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_oem_meta_file_io_req()` 47 - `decode_platform_event_message_req()` 48 - `decode_platform_event_message_resp()` 49 - `decode_sensor_op_data()` 50 - `encode_get_state_effecter_states_resp()` 51 - `encode_state_effecter_pdr()` 52 - `encode_state_sensor_pdr()` 53 - `pldm_bios_table_append_pad_checksum()` 54 - `pldm_bios_table_attr_value_entry_encode_enum()` 55 - `pldm_bios_table_attr_value_entry_encode_string()` 56 - `pldm_pdr_find_record()` 57 - `pldm_pdr_get_next_record()` 58 593. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 60 614. dsp: firmware_update: Bounds check 62 decode_downstream_device_parameter_table_entry_versions() 63 64 The additional bounds-checking required the addition of further length 65 parameters. 66 67### Deprecated 68 691. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 70 71 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 72 function to make it safer. 73 74 Modification: 75 76 - The meaning of the returned result. 77 - Change parameters from individual pointers to a struct. 78 - Check the length provided in the message won't exceed the buffer. 79 802. pldm_entity_association_tree_copy_root() 81 82 The implementation allocates, but gives no indication to the caller if an 83 allocation (and hence the copy) has failed. Users should migrate to 84 pldm_entity_association_tree_copy_root_check(). 85 863. The following APIs are deprecated as unsafe due to various unfixable CWE 87 violations: 88 89 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 90 91 - `encode_get_bios_current_value_by_handle_resp()` 92 - `encode_get_bios_table_resp()` 93 - `encode_get_file_table_resp()` 94 - `encode_get_version_resp()` 95 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 96 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 97 - `pldm_bios_table_attr_find_by_handle()` 98 - `pldm_bios_table_attr_find_by_string_handle()` 99 - `pldm_bios_table_attr_value_find_by_handle()` 100 - `pldm_bios_table_iter_create()` 101 - `pldm_bios_table_iter_is_end()` 102 - `pldm_bios_table_string_find_by_handle()` 103 - `pldm_bios_table_string_find_by_string()` 104 105 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 106 107 - `pldm_entity_association_tree_copy_root()` 108 109 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 110 111 - `decode_oem_meta_file_io_req()` 112 113 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 114 - `encode_fru_record()` 115 - `encode_get_pdr_resp()` 116 - `pldm_bios_table_attr_entry_enum_encode_length()` 117 118### Removed 119 1201. Deprecated functions with the `_check` suffix 121 122 - `get_fru_record_by_option_check()` 123 - `pldm_bios_table_append_pad_checksum_check()` 124 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 125 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 126 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 127 - `pldm_bios_table_attr_entry_enum_encode_check()` 128 - `pldm_bios_table_attr_entry_integer_encode_check()` 129 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 130 - `pldm_bios_table_attr_entry_string_encode_check()` 131 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 132 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 133 - `pldm_bios_table_attr_value_entry_encode_string_check()` 134 - `pldm_bios_table_string_entry_decode_string_check()` 135 - `pldm_bios_table_string_entry_encode_check()` 136 - `pldm_entity_association_pdr_add_check()` 137 - `pldm_entity_association_pdr_add_from_node_check()` 138 - `pldm_pdr_add_check()` 139 - `pldm_pdr_add_fru_record_set_check()` 140 141### Fixed 142 1431. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 144 145 Avoid a caller-controlled NULL pointer dereference in the library 146 implementation. 147 1482. platform: fix encode/decode_poll_for_platform_event_message_req 149 150 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 151 follow spec. 152 1533. platform: Fix checking `eventIDToAcknowledge` 154 155 As the event receiver sends `PollForPlatformEventMessage` with the 156 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 157 should be the previously retrieved eventID (from the PLDM terminus). 158 1594. dsp: platform: Prevent overflow of arithmetic on event_data_length 1605. dsp: platform: Bounds check encode_sensor_state_pdr() 1616. dsp: platform: Bounds check encode_state_effecter_pdr() 1627. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1638. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1649. dsp: bios_table: Bounds check 165 pldm_bios_table_attr_value_entry_encode_string() 16610. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 16711. dsp: firmware_update: Bounds check 168 decode_downstream_device_parameter_table_entry_versions() 16912. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 17013. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 17114. dsp: fru: Bounds check encode_fru_record() 17215. dsp: bios: Bounds check encode_set_bios_table_req() 17316. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 17417. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 175 176## [0.9.1] - 2024-09-07 177 178### Changed 179 1801. Moved evolutions intended for v0.9.0 into place 181 182 Evolutions for the release have been moved from `evolutions/current` to 183 `evolutions/v0.9.1`. Library users can apply them to migrate off of 184 deprecated APIs. 185 186## [0.9.0] - 2024-09-07 187 188### Added 189 1901. base: Define macros for reserved TIDs 1912. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1923. pdr: Add pldm_entity_association_pdr_create_new() 1934. platform: Define macros for the responded transferflags 1945. pdr: Add pldm_pdr_get_terminus_handle() API 1956. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 1967. fw_update: Add encode req & decode resp for get_downstream_fw_params 1978. platform: Add decode_pldm_platform_cper_event() API 1989. decode_get_pdr_repository_info_resp_safe() 199 200 Replaces decode_get_pdr_repository_info_resp() as discussed in the 201 `Deprecated` section below 202 20310. decode_get_pdr_resp_safe() 204 205 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 206 below 207 208### Changed 209 2101. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2112. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2123. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2134. ABI break for decode_sensor_op_data() 214 215 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 216 abi-compliance-checker to flag a change in the register containing the 217 parameter `previous_op_state`. 218 2195. platform: Stabilise decode_pldm_platform_cper_event() API 2206. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2217. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2228. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 223 224### Deprecated 225 2261. Rename and deprecate functions with the `_check` suffix 227 228 All library function return values always need to be checked. The `_check` 229 suffix is redundant, so remove it. Migration to the non-deprecated 230 equivalents without the `_check` suffix can be performed using 231 `scripts/ apply-renames` and the [clang-rename][] configurations under 232 `evolutions/` 233 234 The deprecated functions: 235 236 - `get_fru_record_by_option_check()` 237 - `pldm_bios_table_append_pad_checksum_check()` 238 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 239 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 240 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 241 - `pldm_bios_table_attr_entry_enum_encode_check()` 242 - `pldm_bios_table_attr_entry_integer_encode_check()` 243 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 244 - `pldm_bios_table_attr_entry_string_encode_check()` 245 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 246 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 247 - `pldm_bios_table_attr_value_entry_encode_string_check()` 248 - `pldm_bios_table_string_entry_decode_string_check()` 249 - `pldm_bios_table_string_entry_encode_check()` 250 - `pldm_entity_association_pdr_add_check()` 251 - `pldm_entity_association_pdr_add_from_node_check()` 252 - `pldm_pdr_add_check()` 253 - `pldm_pdr_add_fru_record_set_check()` 254 255[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 256 2572. `decode_get_pdr_repository_info_resp()` 258 259 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 260 eliminates the opportunity for buffer overruns when extracting objects from 261 the message. 262 2633. `decode_get_pdr_resp()` 264 265 Users should move to `decode_get_pdr_resp_safe()` which reduces the 266 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 267 268### Removed 269 2701. IBM OEM header compatibility symlinks. 271 272 Anyone left using the deprecated paths can migrate using the coccinelle patch 273 at `evolutions/current/oem-ibm-header-compat.cocci`. 274 275### Fixed 276 2771. requester: instance-id: Release read lock on conflict 2782. pdr: Error propagation for 279 pldm_entity_association_pdr_add_from_node_with_record_handle() 280 281## [0.8.0] - 2024-05-23 282 283### Added 284 2851. base: Provide pldm_msg_hdr_correlate_response() 2862. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2873. oem: ibm: Add chapdata file type support 2884. base: Added PLDM_SMBIOS & PLDM_RDE message types 2895. oem: meta: Add decode_oem_meta_file_io_req() 2906. state-set: Add all state set values to system power state enum as per DSP0249 2917. platform: Add alias members to the enum 292 pldm_pdr_repository_chg_event_change_record_event_data_operation. 293 294 enum constants with inconsistent names are deprecated with this change. 295 remove old inconsistent enum members after backward compatibility cleanup is 296 done 297 2988. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 2999. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 30010. platform: Add 3 PDR type enum for Redfish Device Enablement per 301 DSP0248_1.2.0 30211. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 30312. entity: Add enum for Network Interface Connectors and Network Ports 304 Connection Types 30513. pdr: Add decode_numeric_effecter_pdr_data() 30614. oem: ibm: Support for the Real SAI entity id 30715. fw_update: Add encode req & decode resp for query_downstream_devices 30816. fw_update: Add encode req & decode resp for query_downstream_identifiers 30917. platform: Add support for GetStateEffecterStates command 310 311### Changed 312 3131. base: Stabilise pldm_msg_hdr_correlate_response() 3142. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3153. libpldm: Fix header use 3164. libpldm: More fixes for header use 3175. pdr: Stabilise pldm_pdr_find_last_in_range() API 3186. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3197. oem: meta: stabilise decode_oem_meta_file_io_req() 3208. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 321 322### Deprecated 323 3241. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 325 with `PLDM_OEM_IBM_` 326 327### Fixed 328 3291. libpldm: Rationalise the local and installed path of pldm.h 3302. pdr: Assign record_handle in entity_association_pdr_add_children() 3313. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3324. pdr: Remove redundant constant for minimum numeric sensor PDR length 3335. tests: oem: meta: Fix fileio use of msgbuf 334 335## [0.7.0] - 2023-08-29 336 337### Added 338 3391. state-set: Add new enum for Operational Fault Status enum 340 341### Changed 342 3431. transport: Match specified metadata in pldm_transport_send_recv_msg() 3442. transport: mctp-demux: Drop ABI annotation for internal symbols 3453. transport: Stabilise core transport and implementation APIs 346 347 This stabilisation covers the following headers and functions: 348 349 - libpldm/transport.h 350 351 - pldm_transport_poll() 352 - pldm_transport_send_msg() 353 - pldm_transport_recv_msg() 354 - pldm_transport_send_recv_msg() 355 356 - libpldm/transport/af-mctp.h 357 358 - pldm_transport_af_mctp_init() 359 - pldm_transport_af_mctp_destroy() 360 - pldm_transport_af_mctp_core() 361 - pldm_transport_af_mctp_init_pollfd() 362 - pldm_transport_af_mctp_map_tid() 363 - pldm_transport_af_mctp_unmap_tid() 364 365 - libpldm/transport/mctp-demux.h 366 - pldm_transport_mctp_demux_init() 367 - pldm_transport_mctp_demux_destroy() 368 - pldm_transport_mctp_demux_core() 369 - pldm_transport_mctp_demux_init_pollfd() 370 - pldm_transport_mctp_demux_map_tid() 371 - pldm_transport_mctp_demux_unmap_tid() 372 373### Deprecated 374 3751. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 376 `libpldm/requester/pldm.h`): 377 378 - pldm_open() 379 - pldm_send_recv() 380 - pldm_send() 381 - pldm_recv() 382 - pldm_recv_any() 383 - pldm_close() 384 385 Users should migrate to the newer "transport" APIs instead. 386 387## Fixed 388 3891. tests: Exclude transport tests when build excludes testing ABIs 3902. abi: Capture deprecation of pldm_close() 391 392## [0.6.0] - 2023-08-22 393 394### Changed 395 3961. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 3972. meson: Apply `b_ndebug=if-release` by default 3983. pdr : Stabilize pldm_entity_association_tree_add_entity() 3994. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4005. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4016. transport: af-mctp: Assign out-params on success in \*\_recv() 4027. transport: Generalise the pldm_transport_recv_msg() API 403 404### Removed 405 4061. pdr: Remove pldm_entity_association_pdr_add() 4072. state-set: Remove enum pldm_state_set_operational_fault_status_values 408 409### Fixed 410 4111. transport: register init_pollfd callback for af-mctp 4122. transport: fix init_pollfd function parameter 4133. transport: Fix doxygen and variables for send and recv functions 4144. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 415 416## [0.5.0] - 2023-08-09 417 418### Added 419 4201. pdr: Introduce pldm_entity_association_pdr_add_check() 421 422### Changed 423 4241. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4252. transport: pldm_transport_poll(): Adjust return value semantics 4263. transport: free un-wanted responses in pldm_transport_send_recv_msg() 427 428### Deprecated 429 4301. state-set: Enum pldm_state_set_operational_fault_status_values 431 432 The enum operational_fault_status is defined with wrong members and will 433 eventually be replaced with the correct members. Any uses of 434 pldm_state_set_operational_fault_status_values members should move to 435 equivalent pldm_state_set_operational_stress_status_values members if needed. 436 4372. platform: Struct field name in fru_record_set PDR 438 439 References to entity_instance_num should be changed to entity_instance 440 4413. platform: Struct field name in numeric sensor value PDR 442 443 References to entity_instance_num should be changed to entity_instance 444 445### Removed 446 4471. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4482. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4493. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4504. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4515. bios_table: Remove pldm_bios_table_append_pad_checksum() 4526. fru: Remove get_fru_record_by_option() 4537. pdr: Make is_present() static 4548. pdr: Remove pldm_pdr_add() 4559. pdr: Remove pldm_pdr_add_fru_record_set() 45610. pdr: Remove pldm_entity_association_pdr_add_from_node() 45711. pdr: Make find_entity_ref_in_tree() static 45812. pdr: Make entity_association_tree_find() static 459 460### Fixed 461 4621. requester: Fix response buffer cast in pldm_send_recv() 4632. pdr: Hoist record handle overflow test to avoid memory leak 4643. transport: Correct comparison in while loop condition 465 466## [0.4.0] - 2023-07-14 467 468### Added 469 4701. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4712. fru: Introduce get_fru_record_by_option_check() 4723. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4734. pdr: Introduce pldm_pdr_add_check() 4745. pdr: Introduce pldm_pdr_add_fru_record_set_check() 475 476### Changed 477 4781. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4792. requester: Expose pldm_close() in header 4803. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4814. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4825. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4836. pdr: pldm_pdr_init(): Return NULL on allocation failure 4847. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4858. pdr: Document preconditions for trivial accessor functions 486 487 A trivial accessor function is one that exposes properties of an object in a 488 way can't result in an error, beyond passing an invalid argument to the 489 function. For APIs meeting this definition we define a precondition that 490 struct pointers must point to valid objects to avoid polluting the function 491 prototypes. The following APIs now have this precondition explicitly defined: 492 493 - pldm_entity_extract() 494 - pldm_entity_get_parent() 495 - pldm_entity_is_exist_parent() 496 - pldm_entity_is_node_parent() 497 - pldm_is_current_parent_child 498 - pldm_is_empty_entity_assoc_tree() 499 - pldm_pdr_get_record_count() 500 - pldm_pdr_get_record_handle() 501 - pldm_pdr_get_repo_size() 502 - pldm_pdr_record_is_remote() 503 5049. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 50510. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 50611. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 50712. pdr: pldm_entity_association_tree_visit(): Document preconditions 50813. pdr: pldm_entity_association_tree_visit(): Exit early on failure 50914. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 51015. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 51116. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 51217. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 51318. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 51419. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 51520. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 51621. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 51722. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 51823. pdr: pldm_entity_get_num_children(): Don't return invalid values 51924. libpldm: Lift or remove asserts where a subsequent check exists 520 521### Deprecated 522 5231. pldm_bios_table_attr_entry_integer_encode() 524 525 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 526 5272. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 528 529 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 530 5313. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 532 533 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 534 5354. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 536 537 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 538 5395. pdr: Deprecate is_present() 540 541 There should be no users of this symbol. If you are a user, you should figure 542 out how to stop, or get in touch. This symbol will be marked static the 543 release after deprecation. 544 5456. pdr: Deprecate find_entity_ref_in_tree() 546 547 There should be no users of this symbol. If you are a user, you should figure 548 out how to stop, or get in touch. This symbol will be marked static the 549 release after deprecation. 550 5517. pdr: Deprecate entity_association_tree_find() 552 553 There should be no users of this symbol. If you are a user, you should figure 554 out how to stop, or get in touch. This symbol will be marked static the 555 release after deprecation. 556 5578. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 558 559 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 560 pldm_bios_table_append_pad_checksum() should migrate to 561 pldm_bios_table_append_pad_checksum_check() 562 5639. fru: Stabilise get_fru_record_by_option_check() 564 565 get_fru_record_by_option() is deprecated by this change. Users of 566 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 567 56810. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 569 570 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 571 Users of pldm_entity_association_pdr_add_from_node() should migrate to 572 pldm_entity_association_pdr_add_from_node_check() 573 57411. pdr: Stabilise pldm_pdr_add_check() 575 576 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 577 migrate to pldm_pdr_add_check() 578 57912. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 580 581 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 582 pldm_pdr_add_fru_record_set() should migrate to 583 pldm_pdr_add_fru_record_set_check() 584 585### Removed 586 5871. bios_table: Remove deprecated APIs sanitized by assert(): 588 589 - pldm_bios_table_string_entry_encode() 590 - pldm_bios_table_string_entry_decode_string() 591 - pldm_bios_table_attr_entry_enum_encode() 592 - pldm_bios_table_attr_entry_enum_decode_pv_num() 593 - pldm_bios_table_attr_entry_enum_decode_def_num() 594 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 595 - pldm_bios_table_attr_entry_string_encode() 596 - pldm_bios_table_attr_entry_string_decode_def_string_length() 597 598### Fixed 599 6001. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6012. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6023. transport: mctp-demux: Don't test socket for non-zero value 6034. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6045. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6056. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6067. abi: Update to remove pldm_close() from reference dumps 6078. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 608 609## [0.3.0] - 2023-06-23 610 611### Added 612 6131. Add encode/decode pldmMessagePollEvent data 6142. README: Add a section on working with libpldm 6153. pdr: Introduce remote_container_id and associated APIs 6164. pdr: Add APIs for creating and locating remote PDRs 6175. pdr: Add pldm_pdr_find_last_in_range() 6186. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6197. pdr: Add pldm_pdr_find_container_id_range_exclude() 620 621### Changed 622 6231. include: Move installed transport.h under libpldm/ 6242. libpldm: Explicit deprecated, stable and testing ABI classes 6253. meson: Reduce strength of oem-ibm requirements from enabled to allowed 626 627 The `oem-ibm` feature is now enabled by the default meson configuration, for 628 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 629 recipe: 630 631 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 632 633 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 634 when invoking `meson setup` 635 6364. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6375. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 638 639### Deprecated 640 6411. bios_table: Deprecate APIs with arguments sanitized using assert() 642 643 C provides enough foot-guns without us encoding them into library APIs. 644 Specifically, deprecate the following in favour of their `*_check()` variants 645 which ensure assertions won't fail or otherwise invoke UB: 646 647 - pldm_bios_table_string_entry_encode() 648 - pldm_bios_table_string_entry_decode_string() 649 - pldm_bios_table_attr_entry_enum_encode() 650 - pldm_bios_table_attr_entry_enum_decode_pv_num() 651 - pldm_bios_table_attr_entry_enum_decode_def_num() 652 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 653 - pldm_bios_table_attr_entry_string_encode() 654 - pldm_bios_table_attr_entry_string_decode_def_string_length() 655 656### Removed 657 6581. libpldm: Remove the requester-api option 659 660### Fixed 661 6621. requester: Make pldm_open() return existing fd 6632. transport: Prevent sticking in waiting for response 6643. transport: Match on response in pldm_transport_send_recv_msg() 6654. requester: Add check before accessing hdr in pldm_recv() 6665. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 667