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 298. platform: Add decode_pldm_platform_cper_event_data() API 30 31### Changed 32 331. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 342. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 353. platform: Stabilise decode_pldm_message_poll_event_data() APIs 36 37### Deprecated 38 391. Rename and deprecate functions with the `_check` suffix 40 41 All library function return values always need to be checked. The `_check` 42 suffix is redundant, so remove it. Migration to the non-deprecated 43 equivalents without the `_check` suffix can be performed using 44 `scripts/ apply-renames` and the [clang-rename][] configurations under 45 `evolutions/` 46 47 The deprecated functions: 48 49 - `get_fru_record_by_option_check()` 50 - `pldm_bios_table_append_pad_checksum_check()` 51 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 52 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 53 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 54 - `pldm_bios_table_attr_entry_enum_encode_check()` 55 - `pldm_bios_table_attr_entry_integer_encode_check()` 56 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 57 - `pldm_bios_table_attr_entry_string_encode_check()` 58 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 59 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 60 - `pldm_bios_table_attr_value_entry_encode_string_check()` 61 - `pldm_bios_table_string_entry_decode_string_check()` 62 - `pldm_bios_table_string_entry_encode_check()` 63 - `pldm_entity_association_pdr_add_check()` 64 - `pldm_entity_association_pdr_add_from_node_check()` 65 - `pldm_pdr_add_check()` 66 - `pldm_pdr_add_fru_record_set_check()` 67 68[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 69 70### Removed 71 721. IBM OEM header compatibility symlinks. 73 74 Anyone left using the deprecated paths can migrate using the coccinelle patch 75 at `evolutions/current/oem-ibm-header-compat.cocci`. 76 77### Fixed 78 791. requester: instance-id: Release read lock on conflict 80 81## [0.8.0] - 2024-05-23 82 83### Added 84 851. base: Provide pldm_msg_hdr_correlate_response() 862. transport: af-mctp: Add pldm_transport_af_mctp_bind() 873. oem: ibm: Add chapdata file type support 884. base: Added PLDM_SMBIOS & PLDM_RDE message types 895. oem: meta: Add decode_oem_meta_file_io_req() 906. state-set: Add all state set values to system power state enum as per DSP0249 917. platform: Add alias members to the enum 92 pldm_pdr_repository_chg_event_change_record_event_data_operation. 93 94 enum constants with inconsistent names are deprecated with this change. 95 remove old inconsistent enum members after backward compatibility cleanup is 96 done 97 988. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 999. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 10010. platform: Add 3 PDR type enum for Redfish Device Enablement per 101 DSP0248_1.2.0 10211. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 10312. entity: Add enum for Network Interface Connectors and Network Ports 104 Connection Types 10513. pdr: Add decode_numeric_effecter_pdr_data() 10614. oem: ibm: Support for the Real SAI entity id 10715. fw_update: Add encode req & decode resp for query_downstream_devices 10816. fw_update: Add encode req & decode resp for query_downstream_identifiers 10917. platform: Add support for GetStateEffecterStates command 110 111### Changed 112 1131. base: Stabilise pldm_msg_hdr_correlate_response() 1142. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1153. libpldm: Fix header use 1164. libpldm: More fixes for header use 1175. pdr: Stabilise pldm_pdr_find_last_in_range() API 1186. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1197. oem: meta: stabilise decode_oem_meta_file_io_req() 1208. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 121 122### Deprecated 123 1241. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 125 with `PLDM_OEM_IBM_` 126 127### Fixed 128 1291. libpldm: Rationalise the local and installed path of pldm.h 1302. pdr: Assign record_handle in entity_association_pdr_add_children() 1313. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1324. pdr: Remove redundant constant for minimum numeric sensor PDR length 1335. tests: oem: meta: Fix fileio use of msgbuf 134 135## [0.7.0] - 2023-08-29 136 137### Added 138 1391. state-set: Add new enum for Operational Fault Status enum 140 141### Changed 142 1431. transport: Match specified metadata in pldm_transport_send_recv_msg() 1442. transport: mctp-demux: Drop ABI annotation for internal symbols 1453. transport: Stabilise core transport and implementation APIs 146 147 This stabilisation covers the following headers and functions: 148 149 - libpldm/transport.h 150 151 - pldm_transport_poll() 152 - pldm_transport_send_msg() 153 - pldm_transport_recv_msg() 154 - pldm_transport_send_recv_msg() 155 156 - libpldm/transport/af-mctp.h 157 158 - pldm_transport_af_mctp_init() 159 - pldm_transport_af_mctp_destroy() 160 - pldm_transport_af_mctp_core() 161 - pldm_transport_af_mctp_init_pollfd() 162 - pldm_transport_af_mctp_map_tid() 163 - pldm_transport_af_mctp_unmap_tid() 164 165 - libpldm/transport/mctp-demux.h 166 - pldm_transport_mctp_demux_init() 167 - pldm_transport_mctp_demux_destroy() 168 - pldm_transport_mctp_demux_core() 169 - pldm_transport_mctp_demux_init_pollfd() 170 - pldm_transport_mctp_demux_map_tid() 171 - pldm_transport_mctp_demux_unmap_tid() 172 173### Deprecated 174 1751. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 176 `libpldm/requester/pldm.h`): 177 178 - pldm_open() 179 - pldm_send_recv() 180 - pldm_send() 181 - pldm_recv() 182 - pldm_recv_any() 183 - pldm_close() 184 185 Users should migrate to the newer "transport" APIs instead. 186 187## Fixed 188 1891. tests: Exclude transport tests when build excludes testing ABIs 1902. abi: Capture deprecation of pldm_close() 191 192## [0.6.0] - 2023-08-22 193 194### Changed 195 1961. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1972. meson: Apply `b_ndebug=if-release` by default 1983. pdr : Stabilize pldm_entity_association_tree_add_entity() 1994. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 2005. pdr: Stabilize pldm_entity_node_get_remote_container_id() 2016. transport: af-mctp: Assign out-params on success in \*\_recv() 2027. transport: Generalise the pldm_transport_recv_msg() API 203 204### Removed 205 2061. pdr: Remove pldm_entity_association_pdr_add() 2072. state-set: Remove enum pldm_state_set_operational_fault_status_values 208 209### Fixed 210 2111. transport: register init_pollfd callback for af-mctp 2122. transport: fix init_pollfd function parameter 2133. transport: Fix doxygen and variables for send and recv functions 2144. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 215 216## [0.5.0] - 2023-08-09 217 218### Added 219 2201. pdr: Introduce pldm_entity_association_pdr_add_check() 221 222### Changed 223 2241. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2252. transport: pldm_transport_poll(): Adjust return value semantics 2263. transport: free un-wanted responses in pldm_transport_send_recv_msg() 227 228### Deprecated 229 2301. state-set: Enum pldm_state_set_operational_fault_status_values 231 232 The enum operational_fault_status is defined with wrong members and will 233 eventually be replaced with the correct members. Any uses of 234 pldm_state_set_operational_fault_status_values members should move to 235 equivalent pldm_state_set_operational_stress_status_values members if needed. 236 2372. platform: Struct field name in fru_record_set PDR 238 239 References to entity_instance_num should be changed to entity_instance 240 2413. platform: Struct field name in numeric sensor value PDR 242 243 References to entity_instance_num should be changed to entity_instance 244 245### Removed 246 2471. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2482. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2493. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2504. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2515. bios_table: Remove pldm_bios_table_append_pad_checksum() 2526. fru: Remove get_fru_record_by_option() 2537. pdr: Make is_present() static 2548. pdr: Remove pldm_pdr_add() 2559. pdr: Remove pldm_pdr_add_fru_record_set() 25610. pdr: Remove pldm_entity_association_pdr_add_from_node() 25711. pdr: Make find_entity_ref_in_tree() static 25812. pdr: Make entity_association_tree_find() static 259 260### Fixed 261 2621. requester: Fix response buffer cast in pldm_send_recv() 2632. pdr: Hoist record handle overflow test to avoid memory leak 2643. transport: Correct comparison in while loop condition 265 266## [0.4.0] - 2023-07-14 267 268### Added 269 2701. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2712. fru: Introduce get_fru_record_by_option_check() 2723. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2734. pdr: Introduce pldm_pdr_add_check() 2745. pdr: Introduce pldm_pdr_add_fru_record_set_check() 275 276### Changed 277 2781. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2792. requester: Expose pldm_close() in header 2803. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2814. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2825. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2836. pdr: pldm_pdr_init(): Return NULL on allocation failure 2847. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2858. pdr: Document preconditions for trivial accessor functions 286 287 A trivial accessor function is one that exposes properties of an object in a 288 way can't result in an error, beyond passing an invalid argument to the 289 function. For APIs meeting this definition we define a precondition that 290 struct pointers must point to valid objects to avoid polluting the function 291 prototypes. The following APIs now have this precondition explicitly defined: 292 293 - pldm_entity_extract() 294 - pldm_entity_get_parent() 295 - pldm_entity_is_exist_parent() 296 - pldm_entity_is_node_parent() 297 - pldm_is_current_parent_child 298 - pldm_is_empty_entity_assoc_tree() 299 - pldm_pdr_get_record_count() 300 - pldm_pdr_get_record_handle() 301 - pldm_pdr_get_repo_size() 302 - pldm_pdr_record_is_remote() 303 3049. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 30510. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 30611. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 30712. pdr: pldm_entity_association_tree_visit(): Document preconditions 30813. pdr: pldm_entity_association_tree_visit(): Exit early on failure 30914. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 31015. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 31116. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 31217. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 31318. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 31419. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 31520. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 31621. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 31722. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 31823. pdr: pldm_entity_get_num_children(): Don't return invalid values 31924. libpldm: Lift or remove asserts where a subsequent check exists 320 321### Deprecated 322 3231. pldm_bios_table_attr_entry_integer_encode() 324 325 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 326 3272. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 328 329 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 330 3313. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 332 333 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 334 3354. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 336 337 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 338 3395. pdr: Deprecate is_present() 340 341 There should be no users of this symbol. If you are a user, you should figure 342 out how to stop, or get in touch. This symbol will be marked static the 343 release after deprecation. 344 3456. pdr: Deprecate find_entity_ref_in_tree() 346 347 There should be no users of this symbol. If you are a user, you should figure 348 out how to stop, or get in touch. This symbol will be marked static the 349 release after deprecation. 350 3517. pdr: Deprecate entity_association_tree_find() 352 353 There should be no users of this symbol. If you are a user, you should figure 354 out how to stop, or get in touch. This symbol will be marked static the 355 release after deprecation. 356 3578. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 358 359 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 360 pldm_bios_table_append_pad_checksum() should migrate to 361 pldm_bios_table_append_pad_checksum_check() 362 3639. fru: Stabilise get_fru_record_by_option_check() 364 365 get_fru_record_by_option() is deprecated by this change. Users of 366 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 367 36810. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 369 370 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 371 Users of pldm_entity_association_pdr_add_from_node() should migrate to 372 pldm_entity_association_pdr_add_from_node_check() 373 37411. pdr: Stabilise pldm_pdr_add_check() 375 376 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 377 migrate to pldm_pdr_add_check() 378 37912. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 380 381 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 382 pldm_pdr_add_fru_record_set() should migrate to 383 pldm_pdr_add_fru_record_set_check() 384 385### Removed 386 3871. bios_table: Remove deprecated APIs sanitized by assert(): 388 389 - pldm_bios_table_string_entry_encode() 390 - pldm_bios_table_string_entry_decode_string() 391 - pldm_bios_table_attr_entry_enum_encode() 392 - pldm_bios_table_attr_entry_enum_decode_pv_num() 393 - pldm_bios_table_attr_entry_enum_decode_def_num() 394 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 395 - pldm_bios_table_attr_entry_string_encode() 396 - pldm_bios_table_attr_entry_string_decode_def_string_length() 397 398### Fixed 399 4001. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 4012. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 4023. transport: mctp-demux: Don't test socket for non-zero value 4034. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 4045. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 4056. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 4067. abi: Update to remove pldm_close() from reference dumps 4078. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 408 409## [0.3.0] - 2023-06-23 410 411### Added 412 4131. Add encode/decode pldmMessagePollEvent data 4142. README: Add a section on working with libpldm 4153. pdr: Introduce remote_container_id and associated APIs 4164. pdr: Add APIs for creating and locating remote PDRs 4175. pdr: Add pldm_pdr_find_last_in_range() 4186. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4197. pdr: Add pldm_pdr_find_container_id_range_exclude() 420 421### Changed 422 4231. include: Move installed transport.h under libpldm/ 4242. libpldm: Explicit deprecated, stable and testing ABI classes 4253. meson: Reduce strength of oem-ibm requirements from enabled to allowed 426 427 The `oem-ibm` feature is now enabled by the default meson configuration, for 428 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 429 recipe: 430 431 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 432 433 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 434 when invoking `meson setup` 435 4364. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4375. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 438 439### Deprecated 440 4411. bios_table: Deprecate APIs with arguments sanitized using assert() 442 443 C provides enough foot-guns without us encoding them into library APIs. 444 Specifically, deprecate the following in favour of their `*_check()` variants 445 which ensure assertions won't fail or otherwise invoke UB: 446 447 - pldm_bios_table_string_entry_encode() 448 - pldm_bios_table_string_entry_decode_string() 449 - pldm_bios_table_attr_entry_enum_encode() 450 - pldm_bios_table_attr_entry_enum_decode_pv_num() 451 - pldm_bios_table_attr_entry_enum_decode_def_num() 452 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 453 - pldm_bios_table_attr_entry_string_encode() 454 - pldm_bios_table_attr_entry_string_decode_def_string_length() 455 456### Removed 457 4581. libpldm: Remove the requester-api option 459 460### Fixed 461 4621. requester: Make pldm_open() return existing fd 4632. transport: Prevent sticking in waiting for response 4643. transport: Match on response in pldm_transport_send_recv_msg() 4654. requester: Add check before accessing hdr in pldm_recv() 4665. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 467