From 9f5cbf4c7f2022ce9fba85a665a1364e85a7ee07 Mon Sep 17 00:00:00 2001 From: Maciej Wawryk Date: Thu, 22 Aug 2019 12:51:25 +0200 Subject: [PATCH] RPC: rename bdev_iscsi RPCs Rename: *delete_iscsi_bdev to bdev_iscsi_delete *construct_iscsi_bdev to bdev_iscsi_create Signed-off-by: Maciej Wawryk Change-Id: I7bef397872b9d31eab0ce363e59922c68f5bed00 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466030 Reviewed-by: Broadcom SPDK FC-NVMe CI Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto Tested-by: SPDK CI Jenkins --- doc/bdev.md | 2 +- doc/jsonrpc.md | 8 +++--- module/bdev/iscsi/bdev_iscsi.c | 2 +- module/bdev/iscsi/bdev_iscsi_rpc.c | 40 ++++++++++++++++-------------- scripts/rpc.py | 23 +++++++++-------- scripts/rpc/bdev.py | 10 +++++--- scripts/spdkcli/ui_node.py | 2 +- scripts/spdkcli/ui_root.py | 6 ++--- 8 files changed, 49 insertions(+), 44 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 10b81c5a1..de7d8dd83 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -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://[[%]@][:]//` diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 8236ee0d8..de649ce54 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -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 } ~~~ diff --git a/module/bdev/iscsi/bdev_iscsi.c b/module/bdev/iscsi/bdev_iscsi.c index c751fa869..45cd89c94 100644 --- a/module/bdev/iscsi/bdev_iscsi.c +++ b/module/bdev/iscsi/bdev_iscsi.c @@ -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); diff --git a/module/bdev/iscsi/bdev_iscsi_rpc.c b/module/bdev/iscsi/bdev_iscsi_rpc.c index 5a4f07b26..ba2146d04 100644 --- a/module/bdev/iscsi/bdev_iscsi_rpc.c +++ b/module/bdev/iscsi/bdev_iscsi_rpc.c @@ -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, - const struct spdk_json_val *params) +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) diff --git a/scripts/rpc.py b/scripts/rpc.py index 114aba620..4b6fade70 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -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, - name=args.name, - url=args.url, - initiator_iqn=args.initiator_iqn)) + 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, diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index ef327c56d..7e8116f4f 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -539,7 +539,8 @@ def bdev_error_delete(client, name): 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. Args: @@ -555,17 +556,18 @@ def construct_iscsi_bdev(client, name, url, initiator_iqn): 'url': url, '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. Args: bdev_name: name of iSCSI bdev to delete """ 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): diff --git a/scripts/spdkcli/ui_node.py b/scripts/spdkcli/ui_node.py index 4c37a7099..4eb5e2ac6 100644 --- a/scripts/spdkcli/ui_node.py +++ b/scripts/spdkcli/ui_node.py @@ -487,7 +487,7 @@ class UIiSCSIBdev(UIBdev): UIBdev.__init__(self, "iscsi", parent) 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): """ diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index c3c7063b5..873fde151 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -136,12 +136,12 @@ class UIRoot(UINode): @verbose 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 @verbose - def delete_iscsi_bdev(self, **kwargs): - rpc.bdev.delete_iscsi_bdev(self.client, **kwargs) + def bdev_iscsi_delete(self, **kwargs): + rpc.bdev.bdev_iscsi_delete(self.client, **kwargs) @verbose def bdev_aio_create(self, **kwargs):