pldmtool: Exit non-zero on request failures

exec()'s three failure paths (instance ID allocation,
createRequestMsg(), pldmSendRecv()) now report failure through the CLI
framework's exit-code mechanism instead of an uncaught exception or a
plain return.

Motivation:
pldmtool surfaces the instance ID allocation failure as an exception
rather than silently discarding it. Nothing above exec() catches that
exception, so a real, expected failure (instance IDs running out under
normal contention, not misuse) crashes the whole process instead of
exiting cleanly. The other two paths avoid that crash, but log an error
and still return successfully as far as the caller can tell, so a script
checking the exit status cannot distinguish a failed request from a
successful one.

Tested:
Forced each of the three failure paths above on Yosemite4.

Instance ID pool forced empty, before:
```
$ pldmtool base GetTID -m 30
<3> Instance ID allocation failed for EID 30: Failed to allocate
instance ID for EID 30: No free instance ids
terminate called after throwing an instance of 'pldm::InstanceIdError'
  what():  Failed to allocate instance ID for EID 30: No free
  instance ids
Aborted (core dumped)
$ echo $?
134
```
after:
```
$ pldmtool base GetTID -m 30
<3> Instance ID allocation failed for EID 30: Failed to allocate
instance ID for EID 30: No free instance ids
$ echo $?
1
```

createRequestMsg() forced to return an encode-validation error, before:
```
$ pldmtool base GetTID -m 30
Failed to encode request message for base:GetTID rc = 2
$ echo $?
0
```
after:
```
$ pldmtool base GetTID -m 30
Failed to encode request message for base:GetTID rc = 2
$ echo $?
1
```

pldmSendRecv() forced to return a transport send error, before:
```
$ pldmtool base GetTID -m 30
pldmSendRecv: Failed to receive RC = -7
$ echo $?
0
```
after:
```
$ pldmtool base GetTID -m 30
pldmSendRecv: Failed to receive RC = -7
$ echo $?
1
```

Change-Id: Ifbc0235b431e50df104322d3d5d156df383a8aa2
Signed-off-by: Eric Yang <eric.yang.wiwynn@gmail.com>
1 file changed
tree: 967a00b3dfae36f15013f361993f293118b64e2c
  1. common/
  2. configurations/
  3. docs/
  4. fw-update/
  5. host-bmc/
  6. libpldmresponder/
  7. oem/
  8. platform-mc/
  9. pldmd/
  10. pldmtool/
  11. requester/
  12. softoff/
  13. subprojects/
  14. test/
  15. tools/
  16. utilities/
  17. .clang-format
  18. .clang-tidy
  19. .eslintignore
  20. .gitignore
  21. .linter-ignore
  22. LICENSE
  23. meson.build
  24. meson.options
  25. OWNERS
  26. README.md
README.md

PLDM - Platform Level Data Model

License

Overview

PLDM (Platform Level Data Model) is a key component of the OpenBMC project, providing a standardized data model and message formats for various platform management functionalities. It defines a method to manage, monitor, and control the firmware and hardware of a system.

The OpenBMC PLDM project aims to implement the specifications defined by the Distributed Management Task Force (DMTF), allowing for interoperable management interfaces across different hardware and firmware components.

Features

  • Standardized Messaging: Adheres to the DMTF's PLDM specifications, enabling consistent and interoperable communication between different components.
  • Modularity: Supports multiple PLDM types, including base, FRU,Firmware update, Platform Monitoring and Control, and BIOS Control and Configuration.
  • Extensibility: Easily extendable to support new PLDM types and custom OEM commands.
  • Integration: Seamlessly integrates with other OpenBMC components for comprehensive system management.

Getting Started

Prerequisites

To build and run PLDM, you need the following dependencies:

  • Meson
  • Ninja

Alternatively, source an OpenBMC ARM/x86 SDK.

Building

To build the PLDM project, follow these steps:

meson setup build && meson compile -C build

To run unit tests

The simplest way of running the tests is as described by the meson man page:

meson test -C build

Alternatively, tests can be run in the OpenBMC CI docker container using these steps.

To enable pldm verbosity

pldm daemon accepts a command line argument --verbose or --v or -v to enable the daemon to run in verbose mode. It can be done via adding this option to the environment file that pldm service consumes.

echo 'PLDMD_ARGS="--verbose"' > /etc/default/pldmd
systemctl restart pldmd

To disable pldm verbosity

rm /etc/default/pldmd
systemctl restart pldmd

Documentation

For complete documentation on the functionality and usage of this repository, please refer to the docs folder.