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 51### Deprecated 52 531. Rename and deprecate functions with the `_check` suffix 54 55 All library function return values always need to be checked. The `_check` 56 suffix is redundant, so remove it. Migration to the non-deprecated 57 equivalents without the `_check` suffix can be performed using 58 `scripts/ apply-renames` and the [clang-rename][] configurations under 59 `evolutions/` 60 61 The deprecated functions: 62 63 - `get_fru_record_by_option_check()` 64 - `pldm_bios_table_append_pad_checksum_check()` 65 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 66 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 67 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 68 - `pldm_bios_table_attr_entry_enum_encode_check()` 69 - `pldm_bios_table_attr_entry_integer_encode_check()` 70 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 71 - `pldm_bios_table_attr_entry_string_encode_check()` 72 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 73 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 74 - `pldm_bios_table_attr_value_entry_encode_string_check()` 75 - `pldm_bios_table_string_entry_decode_string_check()` 76 - `pldm_bios_table_string_entry_encode_check()` 77 - `pldm_entity_association_pdr_add_check()` 78 - `pldm_entity_association_pdr_add_from_node_check()` 79 - `pldm_pdr_add_check()` 80 - `pldm_pdr_add_fru_record_set_check()` 81 82[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 83 842. `decode_get_pdr_repository_info_resp()` 85 86 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 87 eliminates the opportunity for buffer overruns when extracting objects from 88 the message. 89 903. `decode_get_pdr_resp()` 91 92 Users should move to `decode_get_pdr_resp_safe()` which reduces the 93 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 94 95### Removed 96 971. IBM OEM header compatibility symlinks. 98 99 Anyone left using the deprecated paths can migrate using the coccinelle patch 100 at `evolutions/current/oem-ibm-header-compat.cocci`. 101 102### Fixed 103 1041. requester: instance-id: Release read lock on conflict 105 106## [0.8.0] - 2024-05-23 107 108### Added 109 1101. base: Provide pldm_msg_hdr_correlate_response() 1112. transport: af-mctp: Add pldm_transport_af_mctp_bind() 1123. oem: ibm: Add chapdata file type support 1134. base: Added PLDM_SMBIOS & PLDM_RDE message types 1145. oem: meta: Add decode_oem_meta_file_io_req() 1156. state-set: Add all state set values to system power state enum as per DSP0249 1167. platform: Add alias members to the enum 117 pldm_pdr_repository_chg_event_change_record_event_data_operation. 118 119 enum constants with inconsistent names are deprecated with this change. 120 remove old inconsistent enum members after backward compatibility cleanup is 121 done 122 1238. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 1249. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 12510. platform: Add 3 PDR type enum for Redfish Device Enablement per 126 DSP0248_1.2.0 12711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 12812. entity: Add enum for Network Interface Connectors and Network Ports 129 Connection Types 13013. pdr: Add decode_numeric_effecter_pdr_data() 13114. oem: ibm: Support for the Real SAI entity id 13215. fw_update: Add encode req & decode resp for query_downstream_devices 13316. fw_update: Add encode req & decode resp for query_downstream_identifiers 13417. platform: Add support for GetStateEffecterStates command 135 136### Changed 137 1381. base: Stabilise pldm_msg_hdr_correlate_response() 1392. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1403. libpldm: Fix header use 1414. libpldm: More fixes for header use 1425. pdr: Stabilise pldm_pdr_find_last_in_range() API 1436. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1447. oem: meta: stabilise decode_oem_meta_file_io_req() 1458. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 146 147### Deprecated 148 1491. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 150 with `PLDM_OEM_IBM_` 151 152### Fixed 153 1541. libpldm: Rationalise the local and installed path of pldm.h 1552. pdr: Assign record_handle in entity_association_pdr_add_children() 1563. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1574. pdr: Remove redundant constant for minimum numeric sensor PDR length 1585. tests: oem: meta: Fix fileio use of msgbuf 159 160## [0.7.0] - 2023-08-29 161 162### Added 163 1641. state-set: Add new enum for Operational Fault Status enum 165 166### Changed 167 1681. transport: Match specified metadata in pldm_transport_send_recv_msg() 1692. transport: mctp-demux: Drop ABI annotation for internal symbols 1703. transport: Stabilise core transport and implementation APIs 171 172 This stabilisation covers the following headers and functions: 173 174 - libpldm/transport.h 175 176 - pldm_transport_poll() 177 - pldm_transport_send_msg() 178 - pldm_transport_recv_msg() 179 - pldm_transport_send_recv_msg() 180 181 - libpldm/transport/af-mctp.h 182 183 - pldm_transport_af_mctp_init() 184 - pldm_transport_af_mctp_destroy() 185 - pldm_transport_af_mctp_core() 186 - pldm_transport_af_mctp_init_pollfd() 187 - pldm_transport_af_mctp_map_tid() 188 - pldm_transport_af_mctp_unmap_tid() 189 190 - libpldm/transport/mctp-demux.h 191 - pldm_transport_mctp_demux_init() 192 - pldm_transport_mctp_demux_destroy() 193 - pldm_transport_mctp_demux_core() 194 - pldm_transport_mctp_demux_init_pollfd() 195 - pldm_transport_mctp_demux_map_tid() 196 - pldm_transport_mctp_demux_unmap_tid() 197 198### Deprecated 199 2001. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 201 `libpldm/requester/pldm.h`): 202 203 - pldm_open() 204 - pldm_send_recv() 205 - pldm_send() 206 - pldm_recv() 207 - pldm_recv_any() 208 - pldm_close() 209 210 Users should migrate to the newer "transport" APIs instead. 211 212## Fixed 213 2141. tests: Exclude transport tests when build excludes testing ABIs 2152. abi: Capture deprecation of pldm_close() 216 217## [0.6.0] - 2023-08-22 218 219### Changed 220 2211. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 2222. meson: Apply `b_ndebug=if-release` by default 2233. pdr : Stabilize pldm_entity_association_tree_add_entity() 2244. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 2255. pdr: Stabilize pldm_entity_node_get_remote_container_id() 2266. transport: af-mctp: Assign out-params on success in \*\_recv() 2277. transport: Generalise the pldm_transport_recv_msg() API 228 229### Removed 230 2311. pdr: Remove pldm_entity_association_pdr_add() 2322. state-set: Remove enum pldm_state_set_operational_fault_status_values 233 234### Fixed 235 2361. transport: register init_pollfd callback for af-mctp 2372. transport: fix init_pollfd function parameter 2383. transport: Fix doxygen and variables for send and recv functions 2394. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 240 241## [0.5.0] - 2023-08-09 242 243### Added 244 2451. pdr: Introduce pldm_entity_association_pdr_add_check() 246 247### Changed 248 2491. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2502. transport: pldm_transport_poll(): Adjust return value semantics 2513. transport: free un-wanted responses in pldm_transport_send_recv_msg() 252 253### Deprecated 254 2551. state-set: Enum pldm_state_set_operational_fault_status_values 256 257 The enum operational_fault_status is defined with wrong members and will 258 eventually be replaced with the correct members. Any uses of 259 pldm_state_set_operational_fault_status_values members should move to 260 equivalent pldm_state_set_operational_stress_status_values members if needed. 261 2622. platform: Struct field name in fru_record_set PDR 263 264 References to entity_instance_num should be changed to entity_instance 265 2663. platform: Struct field name in numeric sensor value PDR 267 268 References to entity_instance_num should be changed to entity_instance 269 270### Removed 271 2721. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2732. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2743. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2754. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2765. bios_table: Remove pldm_bios_table_append_pad_checksum() 2776. fru: Remove get_fru_record_by_option() 2787. pdr: Make is_present() static 2798. pdr: Remove pldm_pdr_add() 2809. pdr: Remove pldm_pdr_add_fru_record_set() 28110. pdr: Remove pldm_entity_association_pdr_add_from_node() 28211. pdr: Make find_entity_ref_in_tree() static 28312. pdr: Make entity_association_tree_find() static 284 285### Fixed 286 2871. requester: Fix response buffer cast in pldm_send_recv() 2882. pdr: Hoist record handle overflow test to avoid memory leak 2893. transport: Correct comparison in while loop condition 290 291## [0.4.0] - 2023-07-14 292 293### Added 294 2951. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2962. fru: Introduce get_fru_record_by_option_check() 2973. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2984. pdr: Introduce pldm_pdr_add_check() 2995. pdr: Introduce pldm_pdr_add_fru_record_set_check() 300 301### Changed 302 3031. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 3042. requester: Expose pldm_close() in header 3053. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 3064. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 3075. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 3086. pdr: pldm_pdr_init(): Return NULL on allocation failure 3097. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 3108. pdr: Document preconditions for trivial accessor functions 311 312 A trivial accessor function is one that exposes properties of an object in a 313 way can't result in an error, beyond passing an invalid argument to the 314 function. For APIs meeting this definition we define a precondition that 315 struct pointers must point to valid objects to avoid polluting the function 316 prototypes. The following APIs now have this precondition explicitly defined: 317 318 - pldm_entity_extract() 319 - pldm_entity_get_parent() 320 - pldm_entity_is_exist_parent() 321 - pldm_entity_is_node_parent() 322 - pldm_is_current_parent_child 323 - pldm_is_empty_entity_assoc_tree() 324 - pldm_pdr_get_record_count() 325 - pldm_pdr_get_record_handle() 326 - pldm_pdr_get_repo_size() 327 - pldm_pdr_record_is_remote() 328 3299. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 33010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 33111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 33212. pdr: pldm_entity_association_tree_visit(): Document preconditions 33313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 33414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 33515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 33616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 33717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 33818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 33919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 34020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 34121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 34222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 34323. pdr: pldm_entity_get_num_children(): Don't return invalid values 34424. libpldm: Lift or remove asserts where a subsequent check exists 345 346### Deprecated 347 3481. pldm_bios_table_attr_entry_integer_encode() 349 350 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 351 3522. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 353 354 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 355 3563. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 357 358 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 359 3604. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 361 362 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 363 3645. pdr: Deprecate is_present() 365 366 There should be no users of this symbol. If you are a user, you should figure 367 out how to stop, or get in touch. This symbol will be marked static the 368 release after deprecation. 369 3706. pdr: Deprecate find_entity_ref_in_tree() 371 372 There should be no users of this symbol. If you are a user, you should figure 373 out how to stop, or get in touch. This symbol will be marked static the 374 release after deprecation. 375 3767. pdr: Deprecate entity_association_tree_find() 377 378 There should be no users of this symbol. If you are a user, you should figure 379 out how to stop, or get in touch. This symbol will be marked static the 380 release after deprecation. 381 3828. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 383 384 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 385 pldm_bios_table_append_pad_checksum() should migrate to 386 pldm_bios_table_append_pad_checksum_check() 387 3889. fru: Stabilise get_fru_record_by_option_check() 389 390 get_fru_record_by_option() is deprecated by this change. Users of 391 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 392 39310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 394 395 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 396 Users of pldm_entity_association_pdr_add_from_node() should migrate to 397 pldm_entity_association_pdr_add_from_node_check() 398 39911. pdr: Stabilise pldm_pdr_add_check() 400 401 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 402 migrate to pldm_pdr_add_check() 403 40412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 405 406 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 407 pldm_pdr_add_fru_record_set() should migrate to 408 pldm_pdr_add_fru_record_set_check() 409 410### Removed 411 4121. bios_table: Remove deprecated APIs sanitized by assert(): 413 414 - pldm_bios_table_string_entry_encode() 415 - pldm_bios_table_string_entry_decode_string() 416 - pldm_bios_table_attr_entry_enum_encode() 417 - pldm_bios_table_attr_entry_enum_decode_pv_num() 418 - pldm_bios_table_attr_entry_enum_decode_def_num() 419 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 420 - pldm_bios_table_attr_entry_string_encode() 421 - pldm_bios_table_attr_entry_string_decode_def_string_length() 422 423### Fixed 424 4251. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 4262. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 4273. transport: mctp-demux: Don't test socket for non-zero value 4284. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 4295. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 4306. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 4317. abi: Update to remove pldm_close() from reference dumps 4328. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 433 434## [0.3.0] - 2023-06-23 435 436### Added 437 4381. Add encode/decode pldmMessagePollEvent data 4392. README: Add a section on working with libpldm 4403. pdr: Introduce remote_container_id and associated APIs 4414. pdr: Add APIs for creating and locating remote PDRs 4425. pdr: Add pldm_pdr_find_last_in_range() 4436. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4447. pdr: Add pldm_pdr_find_container_id_range_exclude() 445 446### Changed 447 4481. include: Move installed transport.h under libpldm/ 4492. libpldm: Explicit deprecated, stable and testing ABI classes 4503. meson: Reduce strength of oem-ibm requirements from enabled to allowed 451 452 The `oem-ibm` feature is now enabled by the default meson configuration, for 453 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 454 recipe: 455 456 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 457 458 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 459 when invoking `meson setup` 460 4614. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4625. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 463 464### Deprecated 465 4661. bios_table: Deprecate APIs with arguments sanitized using assert() 467 468 C provides enough foot-guns without us encoding them into library APIs. 469 Specifically, deprecate the following in favour of their `*_check()` variants 470 which ensure assertions won't fail or otherwise invoke UB: 471 472 - pldm_bios_table_string_entry_encode() 473 - pldm_bios_table_string_entry_decode_string() 474 - pldm_bios_table_attr_entry_enum_encode() 475 - pldm_bios_table_attr_entry_enum_decode_pv_num() 476 - pldm_bios_table_attr_entry_enum_decode_def_num() 477 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 478 - pldm_bios_table_attr_entry_string_encode() 479 - pldm_bios_table_attr_entry_string_decode_def_string_length() 480 481### Removed 482 4831. libpldm: Remove the requester-api option 484 485### Fixed 486 4871. requester: Make pldm_open() return existing fd 4882. transport: Prevent sticking in waiting for response 4893. transport: Match on response in pldm_transport_send_recv_msg() 4904. requester: Add check before accessing hdr in pldm_recv() 4915. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 492