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_decode_def_num_check()` 50 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 51 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 52 - `pldm_bios_table_attr_entry_enum_encode_check()` 53 - `pldm_bios_table_attr_entry_string_encode_check()` 54 - `pldm_bios_table_string_entry_decode_string_check()` 55 - `pldm_bios_table_string_entry_encode_check()` 56 - `pldm_entity_association_pdr_add_check()` 57 - `pldm_entity_association_pdr_add_from_node_check()` 58 - `pldm_pdr_add_check()` 59 - `pldm_pdr_add_fru_record_set_check()` 60 61[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 62 63### Removed 64 651. IBM OEM header compatibility symlinks. 66 67 Anyone left using the deprecated paths can migrate using the coccinelle patch 68 at `evolutions/current/oem-ibm-header-compat.cocci`. 69 70### Fixed 71 721. requester: instance-id: Release read lock on conflict 73 74## [0.8.0] - 2024-05-23 75 76### Added 77 781. base: Provide pldm_msg_hdr_correlate_response() 792. transport: af-mctp: Add pldm_transport_af_mctp_bind() 803. oem: ibm: Add chapdata file type support 814. base: Added PLDM_SMBIOS & PLDM_RDE message types 825. oem: meta: Add decode_oem_meta_file_io_req() 836. state-set: Add all state set values to system power state enum as per DSP0249 847. platform: Add alias members to the enum 85 pldm_pdr_repository_chg_event_change_record_event_data_operation. 86 87 enum constants with inconsistent names are deprecated with this change. 88 remove old inconsistent enum members after backward compatibility cleanup is 89 done 90 918. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 929. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 9310. platform: Add 3 PDR type enum for Redfish Device Enablement per 94 DSP0248_1.2.0 9511. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 9612. entity: Add enum for Network Interface Connectors and Network Ports 97 Connection Types 9813. pdr: Add decode_numeric_effecter_pdr_data() 9914. oem: ibm: Support for the Real SAI entity id 10015. fw_update: Add encode req & decode resp for query_downstream_devices 10116. fw_update: Add encode req & decode resp for query_downstream_identifiers 10217. platform: Add support for GetStateEffecterStates command 103 104### Changed 105 1061. base: Stabilise pldm_msg_hdr_correlate_response() 1072. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1083. libpldm: Fix header use 1094. libpldm: More fixes for header use 1105. pdr: Stabilise pldm_pdr_find_last_in_range() API 1116. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1127. oem: meta: stabilise decode_oem_meta_file_io_req() 1138. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 114 115### Deprecated 116 1171. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 118 with `PLDM_OEM_IBM_` 119 120### Fixed 121 1221. libpldm: Rationalise the local and installed path of pldm.h 1232. pdr: Assign record_handle in entity_association_pdr_add_children() 1243. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1254. pdr: Remove redundant constant for minimum numeric sensor PDR length 1265. tests: oem: meta: Fix fileio use of msgbuf 127 128## [0.7.0] - 2023-08-29 129 130### Added 131 1321. state-set: Add new enum for Operational Fault Status enum 133 134### Changed 135 1361. transport: Match specified metadata in pldm_transport_send_recv_msg() 1372. transport: mctp-demux: Drop ABI annotation for internal symbols 1383. transport: Stabilise core transport and implementation APIs 139 140 This stabilisation covers the following headers and functions: 141 142 - libpldm/transport.h 143 144 - pldm_transport_poll() 145 - pldm_transport_send_msg() 146 - pldm_transport_recv_msg() 147 - pldm_transport_send_recv_msg() 148 149 - libpldm/transport/af-mctp.h 150 151 - pldm_transport_af_mctp_init() 152 - pldm_transport_af_mctp_destroy() 153 - pldm_transport_af_mctp_core() 154 - pldm_transport_af_mctp_init_pollfd() 155 - pldm_transport_af_mctp_map_tid() 156 - pldm_transport_af_mctp_unmap_tid() 157 158 - libpldm/transport/mctp-demux.h 159 - pldm_transport_mctp_demux_init() 160 - pldm_transport_mctp_demux_destroy() 161 - pldm_transport_mctp_demux_core() 162 - pldm_transport_mctp_demux_init_pollfd() 163 - pldm_transport_mctp_demux_map_tid() 164 - pldm_transport_mctp_demux_unmap_tid() 165 166### Deprecated 167 1681. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 169 `libpldm/requester/pldm.h`): 170 171 - pldm_open() 172 - pldm_send_recv() 173 - pldm_send() 174 - pldm_recv() 175 - pldm_recv_any() 176 - pldm_close() 177 178 Users should migrate to the newer "transport" APIs instead. 179 180## Fixed 181 1821. tests: Exclude transport tests when build excludes testing ABIs 1832. abi: Capture deprecation of pldm_close() 184 185## [0.6.0] - 2023-08-22 186 187### Changed 188 1891. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1902. meson: Apply `b_ndebug=if-release` by default 1913. pdr : Stabilize pldm_entity_association_tree_add_entity() 1924. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1935. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1946. transport: af-mctp: Assign out-params on success in \*\_recv() 1957. transport: Generalise the pldm_transport_recv_msg() API 196 197### Removed 198 1991. pdr: Remove pldm_entity_association_pdr_add() 2002. state-set: Remove enum pldm_state_set_operational_fault_status_values 201 202### Fixed 203 2041. transport: register init_pollfd callback for af-mctp 2052. transport: fix init_pollfd function parameter 2063. transport: Fix doxygen and variables for send and recv functions 2074. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 208 209## [0.5.0] - 2023-08-09 210 211### Added 212 2131. pdr: Introduce pldm_entity_association_pdr_add_check() 214 215### Changed 216 2171. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2182. transport: pldm_transport_poll(): Adjust return value semantics 2193. transport: free un-wanted responses in pldm_transport_send_recv_msg() 220 221### Deprecated 222 2231. state-set: Enum pldm_state_set_operational_fault_status_values 224 225 The enum operational_fault_status is defined with wrong members and will 226 eventually be replaced with the correct members. Any uses of 227 pldm_state_set_operational_fault_status_values members should move to 228 equivalent pldm_state_set_operational_stress_status_values members if needed. 229 2302. platform: Struct field name in fru_record_set PDR 231 232 References to entity_instance_num should be changed to entity_instance 233 2343. platform: Struct field name in numeric sensor value PDR 235 236 References to entity_instance_num should be changed to entity_instance 237 238### Removed 239 2401. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2412. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2423. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2434. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2445. bios_table: Remove pldm_bios_table_append_pad_checksum() 2456. fru: Remove get_fru_record_by_option() 2467. pdr: Make is_present() static 2478. pdr: Remove pldm_pdr_add() 2489. pdr: Remove pldm_pdr_add_fru_record_set() 24910. pdr: Remove pldm_entity_association_pdr_add_from_node() 25011. pdr: Make find_entity_ref_in_tree() static 25112. pdr: Make entity_association_tree_find() static 252 253### Fixed 254 2551. requester: Fix response buffer cast in pldm_send_recv() 2562. pdr: Hoist record handle overflow test to avoid memory leak 2573. transport: Correct comparison in while loop condition 258 259## [0.4.0] - 2023-07-14 260 261### Added 262 2631. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2642. fru: Introduce get_fru_record_by_option_check() 2653. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2664. pdr: Introduce pldm_pdr_add_check() 2675. pdr: Introduce pldm_pdr_add_fru_record_set_check() 268 269### Changed 270 2711. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2722. requester: Expose pldm_close() in header 2733. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2744. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2755. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2766. pdr: pldm_pdr_init(): Return NULL on allocation failure 2777. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2788. pdr: Document preconditions for trivial accessor functions 279 280 A trivial accessor function is one that exposes properties of an object in a 281 way can't result in an error, beyond passing an invalid argument to the 282 function. For APIs meeting this definition we define a precondition that 283 struct pointers must point to valid objects to avoid polluting the function 284 prototypes. The following APIs now have this precondition explicitly defined: 285 286 - pldm_entity_extract() 287 - pldm_entity_get_parent() 288 - pldm_entity_is_exist_parent() 289 - pldm_entity_is_node_parent() 290 - pldm_is_current_parent_child 291 - pldm_is_empty_entity_assoc_tree() 292 - pldm_pdr_get_record_count() 293 - pldm_pdr_get_record_handle() 294 - pldm_pdr_get_repo_size() 295 - pldm_pdr_record_is_remote() 296 2979. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 29810. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 29911. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 30012. pdr: pldm_entity_association_tree_visit(): Document preconditions 30113. pdr: pldm_entity_association_tree_visit(): Exit early on failure 30214. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 30315. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 30416. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 30517. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 30618. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 30719. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 30820. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 30921. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 31022. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 31123. pdr: pldm_entity_get_num_children(): Don't return invalid values 31224. libpldm: Lift or remove asserts where a subsequent check exists 313 314### Deprecated 315 3161. pldm_bios_table_attr_entry_integer_encode() 317 318 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 319 3202. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 321 322 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 323 3243. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 325 326 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 327 3284. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 329 330 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 331 3325. pdr: Deprecate is_present() 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 3386. pdr: Deprecate find_entity_ref_in_tree() 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 3447. pdr: Deprecate entity_association_tree_find() 345 346 There should be no users of this symbol. If you are a user, you should figure 347 out how to stop, or get in touch. This symbol will be marked static the 348 release after deprecation. 349 3508. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 351 352 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 353 pldm_bios_table_append_pad_checksum() should migrate to 354 pldm_bios_table_append_pad_checksum_check() 355 3569. fru: Stabilise get_fru_record_by_option_check() 357 358 get_fru_record_by_option() is deprecated by this change. Users of 359 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 360 36110. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 362 363 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 364 Users of pldm_entity_association_pdr_add_from_node() should migrate to 365 pldm_entity_association_pdr_add_from_node_check() 366 36711. pdr: Stabilise pldm_pdr_add_check() 368 369 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 370 migrate to pldm_pdr_add_check() 371 37212. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 373 374 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 375 pldm_pdr_add_fru_record_set() should migrate to 376 pldm_pdr_add_fru_record_set_check() 377 378### Removed 379 3801. bios_table: Remove deprecated APIs sanitized by assert(): 381 382 - pldm_bios_table_string_entry_encode() 383 - pldm_bios_table_string_entry_decode_string() 384 - pldm_bios_table_attr_entry_enum_encode() 385 - pldm_bios_table_attr_entry_enum_decode_pv_num() 386 - pldm_bios_table_attr_entry_enum_decode_def_num() 387 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 388 - pldm_bios_table_attr_entry_string_encode() 389 - pldm_bios_table_attr_entry_string_decode_def_string_length() 390 391### Fixed 392 3931. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3942. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3953. transport: mctp-demux: Don't test socket for non-zero value 3964. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3975. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3986. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3997. abi: Update to remove pldm_close() from reference dumps 4008. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 401 402## [0.3.0] - 2023-06-23 403 404### Added 405 4061. Add encode/decode pldmMessagePollEvent data 4072. README: Add a section on working with libpldm 4083. pdr: Introduce remote_container_id and associated APIs 4094. pdr: Add APIs for creating and locating remote PDRs 4105. pdr: Add pldm_pdr_find_last_in_range() 4116. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4127. pdr: Add pldm_pdr_find_container_id_range_exclude() 413 414### Changed 415 4161. include: Move installed transport.h under libpldm/ 4172. libpldm: Explicit deprecated, stable and testing ABI classes 4183. meson: Reduce strength of oem-ibm requirements from enabled to allowed 419 420 The `oem-ibm` feature is now enabled by the default meson configuration, for 421 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 422 recipe: 423 424 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 425 426 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 427 when invoking `meson setup` 428 4294. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4305. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 431 432### Deprecated 433 4341. bios_table: Deprecate APIs with arguments sanitized using assert() 435 436 C provides enough foot-guns without us encoding them into library APIs. 437 Specifically, deprecate the following in favour of their `*_check()` variants 438 which ensure assertions won't fail or otherwise invoke UB: 439 440 - pldm_bios_table_string_entry_encode() 441 - pldm_bios_table_string_entry_decode_string() 442 - pldm_bios_table_attr_entry_enum_encode() 443 - pldm_bios_table_attr_entry_enum_decode_pv_num() 444 - pldm_bios_table_attr_entry_enum_decode_def_num() 445 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 446 - pldm_bios_table_attr_entry_string_encode() 447 - pldm_bios_table_attr_entry_string_decode_def_string_length() 448 449### Removed 450 4511. libpldm: Remove the requester-api option 452 453### Fixed 454 4551. requester: Make pldm_open() return existing fd 4562. transport: Prevent sticking in waiting for response 4573. transport: Match on response in pldm_transport_send_recv_msg() 4584. requester: Add check before accessing hdr in pldm_recv() 4595. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 460