Google Git
Sign in
android / platform / external / stg / 0548b2dc27b06dfa4949fd6679e7fff3eb761610
commit0548b2dc27b06dfa4949fd6679e7fff3eb761610[log] [tgz]
authorGiuliano Procida <gprocida@google.com>Mon Dec 09 19:19:56 2024 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Mon Dec 09 19:19:56 2024 +0000
tree3192fccf05771c51b997353f0a090987eba2e25c
parent92415d9b2a837c8515cd4df8d8762cab5b6b2fce [diff]
parentfef65c6a1f5df6824df41cd90a76e17838abbcf7 [diff]
Merge branch 'upstream-main' into 'main' am: fef65c6a1f

Original change: https://android-review.googlesource.com/c/platform/external/stg/+/3399800

Change-Id: I065e06b29daaf18f7637f40fbbc4abb39f33d96a
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 3192fccf05771c51b997353f0a090987eba2e25c
  1. cmake/
  2. doc/
  3. fuzz/
  4. test_cases/
  5. testdata/
  6. abigail_reader.cc
  7. abigail_reader.h
  8. abigail_reader_test.cc
  9. Android.bp
  10. btf_reader.cc
  11. btf_reader.h
  12. catch.cc
  13. CMakeLists.txt
  14. comparison.cc
  15. comparison.h
  16. CONTRIBUTING.md
  17. deduplication.cc
  18. deduplication.h
  19. Dockerfile
  20. dwarf_processor.cc
  21. dwarf_processor.h
  22. dwarf_wrappers.cc
  23. dwarf_wrappers.h
  24. elf_dwarf_handle.cc
  25. elf_dwarf_handle.h
  26. elf_loader.cc
  27. elf_loader.h
  28. elf_reader.cc
  29. elf_reader.h
  30. elf_reader_test.cc
  31. equality.h
  32. equality_cache.h
  33. error.h
  34. error_test.cc
  35. fidelity.cc
  36. fidelity.h
  37. file_descriptor.cc
  38. file_descriptor.h
  39. file_descriptor_test.cc
  40. filter.cc
  41. filter.h
  42. filter_test.cc
  43. fingerprint.cc
  44. fingerprint.h
  45. graph.cc
  46. graph.h
  47. hashing.h
  48. hex.h
  49. hex_test.cc
  50. input.cc
  51. input.h
  52. LICENSE
  53. METADATA
  54. MODULE_LICENSE_LLVM
  55. naming.cc
  56. naming.h
  57. order.h
  58. order_test.cc
  59. OWNERS
  60. post_processing.cc
  61. post_processing.h
  62. proto_reader.cc
  63. proto_reader.h
  64. proto_writer.cc
  65. proto_writer.h
  66. reader_options.h
  67. README.md
  68. reporting.cc
  69. reporting.h
  70. reporting_test.cc
  71. runtime.cc
  72. runtime.h
  73. runtime_test.cc
  74. scc.h
  75. scc_test.cc
  76. scope.h
  77. scope_test.cc
  78. stable_hash.cc
  79. stable_hash.h
  80. stg.cc
  81. stg.proto
  82. stgdiff.cc
  83. stgdiff_test.cc
  84. substitution.h
  85. type_normalisation.cc
  86. type_normalisation.h
  87. type_resolution.cc
  88. type_resolution.h
  89. unification.cc
  90. unification.h
README.md

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.

The ABI extraction tool, stg, emits a native ABI format. Parsers exist for libabigail's XML format, BTF and ELF / DWARF.

The ABI diff tool, stgdiff, supports multiple reporting options.

STG has a versioned native file format. Older formats can be read and rewritten as the latest.

NOTE: STG is under active developement. Tool arguments and behaviour are subject to change.

Getting STG

Distributions

We intend to package STG for major distributions. Currently we have packages as follows:

DistributionPackage
Arch Linux (AUR)stg-git

Source Code

This source code is available at https://android.googlesource.com/platform/external/stg/.

Building from Source

Instructions are included for local and Docker builds.

Dependencies

STG is written in C++20. It is known to compile with GCC 11, Clang 15 or later versions. Mininum requirements for a local build are:

DependencyDebianRedHatVersion
buildcmakecmake3.14
ELF, BTFlibelf-develfutils-devel0.189
DWARFlibdw-develfutils-devel0.189
XMLlibxml2-devlibxml2-devel2.9
BTFlinux-libc-devkernel-headers5.19
native formatlibprotobuf-devprotobuf-devel3.19
native formatprotobuf-compilerprotobuf-compiler3.19
allocator[^1]libjemalloc-devjemalloc-devel5
catch2[^2]catch2catch2-devel2 (only)

[^1]: jemalloc is optional, but will likely improve performance. [^2]: catch2 is optional, but required to build the test suite.

Local Build

Build STG using CMake as follows:

$ mkdir build && cd build
$ cmake ..
$ cmake --build . --parallel

Run the STG unit test suite:

$ ctest

Docker Build

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

$ docker build -t stg .

And then enter the container:

$ docker run -it stg

Note that the Dockerfile provides only a production image. To use Docker as a development environment, you can comment out everything after the line # second stage.

After that you may 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.

Contributions

See CONTRIBUTING.md for details.

Contact Information

Please send feedback, questions and bug reports to kernel-team@android.com.