RPC: rename rpc set_read_only_lvol_bdev to bdev_lvol_set_read_only

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I3652e81e01f0093c36f37c5735224ed651124df0
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466288
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

@@ -302,7 +302,7 @@ Example response:
     "bdev_lvol_get_lvstores",
     "destroy_lvol_bdev",
     "resize_lvol_bdev",
-    "set_read_only_lvol_bdev",
+    "bdev_lvol_set_read_only",
     "decouple_parent_lvol_bdev",
     "inflate_lvol_bdev",
     "bdev_lvol_rename",
@@ -5145,7 +5145,7 @@ Example response:
 }
 ~~~
 
-## set_read_only_lvol_bdev{#rpc_set_read_only_lvol_bdev}
+## bdev_lvol_set_read_only{#rpc_bdev_lvol_set_read_only}
 
 Mark logical volume as read only.
 
@@ -5162,7 +5162,7 @@ Example request:
 ~~~
 {
   "jsonrpc": "2.0",
-  "method": "set_read_only_lvol_bdev",
+  "method": "bdev_lvol_set_read_only",
   "id": 1,
   "params": {
     "name": "51638754-ca16-43a7-9f8f-294a0805ab0a",

doc/lvol.md

@@ -145,7 +145,7 @@ resize_lvol_bdev [-h] name size
     Resize existing lvol bdev
     optional arguments:
     -h, --help  show help
-set_read_only_lvol_bdev [-h] name
+bdev_lvol_set_read_only [-h] name
     Mark lvol bdev as read only
     optional arguments:
     -h, --help  show help

module/bdev/lvol/vbdev_lvol_rpc.c

@@ -868,7 +868,7 @@ invalid:
 }
 
 static void
-spdk_rpc_set_read_only_lvol_bdev(struct spdk_jsonrpc_request *request,
+spdk_rpc_bdev_lvol_set_read_only(struct spdk_jsonrpc_request *request,
 				 const struct spdk_json_val *params)
 {
 	struct rpc_set_ro_lvol_bdev req = {};
@@ -911,7 +911,8 @@ cleanup:
 	free_rpc_set_ro_lvol_bdev(&req);
 }
 
-SPDK_RPC_REGISTER("set_read_only_lvol_bdev", spdk_rpc_set_read_only_lvol_bdev, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("bdev_lvol_set_read_only", spdk_rpc_bdev_lvol_set_read_only, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_lvol_set_read_only, set_read_only_lvol_bdev)
 
 struct rpc_destroy_lvol_bdev {
 	char *name;

scripts/rpc.py

@@ -1246,13 +1246,14 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
     p.add_argument('size', help='new size in MiB for this bdev', type=int)
     p.set_defaults(func=resize_lvol_bdev)
 
-    def set_read_only_lvol_bdev(args):
+    def bdev_lvol_set_read_only(args):
-        rpc.lvol.set_read_only_lvol_bdev(args.client,
+        rpc.lvol.bdev_lvol_set_read_only(args.client,
                                          name=args.name)
 
-    p = subparsers.add_parser('set_read_only_lvol_bdev', help='Mark lvol bdev as read only')
+    p = subparsers.add_parser('bdev_lvol_set_read_only', aliases=['set_read_only_lvol_bdev'],
+                              help='Mark lvol bdev as read only')
     p.add_argument('name', help='lvol bdev name')
-    p.set_defaults(func=set_read_only_lvol_bdev)
+    p.set_defaults(func=bdev_lvol_set_read_only)
 
     def destroy_lvol_bdev(args):
         rpc.lvol.destroy_lvol_bdev(args.client,

scripts/rpc/lvol.py

@@ -129,7 +129,8 @@ def resize_lvol_bdev(client, name, size):
     return client.call('resize_lvol_bdev', params)
 
 
-def set_read_only_lvol_bdev(client, name):
+@deprecated_alias('set_read_only_lvol_bdev')
+def bdev_lvol_set_read_only(client, name):
     """Mark logical volume as read only.
 
     Args:
@@ -138,7 +139,7 @@ def set_read_only_lvol_bdev(client, name):
     params = {
         'name': name,
     }
-    return client.call('set_read_only_lvol_bdev', params)
+    return client.call('bdev_lvol_set_read_only', params)
 
 
 def destroy_lvol_bdev(client, name):

test/lvol/rpc_commands_lib.py

@@ -164,9 +164,9 @@ class Commands_Rpc(object):
         output, rc = self.rpc.resize_lvol_bdev(uuid, new_size)
         return rc
 
-    def set_read_only_lvol_bdev(self, uuid):
+    def bdev_lvol_set_read_only(self, uuid):
-        print("INFO: RPC COMMAND set_read_only_lvol_bdev")
+        print("INFO: RPC COMMAND bdev_lvol_set_read_only")
-        output, rc = self.rpc.set_read_only_lvol_bdev(uuid)
+        output, rc = self.rpc.bdev_lvol_set_read_only(uuid)
         return rc
 
     def start_nbd_disk(self, bdev_name, nbd_name):

test/lvol/test_cases.py

@@ -2866,7 +2866,7 @@ class TestCases(object):
                                                bdev_size)
         # Set lvol bdev as read only
         lvol_bdev = self.c.get_lvol_bdev_with_name(bdev_name)
-        fail_count += self.c.set_read_only_lvol_bdev(lvol_bdev['name'])
+        fail_count += self.c.bdev_lvol_set_read_only(lvol_bdev['name'])
 
         # Try to perform write operation on lvol marked as read only
         fail_count += self.c.start_nbd_disk(lvol_bdev['name'], nbd_name0)