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. oem: meta: Add decode_oem_meta_file_io_write_req() 232. oem: meta: Add decode_oem_meta_file_io_read_req() 243. oem: meta: Add encode_oem_meta_file_io_read_resp() 254. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 265. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 276. pldm_entity_association_tree_copy_root_check() 287. oem: ibm: Add topology related state set and enum 29 308. base: Add size and buffer macros for struct pldm_msg 31 32 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 33 349. entity: Add new entity types from DSP0249 v1.3.0 35 36### Changed 37 381. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 39 40 pldm_bios_table_iter_is_end() now returns true if the provided argument is 41 NULL. 42 432. Register assignment for parameters of a number of APIs changed with increased 44 scrutiny on their implementations. 45 46 - `decode_entity_auxiliary_names_pdr()` 47 - `decode_get_state_sensor_readings_resp()` 48 - `decode_oem_meta_file_io_req()` 49 - `decode_platform_event_message_req()` 50 - `decode_platform_event_message_resp()` 51 - `decode_sensor_op_data()` 52 - `encode_get_state_effecter_states_resp()` 53 - `encode_state_effecter_pdr()` 54 - `encode_state_sensor_pdr()` 55 - `pldm_bios_table_append_pad_checksum()` 56 - `pldm_bios_table_attr_value_entry_encode_enum()` 57 - `pldm_bios_table_attr_value_entry_encode_string()` 58 - `pldm_pdr_find_record()` 59 - `pldm_pdr_get_next_record()` 60 613. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 62 634. dsp: firmware_update: Bounds check 64 decode_downstream_device_parameter_table_entry_versions() 65 66 The additional bounds-checking required the addition of further length 67 parameters. 68 69### Deprecated 70 711. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 72 73 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 74 function to make it safer. 75 76 Modification: 77 78 - The meaning of the returned result. 79 - Change parameters from individual pointers to a struct. 80 - Check the length provided in the message won't exceed the buffer. 81 822. pldm_entity_association_tree_copy_root() 83 84 The implementation allocates, but gives no indication to the caller if an 85 allocation (and hence the copy) has failed. Users should migrate to 86 pldm_entity_association_tree_copy_root_check(). 87 883. The following APIs are deprecated as unsafe due to various unfixable CWE 89 violations: 90 91 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 92 93 - `encode_get_bios_current_value_by_handle_resp()` 94 - `encode_get_bios_table_resp()` 95 - `encode_get_file_table_resp()` 96 - `encode_get_version_resp()` 97 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 98 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 99 - `pldm_bios_table_attr_find_by_handle()` 100 - `pldm_bios_table_attr_find_by_string_handle()` 101 - `pldm_bios_table_attr_value_find_by_handle()` 102 - `pldm_bios_table_iter_create()` 103 - `pldm_bios_table_iter_is_end()` 104 - `pldm_bios_table_string_find_by_handle()` 105 - `pldm_bios_table_string_find_by_string()` 106 107 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 108 109 - `pldm_entity_association_tree_copy_root()` 110 111 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 112 113 - `decode_oem_meta_file_io_req()` 114 115 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 116 - `encode_fru_record()` 117 - `encode_get_pdr_resp()` 118 - `pldm_bios_table_attr_entry_enum_encode_length()` 119 120### Removed 121 1221. Deprecated functions with the `_check` suffix 123 124 - `get_fru_record_by_option_check()` 125 - `pldm_bios_table_append_pad_checksum_check()` 126 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 127 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 128 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 129 - `pldm_bios_table_attr_entry_enum_encode_check()` 130 - `pldm_bios_table_attr_entry_integer_encode_check()` 131 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 132 - `pldm_bios_table_attr_entry_string_encode_check()` 133 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 134 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 135 - `pldm_bios_table_attr_value_entry_encode_string_check()` 136 - `pldm_bios_table_string_entry_decode_string_check()` 137 - `pldm_bios_table_string_entry_encode_check()` 138 - `pldm_entity_association_pdr_add_check()` 139 - `pldm_entity_association_pdr_add_from_node_check()` 140 - `pldm_pdr_add_check()` 141 - `pldm_pdr_add_fru_record_set_check()` 142 143### Fixed 144 1451. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 146 147 Avoid a caller-controlled NULL pointer dereference in the library 148 implementation. 149 1502. platform: fix encode/decode_poll_for_platform_event_message_req 151 152 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 153 follow spec. 154 1553. platform: Fix checking `eventIDToAcknowledge` 156 157 As the event receiver sends `PollForPlatformEventMessage` with the 158 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 159 should be the previously retrieved eventID (from the PLDM terminus). 160 1614. dsp: platform: Prevent overflow of arithmetic on event_data_length 1625. dsp: platform: Bounds check encode_sensor_state_pdr() 1636. dsp: platform: Bounds check encode_state_effecter_pdr() 1647. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1658. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1669. dsp: bios_table: Bounds check 167 pldm_bios_table_attr_value_entry_encode_string() 16810. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 16911. dsp: firmware_update: Bounds check 170 decode_downstream_device_parameter_table_entry_versions() 17112. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 17213. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 17314. dsp: fru: Bounds check encode_fru_record() 17415. dsp: bios: Bounds check encode_set_bios_table_req() 17516. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 17617. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 17718. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 17819. dsp: platform: Fix decode_set_event_receiver_req() 179 180## [0.9.1] - 2024-09-07 181 182### Changed 183 1841. Moved evolutions intended for v0.9.0 into place 185 186 Evolutions for the release have been moved from `evolutions/current` to 187 `evolutions/v0.9.1`. Library users can apply them to migrate off of 188 deprecated APIs. 189 190## [0.9.0] - 2024-09-07 191 192### Added 193 1941. base: Define macros for reserved TIDs 1952. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1963. pdr: Add pldm_entity_association_pdr_create_new() 1974. platform: Define macros for the responded transferflags 1985. pdr: Add pldm_pdr_get_terminus_handle() API 1996. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2007. fw_update: Add encode req & decode resp for get_downstream_fw_params 2018. platform: Add decode_pldm_platform_cper_event() API 2029. decode_get_pdr_repository_info_resp_safe() 203 204 Replaces decode_get_pdr_repository_info_resp() as discussed in the 205 `Deprecated` section below 206 20710. decode_get_pdr_resp_safe() 208 209 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 210 below 211 212### Changed 213 2141. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2152. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2163. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2174. ABI break for decode_sensor_op_data() 218 219 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 220 abi-compliance-checker to flag a change in the register containing the 221 parameter `previous_op_state`. 222 2235. platform: Stabilise decode_pldm_platform_cper_event() API 2246. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2257. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2268. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 227 228### Deprecated 229 2301. Rename and deprecate functions with the `_check` suffix 231 232 All library function return values always need to be checked. The `_check` 233 suffix is redundant, so remove it. Migration to the non-deprecated 234 equivalents without the `_check` suffix can be performed using 235 `scripts/ apply-renames` and the [clang-rename][] configurations under 236 `evolutions/` 237 238 The deprecated functions: 239 240 - `get_fru_record_by_option_check()` 241 - `pldm_bios_table_append_pad_checksum_check()` 242 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 243 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 244 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 245 - `pldm_bios_table_attr_entry_enum_encode_check()` 246 - `pldm_bios_table_attr_entry_integer_encode_check()` 247 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 248 - `pldm_bios_table_attr_entry_string_encode_check()` 249 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 250 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 251 - `pldm_bios_table_attr_value_entry_encode_string_check()` 252 - `pldm_bios_table_string_entry_decode_string_check()` 253 - `pldm_bios_table_string_entry_encode_check()` 254 - `pldm_entity_association_pdr_add_check()` 255 - `pldm_entity_association_pdr_add_from_node_check()` 256 - `pldm_pdr_add_check()` 257 - `pldm_pdr_add_fru_record_set_check()` 258 259[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 260 2612. `decode_get_pdr_repository_info_resp()` 262 263 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 264 eliminates the opportunity for buffer overruns when extracting objects from 265 the message. 266 2673. `decode_get_pdr_resp()` 268 269 Users should move to `decode_get_pdr_resp_safe()` which reduces the 270 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 271 272### Removed 273 2741. IBM OEM header compatibility symlinks. 275 276 Anyone left using the deprecated paths can migrate using the coccinelle patch 277 at `evolutions/current/oem-ibm-header-compat.cocci`. 278 279### Fixed 280 2811. requester: instance-id: Release read lock on conflict 2822. pdr: Error propagation for 283 pldm_entity_association_pdr_add_from_node_with_record_handle() 284 285## [0.8.0] - 2024-05-23 286 287### Added 288 2891. base: Provide pldm_msg_hdr_correlate_response() 2902. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2913. oem: ibm: Add chapdata file type support 2924. base: Added PLDM_SMBIOS & PLDM_RDE message types 2935. oem: meta: Add decode_oem_meta_file_io_req() 2946. state-set: Add all state set values to system power state enum as per DSP0249 2957. platform: Add alias members to the enum 296 pldm_pdr_repository_chg_event_change_record_event_data_operation. 297 298 enum constants with inconsistent names are deprecated with this change. 299 remove old inconsistent enum members after backward compatibility cleanup is 300 done 301 3028. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3039. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 30410. platform: Add 3 PDR type enum for Redfish Device Enablement per 305 DSP0248_1.2.0 30611. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 30712. entity: Add enum for Network Interface Connectors and Network Ports 308 Connection Types 30913. pdr: Add decode_numeric_effecter_pdr_data() 31014. oem: ibm: Support for the Real SAI entity id 31115. fw_update: Add encode req & decode resp for query_downstream_devices 31216. fw_update: Add encode req & decode resp for query_downstream_identifiers 31317. platform: Add support for GetStateEffecterStates command 314 315### Changed 316 3171. base: Stabilise pldm_msg_hdr_correlate_response() 3182. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3193. libpldm: Fix header use 3204. libpldm: More fixes for header use 3215. pdr: Stabilise pldm_pdr_find_last_in_range() API 3226. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3237. oem: meta: stabilise decode_oem_meta_file_io_req() 3248. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 325 326### Deprecated 327 3281. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 329 with `PLDM_OEM_IBM_` 330 331### Fixed 332 3331. libpldm: Rationalise the local and installed path of pldm.h 3342. pdr: Assign record_handle in entity_association_pdr_add_children() 3353. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3364. pdr: Remove redundant constant for minimum numeric sensor PDR length 3375. tests: oem: meta: Fix fileio use of msgbuf 338 339## [0.7.0] - 2023-08-29 340 341### Added 342 3431. state-set: Add new enum for Operational Fault Status enum 344 345### Changed 346 3471. transport: Match specified metadata in pldm_transport_send_recv_msg() 3482. transport: mctp-demux: Drop ABI annotation for internal symbols 3493. transport: Stabilise core transport and implementation APIs 350 351 This stabilisation covers the following headers and functions: 352 353 - libpldm/transport.h 354 355 - pldm_transport_poll() 356 - pldm_transport_send_msg() 357 - pldm_transport_recv_msg() 358 - pldm_transport_send_recv_msg() 359 360 - libpldm/transport/af-mctp.h 361 362 - pldm_transport_af_mctp_init() 363 - pldm_transport_af_mctp_destroy() 364 - pldm_transport_af_mctp_core() 365 - pldm_transport_af_mctp_init_pollfd() 366 - pldm_transport_af_mctp_map_tid() 367 - pldm_transport_af_mctp_unmap_tid() 368 369 - libpldm/transport/mctp-demux.h 370 - pldm_transport_mctp_demux_init() 371 - pldm_transport_mctp_demux_destroy() 372 - pldm_transport_mctp_demux_core() 373 - pldm_transport_mctp_demux_init_pollfd() 374 - pldm_transport_mctp_demux_map_tid() 375 - pldm_transport_mctp_demux_unmap_tid() 376 377### Deprecated 378 3791. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 380 `libpldm/requester/pldm.h`): 381 382 - pldm_open() 383 - pldm_send_recv() 384 - pldm_send() 385 - pldm_recv() 386 - pldm_recv_any() 387 - pldm_close() 388 389 Users should migrate to the newer "transport" APIs instead. 390 391## Fixed 392 3931. tests: Exclude transport tests when build excludes testing ABIs 3942. abi: Capture deprecation of pldm_close() 395 396## [0.6.0] - 2023-08-22 397 398### Changed 399 4001. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4012. meson: Apply `b_ndebug=if-release` by default 4023. pdr : Stabilize pldm_entity_association_tree_add_entity() 4034. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4045. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4056. transport: af-mctp: Assign out-params on success in \*\_recv() 4067. transport: Generalise the pldm_transport_recv_msg() API 407 408### Removed 409 4101. pdr: Remove pldm_entity_association_pdr_add() 4112. state-set: Remove enum pldm_state_set_operational_fault_status_values 412 413### Fixed 414 4151. transport: register init_pollfd callback for af-mctp 4162. transport: fix init_pollfd function parameter 4173. transport: Fix doxygen and variables for send and recv functions 4184. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 419 420## [0.5.0] - 2023-08-09 421 422### Added 423 4241. pdr: Introduce pldm_entity_association_pdr_add_check() 425 426### Changed 427 4281. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4292. transport: pldm_transport_poll(): Adjust return value semantics 4303. transport: free un-wanted responses in pldm_transport_send_recv_msg() 431 432### Deprecated 433 4341. state-set: Enum pldm_state_set_operational_fault_status_values 435 436 The enum operational_fault_status is defined with wrong members and will 437 eventually be replaced with the correct members. Any uses of 438 pldm_state_set_operational_fault_status_values members should move to 439 equivalent pldm_state_set_operational_stress_status_values members if needed. 440 4412. platform: Struct field name in fru_record_set PDR 442 443 References to entity_instance_num should be changed to entity_instance 444 4453. platform: Struct field name in numeric sensor value PDR 446 447 References to entity_instance_num should be changed to entity_instance 448 449### Removed 450 4511. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4522. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4533. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4544. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4555. bios_table: Remove pldm_bios_table_append_pad_checksum() 4566. fru: Remove get_fru_record_by_option() 4577. pdr: Make is_present() static 4588. pdr: Remove pldm_pdr_add() 4599. pdr: Remove pldm_pdr_add_fru_record_set() 46010. pdr: Remove pldm_entity_association_pdr_add_from_node() 46111. pdr: Make find_entity_ref_in_tree() static 46212. pdr: Make entity_association_tree_find() static 463 464### Fixed 465 4661. requester: Fix response buffer cast in pldm_send_recv() 4672. pdr: Hoist record handle overflow test to avoid memory leak 4683. transport: Correct comparison in while loop condition 469 470## [0.4.0] - 2023-07-14 471 472### Added 473 4741. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4752. fru: Introduce get_fru_record_by_option_check() 4763. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4774. pdr: Introduce pldm_pdr_add_check() 4785. pdr: Introduce pldm_pdr_add_fru_record_set_check() 479 480### Changed 481 4821. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4832. requester: Expose pldm_close() in header 4843. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4854. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4865. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4876. pdr: pldm_pdr_init(): Return NULL on allocation failure 4887. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4898. pdr: Document preconditions for trivial accessor functions 490 491 A trivial accessor function is one that exposes properties of an object in a 492 way can't result in an error, beyond passing an invalid argument to the 493 function. For APIs meeting this definition we define a precondition that 494 struct pointers must point to valid objects to avoid polluting the function 495 prototypes. The following APIs now have this precondition explicitly defined: 496 497 - pldm_entity_extract() 498 - pldm_entity_get_parent() 499 - pldm_entity_is_exist_parent() 500 - pldm_entity_is_node_parent() 501 - pldm_is_current_parent_child 502 - pldm_is_empty_entity_assoc_tree() 503 - pldm_pdr_get_record_count() 504 - pldm_pdr_get_record_handle() 505 - pldm_pdr_get_repo_size() 506 - pldm_pdr_record_is_remote() 507 5089. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 50910. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 51011. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 51112. pdr: pldm_entity_association_tree_visit(): Document preconditions 51213. pdr: pldm_entity_association_tree_visit(): Exit early on failure 51314. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 51415. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 51516. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 51617. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 51718. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 51819. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 51920. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 52021. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 52122. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 52223. pdr: pldm_entity_get_num_children(): Don't return invalid values 52324. libpldm: Lift or remove asserts where a subsequent check exists 524 525### Deprecated 526 5271. pldm_bios_table_attr_entry_integer_encode() 528 529 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 530 5312. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 532 533 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 534 5353. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 536 537 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 538 5394. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 540 541 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 542 5435. pdr: Deprecate is_present() 544 545 There should be no users of this symbol. If you are a user, you should figure 546 out how to stop, or get in touch. This symbol will be marked static the 547 release after deprecation. 548 5496. pdr: Deprecate find_entity_ref_in_tree() 550 551 There should be no users of this symbol. If you are a user, you should figure 552 out how to stop, or get in touch. This symbol will be marked static the 553 release after deprecation. 554 5557. pdr: Deprecate entity_association_tree_find() 556 557 There should be no users of this symbol. If you are a user, you should figure 558 out how to stop, or get in touch. This symbol will be marked static the 559 release after deprecation. 560 5618. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 562 563 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 564 pldm_bios_table_append_pad_checksum() should migrate to 565 pldm_bios_table_append_pad_checksum_check() 566 5679. fru: Stabilise get_fru_record_by_option_check() 568 569 get_fru_record_by_option() is deprecated by this change. Users of 570 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 571 57210. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 573 574 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 575 Users of pldm_entity_association_pdr_add_from_node() should migrate to 576 pldm_entity_association_pdr_add_from_node_check() 577 57811. pdr: Stabilise pldm_pdr_add_check() 579 580 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 581 migrate to pldm_pdr_add_check() 582 58312. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 584 585 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 586 pldm_pdr_add_fru_record_set() should migrate to 587 pldm_pdr_add_fru_record_set_check() 588 589### Removed 590 5911. bios_table: Remove deprecated APIs sanitized by assert(): 592 593 - pldm_bios_table_string_entry_encode() 594 - pldm_bios_table_string_entry_decode_string() 595 - pldm_bios_table_attr_entry_enum_encode() 596 - pldm_bios_table_attr_entry_enum_decode_pv_num() 597 - pldm_bios_table_attr_entry_enum_decode_def_num() 598 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 599 - pldm_bios_table_attr_entry_string_encode() 600 - pldm_bios_table_attr_entry_string_decode_def_string_length() 601 602### Fixed 603 6041. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6052. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6063. transport: mctp-demux: Don't test socket for non-zero value 6074. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6085. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6096. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6107. abi: Update to remove pldm_close() from reference dumps 6118. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 612 613## [0.3.0] - 2023-06-23 614 615### Added 616 6171. Add encode/decode pldmMessagePollEvent data 6182. README: Add a section on working with libpldm 6193. pdr: Introduce remote_container_id and associated APIs 6204. pdr: Add APIs for creating and locating remote PDRs 6215. pdr: Add pldm_pdr_find_last_in_range() 6226. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6237. pdr: Add pldm_pdr_find_container_id_range_exclude() 624 625### Changed 626 6271. include: Move installed transport.h under libpldm/ 6282. libpldm: Explicit deprecated, stable and testing ABI classes 6293. meson: Reduce strength of oem-ibm requirements from enabled to allowed 630 631 The `oem-ibm` feature is now enabled by the default meson configuration, for 632 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 633 recipe: 634 635 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 636 637 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 638 when invoking `meson setup` 639 6404. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6415. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 642 643### Deprecated 644 6451. bios_table: Deprecate APIs with arguments sanitized using assert() 646 647 C provides enough foot-guns without us encoding them into library APIs. 648 Specifically, deprecate the following in favour of their `*_check()` variants 649 which ensure assertions won't fail or otherwise invoke UB: 650 651 - pldm_bios_table_string_entry_encode() 652 - pldm_bios_table_string_entry_decode_string() 653 - pldm_bios_table_attr_entry_enum_encode() 654 - pldm_bios_table_attr_entry_enum_decode_pv_num() 655 - pldm_bios_table_attr_entry_enum_decode_def_num() 656 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 657 - pldm_bios_table_attr_entry_string_encode() 658 - pldm_bios_table_attr_entry_string_decode_def_string_length() 659 660### Removed 661 6621. libpldm: Remove the requester-api option 663 664### Fixed 665 6661. requester: Make pldm_open() return existing fd 6672. transport: Prevent sticking in waiting for response 6683. transport: Match on response in pldm_transport_send_recv_msg() 6694. requester: Add check before accessing hdr in pldm_recv() 6705. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 671