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 435. dsp: firmware_update: Change return type of downstream device ABIs to ERRNO 44 45 Those downstream device related ABIs have not been stabilized yet, change 46 return type from PLDM Completion Code to ERRNO 47 486. dsp: firmware_update: pack decomposed parameters to struct 49 50 `encode_query_downstream_identifiers_req()` and 51 `encode_get_downstream_firmware_params_req()` 52 53### Fixed 54 551. dsp: platform: Fix location of closing paren in overflow detection 562. libpldm: Install api header, update changelog 57 58## [0.10.0] 2024-11-01 59 60### Added 61 621. oem: meta: Add decode_oem_meta_file_io_write_req() 632. oem: meta: Add decode_oem_meta_file_io_read_req() 643. oem: meta: Add encode_oem_meta_file_io_read_resp() 654. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 665. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 676. pldm_entity_association_tree_copy_root_check() 687. oem: ibm: Add topology related state set and enum 69 708. base: Add size and buffer macros for struct pldm_msg 71 72 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 73 749. entity: Add new entity types from DSP0249 v1.3.0 7510. stateset: Add new state sets from DSP0249 v1.3.0 76 77### Changed 78 791. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 80 81 pldm_bios_table_iter_is_end() now returns true if the provided argument is 82 NULL. 83 842. Register assignment for parameters of a number of APIs changed with increased 85 scrutiny on their implementations. 86 87 - `decode_entity_auxiliary_names_pdr()` 88 - `decode_get_state_sensor_readings_resp()` 89 - `decode_oem_meta_file_io_req()` 90 - `decode_platform_event_message_req()` 91 - `decode_platform_event_message_resp()` 92 - `decode_sensor_op_data()` 93 - `encode_get_state_effecter_states_resp()` 94 - `encode_state_effecter_pdr()` 95 - `encode_state_sensor_pdr()` 96 - `pldm_bios_table_append_pad_checksum()` 97 - `pldm_bios_table_attr_value_entry_encode_enum()` 98 - `pldm_bios_table_attr_value_entry_encode_string()` 99 - `pldm_pdr_find_record()` 100 - `pldm_pdr_get_next_record()` 101 1023. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 103 1044. dsp: firmware_update: Bounds check 105 decode_downstream_device_parameter_table_entry_versions() 106 107 The additional bounds-checking required the addition of further length 108 parameters. 109 110### Deprecated 111 1121. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 113 114 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 115 function to make it safer. 116 117 Modification: 118 119 - The meaning of the returned result. 120 - Change parameters from individual pointers to a struct. 121 - Check the length provided in the message won't exceed the buffer. 122 1232. pldm_entity_association_tree_copy_root() 124 125 The implementation allocates, but gives no indication to the caller if an 126 allocation (and hence the copy) has failed. Users should migrate to 127 pldm_entity_association_tree_copy_root_check(). 128 1293. The following APIs are deprecated as unsafe due to various unfixable CWE 130 violations: 131 132 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 133 134 - `encode_get_bios_current_value_by_handle_resp()` 135 - `encode_get_bios_table_resp()` 136 - `encode_get_file_table_resp()` 137 - `encode_get_version_resp()` 138 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 139 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 140 - `pldm_bios_table_attr_find_by_handle()` 141 - `pldm_bios_table_attr_find_by_string_handle()` 142 - `pldm_bios_table_attr_value_find_by_handle()` 143 - `pldm_bios_table_iter_create()` 144 - `pldm_bios_table_iter_is_end()` 145 - `pldm_bios_table_string_find_by_handle()` 146 - `pldm_bios_table_string_find_by_string()` 147 148 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 149 150 - `pldm_entity_association_tree_copy_root()` 151 152 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 153 154 - `decode_oem_meta_file_io_req()` 155 156 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 157 - `encode_fru_record()` 158 - `encode_get_pdr_resp()` 159 - `pldm_bios_table_attr_entry_enum_encode_length()` 160 161### Removed 162 1631. Deprecated functions with the `_check` suffix 164 165 - `get_fru_record_by_option_check()` 166 - `pldm_bios_table_append_pad_checksum_check()` 167 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 168 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 169 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 170 - `pldm_bios_table_attr_entry_enum_encode_check()` 171 - `pldm_bios_table_attr_entry_integer_encode_check()` 172 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 173 - `pldm_bios_table_attr_entry_string_encode_check()` 174 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 175 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 176 - `pldm_bios_table_attr_value_entry_encode_string_check()` 177 - `pldm_bios_table_string_entry_decode_string_check()` 178 - `pldm_bios_table_string_entry_encode_check()` 179 - `pldm_entity_association_pdr_add_check()` 180 - `pldm_entity_association_pdr_add_from_node_check()` 181 - `pldm_pdr_add_check()` 182 - `pldm_pdr_add_fru_record_set_check()` 183 184### Fixed 185 1861. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 187 188 Avoid a caller-controlled NULL pointer dereference in the library 189 implementation. 190 1912. platform: fix encode/decode_poll_for_platform_event_message_req 192 193 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 194 follow spec. 195 1963. platform: Fix checking `eventIDToAcknowledge` 197 198 As the event receiver sends `PollForPlatformEventMessage` with the 199 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 200 should be the previously retrieved eventID (from the PLDM terminus). 201 2024. dsp: platform: Prevent overflow of arithmetic on event_data_length 2035. dsp: platform: Bounds check encode_sensor_state_pdr() 2046. dsp: platform: Bounds check encode_state_effecter_pdr() 2057. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 2068. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 2079. dsp: bios_table: Bounds check 208 pldm_bios_table_attr_value_entry_encode_string() 20910. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 21011. dsp: firmware_update: Bounds check 211 decode_downstream_device_parameter_table_entry_versions() 21212. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 21313. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 21414. dsp: fru: Bounds check encode_fru_record() 21515. dsp: bios: Bounds check encode_set_bios_table_req() 21616. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 21717. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 21818. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 21919. dsp: platform: Fix decode_set_event_receiver_req() 220 221## [0.9.1] - 2024-09-07 222 223### Changed 224 2251. Moved evolutions intended for v0.9.0 into place 226 227 Evolutions for the release have been moved from `evolutions/current` to 228 `evolutions/v0.9.1`. Library users can apply them to migrate off of 229 deprecated APIs. 230 231## [0.9.0] - 2024-09-07 232 233### Added 234 2351. base: Define macros for reserved TIDs 2362. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 2373. pdr: Add pldm_entity_association_pdr_create_new() 2384. platform: Define macros for the responded transferflags 2395. pdr: Add pldm_pdr_get_terminus_handle() API 2406. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2417. fw_update: Add encode req & decode resp for get_downstream_fw_params 2428. platform: Add decode_pldm_platform_cper_event() API 2439. decode_get_pdr_repository_info_resp_safe() 244 245 Replaces decode_get_pdr_repository_info_resp() as discussed in the 246 `Deprecated` section below 247 24810. decode_get_pdr_resp_safe() 249 250 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 251 below 252 253### Changed 254 2551. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2562. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2573. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2584. ABI break for decode_sensor_op_data() 259 260 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 261 abi-compliance-checker to flag a change in the register containing the 262 parameter `previous_op_state`. 263 2645. platform: Stabilise decode_pldm_platform_cper_event() API 2656. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2667. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2678. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 268 269### Deprecated 270 2711. Rename and deprecate functions with the `_check` suffix 272 273 All library function return values always need to be checked. The `_check` 274 suffix is redundant, so remove it. Migration to the non-deprecated 275 equivalents without the `_check` suffix can be performed using 276 `scripts/ apply-renames` and the [clang-rename][] configurations under 277 `evolutions/` 278 279 The deprecated functions: 280 281 - `get_fru_record_by_option_check()` 282 - `pldm_bios_table_append_pad_checksum_check()` 283 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 284 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 285 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 286 - `pldm_bios_table_attr_entry_enum_encode_check()` 287 - `pldm_bios_table_attr_entry_integer_encode_check()` 288 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 289 - `pldm_bios_table_attr_entry_string_encode_check()` 290 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 291 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 292 - `pldm_bios_table_attr_value_entry_encode_string_check()` 293 - `pldm_bios_table_string_entry_decode_string_check()` 294 - `pldm_bios_table_string_entry_encode_check()` 295 - `pldm_entity_association_pdr_add_check()` 296 - `pldm_entity_association_pdr_add_from_node_check()` 297 - `pldm_pdr_add_check()` 298 - `pldm_pdr_add_fru_record_set_check()` 299 300[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 301 3022. `decode_get_pdr_repository_info_resp()` 303 304 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 305 eliminates the opportunity for buffer overruns when extracting objects from 306 the message. 307 3083. `decode_get_pdr_resp()` 309 310 Users should move to `decode_get_pdr_resp_safe()` which reduces the 311 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 312 313### Removed 314 3151. IBM OEM header compatibility symlinks. 316 317 Anyone left using the deprecated paths can migrate using the coccinelle patch 318 at `evolutions/current/oem-ibm-header-compat.cocci`. 319 320### Fixed 321 3221. requester: instance-id: Release read lock on conflict 3232. pdr: Error propagation for 324 pldm_entity_association_pdr_add_from_node_with_record_handle() 325 326## [0.8.0] - 2024-05-23 327 328### Added 329 3301. base: Provide pldm_msg_hdr_correlate_response() 3312. transport: af-mctp: Add pldm_transport_af_mctp_bind() 3323. oem: ibm: Add chapdata file type support 3334. base: Added PLDM_SMBIOS & PLDM_RDE message types 3345. oem: meta: Add decode_oem_meta_file_io_req() 3356. state-set: Add all state set values to system power state enum as per DSP0249 3367. platform: Add alias members to the enum 337 pldm_pdr_repository_chg_event_change_record_event_data_operation. 338 339 enum constants with inconsistent names are deprecated with this change. 340 remove old inconsistent enum members after backward compatibility cleanup is 341 done 342 3438. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3449. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 34510. platform: Add 3 PDR type enum for Redfish Device Enablement per 346 DSP0248_1.2.0 34711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 34812. entity: Add enum for Network Interface Connectors and Network Ports 349 Connection Types 35013. pdr: Add decode_numeric_effecter_pdr_data() 35114. oem: ibm: Support for the Real SAI entity id 35215. fw_update: Add encode req & decode resp for query_downstream_devices 35316. fw_update: Add encode req & decode resp for query_downstream_identifiers 35417. platform: Add support for GetStateEffecterStates command 355 356### Changed 357 3581. base: Stabilise pldm_msg_hdr_correlate_response() 3592. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3603. libpldm: Fix header use 3614. libpldm: More fixes for header use 3625. pdr: Stabilise pldm_pdr_find_last_in_range() API 3636. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3647. oem: meta: stabilise decode_oem_meta_file_io_req() 3658. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 366 367### Deprecated 368 3691. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 370 with `PLDM_OEM_IBM_` 371 372### Fixed 373 3741. libpldm: Rationalise the local and installed path of pldm.h 3752. pdr: Assign record_handle in entity_association_pdr_add_children() 3763. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3774. pdr: Remove redundant constant for minimum numeric sensor PDR length 3785. tests: oem: meta: Fix fileio use of msgbuf 379 380## [0.7.0] - 2023-08-29 381 382### Added 383 3841. state-set: Add new enum for Operational Fault Status enum 385 386### Changed 387 3881. transport: Match specified metadata in pldm_transport_send_recv_msg() 3892. transport: mctp-demux: Drop ABI annotation for internal symbols 3903. transport: Stabilise core transport and implementation APIs 391 392 This stabilisation covers the following headers and functions: 393 394 - libpldm/transport.h 395 396 - pldm_transport_poll() 397 - pldm_transport_send_msg() 398 - pldm_transport_recv_msg() 399 - pldm_transport_send_recv_msg() 400 401 - libpldm/transport/af-mctp.h 402 403 - pldm_transport_af_mctp_init() 404 - pldm_transport_af_mctp_destroy() 405 - pldm_transport_af_mctp_core() 406 - pldm_transport_af_mctp_init_pollfd() 407 - pldm_transport_af_mctp_map_tid() 408 - pldm_transport_af_mctp_unmap_tid() 409 410 - libpldm/transport/mctp-demux.h 411 - pldm_transport_mctp_demux_init() 412 - pldm_transport_mctp_demux_destroy() 413 - pldm_transport_mctp_demux_core() 414 - pldm_transport_mctp_demux_init_pollfd() 415 - pldm_transport_mctp_demux_map_tid() 416 - pldm_transport_mctp_demux_unmap_tid() 417 418### Deprecated 419 4201. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 421 `libpldm/requester/pldm.h`): 422 423 - pldm_open() 424 - pldm_send_recv() 425 - pldm_send() 426 - pldm_recv() 427 - pldm_recv_any() 428 - pldm_close() 429 430 Users should migrate to the newer "transport" APIs instead. 431 432## Fixed 433 4341. tests: Exclude transport tests when build excludes testing ABIs 4352. abi: Capture deprecation of pldm_close() 436 437## [0.6.0] - 2023-08-22 438 439### Changed 440 4411. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4422. meson: Apply `b_ndebug=if-release` by default 4433. pdr : Stabilize pldm_entity_association_tree_add_entity() 4444. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4455. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4466. transport: af-mctp: Assign out-params on success in \*\_recv() 4477. transport: Generalise the pldm_transport_recv_msg() API 448 449### Removed 450 4511. pdr: Remove pldm_entity_association_pdr_add() 4522. state-set: Remove enum pldm_state_set_operational_fault_status_values 453 454### Fixed 455 4561. transport: register init_pollfd callback for af-mctp 4572. transport: fix init_pollfd function parameter 4583. transport: Fix doxygen and variables for send and recv functions 4594. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 460 461## [0.5.0] - 2023-08-09 462 463### Added 464 4651. pdr: Introduce pldm_entity_association_pdr_add_check() 466 467### Changed 468 4691. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4702. transport: pldm_transport_poll(): Adjust return value semantics 4713. transport: free un-wanted responses in pldm_transport_send_recv_msg() 472 473### Deprecated 474 4751. state-set: Enum pldm_state_set_operational_fault_status_values 476 477 The enum operational_fault_status is defined with wrong members and will 478 eventually be replaced with the correct members. Any uses of 479 pldm_state_set_operational_fault_status_values members should move to 480 equivalent pldm_state_set_operational_stress_status_values members if needed. 481 4822. platform: Struct field name in fru_record_set PDR 483 484 References to entity_instance_num should be changed to entity_instance 485 4863. platform: Struct field name in numeric sensor value PDR 487 488 References to entity_instance_num should be changed to entity_instance 489 490### Removed 491 4921. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4932. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4943. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4954. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4965. bios_table: Remove pldm_bios_table_append_pad_checksum() 4976. fru: Remove get_fru_record_by_option() 4987. pdr: Make is_present() static 4998. pdr: Remove pldm_pdr_add() 5009. pdr: Remove pldm_pdr_add_fru_record_set() 50110. pdr: Remove pldm_entity_association_pdr_add_from_node() 50211. pdr: Make find_entity_ref_in_tree() static 50312. pdr: Make entity_association_tree_find() static 504 505### Fixed 506 5071. requester: Fix response buffer cast in pldm_send_recv() 5082. pdr: Hoist record handle overflow test to avoid memory leak 5093. transport: Correct comparison in while loop condition 510 511## [0.4.0] - 2023-07-14 512 513### Added 514 5151. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 5162. fru: Introduce get_fru_record_by_option_check() 5173. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 5184. pdr: Introduce pldm_pdr_add_check() 5195. pdr: Introduce pldm_pdr_add_fru_record_set_check() 520 521### Changed 522 5231. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 5242. requester: Expose pldm_close() in header 5253. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 5264. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 5275. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 5286. pdr: pldm_pdr_init(): Return NULL on allocation failure 5297. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 5308. pdr: Document preconditions for trivial accessor functions 531 532 A trivial accessor function is one that exposes properties of an object in a 533 way can't result in an error, beyond passing an invalid argument to the 534 function. For APIs meeting this definition we define a precondition that 535 struct pointers must point to valid objects to avoid polluting the function 536 prototypes. The following APIs now have this precondition explicitly defined: 537 538 - pldm_entity_extract() 539 - pldm_entity_get_parent() 540 - pldm_entity_is_exist_parent() 541 - pldm_entity_is_node_parent() 542 - pldm_is_current_parent_child 543 - pldm_is_empty_entity_assoc_tree() 544 - pldm_pdr_get_record_count() 545 - pldm_pdr_get_record_handle() 546 - pldm_pdr_get_repo_size() 547 - pldm_pdr_record_is_remote() 548 5499. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 55010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 55111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 55212. pdr: pldm_entity_association_tree_visit(): Document preconditions 55313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 55414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 55515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 55616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 55717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 55818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 55919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 56020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 56121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 56222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 56323. pdr: pldm_entity_get_num_children(): Don't return invalid values 56424. libpldm: Lift or remove asserts where a subsequent check exists 565 566### Deprecated 567 5681. pldm_bios_table_attr_entry_integer_encode() 569 570 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 571 5722. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 573 574 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 575 5763. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 577 578 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 579 5804. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 581 582 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 583 5845. pdr: Deprecate is_present() 585 586 There should be no users of this symbol. If you are a user, you should figure 587 out how to stop, or get in touch. This symbol will be marked static the 588 release after deprecation. 589 5906. pdr: Deprecate find_entity_ref_in_tree() 591 592 There should be no users of this symbol. If you are a user, you should figure 593 out how to stop, or get in touch. This symbol will be marked static the 594 release after deprecation. 595 5967. pdr: Deprecate entity_association_tree_find() 597 598 There should be no users of this symbol. If you are a user, you should figure 599 out how to stop, or get in touch. This symbol will be marked static the 600 release after deprecation. 601 6028. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 603 604 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 605 pldm_bios_table_append_pad_checksum() should migrate to 606 pldm_bios_table_append_pad_checksum_check() 607 6089. fru: Stabilise get_fru_record_by_option_check() 609 610 get_fru_record_by_option() is deprecated by this change. Users of 611 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 612 61310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 614 615 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 616 Users of pldm_entity_association_pdr_add_from_node() should migrate to 617 pldm_entity_association_pdr_add_from_node_check() 618 61911. pdr: Stabilise pldm_pdr_add_check() 620 621 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 622 migrate to pldm_pdr_add_check() 623 62412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 625 626 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 627 pldm_pdr_add_fru_record_set() should migrate to 628 pldm_pdr_add_fru_record_set_check() 629 630### Removed 631 6321. bios_table: Remove deprecated APIs sanitized by assert(): 633 634 - pldm_bios_table_string_entry_encode() 635 - pldm_bios_table_string_entry_decode_string() 636 - pldm_bios_table_attr_entry_enum_encode() 637 - pldm_bios_table_attr_entry_enum_decode_pv_num() 638 - pldm_bios_table_attr_entry_enum_decode_def_num() 639 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 640 - pldm_bios_table_attr_entry_string_encode() 641 - pldm_bios_table_attr_entry_string_decode_def_string_length() 642 643### Fixed 644 6451. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6462. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6473. transport: mctp-demux: Don't test socket for non-zero value 6484. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6495. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6506. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6517. abi: Update to remove pldm_close() from reference dumps 6528. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 653 654## [0.3.0] - 2023-06-23 655 656### Added 657 6581. Add encode/decode pldmMessagePollEvent data 6592. README: Add a section on working with libpldm 6603. pdr: Introduce remote_container_id and associated APIs 6614. pdr: Add APIs for creating and locating remote PDRs 6625. pdr: Add pldm_pdr_find_last_in_range() 6636. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6647. pdr: Add pldm_pdr_find_container_id_range_exclude() 665 666### Changed 667 6681. include: Move installed transport.h under libpldm/ 6692. libpldm: Explicit deprecated, stable and testing ABI classes 6703. meson: Reduce strength of oem-ibm requirements from enabled to allowed 671 672 The `oem-ibm` feature is now enabled by the default meson configuration, for 673 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 674 recipe: 675 676 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 677 678 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 679 when invoking `meson setup` 680 6814. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6825. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 683 684### Deprecated 685 6861. bios_table: Deprecate APIs with arguments sanitized using assert() 687 688 C provides enough foot-guns without us encoding them into library APIs. 689 Specifically, deprecate the following in favour of their `*_check()` variants 690 which ensure assertions won't fail or otherwise invoke UB: 691 692 - pldm_bios_table_string_entry_encode() 693 - pldm_bios_table_string_entry_decode_string() 694 - pldm_bios_table_attr_entry_enum_encode() 695 - pldm_bios_table_attr_entry_enum_decode_pv_num() 696 - pldm_bios_table_attr_entry_enum_decode_def_num() 697 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 698 - pldm_bios_table_attr_entry_string_encode() 699 - pldm_bios_table_attr_entry_string_decode_def_string_length() 700 701### Removed 702 7031. libpldm: Remove the requester-api option 704 705### Fixed 706 7071. requester: Make pldm_open() return existing fd 7082. transport: Prevent sticking in waiting for response 7093. transport: Match on response in pldm_transport_send_recv_msg() 7104. requester: Add check before accessing hdr in pldm_recv() 7115. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 712