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_attr_entry_enum_encode_check()` 50 - `pldm_bios_table_string_entry_decode_string_check()` 51 - `pldm_bios_table_string_entry_encode_check()` 52 - `pldm_entity_association_pdr_add_check()` 53 - `pldm_entity_association_pdr_add_from_node_check()` 54 - `pldm_pdr_add_check()` 55 - `pldm_pdr_add_fru_record_set_check()` 56 57[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 58 59### Removed 60 611. IBM OEM header compatibility symlinks. 62 63 Anyone left using the deprecated paths can migrate using the coccinelle patch 64 at `evolutions/current/oem-ibm-header-compat.cocci`. 65 66### Fixed 67 681. requester: instance-id: Release read lock on conflict 69 70## [0.8.0] - 2024-05-23 71 72### Added 73 741. base: Provide pldm_msg_hdr_correlate_response() 752. transport: af-mctp: Add pldm_transport_af_mctp_bind() 763. oem: ibm: Add chapdata file type support 774. base: Added PLDM_SMBIOS & PLDM_RDE message types 785. oem: meta: Add decode_oem_meta_file_io_req() 796. state-set: Add all state set values to system power state enum as per DSP0249 807. platform: Add alias members to the enum 81 pldm_pdr_repository_chg_event_change_record_event_data_operation. 82 83 enum constants with inconsistent names are deprecated with this change. 84 remove old inconsistent enum members after backward compatibility cleanup is 85 done 86 878. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 889. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 8910. platform: Add 3 PDR type enum for Redfish Device Enablement per 90 DSP0248_1.2.0 9111. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 9212. entity: Add enum for Network Interface Connectors and Network Ports 93 Connection Types 9413. pdr: Add decode_numeric_effecter_pdr_data() 9514. oem: ibm: Support for the Real SAI entity id 9615. fw_update: Add encode req & decode resp for query_downstream_devices 9716. fw_update: Add encode req & decode resp for query_downstream_identifiers 9817. platform: Add support for GetStateEffecterStates command 99 100### Changed 101 1021. base: Stabilise pldm_msg_hdr_correlate_response() 1032. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1043. libpldm: Fix header use 1054. libpldm: More fixes for header use 1065. pdr: Stabilise pldm_pdr_find_last_in_range() API 1076. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1087. oem: meta: stabilise decode_oem_meta_file_io_req() 1098. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 110 111### Deprecated 112 1131. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 114 with `PLDM_OEM_IBM_` 115 116### Fixed 117 1181. libpldm: Rationalise the local and installed path of pldm.h 1192. pdr: Assign record_handle in entity_association_pdr_add_children() 1203. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1214. pdr: Remove redundant constant for minimum numeric sensor PDR length 1225. tests: oem: meta: Fix fileio use of msgbuf 123 124## [0.7.0] - 2023-08-29 125 126### Added 127 1281. state-set: Add new enum for Operational Fault Status enum 129 130### Changed 131 1321. transport: Match specified metadata in pldm_transport_send_recv_msg() 1332. transport: mctp-demux: Drop ABI annotation for internal symbols 1343. transport: Stabilise core transport and implementation APIs 135 136 This stabilisation covers the following headers and functions: 137 138 - libpldm/transport.h 139 140 - pldm_transport_poll() 141 - pldm_transport_send_msg() 142 - pldm_transport_recv_msg() 143 - pldm_transport_send_recv_msg() 144 145 - libpldm/transport/af-mctp.h 146 147 - pldm_transport_af_mctp_init() 148 - pldm_transport_af_mctp_destroy() 149 - pldm_transport_af_mctp_core() 150 - pldm_transport_af_mctp_init_pollfd() 151 - pldm_transport_af_mctp_map_tid() 152 - pldm_transport_af_mctp_unmap_tid() 153 154 - libpldm/transport/mctp-demux.h 155 - pldm_transport_mctp_demux_init() 156 - pldm_transport_mctp_demux_destroy() 157 - pldm_transport_mctp_demux_core() 158 - pldm_transport_mctp_demux_init_pollfd() 159 - pldm_transport_mctp_demux_map_tid() 160 - pldm_transport_mctp_demux_unmap_tid() 161 162### Deprecated 163 1641. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 165 `libpldm/requester/pldm.h`): 166 167 - pldm_open() 168 - pldm_send_recv() 169 - pldm_send() 170 - pldm_recv() 171 - pldm_recv_any() 172 - pldm_close() 173 174 Users should migrate to the newer "transport" APIs instead. 175 176## Fixed 177 1781. tests: Exclude transport tests when build excludes testing ABIs 1792. abi: Capture deprecation of pldm_close() 180 181## [0.6.0] - 2023-08-22 182 183### Changed 184 1851. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1862. meson: Apply `b_ndebug=if-release` by default 1873. pdr : Stabilize pldm_entity_association_tree_add_entity() 1884. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1895. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1906. transport: af-mctp: Assign out-params on success in \*\_recv() 1917. transport: Generalise the pldm_transport_recv_msg() API 192 193### Removed 194 1951. pdr: Remove pldm_entity_association_pdr_add() 1962. state-set: Remove enum pldm_state_set_operational_fault_status_values 197 198### Fixed 199 2001. transport: register init_pollfd callback for af-mctp 2012. transport: fix init_pollfd function parameter 2023. transport: Fix doxygen and variables for send and recv functions 2034. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 204 205## [0.5.0] - 2023-08-09 206 207### Added 208 2091. pdr: Introduce pldm_entity_association_pdr_add_check() 210 211### Changed 212 2131. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2142. transport: pldm_transport_poll(): Adjust return value semantics 2153. transport: free un-wanted responses in pldm_transport_send_recv_msg() 216 217### Deprecated 218 2191. state-set: Enum pldm_state_set_operational_fault_status_values 220 221 The enum operational_fault_status is defined with wrong members and will 222 eventually be replaced with the correct members. Any uses of 223 pldm_state_set_operational_fault_status_values members should move to 224 equivalent pldm_state_set_operational_stress_status_values members if needed. 225 2262. platform: Struct field name in fru_record_set PDR 227 228 References to entity_instance_num should be changed to entity_instance 229 2303. platform: Struct field name in numeric sensor value PDR 231 232 References to entity_instance_num should be changed to entity_instance 233 234### Removed 235 2361. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2372. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2383. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2394. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2405. bios_table: Remove pldm_bios_table_append_pad_checksum() 2416. fru: Remove get_fru_record_by_option() 2427. pdr: Make is_present() static 2438. pdr: Remove pldm_pdr_add() 2449. pdr: Remove pldm_pdr_add_fru_record_set() 24510. pdr: Remove pldm_entity_association_pdr_add_from_node() 24611. pdr: Make find_entity_ref_in_tree() static 24712. pdr: Make entity_association_tree_find() static 248 249### Fixed 250 2511. requester: Fix response buffer cast in pldm_send_recv() 2522. pdr: Hoist record handle overflow test to avoid memory leak 2533. transport: Correct comparison in while loop condition 254 255## [0.4.0] - 2023-07-14 256 257### Added 258 2591. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2602. fru: Introduce get_fru_record_by_option_check() 2613. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2624. pdr: Introduce pldm_pdr_add_check() 2635. pdr: Introduce pldm_pdr_add_fru_record_set_check() 264 265### Changed 266 2671. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2682. requester: Expose pldm_close() in header 2693. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2704. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2715. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2726. pdr: pldm_pdr_init(): Return NULL on allocation failure 2737. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2748. pdr: Document preconditions for trivial accessor functions 275 276 A trivial accessor function is one that exposes properties of an object in a 277 way can't result in an error, beyond passing an invalid argument to the 278 function. For APIs meeting this definition we define a precondition that 279 struct pointers must point to valid objects to avoid polluting the function 280 prototypes. The following APIs now have this precondition explicitly defined: 281 282 - pldm_entity_extract() 283 - pldm_entity_get_parent() 284 - pldm_entity_is_exist_parent() 285 - pldm_entity_is_node_parent() 286 - pldm_is_current_parent_child 287 - pldm_is_empty_entity_assoc_tree() 288 - pldm_pdr_get_record_count() 289 - pldm_pdr_get_record_handle() 290 - pldm_pdr_get_repo_size() 291 - pldm_pdr_record_is_remote() 292 2939. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 29410. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 29511. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 29612. pdr: pldm_entity_association_tree_visit(): Document preconditions 29713. pdr: pldm_entity_association_tree_visit(): Exit early on failure 29814. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 29915. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 30016. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 30117. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 30218. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 30319. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 30420. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 30521. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 30622. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 30723. pdr: pldm_entity_get_num_children(): Don't return invalid values 30824. libpldm: Lift or remove asserts where a subsequent check exists 309 310### Deprecated 311 3121. pldm_bios_table_attr_entry_integer_encode() 313 314 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 315 3162. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 317 318 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 319 3203. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 321 322 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 323 3244. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 325 326 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 327 3285. pdr: Deprecate is_present() 329 330 There should be no users of this symbol. If you are a user, you should figure 331 out how to stop, or get in touch. This symbol will be marked static the 332 release after deprecation. 333 3346. pdr: Deprecate find_entity_ref_in_tree() 335 336 There should be no users of this symbol. If you are a user, you should figure 337 out how to stop, or get in touch. This symbol will be marked static the 338 release after deprecation. 339 3407. pdr: Deprecate entity_association_tree_find() 341 342 There should be no users of this symbol. If you are a user, you should figure 343 out how to stop, or get in touch. This symbol will be marked static the 344 release after deprecation. 345 3468. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 347 348 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 349 pldm_bios_table_append_pad_checksum() should migrate to 350 pldm_bios_table_append_pad_checksum_check() 351 3529. fru: Stabilise get_fru_record_by_option_check() 353 354 get_fru_record_by_option() is deprecated by this change. Users of 355 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 356 35710. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 358 359 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 360 Users of pldm_entity_association_pdr_add_from_node() should migrate to 361 pldm_entity_association_pdr_add_from_node_check() 362 36311. pdr: Stabilise pldm_pdr_add_check() 364 365 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 366 migrate to pldm_pdr_add_check() 367 36812. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 369 370 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 371 pldm_pdr_add_fru_record_set() should migrate to 372 pldm_pdr_add_fru_record_set_check() 373 374### Removed 375 3761. bios_table: Remove deprecated APIs sanitized by assert(): 377 378 - pldm_bios_table_string_entry_encode() 379 - pldm_bios_table_string_entry_decode_string() 380 - pldm_bios_table_attr_entry_enum_encode() 381 - pldm_bios_table_attr_entry_enum_decode_pv_num() 382 - pldm_bios_table_attr_entry_enum_decode_def_num() 383 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 384 - pldm_bios_table_attr_entry_string_encode() 385 - pldm_bios_table_attr_entry_string_decode_def_string_length() 386 387### Fixed 388 3891. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3902. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3913. transport: mctp-demux: Don't test socket for non-zero value 3924. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3935. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3946. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3957. abi: Update to remove pldm_close() from reference dumps 3968. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 397 398## [0.3.0] - 2023-06-23 399 400### Added 401 4021. Add encode/decode pldmMessagePollEvent data 4032. README: Add a section on working with libpldm 4043. pdr: Introduce remote_container_id and associated APIs 4054. pdr: Add APIs for creating and locating remote PDRs 4065. pdr: Add pldm_pdr_find_last_in_range() 4076. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4087. pdr: Add pldm_pdr_find_container_id_range_exclude() 409 410### Changed 411 4121. include: Move installed transport.h under libpldm/ 4132. libpldm: Explicit deprecated, stable and testing ABI classes 4143. meson: Reduce strength of oem-ibm requirements from enabled to allowed 415 416 The `oem-ibm` feature is now enabled by the default meson configuration, for 417 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 418 recipe: 419 420 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 421 422 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 423 when invoking `meson setup` 424 4254. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4265. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 427 428### Deprecated 429 4301. bios_table: Deprecate APIs with arguments sanitized using assert() 431 432 C provides enough foot-guns without us encoding them into library APIs. 433 Specifically, deprecate the following in favour of their `*_check()` variants 434 which ensure assertions won't fail or otherwise invoke UB: 435 436 - pldm_bios_table_string_entry_encode() 437 - pldm_bios_table_string_entry_decode_string() 438 - pldm_bios_table_attr_entry_enum_encode() 439 - pldm_bios_table_attr_entry_enum_decode_pv_num() 440 - pldm_bios_table_attr_entry_enum_decode_def_num() 441 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 442 - pldm_bios_table_attr_entry_string_encode() 443 - pldm_bios_table_attr_entry_string_decode_def_string_length() 444 445### Removed 446 4471. libpldm: Remove the requester-api option 448 449### Fixed 450 4511. requester: Make pldm_open() return existing fd 4522. transport: Prevent sticking in waiting for response 4533. transport: Match on response in pldm_transport_send_recv_msg() 4544. requester: Add check before accessing hdr in pldm_recv() 4555. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 456