diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 7d91840ca..7501b77ce 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -305,7 +305,7 @@ Example response: "set_read_only_lvol_bdev", "decouple_parent_lvol_bdev", "inflate_lvol_bdev", - "rename_lvol_bdev", + "bdev_lvol_rename", "bdev_lvol_clone", "snapshot_lvol_bdev", "construct_lvol_bdev", @@ -5067,7 +5067,7 @@ Example response: } ~~~ -## rename_lvol_bdev {#rpc_rename_lvol_bdev} +## bdev_lvol_rename {#rpc_bdev_lvol_rename} Rename a logical volume. New name will rename only the alias of the logical volume. @@ -5085,7 +5085,7 @@ Example request: ~~~ { "jsonrpc": "2.0", - "method": "rename_lvol_bdev", + "method": "bdev_lvol_rename", "id": 1, "params": { "old_name": "067df606-6dbc-4143-a499-0d05855cb3b8", diff --git a/doc/lvol.md b/doc/lvol.md index c637e59f5..eb2cf09cf 100644 --- a/doc/lvol.md +++ b/doc/lvol.md @@ -137,7 +137,7 @@ bdev_lvol_clone [-h] snapshot_name clone_name Create a clone with clone_name of a given lvol snapshot. optional arguments: -h, --help show help -rename_lvol_bdev [-h] old_name new_name +bdev_lvol_rename [-h] old_name new_name Change lvol bdev name optional arguments: -h, --help show help diff --git a/module/bdev/lvol/vbdev_lvol_rpc.c b/module/bdev/lvol/vbdev_lvol_rpc.c index 5c00074ae..3fb4adb20 100644 --- a/module/bdev/lvol/vbdev_lvol_rpc.c +++ b/module/bdev/lvol/vbdev_lvol_rpc.c @@ -562,25 +562,25 @@ cleanup: SPDK_RPC_REGISTER("bdev_lvol_clone", spdk_rpc_bdev_lvol_clone, SPDK_RPC_RUNTIME) SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_lvol_clone, clone_lvol_bdev) -struct rpc_rename_lvol_bdev { +struct rpc_bdev_lvol_rename { char *old_name; char *new_name; }; static void -free_rpc_rename_lvol_bdev(struct rpc_rename_lvol_bdev *req) +free_rpc_bdev_lvol_rename(struct rpc_bdev_lvol_rename *req) { free(req->old_name); free(req->new_name); } -static const struct spdk_json_object_decoder rpc_rename_lvol_bdev_decoders[] = { - {"old_name", offsetof(struct rpc_rename_lvol_bdev, old_name), spdk_json_decode_string}, - {"new_name", offsetof(struct rpc_rename_lvol_bdev, new_name), spdk_json_decode_string}, +static const struct spdk_json_object_decoder rpc_bdev_lvol_rename_decoders[] = { + {"old_name", offsetof(struct rpc_bdev_lvol_rename, old_name), spdk_json_decode_string}, + {"new_name", offsetof(struct rpc_bdev_lvol_rename, new_name), spdk_json_decode_string}, }; static void -_spdk_rpc_rename_lvol_bdev_cb(void *cb_arg, int lvolerrno) +_spdk_rpc_bdev_lvol_rename_cb(void *cb_arg, int lvolerrno) { struct spdk_json_write_ctx *w; struct spdk_jsonrpc_request *request = cb_arg; @@ -600,17 +600,17 @@ invalid: } static void -spdk_rpc_rename_lvol_bdev(struct spdk_jsonrpc_request *request, +spdk_rpc_bdev_lvol_rename(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params) { - struct rpc_rename_lvol_bdev req = {}; + struct rpc_bdev_lvol_rename req = {}; struct spdk_bdev *bdev; struct spdk_lvol *lvol; SPDK_INFOLOG(SPDK_LOG_LVOL_RPC, "Renaming lvol\n"); - if (spdk_json_decode_object(params, rpc_rename_lvol_bdev_decoders, - SPDK_COUNTOF(rpc_rename_lvol_bdev_decoders), + if (spdk_json_decode_object(params, rpc_bdev_lvol_rename_decoders, + SPDK_COUNTOF(rpc_bdev_lvol_rename_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, @@ -632,13 +632,14 @@ spdk_rpc_rename_lvol_bdev(struct spdk_jsonrpc_request *request, goto cleanup; } - vbdev_lvol_rename(lvol, req.new_name, _spdk_rpc_rename_lvol_bdev_cb, request); + vbdev_lvol_rename(lvol, req.new_name, _spdk_rpc_bdev_lvol_rename_cb, request); cleanup: - free_rpc_rename_lvol_bdev(&req); + free_rpc_bdev_lvol_rename(&req); } -SPDK_RPC_REGISTER("rename_lvol_bdev", spdk_rpc_rename_lvol_bdev, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("bdev_lvol_rename", spdk_rpc_bdev_lvol_rename, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_lvol_rename, rename_lvol_bdev) struct rpc_inflate_lvol_bdev { char *name; diff --git a/scripts/rpc.py b/scripts/rpc.py index 8b522af2a..6ad112645 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -1195,15 +1195,16 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.add_argument('clone_name', help='lvol clone name') p.set_defaults(func=bdev_lvol_clone) - def rename_lvol_bdev(args): - rpc.lvol.rename_lvol_bdev(args.client, + def bdev_lvol_rename(args): + rpc.lvol.bdev_lvol_rename(args.client, old_name=args.old_name, new_name=args.new_name) - p = subparsers.add_parser('rename_lvol_bdev', help='Change lvol bdev name') + p = subparsers.add_parser('bdev_lvol_rename', aliases=['rename_lvol_bdev'], + help='Change lvol bdev name') p.add_argument('old_name', help='lvol bdev name') p.add_argument('new_name', help='new lvol name') - p.set_defaults(func=rename_lvol_bdev) + p.set_defaults(func=bdev_lvol_rename) def inflate_lvol_bdev(args): rpc.lvol.inflate_lvol_bdev(args.client, diff --git a/scripts/rpc/lvol.py b/scripts/rpc/lvol.py index 3df893571..f6bab79e3 100644 --- a/scripts/rpc/lvol.py +++ b/scripts/rpc/lvol.py @@ -100,7 +100,8 @@ def bdev_lvol_clone(client, snapshot_name, clone_name): return client.call('bdev_lvol_clone', params) -def rename_lvol_bdev(client, old_name, new_name): +@deprecated_alias('rename_lvol_bdev') +def bdev_lvol_rename(client, old_name, new_name): """Rename a logical volume. Args: @@ -111,7 +112,7 @@ def rename_lvol_bdev(client, old_name, new_name): 'old_name': old_name, 'new_name': new_name } - return client.call('rename_lvol_bdev', params) + return client.call('bdev_lvol_rename', params) def resize_lvol_bdev(client, name, size): diff --git a/test/lvol/lvol.sh b/test/lvol/lvol.sh index 876d5d2bb..70a211a08 100755 --- a/test/lvol/lvol.sh +++ b/test/lvol/lvol.sh @@ -78,8 +78,8 @@ function usage() { 800: 'rename_positive', 801: 'rename_lvs_nonexistent', 802: 'rename_lvs_EEXIST', - 803: 'rename_lvol_bdev_nonexistent', - 804: 'rename_lvol_bdev_EEXIST', + 803: 'bdev_lvol_rename_nonexistent', + 804: 'bdev_lvol_rename_EEXIST', 10000: 'SIGTERM' or all: This parameter runs all tests diff --git a/test/lvol/rpc_commands_lib.py b/test/lvol/rpc_commands_lib.py index c6482a7c3..ecd22f165 100644 --- a/test/lvol/rpc_commands_lib.py +++ b/test/lvol/rpc_commands_lib.py @@ -209,9 +209,9 @@ class Commands_Rpc(object): output, rc = self.rpc.rename_lvol_store(old_name, new_name) return rc - def rename_lvol_bdev(self, old_name, new_name): + def bdev_lvol_rename(self, old_name, new_name): print("INFO: Renaming lvol bdev from {old} to {new}".format(old=old_name, new=new_name)) - output, rc = self.rpc.rename_lvol_bdev(old_name, new_name) + output, rc = self.rpc.bdev_lvol_rename(old_name, new_name) return rc def snapshot_lvol_bdev(self, bdev_name, snapshot_name): diff --git a/test/lvol/test_cases.py b/test/lvol/test_cases.py index 331badbc6..be8ddaf40 100644 --- a/test/lvol/test_cases.py +++ b/test/lvol/test_cases.py @@ -178,8 +178,8 @@ def case_message(func): 800: 'rename_positive', 801: 'rename_lvs_nonexistent', 802: 'rename_lvs_EEXIST', - 803: 'rename_lvol_bdev_nonexistent', - 804: 'rename_lvol_bdev_EEXIST', + 803: 'bdev_lvol_rename_nonexistent', + 804: 'bdev_lvol_rename_EEXIST', # SIGTERM 10000: 'SIGTERM', } @@ -3158,7 +3158,7 @@ class TestCases(object): bdev_aliases = ["/".join([new_lvs_name, name]) for name in bdev_names] print(bdev_aliases) for uuid, new_name, new_alias in zip(bdev_uuids, bdev_names, bdev_aliases): - fail_count += self.c.rename_lvol_bdev(uuid, new_name) + fail_count += self.c.bdev_lvol_rename(uuid, new_name) fail_count += self.c.check_get_bdevs_methods(uuid, bdev_size, new_alias) @@ -3168,7 +3168,7 @@ class TestCases(object): new_bdev_aliases = ["/".join([new_lvs_name, name]) for name in bdev_names] print(bdev_aliases) for uuid, old_alias, new_alias, new_name in zip(bdev_uuids, bdev_aliases, new_bdev_aliases, bdev_names): - fail_count += self.c.rename_lvol_bdev(old_alias, new_name) + fail_count += self.c.bdev_lvol_rename(old_alias, new_name) fail_count += self.c.check_get_bdevs_methods(uuid, bdev_size, new_alias) @@ -3309,25 +3309,25 @@ class TestCases(object): @case_message def test_case803(self): """ - rename_lvol_bdev_nonexistent + bdev_lvol_rename_nonexistent Negative test case for lvol bdev rename. Check that error is returned when trying to rename not existing lvol bdev. """ fail_count = 0 - # Call rename_lvol_bdev with name pointing to not existing lvol bdev - if self.c.rename_lvol_bdev("NOTEXIST", "WHATEVER") == 0: + # Call bdev_lvol_rename with name pointing to not existing lvol bdev + if self.c.bdev_lvol_rename("NOTEXIST", "WHATEVER") == 0: fail_count += 1 # Expected results: - # - rename_lvol_bdev return code != 0 + # - bdev_lvol_rename return code != 0 # - no other operation fails return fail_count @case_message def test_case804(self): """ - rename_lvol_bdev_EEXIST + bdev_lvol_rename_EEXIST Negative test case for lvol bdev rename. Check that error is returned when trying to rename to a name which is already @@ -3358,9 +3358,9 @@ class TestCases(object): fail_count += self.c.check_get_bdevs_methods(bdev_uuid_2, bdev_size) - # Call rename_lvol_bdev on first lvol bdev and try to change its name to + # Call bdev_lvol_rename on first lvol bdev and try to change its name to # the same name as used by second lvol bdev - if self.c.rename_lvol_bdev(self.lbd_name + "1", self.lbd_name + "2") == 0: + if self.c.bdev_lvol_rename(self.lbd_name + "1", self.lbd_name + "2") == 0: fail_count += 1 # Verify that lvol bdev still have the same names as before fail_count += self.c.check_get_bdevs_methods(bdev_uuid_1, @@ -3373,7 +3373,7 @@ class TestCases(object): fail_count += self.c.delete_malloc_bdev(base_bdev) # Expected results: - # - rename_lvol_bdev return code != 0; not possible to rename to already + # - bdev_lvol_rename return code != 0; not possible to rename to already # used name # - no other operation fails return fail_count