All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Change categories:
state-set: Enum pldm_state_set_operational_fault_status_values
The enum operational_fault_status is defined with wrong members and will eventually be replaced with the correct members. Any uses of pldm_state_set_operational_fault_status_values members should move to equivalent pldm_state_set_operational_stress_status_values members if needed.
platform: Struct field name in fru_record_set PDR
References to entity_instance_num should be changed to entity_instance
requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
requester: Expose pldm_close() in header
bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
pdr: pldm_pdr_init(): Return NULL on allocation failure
pdr: pldm_pdr_destroy(): Exit early if repo is NULL
pdr: Document preconditions for trivial accessor functions
A trivial accessor function is one that exposes properties of an object in a way can't result in an error, beyond passing an invalid argument to the function. For APIs meeting this definition we define a precondition that struct pointers must point to valid objects to avoid polluting the function prototypes. The following APIs now have this precondition explicitly defined:
pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
pdr: pldm_entity_association_tree_visit(): Document preconditions
pdr: pldm_entity_association_tree_visit(): Exit early on failure
pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
pdr: pldm_is_current_parent_child(): Return false for invalid arguments
pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
pdr: pldm_entity_get_num_children(): Don't return invalid values
libpldm: Lift or remove asserts where a subsequent check exists
pldm_bios_table_attr_entry_integer_encode()
Migrate to pldm_bios_table_attr_entry_integer_encode_check()
bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
pdr: Deprecate is_present()
There should be no users of this symbol. If you are a user, you should figure out how to stop, or get in touch. This symbol will be marked static the release after deprecation.
pdr: Deprecate find_entity_ref_in_tree()
There should be no users of this symbol. If you are a user, you should figure out how to stop, or get in touch. This symbol will be marked static the release after deprecation.
pdr: Deprecate entity_association_tree_find()
There should be no users of this symbol. If you are a user, you should figure out how to stop, or get in touch. This symbol will be marked static the release after deprecation.
bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of pldm_bios_table_append_pad_checksum() should migrate to pldm_bios_table_append_pad_checksum_check()
fru: Stabilise get_fru_record_by_option_check()
get_fru_record_by_option() is deprecated by this change. Users of get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
pldm_entity_association_pdr_add_from_node() is deprecated by this change. Users of pldm_entity_association_pdr_add_from_node() should migrate to pldm_entity_association_pdr_add_from_node_check()
pdr: Stabilise pldm_pdr_add_check()
pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should migrate to pldm_pdr_add_check()
pdr: Stabilise pldm_pdr_add_fru_record_set_check()
pldm_pdr_add_fru_record_set() is deprecated by this change. Users of pldm_pdr_add_fru_record_set() should migrate to pldm_pdr_add_fru_record_set_check()
bios_table: Remove deprecated APIs sanitized by assert():
include: Move installed transport.h under libpldm/
libpldm: Explicit deprecated, stable and testing ABI classes
meson: Reduce strength of oem-ibm requirements from enabled to allowed
The oem-ibm feature is now enabled by the default meson configuration, for CI purposes. oem-ibm is still disabled by default in the libpldm bitbake recipe:
To disable oem-ibm in your development builds, pass -Doem-ibm=disabled when invoking meson setup
bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
bios_table: Deprecate APIs with arguments sanitized using assert()
C provides enough foot-guns without us encoding them into library APIs. Specifically, deprecate the following in favour of their *_check() variants which ensure assertions won't fail or otherwise invoke UB: