Google Git
Sign in
android / platform / external / stg / refs/tags/platform-tools-34.0.4
tag18c4838717e4c5c8fb1861c734a83fbb7756ea07
taggerThe Android Open Source Project <initial-contribution@android.com>Thu Jul 27 11:36:35 2023 -0700
object1fa2cdf4ba19bb2c174bdad4aef4bcb195a8f75a 
Platform Tools Release 34.0.4 (10411341)
commit1fa2cdf4ba19bb2c174bdad4aef4bcb195a8f75a[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Wed Jun 28 13:35:39 2023 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Wed Jun 28 13:35:39 2023 +0000
treef6b717bd926a7b9c83dd6ddd51e0b27633ae0399
parentad8e0a5eb946febb9dd3ae27f7260bae8bf69b63 [diff]
parentbec78e9003ef0773664dab43b91e8c919bd861f0 [diff]
Snap for 10399941 from bec78e9003ef0773664dab43b91e8c919bd861f0 to sdk-release

Change-Id: Iefa1aa1e5ff1550b3dd82204cc148895ee77ba9c
tree: f6b717bd926a7b9c83dd6ddd51e0b27633ae0399
  1. doc/
  2. fuzz/
  3. testdata/
  4. abigail_reader.cc
  5. abigail_reader.h
  6. abigail_reader_test.cc
  7. Android.bp
  8. btf_reader.cc
  9. btf_reader.h
  10. catch.cc
  11. comparison.cc
  12. comparison.h
  13. CONTRIBUTING.md
  14. deduplication.cc
  15. deduplication.h
  16. Dockerfile
  17. dwarf_processor.cc
  18. dwarf_processor.h
  19. dwarf_wrappers.cc
  20. dwarf_wrappers.h
  21. elf_loader.cc
  22. elf_loader.h
  23. elf_reader.cc
  24. elf_reader.h
  25. elf_reader_test.cc
  26. equality.h
  27. equality_cache.h
  28. error.h
  29. error_test.cc
  30. fidelity.cc
  31. fidelity.h
  32. file_descriptor.cc
  33. file_descriptor.h
  34. file_descriptor_test.cc
  35. fingerprint.cc
  36. fingerprint.h
  37. graph.cc
  38. graph.h
  39. hashing.h
  40. input.cc
  41. input.h
  42. LICENSE
  43. Makefile
  44. METADATA
  45. metrics.cc
  46. metrics.h
  47. metrics_test.cc
  48. MODULE_LICENSE_LLVM
  49. naming.cc
  50. naming.h
  51. order.h
  52. order_test.cc
  53. OWNERS
  54. post_processing.cc
  55. post_processing.h
  56. proto_reader.cc
  57. proto_reader.h
  58. proto_writer.cc
  59. proto_writer.h
  60. reader_options.h
  61. README.md
  62. reporting.cc
  63. reporting.h
  64. reporting_test.cc
  65. scc.h
  66. scc_test.cc
  67. scope.h
  68. stable_hash.cc
  69. stable_hash.h
  70. stg.cc
  71. stg.proto
  72. stgdiff.cc
  73. stgdiff_test.cc
  74. stginfo.cc
  75. substitution.h
  76. symbol_filter.cc
  77. symbol_filter.h
  78. symbol_filter_test.cc
  79. type_normalisation.cc
  80. type_normalisation.h
  81. type_resolution.cc
  82. type_resolution.h
  83. unification.cc
  84. 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. 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.