From 7ad783c8a3c263b521e676ce85ded263db077c50 Mon Sep 17 00:00:00 2001 From: Changpeng Liu Date: Wed, 21 Sep 2022 11:24:30 +0800 Subject: [PATCH] nvmf: declare new added migration APIs are experimental Change-Id: If40b6ec81035bbd8d5e61748c3ff47f928930f74 Signed-off-by: Changpeng Liu Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/14587 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: GangCao Reviewed-by: Tomasz Zawadzki --- include/spdk/nvmf_transport.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/include/spdk/nvmf_transport.h b/include/spdk/nvmf_transport.h index 52b76b614..8550cd5e5 100644 --- a/include/spdk/nvmf_transport.h +++ b/include/spdk/nvmf_transport.h @@ -487,7 +487,12 @@ struct spdk_nvmf_ctrlr_feat { }; SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ctrlr_feat) == 40, "Incorrect size"); -/* Migration data structure used to save & restore a NVMe-oF controller. */ +/* + * Migration data structure used to save & restore a NVMe-oF controller. + * + * The data structure is experimental. + * + */ struct spdk_nvmf_ctrlr_migr_data { /* `data_size` is valid size of `spdk_nvmf_ctrlr_migr_data` without counting `unused`. * We use this field to migrate `spdk_nvmf_ctrlr_migr_data` from source VM and restore @@ -528,6 +533,8 @@ SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ctrlr_migr_data) == 4096, "Incorrect /** * Save the NVMe-oF controller state and configuration. * + * The API is experimental. + * * It is allowed to save the data only when the nvmf subystem is in paused * state i.e. there are no outstanding cmds in nvmf layer (other than aer), * pending async event completions are getting blocked. @@ -546,6 +553,8 @@ int spdk_nvmf_ctrlr_save_migr_data(struct spdk_nvmf_ctrlr *ctrlr, /** * Restore the NVMe-oF controller state and configuration. * + * The API is experimental. + * * It is allowed to restore the data only when the nvmf subystem is in paused * state. *