From 9d06166f5b47a9d2382e93f40db35dfcba86d438 Mon Sep 17 00:00:00 2001 From: Mike Gerdts Date: Thu, 1 Dec 2022 23:20:01 -0600 Subject: [PATCH] nvme: annotate and log existing deprecation Use the deprecation API to annotate and log the deprecation of spdk_nvme_ctrlr_prepare_for_reset() using the tag "nvme_ctrlr_prepare_for_reset". Signed-off-by: Mike Gerdts Change-Id: I98fd840aa9acc028a49bb47daf4ab7e88f1eb818 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15756 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Aleksey Marchuk Reviewed-by: Ben Walker --- deprecation.md | 2 ++ lib/nvme/nvme_ctrlr.c | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/deprecation.md b/deprecation.md index 0efa16b78..88adb2df5 100644 --- a/deprecation.md +++ b/deprecation.md @@ -21,5 +21,7 @@ The tags can be matched with the level 4 headers below. ### 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. diff --git a/lib/nvme/nvme_ctrlr.c b/lib/nvme/nvme_ctrlr.c index 5ce7b1f3e..98b2a57ac 100644 --- a/lib/nvme/nvme_ctrlr.c +++ b/lib/nvme/nvme_ctrlr.c @@ -1831,9 +1831,14 @@ spdk_nvme_ctrlr_reset(struct spdk_nvme_ctrlr *ctrlr) return rc; } +SPDK_LOG_DEPRECATION_REGISTER(nvme_ctrlr_prepare_for_reset, + "spdk_nvme_ctrlr_prepare_for_reset() is deprecated", + "SPDK 22.01", 0); + void spdk_nvme_ctrlr_prepare_for_reset(struct spdk_nvme_ctrlr *ctrlr) { + SPDK_LOG_DEPRECATED(nvme_ctrlr_prepare_for_reset); nvme_robust_mutex_lock(&ctrlr->ctrlr_lock); ctrlr->prepare_for_reset = true; nvme_robust_mutex_unlock(&ctrlr->ctrlr_lock);