rpc: Rename delete_pmem_bdev to bdev_pmem_delete

Change-Id: I7d946e1ab695ac230c1db1ba74d05df542f4c993
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466706
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>

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}
 

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
 }
 ~~~

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;

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):
+    def bdev_pmem_delete(args):
-        rpc.bdev.delete_pmem_bdev(args.client,
+        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,

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):

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)

scripts/spdkcli/ui_root.py

@@ -225,8 +225,8 @@ class UIRoot(UINode):
         return response
 
     @verbose
-    def delete_pmem_bdev(self, **kwargs):
+    def bdev_pmem_delete(self, **kwargs):
-        response = rpc.bdev.delete_pmem_bdev(self.client, **kwargs)
+        response = rpc.bdev.bdev_pmem_delete(self.client, **kwargs)
         return response
 
     @verbose

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

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",

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

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
+	if $rpc_py bdev_pmem_delete $pmem_bdev_name; then
-		error "delete_pmem_bdev deleted pmem bdev for second time!"
+		error "bdev_pmem_delete deleted pmem bdev for second time!"
 	fi
 
 	pmem_clean_pool_file

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