abi: Refresh dumps to capture libpldm++ namespace rework

The final iteration of d6a957481638 ("bindings: C++ binding for parsing
PLDM fw package") introduced the `libpldm::` namespace to house
implementation details, however the ABI dump was not updated to match.

Refresh the dumps to capture the new namespace.

Fixes: d6a957481638 ("bindings: C++ binding for parsing PLDM fw package")
Change-Id: Ieab322c95efec2007e41fb3b5a9006eaf91169a1
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
3 files changed
tree: 4a4ef5c97e6c74fa98feb045ad1fe5f15bb4e858
  1. abi/
  2. bindings/
  3. docs/
  4. evolutions/
  5. include/
  6. instance-db/
  7. scripts/
  8. src/
  9. subprojects/
  10. tests/
  11. tools/
  12. .clang-format
  13. .clang-tidy
  14. CHANGELOG.md
  15. CONTRIBUTING.md
  16. Doxyfile.in
  17. LICENSE
  18. meson.build
  19. meson.options
  20. OWNERS
  21. README.md
README.md

libpldm

This is a library which deals with the encoding and decoding of PLDM messages. It should be possible to use this library by projects other than OpenBMC, and hence certain constraints apply to it:

  • keeping it light weight
  • implementation in C
  • minimal dynamic memory allocations
  • endian-safe
  • no OpenBMC specific dependencies

Source files are named according to the PLDM Type, for eg base.[h/c], fru.[h/c], etc.

Given a PLDM command "foo", the library will provide the following API: For the Requester function:

encode_foo_req() - encode a foo request
decode_foo_resp() - decode a response to foo

For the Responder function:

decode_foo_req() - decode a foo request
encode_foo_resp() - encode a response to foo

The library also provides API to pack and unpack PLDM headers.

To Build

libpldm is configured and built using meson. Python's pip or pipx can be used to install a recent version on your machine:

pipx install meson

Once meson is installed:

meson setup build && meson compile -C build

To run unit tests

meson test -C build

Working with libpldm

Components of the library ABI[^1] (loosely, functions) are separated into three categories:

[^1]: "library API + compiler ABI = library ABI"

  1. Stable
  2. Testing
  3. Deprecated

Applications depending on libpldm should aim to only use functions from the stable category. However, this may not always be possible. What to do when required functions fall into the deprecated or testing categories is discussed in CONTRIBUTING.

Upgrading libpldm

libpldm is maintained with the expectation that users move between successive releases when upgrading. This constraint allows the library to reintroduce types and functions of the same name in subsequent releases in the knowledge that there are no remaining users of previous definitions. While strategies are employed to avoid breaking existing APIs unnecessarily, the library is still to reach maturity, and we must allow for improvements to be made in the design.