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. base: Define macros for reserved TIDs 232. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 243. pdr: Add pldm_entity_association_pdr_create_new() 254. platform: Define macros for the responded transferflags 265. pdr: Add pldm_pdr_get_terminus_handle() API 276. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 287. fw_update: Add encode req & decode resp for get_downstream_fw_params 298. platform: Add decode_pldm_platform_cper_event() API 309. decode_get_pdr_repository_info_resp_safe() 31 32 Replaces decode_get_pdr_repository_info_resp() as discussed in the 33 `Deprecated` section below 34 3510. decode_get_pdr_resp_safe() 36 37 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 38 below 39 40### Changed 41 421. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 432. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 443. platform: Stabilise decode_pldm_message_poll_event_data() APIs 454. ABI break for decode_sensor_op_data() 46 47 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 48 abi-compliance-checker to flag a change in the register containing the 49 parameter `previous_op_state`. 50 515. platform: Stabilise decode_pldm_platform_cper_event() API 52 53### Deprecated 54 551. Rename and deprecate functions with the `_check` suffix 56 57 All library function return values always need to be checked. The `_check` 58 suffix is redundant, so remove it. Migration to the non-deprecated 59 equivalents without the `_check` suffix can be performed using 60 `scripts/ apply-renames` and the [clang-rename][] configurations under 61 `evolutions/` 62 63 The deprecated functions: 64 65 - `get_fru_record_by_option_check()` 66 - `pldm_bios_table_append_pad_checksum_check()` 67 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 68 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 69 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 70 - `pldm_bios_table_attr_entry_enum_encode_check()` 71 - `pldm_bios_table_attr_entry_integer_encode_check()` 72 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 73 - `pldm_bios_table_attr_entry_string_encode_check()` 74 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 75 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 76 - `pldm_bios_table_attr_value_entry_encode_string_check()` 77 - `pldm_bios_table_string_entry_decode_string_check()` 78 - `pldm_bios_table_string_entry_encode_check()` 79 - `pldm_entity_association_pdr_add_check()` 80 - `pldm_entity_association_pdr_add_from_node_check()` 81 - `pldm_pdr_add_check()` 82 - `pldm_pdr_add_fru_record_set_check()` 83 84[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 85 862. `decode_get_pdr_repository_info_resp()` 87 88 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 89 eliminates the opportunity for buffer overruns when extracting objects from 90 the message. 91 923. `decode_get_pdr_resp()` 93 94 Users should move to `decode_get_pdr_resp_safe()` which reduces the 95 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 96 97### Removed 98 991. IBM OEM header compatibility symlinks. 100 101 Anyone left using the deprecated paths can migrate using the coccinelle patch 102 at `evolutions/current/oem-ibm-header-compat.cocci`. 103 104### Fixed 105 1061. requester: instance-id: Release read lock on conflict 107 108## [0.8.0] - 2024-05-23 109 110### Added 111 1121. base: Provide pldm_msg_hdr_correlate_response() 1132. transport: af-mctp: Add pldm_transport_af_mctp_bind() 1143. oem: ibm: Add chapdata file type support 1154. base: Added PLDM_SMBIOS & PLDM_RDE message types 1165. oem: meta: Add decode_oem_meta_file_io_req() 1176. state-set: Add all state set values to system power state enum as per DSP0249 1187. platform: Add alias members to the enum 119 pldm_pdr_repository_chg_event_change_record_event_data_operation. 120 121 enum constants with inconsistent names are deprecated with this change. 122 remove old inconsistent enum members after backward compatibility cleanup is 123 done 124 1258. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 1269. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 12710. platform: Add 3 PDR type enum for Redfish Device Enablement per 128 DSP0248_1.2.0 12911. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 13012. entity: Add enum for Network Interface Connectors and Network Ports 131 Connection Types 13213. pdr: Add decode_numeric_effecter_pdr_data() 13314. oem: ibm: Support for the Real SAI entity id 13415. fw_update: Add encode req & decode resp for query_downstream_devices 13516. fw_update: Add encode req & decode resp for query_downstream_identifiers 13617. platform: Add support for GetStateEffecterStates command 137 138### Changed 139 1401. base: Stabilise pldm_msg_hdr_correlate_response() 1412. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1423. libpldm: Fix header use 1434. libpldm: More fixes for header use 1445. pdr: Stabilise pldm_pdr_find_last_in_range() API 1456. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1467. oem: meta: stabilise decode_oem_meta_file_io_req() 1478. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 148 149### Deprecated 150 1511. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 152 with `PLDM_OEM_IBM_` 153 154### Fixed 155 1561. libpldm: Rationalise the local and installed path of pldm.h 1572. pdr: Assign record_handle in entity_association_pdr_add_children() 1583. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1594. pdr: Remove redundant constant for minimum numeric sensor PDR length 1605. tests: oem: meta: Fix fileio use of msgbuf 161 162## [0.7.0] - 2023-08-29 163 164### Added 165 1661. state-set: Add new enum for Operational Fault Status enum 167 168### Changed 169 1701. transport: Match specified metadata in pldm_transport_send_recv_msg() 1712. transport: mctp-demux: Drop ABI annotation for internal symbols 1723. transport: Stabilise core transport and implementation APIs 173 174 This stabilisation covers the following headers and functions: 175 176 - libpldm/transport.h 177 178 - pldm_transport_poll() 179 - pldm_transport_send_msg() 180 - pldm_transport_recv_msg() 181 - pldm_transport_send_recv_msg() 182 183 - libpldm/transport/af-mctp.h 184 185 - pldm_transport_af_mctp_init() 186 - pldm_transport_af_mctp_destroy() 187 - pldm_transport_af_mctp_core() 188 - pldm_transport_af_mctp_init_pollfd() 189 - pldm_transport_af_mctp_map_tid() 190 - pldm_transport_af_mctp_unmap_tid() 191 192 - libpldm/transport/mctp-demux.h 193 - pldm_transport_mctp_demux_init() 194 - pldm_transport_mctp_demux_destroy() 195 - pldm_transport_mctp_demux_core() 196 - pldm_transport_mctp_demux_init_pollfd() 197 - pldm_transport_mctp_demux_map_tid() 198 - pldm_transport_mctp_demux_unmap_tid() 199 200### Deprecated 201 2021. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 203 `libpldm/requester/pldm.h`): 204 205 - pldm_open() 206 - pldm_send_recv() 207 - pldm_send() 208 - pldm_recv() 209 - pldm_recv_any() 210 - pldm_close() 211 212 Users should migrate to the newer "transport" APIs instead. 213 214## Fixed 215 2161. tests: Exclude transport tests when build excludes testing ABIs 2172. abi: Capture deprecation of pldm_close() 218 219## [0.6.0] - 2023-08-22 220 221### Changed 222 2231. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 2242. meson: Apply `b_ndebug=if-release` by default 2253. pdr : Stabilize pldm_entity_association_tree_add_entity() 2264. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 2275. pdr: Stabilize pldm_entity_node_get_remote_container_id() 2286. transport: af-mctp: Assign out-params on success in \*\_recv() 2297. transport: Generalise the pldm_transport_recv_msg() API 230 231### Removed 232 2331. pdr: Remove pldm_entity_association_pdr_add() 2342. state-set: Remove enum pldm_state_set_operational_fault_status_values 235 236### Fixed 237 2381. transport: register init_pollfd callback for af-mctp 2392. transport: fix init_pollfd function parameter 2403. transport: Fix doxygen and variables for send and recv functions 2414. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 242 243## [0.5.0] - 2023-08-09 244 245### Added 246 2471. pdr: Introduce pldm_entity_association_pdr_add_check() 248 249### Changed 250 2511. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2522. transport: pldm_transport_poll(): Adjust return value semantics 2533. transport: free un-wanted responses in pldm_transport_send_recv_msg() 254 255### Deprecated 256 2571. state-set: Enum pldm_state_set_operational_fault_status_values 258 259 The enum operational_fault_status is defined with wrong members and will 260 eventually be replaced with the correct members. Any uses of 261 pldm_state_set_operational_fault_status_values members should move to 262 equivalent pldm_state_set_operational_stress_status_values members if needed. 263 2642. platform: Struct field name in fru_record_set PDR 265 266 References to entity_instance_num should be changed to entity_instance 267 2683. platform: Struct field name in numeric sensor value PDR 269 270 References to entity_instance_num should be changed to entity_instance 271 272### Removed 273 2741. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2752. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2763. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2774. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2785. bios_table: Remove pldm_bios_table_append_pad_checksum() 2796. fru: Remove get_fru_record_by_option() 2807. pdr: Make is_present() static 2818. pdr: Remove pldm_pdr_add() 2829. pdr: Remove pldm_pdr_add_fru_record_set() 28310. pdr: Remove pldm_entity_association_pdr_add_from_node() 28411. pdr: Make find_entity_ref_in_tree() static 28512. pdr: Make entity_association_tree_find() static 286 287### Fixed 288 2891. requester: Fix response buffer cast in pldm_send_recv() 2902. pdr: Hoist record handle overflow test to avoid memory leak 2913. transport: Correct comparison in while loop condition 292 293## [0.4.0] - 2023-07-14 294 295### Added 296 2971. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2982. fru: Introduce get_fru_record_by_option_check() 2993. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 3004. pdr: Introduce pldm_pdr_add_check() 3015. pdr: Introduce pldm_pdr_add_fru_record_set_check() 302 303### Changed 304 3051. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 3062. requester: Expose pldm_close() in header 3073. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 3084. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 3095. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 3106. pdr: pldm_pdr_init(): Return NULL on allocation failure 3117. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 3128. pdr: Document preconditions for trivial accessor functions 313 314 A trivial accessor function is one that exposes properties of an object in a 315 way can't result in an error, beyond passing an invalid argument to the 316 function. For APIs meeting this definition we define a precondition that 317 struct pointers must point to valid objects to avoid polluting the function 318 prototypes. The following APIs now have this precondition explicitly defined: 319 320 - pldm_entity_extract() 321 - pldm_entity_get_parent() 322 - pldm_entity_is_exist_parent() 323 - pldm_entity_is_node_parent() 324 - pldm_is_current_parent_child 325 - pldm_is_empty_entity_assoc_tree() 326 - pldm_pdr_get_record_count() 327 - pldm_pdr_get_record_handle() 328 - pldm_pdr_get_repo_size() 329 - pldm_pdr_record_is_remote() 330 3319. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 33210. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 33311. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 33412. pdr: pldm_entity_association_tree_visit(): Document preconditions 33513. pdr: pldm_entity_association_tree_visit(): Exit early on failure 33614. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 33715. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 33816. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 33917. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 34018. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 34119. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 34220. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 34321. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 34422. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 34523. pdr: pldm_entity_get_num_children(): Don't return invalid values 34624. libpldm: Lift or remove asserts where a subsequent check exists 347 348### Deprecated 349 3501. pldm_bios_table_attr_entry_integer_encode() 351 352 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 353 3542. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 355 356 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 357 3583. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 359 360 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 361 3624. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 363 364 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 365 3665. pdr: Deprecate is_present() 367 368 There should be no users of this symbol. If you are a user, you should figure 369 out how to stop, or get in touch. This symbol will be marked static the 370 release after deprecation. 371 3726. pdr: Deprecate find_entity_ref_in_tree() 373 374 There should be no users of this symbol. If you are a user, you should figure 375 out how to stop, or get in touch. This symbol will be marked static the 376 release after deprecation. 377 3787. pdr: Deprecate entity_association_tree_find() 379 380 There should be no users of this symbol. If you are a user, you should figure 381 out how to stop, or get in touch. This symbol will be marked static the 382 release after deprecation. 383 3848. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 385 386 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 387 pldm_bios_table_append_pad_checksum() should migrate to 388 pldm_bios_table_append_pad_checksum_check() 389 3909. fru: Stabilise get_fru_record_by_option_check() 391 392 get_fru_record_by_option() is deprecated by this change. Users of 393 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 394 39510. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 396 397 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 398 Users of pldm_entity_association_pdr_add_from_node() should migrate to 399 pldm_entity_association_pdr_add_from_node_check() 400 40111. pdr: Stabilise pldm_pdr_add_check() 402 403 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 404 migrate to pldm_pdr_add_check() 405 40612. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 407 408 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 409 pldm_pdr_add_fru_record_set() should migrate to 410 pldm_pdr_add_fru_record_set_check() 411 412### Removed 413 4141. bios_table: Remove deprecated APIs sanitized by assert(): 415 416 - pldm_bios_table_string_entry_encode() 417 - pldm_bios_table_string_entry_decode_string() 418 - pldm_bios_table_attr_entry_enum_encode() 419 - pldm_bios_table_attr_entry_enum_decode_pv_num() 420 - pldm_bios_table_attr_entry_enum_decode_def_num() 421 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 422 - pldm_bios_table_attr_entry_string_encode() 423 - pldm_bios_table_attr_entry_string_decode_def_string_length() 424 425### Fixed 426 4271. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 4282. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 4293. transport: mctp-demux: Don't test socket for non-zero value 4304. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 4315. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 4326. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 4337. abi: Update to remove pldm_close() from reference dumps 4348. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 435 436## [0.3.0] - 2023-06-23 437 438### Added 439 4401. Add encode/decode pldmMessagePollEvent data 4412. README: Add a section on working with libpldm 4423. pdr: Introduce remote_container_id and associated APIs 4434. pdr: Add APIs for creating and locating remote PDRs 4445. pdr: Add pldm_pdr_find_last_in_range() 4456. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4467. pdr: Add pldm_pdr_find_container_id_range_exclude() 447 448### Changed 449 4501. include: Move installed transport.h under libpldm/ 4512. libpldm: Explicit deprecated, stable and testing ABI classes 4523. meson: Reduce strength of oem-ibm requirements from enabled to allowed 453 454 The `oem-ibm` feature is now enabled by the default meson configuration, for 455 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 456 recipe: 457 458 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 459 460 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 461 when invoking `meson setup` 462 4634. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4645. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 465 466### Deprecated 467 4681. bios_table: Deprecate APIs with arguments sanitized using assert() 469 470 C provides enough foot-guns without us encoding them into library APIs. 471 Specifically, deprecate the following in favour of their `*_check()` variants 472 which ensure assertions won't fail or otherwise invoke UB: 473 474 - pldm_bios_table_string_entry_encode() 475 - pldm_bios_table_string_entry_decode_string() 476 - pldm_bios_table_attr_entry_enum_encode() 477 - pldm_bios_table_attr_entry_enum_decode_pv_num() 478 - pldm_bios_table_attr_entry_enum_decode_def_num() 479 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 480 - pldm_bios_table_attr_entry_string_encode() 481 - pldm_bios_table_attr_entry_string_decode_def_string_length() 482 483### Removed 484 4851. libpldm: Remove the requester-api option 486 487### Fixed 488 4891. requester: Make pldm_open() return existing fd 4902. transport: Prevent sticking in waiting for response 4913. transport: Match on response in pldm_transport_send_recv_msg() 4924. requester: Add check before accessing hdr in pldm_recv() 4935. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 494