Commit 8ac7cad4 authored by Maciej Wawryk's avatar Maciej Wawryk Committed by Ben Walker
Browse files

RPC: rename rpc construct_rbd_bdev to bdev_rbd_create 



Signed-off-by: default avatarMaciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: Ibc24c5fc623e38cae8fe787a7c59917a129fdad2
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468019


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 avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 87ebcb08

doc/bdev.md

+2 −2
Original line number Diff line number Diff line
@@ -107,11 +107,11 @@ The command will disable histogram on Nvme0n1 device. 
The SPDK RBD bdev driver provides SPDK block layer access to Ceph RADOS block

devices (RBD). Ceph RBD devices are accessed via librbd and librados libraries

to access the RADOS block device exported by Ceph. To create Ceph bdev RPC

command `construct_rbd_bdev` should be used.

command `bdev_rbd_create` should be used.



Example command



`rpc.py construct_rbd_bdev rbd foo 512`

`rpc.py bdev_rbd_create rbd foo 512`



This command will create a bdev that represents the 'foo' image from a pool called 'rbd'.

doc/jsonrpc.md

+3 −3
Original line number Diff line number Diff line
@@ -1617,9 +1617,9 @@ Example response: 
}

~~~



## construct_rbd_bdev {#rpc_construct_rbd_bdev}

## bdev_rbd_create {#rpc_bdev_rbd_create}



Construct @ref bdev_config_rbd bdev

Create @ref bdev_config_rbd bdev



This method is available only if SPDK was build with Ceph RBD support.
@@ -1664,7 +1664,7 @@ Example request with `key` from `/etc/ceph/ceph.client.admin.keyring`: 
    "block_size": 4096

  },

  "jsonrpc": "2.0",

  "method": "construct_rbd_bdev",

  "method": "bdev_rbd_create",

  "id": 1

}

~~~

module/bdev/rbd/bdev_rbd.c

+1 −1
Original line number Diff line number Diff line
@@ -645,7 +645,7 @@ bdev_rbd_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w 


	spdk_json_write_object_begin(w);



	spdk_json_write_named_string(w, "method", "construct_rbd_bdev");

	spdk_json_write_named_string(w, "method", "bdev_rbd_create");



	spdk_json_write_named_object_begin(w, "params");

	spdk_json_write_named_string(w, "name", bdev->name);

module/bdev/rbd/bdev_rbd_rpc.c

+17 −16
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ 
#include "spdk/string.h"

#include "spdk_internal/log.h"



struct rpc_construct_rbd {

struct rpc_create_rbd {

	char *name;

	char *user_id;

	char *pool_name;
@@ -47,7 +47,7 @@ struct rpc_construct_rbd { 
};



static void

free_rpc_construct_rbd(struct rpc_construct_rbd *req)

free_rpc_create_rbd(struct rpc_create_rbd *req)

{

	free(req->name);

	free(req->user_id);
@@ -98,26 +98,26 @@ spdk_bdev_rbd_decode_config(const struct spdk_json_val *values, void *out) 
	return 0;

}



static const struct spdk_json_object_decoder rpc_construct_rbd_decoders[] = {

	{"name", offsetof(struct rpc_construct_rbd, name), spdk_json_decode_string, true},

	{"user_id", offsetof(struct rpc_construct_rbd, user_id), spdk_json_decode_string, true},

	{"pool_name", offsetof(struct rpc_construct_rbd, pool_name), spdk_json_decode_string},

	{"rbd_name", offsetof(struct rpc_construct_rbd, rbd_name), spdk_json_decode_string},

	{"block_size", offsetof(struct rpc_construct_rbd, block_size), spdk_json_decode_uint32},

	{"config", offsetof(struct rpc_construct_rbd, config), spdk_bdev_rbd_decode_config, true}

static const struct spdk_json_object_decoder rpc_create_rbd_decoders[] = {

	{"name", offsetof(struct rpc_create_rbd, name), spdk_json_decode_string, true},

	{"user_id", offsetof(struct rpc_create_rbd, user_id), spdk_json_decode_string, true},

	{"pool_name", offsetof(struct rpc_create_rbd, pool_name), spdk_json_decode_string},

	{"rbd_name", offsetof(struct rpc_create_rbd, rbd_name), spdk_json_decode_string},

	{"block_size", offsetof(struct rpc_create_rbd, block_size), spdk_json_decode_uint32},

	{"config", offsetof(struct rpc_create_rbd, config), spdk_bdev_rbd_decode_config, true}

};



static void

spdk_rpc_construct_rbd_bdev(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_rbd_create(struct spdk_jsonrpc_request *request,

			 const struct spdk_json_val *params)

{

	struct rpc_construct_rbd req = {};

	struct rpc_create_rbd req = {};

	struct spdk_json_write_ctx *w;

	struct spdk_bdev *bdev;

	int rc = 0;



	if (spdk_json_decode_object(params, rpc_construct_rbd_decoders,

				    SPDK_COUNTOF(rpc_construct_rbd_decoders),

	if (spdk_json_decode_object(params, rpc_create_rbd_decoders,

				    SPDK_COUNTOF(rpc_create_rbd_decoders),

				    &req)) {

		SPDK_DEBUGLOG(SPDK_LOG_BDEV_RBD, "spdk_json_decode_object failed\n");

		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
@@ -139,9 +139,10 @@ spdk_rpc_construct_rbd_bdev(struct spdk_jsonrpc_request *request, 
	spdk_jsonrpc_end_result(request, w);



cleanup:

	free_rpc_construct_rbd(&req);

	free_rpc_create_rbd(&req);

}

SPDK_RPC_REGISTER("construct_rbd_bdev", spdk_rpc_construct_rbd_bdev, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER("bdev_rbd_create", spdk_rpc_bdev_rbd_create, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_rbd_create, construct_rbd_bdev)



struct rpc_delete_rbd {

	char *name;

scripts/rpc.py

+11 −11
Original line number Diff line number Diff line
@@ -245,7 +245,7 @@ if __name__ == "__main__": 
                                               name=args.name,

                                               uuid=args.uuid))

    p = subparsers.add_parser('bdev_malloc_create', aliases=['construct_malloc_bdev'],

                              help='Add a bdev with malloc backend')

                              help='Create a bdev with malloc backend')

    p.add_argument('-b', '--name', help="Name of the bdev")

    p.add_argument('-u', '--uuid', help="UUID of the bdev")

    p.add_argument(
@@ -411,7 +411,7 @@ if __name__ == "__main__": 
    p.add_argument('name', help="Name of the controller")

    p.set_defaults(func=delete_nvme_controller)



    def construct_rbd_bdev(args):

    def bdev_rbd_create(args):

        config = None

        if args.config:

            config = {}
@@ -420,7 +420,7 @@ if __name__ == "__main__": 
                if len(parts) != 2:

                    raise Exception('--config %s not in key=value form' % entry)

                config[parts[0]] = parts[1]

        print_json(rpc.bdev.construct_rbd_bdev(args.client,

        print_json(rpc.bdev.bdev_rbd_create(args.client,

                                            name=args.name,

                                            user=args.user,

                                            config=config,
@@ -428,7 +428,7 @@ if __name__ == "__main__": 
                                            rbd_name=args.rbd_name,

                                            block_size=args.block_size))



    p = subparsers.add_parser('construct_rbd_bdev',

    p = subparsers.add_parser('bdev_rbd_create', aliases=['construct_rbd_bdev'],

                              help='Add a bdev with ceph rbd backend')

    p.add_argument('-b', '--name', help="Name of the bdev", required=False)

    p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False)
@@ -437,7 +437,7 @@ if __name__ == "__main__": 
    p.add_argument('pool_name', help='rbd pool name')

    p.add_argument('rbd_name', help='rbd image name')

    p.add_argument('block_size', help='rbd block size', type=int)

    p.set_defaults(func=construct_rbd_bdev)

    p.set_defaults(func=bdev_rbd_create)



    def delete_rbd_bdev(args):

        rpc.bdev.delete_rbd_bdev(args.client,