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

rpc: Rename stop_nbd_disk to nbd_stop_disk 



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


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.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 0a993323

doc/bdev.md

+4 −4
Original line number Diff line number Diff line
@@ -266,17 +266,17 @@ Example command 


This will expose an SPDK bdev `Malloc0` under the `/dev/nbd0` block device.



To remove NBD device user should use `stop_nbd_disk` RPC command.

To remove NBD device user should use `nbd_stop_disk` RPC command.



Example command



`rpc.py stop_nbd_disk /dev/nbd0`

`rpc.py nbd_stop_disk /dev/nbd0`



To display full or specified nbd device list user should use `get_nbd_disks` RPC command.



Example command



`rpc.py stop_nbd_disk -n /dev/nbd0`

`rpc.py nbd_stop_disk -n /dev/nbd0`



## Creating a GPT partition table using NBD {#bdev_ug_gpt_create_part}
@@ -295,7 +295,7 @@ parted -s /dev/nbd0 mkpart MyPartition '0%' '50%' 
sgdisk -t 1:7c5222bd-8f5d-4087-9c00-bf9843c7b58c /dev/nbd0



# Stop the NBD device (stop exporting /dev/nbd0).

rpc.py stop_nbd_disk /dev/nbd0

rpc.py nbd_stop_disk /dev/nbd0



# Now Nvme0n1 is configured with a GPT partition table, and

# the first partition will be automatically exposed as

doc/jsonrpc.md

+3 −3
Original line number Diff line number Diff line
@@ -245,7 +245,7 @@ Example response: 
    "delete_ip_address",

    "add_ip_address",

    "get_nbd_disks",

    "stop_nbd_disk",

    "nbd_stop_disk",

    "nbd_start_disk",

    "get_log_flags",

    "clear_log_flag",
@@ -5559,7 +5559,7 @@ Example response: 
}

~~~



## stop_nbd_disk {#rpc_stop_nbd_disk}

## nbd_stop_disk {#rpc_nbd_stop_disk}



Stop one NBD disk which is based on SPDK bdev.
@@ -5579,7 +5579,7 @@ Example request: 
    "nbd_device": "/dev/nbd1",

  },

  "jsonrpc": "2.0",

  "method": "stop_nbd_disk",

  "method": "nbd_stop_disk",

  "id": 1

}

~~~

lib/nbd/nbd_rpc.c

+11 −10
Original line number Diff line number Diff line
@@ -234,18 +234,18 @@ invalid: 
SPDK_RPC_REGISTER("nbd_start_disk", spdk_rpc_nbd_start_disk, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nbd_start_disk, start_nbd_disk)



struct rpc_stop_nbd_disk {

struct rpc_nbd_stop_disk {

	char *nbd_device;

};



static void

free_rpc_stop_nbd_disk(struct rpc_stop_nbd_disk *req)

free_rpc_nbd_stop_disk(struct rpc_nbd_stop_disk *req)

{

	free(req->nbd_device);

}



static const struct spdk_json_object_decoder rpc_stop_nbd_disk_decoders[] = {

	{"nbd_device", offsetof(struct rpc_stop_nbd_disk, nbd_device), spdk_json_decode_string},

static const struct spdk_json_object_decoder rpc_nbd_stop_disk_decoders[] = {

	{"nbd_device", offsetof(struct rpc_nbd_stop_disk, nbd_device), spdk_json_decode_string},

};



struct nbd_disconnect_arg {
@@ -272,17 +272,17 @@ nbd_disconnect_thread(void *arg) 
}



static void

spdk_rpc_stop_nbd_disk(struct spdk_jsonrpc_request *request,

spdk_rpc_nbd_stop_disk(struct spdk_jsonrpc_request *request,

		       const struct spdk_json_val *params)

{

	struct rpc_stop_nbd_disk req = {};

	struct rpc_nbd_stop_disk req = {};

	struct spdk_nbd_disk *nbd;

	pthread_t tid;

	struct nbd_disconnect_arg *thd_arg = NULL;

	int rc;



	if (spdk_json_decode_object(params, rpc_stop_nbd_disk_decoders,

				    SPDK_COUNTOF(rpc_stop_nbd_disk_decoders),

	if (spdk_json_decode_object(params, rpc_nbd_stop_disk_decoders,

				    SPDK_COUNTOF(rpc_nbd_stop_disk_decoders),

				    &req)) {

		SPDK_ERRLOG("spdk_json_decode_object failed\n");

		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
@@ -335,10 +335,11 @@ spdk_rpc_stop_nbd_disk(struct spdk_jsonrpc_request *request, 
	}



out:

	free_rpc_stop_nbd_disk(&req);

	free_rpc_nbd_stop_disk(&req);

}



SPDK_RPC_REGISTER("stop_nbd_disk", spdk_rpc_stop_nbd_disk, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER("nbd_stop_disk", spdk_rpc_nbd_stop_disk, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(nbd_stop_disk, stop_nbd_disk)



static void

spdk_rpc_dump_nbd_info(struct spdk_json_write_ctx *w,

scripts/rpc.py

+5 −4
Original line number Diff line number Diff line
@@ -1472,13 +1472,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 assigned. Example: /dev/nbd0.', nargs='?')

    p.set_defaults(func=nbd_start_disk)



    def stop_nbd_disk(args):

        rpc.nbd.stop_nbd_disk(args.client,

    def nbd_stop_disk(args):

        rpc.nbd.nbd_stop_disk(args.client,

                              nbd_device=args.nbd_device)



    p = subparsers.add_parser('stop_nbd_disk', help='Stop a nbd disk')

    p = subparsers.add_parser('nbd_stop_disk', aliases=['stop_nbd_disk'],

                              help='Stop a nbd disk')

    p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.')

    p.set_defaults(func=stop_nbd_disk)

    p.set_defaults(func=nbd_stop_disk)



    def get_nbd_disks(args):

        print_dict(rpc.nbd.get_nbd_disks(args.client,

scripts/rpc/nbd.py

+3 −2
Original line number Diff line number Diff line
@@ -11,9 +11,10 @@ def nbd_start_disk(client, bdev_name, nbd_device): 
    return client.call('nbd_start_disk', params)





def stop_nbd_disk(client, nbd_device):

@deprecated_alias('stop_nbd_disk')

def nbd_stop_disk(client, nbd_device):

    params = {'nbd_device': nbd_device}

    return client.call('stop_nbd_disk', params)

    return client.call('nbd_stop_disk', params)





def get_nbd_disks(client, nbd_device=None):