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. oem: meta: Add decode_oem_meta_file_io_write_req() 232. oem: meta: Add decode_oem_meta_file_io_read_req() 243. oem: meta: Add encode_oem_meta_file_io_read_resp() 254. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 265. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 276. pldm_entity_association_tree_copy_root_check() 287. oem: ibm: Add topology related state set and enum 29 308. base: Add size and buffer macros for struct pldm_msg 31 32 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 33 34### Changed 35 361. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 37 38 pldm_bios_table_iter_is_end() now returns true if the provided argument is 39 NULL. 40 412. Register assignment for parameters of a number of APIs changed with increased 42 scrutiny on their implementations. 43 44 - `decode_entity_auxiliary_names_pdr()` 45 - `decode_get_state_sensor_readings_resp()` 46 - `decode_platform_event_message_req()` 47 - `decode_platform_event_message_resp()` 48 - `decode_sensor_op_data()` 49 - `encode_get_state_effecter_states_resp()` 50 - `encode_state_effecter_pdr()` 51 - `encode_state_sensor_pdr()` 52 - `pldm_bios_table_append_pad_checksum()` 53 - `pldm_bios_table_attr_value_entry_encode_enum()` 54 - `pldm_bios_table_attr_value_entry_encode_string()` 55 - `pldm_pdr_find_record()` 56 - `pldm_pdr_get_next_record()` 57 583. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 59 604. dsp: firmware_update: Bounds check 61 decode_downstream_device_parameter_table_entry_versions() 62 63 The additional bounds-checking required the addition of further length 64 parameters. 65 66### Deprecated 67 681. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 69 70 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 71 function to make it safer. 72 73 Modification: 74 75 - The meaning of the returned result. 76 - Change parameters from individual pointers to a struct. 77 - Check the length provided in the message won't exceed the buffer. 78 792. pldm_entity_association_tree_copy_root() 80 81 The implementation allocates, but gives no indication to the caller if an 82 allocation (and hence the copy) has failed. Users should migrate to 83 pldm_entity_association_tree_copy_root_check(). 84 85### Removed 86 871. Deprecated functions with the `_check` suffix 88 89 - `get_fru_record_by_option_check()` 90 - `pldm_bios_table_append_pad_checksum_check()` 91 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 92 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 93 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 94 - `pldm_bios_table_attr_entry_enum_encode_check()` 95 - `pldm_bios_table_attr_entry_integer_encode_check()` 96 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 97 - `pldm_bios_table_attr_entry_string_encode_check()` 98 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 99 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 100 - `pldm_bios_table_attr_value_entry_encode_string_check()` 101 - `pldm_bios_table_string_entry_decode_string_check()` 102 - `pldm_bios_table_string_entry_encode_check()` 103 - `pldm_entity_association_pdr_add_check()` 104 - `pldm_entity_association_pdr_add_from_node_check()` 105 - `pldm_pdr_add_check()` 106 - `pldm_pdr_add_fru_record_set_check()` 107 108### Fixed 109 1101. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 111 112 Avoid a caller-controlled NULL pointer dereference in the library 113 implementation. 114 1152. platform: fix encode/decode_poll_for_platform_event_message_req 116 117 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 118 follow spec. 119 1203. platform: Fix checking `eventIDToAcknowledge` 121 122 As the event receiver sends `PollForPlatformEventMessage` with the 123 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 124 should be the previously retrieved eventID (from the PLDM terminus). 125 1264. dsp: platform: Prevent overflow of arithmetic on event_data_length 1275. dsp: platform: Bounds check encode_sensor_state_pdr() 1286. dsp: platform: Bounds check encode_state_effecter_pdr() 1297. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1308. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1319. dsp: bios_table: Bounds check 132 pldm_bios_table_attr_value_entry_encode_string() 13310. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 13411. dsp: firmware_update: Bounds check 135 decode_downstream_device_parameter_table_entry_versions() 13612. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 13713. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 13814. dsp: fru: Bounds check encode_fru_record() 13915. dsp: bios: Bounds check encode_set_bios_table_req() 14016. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 14117. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 142 143## [0.9.1] - 2024-09-07 144 145### Changed 146 1471. Moved evolutions intended for v0.9.0 into place 148 149 Evolutions for the release have been moved from `evolutions/current` to 150 `evolutions/v0.9.1`. Library users can apply them to migrate off of 151 deprecated APIs. 152 153## [0.9.0] - 2024-09-07 154 155### Added 156 1571. base: Define macros for reserved TIDs 1582. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1593. pdr: Add pldm_entity_association_pdr_create_new() 1604. platform: Define macros for the responded transferflags 1615. pdr: Add pldm_pdr_get_terminus_handle() API 1626. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 1637. fw_update: Add encode req & decode resp for get_downstream_fw_params 1648. platform: Add decode_pldm_platform_cper_event() API 1659. decode_get_pdr_repository_info_resp_safe() 166 167 Replaces decode_get_pdr_repository_info_resp() as discussed in the 168 `Deprecated` section below 169 17010. decode_get_pdr_resp_safe() 171 172 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 173 below 174 175### Changed 176 1771. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 1782. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 1793. platform: Stabilise decode_pldm_message_poll_event_data() APIs 1804. ABI break for decode_sensor_op_data() 181 182 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 183 abi-compliance-checker to flag a change in the register containing the 184 parameter `previous_op_state`. 185 1865. platform: Stabilise decode_pldm_platform_cper_event() API 1876. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 1887. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 1898. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 190 191### Deprecated 192 1931. Rename and deprecate functions with the `_check` suffix 194 195 All library function return values always need to be checked. The `_check` 196 suffix is redundant, so remove it. Migration to the non-deprecated 197 equivalents without the `_check` suffix can be performed using 198 `scripts/ apply-renames` and the [clang-rename][] configurations under 199 `evolutions/` 200 201 The deprecated functions: 202 203 - `get_fru_record_by_option_check()` 204 - `pldm_bios_table_append_pad_checksum_check()` 205 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 206 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 207 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 208 - `pldm_bios_table_attr_entry_enum_encode_check()` 209 - `pldm_bios_table_attr_entry_integer_encode_check()` 210 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 211 - `pldm_bios_table_attr_entry_string_encode_check()` 212 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 213 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 214 - `pldm_bios_table_attr_value_entry_encode_string_check()` 215 - `pldm_bios_table_string_entry_decode_string_check()` 216 - `pldm_bios_table_string_entry_encode_check()` 217 - `pldm_entity_association_pdr_add_check()` 218 - `pldm_entity_association_pdr_add_from_node_check()` 219 - `pldm_pdr_add_check()` 220 - `pldm_pdr_add_fru_record_set_check()` 221 222[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 223 2242. `decode_get_pdr_repository_info_resp()` 225 226 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 227 eliminates the opportunity for buffer overruns when extracting objects from 228 the message. 229 2303. `decode_get_pdr_resp()` 231 232 Users should move to `decode_get_pdr_resp_safe()` which reduces the 233 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 234 235### Removed 236 2371. IBM OEM header compatibility symlinks. 238 239 Anyone left using the deprecated paths can migrate using the coccinelle patch 240 at `evolutions/current/oem-ibm-header-compat.cocci`. 241 242### Fixed 243 2441. requester: instance-id: Release read lock on conflict 2452. pdr: Error propagation for 246 pldm_entity_association_pdr_add_from_node_with_record_handle() 247 248## [0.8.0] - 2024-05-23 249 250### Added 251 2521. base: Provide pldm_msg_hdr_correlate_response() 2532. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2543. oem: ibm: Add chapdata file type support 2554. base: Added PLDM_SMBIOS & PLDM_RDE message types 2565. oem: meta: Add decode_oem_meta_file_io_req() 2576. state-set: Add all state set values to system power state enum as per DSP0249 2587. platform: Add alias members to the enum 259 pldm_pdr_repository_chg_event_change_record_event_data_operation. 260 261 enum constants with inconsistent names are deprecated with this change. 262 remove old inconsistent enum members after backward compatibility cleanup is 263 done 264 2658. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 2669. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 26710. platform: Add 3 PDR type enum for Redfish Device Enablement per 268 DSP0248_1.2.0 26911. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 27012. entity: Add enum for Network Interface Connectors and Network Ports 271 Connection Types 27213. pdr: Add decode_numeric_effecter_pdr_data() 27314. oem: ibm: Support for the Real SAI entity id 27415. fw_update: Add encode req & decode resp for query_downstream_devices 27516. fw_update: Add encode req & decode resp for query_downstream_identifiers 27617. platform: Add support for GetStateEffecterStates command 277 278### Changed 279 2801. base: Stabilise pldm_msg_hdr_correlate_response() 2812. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 2823. libpldm: Fix header use 2834. libpldm: More fixes for header use 2845. pdr: Stabilise pldm_pdr_find_last_in_range() API 2856. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 2867. oem: meta: stabilise decode_oem_meta_file_io_req() 2878. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 288 289### Deprecated 290 2911. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 292 with `PLDM_OEM_IBM_` 293 294### Fixed 295 2961. libpldm: Rationalise the local and installed path of pldm.h 2972. pdr: Assign record_handle in entity_association_pdr_add_children() 2983. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 2994. pdr: Remove redundant constant for minimum numeric sensor PDR length 3005. tests: oem: meta: Fix fileio use of msgbuf 301 302## [0.7.0] - 2023-08-29 303 304### Added 305 3061. state-set: Add new enum for Operational Fault Status enum 307 308### Changed 309 3101. transport: Match specified metadata in pldm_transport_send_recv_msg() 3112. transport: mctp-demux: Drop ABI annotation for internal symbols 3123. transport: Stabilise core transport and implementation APIs 313 314 This stabilisation covers the following headers and functions: 315 316 - libpldm/transport.h 317 318 - pldm_transport_poll() 319 - pldm_transport_send_msg() 320 - pldm_transport_recv_msg() 321 - pldm_transport_send_recv_msg() 322 323 - libpldm/transport/af-mctp.h 324 325 - pldm_transport_af_mctp_init() 326 - pldm_transport_af_mctp_destroy() 327 - pldm_transport_af_mctp_core() 328 - pldm_transport_af_mctp_init_pollfd() 329 - pldm_transport_af_mctp_map_tid() 330 - pldm_transport_af_mctp_unmap_tid() 331 332 - libpldm/transport/mctp-demux.h 333 - pldm_transport_mctp_demux_init() 334 - pldm_transport_mctp_demux_destroy() 335 - pldm_transport_mctp_demux_core() 336 - pldm_transport_mctp_demux_init_pollfd() 337 - pldm_transport_mctp_demux_map_tid() 338 - pldm_transport_mctp_demux_unmap_tid() 339 340### Deprecated 341 3421. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 343 `libpldm/requester/pldm.h`): 344 345 - pldm_open() 346 - pldm_send_recv() 347 - pldm_send() 348 - pldm_recv() 349 - pldm_recv_any() 350 - pldm_close() 351 352 Users should migrate to the newer "transport" APIs instead. 353 354## Fixed 355 3561. tests: Exclude transport tests when build excludes testing ABIs 3572. abi: Capture deprecation of pldm_close() 358 359## [0.6.0] - 2023-08-22 360 361### Changed 362 3631. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 3642. meson: Apply `b_ndebug=if-release` by default 3653. pdr : Stabilize pldm_entity_association_tree_add_entity() 3664. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 3675. pdr: Stabilize pldm_entity_node_get_remote_container_id() 3686. transport: af-mctp: Assign out-params on success in \*\_recv() 3697. transport: Generalise the pldm_transport_recv_msg() API 370 371### Removed 372 3731. pdr: Remove pldm_entity_association_pdr_add() 3742. state-set: Remove enum pldm_state_set_operational_fault_status_values 375 376### Fixed 377 3781. transport: register init_pollfd callback for af-mctp 3792. transport: fix init_pollfd function parameter 3803. transport: Fix doxygen and variables for send and recv functions 3814. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 382 383## [0.5.0] - 2023-08-09 384 385### Added 386 3871. pdr: Introduce pldm_entity_association_pdr_add_check() 388 389### Changed 390 3911. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 3922. transport: pldm_transport_poll(): Adjust return value semantics 3933. transport: free un-wanted responses in pldm_transport_send_recv_msg() 394 395### Deprecated 396 3971. state-set: Enum pldm_state_set_operational_fault_status_values 398 399 The enum operational_fault_status is defined with wrong members and will 400 eventually be replaced with the correct members. Any uses of 401 pldm_state_set_operational_fault_status_values members should move to 402 equivalent pldm_state_set_operational_stress_status_values members if needed. 403 4042. platform: Struct field name in fru_record_set PDR 405 406 References to entity_instance_num should be changed to entity_instance 407 4083. platform: Struct field name in numeric sensor value PDR 409 410 References to entity_instance_num should be changed to entity_instance 411 412### Removed 413 4141. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4152. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4163. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4174. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4185. bios_table: Remove pldm_bios_table_append_pad_checksum() 4196. fru: Remove get_fru_record_by_option() 4207. pdr: Make is_present() static 4218. pdr: Remove pldm_pdr_add() 4229. pdr: Remove pldm_pdr_add_fru_record_set() 42310. pdr: Remove pldm_entity_association_pdr_add_from_node() 42411. pdr: Make find_entity_ref_in_tree() static 42512. pdr: Make entity_association_tree_find() static 426 427### Fixed 428 4291. requester: Fix response buffer cast in pldm_send_recv() 4302. pdr: Hoist record handle overflow test to avoid memory leak 4313. transport: Correct comparison in while loop condition 432 433## [0.4.0] - 2023-07-14 434 435### Added 436 4371. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4382. fru: Introduce get_fru_record_by_option_check() 4393. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4404. pdr: Introduce pldm_pdr_add_check() 4415. pdr: Introduce pldm_pdr_add_fru_record_set_check() 442 443### Changed 444 4451. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4462. requester: Expose pldm_close() in header 4473. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4484. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4495. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4506. pdr: pldm_pdr_init(): Return NULL on allocation failure 4517. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4528. pdr: Document preconditions for trivial accessor functions 453 454 A trivial accessor function is one that exposes properties of an object in a 455 way can't result in an error, beyond passing an invalid argument to the 456 function. For APIs meeting this definition we define a precondition that 457 struct pointers must point to valid objects to avoid polluting the function 458 prototypes. The following APIs now have this precondition explicitly defined: 459 460 - pldm_entity_extract() 461 - pldm_entity_get_parent() 462 - pldm_entity_is_exist_parent() 463 - pldm_entity_is_node_parent() 464 - pldm_is_current_parent_child 465 - pldm_is_empty_entity_assoc_tree() 466 - pldm_pdr_get_record_count() 467 - pldm_pdr_get_record_handle() 468 - pldm_pdr_get_repo_size() 469 - pldm_pdr_record_is_remote() 470 4719. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 47210. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 47311. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 47412. pdr: pldm_entity_association_tree_visit(): Document preconditions 47513. pdr: pldm_entity_association_tree_visit(): Exit early on failure 47614. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 47715. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 47816. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 47917. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 48018. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 48119. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 48220. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 48321. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 48422. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 48523. pdr: pldm_entity_get_num_children(): Don't return invalid values 48624. libpldm: Lift or remove asserts where a subsequent check exists 487 488### Deprecated 489 4901. pldm_bios_table_attr_entry_integer_encode() 491 492 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 493 4942. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 495 496 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 497 4983. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 499 500 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 501 5024. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 503 504 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 505 5065. pdr: Deprecate is_present() 507 508 There should be no users of this symbol. If you are a user, you should figure 509 out how to stop, or get in touch. This symbol will be marked static the 510 release after deprecation. 511 5126. pdr: Deprecate find_entity_ref_in_tree() 513 514 There should be no users of this symbol. If you are a user, you should figure 515 out how to stop, or get in touch. This symbol will be marked static the 516 release after deprecation. 517 5187. pdr: Deprecate entity_association_tree_find() 519 520 There should be no users of this symbol. If you are a user, you should figure 521 out how to stop, or get in touch. This symbol will be marked static the 522 release after deprecation. 523 5248. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 525 526 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 527 pldm_bios_table_append_pad_checksum() should migrate to 528 pldm_bios_table_append_pad_checksum_check() 529 5309. fru: Stabilise get_fru_record_by_option_check() 531 532 get_fru_record_by_option() is deprecated by this change. Users of 533 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 534 53510. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 536 537 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 538 Users of pldm_entity_association_pdr_add_from_node() should migrate to 539 pldm_entity_association_pdr_add_from_node_check() 540 54111. pdr: Stabilise pldm_pdr_add_check() 542 543 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 544 migrate to pldm_pdr_add_check() 545 54612. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 547 548 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 549 pldm_pdr_add_fru_record_set() should migrate to 550 pldm_pdr_add_fru_record_set_check() 551 552### Removed 553 5541. bios_table: Remove deprecated APIs sanitized by assert(): 555 556 - pldm_bios_table_string_entry_encode() 557 - pldm_bios_table_string_entry_decode_string() 558 - pldm_bios_table_attr_entry_enum_encode() 559 - pldm_bios_table_attr_entry_enum_decode_pv_num() 560 - pldm_bios_table_attr_entry_enum_decode_def_num() 561 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 562 - pldm_bios_table_attr_entry_string_encode() 563 - pldm_bios_table_attr_entry_string_decode_def_string_length() 564 565### Fixed 566 5671. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 5682. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 5693. transport: mctp-demux: Don't test socket for non-zero value 5704. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 5715. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 5726. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 5737. abi: Update to remove pldm_close() from reference dumps 5748. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 575 576## [0.3.0] - 2023-06-23 577 578### Added 579 5801. Add encode/decode pldmMessagePollEvent data 5812. README: Add a section on working with libpldm 5823. pdr: Introduce remote_container_id and associated APIs 5834. pdr: Add APIs for creating and locating remote PDRs 5845. pdr: Add pldm_pdr_find_last_in_range() 5856. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 5867. pdr: Add pldm_pdr_find_container_id_range_exclude() 587 588### Changed 589 5901. include: Move installed transport.h under libpldm/ 5912. libpldm: Explicit deprecated, stable and testing ABI classes 5923. meson: Reduce strength of oem-ibm requirements from enabled to allowed 593 594 The `oem-ibm` feature is now enabled by the default meson configuration, for 595 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 596 recipe: 597 598 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 599 600 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 601 when invoking `meson setup` 602 6034. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6045. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 605 606### Deprecated 607 6081. bios_table: Deprecate APIs with arguments sanitized using assert() 609 610 C provides enough foot-guns without us encoding them into library APIs. 611 Specifically, deprecate the following in favour of their `*_check()` variants 612 which ensure assertions won't fail or otherwise invoke UB: 613 614 - pldm_bios_table_string_entry_encode() 615 - pldm_bios_table_string_entry_decode_string() 616 - pldm_bios_table_attr_entry_enum_encode() 617 - pldm_bios_table_attr_entry_enum_decode_pv_num() 618 - pldm_bios_table_attr_entry_enum_decode_def_num() 619 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 620 - pldm_bios_table_attr_entry_string_encode() 621 - pldm_bios_table_attr_entry_string_decode_def_string_length() 622 623### Removed 624 6251. libpldm: Remove the requester-api option 626 627### Fixed 628 6291. requester: Make pldm_open() return existing fd 6302. transport: Prevent sticking in waiting for response 6313. transport: Match on response in pldm_transport_send_recv_msg() 6324. requester: Add check before accessing hdr in pldm_recv() 6335. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 634