This is the Application Binary Interface Generic Analysis and
Instrumentation Library.

It aims at constructing, manipulating, serializing and de-serializing
ABI-relevant artifacts.

The set of artifacts that we are intersted is made of quantities like
types, variable, functions and declarations of a given library or
program.  For a given library or program this set of quantities is
called an ABI corpus.

This library aims at (among other things) providing a way to compare
two ABI Corpora (apparently the plural of corpus is copora, heh,
that's cool), provide detailed information about their differences,
and help build tools to infer interesting conclusions about these
differences.

You are welcome to contribute to this project after reading the files
CONTRIBUTING and COMMIT-LOG-GUIDELINES files in the source tree.

Communicating with the maintainers of this project -- including
sending patches to be include to the source code -- happens via email
at libabigail@sourceware.org.

# Libabigail Docker

Libabigail comes with two Dockerfile in [docker](docker) to build each of:

 - a Fedora base image (recommended)
 - an Ubuntu base image.

These containers are built and deployed on merges to the main branch and releases.

### Usage

Here is how to build the containers. Note that we build so it belongs to the same
namespace as the repository here. "ghcr.io" means "GitHub Container Registry" and
is the [GitHub packages](https://github.com/features/packages) registry that supports
 Docker images and other OCI artifacts.

```bash
$ docker build -f docker/Dockerfile.fedora -t ghcr.io/woodard/libabigail-fedora .
```
```bash
$ docker build -f docker/Dockerfile.ubuntu -t ghcr.io/woodard/libabigail-ubuntu-22.04 .
```

Note that currently the fedora image is deployed to `ghcr.io/woodard/libabigail:latest`.

### Shell

To shell into a container (here is an example with ubuntu):

```bash
$ docker run -it ghcr.io/woodard/libabigail-ubuntu-22.04 bash
```

Off the bat, you can find the abi executables:

```bash
# which abidiff
/opt/abigail-env/.spack-env/view/bin/abidiff
```

Since the ubuntu base uses spack, you can interact with spack.
You can go to the environment in `/opt/abigail-env` and (given you
have the source code bound to `/src`) build and test again.

```bash
$ spack install
```

And that's it! This workflow should make it easy to install development versions of libabigail with spack.
We will also use the "production" containers to grab libraries in:

```
$ ls /opt/abigail-env/.spack-env/view/
bin  include  lib  share
```

Note that the fedora container does not come with spack.

### Testing

We provide a testing container, which will use a fedora base and add new code to
compile, and then run `make check`. You can do this as follows on your local machine:

```bash
$ docker build -f docker/Dockerfile.test -t test .
```

[
  {
    "Name": "libabigail",
    "License": "Apache License 2.0",
    "License File": "LICENSE.txt",
    "Version Number": "2.2",
    "Owner": "zhanghaibo0@huawei.com",
    "Upstream URL": "https://sourceware.org/libabigail/",
    "Description": "ABI check for dynamic libraries of different versions."
  }
]

# libabigail

仓库包含第三方开源软件libabigail，libabigail是一个用于不同版本二进制库的ABI检查工具。开发者使用这个工具可以生成二进制库的ABI特征文件，并且可以比较两个版本之间的特征文件，从而可以看出同一个二进制库在两个版本之间是否发生了ABI变化。

## 目录结构

```
doc/           文档
include/       头文件
scripts/       脚本
src/           源文件
tests/         测试目录
tools/         工具源码
LICENSE.txt    证书文件
README         README说明
```

## OpenHarmony如何使用libabigail

SA独立升级的特性需要对相关的二进制库进行ABI检查，以保证二进制库的前向兼容。通过libabigail提供的工具对比基线的ABI特征文件与编译时实时生成的ABI特征文件，可以看出ABI是否发生了变化，如果是则编译报错。

## OpenHarmony如何集成libabigail

libabigail是作为host端的工具存在，不会随镜像发布到产品中。

### 1.libabigail编译入口

libabigail的编译入口在其根目录下的BUILD.gn中。

```makefile
group("libabigail-tools_host_toolchain") {
  deps = [
    "//third_party/libabigail/tools:abidiff($host_toolchain)",
    "//third_party/libabigail/tools:abidw($host_toolchain)",
  ]
}
```

可以看出使用了libabigail中的abidiff和abidw这两个工具。

### 2.使用libabigail

SA独立升级特性提供了新的编译模板`ohos_module_package`，其中直接指定了对libabigail的依赖。

```makefile
deps += [ "//third_party/libabigail:libabigail-tools_host_toolchain" ]
```
这样只要有模块使用了`ohos_module_package`模板，libabigail工具就会编译出来。

## libabigail相关内容

[libabigail官网](https://sourceware.org/libabigail/)

## License

`Apache License V2.0`

‍