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 29 30### Changed 31 321. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 332. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 343. platform: Stabilise decode_pldm_message_poll_event_data() APIs 35 36### Deprecated 37 381. Rename and deprecate functions with the `_check` suffix 39 40 All library function return values always need to be checked. The `_check` 41 suffix is redundant, so remove it. Migration to the non-deprecated 42 equivalents without the `_check` suffix can be performed using 43 `scripts/ apply-renames` and the [clang-rename][] configurations under 44 `evolutions/` 45 46 The deprecated functions: 47 48 - `get_fru_record_by_option_check()` 49 - `pldm_bios_table_string_entry_encode_check()` 50 - `pldm_entity_association_pdr_add_check()` 51 - `pldm_entity_association_pdr_add_from_node_check()` 52 - `pldm_pdr_add_check()` 53 - `pldm_pdr_add_fru_record_set_check()` 54 55[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 56 57### Removed 58 591. IBM OEM header compatibility symlinks. 60 61 Anyone left using the deprecated paths can migrate using the coccinelle patch 62 at `evolutions/current/oem-ibm-header-compat.cocci`. 63 64### Fixed 65 661. requester: instance-id: Release read lock on conflict 67 68## [0.8.0] - 2024-05-23 69 70### Added 71 721. base: Provide pldm_msg_hdr_correlate_response() 732. transport: af-mctp: Add pldm_transport_af_mctp_bind() 743. oem: ibm: Add chapdata file type support 754. base: Added PLDM_SMBIOS & PLDM_RDE message types 765. oem: meta: Add decode_oem_meta_file_io_req() 776. state-set: Add all state set values to system power state enum as per DSP0249 787. platform: Add alias members to the enum 79 pldm_pdr_repository_chg_event_change_record_event_data_operation. 80 81 enum constants with inconsistent names are deprecated with this change. 82 remove old inconsistent enum members after backward compatibility cleanup is 83 done 84 858. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 869. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 8710. platform: Add 3 PDR type enum for Redfish Device Enablement per 88 DSP0248_1.2.0 8911. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 9012. entity: Add enum for Network Interface Connectors and Network Ports 91 Connection Types 9213. pdr: Add decode_numeric_effecter_pdr_data() 9314. oem: ibm: Support for the Real SAI entity id 9415. fw_update: Add encode req & decode resp for query_downstream_devices 9516. fw_update: Add encode req & decode resp for query_downstream_identifiers 9617. platform: Add support for GetStateEffecterStates command 97 98### Changed 99 1001. base: Stabilise pldm_msg_hdr_correlate_response() 1012. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1023. libpldm: Fix header use 1034. libpldm: More fixes for header use 1045. pdr: Stabilise pldm_pdr_find_last_in_range() API 1056. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1067. oem: meta: stabilise decode_oem_meta_file_io_req() 1078. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 108 109### Deprecated 110 1111. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 112 with `PLDM_OEM_IBM_` 113 114### Fixed 115 1161. libpldm: Rationalise the local and installed path of pldm.h 1172. pdr: Assign record_handle in entity_association_pdr_add_children() 1183. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1194. pdr: Remove redundant constant for minimum numeric sensor PDR length 1205. tests: oem: meta: Fix fileio use of msgbuf 121 122## [0.7.0] - 2023-08-29 123 124### Added 125 1261. state-set: Add new enum for Operational Fault Status enum 127 128### Changed 129 1301. transport: Match specified metadata in pldm_transport_send_recv_msg() 1312. transport: mctp-demux: Drop ABI annotation for internal symbols 1323. transport: Stabilise core transport and implementation APIs 133 134 This stabilisation covers the following headers and functions: 135 136 - libpldm/transport.h 137 138 - pldm_transport_poll() 139 - pldm_transport_send_msg() 140 - pldm_transport_recv_msg() 141 - pldm_transport_send_recv_msg() 142 143 - libpldm/transport/af-mctp.h 144 145 - pldm_transport_af_mctp_init() 146 - pldm_transport_af_mctp_destroy() 147 - pldm_transport_af_mctp_core() 148 - pldm_transport_af_mctp_init_pollfd() 149 - pldm_transport_af_mctp_map_tid() 150 - pldm_transport_af_mctp_unmap_tid() 151 152 - libpldm/transport/mctp-demux.h 153 - pldm_transport_mctp_demux_init() 154 - pldm_transport_mctp_demux_destroy() 155 - pldm_transport_mctp_demux_core() 156 - pldm_transport_mctp_demux_init_pollfd() 157 - pldm_transport_mctp_demux_map_tid() 158 - pldm_transport_mctp_demux_unmap_tid() 159 160### Deprecated 161 1621. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 163 `libpldm/requester/pldm.h`): 164 165 - pldm_open() 166 - pldm_send_recv() 167 - pldm_send() 168 - pldm_recv() 169 - pldm_recv_any() 170 - pldm_close() 171 172 Users should migrate to the newer "transport" APIs instead. 173 174## Fixed 175 1761. tests: Exclude transport tests when build excludes testing ABIs 1772. abi: Capture deprecation of pldm_close() 178 179## [0.6.0] - 2023-08-22 180 181### Changed 182 1831. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1842. meson: Apply `b_ndebug=if-release` by default 1853. pdr : Stabilize pldm_entity_association_tree_add_entity() 1864. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1875. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1886. transport: af-mctp: Assign out-params on success in \*\_recv() 1897. transport: Generalise the pldm_transport_recv_msg() API 190 191### Removed 192 1931. pdr: Remove pldm_entity_association_pdr_add() 1942. state-set: Remove enum pldm_state_set_operational_fault_status_values 195 196### Fixed 197 1981. transport: register init_pollfd callback for af-mctp 1992. transport: fix init_pollfd function parameter 2003. transport: Fix doxygen and variables for send and recv functions 2014. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 202 203## [0.5.0] - 2023-08-09 204 205### Added 206 2071. pdr: Introduce pldm_entity_association_pdr_add_check() 208 209### Changed 210 2111. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2122. transport: pldm_transport_poll(): Adjust return value semantics 2133. transport: free un-wanted responses in pldm_transport_send_recv_msg() 214 215### Deprecated 216 2171. state-set: Enum pldm_state_set_operational_fault_status_values 218 219 The enum operational_fault_status is defined with wrong members and will 220 eventually be replaced with the correct members. Any uses of 221 pldm_state_set_operational_fault_status_values members should move to 222 equivalent pldm_state_set_operational_stress_status_values members if needed. 223 2242. platform: Struct field name in fru_record_set PDR 225 226 References to entity_instance_num should be changed to entity_instance 227 2283. platform: Struct field name in numeric sensor value PDR 229 230 References to entity_instance_num should be changed to entity_instance 231 232### Removed 233 2341. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2352. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2363. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2374. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2385. bios_table: Remove pldm_bios_table_append_pad_checksum() 2396. fru: Remove get_fru_record_by_option() 2407. pdr: Make is_present() static 2418. pdr: Remove pldm_pdr_add() 2429. pdr: Remove pldm_pdr_add_fru_record_set() 24310. pdr: Remove pldm_entity_association_pdr_add_from_node() 24411. pdr: Make find_entity_ref_in_tree() static 24512. pdr: Make entity_association_tree_find() static 246 247### Fixed 248 2491. requester: Fix response buffer cast in pldm_send_recv() 2502. pdr: Hoist record handle overflow test to avoid memory leak 2513. transport: Correct comparison in while loop condition 252 253## [0.4.0] - 2023-07-14 254 255### Added 256 2571. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2582. fru: Introduce get_fru_record_by_option_check() 2593. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2604. pdr: Introduce pldm_pdr_add_check() 2615. pdr: Introduce pldm_pdr_add_fru_record_set_check() 262 263### Changed 264 2651. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2662. requester: Expose pldm_close() in header 2673. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2684. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2695. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2706. pdr: pldm_pdr_init(): Return NULL on allocation failure 2717. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2728. pdr: Document preconditions for trivial accessor functions 273 274 A trivial accessor function is one that exposes properties of an object in a 275 way can't result in an error, beyond passing an invalid argument to the 276 function. For APIs meeting this definition we define a precondition that 277 struct pointers must point to valid objects to avoid polluting the function 278 prototypes. The following APIs now have this precondition explicitly defined: 279 280 - pldm_entity_extract() 281 - pldm_entity_get_parent() 282 - pldm_entity_is_exist_parent() 283 - pldm_entity_is_node_parent() 284 - pldm_is_current_parent_child 285 - pldm_is_empty_entity_assoc_tree() 286 - pldm_pdr_get_record_count() 287 - pldm_pdr_get_record_handle() 288 - pldm_pdr_get_repo_size() 289 - pldm_pdr_record_is_remote() 290 2919. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 29210. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 29311. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 29412. pdr: pldm_entity_association_tree_visit(): Document preconditions 29513. pdr: pldm_entity_association_tree_visit(): Exit early on failure 29614. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 29715. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 29816. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 29917. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 30018. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 30119. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 30220. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 30321. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 30422. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 30523. pdr: pldm_entity_get_num_children(): Don't return invalid values 30624. libpldm: Lift or remove asserts where a subsequent check exists 307 308### Deprecated 309 3101. pldm_bios_table_attr_entry_integer_encode() 311 312 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 313 3142. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 315 316 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 317 3183. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 319 320 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 321 3224. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 323 324 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 325 3265. pdr: Deprecate is_present() 327 328 There should be no users of this symbol. If you are a user, you should figure 329 out how to stop, or get in touch. This symbol will be marked static the 330 release after deprecation. 331 3326. pdr: Deprecate find_entity_ref_in_tree() 333 334 There should be no users of this symbol. If you are a user, you should figure 335 out how to stop, or get in touch. This symbol will be marked static the 336 release after deprecation. 337 3387. pdr: Deprecate entity_association_tree_find() 339 340 There should be no users of this symbol. If you are a user, you should figure 341 out how to stop, or get in touch. This symbol will be marked static the 342 release after deprecation. 343 3448. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 345 346 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 347 pldm_bios_table_append_pad_checksum() should migrate to 348 pldm_bios_table_append_pad_checksum_check() 349 3509. fru: Stabilise get_fru_record_by_option_check() 351 352 get_fru_record_by_option() is deprecated by this change. Users of 353 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 354 35510. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 356 357 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 358 Users of pldm_entity_association_pdr_add_from_node() should migrate to 359 pldm_entity_association_pdr_add_from_node_check() 360 36111. pdr: Stabilise pldm_pdr_add_check() 362 363 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 364 migrate to pldm_pdr_add_check() 365 36612. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 367 368 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 369 pldm_pdr_add_fru_record_set() should migrate to 370 pldm_pdr_add_fru_record_set_check() 371 372### Removed 373 3741. bios_table: Remove deprecated APIs sanitized by assert(): 375 376 - pldm_bios_table_string_entry_encode() 377 - pldm_bios_table_string_entry_decode_string() 378 - pldm_bios_table_attr_entry_enum_encode() 379 - pldm_bios_table_attr_entry_enum_decode_pv_num() 380 - pldm_bios_table_attr_entry_enum_decode_def_num() 381 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 382 - pldm_bios_table_attr_entry_string_encode() 383 - pldm_bios_table_attr_entry_string_decode_def_string_length() 384 385### Fixed 386 3871. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3882. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3893. transport: mctp-demux: Don't test socket for non-zero value 3904. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3915. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3926. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3937. abi: Update to remove pldm_close() from reference dumps 3948. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 395 396## [0.3.0] - 2023-06-23 397 398### Added 399 4001. Add encode/decode pldmMessagePollEvent data 4012. README: Add a section on working with libpldm 4023. pdr: Introduce remote_container_id and associated APIs 4034. pdr: Add APIs for creating and locating remote PDRs 4045. pdr: Add pldm_pdr_find_last_in_range() 4056. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4067. pdr: Add pldm_pdr_find_container_id_range_exclude() 407 408### Changed 409 4101. include: Move installed transport.h under libpldm/ 4112. libpldm: Explicit deprecated, stable and testing ABI classes 4123. meson: Reduce strength of oem-ibm requirements from enabled to allowed 413 414 The `oem-ibm` feature is now enabled by the default meson configuration, for 415 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 416 recipe: 417 418 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 419 420 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 421 when invoking `meson setup` 422 4234. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4245. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 425 426### Deprecated 427 4281. bios_table: Deprecate APIs with arguments sanitized using assert() 429 430 C provides enough foot-guns without us encoding them into library APIs. 431 Specifically, deprecate the following in favour of their `*_check()` variants 432 which ensure assertions won't fail or otherwise invoke UB: 433 434 - pldm_bios_table_string_entry_encode() 435 - pldm_bios_table_string_entry_decode_string() 436 - pldm_bios_table_attr_entry_enum_encode() 437 - pldm_bios_table_attr_entry_enum_decode_pv_num() 438 - pldm_bios_table_attr_entry_enum_decode_def_num() 439 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 440 - pldm_bios_table_attr_entry_string_encode() 441 - pldm_bios_table_attr_entry_string_decode_def_string_length() 442 443### Removed 444 4451. libpldm: Remove the requester-api option 446 447### Fixed 448 4491. requester: Make pldm_open() return existing fd 4502. transport: Prevent sticking in waiting for response 4513. transport: Match on response in pldm_transport_send_recv_msg() 4524. requester: Add check before accessing hdr in pldm_recv() 4535. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 454