Commit 5456a430 authored by Pawel Kaminski's avatar Pawel Kaminski Committed by Ben Walker
Browse files

rpc: Rename get_nbd_disks to nbd_get_disks 



Change-Id: I15aa0cc4fe26869a938b0ba81b6b5b4acc63fe21
Signed-off-by: default avatarPawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468584


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent d242f5a0

doc/bdev.md

+1 −1
Original line number Diff line number Diff line
@@ -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

doc/jsonrpc.md

+3 −3
Original line number Diff line number Diff line
@@ -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

}

~~~

lib/nbd/nbd_rpc.c

+12 −11
Original line number Diff line number Diff line
@@ -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)

scripts/rpc.py

+5 −4
Original line number Diff line number Diff line
@@ -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):

scripts/rpc/nbd.py

+3 −2
Original line number Diff line number Diff line
@@ -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)