| commit | 6b1d883043dc36516e771faf5ce9f5fa18e23cc0 | [log] [tgz] |
|---|---|---|
| author | Manojkiran Eda <manojkiran.eda@gmail.com> | Sat Mar 27 11:25:06 2021 +0530 |
| committer | Manojkiran Eda <manojkiran.eda@gmail.com> | Wed Apr 14 11:55:33 2021 +0530 |
| tree | eb16674b6c2e15cffec6617506747cb17a1c443a | |
| parent | e7991b75325dacafd9573d52eb722cfe390b6faf [diff] |
Fix broken IBM OEM Unit tests Tested Log: ninja: no work to do. 1/28 libpldm_base_test OK 0.05s 2/28 libpldm_platform_test OK 0.04s 3/28 libpldm_bios_test OK 0.04s 4/28 libpldm_fru_test OK 0.03s 5/28 libpldm_utils_test OK 0.02s 6/28 libpldm_pdr_test OK 0.02s 7/28 ../../oem/ibm/test/libpldm_fileio_test OK 0.05s 8/28 ../../oem/ibm/test/libpldm_host_test OK 0.05s 9/28 libpldmresponder_base_test OK 0.05s 10/28 libpldmresponder_bios_test OK 0.04s 11/28 libpldmresponder_bios_attribute_test OK 0.04s 12/28 libpldmresponder_bios_string_attribute_test OK 0.06s 13/28 libpldmresponder_bios_integer_attribute_test OK 0.06s 14/28 libpldmresponder_bios_config_test OK 0.07s 15/28 libpldmresponder_bios_enum_attribute_test OK 0.06s 16/28 libpldmresponder_pdr_effecter_test OK 0.06s 17/28 libpldmresponder_pdr_sensor_test OK 0.05s 18/28 libpldmresponder_bios_table_test OK 0.07s 19/28 pldmd_instanceid_test OK 0.05s 20/28 pldmd_registration_test OK 0.05s 21/28 libpldmresponder_platform_test OK 0.07s 22/28 pldm_utils_test OK 0.05s 23/28 libpldmresponder_fru_test OK 0.04s 24/28 libpldmresponder_dbus_to_host_effecter_test OK 0.04s 25/28 ../oem/ibm/test/libpldmresponder_oem_platform_test OK 0.02s 26/28 ../oem/ibm/test/host_bmc_lamp_test OK 0.02s 27/28 ../oem/ibm/test/libpldmresponder_fileio_test OK 0.04s 28/28 libpldm_bios_table_test OK 2.14s Ok: 28 Expected Fail: 0 Fail: 0 Unexpected Pass: 0 Skipped: 0 Timeout: 0 Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com> Change-Id: Iaacbefffebee252f0588db267c3e26f583a9edba
Need meson and ninja. Alternatively, source an OpenBMC ARM/x86 SDK.
meson build && ninja -C build
Tests can be run in the CI docker container, or with an OpenBMC x86 sdk(see below for x86 steps).
meson -Doe-sdk=enabled -Dtests=enabled build ninja -C build test
At a high-level, code in this repository belongs to one of the following three components.
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:
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.
This library provides handlers for incoming PLDM request messages. It provides for a registration as well as a plug-in mechanism. The library is implemented in modern C++, and handles OpenBMC's platform specifics.
The handlers are of the form
Response handler(Request payload, size_t payloadLen)
Source files are named according to the PLDM Type, for eg base.[hpp/cpp], fru.[hpp/cpp], etc.
This will support OEM or vendor-specific functions and semantic information. Following directory structure has to be used:
pldm repo
|---- oem
|----<oem_name>
|----libpldm
|----<oem based encoding and decoding files>
|----libpldmresponder
|---<oem based handler files>
<oem_name> - This folder must be created with the name of the OEM/vendor in lower case. Folders named libpldm and libpldmresponder must be created under the folder <oem_name>
Files having the oem functionality for the libpldm library should be placed under the folder oem/<oem_name>/libpldm. They must be adhering to the rules mentioned under the libpldm section above.
Files having the oem functionality for the libpldmresponder library should be placed under the folder oem/<oem_name>/libpldmresponder. They must be adhering to the rules mentioned under the libpldmresponder section above.
Once the above is done a meson option has to be created in pldm/meson_options.txt with its mapped compiler flag to enable conditional compilation.
For consistency would recommend using "oem-<oem_name>".
The pldm/meson.build and the corresponding source file(s) will need to incorporate the logic of adding its mapped compiler flag to allow conditional compilation of the code.
Consider hosting libpldm above in a repo of its own, probably even outside the OpenBMC project? A separate repo would enable something like git submodule.
This section documents important code flow paths.
a) PLDM daemon receives PLDM request message from underlying transport (MCTP).
b) PLDM daemon routes message to message handler, based on the PLDM command.
c) Message handler decodes request payload into various field(s) of the request message. It can make use of a decode_foo_req() API, and doesn't have to perform deserialization of the request payload by itself.
d) Message handler works with the request field(s) and generates response field(s).
e) Message handler prepares a response message. It can make use of an encode_foo_resp() API, and doesn't have to perform the serialization of the response field(s) by itself.
f) The PLDM daemon sends the response message prepared at step e) to the remote PLDM device.
a) A BMC PLDM requester app prepares a PLDM request message. There would be several requester apps (based on functionality/PLDM remote device). Each of them needn't bother with the serialization of request field(s), and can instead make use of an encode_foo_req() API.
b) BMC requester app requests PLDM daemon to send the request message to remote PLDM device.
c) Once the PLDM daemon receives a corresponding response message, it notifies the requester app.
d) The requester app has to work with the response field(s). It can make use of a decode_foo_resp() API to deserialize the response message.
While PLDM Platform Descriptor Records (PDRs) are mostly static information, they can vary across platforms and systems. For this reason, platform specific PDR information is encoded in platform specific JSON files. JSON files must be named based on the PDR type number. For example a state effecter PDR JSON file will be named 11.json. The JSON files may also include information to enable additional processing (apart from PDR creation) for specific PDR types, for eg mapping an effecter id to a D-Bus object.
The PLDM responder implementation finds and parses PDR JSON files to create the PDR repository. Platform specific PDR modifications would likely just result in JSON updates. New PDR type support would require JSON updates as well as PDR generation code. The PDR generator is a map of PDR Type -> C++ lambda to create PDR entries for that type based on the JSON, and to update the central PDR repo.