RPC: rename RPC compress_bdev series

RPC: rename RPC construct_compress_bdev to bdev_compress_create
RPC: rename RPC delete_compress_bdev to bdev_compress_delete

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I768825269967e6af079e87094a4b3ce0b11444ab
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465051
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>

doc/bdev.md

@@ -142,7 +142,7 @@ any production use.
 
 Example command
 
-`rpc.py construct_compress_bdev -p /pmem_files -b myLvol`
+`rpc.py bdev_compress_create -p /pmem_files -b myLvol`
 
 In this example, a compression vbdev is created using persistent memory that is mapped to
 the directory `pmem_files` on top of the existing thinly provisioned logical volume `myLvol`.
@@ -170,7 +170,7 @@ To remove a compression vbdev, use the following command which will also delete
 file.  If the logical volume is deleted the PMEM file will not be removed and the
 compression vbdev will not be available.
 
-`rpc.py delete_compress_bdev COMP_LVS/myLvol`
+`rpc.py bdev_compress_delete COMP_LVS/myLvol`
 
 # Crypto Virtual Bdev Module {#bdev_config_crypto}
 

lib/bdev/compress/vbdev_compress.c

@@ -931,7 +931,7 @@ vbdev_compress_config_json(struct spdk_json_write_ctx *w)
 
 	TAILQ_FOREACH(comp_bdev, &g_vbdev_comp, link) {
 		spdk_json_write_object_begin(w);
-		spdk_json_write_named_string(w, "method", "construct_compress_bdev");
+		spdk_json_write_named_string(w, "method", "bdev_compress_create");
 		spdk_json_write_named_object_begin(w, "params");
 		spdk_json_write_named_string(w, "base_bdev_name", spdk_bdev_get_name(comp_bdev->base_bdev));
 		spdk_json_write_named_string(w, "name", spdk_bdev_get_name(&comp_bdev->comp_bdev));
@@ -1461,7 +1461,7 @@ error_bdev_name:
 }
 
 void
-delete_compress_bdev(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn, void *cb_arg)
+bdev_compress_delete(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn, void *cb_arg)
 {
 	struct vbdev_compress *comp_bdev = NULL;
 

lib/bdev/compress/vbdev_compress.h

@@ -65,7 +65,7 @@ int create_compress_bdev(const char *bdev_name, const char *pm_path);
  * \param cb_fn Function to call after deletion.
  * \param cb_arg Argument to pass to cb_fn.
  */
-void delete_compress_bdev(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn,
+void bdev_compress_delete(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn,
 			  void *cb_arg);
 
 #endif /* SPDK_VBDEV_COMPRESS_H */

lib/bdev/compress/vbdev_compress_rpc.c

@@ -107,7 +107,7 @@ static const struct spdk_json_object_decoder rpc_construct_compress_decoders[] =
  * device. Error status returned in the failed cases.
  */
 static void
-spdk_rpc_construct_compress_bdev(struct spdk_jsonrpc_request *request,
+spdk_rpc_bdev_compress_create(struct spdk_jsonrpc_request *request,
 			      const struct spdk_json_val *params)
 {
 	struct rpc_construct_compress req = {NULL};
@@ -139,7 +139,8 @@ spdk_rpc_construct_compress_bdev(struct spdk_jsonrpc_request *request,
 cleanup:
 	free_rpc_construct_compress(&req);
 }
-SPDK_RPC_REGISTER("construct_compress_bdev", spdk_rpc_construct_compress_bdev, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("bdev_compress_create", spdk_rpc_bdev_compress_create, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_compress_create, construct_compress_bdev)
 
 struct rpc_delete_compress {
 	char *name;
@@ -156,7 +157,7 @@ static const struct spdk_json_object_decoder rpc_delete_compress_decoders[] = {
 };
 
 static void
-_spdk_rpc_delete_compress_bdev_cb(void *cb_arg, int bdeverrno)
+_spdk_rpc_bdev_compress_delete_cb(void *cb_arg, int bdeverrno)
 {
 	struct spdk_jsonrpc_request *request = cb_arg;
 	struct spdk_json_write_ctx *w;
@@ -167,7 +168,7 @@ _spdk_rpc_delete_compress_bdev_cb(void *cb_arg, int bdeverrno)
 }
 
 static void
-spdk_rpc_delete_compress_bdev(struct spdk_jsonrpc_request *request,
+spdk_rpc_bdev_compress_delete(struct spdk_jsonrpc_request *request,
 			      const struct spdk_json_val *params)
 {
 	struct rpc_delete_compress req = {NULL};
@@ -187,9 +188,10 @@ spdk_rpc_delete_compress_bdev(struct spdk_jsonrpc_request *request,
 		goto cleanup;
 	}
 
-	delete_compress_bdev(bdev, _spdk_rpc_delete_compress_bdev_cb, request);
+	bdev_compress_delete(bdev, _spdk_rpc_bdev_compress_delete_cb, request);
 
 cleanup:
 	free_rpc_delete_compress(&req);
 }
-SPDK_RPC_REGISTER("delete_compress_bdev", spdk_rpc_delete_compress_bdev, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("bdev_compress_delete", spdk_rpc_bdev_compress_delete, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_compress_delete, delete_compress_bdev)

scripts/rpc.py

@@ -136,23 +136,23 @@ if __name__ == "__main__":
     p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
     p.set_defaults(func=set_bdev_options)
 
-    def construct_compress_bdev(args):
-        print_json(rpc.bdev.construct_compress_bdev(args.client,
+    def bdev_compress_create(args):
+        print_json(rpc.bdev.bdev_compress_create(args.client,
                                                  base_bdev_name=args.base_bdev_name,
                                                  pm_path=args.pm_path))
-    p = subparsers.add_parser('construct_compress_bdev',
+    p = subparsers.add_parser('bdev_compress_create',
                               help='Add a compress vbdev')
     p.add_argument('-b', '--base_bdev_name', help="Name of the base bdev")
     p.add_argument('-p', '--pm_path', help="Path to persistent memory")
-    p.set_defaults(func=construct_compress_bdev)
+    p.set_defaults(func=bdev_compress_create)
 
-    def delete_compress_bdev(args):
-        rpc.bdev.delete_compress_bdev(args.client,
+    def bdev_compress_delete(args):
+        rpc.bdev.bdev_compress_delete(args.client,
                                       name=args.name)
 
-    p = subparsers.add_parser('delete_compress_bdev', help='Delete a compress disk')
+    p = subparsers.add_parser('bdev_compress_delete', help='Delete a compress disk')
     p.add_argument('name', help='compress bdev name')
-    p.set_defaults(func=delete_compress_bdev)
+    p.set_defaults(func=bdev_compress_delete)
 
     def set_compress_pmd(args):
         rpc.bdev.set_compress_pmd(args.client,

scripts/rpc/bdev.py

@@ -18,7 +18,8 @@ def set_bdev_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None):
     return client.call('set_bdev_options', params)
 
 
-def construct_compress_bdev(client, base_bdev_name, pm_path):
+@deprecated_alias('construct_compress_bdev')
+def bdev_compress_create(client, base_bdev_name, pm_path):
     """Construct a compress virtual block device.
 
     Args:
@@ -30,17 +31,18 @@ def construct_compress_bdev(client, base_bdev_name, pm_path):
     """
     params = {'base_bdev_name': base_bdev_name, 'pm_path': pm_path}
 
-    return client.call('construct_compress_bdev', params)
+    return client.call('bdev_compress_create', params)
 
 
-def delete_compress_bdev(client, name):
+@deprecated_alias('delete_compress_bdev')
+def bdev_compress_delete(client, name):
     """Delete compress virtual block device.
 
     Args:
         name: name of compress vbdev to delete
     """
     params = {'name': name}
-    return client.call('delete_compress_bdev', params)
+    return client.call('bdev_compress_delete', params)
 
 
 def set_compress_pmd(client, pmd):

test/compress/compress.sh

@@ -28,7 +28,7 @@ lvs_u=$($rpc_py construct_lvol_store Nvme0n1 lvs0)
 $rpc_py construct_lvol_bdev -t -u $lvs_u lv0 100
 # this will force isal_pmd as some of the CI systems need a qat driver update
 $rpc_py set_compress_pmd -p 2
-compress_bdev=$($rpc_py construct_compress_bdev -b lvs0/lv0 -p /tmp)
+compress_bdev=$($rpc_py bdev_compress_create -b lvs0/lv0 -p /tmp)
 trap - SIGINT SIGTERM EXIT
 killprocess $bdev_svc_pid
 
@@ -64,7 +64,7 @@ waitforbdev $compress_bdev
 $rootdir/test/bdev/bdevperf/bdevperf.py perform_tests
 
 # now cleanup the vols, deleting the compression vol also deletes the pmem file
-$rpc_py delete_compress_bdev COMP_lvs0/lv0
+$rpc_py bdev_compress_delete COMP_lvs0/lv0
 $rpc_py destroy_lvol_store -l lvs0
 
 trap - SIGINT SIGTERM EXIT

test/json_config/clear_config.py

@@ -42,7 +42,7 @@ def get_bdev_destroy_method(bdev):
                           'construct_crypto_bdev': "delete_crypto_bdev",
                           'bdev_delay_create': "bdev_delay_delete",
                           'construct_passthru_bdev': "delete_passthru_bdev",
-                          'construct_compress_bdev': 'delete_compress_bdev',
+                          'bdev_compress_create': 'bdev_compress_delete',
                           }
     destroy_method = None
     if 'method' in bdev: