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. Deprecated functions with the `_check` suffix 23 24 - `pldm_bios_table_append_pad_checksum_check()` 25 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 26 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 27 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 28 - `pldm_bios_table_attr_entry_enum_encode_check()` 29 - `pldm_bios_table_attr_entry_integer_encode_check()` 30 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 31 - `pldm_bios_table_attr_entry_string_encode_check()` 32 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 33 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 34 - `pldm_bios_table_attr_value_entry_encode_string_check()` 35 - `pldm_bios_table_string_entry_decode_string_check()` 36 - `pldm_bios_table_string_entry_encode_check()` 37 - `pldm_entity_association_pdr_add_check()` 38 - `pldm_entity_association_pdr_add_from_node_check()` 39 40## [0.9.1] - 2024-09-07 41 42### Changed 43 441. Moved evolutions intended for v0.9.0 into place 45 46 Evolutions for the release have been moved from `evolutions/current` to 47 `evolutions/v0.9.1`. Library users can apply them to migrate off of 48 deprecated APIs. 49 50## [0.9.0] - 2024-09-07 51 52### Added 53 541. base: Define macros for reserved TIDs 552. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 563. pdr: Add pldm_entity_association_pdr_create_new() 574. platform: Define macros for the responded transferflags 585. pdr: Add pldm_pdr_get_terminus_handle() API 596. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 607. fw_update: Add encode req & decode resp for get_downstream_fw_params 618. platform: Add decode_pldm_platform_cper_event() API 629. decode_get_pdr_repository_info_resp_safe() 63 64 Replaces decode_get_pdr_repository_info_resp() as discussed in the 65 `Deprecated` section below 66 6710. decode_get_pdr_resp_safe() 68 69 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 70 below 71 72### Changed 73 741. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 752. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 763. platform: Stabilise decode_pldm_message_poll_event_data() APIs 774. ABI break for decode_sensor_op_data() 78 79 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 80 abi-compliance-checker to flag a change in the register containing the 81 parameter `previous_op_state`. 82 835. platform: Stabilise decode_pldm_platform_cper_event() API 84 85### Deprecated 86 871. Rename and deprecate functions with the `_check` suffix 88 89 All library function return values always need to be checked. The `_check` 90 suffix is redundant, so remove it. Migration to the non-deprecated 91 equivalents without the `_check` suffix can be performed using 92 `scripts/ apply-renames` and the [clang-rename][] configurations under 93 `evolutions/` 94 95 The deprecated functions: 96 97 - `get_fru_record_by_option_check()` 98 - `pldm_bios_table_append_pad_checksum_check()` 99 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 100 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 101 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 102 - `pldm_bios_table_attr_entry_enum_encode_check()` 103 - `pldm_bios_table_attr_entry_integer_encode_check()` 104 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 105 - `pldm_bios_table_attr_entry_string_encode_check()` 106 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 107 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 108 - `pldm_bios_table_attr_value_entry_encode_string_check()` 109 - `pldm_bios_table_string_entry_decode_string_check()` 110 - `pldm_bios_table_string_entry_encode_check()` 111 - `pldm_entity_association_pdr_add_check()` 112 - `pldm_entity_association_pdr_add_from_node_check()` 113 - `pldm_pdr_add_check()` 114 - `pldm_pdr_add_fru_record_set_check()` 115 116[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 117 1182. `decode_get_pdr_repository_info_resp()` 119 120 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 121 eliminates the opportunity for buffer overruns when extracting objects from 122 the message. 123 1243. `decode_get_pdr_resp()` 125 126 Users should move to `decode_get_pdr_resp_safe()` which reduces the 127 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 128 129### Removed 130 1311. IBM OEM header compatibility symlinks. 132 133 Anyone left using the deprecated paths can migrate using the coccinelle patch 134 at `evolutions/current/oem-ibm-header-compat.cocci`. 135 136### Fixed 137 1381. requester: instance-id: Release read lock on conflict 139 140## [0.8.0] - 2024-05-23 141 142### Added 143 1441. base: Provide pldm_msg_hdr_correlate_response() 1452. transport: af-mctp: Add pldm_transport_af_mctp_bind() 1463. oem: ibm: Add chapdata file type support 1474. base: Added PLDM_SMBIOS & PLDM_RDE message types 1485. oem: meta: Add decode_oem_meta_file_io_req() 1496. state-set: Add all state set values to system power state enum as per DSP0249 1507. platform: Add alias members to the enum 151 pldm_pdr_repository_chg_event_change_record_event_data_operation. 152 153 enum constants with inconsistent names are deprecated with this change. 154 remove old inconsistent enum members after backward compatibility cleanup is 155 done 156 1578. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 1589. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 15910. platform: Add 3 PDR type enum for Redfish Device Enablement per 160 DSP0248_1.2.0 16111. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 16212. entity: Add enum for Network Interface Connectors and Network Ports 163 Connection Types 16413. pdr: Add decode_numeric_effecter_pdr_data() 16514. oem: ibm: Support for the Real SAI entity id 16615. fw_update: Add encode req & decode resp for query_downstream_devices 16716. fw_update: Add encode req & decode resp for query_downstream_identifiers 16817. platform: Add support for GetStateEffecterStates command 169 170### Changed 171 1721. base: Stabilise pldm_msg_hdr_correlate_response() 1732. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1743. libpldm: Fix header use 1754. libpldm: More fixes for header use 1765. pdr: Stabilise pldm_pdr_find_last_in_range() API 1776. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1787. oem: meta: stabilise decode_oem_meta_file_io_req() 1798. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 180 181### Deprecated 182 1831. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 184 with `PLDM_OEM_IBM_` 185 186### Fixed 187 1881. libpldm: Rationalise the local and installed path of pldm.h 1892. pdr: Assign record_handle in entity_association_pdr_add_children() 1903. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1914. pdr: Remove redundant constant for minimum numeric sensor PDR length 1925. tests: oem: meta: Fix fileio use of msgbuf 193 194## [0.7.0] - 2023-08-29 195 196### Added 197 1981. state-set: Add new enum for Operational Fault Status enum 199 200### Changed 201 2021. transport: Match specified metadata in pldm_transport_send_recv_msg() 2032. transport: mctp-demux: Drop ABI annotation for internal symbols 2043. transport: Stabilise core transport and implementation APIs 205 206 This stabilisation covers the following headers and functions: 207 208 - libpldm/transport.h 209 210 - pldm_transport_poll() 211 - pldm_transport_send_msg() 212 - pldm_transport_recv_msg() 213 - pldm_transport_send_recv_msg() 214 215 - libpldm/transport/af-mctp.h 216 217 - pldm_transport_af_mctp_init() 218 - pldm_transport_af_mctp_destroy() 219 - pldm_transport_af_mctp_core() 220 - pldm_transport_af_mctp_init_pollfd() 221 - pldm_transport_af_mctp_map_tid() 222 - pldm_transport_af_mctp_unmap_tid() 223 224 - libpldm/transport/mctp-demux.h 225 - pldm_transport_mctp_demux_init() 226 - pldm_transport_mctp_demux_destroy() 227 - pldm_transport_mctp_demux_core() 228 - pldm_transport_mctp_demux_init_pollfd() 229 - pldm_transport_mctp_demux_map_tid() 230 - pldm_transport_mctp_demux_unmap_tid() 231 232### Deprecated 233 2341. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 235 `libpldm/requester/pldm.h`): 236 237 - pldm_open() 238 - pldm_send_recv() 239 - pldm_send() 240 - pldm_recv() 241 - pldm_recv_any() 242 - pldm_close() 243 244 Users should migrate to the newer "transport" APIs instead. 245 246## Fixed 247 2481. tests: Exclude transport tests when build excludes testing ABIs 2492. abi: Capture deprecation of pldm_close() 250 251## [0.6.0] - 2023-08-22 252 253### Changed 254 2551. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 2562. meson: Apply `b_ndebug=if-release` by default 2573. pdr : Stabilize pldm_entity_association_tree_add_entity() 2584. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 2595. pdr: Stabilize pldm_entity_node_get_remote_container_id() 2606. transport: af-mctp: Assign out-params on success in \*\_recv() 2617. transport: Generalise the pldm_transport_recv_msg() API 262 263### Removed 264 2651. pdr: Remove pldm_entity_association_pdr_add() 2662. state-set: Remove enum pldm_state_set_operational_fault_status_values 267 268### Fixed 269 2701. transport: register init_pollfd callback for af-mctp 2712. transport: fix init_pollfd function parameter 2723. transport: Fix doxygen and variables for send and recv functions 2734. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 274 275## [0.5.0] - 2023-08-09 276 277### Added 278 2791. pdr: Introduce pldm_entity_association_pdr_add_check() 280 281### Changed 282 2831. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2842. transport: pldm_transport_poll(): Adjust return value semantics 2853. transport: free un-wanted responses in pldm_transport_send_recv_msg() 286 287### Deprecated 288 2891. state-set: Enum pldm_state_set_operational_fault_status_values 290 291 The enum operational_fault_status is defined with wrong members and will 292 eventually be replaced with the correct members. Any uses of 293 pldm_state_set_operational_fault_status_values members should move to 294 equivalent pldm_state_set_operational_stress_status_values members if needed. 295 2962. platform: Struct field name in fru_record_set PDR 297 298 References to entity_instance_num should be changed to entity_instance 299 3003. platform: Struct field name in numeric sensor value PDR 301 302 References to entity_instance_num should be changed to entity_instance 303 304### Removed 305 3061. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 3072. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 3083. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 3094. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 3105. bios_table: Remove pldm_bios_table_append_pad_checksum() 3116. fru: Remove get_fru_record_by_option() 3127. pdr: Make is_present() static 3138. pdr: Remove pldm_pdr_add() 3149. pdr: Remove pldm_pdr_add_fru_record_set() 31510. pdr: Remove pldm_entity_association_pdr_add_from_node() 31611. pdr: Make find_entity_ref_in_tree() static 31712. pdr: Make entity_association_tree_find() static 318 319### Fixed 320 3211. requester: Fix response buffer cast in pldm_send_recv() 3222. pdr: Hoist record handle overflow test to avoid memory leak 3233. transport: Correct comparison in while loop condition 324 325## [0.4.0] - 2023-07-14 326 327### Added 328 3291. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 3302. fru: Introduce get_fru_record_by_option_check() 3313. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 3324. pdr: Introduce pldm_pdr_add_check() 3335. pdr: Introduce pldm_pdr_add_fru_record_set_check() 334 335### Changed 336 3371. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 3382. requester: Expose pldm_close() in header 3393. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 3404. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 3415. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 3426. pdr: pldm_pdr_init(): Return NULL on allocation failure 3437. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 3448. pdr: Document preconditions for trivial accessor functions 345 346 A trivial accessor function is one that exposes properties of an object in a 347 way can't result in an error, beyond passing an invalid argument to the 348 function. For APIs meeting this definition we define a precondition that 349 struct pointers must point to valid objects to avoid polluting the function 350 prototypes. The following APIs now have this precondition explicitly defined: 351 352 - pldm_entity_extract() 353 - pldm_entity_get_parent() 354 - pldm_entity_is_exist_parent() 355 - pldm_entity_is_node_parent() 356 - pldm_is_current_parent_child 357 - pldm_is_empty_entity_assoc_tree() 358 - pldm_pdr_get_record_count() 359 - pldm_pdr_get_record_handle() 360 - pldm_pdr_get_repo_size() 361 - pldm_pdr_record_is_remote() 362 3639. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 36410. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 36511. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 36612. pdr: pldm_entity_association_tree_visit(): Document preconditions 36713. pdr: pldm_entity_association_tree_visit(): Exit early on failure 36814. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 36915. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 37016. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 37117. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 37218. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 37319. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 37420. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 37521. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 37622. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 37723. pdr: pldm_entity_get_num_children(): Don't return invalid values 37824. libpldm: Lift or remove asserts where a subsequent check exists 379 380### Deprecated 381 3821. pldm_bios_table_attr_entry_integer_encode() 383 384 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 385 3862. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 387 388 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 389 3903. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 391 392 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 393 3944. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 395 396 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 397 3985. pdr: Deprecate is_present() 399 400 There should be no users of this symbol. If you are a user, you should figure 401 out how to stop, or get in touch. This symbol will be marked static the 402 release after deprecation. 403 4046. pdr: Deprecate find_entity_ref_in_tree() 405 406 There should be no users of this symbol. If you are a user, you should figure 407 out how to stop, or get in touch. This symbol will be marked static the 408 release after deprecation. 409 4107. pdr: Deprecate entity_association_tree_find() 411 412 There should be no users of this symbol. If you are a user, you should figure 413 out how to stop, or get in touch. This symbol will be marked static the 414 release after deprecation. 415 4168. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 417 418 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 419 pldm_bios_table_append_pad_checksum() should migrate to 420 pldm_bios_table_append_pad_checksum_check() 421 4229. fru: Stabilise get_fru_record_by_option_check() 423 424 get_fru_record_by_option() is deprecated by this change. Users of 425 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 426 42710. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 428 429 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 430 Users of pldm_entity_association_pdr_add_from_node() should migrate to 431 pldm_entity_association_pdr_add_from_node_check() 432 43311. pdr: Stabilise pldm_pdr_add_check() 434 435 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 436 migrate to pldm_pdr_add_check() 437 43812. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 439 440 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 441 pldm_pdr_add_fru_record_set() should migrate to 442 pldm_pdr_add_fru_record_set_check() 443 444### Removed 445 4461. bios_table: Remove deprecated APIs sanitized by assert(): 447 448 - pldm_bios_table_string_entry_encode() 449 - pldm_bios_table_string_entry_decode_string() 450 - pldm_bios_table_attr_entry_enum_encode() 451 - pldm_bios_table_attr_entry_enum_decode_pv_num() 452 - pldm_bios_table_attr_entry_enum_decode_def_num() 453 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 454 - pldm_bios_table_attr_entry_string_encode() 455 - pldm_bios_table_attr_entry_string_decode_def_string_length() 456 457### Fixed 458 4591. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 4602. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 4613. transport: mctp-demux: Don't test socket for non-zero value 4624. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 4635. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 4646. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 4657. abi: Update to remove pldm_close() from reference dumps 4668. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 467 468## [0.3.0] - 2023-06-23 469 470### Added 471 4721. Add encode/decode pldmMessagePollEvent data 4732. README: Add a section on working with libpldm 4743. pdr: Introduce remote_container_id and associated APIs 4754. pdr: Add APIs for creating and locating remote PDRs 4765. pdr: Add pldm_pdr_find_last_in_range() 4776. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4787. pdr: Add pldm_pdr_find_container_id_range_exclude() 479 480### Changed 481 4821. include: Move installed transport.h under libpldm/ 4832. libpldm: Explicit deprecated, stable and testing ABI classes 4843. meson: Reduce strength of oem-ibm requirements from enabled to allowed 485 486 The `oem-ibm` feature is now enabled by the default meson configuration, for 487 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 488 recipe: 489 490 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 491 492 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 493 when invoking `meson setup` 494 4954. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4965. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 497 498### Deprecated 499 5001. bios_table: Deprecate APIs with arguments sanitized using assert() 501 502 C provides enough foot-guns without us encoding them into library APIs. 503 Specifically, deprecate the following in favour of their `*_check()` variants 504 which ensure assertions won't fail or otherwise invoke UB: 505 506 - pldm_bios_table_string_entry_encode() 507 - pldm_bios_table_string_entry_decode_string() 508 - pldm_bios_table_attr_entry_enum_encode() 509 - pldm_bios_table_attr_entry_enum_decode_pv_num() 510 - pldm_bios_table_attr_entry_enum_decode_def_num() 511 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 512 - pldm_bios_table_attr_entry_string_encode() 513 - pldm_bios_table_attr_entry_string_decode_def_string_length() 514 515### Removed 516 5171. libpldm: Remove the requester-api option 518 519### Fixed 520 5211. requester: Make pldm_open() return existing fd 5222. transport: Prevent sticking in waiting for response 5233. transport: Match on response in pldm_transport_send_recv_msg() 5244. requester: Add check before accessing hdr in pldm_recv() 5255. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 526