1# Deprecation 2 3## ABI and API Deprecation 4 5This document details the policy for maintaining stability of SPDK ABI and API. 6 7Major ABI version can change at most once for each SPDK release. 8ABI versions are managed separately for each library and follow [Semantic Versioning](https://semver.org/). 9 10API and ABI deprecation notices shall be posted in the next section. 11Each entry must describe what will be removed and can suggest the future use or alternative. 12Specific future SPDK release for the removal must be provided. 13ABI cannot be removed without providing deprecation notice for at least single SPDK release. 14 15Deprecated code paths must be registered with `SPDK_DEPRECATION_REGISTER()` and logged with 16`SPDK_LOG_DEPRECATED()`. The tag used with these macros will appear in the SPDK 17log at the warn level when `SPDK_LOG_DEPRECATED()` is called, subject to rate limits. 18The tags can be matched with the level 4 headers below. 19 20## Deprecation Notices 21 22### util 23 24#### `spdk_iov_one` 25 26The function is deprecated and will be removed in 24.05 release. Please use `SPDK_IOV_ONE` 27macro instead. 28 29### nvmf 30 31#### `spdk_nvmf_qpair_disconnect` 32 33Parameters `cb_fn` and `ctx` of `spdk_nvmf_qpair_disconnect` API are deprecated. These parameters 34will be removed in 24.01 release. 35 36#### `nvmf_get_subsystems` 37 38`transport` field in `listen_addresses` of `nvmf_get_subsystems` RPC is deprecated. 39`trtype` field should be used instead. `transport` field will be removed in 24.01 release. 40 41#### 'spdk_nvmf_subsytem_any_listener_allowed' 42 43The function is deprecated and will be removed in 24.01 release. Please use 44'spdk_nvmf_subsystem_any_listener_allowed' instead. 45 46### gpt 47 48#### `old_gpt_guid` 49 50Deprecated the SPDK partition type GUID `7c5222bd-8f5d-4087-9c00-bf9843c7b58c`. Partitions of this 51type have bdevs created that are one block less than the actual size of the partition. Existing 52partitions using the deprecated GUID can continue to use that GUID; support for the deprecated GUID 53will remain in SPDK indefinitely, and will continue to exhibit the off-by-one bug so that on-disk 54metadata layouts based on the incorrect size are not affected. 55 56See GitHub issue [2801](https://github.com/spdk/spdk/issues/2801) for additional details on the bug. 57 58New SPDK partition types should use GUID `6527994e-2c5a-4eec-9613-8f5944074e8b` which will create 59a bdev of the correct size. 60 61### lvol 62 63#### `vbdev_lvol_rpc_req_size` 64 65Param `size` in rpc commands `rpc_bdev_lvol_create` and `rpc_bdev_lvol_resize` is deprecated and 66replace by `size_in_mib`. 67 68See GitHub issue [2346](https://github.com/spdk/spdk/issues/2346) for additional details. 69