RPC: rename rpc rename_lvol_store to bdev_lvol_rename_lvstore

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I07e5b1b6a1f6c4895f9fa8f4f5837080a43f6774
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466747
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>

doc/jsonrpc.md

@@ -310,7 +310,7 @@ Example response:
     "bdev_lvol_snapshot",
     "bdev_lvol_create",
     "bdev_lvol_delete_lvstore",
-    "rename_lvol_store",
+    "bdev_lvol_rename_lvstore",
     "construct_lvol_store"
   ]
 }
@@ -4901,7 +4901,7 @@ Example response:
 }
 ~~~
 
-## rename_lvol_store {#rpc_rename_lvol_store}
+## bdev_lvol_rename_lvstore {#rpc_bdev_lvol_rename_lvstore}
 
 Rename a logical volume store.
 
@@ -4919,7 +4919,7 @@ Example request:
 ~~~
 {
   "jsonrpc": "2.0",
-  "method": "rename_lvol_store",
+  "method": "bdev_lvol_rename_lvstore",
   "id": 1,
   "params": {
     "old_name": "LVS0",

doc/lvol.md

@@ -103,7 +103,7 @@ bdev_lvol_get_lvstores [-h] [-u UUID] [-l LVS_NAME]
     -h, --help  show help
     -u UUID, --uuid UUID  show details of specified lvol store
     -l LVS_NAME, --lvs_name LVS_NAME  show details of specified lvol store
-rename_lvol_store [-h] old_name new_name
+bdev_lvol_rename_lvstore [-h] old_name new_name
     Change logical volume store name
     optional arguments:
     -h, --help  show this help message and exit

module/bdev/lvol/vbdev_lvol_rpc.c

@@ -170,25 +170,25 @@ cleanup:
 }
 SPDK_RPC_REGISTER("construct_lvol_store", spdk_rpc_construct_lvol_store, SPDK_RPC_RUNTIME)
 
-struct rpc_rename_lvol_store {
+struct rpc_bdev_lvol_rename_lvstore {
 	char *old_name;
 	char *new_name;
 };
 
 static void
-free_rpc_rename_lvol_store(struct rpc_rename_lvol_store *req)
+free_rpc_bdev_lvol_rename_lvstore(struct rpc_bdev_lvol_rename_lvstore *req)
 {
 	free(req->old_name);
 	free(req->new_name);
 }
 
-static const struct spdk_json_object_decoder rpc_rename_lvol_store_decoders[] = {
+static const struct spdk_json_object_decoder rpc_bdev_lvol_rename_lvstore_decoders[] = {
-	{"old_name", offsetof(struct rpc_rename_lvol_store, old_name), spdk_json_decode_string},
+	{"old_name", offsetof(struct rpc_bdev_lvol_rename_lvstore, old_name), spdk_json_decode_string},
-	{"new_name", offsetof(struct rpc_rename_lvol_store, new_name), spdk_json_decode_string},
+	{"new_name", offsetof(struct rpc_bdev_lvol_rename_lvstore, new_name), spdk_json_decode_string},
 };
 
 static void
-_spdk_rpc_rename_lvol_store_cb(void *cb_arg, int lvserrno)
+_spdk_rpc_bdev_lvol_rename_lvstore_cb(void *cb_arg, int lvserrno)
 {
 	struct spdk_json_write_ctx *w;
 	struct spdk_jsonrpc_request *request = cb_arg;
@@ -208,14 +208,14 @@ invalid:
 }
 
 static void
-spdk_rpc_rename_lvol_store(struct spdk_jsonrpc_request *request,
+spdk_rpc_bdev_lvol_rename_lvstore(struct spdk_jsonrpc_request *request,
-			   const struct spdk_json_val *params)
+				  const struct spdk_json_val *params)
 {
-	struct rpc_rename_lvol_store req = {};
+	struct rpc_bdev_lvol_rename_lvstore req = {};
 	struct spdk_lvol_store *lvs;
 
-	if (spdk_json_decode_object(params, rpc_rename_lvol_store_decoders,
+	if (spdk_json_decode_object(params, rpc_bdev_lvol_rename_lvstore_decoders,
-				    SPDK_COUNTOF(rpc_rename_lvol_store_decoders),
+				    SPDK_COUNTOF(rpc_bdev_lvol_rename_lvstore_decoders),
 				    &req)) {
 		SPDK_INFOLOG(SPDK_LOG_LVOL_RPC, "spdk_json_decode_object failed\n");
 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
@@ -230,12 +230,13 @@ spdk_rpc_rename_lvol_store(struct spdk_jsonrpc_request *request,
 		goto cleanup;
 	}
 
-	vbdev_lvs_rename(lvs, req.new_name, _spdk_rpc_rename_lvol_store_cb, request);
+	vbdev_lvs_rename(lvs, req.new_name, _spdk_rpc_bdev_lvol_rename_lvstore_cb, request);
 
 cleanup:
-	free_rpc_rename_lvol_store(&req);
+	free_rpc_bdev_lvol_rename_lvstore(&req);
 }
-SPDK_RPC_REGISTER("rename_lvol_store", spdk_rpc_rename_lvol_store, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("bdev_lvol_rename_lvstore", spdk_rpc_bdev_lvol_rename_lvstore, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_lvol_rename_lvstore, rename_lvol_store)
 
 struct rpc_bdev_lvol_delete_lvstore {
 	char *uuid;

scripts/rpc.py

@@ -1167,15 +1167,16 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
         Available: none, unmap, write_zeroes""", required=False)
     p.set_defaults(func=construct_lvol_store)
 
-    def rename_lvol_store(args):
+    def bdev_lvol_rename_lvstore(args):
-        rpc.lvol.rename_lvol_store(args.client,
+        rpc.lvol.bdev_lvol_rename_lvstore(args.client,
-                                   old_name=args.old_name,
+                                          old_name=args.old_name,
-                                   new_name=args.new_name)
+                                          new_name=args.new_name)
 
-    p = subparsers.add_parser('rename_lvol_store', help='Change logical volume store name')
+    p = subparsers.add_parser('bdev_lvol_rename_lvstore', aliases=['rename_lvol_store'],
+                              help='Change logical volume store name')
     p.add_argument('old_name', help='old name')
     p.add_argument('new_name', help='new name')
-    p.set_defaults(func=rename_lvol_store)
+    p.set_defaults(func=bdev_lvol_rename_lvstore)
 
     def bdev_lvol_create(args):
         print_json(rpc.lvol.bdev_lvol_create(args.client,

scripts/rpc/lvol.py

@@ -21,7 +21,8 @@ def construct_lvol_store(client, bdev_name, lvs_name, cluster_sz=None, clear_met
     return client.call('construct_lvol_store', params)
 
 
-def rename_lvol_store(client, old_name, new_name):
+@deprecated_alias('rename_lvol_store')
+def bdev_lvol_rename_lvstore(client, old_name, new_name):
     """Rename a logical volume store.
 
     Args:
@@ -32,7 +33,7 @@ def rename_lvol_store(client, old_name, new_name):
         'old_name': old_name,
         'new_name': new_name
     }
-    return client.call('rename_lvol_store', params)
+    return client.call('bdev_lvol_rename_lvstore', params)
 
 
 @deprecated_alias('construct_lvol_bdev')

test/lvol/rpc_commands_lib.py

@@ -204,9 +204,9 @@ class Commands_Rpc(object):
 
         return None
 
-    def rename_lvol_store(self, old_name, new_name):
+    def bdev_lvol_rename_lvstore(self, old_name, new_name):
         print("INFO: Renaming lvol store from {old} to {new}".format(old=old_name, new=new_name))
-        output, rc = self.rpc.rename_lvol_store(old_name, new_name)
+        output, rc = self.rpc.bdev_lvol_rename_lvstore(old_name, new_name)
         return rc
 
     def bdev_lvol_rename(self, old_name, new_name):

test/lvol/test_cases.py

@@ -3140,7 +3140,7 @@ class TestCases(object):
         new_lvs_name = "lvs_new"
         bdev_aliases = [alias.replace(self.lvs_name, new_lvs_name) for alias in bdev_aliases]
 
-        fail_count += self.c.rename_lvol_store(self.lvs_name, new_lvs_name)
+        fail_count += self.c.bdev_lvol_rename_lvstore(self.lvs_name, new_lvs_name)
 
         fail_count += self.c.check_bdev_lvol_get_lvstores(base_name,
                                                           lvs_uuid,
@@ -3195,12 +3195,12 @@ class TestCases(object):
         Check that error is returned when trying to rename not existing lvol store.
         """
         fail_count = 0
-        # Call rename_lvol_store with name pointing to not existing lvol store
+        # Call bdev_lvol_rename_lvstore with name pointing to not existing lvol store
-        if self.c.rename_lvol_store("NOTEXIST", "WHATEVER") == 0:
+        if self.c.bdev_lvol_rename_lvstore("NOTEXIST", "WHATEVER") == 0:
             fail_count += 1
 
         # Expected results:
-        # - rename_lvol_store return code != 0
+        # - bdev_lvol_rename_lvstore return code != 0
         # - no other operation fails
         return fail_count
 
@@ -3266,9 +3266,9 @@ class TestCases(object):
                                                          alias)
             bdev_uuids_2.append(uuid)
 
-        # Call rename_lvol_store on first lvol store and try to change its name to
+        # Call bdev_lvol_rename_lvstore on first lvol store and try to change its name to
         # the same name as used by second lvol store
-        if self.c.rename_lvol_store(lvs_name_1, lvs_name_2) == 0:
+        if self.c.bdev_lvol_rename_lvstore(lvs_name_1, lvs_name_2) == 0:
             fail_count += 1
 
         # Verify that names of lvol stores and lvol bdevs did not change
@@ -3300,7 +3300,7 @@ class TestCases(object):
         fail_count += self.c.delete_malloc_bdev(base_bdev_2)
 
         # Expected results:
-        # - rename_lvol_store return code != 0; not possible to rename to already
+        # - bdev_lvol_rename_lvstore return code != 0; not possible to rename to already
         #   used name
         # - no other operation fails