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. dsp: firmware_update: Iterators for downstream device descriptors 232. platform: add PLDM Command numbers 243. base: add PLDM Command numbers 25 26### Changed 27 281. Register assignment for parameters of `encode_state_effecter_pdr()` 29 302. dsp: firmware_update: Iterators for downstream device descriptors 31 32 The prototype for `decode_query_downstream_identifiers_resp()` was updated to 33 improve ergonomics for the iterator APIs. 34 353. meson: Specify OEM extensions in an array 36 37 `include/libpldm/meson.build` is modified, but not in ways that are 38 significant. 39 404. Return `ENOENT` rather than `ENOKEY` from 41 `pldm_pdr_find_child_container_id_index_range_exclude()` 42 43### Fixed 44 451. dsp: platform: Fix location of closing paren in overflow detection 462. libpldm: Install api header, update changelog 47 48## [0.10.0] 2024-11-01 49 50### Added 51 521. oem: meta: Add decode_oem_meta_file_io_write_req() 532. oem: meta: Add decode_oem_meta_file_io_read_req() 543. oem: meta: Add encode_oem_meta_file_io_read_resp() 554. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 565. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 576. pldm_entity_association_tree_copy_root_check() 587. oem: ibm: Add topology related state set and enum 59 608. base: Add size and buffer macros for struct pldm_msg 61 62 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 63 649. entity: Add new entity types from DSP0249 v1.3.0 6510. stateset: Add new state sets from DSP0249 v1.3.0 66 67### Changed 68 691. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 70 71 pldm_bios_table_iter_is_end() now returns true if the provided argument is 72 NULL. 73 742. Register assignment for parameters of a number of APIs changed with increased 75 scrutiny on their implementations. 76 77 - `decode_entity_auxiliary_names_pdr()` 78 - `decode_get_state_sensor_readings_resp()` 79 - `decode_oem_meta_file_io_req()` 80 - `decode_platform_event_message_req()` 81 - `decode_platform_event_message_resp()` 82 - `decode_sensor_op_data()` 83 - `encode_get_state_effecter_states_resp()` 84 - `encode_state_effecter_pdr()` 85 - `encode_state_sensor_pdr()` 86 - `pldm_bios_table_append_pad_checksum()` 87 - `pldm_bios_table_attr_value_entry_encode_enum()` 88 - `pldm_bios_table_attr_value_entry_encode_string()` 89 - `pldm_pdr_find_record()` 90 - `pldm_pdr_get_next_record()` 91 923. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 93 944. dsp: firmware_update: Bounds check 95 decode_downstream_device_parameter_table_entry_versions() 96 97 The additional bounds-checking required the addition of further length 98 parameters. 99 100### Deprecated 101 1021. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 103 104 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 105 function to make it safer. 106 107 Modification: 108 109 - The meaning of the returned result. 110 - Change parameters from individual pointers to a struct. 111 - Check the length provided in the message won't exceed the buffer. 112 1132. pldm_entity_association_tree_copy_root() 114 115 The implementation allocates, but gives no indication to the caller if an 116 allocation (and hence the copy) has failed. Users should migrate to 117 pldm_entity_association_tree_copy_root_check(). 118 1193. The following APIs are deprecated as unsafe due to various unfixable CWE 120 violations: 121 122 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 123 124 - `encode_get_bios_current_value_by_handle_resp()` 125 - `encode_get_bios_table_resp()` 126 - `encode_get_file_table_resp()` 127 - `encode_get_version_resp()` 128 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 129 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 130 - `pldm_bios_table_attr_find_by_handle()` 131 - `pldm_bios_table_attr_find_by_string_handle()` 132 - `pldm_bios_table_attr_value_find_by_handle()` 133 - `pldm_bios_table_iter_create()` 134 - `pldm_bios_table_iter_is_end()` 135 - `pldm_bios_table_string_find_by_handle()` 136 - `pldm_bios_table_string_find_by_string()` 137 138 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 139 140 - `pldm_entity_association_tree_copy_root()` 141 142 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 143 144 - `decode_oem_meta_file_io_req()` 145 146 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 147 - `encode_fru_record()` 148 - `encode_get_pdr_resp()` 149 - `pldm_bios_table_attr_entry_enum_encode_length()` 150 151### Removed 152 1531. Deprecated functions with the `_check` suffix 154 155 - `get_fru_record_by_option_check()` 156 - `pldm_bios_table_append_pad_checksum_check()` 157 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 158 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 159 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 160 - `pldm_bios_table_attr_entry_enum_encode_check()` 161 - `pldm_bios_table_attr_entry_integer_encode_check()` 162 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 163 - `pldm_bios_table_attr_entry_string_encode_check()` 164 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 165 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 166 - `pldm_bios_table_attr_value_entry_encode_string_check()` 167 - `pldm_bios_table_string_entry_decode_string_check()` 168 - `pldm_bios_table_string_entry_encode_check()` 169 - `pldm_entity_association_pdr_add_check()` 170 - `pldm_entity_association_pdr_add_from_node_check()` 171 - `pldm_pdr_add_check()` 172 - `pldm_pdr_add_fru_record_set_check()` 173 174### Fixed 175 1761. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 177 178 Avoid a caller-controlled NULL pointer dereference in the library 179 implementation. 180 1812. platform: fix encode/decode_poll_for_platform_event_message_req 182 183 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 184 follow spec. 185 1863. platform: Fix checking `eventIDToAcknowledge` 187 188 As the event receiver sends `PollForPlatformEventMessage` with the 189 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 190 should be the previously retrieved eventID (from the PLDM terminus). 191 1924. dsp: platform: Prevent overflow of arithmetic on event_data_length 1935. dsp: platform: Bounds check encode_sensor_state_pdr() 1946. dsp: platform: Bounds check encode_state_effecter_pdr() 1957. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1968. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1979. dsp: bios_table: Bounds check 198 pldm_bios_table_attr_value_entry_encode_string() 19910. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 20011. dsp: firmware_update: Bounds check 201 decode_downstream_device_parameter_table_entry_versions() 20212. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 20313. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 20414. dsp: fru: Bounds check encode_fru_record() 20515. dsp: bios: Bounds check encode_set_bios_table_req() 20616. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 20717. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 20818. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 20919. dsp: platform: Fix decode_set_event_receiver_req() 210 211## [0.9.1] - 2024-09-07 212 213### Changed 214 2151. Moved evolutions intended for v0.9.0 into place 216 217 Evolutions for the release have been moved from `evolutions/current` to 218 `evolutions/v0.9.1`. Library users can apply them to migrate off of 219 deprecated APIs. 220 221## [0.9.0] - 2024-09-07 222 223### Added 224 2251. base: Define macros for reserved TIDs 2262. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 2273. pdr: Add pldm_entity_association_pdr_create_new() 2284. platform: Define macros for the responded transferflags 2295. pdr: Add pldm_pdr_get_terminus_handle() API 2306. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2317. fw_update: Add encode req & decode resp for get_downstream_fw_params 2328. platform: Add decode_pldm_platform_cper_event() API 2339. decode_get_pdr_repository_info_resp_safe() 234 235 Replaces decode_get_pdr_repository_info_resp() as discussed in the 236 `Deprecated` section below 237 23810. decode_get_pdr_resp_safe() 239 240 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 241 below 242 243### Changed 244 2451. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2462. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2473. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2484. ABI break for decode_sensor_op_data() 249 250 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 251 abi-compliance-checker to flag a change in the register containing the 252 parameter `previous_op_state`. 253 2545. platform: Stabilise decode_pldm_platform_cper_event() API 2556. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2567. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2578. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 258 259### Deprecated 260 2611. Rename and deprecate functions with the `_check` suffix 262 263 All library function return values always need to be checked. The `_check` 264 suffix is redundant, so remove it. Migration to the non-deprecated 265 equivalents without the `_check` suffix can be performed using 266 `scripts/ apply-renames` and the [clang-rename][] configurations under 267 `evolutions/` 268 269 The deprecated functions: 270 271 - `get_fru_record_by_option_check()` 272 - `pldm_bios_table_append_pad_checksum_check()` 273 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 274 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 275 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 276 - `pldm_bios_table_attr_entry_enum_encode_check()` 277 - `pldm_bios_table_attr_entry_integer_encode_check()` 278 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 279 - `pldm_bios_table_attr_entry_string_encode_check()` 280 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 281 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 282 - `pldm_bios_table_attr_value_entry_encode_string_check()` 283 - `pldm_bios_table_string_entry_decode_string_check()` 284 - `pldm_bios_table_string_entry_encode_check()` 285 - `pldm_entity_association_pdr_add_check()` 286 - `pldm_entity_association_pdr_add_from_node_check()` 287 - `pldm_pdr_add_check()` 288 - `pldm_pdr_add_fru_record_set_check()` 289 290[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 291 2922. `decode_get_pdr_repository_info_resp()` 293 294 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 295 eliminates the opportunity for buffer overruns when extracting objects from 296 the message. 297 2983. `decode_get_pdr_resp()` 299 300 Users should move to `decode_get_pdr_resp_safe()` which reduces the 301 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 302 303### Removed 304 3051. IBM OEM header compatibility symlinks. 306 307 Anyone left using the deprecated paths can migrate using the coccinelle patch 308 at `evolutions/current/oem-ibm-header-compat.cocci`. 309 310### Fixed 311 3121. requester: instance-id: Release read lock on conflict 3132. pdr: Error propagation for 314 pldm_entity_association_pdr_add_from_node_with_record_handle() 315 316## [0.8.0] - 2024-05-23 317 318### Added 319 3201. base: Provide pldm_msg_hdr_correlate_response() 3212. transport: af-mctp: Add pldm_transport_af_mctp_bind() 3223. oem: ibm: Add chapdata file type support 3234. base: Added PLDM_SMBIOS & PLDM_RDE message types 3245. oem: meta: Add decode_oem_meta_file_io_req() 3256. state-set: Add all state set values to system power state enum as per DSP0249 3267. platform: Add alias members to the enum 327 pldm_pdr_repository_chg_event_change_record_event_data_operation. 328 329 enum constants with inconsistent names are deprecated with this change. 330 remove old inconsistent enum members after backward compatibility cleanup is 331 done 332 3338. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3349. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 33510. platform: Add 3 PDR type enum for Redfish Device Enablement per 336 DSP0248_1.2.0 33711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 33812. entity: Add enum for Network Interface Connectors and Network Ports 339 Connection Types 34013. pdr: Add decode_numeric_effecter_pdr_data() 34114. oem: ibm: Support for the Real SAI entity id 34215. fw_update: Add encode req & decode resp for query_downstream_devices 34316. fw_update: Add encode req & decode resp for query_downstream_identifiers 34417. platform: Add support for GetStateEffecterStates command 345 346### Changed 347 3481. base: Stabilise pldm_msg_hdr_correlate_response() 3492. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3503. libpldm: Fix header use 3514. libpldm: More fixes for header use 3525. pdr: Stabilise pldm_pdr_find_last_in_range() API 3536. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3547. oem: meta: stabilise decode_oem_meta_file_io_req() 3558. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 356 357### Deprecated 358 3591. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 360 with `PLDM_OEM_IBM_` 361 362### Fixed 363 3641. libpldm: Rationalise the local and installed path of pldm.h 3652. pdr: Assign record_handle in entity_association_pdr_add_children() 3663. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3674. pdr: Remove redundant constant for minimum numeric sensor PDR length 3685. tests: oem: meta: Fix fileio use of msgbuf 369 370## [0.7.0] - 2023-08-29 371 372### Added 373 3741. state-set: Add new enum for Operational Fault Status enum 375 376### Changed 377 3781. transport: Match specified metadata in pldm_transport_send_recv_msg() 3792. transport: mctp-demux: Drop ABI annotation for internal symbols 3803. transport: Stabilise core transport and implementation APIs 381 382 This stabilisation covers the following headers and functions: 383 384 - libpldm/transport.h 385 386 - pldm_transport_poll() 387 - pldm_transport_send_msg() 388 - pldm_transport_recv_msg() 389 - pldm_transport_send_recv_msg() 390 391 - libpldm/transport/af-mctp.h 392 393 - pldm_transport_af_mctp_init() 394 - pldm_transport_af_mctp_destroy() 395 - pldm_transport_af_mctp_core() 396 - pldm_transport_af_mctp_init_pollfd() 397 - pldm_transport_af_mctp_map_tid() 398 - pldm_transport_af_mctp_unmap_tid() 399 400 - libpldm/transport/mctp-demux.h 401 - pldm_transport_mctp_demux_init() 402 - pldm_transport_mctp_demux_destroy() 403 - pldm_transport_mctp_demux_core() 404 - pldm_transport_mctp_demux_init_pollfd() 405 - pldm_transport_mctp_demux_map_tid() 406 - pldm_transport_mctp_demux_unmap_tid() 407 408### Deprecated 409 4101. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 411 `libpldm/requester/pldm.h`): 412 413 - pldm_open() 414 - pldm_send_recv() 415 - pldm_send() 416 - pldm_recv() 417 - pldm_recv_any() 418 - pldm_close() 419 420 Users should migrate to the newer "transport" APIs instead. 421 422## Fixed 423 4241. tests: Exclude transport tests when build excludes testing ABIs 4252. abi: Capture deprecation of pldm_close() 426 427## [0.6.0] - 2023-08-22 428 429### Changed 430 4311. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4322. meson: Apply `b_ndebug=if-release` by default 4333. pdr : Stabilize pldm_entity_association_tree_add_entity() 4344. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4355. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4366. transport: af-mctp: Assign out-params on success in \*\_recv() 4377. transport: Generalise the pldm_transport_recv_msg() API 438 439### Removed 440 4411. pdr: Remove pldm_entity_association_pdr_add() 4422. state-set: Remove enum pldm_state_set_operational_fault_status_values 443 444### Fixed 445 4461. transport: register init_pollfd callback for af-mctp 4472. transport: fix init_pollfd function parameter 4483. transport: Fix doxygen and variables for send and recv functions 4494. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 450 451## [0.5.0] - 2023-08-09 452 453### Added 454 4551. pdr: Introduce pldm_entity_association_pdr_add_check() 456 457### Changed 458 4591. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4602. transport: pldm_transport_poll(): Adjust return value semantics 4613. transport: free un-wanted responses in pldm_transport_send_recv_msg() 462 463### Deprecated 464 4651. state-set: Enum pldm_state_set_operational_fault_status_values 466 467 The enum operational_fault_status is defined with wrong members and will 468 eventually be replaced with the correct members. Any uses of 469 pldm_state_set_operational_fault_status_values members should move to 470 equivalent pldm_state_set_operational_stress_status_values members if needed. 471 4722. platform: Struct field name in fru_record_set PDR 473 474 References to entity_instance_num should be changed to entity_instance 475 4763. platform: Struct field name in numeric sensor value PDR 477 478 References to entity_instance_num should be changed to entity_instance 479 480### Removed 481 4821. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4832. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4843. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4854. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4865. bios_table: Remove pldm_bios_table_append_pad_checksum() 4876. fru: Remove get_fru_record_by_option() 4887. pdr: Make is_present() static 4898. pdr: Remove pldm_pdr_add() 4909. pdr: Remove pldm_pdr_add_fru_record_set() 49110. pdr: Remove pldm_entity_association_pdr_add_from_node() 49211. pdr: Make find_entity_ref_in_tree() static 49312. pdr: Make entity_association_tree_find() static 494 495### Fixed 496 4971. requester: Fix response buffer cast in pldm_send_recv() 4982. pdr: Hoist record handle overflow test to avoid memory leak 4993. transport: Correct comparison in while loop condition 500 501## [0.4.0] - 2023-07-14 502 503### Added 504 5051. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 5062. fru: Introduce get_fru_record_by_option_check() 5073. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 5084. pdr: Introduce pldm_pdr_add_check() 5095. pdr: Introduce pldm_pdr_add_fru_record_set_check() 510 511### Changed 512 5131. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 5142. requester: Expose pldm_close() in header 5153. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 5164. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 5175. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 5186. pdr: pldm_pdr_init(): Return NULL on allocation failure 5197. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 5208. pdr: Document preconditions for trivial accessor functions 521 522 A trivial accessor function is one that exposes properties of an object in a 523 way can't result in an error, beyond passing an invalid argument to the 524 function. For APIs meeting this definition we define a precondition that 525 struct pointers must point to valid objects to avoid polluting the function 526 prototypes. The following APIs now have this precondition explicitly defined: 527 528 - pldm_entity_extract() 529 - pldm_entity_get_parent() 530 - pldm_entity_is_exist_parent() 531 - pldm_entity_is_node_parent() 532 - pldm_is_current_parent_child 533 - pldm_is_empty_entity_assoc_tree() 534 - pldm_pdr_get_record_count() 535 - pldm_pdr_get_record_handle() 536 - pldm_pdr_get_repo_size() 537 - pldm_pdr_record_is_remote() 538 5399. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 54010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 54111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 54212. pdr: pldm_entity_association_tree_visit(): Document preconditions 54313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 54414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 54515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 54616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 54717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 54818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 54919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 55020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 55121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 55222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 55323. pdr: pldm_entity_get_num_children(): Don't return invalid values 55424. libpldm: Lift or remove asserts where a subsequent check exists 555 556### Deprecated 557 5581. pldm_bios_table_attr_entry_integer_encode() 559 560 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 561 5622. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 563 564 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 565 5663. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 567 568 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 569 5704. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 571 572 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 573 5745. pdr: Deprecate is_present() 575 576 There should be no users of this symbol. If you are a user, you should figure 577 out how to stop, or get in touch. This symbol will be marked static the 578 release after deprecation. 579 5806. pdr: Deprecate find_entity_ref_in_tree() 581 582 There should be no users of this symbol. If you are a user, you should figure 583 out how to stop, or get in touch. This symbol will be marked static the 584 release after deprecation. 585 5867. pdr: Deprecate entity_association_tree_find() 587 588 There should be no users of this symbol. If you are a user, you should figure 589 out how to stop, or get in touch. This symbol will be marked static the 590 release after deprecation. 591 5928. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 593 594 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 595 pldm_bios_table_append_pad_checksum() should migrate to 596 pldm_bios_table_append_pad_checksum_check() 597 5989. fru: Stabilise get_fru_record_by_option_check() 599 600 get_fru_record_by_option() is deprecated by this change. Users of 601 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 602 60310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 604 605 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 606 Users of pldm_entity_association_pdr_add_from_node() should migrate to 607 pldm_entity_association_pdr_add_from_node_check() 608 60911. pdr: Stabilise pldm_pdr_add_check() 610 611 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 612 migrate to pldm_pdr_add_check() 613 61412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 615 616 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 617 pldm_pdr_add_fru_record_set() should migrate to 618 pldm_pdr_add_fru_record_set_check() 619 620### Removed 621 6221. bios_table: Remove deprecated APIs sanitized by assert(): 623 624 - pldm_bios_table_string_entry_encode() 625 - pldm_bios_table_string_entry_decode_string() 626 - pldm_bios_table_attr_entry_enum_encode() 627 - pldm_bios_table_attr_entry_enum_decode_pv_num() 628 - pldm_bios_table_attr_entry_enum_decode_def_num() 629 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 630 - pldm_bios_table_attr_entry_string_encode() 631 - pldm_bios_table_attr_entry_string_decode_def_string_length() 632 633### Fixed 634 6351. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6362. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6373. transport: mctp-demux: Don't test socket for non-zero value 6384. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6395. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6406. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6417. abi: Update to remove pldm_close() from reference dumps 6428. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 643 644## [0.3.0] - 2023-06-23 645 646### Added 647 6481. Add encode/decode pldmMessagePollEvent data 6492. README: Add a section on working with libpldm 6503. pdr: Introduce remote_container_id and associated APIs 6514. pdr: Add APIs for creating and locating remote PDRs 6525. pdr: Add pldm_pdr_find_last_in_range() 6536. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6547. pdr: Add pldm_pdr_find_container_id_range_exclude() 655 656### Changed 657 6581. include: Move installed transport.h under libpldm/ 6592. libpldm: Explicit deprecated, stable and testing ABI classes 6603. meson: Reduce strength of oem-ibm requirements from enabled to allowed 661 662 The `oem-ibm` feature is now enabled by the default meson configuration, for 663 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 664 recipe: 665 666 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 667 668 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 669 when invoking `meson setup` 670 6714. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6725. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 673 674### Deprecated 675 6761. bios_table: Deprecate APIs with arguments sanitized using assert() 677 678 C provides enough foot-guns without us encoding them into library APIs. 679 Specifically, deprecate the following in favour of their `*_check()` variants 680 which ensure assertions won't fail or otherwise invoke UB: 681 682 - pldm_bios_table_string_entry_encode() 683 - pldm_bios_table_string_entry_decode_string() 684 - pldm_bios_table_attr_entry_enum_encode() 685 - pldm_bios_table_attr_entry_enum_decode_pv_num() 686 - pldm_bios_table_attr_entry_enum_decode_def_num() 687 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 688 - pldm_bios_table_attr_entry_string_encode() 689 - pldm_bios_table_attr_entry_string_decode_def_string_length() 690 691### Removed 692 6931. libpldm: Remove the requester-api option 694 695### Fixed 696 6971. requester: Make pldm_open() return existing fd 6982. transport: Prevent sticking in waiting for response 6993. transport: Match on response in pldm_transport_send_recv_msg() 7004. requester: Add check before accessing hdr in pldm_recv() 7015. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 702