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### Added 21 221. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 23 24### Changed 25 261. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 272. requester: Expose pldm_close() in header 283. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 294. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 305. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 31 32### Deprecated 33 341. pldm_bios_table_attr_entry_integer_encode() 35 36 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 37 382. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 39 40 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 41 423. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 43 44 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 45 464. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 47 48 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 49 50### Removed 51 521. bios_table: Remove deprecated APIs sanitized by assert(): 53 54 - pldm_bios_table_string_entry_encode() 55 - pldm_bios_table_string_entry_decode_string() 56 - pldm_bios_table_attr_entry_enum_encode() 57 - pldm_bios_table_attr_entry_enum_decode_pv_num() 58 - pldm_bios_table_attr_entry_enum_decode_def_num() 59 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 60 - pldm_bios_table_attr_entry_string_encode() 61 - pldm_bios_table_attr_entry_string_decode_def_string_length() 62 63### Fixed 64 651. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 662. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 673. transport: mctp-demux: Don't test socket for non-zero value 684. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 69 70## [0.3.0] - 2023-06-23 71 72### Added 73 741. Add encode/decode pldmMessagePollEvent data 752. README: Add a section on working with libpldm 763. pdr: Introduce remote_container_id and associated APIs 774. pdr: Add APIs for creating and locating remote PDRs 785. pdr: Add pldm_pdr_find_last_in_range() 796. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 807. pdr: Add pldm_pdr_find_container_id_range_exclude() 81 82### Changed 83 841. include: Move installed transport.h under libpldm/ 852. libpldm: Explicit deprecated, stable and testing ABI classes 863. meson: Reduce strength of oem-ibm requirements from enabled to allowed 87 88 The `oem-ibm` feature is now enabled by the default meson configuration, for 89 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 90 recipe: 91 92 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 93 94 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 95 when invoking `meson setup` 96 974. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 985. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 99 100### Deprecated 101 1021. bios_table: Deprecate APIs with arguments sanitized using assert() 103 104 C provides enough foot-guns without us encoding them into library APIs. 105 Specifically, deprecate the following in favour of their `*_check()` variants 106 which ensure assertions won't fail or otherwise invoke UB: 107 108 - pldm_bios_table_string_entry_encode() 109 - pldm_bios_table_string_entry_decode_string() 110 - pldm_bios_table_attr_entry_enum_encode() 111 - pldm_bios_table_attr_entry_enum_decode_pv_num() 112 - pldm_bios_table_attr_entry_enum_decode_def_num() 113 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 114 - pldm_bios_table_attr_entry_string_encode() 115 - pldm_bios_table_attr_entry_string_decode_def_string_length() 116 117### Removed 118 1191. libpldm: Remove the requester-api option 120 121### Fixed 122 1231. requester: Make pldm_open() return existing fd 1242. transport: Prevent sticking in waiting for response 1253. transport: Match on response in pldm_transport_send_recv_msg() 1264. requester: Add check before accessing hdr in pldm_recv() 1275. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 128