Commit 31e77a73 authored by Pawel Kaminski's avatar Pawel Kaminski Committed by Jim Harris
Browse files

rpc: Rename delete_nvme_controller to bdev_nvme_detach_controller 



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


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent f161e76d

doc/bdev.md

+3 −3
Original line number Diff line number Diff line
@@ -405,11 +405,11 @@ This command will create NVMe bdev of physical device in the system. 


This command will create NVMe bdev of NVMe-oF resource.



To remove a NVMe controller use the delete_nvme_controller command.

To remove an NVMe controller use the bdev_nvme_detach_controller command.



`rpc.py delete_nvme_controller Nvme0`

`rpc.py bdev_nvme_detach_controller Nvme0`



This command will remove NVMe controller named Nvme0.

This command will remove NVMe bdev named Nvme0.



# Logical volumes {#bdev_ug_logical_volumes}

doc/jsonrpc.md

+4 −4
Original line number Diff line number Diff line
@@ -293,7 +293,7 @@ Example response: 
    "bdev_passthru_create",

    "bdev_passthru_delete"

    "bdev_nvme_apply_firmware",

    "delete_nvme_controller",

    "bdev_nvme_detach_controller",

    "bdev_nvme_attach_controller",

    "bdev_null_create",

    "bdev_malloc_delete",
@@ -1592,9 +1592,9 @@ Example response: 
}

~~~



## delete_nvme_controller {#rpc_delete_nvme_controller}

## bdev_nvme_detach_controller {#rpc_bdev_nvme_detach_controller}



Delete NVMe controller.

Detach NVMe controller and delete any associated bdevs.



### Parameters
@@ -1612,7 +1612,7 @@ Example requests: 
    "name": "Nvme0"

  },

  "jsonrpc": "2.0",

  "method": "delete_nvme_controller",

  "method": "bdev_nvme_detach_controller",

  "id": 1

}

~~~

module/bdev/nvme/bdev_nvme_rpc.c

+13 −11
Original line number Diff line number Diff line
@@ -413,30 +413,30 @@ cleanup: 
SPDK_RPC_REGISTER("bdev_nvme_get_controllers", spdk_rpc_bdev_nvme_get_controllers, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_get_controllers, get_nvme_controllers)



struct rpc_delete_nvme {

struct rpc_bdev_nvme_detach_controller {

	char *name;

};



static void

free_rpc_delete_nvme(struct rpc_delete_nvme *req)

free_rpc_bdev_nvme_detach_controller(struct rpc_bdev_nvme_detach_controller *req)

{

	free(req->name);

}



static const struct spdk_json_object_decoder rpc_delete_nvme_decoders[] = {

	{"name", offsetof(struct rpc_delete_nvme, name), spdk_json_decode_string},

static const struct spdk_json_object_decoder rpc_bdev_nvme_detach_controller_decoders[] = {

	{"name", offsetof(struct rpc_bdev_nvme_detach_controller, name), spdk_json_decode_string},

};



static void

spdk_rpc_delete_nvme_controller(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_nvme_detach_controller(struct spdk_jsonrpc_request *request,

				     const struct spdk_json_val *params)

{

	struct rpc_delete_nvme req = {NULL};

	struct rpc_bdev_nvme_detach_controller req = {NULL};

	struct spdk_json_write_ctx *w;

	int rc = 0;



	if (spdk_json_decode_object(params, rpc_delete_nvme_decoders,

				    SPDK_COUNTOF(rpc_delete_nvme_decoders),

	if (spdk_json_decode_object(params, rpc_bdev_nvme_detach_controller_decoders,

				    SPDK_COUNTOF(rpc_bdev_nvme_detach_controller_decoders),

				    &req)) {

		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,

						 "spdk_json_decode_object failed");
@@ -454,9 +454,11 @@ spdk_rpc_delete_nvme_controller(struct spdk_jsonrpc_request *request, 
	spdk_jsonrpc_end_result(request, w);



cleanup:

	free_rpc_delete_nvme(&req);

	free_rpc_bdev_nvme_detach_controller(&req);

}

SPDK_RPC_REGISTER("delete_nvme_controller", spdk_rpc_delete_nvme_controller, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER("bdev_nvme_detach_controller", spdk_rpc_bdev_nvme_detach_controller,

		  SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_nvme_detach_controller, delete_nvme_controller)



struct rpc_apply_firmware {

	char *filename;

scripts/rpc.py

+6 −6
Original line number Diff line number Diff line
@@ -421,14 +421,14 @@ if __name__ == "__main__": 
    p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False)

    p.set_defaults(func=bdev_nvme_get_controllers)



    def delete_nvme_controller(args):

        rpc.bdev.delete_nvme_controller(args.client,

    def bdev_nvme_detach_controller(args):

        rpc.bdev.bdev_nvme_detach_controller(args.client,

                                             name=args.name)



    p = subparsers.add_parser('delete_nvme_controller',

                              help='Delete a NVMe controller using controller name')

    p = subparsers.add_parser('bdev_nvme_detach_controller', aliases=['delete_nvme_controller'],

                              help='Detach an NVMe controller and delete any associated bdevs')

    p.add_argument('name', help="Name of the controller")

    p.set_defaults(func=delete_nvme_controller)

    p.set_defaults(func=bdev_nvme_detach_controller)



    def bdev_rbd_create(args):

        config = None

scripts/rpc/bdev.py

+4 −3
Original line number Diff line number Diff line
@@ -444,15 +444,16 @@ def bdev_nvme_attach_controller(client, name, trtype, traddr, adrfam=None, trsvc 
    return client.call('bdev_nvme_attach_controller', params)





def delete_nvme_controller(client, name):

    """Remove NVMe controller from the system.

@deprecated_alias('delete_nvme_controller')

def bdev_nvme_detach_controller(client, name):

    """Detach NVMe controller and delete any associated bdevs.



    Args:

        name: controller name

    """



    params = {'name': name}

    return client.call('delete_nvme_controller', params)

    return client.call('bdev_nvme_detach_controller', params)





@deprecated_alias('construct_rbd_bdev')