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### Changed 21 221. Register assignment for parameters of `encode_state_effecter_pdr()` 23 24### Fixed 25 261. dsp: platform: Fix location of closing paren in overflow detection 27 28## [0.10.0] 2024-11-01 29 30### Added 31 321. oem: meta: Add decode_oem_meta_file_io_write_req() 332. oem: meta: Add decode_oem_meta_file_io_read_req() 343. oem: meta: Add encode_oem_meta_file_io_read_resp() 354. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 365. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 376. pldm_entity_association_tree_copy_root_check() 387. oem: ibm: Add topology related state set and enum 39 408. base: Add size and buffer macros for struct pldm_msg 41 42 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 43 449. entity: Add new entity types from DSP0249 v1.3.0 4510. stateset: Add new state sets from DSP0249 v1.3.0 46 47### Changed 48 491. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 50 51 pldm_bios_table_iter_is_end() now returns true if the provided argument is 52 NULL. 53 542. Register assignment for parameters of a number of APIs changed with increased 55 scrutiny on their implementations. 56 57 - `decode_entity_auxiliary_names_pdr()` 58 - `decode_get_state_sensor_readings_resp()` 59 - `decode_oem_meta_file_io_req()` 60 - `decode_platform_event_message_req()` 61 - `decode_platform_event_message_resp()` 62 - `decode_sensor_op_data()` 63 - `encode_get_state_effecter_states_resp()` 64 - `encode_state_effecter_pdr()` 65 - `encode_state_sensor_pdr()` 66 - `pldm_bios_table_append_pad_checksum()` 67 - `pldm_bios_table_attr_value_entry_encode_enum()` 68 - `pldm_bios_table_attr_value_entry_encode_string()` 69 - `pldm_pdr_find_record()` 70 - `pldm_pdr_get_next_record()` 71 723. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 73 744. dsp: firmware_update: Bounds check 75 decode_downstream_device_parameter_table_entry_versions() 76 77 The additional bounds-checking required the addition of further length 78 parameters. 79 80### Deprecated 81 821. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 83 84 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 85 function to make it safer. 86 87 Modification: 88 89 - The meaning of the returned result. 90 - Change parameters from individual pointers to a struct. 91 - Check the length provided in the message won't exceed the buffer. 92 932. pldm_entity_association_tree_copy_root() 94 95 The implementation allocates, but gives no indication to the caller if an 96 allocation (and hence the copy) has failed. Users should migrate to 97 pldm_entity_association_tree_copy_root_check(). 98 993. The following APIs are deprecated as unsafe due to various unfixable CWE 100 violations: 101 102 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 103 104 - `encode_get_bios_current_value_by_handle_resp()` 105 - `encode_get_bios_table_resp()` 106 - `encode_get_file_table_resp()` 107 - `encode_get_version_resp()` 108 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 109 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 110 - `pldm_bios_table_attr_find_by_handle()` 111 - `pldm_bios_table_attr_find_by_string_handle()` 112 - `pldm_bios_table_attr_value_find_by_handle()` 113 - `pldm_bios_table_iter_create()` 114 - `pldm_bios_table_iter_is_end()` 115 - `pldm_bios_table_string_find_by_handle()` 116 - `pldm_bios_table_string_find_by_string()` 117 118 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 119 120 - `pldm_entity_association_tree_copy_root()` 121 122 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 123 124 - `decode_oem_meta_file_io_req()` 125 126 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 127 - `encode_fru_record()` 128 - `encode_get_pdr_resp()` 129 - `pldm_bios_table_attr_entry_enum_encode_length()` 130 131### Removed 132 1331. Deprecated functions with the `_check` suffix 134 135 - `get_fru_record_by_option_check()` 136 - `pldm_bios_table_append_pad_checksum_check()` 137 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 138 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 139 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 140 - `pldm_bios_table_attr_entry_enum_encode_check()` 141 - `pldm_bios_table_attr_entry_integer_encode_check()` 142 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 143 - `pldm_bios_table_attr_entry_string_encode_check()` 144 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 145 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 146 - `pldm_bios_table_attr_value_entry_encode_string_check()` 147 - `pldm_bios_table_string_entry_decode_string_check()` 148 - `pldm_bios_table_string_entry_encode_check()` 149 - `pldm_entity_association_pdr_add_check()` 150 - `pldm_entity_association_pdr_add_from_node_check()` 151 - `pldm_pdr_add_check()` 152 - `pldm_pdr_add_fru_record_set_check()` 153 154### Fixed 155 1561. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 157 158 Avoid a caller-controlled NULL pointer dereference in the library 159 implementation. 160 1612. platform: fix encode/decode_poll_for_platform_event_message_req 162 163 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 164 follow spec. 165 1663. platform: Fix checking `eventIDToAcknowledge` 167 168 As the event receiver sends `PollForPlatformEventMessage` with the 169 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 170 should be the previously retrieved eventID (from the PLDM terminus). 171 1724. dsp: platform: Prevent overflow of arithmetic on event_data_length 1735. dsp: platform: Bounds check encode_sensor_state_pdr() 1746. dsp: platform: Bounds check encode_state_effecter_pdr() 1757. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1768. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1779. dsp: bios_table: Bounds check 178 pldm_bios_table_attr_value_entry_encode_string() 17910. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 18011. dsp: firmware_update: Bounds check 181 decode_downstream_device_parameter_table_entry_versions() 18212. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 18313. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 18414. dsp: fru: Bounds check encode_fru_record() 18515. dsp: bios: Bounds check encode_set_bios_table_req() 18616. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 18717. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 18818. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 18919. dsp: platform: Fix decode_set_event_receiver_req() 190 191## [0.9.1] - 2024-09-07 192 193### Changed 194 1951. Moved evolutions intended for v0.9.0 into place 196 197 Evolutions for the release have been moved from `evolutions/current` to 198 `evolutions/v0.9.1`. Library users can apply them to migrate off of 199 deprecated APIs. 200 201## [0.9.0] - 2024-09-07 202 203### Added 204 2051. base: Define macros for reserved TIDs 2062. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 2073. pdr: Add pldm_entity_association_pdr_create_new() 2084. platform: Define macros for the responded transferflags 2095. pdr: Add pldm_pdr_get_terminus_handle() API 2106. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2117. fw_update: Add encode req & decode resp for get_downstream_fw_params 2128. platform: Add decode_pldm_platform_cper_event() API 2139. decode_get_pdr_repository_info_resp_safe() 214 215 Replaces decode_get_pdr_repository_info_resp() as discussed in the 216 `Deprecated` section below 217 21810. decode_get_pdr_resp_safe() 219 220 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 221 below 222 223### Changed 224 2251. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2262. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2273. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2284. ABI break for decode_sensor_op_data() 229 230 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 231 abi-compliance-checker to flag a change in the register containing the 232 parameter `previous_op_state`. 233 2345. platform: Stabilise decode_pldm_platform_cper_event() API 2356. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2367. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2378. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 238 239### Deprecated 240 2411. Rename and deprecate functions with the `_check` suffix 242 243 All library function return values always need to be checked. The `_check` 244 suffix is redundant, so remove it. Migration to the non-deprecated 245 equivalents without the `_check` suffix can be performed using 246 `scripts/ apply-renames` and the [clang-rename][] configurations under 247 `evolutions/` 248 249 The deprecated functions: 250 251 - `get_fru_record_by_option_check()` 252 - `pldm_bios_table_append_pad_checksum_check()` 253 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 254 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 255 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 256 - `pldm_bios_table_attr_entry_enum_encode_check()` 257 - `pldm_bios_table_attr_entry_integer_encode_check()` 258 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 259 - `pldm_bios_table_attr_entry_string_encode_check()` 260 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 261 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 262 - `pldm_bios_table_attr_value_entry_encode_string_check()` 263 - `pldm_bios_table_string_entry_decode_string_check()` 264 - `pldm_bios_table_string_entry_encode_check()` 265 - `pldm_entity_association_pdr_add_check()` 266 - `pldm_entity_association_pdr_add_from_node_check()` 267 - `pldm_pdr_add_check()` 268 - `pldm_pdr_add_fru_record_set_check()` 269 270[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 271 2722. `decode_get_pdr_repository_info_resp()` 273 274 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 275 eliminates the opportunity for buffer overruns when extracting objects from 276 the message. 277 2783. `decode_get_pdr_resp()` 279 280 Users should move to `decode_get_pdr_resp_safe()` which reduces the 281 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 282 283### Removed 284 2851. IBM OEM header compatibility symlinks. 286 287 Anyone left using the deprecated paths can migrate using the coccinelle patch 288 at `evolutions/current/oem-ibm-header-compat.cocci`. 289 290### Fixed 291 2921. requester: instance-id: Release read lock on conflict 2932. pdr: Error propagation for 294 pldm_entity_association_pdr_add_from_node_with_record_handle() 295 296## [0.8.0] - 2024-05-23 297 298### Added 299 3001. base: Provide pldm_msg_hdr_correlate_response() 3012. transport: af-mctp: Add pldm_transport_af_mctp_bind() 3023. oem: ibm: Add chapdata file type support 3034. base: Added PLDM_SMBIOS & PLDM_RDE message types 3045. oem: meta: Add decode_oem_meta_file_io_req() 3056. state-set: Add all state set values to system power state enum as per DSP0249 3067. platform: Add alias members to the enum 307 pldm_pdr_repository_chg_event_change_record_event_data_operation. 308 309 enum constants with inconsistent names are deprecated with this change. 310 remove old inconsistent enum members after backward compatibility cleanup is 311 done 312 3138. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3149. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 31510. platform: Add 3 PDR type enum for Redfish Device Enablement per 316 DSP0248_1.2.0 31711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 31812. entity: Add enum for Network Interface Connectors and Network Ports 319 Connection Types 32013. pdr: Add decode_numeric_effecter_pdr_data() 32114. oem: ibm: Support for the Real SAI entity id 32215. fw_update: Add encode req & decode resp for query_downstream_devices 32316. fw_update: Add encode req & decode resp for query_downstream_identifiers 32417. platform: Add support for GetStateEffecterStates command 325 326### Changed 327 3281. base: Stabilise pldm_msg_hdr_correlate_response() 3292. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3303. libpldm: Fix header use 3314. libpldm: More fixes for header use 3325. pdr: Stabilise pldm_pdr_find_last_in_range() API 3336. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3347. oem: meta: stabilise decode_oem_meta_file_io_req() 3358. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 336 337### Deprecated 338 3391. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 340 with `PLDM_OEM_IBM_` 341 342### Fixed 343 3441. libpldm: Rationalise the local and installed path of pldm.h 3452. pdr: Assign record_handle in entity_association_pdr_add_children() 3463. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3474. pdr: Remove redundant constant for minimum numeric sensor PDR length 3485. tests: oem: meta: Fix fileio use of msgbuf 349 350## [0.7.0] - 2023-08-29 351 352### Added 353 3541. state-set: Add new enum for Operational Fault Status enum 355 356### Changed 357 3581. transport: Match specified metadata in pldm_transport_send_recv_msg() 3592. transport: mctp-demux: Drop ABI annotation for internal symbols 3603. transport: Stabilise core transport and implementation APIs 361 362 This stabilisation covers the following headers and functions: 363 364 - libpldm/transport.h 365 366 - pldm_transport_poll() 367 - pldm_transport_send_msg() 368 - pldm_transport_recv_msg() 369 - pldm_transport_send_recv_msg() 370 371 - libpldm/transport/af-mctp.h 372 373 - pldm_transport_af_mctp_init() 374 - pldm_transport_af_mctp_destroy() 375 - pldm_transport_af_mctp_core() 376 - pldm_transport_af_mctp_init_pollfd() 377 - pldm_transport_af_mctp_map_tid() 378 - pldm_transport_af_mctp_unmap_tid() 379 380 - libpldm/transport/mctp-demux.h 381 - pldm_transport_mctp_demux_init() 382 - pldm_transport_mctp_demux_destroy() 383 - pldm_transport_mctp_demux_core() 384 - pldm_transport_mctp_demux_init_pollfd() 385 - pldm_transport_mctp_demux_map_tid() 386 - pldm_transport_mctp_demux_unmap_tid() 387 388### Deprecated 389 3901. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 391 `libpldm/requester/pldm.h`): 392 393 - pldm_open() 394 - pldm_send_recv() 395 - pldm_send() 396 - pldm_recv() 397 - pldm_recv_any() 398 - pldm_close() 399 400 Users should migrate to the newer "transport" APIs instead. 401 402## Fixed 403 4041. tests: Exclude transport tests when build excludes testing ABIs 4052. abi: Capture deprecation of pldm_close() 406 407## [0.6.0] - 2023-08-22 408 409### Changed 410 4111. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4122. meson: Apply `b_ndebug=if-release` by default 4133. pdr : Stabilize pldm_entity_association_tree_add_entity() 4144. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4155. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4166. transport: af-mctp: Assign out-params on success in \*\_recv() 4177. transport: Generalise the pldm_transport_recv_msg() API 418 419### Removed 420 4211. pdr: Remove pldm_entity_association_pdr_add() 4222. state-set: Remove enum pldm_state_set_operational_fault_status_values 423 424### Fixed 425 4261. transport: register init_pollfd callback for af-mctp 4272. transport: fix init_pollfd function parameter 4283. transport: Fix doxygen and variables for send and recv functions 4294. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 430 431## [0.5.0] - 2023-08-09 432 433### Added 434 4351. pdr: Introduce pldm_entity_association_pdr_add_check() 436 437### Changed 438 4391. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4402. transport: pldm_transport_poll(): Adjust return value semantics 4413. transport: free un-wanted responses in pldm_transport_send_recv_msg() 442 443### Deprecated 444 4451. state-set: Enum pldm_state_set_operational_fault_status_values 446 447 The enum operational_fault_status is defined with wrong members and will 448 eventually be replaced with the correct members. Any uses of 449 pldm_state_set_operational_fault_status_values members should move to 450 equivalent pldm_state_set_operational_stress_status_values members if needed. 451 4522. platform: Struct field name in fru_record_set PDR 453 454 References to entity_instance_num should be changed to entity_instance 455 4563. platform: Struct field name in numeric sensor value PDR 457 458 References to entity_instance_num should be changed to entity_instance 459 460### Removed 461 4621. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4632. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4643. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4654. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4665. bios_table: Remove pldm_bios_table_append_pad_checksum() 4676. fru: Remove get_fru_record_by_option() 4687. pdr: Make is_present() static 4698. pdr: Remove pldm_pdr_add() 4709. pdr: Remove pldm_pdr_add_fru_record_set() 47110. pdr: Remove pldm_entity_association_pdr_add_from_node() 47211. pdr: Make find_entity_ref_in_tree() static 47312. pdr: Make entity_association_tree_find() static 474 475### Fixed 476 4771. requester: Fix response buffer cast in pldm_send_recv() 4782. pdr: Hoist record handle overflow test to avoid memory leak 4793. transport: Correct comparison in while loop condition 480 481## [0.4.0] - 2023-07-14 482 483### Added 484 4851. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4862. fru: Introduce get_fru_record_by_option_check() 4873. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4884. pdr: Introduce pldm_pdr_add_check() 4895. pdr: Introduce pldm_pdr_add_fru_record_set_check() 490 491### Changed 492 4931. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4942. requester: Expose pldm_close() in header 4953. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4964. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4975. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4986. pdr: pldm_pdr_init(): Return NULL on allocation failure 4997. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 5008. pdr: Document preconditions for trivial accessor functions 501 502 A trivial accessor function is one that exposes properties of an object in a 503 way can't result in an error, beyond passing an invalid argument to the 504 function. For APIs meeting this definition we define a precondition that 505 struct pointers must point to valid objects to avoid polluting the function 506 prototypes. The following APIs now have this precondition explicitly defined: 507 508 - pldm_entity_extract() 509 - pldm_entity_get_parent() 510 - pldm_entity_is_exist_parent() 511 - pldm_entity_is_node_parent() 512 - pldm_is_current_parent_child 513 - pldm_is_empty_entity_assoc_tree() 514 - pldm_pdr_get_record_count() 515 - pldm_pdr_get_record_handle() 516 - pldm_pdr_get_repo_size() 517 - pldm_pdr_record_is_remote() 518 5199. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 52010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 52111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 52212. pdr: pldm_entity_association_tree_visit(): Document preconditions 52313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 52414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 52515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 52616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 52717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 52818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 52919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 53020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 53121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 53222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 53323. pdr: pldm_entity_get_num_children(): Don't return invalid values 53424. libpldm: Lift or remove asserts where a subsequent check exists 535 536### Deprecated 537 5381. pldm_bios_table_attr_entry_integer_encode() 539 540 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 541 5422. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 543 544 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 545 5463. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 547 548 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 549 5504. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 551 552 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 553 5545. pdr: Deprecate is_present() 555 556 There should be no users of this symbol. If you are a user, you should figure 557 out how to stop, or get in touch. This symbol will be marked static the 558 release after deprecation. 559 5606. pdr: Deprecate find_entity_ref_in_tree() 561 562 There should be no users of this symbol. If you are a user, you should figure 563 out how to stop, or get in touch. This symbol will be marked static the 564 release after deprecation. 565 5667. pdr: Deprecate entity_association_tree_find() 567 568 There should be no users of this symbol. If you are a user, you should figure 569 out how to stop, or get in touch. This symbol will be marked static the 570 release after deprecation. 571 5728. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 573 574 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 575 pldm_bios_table_append_pad_checksum() should migrate to 576 pldm_bios_table_append_pad_checksum_check() 577 5789. fru: Stabilise get_fru_record_by_option_check() 579 580 get_fru_record_by_option() is deprecated by this change. Users of 581 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 582 58310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 584 585 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 586 Users of pldm_entity_association_pdr_add_from_node() should migrate to 587 pldm_entity_association_pdr_add_from_node_check() 588 58911. pdr: Stabilise pldm_pdr_add_check() 590 591 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 592 migrate to pldm_pdr_add_check() 593 59412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 595 596 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 597 pldm_pdr_add_fru_record_set() should migrate to 598 pldm_pdr_add_fru_record_set_check() 599 600### Removed 601 6021. bios_table: Remove deprecated APIs sanitized by assert(): 603 604 - pldm_bios_table_string_entry_encode() 605 - pldm_bios_table_string_entry_decode_string() 606 - pldm_bios_table_attr_entry_enum_encode() 607 - pldm_bios_table_attr_entry_enum_decode_pv_num() 608 - pldm_bios_table_attr_entry_enum_decode_def_num() 609 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 610 - pldm_bios_table_attr_entry_string_encode() 611 - pldm_bios_table_attr_entry_string_decode_def_string_length() 612 613### Fixed 614 6151. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6162. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6173. transport: mctp-demux: Don't test socket for non-zero value 6184. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6195. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6206. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6217. abi: Update to remove pldm_close() from reference dumps 6228. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 623 624## [0.3.0] - 2023-06-23 625 626### Added 627 6281. Add encode/decode pldmMessagePollEvent data 6292. README: Add a section on working with libpldm 6303. pdr: Introduce remote_container_id and associated APIs 6314. pdr: Add APIs for creating and locating remote PDRs 6325. pdr: Add pldm_pdr_find_last_in_range() 6336. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6347. pdr: Add pldm_pdr_find_container_id_range_exclude() 635 636### Changed 637 6381. include: Move installed transport.h under libpldm/ 6392. libpldm: Explicit deprecated, stable and testing ABI classes 6403. meson: Reduce strength of oem-ibm requirements from enabled to allowed 641 642 The `oem-ibm` feature is now enabled by the default meson configuration, for 643 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 644 recipe: 645 646 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 647 648 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 649 when invoking `meson setup` 650 6514. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6525. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 653 654### Deprecated 655 6561. bios_table: Deprecate APIs with arguments sanitized using assert() 657 658 C provides enough foot-guns without us encoding them into library APIs. 659 Specifically, deprecate the following in favour of their `*_check()` variants 660 which ensure assertions won't fail or otherwise invoke UB: 661 662 - pldm_bios_table_string_entry_encode() 663 - pldm_bios_table_string_entry_decode_string() 664 - pldm_bios_table_attr_entry_enum_encode() 665 - pldm_bios_table_attr_entry_enum_decode_pv_num() 666 - pldm_bios_table_attr_entry_enum_decode_def_num() 667 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 668 - pldm_bios_table_attr_entry_string_encode() 669 - pldm_bios_table_attr_entry_string_decode_def_string_length() 670 671### Removed 672 6731. libpldm: Remove the requester-api option 674 675### Fixed 676 6771. requester: Make pldm_open() return existing fd 6782. transport: Prevent sticking in waiting for response 6793. transport: Match on response in pldm_transport_send_recv_msg() 6804. requester: Add check before accessing hdr in pldm_recv() 6815. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 682