ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

RPC: rename bdev_iscsi RPCs

Browse Source 
Rename:
*delete_iscsi_bdev to bdev_iscsi_delete
*construct_iscsi_bdev to bdev_iscsi_create

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I7bef397872b9d31eab0ce363e59922c68f5bed00
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466030
Reviewed-by: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Maciej Wawryk 2019-08-22 12:51:25 +02:00 committed by Jim Harris
parent b9d5e78852
commit 9f5cbf4c7f
8 changed files with 49 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/bdev.md
View File

@ -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 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. 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: The URL is in the following format:
`iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn>/<lun>` `iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn>/<lun>`

8
doc/jsonrpc.md
View File

@ -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. Connect to iSCSI target and create bdev backed by this connection.
@ -1953,7 +1953,7 @@ Example request:
"name": "iSCSI0" "name": "iSCSI0"
}, },
"jsonrpc": "2.0", "jsonrpc": "2.0",
"method": "construct_iscsi_bdev", "method": "bdev_iscsi_create",
"id": 1 "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. Delete iSCSI bdev and terminate connection to target.
@ -1990,7 +1990,7 @@ Example request:
"name": "iSCSI0" "name": "iSCSI0"
}, },
"jsonrpc": "2.0", "jsonrpc": "2.0",
"method": "delete_iscsi_bdev", "method": "bdev_iscsi_delete",
"id": 1 "id": 1
} }
~~~ ~~~

2
module/bdev/iscsi/bdev_iscsi.c
View File

@ -566,7 +566,7 @@ bdev_iscsi_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx
pthread_mutex_lock(&lun->mutex); pthread_mutex_lock(&lun->mutex);
spdk_json_write_object_begin(w); 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_object_begin(w, "params");
spdk_json_write_named_string(w, "name", bdev->name); spdk_json_write_named_string(w, "name", bdev->name);

40
module/bdev/iscsi/bdev_iscsi_rpc.c
View File

@ -38,20 +38,20 @@
#include "spdk_internal/log.h" #include "spdk_internal/log.h"
struct rpc_construct_iscsi_bdev { struct rpc_bdev_iscsi_create {
char *name; char *name;
char *initiator_iqn; char *initiator_iqn;
char *url; char *url;
}; };
static const struct spdk_json_object_decoder rpc_construct_iscsi_bdev_decoders[] = { static const struct spdk_json_object_decoder rpc_bdev_iscsi_create_decoders[] = {
{"name", offsetof(struct rpc_construct_iscsi_bdev, name), spdk_json_decode_string}, {"name", offsetof(struct rpc_bdev_iscsi_create, name), spdk_json_decode_string},
{"initiator_iqn", offsetof(struct rpc_construct_iscsi_bdev, initiator_iqn), spdk_json_decode_string}, {"initiator_iqn", offsetof(struct rpc_bdev_iscsi_create, initiator_iqn), spdk_json_decode_string},
{"url", offsetof(struct rpc_construct_iscsi_bdev, url), spdk_json_decode_string}, {"url", offsetof(struct rpc_bdev_iscsi_create, url), spdk_json_decode_string},
}; };
static void 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->name);
free(req->initiator_iqn); free(req->initiator_iqn);
@ -59,7 +59,7 @@ free_rpc_construct_iscsi_bdev(struct rpc_construct_iscsi_bdev *req)
} }
static void 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_jsonrpc_request *request = cb_arg;
struct spdk_json_write_ctx *w; 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 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) const struct spdk_json_val *params)
{ {
struct rpc_construct_iscsi_bdev req = {}; struct rpc_bdev_iscsi_create req = {};
int rc = 0; int rc = 0;
if (spdk_json_decode_object(params, rpc_construct_iscsi_bdev_decoders, if (spdk_json_decode_object(params, rpc_bdev_iscsi_create_decoders,
SPDK_COUNTOF(rpc_construct_iscsi_bdev_decoders), SPDK_COUNTOF(rpc_bdev_iscsi_create_decoders),
&req)) { &req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n"); SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, 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; 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) { if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc)); spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
} }
cleanup: 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 { struct rpc_delete_iscsi {
char *name; char *name;
@ -118,7 +119,7 @@ static const struct spdk_json_object_decoder rpc_delete_iscsi_decoders[] = {
}; };
static void 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_jsonrpc_request *request = cb_arg;
struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request); 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 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) const struct spdk_json_val *params)
{ {
struct rpc_delete_iscsi req = {NULL}; struct rpc_delete_iscsi req = {NULL};
@ -148,9 +149,10 @@ spdk_rpc_delete_iscsi_bdev(struct spdk_jsonrpc_request *request,
goto cleanup; 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: cleanup:
free_rpc_delete_iscsi(&req); 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)

23
scripts/rpc.py
View File

@ -497,26 +497,27 @@ if __name__ == "__main__":
p.add_argument('name', help='error bdev name') p.add_argument('name', help='error bdev name')
p.set_defaults(func=bdev_error_delete) p.set_defaults(func=bdev_error_delete)
def construct_iscsi_bdev(args): def bdev_iscsi_create(args):
print_json(rpc.bdev.construct_iscsi_bdev(args.client, print_json(rpc.bdev.bdev_iscsi_create(args.client,
name=args.name, name=args.name,
url=args.url, url=args.url,
initiator_iqn=args.initiator_iqn)) 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') help='Add bdev with iSCSI initiator backend')
p.add_argument('-b', '--name', help="Name of the bdev", required=True) 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('-i', '--initiator-iqn', help="Initiator IQN", required=True)
p.add_argument('--url', help="iSCSI Lun URL", 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): def bdev_iscsi_delete(args):
rpc.bdev.delete_iscsi_bdev(args.client, rpc.bdev.bdev_iscsi_delete(args.client,
name=args.name) 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.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): def construct_pmem_bdev(args):
print_json(rpc.bdev.construct_pmem_bdev(args.client, print_json(rpc.bdev.construct_pmem_bdev(args.client,

10
scripts/rpc/bdev.py
View File

@ -539,7 +539,8 @@ def bdev_error_delete(client, name):
return client.call('bdev_error_delete', params) return client.call('bdev_error_delete', params)
def construct_iscsi_bdev(client, name, url, initiator_iqn): @deprecated_alias('construct_iscsi_bdev')
def bdev_iscsi_create(client, name, url, initiator_iqn):
"""Construct a iSCSI block device. """Construct a iSCSI block device.
Args: Args:
@ -555,17 +556,18 @@ def construct_iscsi_bdev(client, name, url, initiator_iqn):
'url': url, 'url': url,
'initiator_iqn': initiator_iqn, 'initiator_iqn': initiator_iqn,
} }
return client.call('construct_iscsi_bdev', params) return client.call('bdev_iscsi_create', params)
def delete_iscsi_bdev(client, name): @deprecated_alias('delete_iscsi_bdev')
def bdev_iscsi_delete(client, name):
"""Remove iSCSI bdev from the system. """Remove iSCSI bdev from the system.
Args: Args:
bdev_name: name of iSCSI bdev to delete bdev_name: name of iSCSI bdev to delete
""" """
params = {'name': name} params = {'name': name}
return client.call('delete_iscsi_bdev', params) return client.call('bdev_iscsi_delete', params)
def construct_pmem_bdev(client, pmem_file, name): def construct_pmem_bdev(client, pmem_file, name):

2
scripts/spdkcli/ui_node.py
View File

@ -487,7 +487,7 @@ class UIiSCSIBdev(UIBdev):
UIBdev.__init__(self, "iscsi", parent) UIBdev.__init__(self, "iscsi", parent)
def delete(self, name): def delete(self, name):
self.get_root().delete_iscsi_bdev(name=name) self.get_root().bdev_iscsi_delete(name=name)
def ui_command_create(self, name, url, initiator_iqn): def ui_command_create(self, name, url, initiator_iqn):
""" """

6
scripts/spdkcli/ui_root.py
View File

@ -136,12 +136,12 @@ class UIRoot(UINode):
@verbose @verbose
def create_iscsi_bdev(self, **kwargs): def create_iscsi_bdev(self, **kwargs):
response = rpc.bdev.construct_iscsi_bdev(self.client, **kwargs) response = rpc.bdev.bdev_iscsi_create(self.client, **kwargs)
return response return response
@verbose @verbose
def delete_iscsi_bdev(self, **kwargs): def bdev_iscsi_delete(self, **kwargs):
rpc.bdev.delete_iscsi_bdev(self.client, **kwargs) rpc.bdev.bdev_iscsi_delete(self.client, **kwargs)
@verbose @verbose
def bdev_aio_create(self, **kwargs): def bdev_aio_create(self, **kwargs):