This document details the policy for maintaining stability of SPDK ABI and API.
Major ABI version can change at most once for each SPDK release. ABI versions are managed separately for each library and follow Semantic Versioning.
API and ABI deprecation notices shall be posted in the next section. Each entry must describe what will be removed and can suggest the future use or alternative. Specific future SPDK release for the removal must be provided. ABI cannot be removed without providing deprecation notice for at least single SPDK release.
Deprecated code paths must be registered with SPDK_DEPRECATION_REGISTER() and logged with SPDK_LOG_DEPRECATED(). The tag used with these macros will appear in the SPDK log at the warn level when SPDK_LOG_DEPRECATED() is called, subject to rate limits. The tags can be matched with the level 4 headers below.
accel_flagsThe int flags parameter in various submit and append accel FW API is not used and deprecated. It will be removed in 24.05 release.
spdk_nvme_ctrlr_opts.pskPassing NVMe/TLS pre-shared keys via spdk_nvme_ctrlr_opts.psk is deprecated and this field will be removed in the v24.09 release. Instead, a key obtained from the keyring library should be passed in spdk_nvme_ctrlr_opts.tls_psk.
spdk_iov_oneThe function is deprecated and will be removed in 24.05 release. Please use SPDK_IOV_ONE macro instead.
spdk_subsystem_init_from_json_configThe function is deprecated and will be removed in 24.09 release. Please use spdk_subsystem_load_config instead.
spdk_nvmf_qpair_disconnectParameters cb_fn and ctx of spdk_nvmf_qpair_disconnect API are deprecated. These parameters will be removed in 24.05 release.
spdk_nvmf_request_exec_fabricsThis function is deprecated and will be removed in the 24.09 release. Instead, users should use spdk_nvmf_request_exec(), which now allows all transports (both fabrics and non-fabrics) to execute fabrics commands.
nvmf_get_subsystemstransport field in listen_addresses of nvmf_get_subsystems RPC is deprecated. trtype field should be used instead. transport field will be removed in 24.05 release.
spdk_nvmf_subsytem_any_listener_allowedThe function is deprecated and will be removed in 24.05 release. Please use spdk_nvmf_subsystem_any_listener_allowed instead.
nvmf_subsystem_add_hostThe ability to specifying path to a PSK file via the psk parameter in nvmf_subsystem_add_host is deprecated and will be removed in the v24.09 release. Instead, the name of a key attached to the keyring should be used.
old_gpt_guidDeprecated the SPDK partition type GUID 7c5222bd-8f5d-4087-9c00-bf9843c7b58c. Partitions of this type have bdevs created that are one block less than the actual size of the partition. Existing partitions using the deprecated GUID can continue to use that GUID; support for the deprecated GUID will remain in SPDK indefinitely, and will continue to exhibit the off-by-one bug so that on-disk metadata layouts based on the incorrect size are not affected.
See GitHub issue 2801 for additional details on the bug.
New SPDK partition types should use GUID 6527994e-2c5a-4eec-9613-8f5944074e8b which will create a bdev of the correct size.
vbdev_lvol_rpc_req_sizeParam size in rpc commands rpc_bdev_lvol_create and rpc_bdev_lvol_resize is deprecated and replace by size_in_mib.
See GitHub issue 2346 for additional details.
spdk_rpc_listen spdk_rpc_accept spdk_rpc_closeThese functions are deprecated and will be removed in 24.09 release. Please use spdk_rpc_server_listen, spdk_rpc_server_accept and spdk_rpc_server_close instead.