From 5456a43053aff0785e43d446e7d235601db9568d Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Tue, 17 Sep 2019 06:59:02 -0400 Subject: [PATCH] rpc: Rename get_nbd_disks to nbd_get_disks Change-Id: I15aa0cc4fe26869a938b0ba81b6b5b4acc63fe21 Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468584 Tested-by: SPDK CI Jenkins Community-CI: Broadcom SPDK FC-NVMe CI Reviewed-by: Paul Luse Reviewed-by: Jim Harris Reviewed-by: Ben Walker --- doc/bdev.md | 2 +- doc/jsonrpc.md | 6 +++--- lib/nbd/nbd_rpc.c | 23 ++++++++++++----------- scripts/rpc.py | 9 +++++---- scripts/rpc/nbd.py | 5 +++-- test/bdev/nbd_common.sh | 4 ++-- 6 files changed, 26 insertions(+), 23 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index e8d16ad7e..6b394d6c0 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -272,7 +272,7 @@ Example command `rpc.py nbd_stop_disk /dev/nbd0` -To display full or specified nbd device list user should use `get_nbd_disks` RPC command. +To display full or specified nbd device list user should use `nbd_get_disks` RPC command. Example command diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index ee2c41f6e..6806ca3d3 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -244,7 +244,7 @@ Example response: "get_interfaces", "delete_ip_address", "add_ip_address", - "get_nbd_disks", + "nbd_get_disks", "nbd_stop_disk", "nbd_start_disk", "get_log_flags", @@ -5594,7 +5594,7 @@ Example response: } ~~~ -## get_nbd_disks {#rpc_get_nbd_disks} +## nbd_get_disks {#rpc_nbd_get_disks} Display all or specified NBD device list @@ -5615,7 +5615,7 @@ Example request: ~~~ { "jsonrpc": "2.0", - "method": "get_nbd_disks", + "method": "nbd_get_disks", "id": 1 } ~~~ diff --git a/lib/nbd/nbd_rpc.c b/lib/nbd/nbd_rpc.c index cf98e3c95..432e32c1d 100644 --- a/lib/nbd/nbd_rpc.c +++ b/lib/nbd/nbd_rpc.c @@ -354,31 +354,31 @@ spdk_rpc_dump_nbd_info(struct spdk_json_write_ctx *w, spdk_json_write_object_end(w); } -struct rpc_get_nbd_disks { +struct rpc_nbd_get_disks { char *nbd_device; }; static void -free_rpc_get_nbd_disks(struct rpc_get_nbd_disks *r) +free_rpc_nbd_get_disks(struct rpc_nbd_get_disks *r) { free(r->nbd_device); } -static const struct spdk_json_object_decoder rpc_get_nbd_disks_decoders[] = { - {"nbd_device", offsetof(struct rpc_get_nbd_disks, nbd_device), spdk_json_decode_string, true}, +static const struct spdk_json_object_decoder rpc_nbd_get_disks_decoders[] = { + {"nbd_device", offsetof(struct rpc_nbd_get_disks, nbd_device), spdk_json_decode_string, true}, }; static void -spdk_rpc_get_nbd_disks(struct spdk_jsonrpc_request *request, +spdk_rpc_nbd_get_disks(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params) { - struct rpc_get_nbd_disks req = {}; + struct rpc_nbd_get_disks req = {}; struct spdk_json_write_ctx *w; struct spdk_nbd_disk *nbd = NULL; if (params != NULL) { - if (spdk_json_decode_object(params, rpc_get_nbd_disks_decoders, - SPDK_COUNTOF(rpc_get_nbd_disks_decoders), + if (spdk_json_decode_object(params, rpc_nbd_get_disks_decoders, + SPDK_COUNTOF(rpc_nbd_get_disks_decoders), &req)) { SPDK_ERRLOG("spdk_json_decode_object failed\n"); spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, @@ -394,7 +394,7 @@ spdk_rpc_get_nbd_disks(struct spdk_jsonrpc_request *request, goto invalid; } - free_rpc_get_nbd_disks(&req); + free_rpc_nbd_get_disks(&req); } } @@ -416,6 +416,7 @@ spdk_rpc_get_nbd_disks(struct spdk_jsonrpc_request *request, return; invalid: - free_rpc_get_nbd_disks(&req); + free_rpc_nbd_get_disks(&req); } -SPDK_RPC_REGISTER("get_nbd_disks", spdk_rpc_get_nbd_disks, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("nbd_get_disks", spdk_rpc_nbd_get_disks, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nbd_get_disks, get_nbd_disks) diff --git a/scripts/rpc.py b/scripts/rpc.py index cf2a52322..f65784074 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -1481,13 +1481,14 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') p.set_defaults(func=nbd_stop_disk) - def get_nbd_disks(args): - print_dict(rpc.nbd.get_nbd_disks(args.client, + def nbd_get_disks(args): + print_dict(rpc.nbd.nbd_get_disks(args.client, nbd_device=args.nbd_device)) - p = subparsers.add_parser('get_nbd_disks', help='Display full or specified nbd device list') + p = subparsers.add_parser('nbd_get_disks', aliases=['get_nbd_disks'], + help='Display full or specified nbd device list') p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0", required=False) - p.set_defaults(func=get_nbd_disks) + p.set_defaults(func=nbd_get_disks) # net def add_ip_address(args): diff --git a/scripts/rpc/nbd.py b/scripts/rpc/nbd.py index 1a53da8a4..55e57d11e 100644 --- a/scripts/rpc/nbd.py +++ b/scripts/rpc/nbd.py @@ -17,8 +17,9 @@ def nbd_stop_disk(client, nbd_device): return client.call('nbd_stop_disk', params) -def get_nbd_disks(client, nbd_device=None): +@deprecated_alias('get_nbd_disks') +def nbd_get_disks(client, nbd_device=None): params = {} if nbd_device: params['nbd_device'] = nbd_device - return client.call('get_nbd_disks', params) + return client.call('nbd_get_disks', params) diff --git a/test/bdev/nbd_common.sh b/test/bdev/nbd_common.sh index 602a4a153..f557bffe9 100644 --- a/test/bdev/nbd_common.sh +++ b/test/bdev/nbd_common.sh @@ -55,7 +55,7 @@ function nbd_get_count() { # return = count of spdk nbd devices local rpc_server=$1 - nbd_disks_json=$($rootdir/scripts/rpc.py -s $rpc_server get_nbd_disks) + nbd_disks_json=$($rootdir/scripts/rpc.py -s $rpc_server nbd_get_disks) nbd_disks_name=$(echo "${nbd_disks_json}" | jq -r '.[] | .nbd_device') count=$(echo "${nbd_disks_name}" | grep -c /dev/nbd || true) echo $count @@ -110,7 +110,7 @@ function nbd_rpc_start_stop_verify() { nbd_start_disks_without_nbd_idx $rpc_server "${bdev_list[*]}" - nbd_disks_json=$($rootdir/scripts/rpc.py -s $rpc_server get_nbd_disks) + nbd_disks_json=$($rootdir/scripts/rpc.py -s $rpc_server nbd_get_disks) nbd_disks_name=($(echo "${nbd_disks_json}" | jq -r '.[] | .nbd_device')) nbd_stop_disks $rpc_server "${nbd_disks_name[*]}"