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 26 27### Deprecated 28 291. fru: Deprecate `get_fru_record_by_option_check()` 30 31 Users should switch to `get_fru_record_by_option()`. Migration can be 32 performed using the [Coccinelle semantic patch][coccinelle] 33 `get_fru_record_by_option_check.cocci`: 34 35 ``` 36 $ spatch \ 37 --sp-file=${LIBPLDM_DIR}/evolutions/current/get_fru_record_by_option_check.cocci \ 38 --in-place \ 39 $(git ls-files | grep -E '\.[ch](pp)?') 40 ``` 41 42[coccinelle]: https://coccinelle.gitlabpages.inria.fr/website/ 43 44### Removed 45 461. IBM OEM header compatibility symlinks. 47 48 Anyone left using the deprecated paths can migrate using the coccinelle patch 49 at `evolutions/current/oem-ibm-header-compat.cocci`. 50 51### Fixed 52 531. requester: instance-id: Release read lock on conflict 54 55## [0.8.0] - 2024-05-23 56 57### Added 58 591. base: Provide pldm_msg_hdr_correlate_response() 602. transport: af-mctp: Add pldm_transport_af_mctp_bind() 613. oem: ibm: Add chapdata file type support 624. base: Added PLDM_SMBIOS & PLDM_RDE message types 635. oem: meta: Add decode_oem_meta_file_io_req() 646. state-set: Add all state set values to system power state enum as per DSP0249 657. platform: Add alias members to the enum 66 pldm_pdr_repository_chg_event_change_record_event_data_operation. 67 68 enum constants with inconsistent names are deprecated with this change. 69 remove old inconsistent enum members after backward compatibility cleanup is 70 done 71 728. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 739. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 7410. platform: Add 3 PDR type enum for Redfish Device Enablement per 75 DSP0248_1.2.0 7611. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 7712. entity: Add enum for Network Interface Connectors and Network Ports 78 Connection Types 7913. pdr: Add decode_numeric_effecter_pdr_data() 8014. oem: ibm: Support for the Real SAI entity id 8115. fw_update: Add encode req & decode resp for query_downstream_devices 8216. fw_update: Add encode req & decode resp for query_downstream_identifiers 8317. platform: Add support for GetStateEffecterStates command 84 85### Changed 86 871. base: Stabilise pldm_msg_hdr_correlate_response() 882. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 893. libpldm: Fix header use 904. libpldm: More fixes for header use 915. pdr: Stabilise pldm_pdr_find_last_in_range() API 926. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 937. oem: meta: stabilise decode_oem_meta_file_io_req() 948. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 95 96### Deprecated 97 981. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 99 with `PLDM_OEM_IBM_` 100 101### Fixed 102 1031. libpldm: Rationalise the local and installed path of pldm.h 1042. pdr: Assign record_handle in entity_association_pdr_add_children() 1053. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1064. pdr: Remove redundant constant for minimum numeric sensor PDR length 1075. tests: oem: meta: Fix fileio use of msgbuf 108 109## [0.7.0] - 2023-08-29 110 111### Added 112 1131. state-set: Add new enum for Operational Fault Status enum 114 115### Changed 116 1171. transport: Match specified metadata in pldm_transport_send_recv_msg() 1182. transport: mctp-demux: Drop ABI annotation for internal symbols 1193. transport: Stabilise core transport and implementation APIs 120 121 This stabilisation covers the following headers and functions: 122 123 - libpldm/transport.h 124 125 - pldm_transport_poll() 126 - pldm_transport_send_msg() 127 - pldm_transport_recv_msg() 128 - pldm_transport_send_recv_msg() 129 130 - libpldm/transport/af-mctp.h 131 132 - pldm_transport_af_mctp_init() 133 - pldm_transport_af_mctp_destroy() 134 - pldm_transport_af_mctp_core() 135 - pldm_transport_af_mctp_init_pollfd() 136 - pldm_transport_af_mctp_map_tid() 137 - pldm_transport_af_mctp_unmap_tid() 138 139 - libpldm/transport/mctp-demux.h 140 - pldm_transport_mctp_demux_init() 141 - pldm_transport_mctp_demux_destroy() 142 - pldm_transport_mctp_demux_core() 143 - pldm_transport_mctp_demux_init_pollfd() 144 - pldm_transport_mctp_demux_map_tid() 145 - pldm_transport_mctp_demux_unmap_tid() 146 147### Deprecated 148 1491. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 150 `libpldm/requester/pldm.h`): 151 152 - pldm_open() 153 - pldm_send_recv() 154 - pldm_send() 155 - pldm_recv() 156 - pldm_recv_any() 157 - pldm_close() 158 159 Users should migrate to the newer "transport" APIs instead. 160 161## Fixed 162 1631. tests: Exclude transport tests when build excludes testing ABIs 1642. abi: Capture deprecation of pldm_close() 165 166## [0.6.0] - 2023-08-22 167 168### Changed 169 1701. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1712. meson: Apply `b_ndebug=if-release` by default 1723. pdr : Stabilize pldm_entity_association_tree_add_entity() 1734. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1745. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1756. transport: af-mctp: Assign out-params on success in \*\_recv() 1767. transport: Generalise the pldm_transport_recv_msg() API 177 178### Removed 179 1801. pdr: Remove pldm_entity_association_pdr_add() 1812. state-set: Remove enum pldm_state_set_operational_fault_status_values 182 183### Fixed 184 1851. transport: register init_pollfd callback for af-mctp 1862. transport: fix init_pollfd function parameter 1873. transport: Fix doxygen and variables for send and recv functions 1884. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 189 190## [0.5.0] - 2023-08-09 191 192### Added 193 1941. pdr: Introduce pldm_entity_association_pdr_add_check() 195 196### Changed 197 1981. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 1992. transport: pldm_transport_poll(): Adjust return value semantics 2003. transport: free un-wanted responses in pldm_transport_send_recv_msg() 201 202### Deprecated 203 2041. state-set: Enum pldm_state_set_operational_fault_status_values 205 206 The enum operational_fault_status is defined with wrong members and will 207 eventually be replaced with the correct members. Any uses of 208 pldm_state_set_operational_fault_status_values members should move to 209 equivalent pldm_state_set_operational_stress_status_values members if needed. 210 2112. platform: Struct field name in fru_record_set PDR 212 213 References to entity_instance_num should be changed to entity_instance 214 2153. platform: Struct field name in numeric sensor value PDR 216 217 References to entity_instance_num should be changed to entity_instance 218 219### Removed 220 2211. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2222. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2233. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2244. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2255. bios_table: Remove pldm_bios_table_append_pad_checksum() 2266. fru: Remove get_fru_record_by_option() 2277. pdr: Make is_present() static 2288. pdr: Remove pldm_pdr_add() 2299. pdr: Remove pldm_pdr_add_fru_record_set() 23010. pdr: Remove pldm_entity_association_pdr_add_from_node() 23111. pdr: Make find_entity_ref_in_tree() static 23212. pdr: Make entity_association_tree_find() static 233 234### Fixed 235 2361. requester: Fix response buffer cast in pldm_send_recv() 2372. pdr: Hoist record handle overflow test to avoid memory leak 2383. transport: Correct comparison in while loop condition 239 240## [0.4.0] - 2023-07-14 241 242### Added 243 2441. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2452. fru: Introduce get_fru_record_by_option_check() 2463. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2474. pdr: Introduce pldm_pdr_add_check() 2485. pdr: Introduce pldm_pdr_add_fru_record_set_check() 249 250### Changed 251 2521. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2532. requester: Expose pldm_close() in header 2543. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2554. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2565. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2576. pdr: pldm_pdr_init(): Return NULL on allocation failure 2587. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2598. pdr: Document preconditions for trivial accessor functions 260 261 A trivial accessor function is one that exposes properties of an object in a 262 way can't result in an error, beyond passing an invalid argument to the 263 function. For APIs meeting this definition we define a precondition that 264 struct pointers must point to valid objects to avoid polluting the function 265 prototypes. The following APIs now have this precondition explicitly defined: 266 267 - pldm_entity_extract() 268 - pldm_entity_get_parent() 269 - pldm_entity_is_exist_parent() 270 - pldm_entity_is_node_parent() 271 - pldm_is_current_parent_child 272 - pldm_is_empty_entity_assoc_tree() 273 - pldm_pdr_get_record_count() 274 - pldm_pdr_get_record_handle() 275 - pldm_pdr_get_repo_size() 276 - pldm_pdr_record_is_remote() 277 2789. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 27910. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 28011. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 28112. pdr: pldm_entity_association_tree_visit(): Document preconditions 28213. pdr: pldm_entity_association_tree_visit(): Exit early on failure 28314. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 28415. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 28516. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 28617. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 28718. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 28819. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 28920. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 29021. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 29122. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 29223. pdr: pldm_entity_get_num_children(): Don't return invalid values 29324. libpldm: Lift or remove asserts where a subsequent check exists 294 295### Deprecated 296 2971. pldm_bios_table_attr_entry_integer_encode() 298 299 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 300 3012. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 302 303 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 304 3053. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 306 307 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 308 3094. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 310 311 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 312 3135. pdr: Deprecate is_present() 314 315 There should be no users of this symbol. If you are a user, you should figure 316 out how to stop, or get in touch. This symbol will be marked static the 317 release after deprecation. 318 3196. pdr: Deprecate find_entity_ref_in_tree() 320 321 There should be no users of this symbol. If you are a user, you should figure 322 out how to stop, or get in touch. This symbol will be marked static the 323 release after deprecation. 324 3257. pdr: Deprecate entity_association_tree_find() 326 327 There should be no users of this symbol. If you are a user, you should figure 328 out how to stop, or get in touch. This symbol will be marked static the 329 release after deprecation. 330 3318. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 332 333 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 334 pldm_bios_table_append_pad_checksum() should migrate to 335 pldm_bios_table_append_pad_checksum_check() 336 3379. fru: Stabilise get_fru_record_by_option_check() 338 339 get_fru_record_by_option() is deprecated by this change. Users of 340 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 341 34210. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 343 344 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 345 Users of pldm_entity_association_pdr_add_from_node() should migrate to 346 pldm_entity_association_pdr_add_from_node_check() 347 34811. pdr: Stabilise pldm_pdr_add_check() 349 350 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 351 migrate to pldm_pdr_add_check() 352 35312. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 354 355 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 356 pldm_pdr_add_fru_record_set() should migrate to 357 pldm_pdr_add_fru_record_set_check() 358 359### Removed 360 3611. bios_table: Remove deprecated APIs sanitized by assert(): 362 363 - pldm_bios_table_string_entry_encode() 364 - pldm_bios_table_string_entry_decode_string() 365 - pldm_bios_table_attr_entry_enum_encode() 366 - pldm_bios_table_attr_entry_enum_decode_pv_num() 367 - pldm_bios_table_attr_entry_enum_decode_def_num() 368 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 369 - pldm_bios_table_attr_entry_string_encode() 370 - pldm_bios_table_attr_entry_string_decode_def_string_length() 371 372### Fixed 373 3741. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3752. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3763. transport: mctp-demux: Don't test socket for non-zero value 3774. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3785. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3796. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3807. abi: Update to remove pldm_close() from reference dumps 3818. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 382 383## [0.3.0] - 2023-06-23 384 385### Added 386 3871. Add encode/decode pldmMessagePollEvent data 3882. README: Add a section on working with libpldm 3893. pdr: Introduce remote_container_id and associated APIs 3904. pdr: Add APIs for creating and locating remote PDRs 3915. pdr: Add pldm_pdr_find_last_in_range() 3926. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 3937. pdr: Add pldm_pdr_find_container_id_range_exclude() 394 395### Changed 396 3971. include: Move installed transport.h under libpldm/ 3982. libpldm: Explicit deprecated, stable and testing ABI classes 3993. meson: Reduce strength of oem-ibm requirements from enabled to allowed 400 401 The `oem-ibm` feature is now enabled by the default meson configuration, for 402 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 403 recipe: 404 405 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 406 407 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 408 when invoking `meson setup` 409 4104. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4115. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 412 413### Deprecated 414 4151. bios_table: Deprecate APIs with arguments sanitized using assert() 416 417 C provides enough foot-guns without us encoding them into library APIs. 418 Specifically, deprecate the following in favour of their `*_check()` variants 419 which ensure assertions won't fail or otherwise invoke UB: 420 421 - pldm_bios_table_string_entry_encode() 422 - pldm_bios_table_string_entry_decode_string() 423 - pldm_bios_table_attr_entry_enum_encode() 424 - pldm_bios_table_attr_entry_enum_decode_pv_num() 425 - pldm_bios_table_attr_entry_enum_decode_def_num() 426 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 427 - pldm_bios_table_attr_entry_string_encode() 428 - pldm_bios_table_attr_entry_string_decode_def_string_length() 429 430### Removed 431 4321. libpldm: Remove the requester-api option 433 434### Fixed 435 4361. requester: Make pldm_open() return existing fd 4372. transport: Prevent sticking in waiting for response 4383. transport: Match on response in pldm_transport_send_recv_msg() 4394. requester: Add check before accessing hdr in pldm_recv() 4405. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 441