Tomasz Zawadzki e72579a6b1 deprecation: VTune support

VTune support was already deprecated in patch below,
this one just formalizes that with SPDK 23.05 removal date.

(6b97cc)bdev, bdev_nvme: deprecate VTUNE support

Change-Id: I09f067a23453f994fa901aa3d82898257aa39a54
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16391
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

2023-01-20 18:25:21 +00:00

1.9 KiB

Raw Blame History

Deprecation

ABI and API Deprecation

This document details the policy for maintaining stability of SPDK ABI and API.

Major ABI version can change at most once for each quarterly 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.

Deprecation Notices

VTune

VTune integration is in now deprecated and will be removed in SPDK 23.05.

nvme

`nvme_ctrlr_prepare_for_reset`

Deprecated spdk_nvme_ctrlr_prepare_for_reset API, which will be removed in SPDK 22.01. For PCIe transport, spdk_nvme_ctrlr_disconnect should be used before freeing I/O qpairs.

bdev

`bdev_register_examine_thread`

Deprecated calling spdk_bdev_register() and spdk_bdev_examine() from a thread other than the app thread. See spdk_thread_get_app_thread(). Starting in SPDK 23.05, calling spdk_bdev_register() or spdk_bdev_examine() from a thread other than the app thread will return an error.

With the removal of this deprecation, calls to vbdev modules' examine_disk() and examine_config() callbacks will happen only on the app thread. This means that vbdev module maintainers will not need to make any changes to examine callbacks that call spdk_bdev_register() on the same thread as the examine callback uses.

1.9 KiB Raw Blame History