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: Provide pldm_msg_hdr_correlate_response() 232. transport: af-mctp: Add pldm_transport_af_mctp_bind() 243. oem: ibm: Add chapdata file type support 254. base: Added PLDM_SMBIOS & PLDM_RDE message types 265. oem: meta: Add decode_oem_meta_file_io_req() 276. state-set: Add all state set values to system power state enum as per DSP0249 287. platform: Add alias members to the enum 29 pldm_pdr_repository_chg_event_change_record_event_data_operation. 30 31 enum constants with inconsistent names are deprecated with this change. 32 remove old inconsistent enum members after backward compatibility cleanup is 33 done 34 358. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 369. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 3710. platform: Add 3 PDR type enum for Redfish Device Enablement per 38 DSP0248_1.2.0 3911. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 4012. entity: Add enum for Network Interface Connectors and Network Ports 41 Connection Types 4213. pdr: Add decode_numeric_effecter_pdr_data() 4314. oem: ibm: Support for the Real SAI entity id 44 45### Changed 46 471. base: Stabilise pldm_msg_hdr_correlate_response() 482. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 493. libpldm: Fix header use 504. libpldm: More fixes for header use 515. pdr: Stabilise pldm_pdr_find_last_in_range() API 526. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 537. oem: meta: stabilise decode_oem_meta_file_io_req() 548. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 55 56### Deprecated 57 581. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 59 with `PLDM_OEM_IBM_` 60 61### Fixed 62 631. libpldm: Rationalise the local and installed path of pldm.h 642. pdr: Assign record_handle in entity_association_pdr_add_children() 653. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 664. pdr: Remove redundant constant for minimum numeric sensor PDR length 67 68## [0.7.0] - 2023-08-29 69 70### Added 71 721. state-set: Add new enum for Operational Fault Status enum 73 74### Changed 75 761. transport: Match specified metadata in pldm_transport_send_recv_msg() 772. transport: mctp-demux: Drop ABI annotation for internal symbols 783. transport: Stabilise core transport and implementation APIs 79 80 This stabilisation covers the following headers and functions: 81 82 - libpldm/transport.h 83 84 - pldm_transport_poll() 85 - pldm_transport_send_msg() 86 - pldm_transport_recv_msg() 87 - pldm_transport_send_recv_msg() 88 89 - libpldm/transport/af-mctp.h 90 91 - pldm_transport_af_mctp_init() 92 - pldm_transport_af_mctp_destroy() 93 - pldm_transport_af_mctp_core() 94 - pldm_transport_af_mctp_init_pollfd() 95 - pldm_transport_af_mctp_map_tid() 96 - pldm_transport_af_mctp_unmap_tid() 97 98 - libpldm/transport/mctp-demux.h 99 - pldm_transport_mctp_demux_init() 100 - pldm_transport_mctp_demux_destroy() 101 - pldm_transport_mctp_demux_core() 102 - pldm_transport_mctp_demux_init_pollfd() 103 - pldm_transport_mctp_demux_map_tid() 104 - pldm_transport_mctp_demux_unmap_tid() 105 106### Deprecated 107 1081. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 109 `libpldm/requester/pldm.h`): 110 111 - pldm_open() 112 - pldm_send_recv() 113 - pldm_send() 114 - pldm_recv() 115 - pldm_recv_any() 116 - pldm_close() 117 118 Users should migrate to the newer "transport" APIs instead. 119 120## Fixed 121 1221. tests: Exclude transport tests when build excludes testing ABIs 1232. abi: Capture deprecation of pldm_close() 124 125## [0.6.0] - 2023-08-22 126 127### Changed 128 1291. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1302. meson: Apply `b_ndebug=if-release` by default 1313. pdr : Stabilize pldm_entity_association_tree_add_entity() 1324. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1335. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1346. transport: af-mctp: Assign out-params on success in \*\_recv() 1357. transport: Generalise the pldm_transport_recv_msg() API 136 137### Removed 138 1391. pdr: Remove pldm_entity_association_pdr_add() 1402. state-set: Remove enum pldm_state_set_operational_fault_status_values 141 142### Fixed 143 1441. transport: register init_pollfd callback for af-mctp 1452. transport: fix init_pollfd function parameter 1463. transport: Fix doxygen and variables for send and recv functions 1474. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 148 149## [0.5.0] - 2023-08-09 150 151### Added 152 1531. pdr: Introduce pldm_entity_association_pdr_add_check() 154 155### Changed 156 1571. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 1582. transport: pldm_transport_poll(): Adjust return value semantics 1593. transport: free un-wanted responses in pldm_transport_send_recv_msg() 160 161### Deprecated 162 1631. state-set: Enum pldm_state_set_operational_fault_status_values 164 165 The enum operational_fault_status is defined with wrong members and will 166 eventually be replaced with the correct members. Any uses of 167 pldm_state_set_operational_fault_status_values members should move to 168 equivalent pldm_state_set_operational_stress_status_values members if needed. 169 1702. platform: Struct field name in fru_record_set PDR 171 172 References to entity_instance_num should be changed to entity_instance 173 1743. platform: Struct field name in numeric sensor value PDR 175 176 References to entity_instance_num should be changed to entity_instance 177 178### Removed 179 1801. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 1812. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 1823. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 1834. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 1845. bios_table: Remove pldm_bios_table_append_pad_checksum() 1856. fru: Remove get_fru_record_by_option() 1867. pdr: Make is_present() static 1878. pdr: Remove pldm_pdr_add() 1889. pdr: Remove pldm_pdr_add_fru_record_set() 18910. pdr: Remove pldm_entity_association_pdr_add_from_node() 19011. pdr: Make find_entity_ref_in_tree() static 19112. pdr: Make entity_association_tree_find() static 192 193### Fixed 194 1951. requester: Fix response buffer cast in pldm_send_recv() 1962. pdr: Hoist record handle overflow test to avoid memory leak 1973. transport: Correct comparison in while loop condition 198 199## [0.4.0] - 2023-07-14 200 201### Added 202 2031. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2042. fru: Introduce get_fru_record_by_option_check() 2053. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2064. pdr: Introduce pldm_pdr_add_check() 2075. pdr: Introduce pldm_pdr_add_fru_record_set_check() 208 209### Changed 210 2111. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2122. requester: Expose pldm_close() in header 2133. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2144. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2155. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2166. pdr: pldm_pdr_init(): Return NULL on allocation failure 2177. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2188. pdr: Document preconditions for trivial accessor functions 219 220 A trivial accessor function is one that exposes properties of an object in a 221 way can't result in an error, beyond passing an invalid argument to the 222 function. For APIs meeting this definition we define a precondition that 223 struct pointers must point to valid objects to avoid polluting the function 224 prototypes. The following APIs now have this precondition explicitly defined: 225 226 - pldm_entity_extract() 227 - pldm_entity_get_parent() 228 - pldm_entity_is_exist_parent() 229 - pldm_entity_is_node_parent() 230 - pldm_is_current_parent_child 231 - pldm_is_empty_entity_assoc_tree() 232 - pldm_pdr_get_record_count() 233 - pldm_pdr_get_record_handle() 234 - pldm_pdr_get_repo_size() 235 - pldm_pdr_record_is_remote() 236 2379. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 23810. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 23911. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 24012. pdr: pldm_entity_association_tree_visit(): Document preconditions 24113. pdr: pldm_entity_association_tree_visit(): Exit early on failure 24214. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 24315. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 24416. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 24517. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 24618. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 24719. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 24820. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 24921. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 25022. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 25123. pdr: pldm_entity_get_num_children(): Don't return invalid values 25224. libpldm: Lift or remove asserts where a subsequent check exists 253 254### Deprecated 255 2561. pldm_bios_table_attr_entry_integer_encode() 257 258 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 259 2602. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 261 262 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 263 2643. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 265 266 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 267 2684. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 269 270 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 271 2725. pdr: Deprecate is_present() 273 274 There should be no users of this symbol. If you are a user, you should figure 275 out how to stop, or get in touch. This symbol will be marked static the 276 release after deprecation. 277 2786. pdr: Deprecate find_entity_ref_in_tree() 279 280 There should be no users of this symbol. If you are a user, you should figure 281 out how to stop, or get in touch. This symbol will be marked static the 282 release after deprecation. 283 2847. pdr: Deprecate entity_association_tree_find() 285 286 There should be no users of this symbol. If you are a user, you should figure 287 out how to stop, or get in touch. This symbol will be marked static the 288 release after deprecation. 289 2908. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 291 292 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 293 pldm_bios_table_append_pad_checksum() should migrate to 294 pldm_bios_table_append_pad_checksum_check() 295 2969. fru: Stabilise get_fru_record_by_option_check() 297 298 get_fru_record_by_option() is deprecated by this change. Users of 299 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 300 30110. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 302 303 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 304 Users of pldm_entity_association_pdr_add_from_node() should migrate to 305 pldm_entity_association_pdr_add_from_node_check() 306 30711. pdr: Stabilise pldm_pdr_add_check() 308 309 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 310 migrate to pldm_pdr_add_check() 311 31212. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 313 314 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 315 pldm_pdr_add_fru_record_set() should migrate to 316 pldm_pdr_add_fru_record_set_check() 317 318### Removed 319 3201. bios_table: Remove deprecated APIs sanitized by assert(): 321 322 - pldm_bios_table_string_entry_encode() 323 - pldm_bios_table_string_entry_decode_string() 324 - pldm_bios_table_attr_entry_enum_encode() 325 - pldm_bios_table_attr_entry_enum_decode_pv_num() 326 - pldm_bios_table_attr_entry_enum_decode_def_num() 327 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 328 - pldm_bios_table_attr_entry_string_encode() 329 - pldm_bios_table_attr_entry_string_decode_def_string_length() 330 331### Fixed 332 3331. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3342. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3353. transport: mctp-demux: Don't test socket for non-zero value 3364. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3375. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3386. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3397. abi: Update to remove pldm_close() from reference dumps 3408. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 341 342## [0.3.0] - 2023-06-23 343 344### Added 345 3461. Add encode/decode pldmMessagePollEvent data 3472. README: Add a section on working with libpldm 3483. pdr: Introduce remote_container_id and associated APIs 3494. pdr: Add APIs for creating and locating remote PDRs 3505. pdr: Add pldm_pdr_find_last_in_range() 3516. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 3527. pdr: Add pldm_pdr_find_container_id_range_exclude() 353 354### Changed 355 3561. include: Move installed transport.h under libpldm/ 3572. libpldm: Explicit deprecated, stable and testing ABI classes 3583. meson: Reduce strength of oem-ibm requirements from enabled to allowed 359 360 The `oem-ibm` feature is now enabled by the default meson configuration, for 361 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 362 recipe: 363 364 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 365 366 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 367 when invoking `meson setup` 368 3694. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 3705. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 371 372### Deprecated 373 3741. bios_table: Deprecate APIs with arguments sanitized using assert() 375 376 C provides enough foot-guns without us encoding them into library APIs. 377 Specifically, deprecate the following in favour of their `*_check()` variants 378 which ensure assertions won't fail or otherwise invoke UB: 379 380 - pldm_bios_table_string_entry_encode() 381 - pldm_bios_table_string_entry_decode_string() 382 - pldm_bios_table_attr_entry_enum_encode() 383 - pldm_bios_table_attr_entry_enum_decode_pv_num() 384 - pldm_bios_table_attr_entry_enum_decode_def_num() 385 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 386 - pldm_bios_table_attr_entry_string_encode() 387 - pldm_bios_table_attr_entry_string_decode_def_string_length() 388 389### Removed 390 3911. libpldm: Remove the requester-api option 392 393### Fixed 394 3951. requester: Make pldm_open() return existing fd 3962. transport: Prevent sticking in waiting for response 3973. transport: Match on response in pldm_transport_send_recv_msg() 3984. requester: Add check before accessing hdr in pldm_recv() 3995. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 400