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## [0.3.0] - 2023-06-23 34 35### Added 36 371. Add encode/decode pldmMessagePollEvent data 382. README: Add a section on working with libpldm 393. pdr: Introduce remote_container_id and associated APIs 404. pdr: Add APIs for creating and locating remote PDRs 415. pdr: Add pldm_pdr_find_last_in_range() 426. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 437. pdr: Add pldm_pdr_find_container_id_range_exclude() 44 45### Changed 46 471. include: Move installed transport.h under libpldm/ 482. libpldm: Explicit deprecated, stable and testing ABI classes 493. meson: Reduce strength of oem-ibm requirements from enabled to allowed 50 51 The `oem-ibm` feature is now enabled by the default meson configuration, for 52 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 53 recipe: 54 55 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 56 57 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 58 when invoking `meson setup` 59 604. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 615. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 62 63### Deprecated 64 651. bios_table: Deprecate APIs with arguments sanitized using assert() 66 67 C provides enough foot-guns without us encoding them into library APIs. 68 Specifically, deprecate the following in favour of their `*_check()` variants 69 which ensure assertions won't fail or otherwise invoke UB: 70 71 - pldm_bios_table_string_entry_encode() 72 - pldm_bios_table_string_entry_decode_string() 73 - pldm_bios_table_attr_entry_enum_encode() 74 - pldm_bios_table_attr_entry_enum_decode_pv_num() 75 - pldm_bios_table_attr_entry_enum_decode_def_num() 76 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 77 - pldm_bios_table_attr_entry_string_encode() 78 - pldm_bios_table_attr_entry_string_decode_def_string_length() 79 80### Removed 81 821. libpldm: Remove the requester-api option 83 84### Fixed 85 861. requester: Make pldm_open() return existing fd 872. transport: Prevent sticking in waiting for response 883. transport: Match on response in pldm_transport_send_recv_msg() 894. requester: Add check before accessing hdr in pldm_recv() 905. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 91