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### accel 23 24#### `accel_flags` 25 26The `int flags` parameter in various *submit* and *append* accel FW API is not used and deprecated. It will be removed 27in 24.05 release. 28 29### util 30 31#### `spdk_iov_one` 32 33The function is deprecated and will be removed in 24.05 release. Please use `SPDK_IOV_ONE` 34macro instead. 35 36### init 37 38#### `spdk_subsystem_init_from_json_config` 39 40The function is deprecated and will be removed in 24.09 release. Please use 41`spdk_subsystem_load_config` instead. 42 43### nvmf 44 45#### `spdk_nvmf_qpair_disconnect` 46 47Parameters `cb_fn` and `ctx` of `spdk_nvmf_qpair_disconnect` API are deprecated. These parameters 48will be removed in 24.05 release. 49 50#### `nvmf_get_subsystems` 51 52`transport` field in `listen_addresses` of `nvmf_get_subsystems` RPC is deprecated. 53`trtype` field should be used instead. `transport` field will be removed in 24.05 release. 54 55#### `spdk_nvmf_subsytem_any_listener_allowed` 56 57The function is deprecated and will be removed in 24.05 release. Please use 58`spdk_nvmf_subsystem_any_listener_allowed` instead. 59 60### gpt 61 62#### `old_gpt_guid` 63 64Deprecated the SPDK partition type GUID `7c5222bd-8f5d-4087-9c00-bf9843c7b58c`. Partitions of this 65type have bdevs created that are one block less than the actual size of the partition. Existing 66partitions using the deprecated GUID can continue to use that GUID; support for the deprecated GUID 67will remain in SPDK indefinitely, and will continue to exhibit the off-by-one bug so that on-disk 68metadata layouts based on the incorrect size are not affected. 69 70See GitHub issue [2801](https://github.com/spdk/spdk/issues/2801) for additional details on the bug. 71 72New SPDK partition types should use GUID `6527994e-2c5a-4eec-9613-8f5944074e8b` which will create 73a bdev of the correct size. 74 75### lvol 76 77#### `vbdev_lvol_rpc_req_size` 78 79Param `size` in rpc commands `rpc_bdev_lvol_create` and `rpc_bdev_lvol_resize` is deprecated and 80replace by `size_in_mib`. 81 82See GitHub issue [2346](https://github.com/spdk/spdk/issues/2346) for additional details. 83 84### rpc 85 86#### `spdk_rpc_listen` `spdk_rpc_accept` `spdk_rpc_close` 87 88These functions are deprecated and will be removed in 24.09 release. Please use 89`spdk_rpc_server_listen`, `spdk_rpc_server_accept` and `spdk_rpc_server_close` instead. 90