From 31e77a733157ef78e4365f3195b155598c799c82 Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Fri, 23 Aug 2019 11:12:13 -0400 Subject: [PATCH] rpc: Rename delete_nvme_controller to bdev_nvme_detach_controller Change-Id: I1402fcb24a779e7af3d108c91a0abcc09082410b Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466144 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto Reviewed-by: Tomasz Zawadzki --- doc/bdev.md | 6 ++--- doc/jsonrpc.md | 8 +++---- module/bdev/nvme/bdev_nvme_rpc.c | 24 ++++++++++--------- scripts/rpc.py | 12 +++++----- scripts/rpc/bdev.py | 7 +++--- scripts/spdkcli/ui_node.py | 2 +- scripts/spdkcli/ui_root.py | 4 ++-- test/iscsi_tgt/ext4test/ext4test.sh | 2 +- test/iscsi_tgt/filesystem/filesystem.sh | 2 +- .../multiconnection/multiconnection.sh | 2 +- test/json_config/clear_config.py | 2 +- test/nvmf/host/fio.sh | 2 +- test/vhost/hotplug/common.sh | 2 +- test/vhost/initiator/blockdev.sh | 2 +- test/vhost/integrity/integrity_start.sh | 2 +- test/vhost/migration/migration-tc2.sh | 2 +- test/vhost/migration/migration-tc3a.sh | 2 +- test/vhost/migration/migration-tc3b.sh | 2 +- test/vhost/readonly/readonly.sh | 2 +- 19 files changed, 45 insertions(+), 42 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 6b394d6c0..8c2af3d7b 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -405,11 +405,11 @@ This command will create NVMe bdev of physical device in the system. This command will create NVMe bdev of NVMe-oF resource. -To remove a NVMe controller use the delete_nvme_controller command. +To remove an NVMe controller use the bdev_nvme_detach_controller command. -`rpc.py delete_nvme_controller Nvme0` +`rpc.py bdev_nvme_detach_controller Nvme0` -This command will remove NVMe controller named Nvme0. +This command will remove NVMe bdev named Nvme0. # Logical volumes {#bdev_ug_logical_volumes} diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index b79301860..251991d99 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -293,7 +293,7 @@ Example response: "bdev_passthru_create", "bdev_passthru_delete" "bdev_nvme_apply_firmware", - "delete_nvme_controller", + "bdev_nvme_detach_controller", "bdev_nvme_attach_controller", "bdev_null_create", "bdev_malloc_delete", @@ -1592,9 +1592,9 @@ Example response: } ~~~ -## delete_nvme_controller {#rpc_delete_nvme_controller} +## bdev_nvme_detach_controller {#rpc_bdev_nvme_detach_controller} -Delete NVMe controller. +Detach NVMe controller and delete any associated bdevs. ### Parameters @@ -1612,7 +1612,7 @@ Example requests: "name": "Nvme0" }, "jsonrpc": "2.0", - "method": "delete_nvme_controller", + "method": "bdev_nvme_detach_controller", "id": 1 } ~~~ diff --git a/module/bdev/nvme/bdev_nvme_rpc.c b/module/bdev/nvme/bdev_nvme_rpc.c index 6ef9ff233..6a83b2b16 100644 --- a/module/bdev/nvme/bdev_nvme_rpc.c +++ b/module/bdev/nvme/bdev_nvme_rpc.c @@ -413,30 +413,30 @@ cleanup: SPDK_RPC_REGISTER("bdev_nvme_get_controllers", spdk_rpc_bdev_nvme_get_controllers, SPDK_RPC_RUNTIME) SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_get_controllers, get_nvme_controllers) -struct rpc_delete_nvme { +struct rpc_bdev_nvme_detach_controller { char *name; }; static void -free_rpc_delete_nvme(struct rpc_delete_nvme *req) +free_rpc_bdev_nvme_detach_controller(struct rpc_bdev_nvme_detach_controller *req) { free(req->name); } -static const struct spdk_json_object_decoder rpc_delete_nvme_decoders[] = { - {"name", offsetof(struct rpc_delete_nvme, name), spdk_json_decode_string}, +static const struct spdk_json_object_decoder rpc_bdev_nvme_detach_controller_decoders[] = { + {"name", offsetof(struct rpc_bdev_nvme_detach_controller, name), spdk_json_decode_string}, }; static void -spdk_rpc_delete_nvme_controller(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_bdev_nvme_detach_controller(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { - struct rpc_delete_nvme req = {NULL}; + struct rpc_bdev_nvme_detach_controller req = {NULL}; struct spdk_json_write_ctx *w; int rc = 0; - if (spdk_json_decode_object(params, rpc_delete_nvme_decoders, - SPDK_COUNTOF(rpc_delete_nvme_decoders), + if (spdk_json_decode_object(params, rpc_bdev_nvme_detach_controller_decoders, + SPDK_COUNTOF(rpc_bdev_nvme_detach_controller_decoders), &req)) { spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, "spdk_json_decode_object failed"); @@ -454,9 +454,11 @@ spdk_rpc_delete_nvme_controller(struct spdk_jsonrpc_request *request, spdk_jsonrpc_end_result(request, w); cleanup: - free_rpc_delete_nvme(&req); + free_rpc_bdev_nvme_detach_controller(&req); } -SPDK_RPC_REGISTER("delete_nvme_controller", spdk_rpc_delete_nvme_controller, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("bdev_nvme_detach_controller", spdk_rpc_bdev_nvme_detach_controller, + SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_detach_controller, delete_nvme_controller) struct rpc_apply_firmware { char *filename; diff --git a/scripts/rpc.py b/scripts/rpc.py index 9d668aa22..f24930496 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -421,14 +421,14 @@ if __name__ == "__main__": p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False) p.set_defaults(func=bdev_nvme_get_controllers) - def delete_nvme_controller(args): - rpc.bdev.delete_nvme_controller(args.client, - name=args.name) + def bdev_nvme_detach_controller(args): + rpc.bdev.bdev_nvme_detach_controller(args.client, + name=args.name) - p = subparsers.add_parser('delete_nvme_controller', - help='Delete a NVMe controller using controller name') + p = subparsers.add_parser('bdev_nvme_detach_controller', aliases=['delete_nvme_controller'], + help='Detach an NVMe controller and delete any associated bdevs') p.add_argument('name', help="Name of the controller") - p.set_defaults(func=delete_nvme_controller) + p.set_defaults(func=bdev_nvme_detach_controller) def bdev_rbd_create(args): config = None diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index ecde32e17..0fa270da7 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -444,15 +444,16 @@ def bdev_nvme_attach_controller(client, name, trtype, traddr, adrfam=None, trsvc return client.call('bdev_nvme_attach_controller', params) -def delete_nvme_controller(client, name): - """Remove NVMe controller from the system. +@deprecated_alias('delete_nvme_controller') +def bdev_nvme_detach_controller(client, name): + """Detach NVMe controller and delete any associated bdevs. Args: name: controller name """ params = {'name': name} - return client.call('delete_nvme_controller', params) + return client.call('bdev_nvme_detach_controller', params) @deprecated_alias('construct_rbd_bdev') diff --git a/scripts/spdkcli/ui_node.py b/scripts/spdkcli/ui_node.py index 22c2b846f..31fbfe001 100644 --- a/scripts/spdkcli/ui_node.py +++ b/scripts/spdkcli/ui_node.py @@ -284,7 +284,7 @@ class UINvmeBdev(UIBdev): UIBdev.__init__(self, "nvme", parent) def delete(self, name): - self.get_root().delete_nvme_controller(name=name) + self.get_root().bdev_nvme_detach_controller(name=name) def ui_command_create(self, name, trtype, traddr, adrfam=None, trsvcid=None, subnqn=None): diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index 2af3ad7da..d75ce6788 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -168,8 +168,8 @@ class UIRoot(UINode): return response @verbose - def delete_nvme_controller(self, **kwargs): - rpc.bdev.delete_nvme_controller(self.client, **kwargs) + def bdev_nvme_detach_controller(self, **kwargs): + rpc.bdev.bdev_nvme_detach_controller(self.client, **kwargs) @verbose def bdev_null_create(self, **kwargs): diff --git a/test/iscsi_tgt/ext4test/ext4test.sh b/test/iscsi_tgt/ext4test/ext4test.sh index 3906966e2..3302b6209 100755 --- a/test/iscsi_tgt/ext4test/ext4test.sh +++ b/test/iscsi_tgt/ext4test/ext4test.sh @@ -126,7 +126,7 @@ $rpc_py bdev_split_delete Nvme0n1 $rpc_py bdev_error_delete EE_Malloc0 if [ -z "$NO_NVME" ]; then - $rpc_py delete_nvme_controller Nvme0 + $rpc_py bdev_nvme_detach_controller Nvme0 fi killprocess $pid diff --git a/test/iscsi_tgt/filesystem/filesystem.sh b/test/iscsi_tgt/filesystem/filesystem.sh index a35e8781a..b1de2fc43 100755 --- a/test/iscsi_tgt/filesystem/filesystem.sh +++ b/test/iscsi_tgt/filesystem/filesystem.sh @@ -22,7 +22,7 @@ function remove_backends() { $rpc_py bdev_lvol_delete_lvstore -l lvs_0 echo "INFO: Removing NVMe" - $rpc_py delete_nvme_controller Nvme0 + $rpc_py bdev_nvme_detach_controller Nvme0 return 0 } diff --git a/test/iscsi_tgt/multiconnection/multiconnection.sh b/test/iscsi_tgt/multiconnection/multiconnection.sh index 3771e98e9..1fccbd0ca 100755 --- a/test/iscsi_tgt/multiconnection/multiconnection.sh +++ b/test/iscsi_tgt/multiconnection/multiconnection.sh @@ -29,7 +29,7 @@ function remove_backends() { echo "INFO: lvol store lvs0 removed" echo "INFO: Removing NVMe" - $rpc_py delete_nvme_controller Nvme0 + $rpc_py bdev_nvme_detach_controller Nvme0 return 0 } diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index 550ec9937..309d00375 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -64,7 +64,7 @@ def clear_bdev_subsystem(args, bdev_config): nvme_controllers = args.client.call("bdev_nvme_get_controllers") for ctrlr in nvme_controllers: - args.client.call('delete_nvme_controller', {'name': ctrlr['name']}) + args.client.call('bdev_nvme_detach_controller', {'name': ctrlr['name']}) ''' Disable and reset hotplug ''' rpc.bdev.bdev_nvme_set_hotplug(args.client, False) diff --git a/test/nvmf/host/fio.sh b/test/nvmf/host/fio.sh index 267df68f8..22c033e76 100755 --- a/test/nvmf/host/fio.sh +++ b/test/nvmf/host/fio.sh @@ -74,7 +74,7 @@ if [ $RUN_NIGHTLY -eq 1 ]; then $rpc_py bdev_lvol_delete_lvstore -l lvs_n_0 $rpc_py bdev_lvol_delete lvs_0/lbd_0 $rpc_py bdev_lvol_delete_lvstore -l lvs_0 - $rpc_py delete_nvme_controller Nvme0 + $rpc_py bdev_nvme_detach_controller Nvme0 fi trap - SIGINT SIGTERM EXIT diff --git a/test/vhost/hotplug/common.sh b/test/vhost/hotplug/common.sh index ca85eaa0a..833f74315 100644 --- a/test/vhost/hotplug/common.sh +++ b/test/vhost/hotplug/common.sh @@ -215,7 +215,7 @@ function get_traddr() { } function delete_nvme() { - $rpc_py delete_nvme_controller $1 + $rpc_py bdev_nvme_detach_controller $1 } function add_nvme() { diff --git a/test/vhost/initiator/blockdev.sh b/test/vhost/initiator/blockdev.sh index 5e3868b6a..6e66a0f33 100755 --- a/test/vhost/initiator/blockdev.sh +++ b/test/vhost/initiator/blockdev.sh @@ -107,7 +107,7 @@ run_spdk_fio $testdir/bdev.fio --filename=$virtio_with_unmap --spdk_conf=$testdi --spdk_conf=$testdir/bdev.conf timing_exit run_spdk_fio_unmap -$RPC_PY delete_nvme_controller Nvme0 +$RPC_PY bdev_nvme_detach_controller Nvme0 timing_enter vhost_kill vhost_kill 0 diff --git a/test/vhost/integrity/integrity_start.sh b/test/vhost/integrity/integrity_start.sh index 7efad72c6..2277997ae 100755 --- a/test/vhost/integrity/integrity_start.sh +++ b/test/vhost/integrity/integrity_start.sh @@ -95,7 +95,7 @@ vm_shutdown_all clean_lvol_cfg -$rpc_py delete_nvme_controller Nvme0 +$rpc_py bdev_nvme_detach_controller Nvme0 notice "Shutting down SPDK vhost app..." vhost_kill 0 diff --git a/test/vhost/migration/migration-tc2.sh b/test/vhost/migration/migration-tc2.sh index e5b47060e..216235a14 100644 --- a/test/vhost/migration/migration-tc2.sh +++ b/test/vhost/migration/migration-tc2.sh @@ -45,7 +45,7 @@ function migration_tc2_cleanup_vhost_config() notice "Removing vhost devices & controllers via RPC ..." # Delete bdev first to remove all LUNs and SCSI targets - $rpc_0 delete_nvme_controller Nvme0 + $rpc_0 bdev_nvme_detach_controller Nvme0 $rpc_0 vhost_delete_controller $incoming_vm_ctrlr $rpc_1 delete_nvme_controller Nvme0 diff --git a/test/vhost/migration/migration-tc3a.sh b/test/vhost/migration/migration-tc3a.sh index 2825aa697..8576096af 100644 --- a/test/vhost/migration/migration-tc3a.sh +++ b/test/vhost/migration/migration-tc3a.sh @@ -84,7 +84,7 @@ function host1_cleanup_vhost() vm_kill $incoming_vm notice "Removing bdev & controller from vhost on local server" - $rpc_0 delete_nvme_controller Nvme0 + $rpc_0 bdev_nvme_detach_controller Nvme0 $rpc_0 vhost_delete_controller $incoming_vm_ctrlr notice "Shutting down vhost app" diff --git a/test/vhost/migration/migration-tc3b.sh b/test/vhost/migration/migration-tc3b.sh index 9c3dc5f2a..3ac21b582 100644 --- a/test/vhost/migration/migration-tc3b.sh +++ b/test/vhost/migration/migration-tc3b.sh @@ -16,7 +16,7 @@ function host_2_cleanup_vhost() vm_kill $target_vm notice "Removing bdev & controller from vhost 1 on remote server" - $rpc delete_nvme_controller Nvme0 + $rpc bdev_nvme_detach_controller Nvme0 $rpc vhost_delete_controller $target_vm_ctrl notice "Shutting down vhost app" diff --git a/test/vhost/readonly/readonly.sh b/test/vhost/readonly/readonly.sh index 4325b6161..c4a8908a0 100755 --- a/test/vhost/readonly/readonly.sh +++ b/test/vhost/readonly/readonly.sh @@ -127,7 +127,7 @@ fi blk_ro_tc1 -$rpc_py delete_nvme_controller Nvme0 +$rpc_py bdev_nvme_detach_controller Nvme0 vhost_kill 0