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 23 24### Changed 25 261. Register assignment for parameters of `encode_state_effecter_pdr()` 27 282. dsp: firmware_update: Iterators for downstream device descriptors 29 30 The prototype for `decode_query_downstream_identifiers_resp()` was updated to 31 improve ergonomics for the iterator APIs. 32 33### Fixed 34 351. dsp: platform: Fix location of closing paren in overflow detection 362. libpldm: Install api header, update changelog 37 38## [0.10.0] 2024-11-01 39 40### Added 41 421. oem: meta: Add decode_oem_meta_file_io_write_req() 432. oem: meta: Add decode_oem_meta_file_io_read_req() 443. oem: meta: Add encode_oem_meta_file_io_read_resp() 454. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 465. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 476. pldm_entity_association_tree_copy_root_check() 487. oem: ibm: Add topology related state set and enum 49 508. base: Add size and buffer macros for struct pldm_msg 51 52 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 53 549. entity: Add new entity types from DSP0249 v1.3.0 5510. stateset: Add new state sets from DSP0249 v1.3.0 56 57### Changed 58 591. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 60 61 pldm_bios_table_iter_is_end() now returns true if the provided argument is 62 NULL. 63 642. Register assignment for parameters of a number of APIs changed with increased 65 scrutiny on their implementations. 66 67 - `decode_entity_auxiliary_names_pdr()` 68 - `decode_get_state_sensor_readings_resp()` 69 - `decode_oem_meta_file_io_req()` 70 - `decode_platform_event_message_req()` 71 - `decode_platform_event_message_resp()` 72 - `decode_sensor_op_data()` 73 - `encode_get_state_effecter_states_resp()` 74 - `encode_state_effecter_pdr()` 75 - `encode_state_sensor_pdr()` 76 - `pldm_bios_table_append_pad_checksum()` 77 - `pldm_bios_table_attr_value_entry_encode_enum()` 78 - `pldm_bios_table_attr_value_entry_encode_string()` 79 - `pldm_pdr_find_record()` 80 - `pldm_pdr_get_next_record()` 81 823. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 83 844. dsp: firmware_update: Bounds check 85 decode_downstream_device_parameter_table_entry_versions() 86 87 The additional bounds-checking required the addition of further length 88 parameters. 89 90### Deprecated 91 921. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 93 94 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 95 function to make it safer. 96 97 Modification: 98 99 - The meaning of the returned result. 100 - Change parameters from individual pointers to a struct. 101 - Check the length provided in the message won't exceed the buffer. 102 1032. pldm_entity_association_tree_copy_root() 104 105 The implementation allocates, but gives no indication to the caller if an 106 allocation (and hence the copy) has failed. Users should migrate to 107 pldm_entity_association_tree_copy_root_check(). 108 1093. The following APIs are deprecated as unsafe due to various unfixable CWE 110 violations: 111 112 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 113 114 - `encode_get_bios_current_value_by_handle_resp()` 115 - `encode_get_bios_table_resp()` 116 - `encode_get_file_table_resp()` 117 - `encode_get_version_resp()` 118 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 119 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 120 - `pldm_bios_table_attr_find_by_handle()` 121 - `pldm_bios_table_attr_find_by_string_handle()` 122 - `pldm_bios_table_attr_value_find_by_handle()` 123 - `pldm_bios_table_iter_create()` 124 - `pldm_bios_table_iter_is_end()` 125 - `pldm_bios_table_string_find_by_handle()` 126 - `pldm_bios_table_string_find_by_string()` 127 128 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 129 130 - `pldm_entity_association_tree_copy_root()` 131 132 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 133 134 - `decode_oem_meta_file_io_req()` 135 136 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 137 - `encode_fru_record()` 138 - `encode_get_pdr_resp()` 139 - `pldm_bios_table_attr_entry_enum_encode_length()` 140 141### Removed 142 1431. Deprecated functions with the `_check` suffix 144 145 - `get_fru_record_by_option_check()` 146 - `pldm_bios_table_append_pad_checksum_check()` 147 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 148 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 149 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 150 - `pldm_bios_table_attr_entry_enum_encode_check()` 151 - `pldm_bios_table_attr_entry_integer_encode_check()` 152 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 153 - `pldm_bios_table_attr_entry_string_encode_check()` 154 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 155 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 156 - `pldm_bios_table_attr_value_entry_encode_string_check()` 157 - `pldm_bios_table_string_entry_decode_string_check()` 158 - `pldm_bios_table_string_entry_encode_check()` 159 - `pldm_entity_association_pdr_add_check()` 160 - `pldm_entity_association_pdr_add_from_node_check()` 161 - `pldm_pdr_add_check()` 162 - `pldm_pdr_add_fru_record_set_check()` 163 164### Fixed 165 1661. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 167 168 Avoid a caller-controlled NULL pointer dereference in the library 169 implementation. 170 1712. platform: fix encode/decode_poll_for_platform_event_message_req 172 173 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 174 follow spec. 175 1763. platform: Fix checking `eventIDToAcknowledge` 177 178 As the event receiver sends `PollForPlatformEventMessage` with the 179 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 180 should be the previously retrieved eventID (from the PLDM terminus). 181 1824. dsp: platform: Prevent overflow of arithmetic on event_data_length 1835. dsp: platform: Bounds check encode_sensor_state_pdr() 1846. dsp: platform: Bounds check encode_state_effecter_pdr() 1857. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1868. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1879. dsp: bios_table: Bounds check 188 pldm_bios_table_attr_value_entry_encode_string() 18910. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 19011. dsp: firmware_update: Bounds check 191 decode_downstream_device_parameter_table_entry_versions() 19212. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 19313. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 19414. dsp: fru: Bounds check encode_fru_record() 19515. dsp: bios: Bounds check encode_set_bios_table_req() 19616. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 19717. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 19818. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 19919. dsp: platform: Fix decode_set_event_receiver_req() 200 201## [0.9.1] - 2024-09-07 202 203### Changed 204 2051. Moved evolutions intended for v0.9.0 into place 206 207 Evolutions for the release have been moved from `evolutions/current` to 208 `evolutions/v0.9.1`. Library users can apply them to migrate off of 209 deprecated APIs. 210 211## [0.9.0] - 2024-09-07 212 213### Added 214 2151. base: Define macros for reserved TIDs 2162. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 2173. pdr: Add pldm_entity_association_pdr_create_new() 2184. platform: Define macros for the responded transferflags 2195. pdr: Add pldm_pdr_get_terminus_handle() API 2206. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2217. fw_update: Add encode req & decode resp for get_downstream_fw_params 2228. platform: Add decode_pldm_platform_cper_event() API 2239. decode_get_pdr_repository_info_resp_safe() 224 225 Replaces decode_get_pdr_repository_info_resp() as discussed in the 226 `Deprecated` section below 227 22810. decode_get_pdr_resp_safe() 229 230 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 231 below 232 233### Changed 234 2351. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2362. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2373. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2384. ABI break for decode_sensor_op_data() 239 240 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 241 abi-compliance-checker to flag a change in the register containing the 242 parameter `previous_op_state`. 243 2445. platform: Stabilise decode_pldm_platform_cper_event() API 2456. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2467. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2478. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 248 249### Deprecated 250 2511. Rename and deprecate functions with the `_check` suffix 252 253 All library function return values always need to be checked. The `_check` 254 suffix is redundant, so remove it. Migration to the non-deprecated 255 equivalents without the `_check` suffix can be performed using 256 `scripts/ apply-renames` and the [clang-rename][] configurations under 257 `evolutions/` 258 259 The deprecated functions: 260 261 - `get_fru_record_by_option_check()` 262 - `pldm_bios_table_append_pad_checksum_check()` 263 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 264 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 265 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 266 - `pldm_bios_table_attr_entry_enum_encode_check()` 267 - `pldm_bios_table_attr_entry_integer_encode_check()` 268 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 269 - `pldm_bios_table_attr_entry_string_encode_check()` 270 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 271 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 272 - `pldm_bios_table_attr_value_entry_encode_string_check()` 273 - `pldm_bios_table_string_entry_decode_string_check()` 274 - `pldm_bios_table_string_entry_encode_check()` 275 - `pldm_entity_association_pdr_add_check()` 276 - `pldm_entity_association_pdr_add_from_node_check()` 277 - `pldm_pdr_add_check()` 278 - `pldm_pdr_add_fru_record_set_check()` 279 280[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 281 2822. `decode_get_pdr_repository_info_resp()` 283 284 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 285 eliminates the opportunity for buffer overruns when extracting objects from 286 the message. 287 2883. `decode_get_pdr_resp()` 289 290 Users should move to `decode_get_pdr_resp_safe()` which reduces the 291 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 292 293### Removed 294 2951. IBM OEM header compatibility symlinks. 296 297 Anyone left using the deprecated paths can migrate using the coccinelle patch 298 at `evolutions/current/oem-ibm-header-compat.cocci`. 299 300### Fixed 301 3021. requester: instance-id: Release read lock on conflict 3032. pdr: Error propagation for 304 pldm_entity_association_pdr_add_from_node_with_record_handle() 305 306## [0.8.0] - 2024-05-23 307 308### Added 309 3101. base: Provide pldm_msg_hdr_correlate_response() 3112. transport: af-mctp: Add pldm_transport_af_mctp_bind() 3123. oem: ibm: Add chapdata file type support 3134. base: Added PLDM_SMBIOS & PLDM_RDE message types 3145. oem: meta: Add decode_oem_meta_file_io_req() 3156. state-set: Add all state set values to system power state enum as per DSP0249 3167. platform: Add alias members to the enum 317 pldm_pdr_repository_chg_event_change_record_event_data_operation. 318 319 enum constants with inconsistent names are deprecated with this change. 320 remove old inconsistent enum members after backward compatibility cleanup is 321 done 322 3238. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3249. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 32510. platform: Add 3 PDR type enum for Redfish Device Enablement per 326 DSP0248_1.2.0 32711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 32812. entity: Add enum for Network Interface Connectors and Network Ports 329 Connection Types 33013. pdr: Add decode_numeric_effecter_pdr_data() 33114. oem: ibm: Support for the Real SAI entity id 33215. fw_update: Add encode req & decode resp for query_downstream_devices 33316. fw_update: Add encode req & decode resp for query_downstream_identifiers 33417. platform: Add support for GetStateEffecterStates command 335 336### Changed 337 3381. base: Stabilise pldm_msg_hdr_correlate_response() 3392. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3403. libpldm: Fix header use 3414. libpldm: More fixes for header use 3425. pdr: Stabilise pldm_pdr_find_last_in_range() API 3436. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3447. oem: meta: stabilise decode_oem_meta_file_io_req() 3458. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 346 347### Deprecated 348 3491. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 350 with `PLDM_OEM_IBM_` 351 352### Fixed 353 3541. libpldm: Rationalise the local and installed path of pldm.h 3552. pdr: Assign record_handle in entity_association_pdr_add_children() 3563. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3574. pdr: Remove redundant constant for minimum numeric sensor PDR length 3585. tests: oem: meta: Fix fileio use of msgbuf 359 360## [0.7.0] - 2023-08-29 361 362### Added 363 3641. state-set: Add new enum for Operational Fault Status enum 365 366### Changed 367 3681. transport: Match specified metadata in pldm_transport_send_recv_msg() 3692. transport: mctp-demux: Drop ABI annotation for internal symbols 3703. transport: Stabilise core transport and implementation APIs 371 372 This stabilisation covers the following headers and functions: 373 374 - libpldm/transport.h 375 376 - pldm_transport_poll() 377 - pldm_transport_send_msg() 378 - pldm_transport_recv_msg() 379 - pldm_transport_send_recv_msg() 380 381 - libpldm/transport/af-mctp.h 382 383 - pldm_transport_af_mctp_init() 384 - pldm_transport_af_mctp_destroy() 385 - pldm_transport_af_mctp_core() 386 - pldm_transport_af_mctp_init_pollfd() 387 - pldm_transport_af_mctp_map_tid() 388 - pldm_transport_af_mctp_unmap_tid() 389 390 - libpldm/transport/mctp-demux.h 391 - pldm_transport_mctp_demux_init() 392 - pldm_transport_mctp_demux_destroy() 393 - pldm_transport_mctp_demux_core() 394 - pldm_transport_mctp_demux_init_pollfd() 395 - pldm_transport_mctp_demux_map_tid() 396 - pldm_transport_mctp_demux_unmap_tid() 397 398### Deprecated 399 4001. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 401 `libpldm/requester/pldm.h`): 402 403 - pldm_open() 404 - pldm_send_recv() 405 - pldm_send() 406 - pldm_recv() 407 - pldm_recv_any() 408 - pldm_close() 409 410 Users should migrate to the newer "transport" APIs instead. 411 412## Fixed 413 4141. tests: Exclude transport tests when build excludes testing ABIs 4152. abi: Capture deprecation of pldm_close() 416 417## [0.6.0] - 2023-08-22 418 419### Changed 420 4211. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4222. meson: Apply `b_ndebug=if-release` by default 4233. pdr : Stabilize pldm_entity_association_tree_add_entity() 4244. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4255. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4266. transport: af-mctp: Assign out-params on success in \*\_recv() 4277. transport: Generalise the pldm_transport_recv_msg() API 428 429### Removed 430 4311. pdr: Remove pldm_entity_association_pdr_add() 4322. state-set: Remove enum pldm_state_set_operational_fault_status_values 433 434### Fixed 435 4361. transport: register init_pollfd callback for af-mctp 4372. transport: fix init_pollfd function parameter 4383. transport: Fix doxygen and variables for send and recv functions 4394. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 440 441## [0.5.0] - 2023-08-09 442 443### Added 444 4451. pdr: Introduce pldm_entity_association_pdr_add_check() 446 447### Changed 448 4491. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4502. transport: pldm_transport_poll(): Adjust return value semantics 4513. transport: free un-wanted responses in pldm_transport_send_recv_msg() 452 453### Deprecated 454 4551. state-set: Enum pldm_state_set_operational_fault_status_values 456 457 The enum operational_fault_status is defined with wrong members and will 458 eventually be replaced with the correct members. Any uses of 459 pldm_state_set_operational_fault_status_values members should move to 460 equivalent pldm_state_set_operational_stress_status_values members if needed. 461 4622. platform: Struct field name in fru_record_set PDR 463 464 References to entity_instance_num should be changed to entity_instance 465 4663. platform: Struct field name in numeric sensor value PDR 467 468 References to entity_instance_num should be changed to entity_instance 469 470### Removed 471 4721. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4732. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4743. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4754. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4765. bios_table: Remove pldm_bios_table_append_pad_checksum() 4776. fru: Remove get_fru_record_by_option() 4787. pdr: Make is_present() static 4798. pdr: Remove pldm_pdr_add() 4809. pdr: Remove pldm_pdr_add_fru_record_set() 48110. pdr: Remove pldm_entity_association_pdr_add_from_node() 48211. pdr: Make find_entity_ref_in_tree() static 48312. pdr: Make entity_association_tree_find() static 484 485### Fixed 486 4871. requester: Fix response buffer cast in pldm_send_recv() 4882. pdr: Hoist record handle overflow test to avoid memory leak 4893. transport: Correct comparison in while loop condition 490 491## [0.4.0] - 2023-07-14 492 493### Added 494 4951. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4962. fru: Introduce get_fru_record_by_option_check() 4973. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4984. pdr: Introduce pldm_pdr_add_check() 4995. pdr: Introduce pldm_pdr_add_fru_record_set_check() 500 501### Changed 502 5031. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 5042. requester: Expose pldm_close() in header 5053. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 5064. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 5075. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 5086. pdr: pldm_pdr_init(): Return NULL on allocation failure 5097. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 5108. pdr: Document preconditions for trivial accessor functions 511 512 A trivial accessor function is one that exposes properties of an object in a 513 way can't result in an error, beyond passing an invalid argument to the 514 function. For APIs meeting this definition we define a precondition that 515 struct pointers must point to valid objects to avoid polluting the function 516 prototypes. The following APIs now have this precondition explicitly defined: 517 518 - pldm_entity_extract() 519 - pldm_entity_get_parent() 520 - pldm_entity_is_exist_parent() 521 - pldm_entity_is_node_parent() 522 - pldm_is_current_parent_child 523 - pldm_is_empty_entity_assoc_tree() 524 - pldm_pdr_get_record_count() 525 - pldm_pdr_get_record_handle() 526 - pldm_pdr_get_repo_size() 527 - pldm_pdr_record_is_remote() 528 5299. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 53010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 53111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 53212. pdr: pldm_entity_association_tree_visit(): Document preconditions 53313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 53414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 53515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 53616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 53717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 53818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 53919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 54020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 54121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 54222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 54323. pdr: pldm_entity_get_num_children(): Don't return invalid values 54424. libpldm: Lift or remove asserts where a subsequent check exists 545 546### Deprecated 547 5481. pldm_bios_table_attr_entry_integer_encode() 549 550 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 551 5522. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 553 554 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 555 5563. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 557 558 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 559 5604. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 561 562 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 563 5645. pdr: Deprecate is_present() 565 566 There should be no users of this symbol. If you are a user, you should figure 567 out how to stop, or get in touch. This symbol will be marked static the 568 release after deprecation. 569 5706. pdr: Deprecate find_entity_ref_in_tree() 571 572 There should be no users of this symbol. If you are a user, you should figure 573 out how to stop, or get in touch. This symbol will be marked static the 574 release after deprecation. 575 5767. pdr: Deprecate entity_association_tree_find() 577 578 There should be no users of this symbol. If you are a user, you should figure 579 out how to stop, or get in touch. This symbol will be marked static the 580 release after deprecation. 581 5828. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 583 584 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 585 pldm_bios_table_append_pad_checksum() should migrate to 586 pldm_bios_table_append_pad_checksum_check() 587 5889. fru: Stabilise get_fru_record_by_option_check() 589 590 get_fru_record_by_option() is deprecated by this change. Users of 591 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 592 59310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 594 595 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 596 Users of pldm_entity_association_pdr_add_from_node() should migrate to 597 pldm_entity_association_pdr_add_from_node_check() 598 59911. pdr: Stabilise pldm_pdr_add_check() 600 601 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 602 migrate to pldm_pdr_add_check() 603 60412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 605 606 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 607 pldm_pdr_add_fru_record_set() should migrate to 608 pldm_pdr_add_fru_record_set_check() 609 610### Removed 611 6121. bios_table: Remove deprecated APIs sanitized by assert(): 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### Fixed 624 6251. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6262. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6273. transport: mctp-demux: Don't test socket for non-zero value 6284. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6295. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6306. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6317. abi: Update to remove pldm_close() from reference dumps 6328. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 633 634## [0.3.0] - 2023-06-23 635 636### Added 637 6381. Add encode/decode pldmMessagePollEvent data 6392. README: Add a section on working with libpldm 6403. pdr: Introduce remote_container_id and associated APIs 6414. pdr: Add APIs for creating and locating remote PDRs 6425. pdr: Add pldm_pdr_find_last_in_range() 6436. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6447. pdr: Add pldm_pdr_find_container_id_range_exclude() 645 646### Changed 647 6481. include: Move installed transport.h under libpldm/ 6492. libpldm: Explicit deprecated, stable and testing ABI classes 6503. meson: Reduce strength of oem-ibm requirements from enabled to allowed 651 652 The `oem-ibm` feature is now enabled by the default meson configuration, for 653 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 654 recipe: 655 656 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 657 658 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 659 when invoking `meson setup` 660 6614. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6625. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 663 664### Deprecated 665 6661. bios_table: Deprecate APIs with arguments sanitized using assert() 667 668 C provides enough foot-guns without us encoding them into library APIs. 669 Specifically, deprecate the following in favour of their `*_check()` variants 670 which ensure assertions won't fail or otherwise invoke UB: 671 672 - pldm_bios_table_string_entry_encode() 673 - pldm_bios_table_string_entry_decode_string() 674 - pldm_bios_table_attr_entry_enum_encode() 675 - pldm_bios_table_attr_entry_enum_decode_pv_num() 676 - pldm_bios_table_attr_entry_enum_decode_def_num() 677 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 678 - pldm_bios_table_attr_entry_string_encode() 679 - pldm_bios_table_attr_entry_string_decode_def_string_length() 680 681### Removed 682 6831. libpldm: Remove the requester-api option 684 685### Fixed 686 6871. requester: Make pldm_open() return existing fd 6882. transport: Prevent sticking in waiting for response 6893. transport: Match on response in pldm_transport_send_recv_msg() 6904. requester: Add check before accessing hdr in pldm_recv() 6915. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 692