Commit 9f5cbf4c authored by Maciej Wawryk's avatar Maciej Wawryk Committed by Jim Harris
Browse files

RPC: rename bdev_iscsi RPCs 



Rename:
*delete_iscsi_bdev to bdev_iscsi_delete
*construct_iscsi_bdev to bdev_iscsi_create

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


Reviewed-by: default avatarBroadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent b9d5e788

doc/bdev.md

+1 −1
Original line number Diff line number Diff line
@@ -310,7 +310,7 @@ In order to use it, build SPDK with an extra `--with-iscsi-initiator` configure 
The following command creates an `iSCSI0` bdev from a single LUN exposed at given iSCSI URL

with `iqn.2016-06.io.spdk:init` as the reported initiator IQN.



`rpc.py construct_iscsi_bdev -b iSCSI0 -i iqn.2016-06.io.spdk:init --url iscsi://127.0.0.1/iqn.2016-06.io.spdk:disk1/0`

`rpc.py bdev_iscsi_create -b iSCSI0 -i iqn.2016-06.io.spdk:init --url iscsi://127.0.0.1/iqn.2016-06.io.spdk:disk1/0`



The URL is in the following format:

`iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn>/<lun>`

doc/jsonrpc.md

+4 −4
Original line number Diff line number Diff line
@@ -1923,7 +1923,7 @@ Example response: 
}

~~~



## construct_iscsi_bdev {#rpc_construct_iscsi_bdev}

## bdev_iscsi_create {#rpc_bdev_iscsi_create}



Connect to iSCSI target and create bdev backed by this connection.
@@ -1953,7 +1953,7 @@ Example request: 
    "name": "iSCSI0"

  },

  "jsonrpc": "2.0",

  "method": "construct_iscsi_bdev",

  "method": "bdev_iscsi_create",

  "id": 1

}

~~~
@@ -1968,7 +1968,7 @@ Example response: 
}

~~~



## delete_iscsi_bdev {#rpc_delete_iscsi_bdev}

## bdev_iscsi_delete {#rpc_bdev_iscsi_delete}



Delete iSCSI bdev and terminate connection to target.
@@ -1990,7 +1990,7 @@ Example request: 
    "name": "iSCSI0"

  },

  "jsonrpc": "2.0",

  "method": "delete_iscsi_bdev",

  "method": "bdev_iscsi_delete",

  "id": 1

}

~~~

module/bdev/iscsi/bdev_iscsi.c

+1 −1
Original line number Diff line number Diff line
@@ -566,7 +566,7 @@ bdev_iscsi_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx 
	pthread_mutex_lock(&lun->mutex);

	spdk_json_write_object_begin(w);



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

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



	spdk_json_write_named_object_begin(w, "params");

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

module/bdev/iscsi/bdev_iscsi_rpc.c

+21 −19
Original line number Diff line number Diff line
@@ -38,20 +38,20 @@ 


#include "spdk_internal/log.h"



struct rpc_construct_iscsi_bdev {

struct rpc_bdev_iscsi_create {

	char *name;

	char *initiator_iqn;

	char *url;

};



static const struct spdk_json_object_decoder rpc_construct_iscsi_bdev_decoders[] = {

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

	{"initiator_iqn", offsetof(struct rpc_construct_iscsi_bdev, initiator_iqn), spdk_json_decode_string},

	{"url", offsetof(struct rpc_construct_iscsi_bdev, url), spdk_json_decode_string},

static const struct spdk_json_object_decoder rpc_bdev_iscsi_create_decoders[] = {

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

	{"initiator_iqn", offsetof(struct rpc_bdev_iscsi_create, initiator_iqn), spdk_json_decode_string},

	{"url", offsetof(struct rpc_bdev_iscsi_create, url), spdk_json_decode_string},

};



static void

free_rpc_construct_iscsi_bdev(struct rpc_construct_iscsi_bdev *req)

free_rpc_bdev_iscsi_create(struct rpc_bdev_iscsi_create *req)

{

	free(req->name);

	free(req->initiator_iqn);
@@ -59,7 +59,7 @@ free_rpc_construct_iscsi_bdev(struct rpc_construct_iscsi_bdev *req) 
}



static void

construct_iscsi_bdev_cb(void *cb_arg, struct spdk_bdev *bdev, int status)

bdev_iscsi_create_cb(void *cb_arg, struct spdk_bdev *bdev, int status)

{

	struct spdk_jsonrpc_request *request = cb_arg;

	struct spdk_json_write_ctx *w;
@@ -78,14 +78,14 @@ construct_iscsi_bdev_cb(void *cb_arg, struct spdk_bdev *bdev, int status) 
}



static void

spdk_rpc_construct_iscsi_bdev(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_iscsi_create(struct spdk_jsonrpc_request *request,

			   const struct spdk_json_val *params)

{

	struct rpc_construct_iscsi_bdev req = {};

	struct rpc_bdev_iscsi_create req = {};

	int rc = 0;



	if (spdk_json_decode_object(params, rpc_construct_iscsi_bdev_decoders,

				    SPDK_COUNTOF(rpc_construct_iscsi_bdev_decoders),

	if (spdk_json_decode_object(params, rpc_bdev_iscsi_create_decoders,

				    SPDK_COUNTOF(rpc_bdev_iscsi_create_decoders),

				    &req)) {

		SPDK_ERRLOG("spdk_json_decode_object failed\n");

		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
@@ -93,15 +93,16 @@ spdk_rpc_construct_iscsi_bdev(struct spdk_jsonrpc_request *request, 
		goto cleanup;

	}



	rc = create_iscsi_disk(req.name, req.url, req.initiator_iqn, construct_iscsi_bdev_cb, request);

	rc = create_iscsi_disk(req.name, req.url, req.initiator_iqn, bdev_iscsi_create_cb, request);

	if (rc) {

		spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));

	}



cleanup:

	free_rpc_construct_iscsi_bdev(&req);

	free_rpc_bdev_iscsi_create(&req);

}

SPDK_RPC_REGISTER("construct_iscsi_bdev", spdk_rpc_construct_iscsi_bdev, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER("bdev_iscsi_create", spdk_rpc_bdev_iscsi_create, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_iscsi_create, construct_iscsi_bdev)



struct rpc_delete_iscsi {

	char *name;
@@ -118,7 +119,7 @@ static const struct spdk_json_object_decoder rpc_delete_iscsi_decoders[] = { 
};



static void

_spdk_rpc_delete_iscsi_bdev_cb(void *cb_arg, int bdeverrno)

_spdk_rpc_bdev_iscsi_delete_cb(void *cb_arg, int bdeverrno)

{

	struct spdk_jsonrpc_request *request = cb_arg;

	struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request);
@@ -128,7 +129,7 @@ _spdk_rpc_delete_iscsi_bdev_cb(void *cb_arg, int bdeverrno) 
}



static void

spdk_rpc_delete_iscsi_bdev(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_iscsi_delete(struct spdk_jsonrpc_request *request,

			   const struct spdk_json_val *params)

{

	struct rpc_delete_iscsi req = {NULL};
@@ -148,9 +149,10 @@ spdk_rpc_delete_iscsi_bdev(struct spdk_jsonrpc_request *request, 
		goto cleanup;

	}



	delete_iscsi_disk(bdev, _spdk_rpc_delete_iscsi_bdev_cb, request);

	delete_iscsi_disk(bdev, _spdk_rpc_bdev_iscsi_delete_cb, request);



cleanup:

	free_rpc_delete_iscsi(&req);

}

SPDK_RPC_REGISTER("delete_iscsi_bdev", spdk_rpc_delete_iscsi_bdev, SPDK_RPC_RUNTIME)
 
SPDK_RPC_REGISTER("bdev_iscsi_delete", spdk_rpc_bdev_iscsi_delete, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_iscsi_delete, delete_iscsi_bdev)

scripts/rpc.py

+12 −11
Original line number Diff line number Diff line
@@ -497,26 +497,27 @@ if __name__ == "__main__": 
    p.add_argument('name', help='error bdev name')

    p.set_defaults(func=bdev_error_delete)



    def construct_iscsi_bdev(args):

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

    def bdev_iscsi_create(args):

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

                                              name=args.name,

                                              url=args.url,

                                              initiator_iqn=args.initiator_iqn))



    p = subparsers.add_parser('construct_iscsi_bdev',

    p = subparsers.add_parser('bdev_iscsi_create', aliases=['construct_iscsi_bdev'],

                              help='Add bdev with iSCSI initiator backend')

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

    p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True)

    p.add_argument('--url', help="iSCSI Lun URL", required=True)

    p.set_defaults(func=construct_iscsi_bdev)

    p.set_defaults(func=bdev_iscsi_create)



    def delete_iscsi_bdev(args):

        rpc.bdev.delete_iscsi_bdev(args.client,

    def bdev_iscsi_delete(args):

        rpc.bdev.bdev_iscsi_delete(args.client,

                                   name=args.name)



    p = subparsers.add_parser('delete_iscsi_bdev', help='Delete an iSCSI bdev')

    p = subparsers.add_parser('bdev_iscsi_delete', aliases=['delete_iscsi_bdev'],

                              help='Delete an iSCSI bdev')

    p.add_argument('name', help='iSCSI bdev name')

    p.set_defaults(func=delete_iscsi_bdev)

    p.set_defaults(func=bdev_iscsi_delete)



    def construct_pmem_bdev(args):

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