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 quarterly 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### nvmf 23 24#### `spdk_nvmf_qpair_disconnect` 25 26Parameters `cb_fn` and `ctx` of `spdk_nvmf_qpair_disconnect` API are deprecated. These parameters 27will be removed in 24.01 release. 28 29#### `nvmf_get_subsystems` 30 31`transport` field in `listen_addresses` of `nvmf_get_subsystems` RPC is deprecated. 32`trtype` field should be used instead. `transport` field will be removed in 24.01 release. 33 34#### 'spdk_nvmf_subsytem_any_listener_allowed' 35 36The function is deprecated and will be removed in 24.01 release. Please use 37'spdk_nvmf_subsystem_any_listener_allowed' instead. 38 39### gpt 40 41#### `old_gpt_guid` 42 43Deprecated the SPDK partition type GUID `7c5222bd-8f5d-4087-9c00-bf9843c7b58c`. Partitions of this 44type have bdevs created that are one block less than the actual size of the partition. Existing 45partitions using the deprecated GUID can continue to use that GUID; support for the deprecated GUID 46will remain in SPDK indefinitely, and will continue to exhibit the off-by-one bug so that on-disk 47metadata layouts based on the incorrect size are not affected. 48 49See GitHub issue [2801](https://github.com/spdk/spdk/issues/2801) for additional details on the bug. 50 51New SPDK partition types should use GUID `6527994e-2c5a-4eec-9613-8f5944074e8b` which will create 52a bdev of the correct size. 53 54### lvol 55 56#### `vbdev_lvol_rpc_req_size` 57 58Param `size` in rpc commands `rpc_bdev_lvol_create` and `rpc_bdev_lvol_resize` is deprecated and 59replace by `size_in_mib`. 60 61See GitHub issue [2346](https://github.com/spdk/spdk/issues/2346) for additional details. 62