1# Changelog 2 3All notable changes to this project will be documented in this file. 4 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6and this project adheres to 7[Semantic Versioning](https://semver.org/spec/v2.0.0.html). 8 9Change categories: 10 11- Added 12- Changed 13- Deprecated 14- Removed 15- Fixed 16- Security 17 18## [Unreleased] 19 20### Removed 21 221. bios_table: Remove deprecated APIs sanitized by assert(): 23 24 - pldm_bios_table_string_entry_encode() 25 - pldm_bios_table_string_entry_decode_string() 26 - pldm_bios_table_attr_entry_enum_encode() 27 - pldm_bios_table_attr_entry_enum_decode_pv_num() 28 - pldm_bios_table_attr_entry_enum_decode_def_num() 29 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 30 - pldm_bios_table_attr_entry_string_encode() 31 - pldm_bios_table_attr_entry_string_decode_def_string_length() 32 33### Fixes 34 351. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 362. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 37 38## [0.3.0] - 2023-06-23 39 40### Added 41 421. Add encode/decode pldmMessagePollEvent data 432. README: Add a section on working with libpldm 443. pdr: Introduce remote_container_id and associated APIs 454. pdr: Add APIs for creating and locating remote PDRs 465. pdr: Add pldm_pdr_find_last_in_range() 476. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 487. pdr: Add pldm_pdr_find_container_id_range_exclude() 49 50### Changed 51 521. include: Move installed transport.h under libpldm/ 532. libpldm: Explicit deprecated, stable and testing ABI classes 543. meson: Reduce strength of oem-ibm requirements from enabled to allowed 55 56 The `oem-ibm` feature is now enabled by the default meson configuration, for 57 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 58 recipe: 59 60 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 61 62 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 63 when invoking `meson setup` 64 654. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 665. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 67 68### Deprecated 69 701. bios_table: Deprecate APIs with arguments sanitized using assert() 71 72 C provides enough foot-guns without us encoding them into library APIs. 73 Specifically, deprecate the following in favour of their `*_check()` variants 74 which ensure assertions won't fail or otherwise invoke UB: 75 76 - pldm_bios_table_string_entry_encode() 77 - pldm_bios_table_string_entry_decode_string() 78 - pldm_bios_table_attr_entry_enum_encode() 79 - pldm_bios_table_attr_entry_enum_decode_pv_num() 80 - pldm_bios_table_attr_entry_enum_decode_def_num() 81 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 82 - pldm_bios_table_attr_entry_string_encode() 83 - pldm_bios_table_attr_entry_string_decode_def_string_length() 84 85### Removed 86 871. libpldm: Remove the requester-api option 88 89### Fixed 90 911. requester: Make pldm_open() return existing fd 922. transport: Prevent sticking in waiting for response 933. transport: Match on response in pldm_transport_send_recv_msg() 944. requester: Add check before accessing hdr in pldm_recv() 955. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 96