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_entity_association_pdr_add_check()` 50 - `pldm_entity_association_pdr_add_from_node_check()` 51 - `pldm_pdr_add_check()` 52 - `pldm_pdr_add_fru_record_set_check()` 53 54[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 55 56### Removed 57 581. IBM OEM header compatibility symlinks. 59 60 Anyone left using the deprecated paths can migrate using the coccinelle patch 61 at `evolutions/current/oem-ibm-header-compat.cocci`. 62 63### Fixed 64 651. requester: instance-id: Release read lock on conflict 66 67## [0.8.0] - 2024-05-23 68 69### Added 70 711. base: Provide pldm_msg_hdr_correlate_response() 722. transport: af-mctp: Add pldm_transport_af_mctp_bind() 733. oem: ibm: Add chapdata file type support 744. base: Added PLDM_SMBIOS & PLDM_RDE message types 755. oem: meta: Add decode_oem_meta_file_io_req() 766. state-set: Add all state set values to system power state enum as per DSP0249 777. platform: Add alias members to the enum 78 pldm_pdr_repository_chg_event_change_record_event_data_operation. 79 80 enum constants with inconsistent names are deprecated with this change. 81 remove old inconsistent enum members after backward compatibility cleanup is 82 done 83 848. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 859. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 8610. platform: Add 3 PDR type enum for Redfish Device Enablement per 87 DSP0248_1.2.0 8811. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 8912. entity: Add enum for Network Interface Connectors and Network Ports 90 Connection Types 9113. pdr: Add decode_numeric_effecter_pdr_data() 9214. oem: ibm: Support for the Real SAI entity id 9315. fw_update: Add encode req & decode resp for query_downstream_devices 9416. fw_update: Add encode req & decode resp for query_downstream_identifiers 9517. platform: Add support for GetStateEffecterStates command 96 97### Changed 98 991. base: Stabilise pldm_msg_hdr_correlate_response() 1002. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1013. libpldm: Fix header use 1024. libpldm: More fixes for header use 1035. pdr: Stabilise pldm_pdr_find_last_in_range() API 1046. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1057. oem: meta: stabilise decode_oem_meta_file_io_req() 1068. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 107 108### Deprecated 109 1101. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 111 with `PLDM_OEM_IBM_` 112 113### Fixed 114 1151. libpldm: Rationalise the local and installed path of pldm.h 1162. pdr: Assign record_handle in entity_association_pdr_add_children() 1173. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1184. pdr: Remove redundant constant for minimum numeric sensor PDR length 1195. tests: oem: meta: Fix fileio use of msgbuf 120 121## [0.7.0] - 2023-08-29 122 123### Added 124 1251. state-set: Add new enum for Operational Fault Status enum 126 127### Changed 128 1291. transport: Match specified metadata in pldm_transport_send_recv_msg() 1302. transport: mctp-demux: Drop ABI annotation for internal symbols 1313. transport: Stabilise core transport and implementation APIs 132 133 This stabilisation covers the following headers and functions: 134 135 - libpldm/transport.h 136 137 - pldm_transport_poll() 138 - pldm_transport_send_msg() 139 - pldm_transport_recv_msg() 140 - pldm_transport_send_recv_msg() 141 142 - libpldm/transport/af-mctp.h 143 144 - pldm_transport_af_mctp_init() 145 - pldm_transport_af_mctp_destroy() 146 - pldm_transport_af_mctp_core() 147 - pldm_transport_af_mctp_init_pollfd() 148 - pldm_transport_af_mctp_map_tid() 149 - pldm_transport_af_mctp_unmap_tid() 150 151 - libpldm/transport/mctp-demux.h 152 - pldm_transport_mctp_demux_init() 153 - pldm_transport_mctp_demux_destroy() 154 - pldm_transport_mctp_demux_core() 155 - pldm_transport_mctp_demux_init_pollfd() 156 - pldm_transport_mctp_demux_map_tid() 157 - pldm_transport_mctp_demux_unmap_tid() 158 159### Deprecated 160 1611. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 162 `libpldm/requester/pldm.h`): 163 164 - pldm_open() 165 - pldm_send_recv() 166 - pldm_send() 167 - pldm_recv() 168 - pldm_recv_any() 169 - pldm_close() 170 171 Users should migrate to the newer "transport" APIs instead. 172 173## Fixed 174 1751. tests: Exclude transport tests when build excludes testing ABIs 1762. abi: Capture deprecation of pldm_close() 177 178## [0.6.0] - 2023-08-22 179 180### Changed 181 1821. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1832. meson: Apply `b_ndebug=if-release` by default 1843. pdr : Stabilize pldm_entity_association_tree_add_entity() 1854. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1865. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1876. transport: af-mctp: Assign out-params on success in \*\_recv() 1887. transport: Generalise the pldm_transport_recv_msg() API 189 190### Removed 191 1921. pdr: Remove pldm_entity_association_pdr_add() 1932. state-set: Remove enum pldm_state_set_operational_fault_status_values 194 195### Fixed 196 1971. transport: register init_pollfd callback for af-mctp 1982. transport: fix init_pollfd function parameter 1993. transport: Fix doxygen and variables for send and recv functions 2004. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 201 202## [0.5.0] - 2023-08-09 203 204### Added 205 2061. pdr: Introduce pldm_entity_association_pdr_add_check() 207 208### Changed 209 2101. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2112. transport: pldm_transport_poll(): Adjust return value semantics 2123. transport: free un-wanted responses in pldm_transport_send_recv_msg() 213 214### Deprecated 215 2161. state-set: Enum pldm_state_set_operational_fault_status_values 217 218 The enum operational_fault_status is defined with wrong members and will 219 eventually be replaced with the correct members. Any uses of 220 pldm_state_set_operational_fault_status_values members should move to 221 equivalent pldm_state_set_operational_stress_status_values members if needed. 222 2232. platform: Struct field name in fru_record_set PDR 224 225 References to entity_instance_num should be changed to entity_instance 226 2273. platform: Struct field name in numeric sensor value PDR 228 229 References to entity_instance_num should be changed to entity_instance 230 231### Removed 232 2331. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2342. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2353. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2364. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2375. bios_table: Remove pldm_bios_table_append_pad_checksum() 2386. fru: Remove get_fru_record_by_option() 2397. pdr: Make is_present() static 2408. pdr: Remove pldm_pdr_add() 2419. pdr: Remove pldm_pdr_add_fru_record_set() 24210. pdr: Remove pldm_entity_association_pdr_add_from_node() 24311. pdr: Make find_entity_ref_in_tree() static 24412. pdr: Make entity_association_tree_find() static 245 246### Fixed 247 2481. requester: Fix response buffer cast in pldm_send_recv() 2492. pdr: Hoist record handle overflow test to avoid memory leak 2503. transport: Correct comparison in while loop condition 251 252## [0.4.0] - 2023-07-14 253 254### Added 255 2561. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2572. fru: Introduce get_fru_record_by_option_check() 2583. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2594. pdr: Introduce pldm_pdr_add_check() 2605. pdr: Introduce pldm_pdr_add_fru_record_set_check() 261 262### Changed 263 2641. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2652. requester: Expose pldm_close() in header 2663. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2674. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2685. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2696. pdr: pldm_pdr_init(): Return NULL on allocation failure 2707. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2718. pdr: Document preconditions for trivial accessor functions 272 273 A trivial accessor function is one that exposes properties of an object in a 274 way can't result in an error, beyond passing an invalid argument to the 275 function. For APIs meeting this definition we define a precondition that 276 struct pointers must point to valid objects to avoid polluting the function 277 prototypes. The following APIs now have this precondition explicitly defined: 278 279 - pldm_entity_extract() 280 - pldm_entity_get_parent() 281 - pldm_entity_is_exist_parent() 282 - pldm_entity_is_node_parent() 283 - pldm_is_current_parent_child 284 - pldm_is_empty_entity_assoc_tree() 285 - pldm_pdr_get_record_count() 286 - pldm_pdr_get_record_handle() 287 - pldm_pdr_get_repo_size() 288 - pldm_pdr_record_is_remote() 289 2909. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 29110. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 29211. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 29312. pdr: pldm_entity_association_tree_visit(): Document preconditions 29413. pdr: pldm_entity_association_tree_visit(): Exit early on failure 29514. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 29615. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 29716. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 29817. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 29918. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 30019. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 30120. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 30221. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 30322. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 30423. pdr: pldm_entity_get_num_children(): Don't return invalid values 30524. libpldm: Lift or remove asserts where a subsequent check exists 306 307### Deprecated 308 3091. pldm_bios_table_attr_entry_integer_encode() 310 311 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 312 3132. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 314 315 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 316 3173. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 318 319 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 320 3214. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 322 323 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 324 3255. pdr: Deprecate is_present() 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 3316. pdr: Deprecate find_entity_ref_in_tree() 332 333 There should be no users of this symbol. If you are a user, you should figure 334 out how to stop, or get in touch. This symbol will be marked static the 335 release after deprecation. 336 3377. pdr: Deprecate entity_association_tree_find() 338 339 There should be no users of this symbol. If you are a user, you should figure 340 out how to stop, or get in touch. This symbol will be marked static the 341 release after deprecation. 342 3438. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 344 345 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 346 pldm_bios_table_append_pad_checksum() should migrate to 347 pldm_bios_table_append_pad_checksum_check() 348 3499. fru: Stabilise get_fru_record_by_option_check() 350 351 get_fru_record_by_option() is deprecated by this change. Users of 352 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 353 35410. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 355 356 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 357 Users of pldm_entity_association_pdr_add_from_node() should migrate to 358 pldm_entity_association_pdr_add_from_node_check() 359 36011. pdr: Stabilise pldm_pdr_add_check() 361 362 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 363 migrate to pldm_pdr_add_check() 364 36512. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 366 367 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 368 pldm_pdr_add_fru_record_set() should migrate to 369 pldm_pdr_add_fru_record_set_check() 370 371### Removed 372 3731. bios_table: Remove deprecated APIs sanitized by assert(): 374 375 - pldm_bios_table_string_entry_encode() 376 - pldm_bios_table_string_entry_decode_string() 377 - pldm_bios_table_attr_entry_enum_encode() 378 - pldm_bios_table_attr_entry_enum_decode_pv_num() 379 - pldm_bios_table_attr_entry_enum_decode_def_num() 380 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 381 - pldm_bios_table_attr_entry_string_encode() 382 - pldm_bios_table_attr_entry_string_decode_def_string_length() 383 384### Fixed 385 3861. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3872. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3883. transport: mctp-demux: Don't test socket for non-zero value 3894. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3905. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3916. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3927. abi: Update to remove pldm_close() from reference dumps 3938. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 394 395## [0.3.0] - 2023-06-23 396 397### Added 398 3991. Add encode/decode pldmMessagePollEvent data 4002. README: Add a section on working with libpldm 4013. pdr: Introduce remote_container_id and associated APIs 4024. pdr: Add APIs for creating and locating remote PDRs 4035. pdr: Add pldm_pdr_find_last_in_range() 4046. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4057. pdr: Add pldm_pdr_find_container_id_range_exclude() 406 407### Changed 408 4091. include: Move installed transport.h under libpldm/ 4102. libpldm: Explicit deprecated, stable and testing ABI classes 4113. meson: Reduce strength of oem-ibm requirements from enabled to allowed 412 413 The `oem-ibm` feature is now enabled by the default meson configuration, for 414 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 415 recipe: 416 417 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 418 419 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 420 when invoking `meson setup` 421 4224. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4235. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 424 425### Deprecated 426 4271. bios_table: Deprecate APIs with arguments sanitized using assert() 428 429 C provides enough foot-guns without us encoding them into library APIs. 430 Specifically, deprecate the following in favour of their `*_check()` variants 431 which ensure assertions won't fail or otherwise invoke UB: 432 433 - pldm_bios_table_string_entry_encode() 434 - pldm_bios_table_string_entry_decode_string() 435 - pldm_bios_table_attr_entry_enum_encode() 436 - pldm_bios_table_attr_entry_enum_decode_pv_num() 437 - pldm_bios_table_attr_entry_enum_decode_def_num() 438 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 439 - pldm_bios_table_attr_entry_string_encode() 440 - pldm_bios_table_attr_entry_string_decode_def_string_length() 441 442### Removed 443 4441. libpldm: Remove the requester-api option 445 446### Fixed 447 4481. requester: Make pldm_open() return existing fd 4492. transport: Prevent sticking in waiting for response 4503. transport: Match on response in pldm_transport_send_recv_msg() 4514. requester: Add check before accessing hdr in pldm_recv() 4525. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 453