Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libpldm / e78634b9c2b23d6bcbaf76b779a593df32816c84
commite78634b9c2b23d6bcbaf76b779a593df32816c84[log] [tgz]
authorAmithash Prasad <amithash@meta.com>Fri Sep 26 14:10:13 2025 -0700
committerAndrew Jeffery <andrew@codeconstruct.com.au>Tue Sep 30 01:22:10 2025 +0000
tree0c941bc5fffec4bba344542c8d3a2d2d31a828de
parent00d12f83821533d3fcc364a30f5a7391ba62d12e [diff]
Add environ as a link seam for platform APIs

Allow precise redirection of platform-related APIs (such as those
provided by libc) for the purpose of unit tests.

Change-Id: I615b25805fc7a24eb5d67e87237bf35c8e262b93
Signed-off-by: Amithash Prasad <amithash@meta.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
6 files changed
tree: 0c941bc5fffec4bba344542c8d3a2d2d31a828de
  1. abi/
  2. docs/
  3. evolutions/
  4. include/
  5. instance-db/
  6. scripts/
  7. src/
  8. subprojects/
  9. tests/
  10. tools/
  11. .clang-format
  12. .clang-tidy
  13. CHANGELOG.md
  14. CONTRIBUTING.md
  15. Doxyfile.in
  16. LICENSE
  17. meson.build
  18. meson.options
  19. OWNERS
  20. 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.