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 34### Changed 35 361. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 37 38 pldm_bios_table_iter_is_end() now returns true if the provided argument is 39 NULL. 40 412. Register assignment for parameters of a number of APIs changed with increased 42 scrutiny on their implementations. 43 44 - `decode_entity_auxiliary_names_pdr()` 45 - `decode_get_state_sensor_readings_resp()` 46 - `decode_oem_meta_file_io_req()` 47 - `decode_platform_event_message_req()` 48 - `decode_platform_event_message_resp()` 49 - `decode_sensor_op_data()` 50 - `encode_get_state_effecter_states_resp()` 51 - `encode_state_effecter_pdr()` 52 - `encode_state_sensor_pdr()` 53 - `pldm_bios_table_append_pad_checksum()` 54 - `pldm_bios_table_attr_value_entry_encode_enum()` 55 - `pldm_bios_table_attr_value_entry_encode_string()` 56 - `pldm_pdr_find_record()` 57 - `pldm_pdr_get_next_record()` 58 593. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 60 614. dsp: firmware_update: Bounds check 62 decode_downstream_device_parameter_table_entry_versions() 63 64 The additional bounds-checking required the addition of further length 65 parameters. 66 67### Deprecated 68 691. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 70 71 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 72 function to make it safer. 73 74 Modification: 75 76 - The meaning of the returned result. 77 - Change parameters from individual pointers to a struct. 78 - Check the length provided in the message won't exceed the buffer. 79 802. pldm_entity_association_tree_copy_root() 81 82 The implementation allocates, but gives no indication to the caller if an 83 allocation (and hence the copy) has failed. Users should migrate to 84 pldm_entity_association_tree_copy_root_check(). 85 863. The following APIs are deprecated as unsafe due to various unfixable CWE 87 violations: 88 89 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 90 91 - `encode_get_bios_current_value_by_handle_resp()` 92 - `encode_get_bios_table_resp()` 93 - `encode_get_file_table_resp()` 94 - `encode_get_version_resp()` 95 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 96 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 97 - `pldm_bios_table_attr_find_by_handle()` 98 - `pldm_bios_table_attr_find_by_string_handle()` 99 - `pldm_bios_table_attr_value_find_by_handle()` 100 - `pldm_bios_table_iter_create()` 101 - `pldm_bios_table_iter_is_end()` 102 - `pldm_bios_table_string_find_by_handle()` 103 - `pldm_bios_table_string_find_by_string()` 104 105 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 106 107 - `pldm_entity_association_tree_copy_root()` 108 109 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 110 111 - `decode_oem_meta_file_io_req()` 112 113 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 114 - `encode_fru_record()` 115 - `encode_get_pdr_resp()` 116 - `pldm_bios_table_attr_entry_enum_encode_length()` 117 118### Removed 119 1201. Deprecated functions with the `_check` suffix 121 122 - `get_fru_record_by_option_check()` 123 - `pldm_bios_table_append_pad_checksum_check()` 124 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 125 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 126 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 127 - `pldm_bios_table_attr_entry_enum_encode_check()` 128 - `pldm_bios_table_attr_entry_integer_encode_check()` 129 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 130 - `pldm_bios_table_attr_entry_string_encode_check()` 131 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 132 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 133 - `pldm_bios_table_attr_value_entry_encode_string_check()` 134 - `pldm_bios_table_string_entry_decode_string_check()` 135 - `pldm_bios_table_string_entry_encode_check()` 136 - `pldm_entity_association_pdr_add_check()` 137 - `pldm_entity_association_pdr_add_from_node_check()` 138 - `pldm_pdr_add_check()` 139 - `pldm_pdr_add_fru_record_set_check()` 140 141### Fixed 142 1431. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 144 145 Avoid a caller-controlled NULL pointer dereference in the library 146 implementation. 147 1482. platform: fix encode/decode_poll_for_platform_event_message_req 149 150 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 151 follow spec. 152 1533. platform: Fix checking `eventIDToAcknowledge` 154 155 As the event receiver sends `PollForPlatformEventMessage` with the 156 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 157 should be the previously retrieved eventID (from the PLDM terminus). 158 1594. dsp: platform: Prevent overflow of arithmetic on event_data_length 1605. dsp: platform: Bounds check encode_sensor_state_pdr() 1616. dsp: platform: Bounds check encode_state_effecter_pdr() 1627. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1638. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1649. dsp: bios_table: Bounds check 165 pldm_bios_table_attr_value_entry_encode_string() 16610. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 16711. dsp: firmware_update: Bounds check 168 decode_downstream_device_parameter_table_entry_versions() 16912. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 17013. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 17114. dsp: fru: Bounds check encode_fru_record() 17215. dsp: bios: Bounds check encode_set_bios_table_req() 17316. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 17417. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 17518. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 176 177## [0.9.1] - 2024-09-07 178 179### Changed 180 1811. Moved evolutions intended for v0.9.0 into place 182 183 Evolutions for the release have been moved from `evolutions/current` to 184 `evolutions/v0.9.1`. Library users can apply them to migrate off of 185 deprecated APIs. 186 187## [0.9.0] - 2024-09-07 188 189### Added 190 1911. base: Define macros for reserved TIDs 1922. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1933. pdr: Add pldm_entity_association_pdr_create_new() 1944. platform: Define macros for the responded transferflags 1955. pdr: Add pldm_pdr_get_terminus_handle() API 1966. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 1977. fw_update: Add encode req & decode resp for get_downstream_fw_params 1988. platform: Add decode_pldm_platform_cper_event() API 1999. decode_get_pdr_repository_info_resp_safe() 200 201 Replaces decode_get_pdr_repository_info_resp() as discussed in the 202 `Deprecated` section below 203 20410. decode_get_pdr_resp_safe() 205 206 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 207 below 208 209### Changed 210 2111. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2122. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2133. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2144. ABI break for decode_sensor_op_data() 215 216 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 217 abi-compliance-checker to flag a change in the register containing the 218 parameter `previous_op_state`. 219 2205. platform: Stabilise decode_pldm_platform_cper_event() API 2216. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2227. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2238. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 224 225### Deprecated 226 2271. Rename and deprecate functions with the `_check` suffix 228 229 All library function return values always need to be checked. The `_check` 230 suffix is redundant, so remove it. Migration to the non-deprecated 231 equivalents without the `_check` suffix can be performed using 232 `scripts/ apply-renames` and the [clang-rename][] configurations under 233 `evolutions/` 234 235 The deprecated functions: 236 237 - `get_fru_record_by_option_check()` 238 - `pldm_bios_table_append_pad_checksum_check()` 239 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 240 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 241 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 242 - `pldm_bios_table_attr_entry_enum_encode_check()` 243 - `pldm_bios_table_attr_entry_integer_encode_check()` 244 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 245 - `pldm_bios_table_attr_entry_string_encode_check()` 246 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 247 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 248 - `pldm_bios_table_attr_value_entry_encode_string_check()` 249 - `pldm_bios_table_string_entry_decode_string_check()` 250 - `pldm_bios_table_string_entry_encode_check()` 251 - `pldm_entity_association_pdr_add_check()` 252 - `pldm_entity_association_pdr_add_from_node_check()` 253 - `pldm_pdr_add_check()` 254 - `pldm_pdr_add_fru_record_set_check()` 255 256[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 257 2582. `decode_get_pdr_repository_info_resp()` 259 260 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 261 eliminates the opportunity for buffer overruns when extracting objects from 262 the message. 263 2643. `decode_get_pdr_resp()` 265 266 Users should move to `decode_get_pdr_resp_safe()` which reduces the 267 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 268 269### Removed 270 2711. IBM OEM header compatibility symlinks. 272 273 Anyone left using the deprecated paths can migrate using the coccinelle patch 274 at `evolutions/current/oem-ibm-header-compat.cocci`. 275 276### Fixed 277 2781. requester: instance-id: Release read lock on conflict 2792. pdr: Error propagation for 280 pldm_entity_association_pdr_add_from_node_with_record_handle() 281 282## [0.8.0] - 2024-05-23 283 284### Added 285 2861. base: Provide pldm_msg_hdr_correlate_response() 2872. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2883. oem: ibm: Add chapdata file type support 2894. base: Added PLDM_SMBIOS & PLDM_RDE message types 2905. oem: meta: Add decode_oem_meta_file_io_req() 2916. state-set: Add all state set values to system power state enum as per DSP0249 2927. platform: Add alias members to the enum 293 pldm_pdr_repository_chg_event_change_record_event_data_operation. 294 295 enum constants with inconsistent names are deprecated with this change. 296 remove old inconsistent enum members after backward compatibility cleanup is 297 done 298 2998. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3009. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 30110. platform: Add 3 PDR type enum for Redfish Device Enablement per 302 DSP0248_1.2.0 30311. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 30412. entity: Add enum for Network Interface Connectors and Network Ports 305 Connection Types 30613. pdr: Add decode_numeric_effecter_pdr_data() 30714. oem: ibm: Support for the Real SAI entity id 30815. fw_update: Add encode req & decode resp for query_downstream_devices 30916. fw_update: Add encode req & decode resp for query_downstream_identifiers 31017. platform: Add support for GetStateEffecterStates command 311 312### Changed 313 3141. base: Stabilise pldm_msg_hdr_correlate_response() 3152. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3163. libpldm: Fix header use 3174. libpldm: More fixes for header use 3185. pdr: Stabilise pldm_pdr_find_last_in_range() API 3196. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3207. oem: meta: stabilise decode_oem_meta_file_io_req() 3218. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 322 323### Deprecated 324 3251. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 326 with `PLDM_OEM_IBM_` 327 328### Fixed 329 3301. libpldm: Rationalise the local and installed path of pldm.h 3312. pdr: Assign record_handle in entity_association_pdr_add_children() 3323. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3334. pdr: Remove redundant constant for minimum numeric sensor PDR length 3345. tests: oem: meta: Fix fileio use of msgbuf 335 336## [0.7.0] - 2023-08-29 337 338### Added 339 3401. state-set: Add new enum for Operational Fault Status enum 341 342### Changed 343 3441. transport: Match specified metadata in pldm_transport_send_recv_msg() 3452. transport: mctp-demux: Drop ABI annotation for internal symbols 3463. transport: Stabilise core transport and implementation APIs 347 348 This stabilisation covers the following headers and functions: 349 350 - libpldm/transport.h 351 352 - pldm_transport_poll() 353 - pldm_transport_send_msg() 354 - pldm_transport_recv_msg() 355 - pldm_transport_send_recv_msg() 356 357 - libpldm/transport/af-mctp.h 358 359 - pldm_transport_af_mctp_init() 360 - pldm_transport_af_mctp_destroy() 361 - pldm_transport_af_mctp_core() 362 - pldm_transport_af_mctp_init_pollfd() 363 - pldm_transport_af_mctp_map_tid() 364 - pldm_transport_af_mctp_unmap_tid() 365 366 - libpldm/transport/mctp-demux.h 367 - pldm_transport_mctp_demux_init() 368 - pldm_transport_mctp_demux_destroy() 369 - pldm_transport_mctp_demux_core() 370 - pldm_transport_mctp_demux_init_pollfd() 371 - pldm_transport_mctp_demux_map_tid() 372 - pldm_transport_mctp_demux_unmap_tid() 373 374### Deprecated 375 3761. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 377 `libpldm/requester/pldm.h`): 378 379 - pldm_open() 380 - pldm_send_recv() 381 - pldm_send() 382 - pldm_recv() 383 - pldm_recv_any() 384 - pldm_close() 385 386 Users should migrate to the newer "transport" APIs instead. 387 388## Fixed 389 3901. tests: Exclude transport tests when build excludes testing ABIs 3912. abi: Capture deprecation of pldm_close() 392 393## [0.6.0] - 2023-08-22 394 395### Changed 396 3971. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 3982. meson: Apply `b_ndebug=if-release` by default 3993. pdr : Stabilize pldm_entity_association_tree_add_entity() 4004. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4015. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4026. transport: af-mctp: Assign out-params on success in \*\_recv() 4037. transport: Generalise the pldm_transport_recv_msg() API 404 405### Removed 406 4071. pdr: Remove pldm_entity_association_pdr_add() 4082. state-set: Remove enum pldm_state_set_operational_fault_status_values 409 410### Fixed 411 4121. transport: register init_pollfd callback for af-mctp 4132. transport: fix init_pollfd function parameter 4143. transport: Fix doxygen and variables for send and recv functions 4154. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 416 417## [0.5.0] - 2023-08-09 418 419### Added 420 4211. pdr: Introduce pldm_entity_association_pdr_add_check() 422 423### Changed 424 4251. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4262. transport: pldm_transport_poll(): Adjust return value semantics 4273. transport: free un-wanted responses in pldm_transport_send_recv_msg() 428 429### Deprecated 430 4311. state-set: Enum pldm_state_set_operational_fault_status_values 432 433 The enum operational_fault_status is defined with wrong members and will 434 eventually be replaced with the correct members. Any uses of 435 pldm_state_set_operational_fault_status_values members should move to 436 equivalent pldm_state_set_operational_stress_status_values members if needed. 437 4382. platform: Struct field name in fru_record_set PDR 439 440 References to entity_instance_num should be changed to entity_instance 441 4423. platform: Struct field name in numeric sensor value PDR 443 444 References to entity_instance_num should be changed to entity_instance 445 446### Removed 447 4481. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4492. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4503. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4514. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4525. bios_table: Remove pldm_bios_table_append_pad_checksum() 4536. fru: Remove get_fru_record_by_option() 4547. pdr: Make is_present() static 4558. pdr: Remove pldm_pdr_add() 4569. pdr: Remove pldm_pdr_add_fru_record_set() 45710. pdr: Remove pldm_entity_association_pdr_add_from_node() 45811. pdr: Make find_entity_ref_in_tree() static 45912. pdr: Make entity_association_tree_find() static 460 461### Fixed 462 4631. requester: Fix response buffer cast in pldm_send_recv() 4642. pdr: Hoist record handle overflow test to avoid memory leak 4653. transport: Correct comparison in while loop condition 466 467## [0.4.0] - 2023-07-14 468 469### Added 470 4711. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4722. fru: Introduce get_fru_record_by_option_check() 4733. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4744. pdr: Introduce pldm_pdr_add_check() 4755. pdr: Introduce pldm_pdr_add_fru_record_set_check() 476 477### Changed 478 4791. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4802. requester: Expose pldm_close() in header 4813. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4824. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4835. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4846. pdr: pldm_pdr_init(): Return NULL on allocation failure 4857. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4868. pdr: Document preconditions for trivial accessor functions 487 488 A trivial accessor function is one that exposes properties of an object in a 489 way can't result in an error, beyond passing an invalid argument to the 490 function. For APIs meeting this definition we define a precondition that 491 struct pointers must point to valid objects to avoid polluting the function 492 prototypes. The following APIs now have this precondition explicitly defined: 493 494 - pldm_entity_extract() 495 - pldm_entity_get_parent() 496 - pldm_entity_is_exist_parent() 497 - pldm_entity_is_node_parent() 498 - pldm_is_current_parent_child 499 - pldm_is_empty_entity_assoc_tree() 500 - pldm_pdr_get_record_count() 501 - pldm_pdr_get_record_handle() 502 - pldm_pdr_get_repo_size() 503 - pldm_pdr_record_is_remote() 504 5059. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 50610. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 50711. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 50812. pdr: pldm_entity_association_tree_visit(): Document preconditions 50913. pdr: pldm_entity_association_tree_visit(): Exit early on failure 51014. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 51115. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 51216. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 51317. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 51418. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 51519. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 51620. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 51721. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 51822. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 51923. pdr: pldm_entity_get_num_children(): Don't return invalid values 52024. libpldm: Lift or remove asserts where a subsequent check exists 521 522### Deprecated 523 5241. pldm_bios_table_attr_entry_integer_encode() 525 526 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 527 5282. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 529 530 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 531 5323. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 533 534 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 535 5364. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 537 538 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 539 5405. pdr: Deprecate is_present() 541 542 There should be no users of this symbol. If you are a user, you should figure 543 out how to stop, or get in touch. This symbol will be marked static the 544 release after deprecation. 545 5466. pdr: Deprecate find_entity_ref_in_tree() 547 548 There should be no users of this symbol. If you are a user, you should figure 549 out how to stop, or get in touch. This symbol will be marked static the 550 release after deprecation. 551 5527. pdr: Deprecate entity_association_tree_find() 553 554 There should be no users of this symbol. If you are a user, you should figure 555 out how to stop, or get in touch. This symbol will be marked static the 556 release after deprecation. 557 5588. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 559 560 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 561 pldm_bios_table_append_pad_checksum() should migrate to 562 pldm_bios_table_append_pad_checksum_check() 563 5649. fru: Stabilise get_fru_record_by_option_check() 565 566 get_fru_record_by_option() is deprecated by this change. Users of 567 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 568 56910. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 570 571 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 572 Users of pldm_entity_association_pdr_add_from_node() should migrate to 573 pldm_entity_association_pdr_add_from_node_check() 574 57511. pdr: Stabilise pldm_pdr_add_check() 576 577 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 578 migrate to pldm_pdr_add_check() 579 58012. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 581 582 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 583 pldm_pdr_add_fru_record_set() should migrate to 584 pldm_pdr_add_fru_record_set_check() 585 586### Removed 587 5881. bios_table: Remove deprecated APIs sanitized by assert(): 589 590 - pldm_bios_table_string_entry_encode() 591 - pldm_bios_table_string_entry_decode_string() 592 - pldm_bios_table_attr_entry_enum_encode() 593 - pldm_bios_table_attr_entry_enum_decode_pv_num() 594 - pldm_bios_table_attr_entry_enum_decode_def_num() 595 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 596 - pldm_bios_table_attr_entry_string_encode() 597 - pldm_bios_table_attr_entry_string_decode_def_string_length() 598 599### Fixed 600 6011. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6022. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6033. transport: mctp-demux: Don't test socket for non-zero value 6044. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6055. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6066. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6077. abi: Update to remove pldm_close() from reference dumps 6088. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 609 610## [0.3.0] - 2023-06-23 611 612### Added 613 6141. Add encode/decode pldmMessagePollEvent data 6152. README: Add a section on working with libpldm 6163. pdr: Introduce remote_container_id and associated APIs 6174. pdr: Add APIs for creating and locating remote PDRs 6185. pdr: Add pldm_pdr_find_last_in_range() 6196. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6207. pdr: Add pldm_pdr_find_container_id_range_exclude() 621 622### Changed 623 6241. include: Move installed transport.h under libpldm/ 6252. libpldm: Explicit deprecated, stable and testing ABI classes 6263. meson: Reduce strength of oem-ibm requirements from enabled to allowed 627 628 The `oem-ibm` feature is now enabled by the default meson configuration, for 629 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 630 recipe: 631 632 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 633 634 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 635 when invoking `meson setup` 636 6374. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6385. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 639 640### Deprecated 641 6421. bios_table: Deprecate APIs with arguments sanitized using assert() 643 644 C provides enough foot-guns without us encoding them into library APIs. 645 Specifically, deprecate the following in favour of their `*_check()` variants 646 which ensure assertions won't fail or otherwise invoke UB: 647 648 - pldm_bios_table_string_entry_encode() 649 - pldm_bios_table_string_entry_decode_string() 650 - pldm_bios_table_attr_entry_enum_encode() 651 - pldm_bios_table_attr_entry_enum_decode_pv_num() 652 - pldm_bios_table_attr_entry_enum_decode_def_num() 653 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 654 - pldm_bios_table_attr_entry_string_encode() 655 - pldm_bios_table_attr_entry_string_decode_def_string_length() 656 657### Removed 658 6591. libpldm: Remove the requester-api option 660 661### Fixed 662 6631. requester: Make pldm_open() return existing fd 6642. transport: Prevent sticking in waiting for response 6653. transport: Match on response in pldm_transport_send_recv_msg() 6664. requester: Add check before accessing hdr in pldm_recv() 6675. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 668