1# Changelog 2 3All notable changes to this project will be documented in this file. 4 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6and this project adheres to 7[Semantic Versioning](https://semver.org/spec/v2.0.0.html). 8 9Change categories: 10 11- Added 12- Changed 13- Deprecated 14- Removed 15- Fixed 16- Security 17 18## [Unreleased] 19 20### Added 21 221. oem: meta: Add decode_oem_meta_file_io_write_req() 232. oem: meta: Add decode_oem_meta_file_io_read_req() 243. oem: meta: Add encode_oem_meta_file_io_read_resp() 254. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 265. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 276. pldm_entity_association_tree_copy_root_check() 287. oem: ibm: Add topology related state set and enum 29 308. base: Add size and buffer macros for struct pldm_msg 31 32 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 33 34### Changed 35 361. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 37 38 pldm_bios_table_iter_is_end() now returns true if the provided argument is 39 NULL. 40 412. Register assignment for parameters of a number of APIs changed with increased 42 scrutiny on their implementations. 43 44 - `decode_entity_auxiliary_names_pdr()` 45 - `decode_get_state_sensor_readings_resp()` 46 - `decode_platform_event_message_req()` 47 - `decode_platform_event_message_resp()` 48 - `decode_sensor_op_data()` 49 - `encode_get_state_effecter_states_resp()` 50 - `encode_state_effecter_pdr()` 51 - `encode_state_sensor_pdr()` 52 - `pldm_bios_table_append_pad_checksum()` 53 - `pldm_bios_table_attr_value_entry_encode_enum()` 54 - `pldm_bios_table_attr_value_entry_encode_string()` 55 - `pldm_pdr_find_record()` 56 - `pldm_pdr_get_next_record()` 57 583. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 59 604. dsp: firmware_update: Bounds check 61 decode_downstream_device_parameter_table_entry_versions() 62 63 The additional bounds-checking required the addition of further length 64 parameters. 65 66### Deprecated 67 681. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 69 70 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 71 function to make it safer. 72 73 Modification: 74 75 - The meaning of the returned result. 76 - Change parameters from individual pointers to a struct. 77 - Check the length provided in the message won't exceed the buffer. 78 792. pldm_entity_association_tree_copy_root() 80 81 The implementation allocates, but gives no indication to the caller if an 82 allocation (and hence the copy) has failed. Users should migrate to 83 pldm_entity_association_tree_copy_root_check(). 84 85### Removed 86 871. Deprecated functions with the `_check` suffix 88 89 - `get_fru_record_by_option_check()` 90 - `pldm_bios_table_append_pad_checksum_check()` 91 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 92 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 93 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 94 - `pldm_bios_table_attr_entry_enum_encode_check()` 95 - `pldm_bios_table_attr_entry_integer_encode_check()` 96 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 97 - `pldm_bios_table_attr_entry_string_encode_check()` 98 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 99 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 100 - `pldm_bios_table_attr_value_entry_encode_string_check()` 101 - `pldm_bios_table_string_entry_decode_string_check()` 102 - `pldm_bios_table_string_entry_encode_check()` 103 - `pldm_entity_association_pdr_add_check()` 104 - `pldm_entity_association_pdr_add_from_node_check()` 105 - `pldm_pdr_add_check()` 106 - `pldm_pdr_add_fru_record_set_check()` 107 108### Fixed 109 1101. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 111 112 Avoid a caller-controlled NULL pointer dereference in the library 113 implementation. 114 1152. platform: fix encode/decode_poll_for_platform_event_message_req 116 117 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 118 follow spec. 119 1203. platform: Fix checking `eventIDToAcknowledge` 121 122 As the event receiver sends `PollForPlatformEventMessage` with the 123 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 124 should be the previously retrieved eventID (from the PLDM terminus). 125 1264. dsp: platform: Prevent overflow of arithmetic on event_data_length 1275. dsp: platform: Bounds check encode_sensor_state_pdr() 1286. dsp: platform: Bounds check encode_state_effecter_pdr() 1297. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1308. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1319. dsp: bios_table: Bounds check 132 pldm_bios_table_attr_value_entry_encode_string() 13310. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 13411. dsp: firmware_update: Bounds check 135 decode_downstream_device_parameter_table_entry_versions() 13612. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 13713. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 13814. dsp: fru: Bounds check encode_fru_record() 13915. dsp: bios: Bounds check encode_set_bios_table_req() 14016. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 141 142## [0.9.1] - 2024-09-07 143 144### Changed 145 1461. Moved evolutions intended for v0.9.0 into place 147 148 Evolutions for the release have been moved from `evolutions/current` to 149 `evolutions/v0.9.1`. Library users can apply them to migrate off of 150 deprecated APIs. 151 152## [0.9.0] - 2024-09-07 153 154### Added 155 1561. base: Define macros for reserved TIDs 1572. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 1583. pdr: Add pldm_entity_association_pdr_create_new() 1594. platform: Define macros for the responded transferflags 1605. pdr: Add pldm_pdr_get_terminus_handle() API 1616. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 1627. fw_update: Add encode req & decode resp for get_downstream_fw_params 1638. platform: Add decode_pldm_platform_cper_event() API 1649. decode_get_pdr_repository_info_resp_safe() 165 166 Replaces decode_get_pdr_repository_info_resp() as discussed in the 167 `Deprecated` section below 168 16910. decode_get_pdr_resp_safe() 170 171 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 172 below 173 174### Changed 175 1761. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 1772. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 1783. platform: Stabilise decode_pldm_message_poll_event_data() APIs 1794. ABI break for decode_sensor_op_data() 180 181 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 182 abi-compliance-checker to flag a change in the register containing the 183 parameter `previous_op_state`. 184 1855. platform: Stabilise decode_pldm_platform_cper_event() API 1866. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 1877. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 1888. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 189 190### Deprecated 191 1921. Rename and deprecate functions with the `_check` suffix 193 194 All library function return values always need to be checked. The `_check` 195 suffix is redundant, so remove it. Migration to the non-deprecated 196 equivalents without the `_check` suffix can be performed using 197 `scripts/ apply-renames` and the [clang-rename][] configurations under 198 `evolutions/` 199 200 The deprecated functions: 201 202 - `get_fru_record_by_option_check()` 203 - `pldm_bios_table_append_pad_checksum_check()` 204 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 205 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 206 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 207 - `pldm_bios_table_attr_entry_enum_encode_check()` 208 - `pldm_bios_table_attr_entry_integer_encode_check()` 209 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 210 - `pldm_bios_table_attr_entry_string_encode_check()` 211 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 212 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 213 - `pldm_bios_table_attr_value_entry_encode_string_check()` 214 - `pldm_bios_table_string_entry_decode_string_check()` 215 - `pldm_bios_table_string_entry_encode_check()` 216 - `pldm_entity_association_pdr_add_check()` 217 - `pldm_entity_association_pdr_add_from_node_check()` 218 - `pldm_pdr_add_check()` 219 - `pldm_pdr_add_fru_record_set_check()` 220 221[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 222 2232. `decode_get_pdr_repository_info_resp()` 224 225 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 226 eliminates the opportunity for buffer overruns when extracting objects from 227 the message. 228 2293. `decode_get_pdr_resp()` 230 231 Users should move to `decode_get_pdr_resp_safe()` which reduces the 232 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 233 234### Removed 235 2361. IBM OEM header compatibility symlinks. 237 238 Anyone left using the deprecated paths can migrate using the coccinelle patch 239 at `evolutions/current/oem-ibm-header-compat.cocci`. 240 241### Fixed 242 2431. requester: instance-id: Release read lock on conflict 2442. pdr: Error propagation for 245 pldm_entity_association_pdr_add_from_node_with_record_handle() 246 247## [0.8.0] - 2024-05-23 248 249### Added 250 2511. base: Provide pldm_msg_hdr_correlate_response() 2522. transport: af-mctp: Add pldm_transport_af_mctp_bind() 2533. oem: ibm: Add chapdata file type support 2544. base: Added PLDM_SMBIOS & PLDM_RDE message types 2555. oem: meta: Add decode_oem_meta_file_io_req() 2566. state-set: Add all state set values to system power state enum as per DSP0249 2577. platform: Add alias members to the enum 258 pldm_pdr_repository_chg_event_change_record_event_data_operation. 259 260 enum constants with inconsistent names are deprecated with this change. 261 remove old inconsistent enum members after backward compatibility cleanup is 262 done 263 2648. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 2659. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 26610. platform: Add 3 PDR type enum for Redfish Device Enablement per 267 DSP0248_1.2.0 26811. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 26912. entity: Add enum for Network Interface Connectors and Network Ports 270 Connection Types 27113. pdr: Add decode_numeric_effecter_pdr_data() 27214. oem: ibm: Support for the Real SAI entity id 27315. fw_update: Add encode req & decode resp for query_downstream_devices 27416. fw_update: Add encode req & decode resp for query_downstream_identifiers 27517. platform: Add support for GetStateEffecterStates command 276 277### Changed 278 2791. base: Stabilise pldm_msg_hdr_correlate_response() 2802. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 2813. libpldm: Fix header use 2824. libpldm: More fixes for header use 2835. pdr: Stabilise pldm_pdr_find_last_in_range() API 2846. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 2857. oem: meta: stabilise decode_oem_meta_file_io_req() 2868. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 287 288### Deprecated 289 2901. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 291 with `PLDM_OEM_IBM_` 292 293### Fixed 294 2951. libpldm: Rationalise the local and installed path of pldm.h 2962. pdr: Assign record_handle in entity_association_pdr_add_children() 2973. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 2984. pdr: Remove redundant constant for minimum numeric sensor PDR length 2995. tests: oem: meta: Fix fileio use of msgbuf 300 301## [0.7.0] - 2023-08-29 302 303### Added 304 3051. state-set: Add new enum for Operational Fault Status enum 306 307### Changed 308 3091. transport: Match specified metadata in pldm_transport_send_recv_msg() 3102. transport: mctp-demux: Drop ABI annotation for internal symbols 3113. transport: Stabilise core transport and implementation APIs 312 313 This stabilisation covers the following headers and functions: 314 315 - libpldm/transport.h 316 317 - pldm_transport_poll() 318 - pldm_transport_send_msg() 319 - pldm_transport_recv_msg() 320 - pldm_transport_send_recv_msg() 321 322 - libpldm/transport/af-mctp.h 323 324 - pldm_transport_af_mctp_init() 325 - pldm_transport_af_mctp_destroy() 326 - pldm_transport_af_mctp_core() 327 - pldm_transport_af_mctp_init_pollfd() 328 - pldm_transport_af_mctp_map_tid() 329 - pldm_transport_af_mctp_unmap_tid() 330 331 - libpldm/transport/mctp-demux.h 332 - pldm_transport_mctp_demux_init() 333 - pldm_transport_mctp_demux_destroy() 334 - pldm_transport_mctp_demux_core() 335 - pldm_transport_mctp_demux_init_pollfd() 336 - pldm_transport_mctp_demux_map_tid() 337 - pldm_transport_mctp_demux_unmap_tid() 338 339### Deprecated 340 3411. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 342 `libpldm/requester/pldm.h`): 343 344 - pldm_open() 345 - pldm_send_recv() 346 - pldm_send() 347 - pldm_recv() 348 - pldm_recv_any() 349 - pldm_close() 350 351 Users should migrate to the newer "transport" APIs instead. 352 353## Fixed 354 3551. tests: Exclude transport tests when build excludes testing ABIs 3562. abi: Capture deprecation of pldm_close() 357 358## [0.6.0] - 2023-08-22 359 360### Changed 361 3621. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 3632. meson: Apply `b_ndebug=if-release` by default 3643. pdr : Stabilize pldm_entity_association_tree_add_entity() 3654. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 3665. pdr: Stabilize pldm_entity_node_get_remote_container_id() 3676. transport: af-mctp: Assign out-params on success in \*\_recv() 3687. transport: Generalise the pldm_transport_recv_msg() API 369 370### Removed 371 3721. pdr: Remove pldm_entity_association_pdr_add() 3732. state-set: Remove enum pldm_state_set_operational_fault_status_values 374 375### Fixed 376 3771. transport: register init_pollfd callback for af-mctp 3782. transport: fix init_pollfd function parameter 3793. transport: Fix doxygen and variables for send and recv functions 3804. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 381 382## [0.5.0] - 2023-08-09 383 384### Added 385 3861. pdr: Introduce pldm_entity_association_pdr_add_check() 387 388### Changed 389 3901. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 3912. transport: pldm_transport_poll(): Adjust return value semantics 3923. transport: free un-wanted responses in pldm_transport_send_recv_msg() 393 394### Deprecated 395 3961. state-set: Enum pldm_state_set_operational_fault_status_values 397 398 The enum operational_fault_status is defined with wrong members and will 399 eventually be replaced with the correct members. Any uses of 400 pldm_state_set_operational_fault_status_values members should move to 401 equivalent pldm_state_set_operational_stress_status_values members if needed. 402 4032. platform: Struct field name in fru_record_set PDR 404 405 References to entity_instance_num should be changed to entity_instance 406 4073. platform: Struct field name in numeric sensor value PDR 408 409 References to entity_instance_num should be changed to entity_instance 410 411### Removed 412 4131. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4142. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4153. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4164. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4175. bios_table: Remove pldm_bios_table_append_pad_checksum() 4186. fru: Remove get_fru_record_by_option() 4197. pdr: Make is_present() static 4208. pdr: Remove pldm_pdr_add() 4219. pdr: Remove pldm_pdr_add_fru_record_set() 42210. pdr: Remove pldm_entity_association_pdr_add_from_node() 42311. pdr: Make find_entity_ref_in_tree() static 42412. pdr: Make entity_association_tree_find() static 425 426### Fixed 427 4281. requester: Fix response buffer cast in pldm_send_recv() 4292. pdr: Hoist record handle overflow test to avoid memory leak 4303. transport: Correct comparison in while loop condition 431 432## [0.4.0] - 2023-07-14 433 434### Added 435 4361. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4372. fru: Introduce get_fru_record_by_option_check() 4383. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4394. pdr: Introduce pldm_pdr_add_check() 4405. pdr: Introduce pldm_pdr_add_fru_record_set_check() 441 442### Changed 443 4441. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 4452. requester: Expose pldm_close() in header 4463. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 4474. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 4485. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 4496. pdr: pldm_pdr_init(): Return NULL on allocation failure 4507. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 4518. pdr: Document preconditions for trivial accessor functions 452 453 A trivial accessor function is one that exposes properties of an object in a 454 way can't result in an error, beyond passing an invalid argument to the 455 function. For APIs meeting this definition we define a precondition that 456 struct pointers must point to valid objects to avoid polluting the function 457 prototypes. The following APIs now have this precondition explicitly defined: 458 459 - pldm_entity_extract() 460 - pldm_entity_get_parent() 461 - pldm_entity_is_exist_parent() 462 - pldm_entity_is_node_parent() 463 - pldm_is_current_parent_child 464 - pldm_is_empty_entity_assoc_tree() 465 - pldm_pdr_get_record_count() 466 - pldm_pdr_get_record_handle() 467 - pldm_pdr_get_repo_size() 468 - pldm_pdr_record_is_remote() 469 4709. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 47110. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 47211. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 47312. pdr: pldm_entity_association_tree_visit(): Document preconditions 47413. pdr: pldm_entity_association_tree_visit(): Exit early on failure 47514. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 47615. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 47716. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 47817. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 47918. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 48019. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 48120. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 48221. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 48322. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 48423. pdr: pldm_entity_get_num_children(): Don't return invalid values 48524. libpldm: Lift or remove asserts where a subsequent check exists 486 487### Deprecated 488 4891. pldm_bios_table_attr_entry_integer_encode() 490 491 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 492 4932. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 494 495 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 496 4973. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 498 499 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 500 5014. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 502 503 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 504 5055. pdr: Deprecate is_present() 506 507 There should be no users of this symbol. If you are a user, you should figure 508 out how to stop, or get in touch. This symbol will be marked static the 509 release after deprecation. 510 5116. pdr: Deprecate find_entity_ref_in_tree() 512 513 There should be no users of this symbol. If you are a user, you should figure 514 out how to stop, or get in touch. This symbol will be marked static the 515 release after deprecation. 516 5177. pdr: Deprecate entity_association_tree_find() 518 519 There should be no users of this symbol. If you are a user, you should figure 520 out how to stop, or get in touch. This symbol will be marked static the 521 release after deprecation. 522 5238. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 524 525 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 526 pldm_bios_table_append_pad_checksum() should migrate to 527 pldm_bios_table_append_pad_checksum_check() 528 5299. fru: Stabilise get_fru_record_by_option_check() 530 531 get_fru_record_by_option() is deprecated by this change. Users of 532 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 533 53410. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 535 536 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 537 Users of pldm_entity_association_pdr_add_from_node() should migrate to 538 pldm_entity_association_pdr_add_from_node_check() 539 54011. pdr: Stabilise pldm_pdr_add_check() 541 542 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 543 migrate to pldm_pdr_add_check() 544 54512. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 546 547 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 548 pldm_pdr_add_fru_record_set() should migrate to 549 pldm_pdr_add_fru_record_set_check() 550 551### Removed 552 5531. bios_table: Remove deprecated APIs sanitized by assert(): 554 555 - pldm_bios_table_string_entry_encode() 556 - pldm_bios_table_string_entry_decode_string() 557 - pldm_bios_table_attr_entry_enum_encode() 558 - pldm_bios_table_attr_entry_enum_decode_pv_num() 559 - pldm_bios_table_attr_entry_enum_decode_def_num() 560 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 561 - pldm_bios_table_attr_entry_string_encode() 562 - pldm_bios_table_attr_entry_string_decode_def_string_length() 563 564### Fixed 565 5661. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 5672. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 5683. transport: mctp-demux: Don't test socket for non-zero value 5694. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 5705. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 5716. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 5727. abi: Update to remove pldm_close() from reference dumps 5738. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 574 575## [0.3.0] - 2023-06-23 576 577### Added 578 5791. Add encode/decode pldmMessagePollEvent data 5802. README: Add a section on working with libpldm 5813. pdr: Introduce remote_container_id and associated APIs 5824. pdr: Add APIs for creating and locating remote PDRs 5835. pdr: Add pldm_pdr_find_last_in_range() 5846. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 5857. pdr: Add pldm_pdr_find_container_id_range_exclude() 586 587### Changed 588 5891. include: Move installed transport.h under libpldm/ 5902. libpldm: Explicit deprecated, stable and testing ABI classes 5913. meson: Reduce strength of oem-ibm requirements from enabled to allowed 592 593 The `oem-ibm` feature is now enabled by the default meson configuration, for 594 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 595 recipe: 596 597 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 598 599 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 600 when invoking `meson setup` 601 6024. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6035. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 604 605### Deprecated 606 6071. bios_table: Deprecate APIs with arguments sanitized using assert() 608 609 C provides enough foot-guns without us encoding them into library APIs. 610 Specifically, deprecate the following in favour of their `*_check()` variants 611 which ensure assertions won't fail or otherwise invoke UB: 612 613 - pldm_bios_table_string_entry_encode() 614 - pldm_bios_table_string_entry_decode_string() 615 - pldm_bios_table_attr_entry_enum_encode() 616 - pldm_bios_table_attr_entry_enum_decode_pv_num() 617 - pldm_bios_table_attr_entry_enum_decode_def_num() 618 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 619 - pldm_bios_table_attr_entry_string_encode() 620 - pldm_bios_table_attr_entry_string_decode_def_string_length() 621 622### Removed 623 6241. libpldm: Remove the requester-api option 625 626### Fixed 627 6281. requester: Make pldm_open() return existing fd 6292. transport: Prevent sticking in waiting for response 6303. transport: Match on response in pldm_transport_send_recv_msg() 6314. requester: Add check before accessing hdr in pldm_recv() 6325. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 633