From 568ce213bbd05d3afd6f0b61245087b1473986e6 Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Thu, 29 Aug 2019 06:19:03 -0400 Subject: [PATCH] rpc: Rename delete_pmem_bdev to bdev_pmem_delete Change-Id: I7d946e1ab695ac230c1db1ba74d05df542f4c993 Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466706 Tested-by: SPDK CI Jenkins Reviewed-by: Broadcom SPDK FC-NVMe CI Reviewed-by: Ben Walker Reviewed-by: Jim Harris --- doc/bdev.md | 4 ++-- doc/jsonrpc.md | 4 ++-- module/bdev/pmem/bdev_pmem_rpc.c | 9 +++++---- scripts/rpc.py | 9 +++++---- scripts/rpc/bdev.py | 5 +++-- scripts/spdkcli/ui_node.py | 2 +- scripts/spdkcli/ui_root.py | 4 ++-- test/iscsi_tgt/pmem/iscsi_pmem.sh | 2 +- test/json_config/clear_config.py | 2 +- test/json_config/json_config.sh | 2 +- test/pmem/pmem.sh | 14 +++++++------- test/pmem/test_plan.md | 16 ++++++++-------- 12 files changed, 38 insertions(+), 35 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 7b2f9e99e..bff74f73f 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -534,9 +534,9 @@ Example command `rpc.py bdev_pmem_create /path/to/pmem_pool -n pmem` -To remove a block device representation use the delete_pmem_bdev command. +To remove a block device representation use the bdev_pmem_delete command. -`rpc.py delete_pmem_bdev pmem` +`rpc.py bdev_pmem_delete pmem` # Virtio Block {#bdev_config_virtio_blk} diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index b6520637c..86a5cf071 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -2274,7 +2274,7 @@ Example response: } ~~~ -## delete_pmem_bdev {#rpc_delete_pmem_bdev} +## bdev_pmem_delete {#rpc_bdev_pmem_delete} Delete @ref bdev_config_pmem bdev. This call will not remove backing pool files. @@ -2300,7 +2300,7 @@ Example request: "name": "Pmem0" }, "jsonrpc": "2.0", - "method": "delete_pmem_bdev", + "method": "bdev_pmem_delete", "id": 1 } ~~~ diff --git a/module/bdev/pmem/bdev_pmem_rpc.c b/module/bdev/pmem/bdev_pmem_rpc.c index aa1b2f14b..3669f6789 100644 --- a/module/bdev/pmem/bdev_pmem_rpc.c +++ b/module/bdev/pmem/bdev_pmem_rpc.c @@ -104,7 +104,7 @@ static const struct spdk_json_object_decoder rpc_delete_pmem_decoders[] = { }; static void -_spdk_rpc_delete_pmem_bdev_cb(void *cb_arg, int bdeverrno) +_spdk_rpc_bdev_pmem_delete_cb(void *cb_arg, int bdeverrno) { struct spdk_jsonrpc_request *request = cb_arg; struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request); @@ -114,7 +114,7 @@ _spdk_rpc_delete_pmem_bdev_cb(void *cb_arg, int bdeverrno) } static void -spdk_rpc_delete_pmem_bdev(struct spdk_jsonrpc_request *request, +spdk_rpc_bdev_pmem_delete(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params) { struct rpc_delete_pmem req = {NULL}; @@ -135,12 +135,13 @@ spdk_rpc_delete_pmem_bdev(struct spdk_jsonrpc_request *request, goto cleanup; } - spdk_delete_pmem_disk(bdev, _spdk_rpc_delete_pmem_bdev_cb, request); + spdk_delete_pmem_disk(bdev, _spdk_rpc_bdev_pmem_delete_cb, request); cleanup: free_rpc_delete_pmem(&req); } -SPDK_RPC_REGISTER("delete_pmem_bdev", spdk_rpc_delete_pmem_bdev, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("bdev_pmem_delete", spdk_rpc_bdev_pmem_delete, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_pmem_delete, delete_pmem_bdev) struct rpc_create_pmem_pool { char *pmem_file; diff --git a/scripts/rpc.py b/scripts/rpc.py index 80163208c..91bcb587f 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -540,13 +540,14 @@ if __name__ == "__main__": p.add_argument('-n', '--name', help='Block device name', required=True) p.set_defaults(func=bdev_pmem_create) - def delete_pmem_bdev(args): - rpc.bdev.delete_pmem_bdev(args.client, + def bdev_pmem_delete(args): + rpc.bdev.bdev_pmem_delete(args.client, name=args.name) - p = subparsers.add_parser('delete_pmem_bdev', help='Delete a pmem bdev') + p = subparsers.add_parser('bdev_pmem_delete', aliases=['delete_pmem_bdev'], + help='Delete a pmem bdev') p.add_argument('name', help='pmem bdev name') - p.set_defaults(func=delete_pmem_bdev) + p.set_defaults(func=bdev_pmem_delete) def construct_passthru_bdev(args): print_json(rpc.bdev.construct_passthru_bdev(args.client, diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index d02232444..814f31bff 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -596,14 +596,15 @@ def bdev_pmem_create(client, pmem_file, name): return client.call('bdev_pmem_create', params) -def delete_pmem_bdev(client, name): +@deprecated_alias('delete_pmem_bdev') +def bdev_pmem_delete(client, name): """Remove pmem bdev from the system. Args: name: name of pmem bdev to delete """ params = {'name': name} - return client.call('delete_pmem_bdev', params) + return client.call('bdev_pmem_delete', params) def construct_passthru_bdev(client, base_bdev_name, name): diff --git a/scripts/spdkcli/ui_node.py b/scripts/spdkcli/ui_node.py index fd2734b57..5e1f9a0fb 100644 --- a/scripts/spdkcli/ui_node.py +++ b/scripts/spdkcli/ui_node.py @@ -423,7 +423,7 @@ class UIPmemBdev(UIBdev): UIBdev.__init__(self, "pmemblk", parent) def delete(self, name): - self.get_root().delete_pmem_bdev(name=name) + self.get_root().bdev_pmem_delete(name=name) def ui_command_create_pmem_pool(self, pmem_file, total_size, block_size): total_size = self.ui_eval_param(total_size, "number", None) diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index f56659bdb..48354d908 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -225,8 +225,8 @@ class UIRoot(UINode): return response @verbose - def delete_pmem_bdev(self, **kwargs): - response = rpc.bdev.delete_pmem_bdev(self.client, **kwargs) + def bdev_pmem_delete(self, **kwargs): + response = rpc.bdev.bdev_pmem_delete(self.client, **kwargs) return response @verbose diff --git a/test/iscsi_tgt/pmem/iscsi_pmem.sh b/test/iscsi_tgt/pmem/iscsi_pmem.sh index c02e08552..4288a1a0b 100755 --- a/test/iscsi_tgt/pmem/iscsi_pmem.sh +++ b/test/iscsi_tgt/pmem/iscsi_pmem.sh @@ -60,7 +60,7 @@ timing_exit fio_test iscsicleanup for pmem in $PMEM_BDEVS; do - $rpc_py delete_pmem_bdev $pmem + $rpc_py bdev_pmem_delete $pmem done for i in $(seq 1 $TGT_NR); do diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index c04a59c29..8429709e1 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -34,7 +34,7 @@ def get_bdev_destroy_method(bdev): destroy_method_map = {'bdev_malloc_create': "delete_malloc_bdev", 'bdev_null_create': "bdev_null_delete", 'construct_rbd_bdev': "delete_rbd_bdev", - 'bdev_pmem_create': "delete_pmem_bdev", + 'bdev_pmem_create': "bdev_pmem_delete", 'bdev_aio_create': "bdev_aio_delete", 'bdev_error_create': "bdev_error_delete", 'construct_split_vbdev': "destruct_split_vbdev", diff --git a/test/json_config/json_config.sh b/test/json_config/json_config.sh index 8c396b752..4e73029cd 100755 --- a/test/json_config/json_config.sh +++ b/test/json_config/json_config.sh @@ -263,7 +263,7 @@ function cleanup_bdev_subsystem_config() { fi if [[ $SPDK_TEST_PMDK -eq 1 && -n "$pmem_pool_file" && -f "$pmem_pool_file" ]]; then - tgt_rpc delete_pmem_bdev pmem1 + tgt_rpc bdev_pmem_delete pmem1 tgt_rpc delete_pmem_pool $pmem_pool_file rm -f $pmem_pool_file fi diff --git a/test/pmem/pmem.sh b/test/pmem/pmem.sh index bed7b2aa4..168622916 100755 --- a/test/pmem/pmem.sh +++ b/test/pmem/pmem.sh @@ -533,7 +533,7 @@ function bdev_pmem_create_tc5() error "Pmem bdev not found!" fi - if ! $rpc_py delete_pmem_bdev $pmem_bdev_name; then + if ! $rpc_py bdev_pmem_delete $pmem_bdev_name; then error "Failed to delete pmem bdev!" fi @@ -569,7 +569,7 @@ function bdev_pmem_create_tc6() error "Constructed pmem bdev with occupied path!" fi - if ! $rpc_py delete_pmem_bdev $pmem_bdev_name; then + if ! $rpc_py bdev_pmem_delete $pmem_bdev_name; then error "Failed to delete pmem bdev!" fi @@ -582,7 +582,7 @@ function bdev_pmem_create_tc6() } #================================================ -# delete_pmem_bdev tests +# bdev_pmem_delete tests #================================================ function delete_bdev_tc1() { @@ -605,7 +605,7 @@ function delete_bdev_tc1() error "$pmem_bdev_name bdev not found!" fi - if ! $rpc_py delete_pmem_bdev $pmem_bdev_name; then + if ! $rpc_py bdev_pmem_delete $pmem_bdev_name; then error "Failed to delete $pmem_bdev_name bdev!" fi @@ -638,12 +638,12 @@ function delete_bdev_tc2() error "Pmem bdev not found!" fi - if ! $rpc_py delete_pmem_bdev $pmem_bdev_name; then + if ! $rpc_py bdev_pmem_delete $pmem_bdev_name; then error "Failed to delete pmem bdev!" fi - if $rpc_py delete_pmem_bdev $pmem_bdev_name; then - error "delete_pmem_bdev deleted pmem bdev for second time!" + if $rpc_py bdev_pmem_delete $pmem_bdev_name; then + error "bdev_pmem_delete deleted pmem bdev for second time!" fi pmem_clean_pool_file diff --git a/test/pmem/test_plan.md b/test/pmem/test_plan.md index 8759cd24b..65a662fde 100644 --- a/test/pmem/test_plan.md +++ b/test/pmem/test_plan.md @@ -241,7 +241,7 @@ Steps & expected results: - call bdev_pmem_create with with correct arguments to create a pmem bdev - return code = 0, no errors - using get_bdevs check that pmem bdev was created -- delete pmem bdev using delete_pmem_bdev +- delete pmem bdev using bdev_pmem_delete - return code = 0, no error code - delete previously created pmem pool - return code = 0, no error code @@ -258,15 +258,15 @@ Steps & expected results: - using get_bdevs check that pmem bdev was created - call bdev_pmem_create again on the same pmem file - return code != 0, error code = EEXIST -- delete pmem bdev using delete_pmem_bdev +- delete pmem bdev using bdev_pmem_delete - return code = 0, no error code - delete previously created pmem pool - return code = 0, no error code -### delete_pmem_bdev +### bdev_pmem_delete #### delete_bdev_tc1 -Positive test for deleting pmem bdevs using delete_pmem_bdev call. +Positive test for deleting pmem bdevs using bdev_pmem_delete call. Steps & expected results: - construct malloc and aio bdevs (also NVMe if possible) - all calls - return code = 0, no errors; bdevs created @@ -278,12 +278,12 @@ block size=512, total size=256M - call bdev_pmem_create and create a pmem bdev - return code = 0, no errors - using get_bdevs check that pmem bdev was created -- delete pmem bdev using delete_pmem_bdev +- delete pmem bdev using bdev_pmem_delete - return code = 0, no errors - using get_bdevs confirm that pmem bdev was deleted and other bdevs were unaffected. -#### delete_pmem_bdev_tc2 +#### bdev_pmem_delete_tc2 Negative test for deleting pmem bdev twice. Steps & expected results: - call create_pmem_pool with correct path argument, @@ -294,10 +294,10 @@ block size=512, total size=256M - call bdev_pmem_create and create a pmem bdev - return code = 0, no errors - using get_bdevs check that pmem bdev was created -- delete pmem bdev using delete_pmem_bdev +- delete pmem bdev using bdev_pmem_delete - return code = 0, no errors - using get_bdevs confirm that pmem bdev was deleted -- delete pmem bdev using delete_pmem_bdev second time +- delete pmem bdev using bdev_pmem_delete second time - return code != 0, error code = ENODEV