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## [0.10.0] 2024-11-01 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 3510. stateset: Add new state sets from DSP0249 v1.3.0 36 37### Changed 38 391. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 40 41 pldm_bios_table_iter_is_end() now returns true if the provided argument is 42 NULL. 43 442. Register assignment for parameters of a number of APIs changed with increased 45 scrutiny on their implementations. 46 47 - `decode_entity_auxiliary_names_pdr()` 48 - `decode_get_state_sensor_readings_resp()` 49 - `decode_oem_meta_file_io_req()` 50 - `decode_platform_event_message_req()` 51 - `decode_platform_event_message_resp()` 52 - `decode_sensor_op_data()` 53 - `encode_get_state_effecter_states_resp()` 54 - `encode_state_effecter_pdr()` 55 - `encode_state_sensor_pdr()` 56 - `pldm_bios_table_append_pad_checksum()` 57 - `pldm_bios_table_attr_value_entry_encode_enum()` 58 - `pldm_bios_table_attr_value_entry_encode_string()` 59 - `pldm_pdr_find_record()` 60 - `pldm_pdr_get_next_record()` 61 623. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 63 644. dsp: firmware_update: Bounds check 65 decode_downstream_device_parameter_table_entry_versions() 66 67 The additional bounds-checking required the addition of further length 68 parameters. 69 70### Deprecated 71 721. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 73 74 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 75 function to make it safer. 76 77 Modification: 78 79 - The meaning of the returned result. 80 - Change parameters from individual pointers to a struct. 81 - Check the length provided in the message won't exceed the buffer. 82 832. pldm_entity_association_tree_copy_root() 84 85 The implementation allocates, but gives no indication to the caller if an 86 allocation (and hence the copy) has failed. Users should migrate to 87 pldm_entity_association_tree_copy_root_check(). 88 893. The following APIs are deprecated as unsafe due to various unfixable CWE 90 violations: 91 92 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 93 94 - `encode_get_bios_current_value_by_handle_resp()` 95 - `encode_get_bios_table_resp()` 96 - `encode_get_file_table_resp()` 97 - `encode_get_version_resp()` 98 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 99 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 100 - `pldm_bios_table_attr_find_by_handle()` 101 - `pldm_bios_table_attr_find_by_string_handle()` 102 - `pldm_bios_table_attr_value_find_by_handle()` 103 - `pldm_bios_table_iter_create()` 104 - `pldm_bios_table_iter_is_end()` 105 - `pldm_bios_table_string_find_by_handle()` 106 - `pldm_bios_table_string_find_by_string()` 107 108 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 109 110 - `pldm_entity_association_tree_copy_root()` 111 112 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 113 114 - `decode_oem_meta_file_io_req()` 115 116 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 117 - `encode_fru_record()` 118 - `encode_get_pdr_resp()` 119 - `pldm_bios_table_attr_entry_enum_encode_length()` 120 121### Removed 122 1231. Deprecated functions with the `_check` suffix 124 125 - `get_fru_record_by_option_check()` 126 - `pldm_bios_table_append_pad_checksum_check()` 127 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 128 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 129 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 130 - `pldm_bios_table_attr_entry_enum_encode_check()` 131 - `pldm_bios_table_attr_entry_integer_encode_check()` 132 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 133 - `pldm_bios_table_attr_entry_string_encode_check()` 134 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 135 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 136 - `pldm_bios_table_attr_value_entry_encode_string_check()` 137 - `pldm_bios_table_string_entry_decode_string_check()` 138 - `pldm_bios_table_string_entry_encode_check()` 139 - `pldm_entity_association_pdr_add_check()` 140 - `pldm_entity_association_pdr_add_from_node_check()` 141 - `pldm_pdr_add_check()` 142 - `pldm_pdr_add_fru_record_set_check()` 143 144### Fixed 145 1461. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 147 148 Avoid a caller-controlled NULL pointer dereference in the library 149 implementation. 150 1512. platform: fix encode/decode_poll_for_platform_event_message_req 152 153 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 154 follow spec. 155 1563. platform: Fix checking `eventIDToAcknowledge` 157 158 As the event receiver sends `PollForPlatformEventMessage` with the 159 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 160 should be the previously retrieved eventID (from the PLDM terminus). 161 1624. dsp: platform: Prevent overflow of arithmetic on event_data_length 1635. dsp: platform: Bounds check encode_sensor_state_pdr() 1646. dsp: platform: Bounds check encode_state_effecter_pdr() 1657. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1668. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1679. dsp: bios_table: Bounds check 168 pldm_bios_table_attr_value_entry_encode_string() 16910. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 17011. dsp: firmware_update: Bounds check 171 decode_downstream_device_parameter_table_entry_versions() 17212. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 17313. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 17414. dsp: fru: Bounds check encode_fru_record() 17515. dsp: bios: Bounds check encode_set_bios_table_req() 17616. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 17717. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 17818. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 17919. dsp: platform: Fix decode_set_event_receiver_req() 180 181## [0.9.1] - 2024-09-07 182 183### Changed 184 1851. Moved evolutions intended for v0.9.0 into place 186 187 Evolutions for the release have been moved from `evolutions/current` to 188 `evolutions/v0.9.1`. Library users can apply them to migrate off of 189 deprecated APIs. 190 191## [0.9.0] - 2024-09-07 192 193### Added 194 1951. base: Define macros for reserved TIDs 1962. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1973. pdr: Add pldm_entity_association_pdr_create_new() 1984. platform: Define macros for the responded transferflags 1995. pdr: Add pldm_pdr_get_terminus_handle() API 2006. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2017. fw_update: Add encode req & decode resp for get_downstream_fw_params 2028. platform: Add decode_pldm_platform_cper_event() API 2039. decode_get_pdr_repository_info_resp_safe() 204 205 Replaces decode_get_pdr_repository_info_resp() as discussed in the 206 `Deprecated` section below 207 20810. decode_get_pdr_resp_safe() 209 210 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 211 below 212 213### Changed 214 2151. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2162. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2173. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2184. ABI break for decode_sensor_op_data() 219 220 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 221 abi-compliance-checker to flag a change in the register containing the 222 parameter `previous_op_state`. 223 2245. platform: Stabilise decode_pldm_platform_cper_event() API 2256. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2267. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2278. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 228 229### Deprecated 230 2311. Rename and deprecate functions with the `_check` suffix 232 233 All library function return values always need to be checked. The `_check` 234 suffix is redundant, so remove it. Migration to the non-deprecated 235 equivalents without the `_check` suffix can be performed using 236 `scripts/ apply-renames` and the [clang-rename][] configurations under 237 `evolutions/` 238 239 The deprecated functions: 240 241 - `get_fru_record_by_option_check()` 242 - `pldm_bios_table_append_pad_checksum_check()` 243 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 244 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 245 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 246 - `pldm_bios_table_attr_entry_enum_encode_check()` 247 - `pldm_bios_table_attr_entry_integer_encode_check()` 248 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 249 - `pldm_bios_table_attr_entry_string_encode_check()` 250 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 251 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 252 - `pldm_bios_table_attr_value_entry_encode_string_check()` 253 - `pldm_bios_table_string_entry_decode_string_check()` 254 - `pldm_bios_table_string_entry_encode_check()` 255 - `pldm_entity_association_pdr_add_check()` 256 - `pldm_entity_association_pdr_add_from_node_check()` 257 - `pldm_pdr_add_check()` 258 - `pldm_pdr_add_fru_record_set_check()` 259 260[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 261 2622. `decode_get_pdr_repository_info_resp()` 263 264 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 265 eliminates the opportunity for buffer overruns when extracting objects from 266 the message. 267 2683. `decode_get_pdr_resp()` 269 270 Users should move to `decode_get_pdr_resp_safe()` which reduces the 271 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 272 273### Removed 274 2751. IBM OEM header compatibility symlinks. 276 277 Anyone left using the deprecated paths can migrate using the coccinelle patch 278 at `evolutions/current/oem-ibm-header-compat.cocci`. 279 280### Fixed 281 2821. requester: instance-id: Release read lock on conflict 2832. pdr: Error propagation for 284 pldm_entity_association_pdr_add_from_node_with_record_handle() 285 286## [0.8.0] - 2024-05-23 287 288### Added 289 2901. base: Provide pldm_msg_hdr_correlate_response() 2912. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2923. oem: ibm: Add chapdata file type support 2934. base: Added PLDM_SMBIOS & PLDM_RDE message types 2945. oem: meta: Add decode_oem_meta_file_io_req() 2956. state-set: Add all state set values to system power state enum as per DSP0249 2967. platform: Add alias members to the enum 297 pldm_pdr_repository_chg_event_change_record_event_data_operation. 298 299 enum constants with inconsistent names are deprecated with this change. 300 remove old inconsistent enum members after backward compatibility cleanup is 301 done 302 3038. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3049. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 30510. platform: Add 3 PDR type enum for Redfish Device Enablement per 306 DSP0248_1.2.0 30711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 30812. entity: Add enum for Network Interface Connectors and Network Ports 309 Connection Types 31013. pdr: Add decode_numeric_effecter_pdr_data() 31114. oem: ibm: Support for the Real SAI entity id 31215. fw_update: Add encode req & decode resp for query_downstream_devices 31316. fw_update: Add encode req & decode resp for query_downstream_identifiers 31417. platform: Add support for GetStateEffecterStates command 315 316### Changed 317 3181. base: Stabilise pldm_msg_hdr_correlate_response() 3192. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3203. libpldm: Fix header use 3214. libpldm: More fixes for header use 3225. pdr: Stabilise pldm_pdr_find_last_in_range() API 3236. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3247. oem: meta: stabilise decode_oem_meta_file_io_req() 3258. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 326 327### Deprecated 328 3291. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 330 with `PLDM_OEM_IBM_` 331 332### Fixed 333 3341. libpldm: Rationalise the local and installed path of pldm.h 3352. pdr: Assign record_handle in entity_association_pdr_add_children() 3363. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3374. pdr: Remove redundant constant for minimum numeric sensor PDR length 3385. tests: oem: meta: Fix fileio use of msgbuf 339 340## [0.7.0] - 2023-08-29 341 342### Added 343 3441. state-set: Add new enum for Operational Fault Status enum 345 346### Changed 347 3481. transport: Match specified metadata in pldm_transport_send_recv_msg() 3492. transport: mctp-demux: Drop ABI annotation for internal symbols 3503. transport: Stabilise core transport and implementation APIs 351 352 This stabilisation covers the following headers and functions: 353 354 - libpldm/transport.h 355 356 - pldm_transport_poll() 357 - pldm_transport_send_msg() 358 - pldm_transport_recv_msg() 359 - pldm_transport_send_recv_msg() 360 361 - libpldm/transport/af-mctp.h 362 363 - pldm_transport_af_mctp_init() 364 - pldm_transport_af_mctp_destroy() 365 - pldm_transport_af_mctp_core() 366 - pldm_transport_af_mctp_init_pollfd() 367 - pldm_transport_af_mctp_map_tid() 368 - pldm_transport_af_mctp_unmap_tid() 369 370 - libpldm/transport/mctp-demux.h 371 - pldm_transport_mctp_demux_init() 372 - pldm_transport_mctp_demux_destroy() 373 - pldm_transport_mctp_demux_core() 374 - pldm_transport_mctp_demux_init_pollfd() 375 - pldm_transport_mctp_demux_map_tid() 376 - pldm_transport_mctp_demux_unmap_tid() 377 378### Deprecated 379 3801. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 381 `libpldm/requester/pldm.h`): 382 383 - pldm_open() 384 - pldm_send_recv() 385 - pldm_send() 386 - pldm_recv() 387 - pldm_recv_any() 388 - pldm_close() 389 390 Users should migrate to the newer "transport" APIs instead. 391 392## Fixed 393 3941. tests: Exclude transport tests when build excludes testing ABIs 3952. abi: Capture deprecation of pldm_close() 396 397## [0.6.0] - 2023-08-22 398 399### Changed 400 4011. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4022. meson: Apply `b_ndebug=if-release` by default 4033. pdr : Stabilize pldm_entity_association_tree_add_entity() 4044. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4055. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4066. transport: af-mctp: Assign out-params on success in \*\_recv() 4077. transport: Generalise the pldm_transport_recv_msg() API 408 409### Removed 410 4111. pdr: Remove pldm_entity_association_pdr_add() 4122. state-set: Remove enum pldm_state_set_operational_fault_status_values 413 414### Fixed 415 4161. transport: register init_pollfd callback for af-mctp 4172. transport: fix init_pollfd function parameter 4183. transport: Fix doxygen and variables for send and recv functions 4194. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 420 421## [0.5.0] - 2023-08-09 422 423### Added 424 4251. pdr: Introduce pldm_entity_association_pdr_add_check() 426 427### Changed 428 4291. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4302. transport: pldm_transport_poll(): Adjust return value semantics 4313. transport: free un-wanted responses in pldm_transport_send_recv_msg() 432 433### Deprecated 434 4351. state-set: Enum pldm_state_set_operational_fault_status_values 436 437 The enum operational_fault_status is defined with wrong members and will 438 eventually be replaced with the correct members. Any uses of 439 pldm_state_set_operational_fault_status_values members should move to 440 equivalent pldm_state_set_operational_stress_status_values members if needed. 441 4422. platform: Struct field name in fru_record_set PDR 443 444 References to entity_instance_num should be changed to entity_instance 445 4463. platform: Struct field name in numeric sensor value PDR 447 448 References to entity_instance_num should be changed to entity_instance 449 450### Removed 451 4521. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4532. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4543. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4554. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4565. bios_table: Remove pldm_bios_table_append_pad_checksum() 4576. fru: Remove get_fru_record_by_option() 4587. pdr: Make is_present() static 4598. pdr: Remove pldm_pdr_add() 4609. pdr: Remove pldm_pdr_add_fru_record_set() 46110. pdr: Remove pldm_entity_association_pdr_add_from_node() 46211. pdr: Make find_entity_ref_in_tree() static 46312. pdr: Make entity_association_tree_find() static 464 465### Fixed 466 4671. requester: Fix response buffer cast in pldm_send_recv() 4682. pdr: Hoist record handle overflow test to avoid memory leak 4693. transport: Correct comparison in while loop condition 470 471## [0.4.0] - 2023-07-14 472 473### Added 474 4751. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4762. fru: Introduce get_fru_record_by_option_check() 4773. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4784. pdr: Introduce pldm_pdr_add_check() 4795. pdr: Introduce pldm_pdr_add_fru_record_set_check() 480 481### Changed 482 4831. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4842. requester: Expose pldm_close() in header 4853. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4864. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4875. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4886. pdr: pldm_pdr_init(): Return NULL on allocation failure 4897. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4908. pdr: Document preconditions for trivial accessor functions 491 492 A trivial accessor function is one that exposes properties of an object in a 493 way can't result in an error, beyond passing an invalid argument to the 494 function. For APIs meeting this definition we define a precondition that 495 struct pointers must point to valid objects to avoid polluting the function 496 prototypes. The following APIs now have this precondition explicitly defined: 497 498 - pldm_entity_extract() 499 - pldm_entity_get_parent() 500 - pldm_entity_is_exist_parent() 501 - pldm_entity_is_node_parent() 502 - pldm_is_current_parent_child 503 - pldm_is_empty_entity_assoc_tree() 504 - pldm_pdr_get_record_count() 505 - pldm_pdr_get_record_handle() 506 - pldm_pdr_get_repo_size() 507 - pldm_pdr_record_is_remote() 508 5099. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 51010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 51111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 51212. pdr: pldm_entity_association_tree_visit(): Document preconditions 51313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 51414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 51515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 51616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 51717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 51818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 51919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 52020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 52121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 52222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 52323. pdr: pldm_entity_get_num_children(): Don't return invalid values 52424. libpldm: Lift or remove asserts where a subsequent check exists 525 526### Deprecated 527 5281. pldm_bios_table_attr_entry_integer_encode() 529 530 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 531 5322. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 533 534 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 535 5363. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 537 538 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 539 5404. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 541 542 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 543 5445. pdr: Deprecate is_present() 545 546 There should be no users of this symbol. If you are a user, you should figure 547 out how to stop, or get in touch. This symbol will be marked static the 548 release after deprecation. 549 5506. pdr: Deprecate find_entity_ref_in_tree() 551 552 There should be no users of this symbol. If you are a user, you should figure 553 out how to stop, or get in touch. This symbol will be marked static the 554 release after deprecation. 555 5567. pdr: Deprecate entity_association_tree_find() 557 558 There should be no users of this symbol. If you are a user, you should figure 559 out how to stop, or get in touch. This symbol will be marked static the 560 release after deprecation. 561 5628. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 563 564 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 565 pldm_bios_table_append_pad_checksum() should migrate to 566 pldm_bios_table_append_pad_checksum_check() 567 5689. fru: Stabilise get_fru_record_by_option_check() 569 570 get_fru_record_by_option() is deprecated by this change. Users of 571 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 572 57310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 574 575 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 576 Users of pldm_entity_association_pdr_add_from_node() should migrate to 577 pldm_entity_association_pdr_add_from_node_check() 578 57911. pdr: Stabilise pldm_pdr_add_check() 580 581 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 582 migrate to pldm_pdr_add_check() 583 58412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 585 586 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 587 pldm_pdr_add_fru_record_set() should migrate to 588 pldm_pdr_add_fru_record_set_check() 589 590### Removed 591 5921. bios_table: Remove deprecated APIs sanitized by assert(): 593 594 - pldm_bios_table_string_entry_encode() 595 - pldm_bios_table_string_entry_decode_string() 596 - pldm_bios_table_attr_entry_enum_encode() 597 - pldm_bios_table_attr_entry_enum_decode_pv_num() 598 - pldm_bios_table_attr_entry_enum_decode_def_num() 599 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 600 - pldm_bios_table_attr_entry_string_encode() 601 - pldm_bios_table_attr_entry_string_decode_def_string_length() 602 603### Fixed 604 6051. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6062. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6073. transport: mctp-demux: Don't test socket for non-zero value 6084. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6095. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6106. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6117. abi: Update to remove pldm_close() from reference dumps 6128. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 613 614## [0.3.0] - 2023-06-23 615 616### Added 617 6181. Add encode/decode pldmMessagePollEvent data 6192. README: Add a section on working with libpldm 6203. pdr: Introduce remote_container_id and associated APIs 6214. pdr: Add APIs for creating and locating remote PDRs 6225. pdr: Add pldm_pdr_find_last_in_range() 6236. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6247. pdr: Add pldm_pdr_find_container_id_range_exclude() 625 626### Changed 627 6281. include: Move installed transport.h under libpldm/ 6292. libpldm: Explicit deprecated, stable and testing ABI classes 6303. meson: Reduce strength of oem-ibm requirements from enabled to allowed 631 632 The `oem-ibm` feature is now enabled by the default meson configuration, for 633 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 634 recipe: 635 636 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 637 638 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 639 when invoking `meson setup` 640 6414. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6425. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 643 644### Deprecated 645 6461. bios_table: Deprecate APIs with arguments sanitized using assert() 647 648 C provides enough foot-guns without us encoding them into library APIs. 649 Specifically, deprecate the following in favour of their `*_check()` variants 650 which ensure assertions won't fail or otherwise invoke UB: 651 652 - pldm_bios_table_string_entry_encode() 653 - pldm_bios_table_string_entry_decode_string() 654 - pldm_bios_table_attr_entry_enum_encode() 655 - pldm_bios_table_attr_entry_enum_decode_pv_num() 656 - pldm_bios_table_attr_entry_enum_decode_def_num() 657 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 658 - pldm_bios_table_attr_entry_string_encode() 659 - pldm_bios_table_attr_entry_string_decode_def_string_length() 660 661### Removed 662 6631. libpldm: Remove the requester-api option 664 665### Fixed 666 6671. requester: Make pldm_open() return existing fd 6682. transport: Prevent sticking in waiting for response 6693. transport: Match on response in pldm_transport_send_recv_msg() 6704. requester: Add check before accessing hdr in pldm_recv() 6715. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 672