From 5a2c29935c696a7cd06fd04a440fefb0f3a2fe44 Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Tue, 27 Aug 2019 15:49:10 -0400 Subject: [PATCH] rpc: Rename get_nvme_controllers to bdev_nvme_get_controllers Change-Id: Icddffe0293116f96e7cf4468a829b838f36a4531 Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466465 Tested-by: SPDK CI Jenkins Reviewed-by: Paul Luse Reviewed-by: Jim Harris Reviewed-by: Ben Walker --- doc/jsonrpc.md | 4 ++-- module/bdev/nvme/bdev_nvme_rpc.c | 23 ++++++++++++----------- scripts/rpc.py | 11 ++++++----- scripts/rpc/nvme.py | 6 ++++-- test/json_config/clear_config.py | 2 +- 5 files changed, 25 insertions(+), 21 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 7fb595286..60ce1d519 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -1532,7 +1532,7 @@ Example response: } ~~~ -## get_nvme_controllers {#rpc_get_nvme_controllers} +## bdev_nvme_get_controllers {#rpc_bdev_nvme_get_controllers} Get information about NVMe controllers. @@ -1557,7 +1557,7 @@ Example request: { "jsonrpc": "2.0", "id": 1, - "method": "get_nvme_controllers", + "method": "bdev_nvme_get_controllers", "params": { "name": "Nvme0" } diff --git a/module/bdev/nvme/bdev_nvme_rpc.c b/module/bdev/nvme/bdev_nvme_rpc.c index 810335b0a..acde20cda 100644 --- a/module/bdev/nvme/bdev_nvme_rpc.c +++ b/module/bdev/nvme/bdev_nvme_rpc.c @@ -344,30 +344,30 @@ spdk_rpc_dump_nvme_controller_info(struct spdk_json_write_ctx *w, spdk_json_write_object_end(w); } -struct rpc_get_nvme_controllers { +struct rpc_bdev_nvme_get_controllers { char *name; }; static void -free_rpc_get_nvme_controllers(struct rpc_get_nvme_controllers *r) +free_rpc_bdev_nvme_get_controllers(struct rpc_bdev_nvme_get_controllers *r) { free(r->name); } -static const struct spdk_json_object_decoder rpc_get_nvme_controllers_decoders[] = { - {"name", offsetof(struct rpc_get_nvme_controllers, name), spdk_json_decode_string, true}, +static const struct spdk_json_object_decoder rpc_bdev_nvme_get_controllers_decoders[] = { + {"name", offsetof(struct rpc_bdev_nvme_get_controllers, name), spdk_json_decode_string, true}, }; static void -spdk_rpc_get_nvme_controllers(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_bdev_nvme_get_controllers(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { - struct rpc_get_nvme_controllers req = {}; + struct rpc_bdev_nvme_get_controllers req = {}; struct spdk_json_write_ctx *w; struct nvme_bdev_ctrlr *ctrlr = NULL; - if (params && spdk_json_decode_object(params, rpc_get_nvme_controllers_decoders, - SPDK_COUNTOF(rpc_get_nvme_controllers_decoders), + if (params && spdk_json_decode_object(params, rpc_bdev_nvme_get_controllers_decoders, + SPDK_COUNTOF(rpc_bdev_nvme_get_controllers_decoders), &req)) { SPDK_ERRLOG("spdk_json_decode_object failed\n"); spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, @@ -400,9 +400,10 @@ spdk_rpc_get_nvme_controllers(struct spdk_jsonrpc_request *request, spdk_jsonrpc_end_result(request, w); cleanup: - free_rpc_get_nvme_controllers(&req); + free_rpc_bdev_nvme_get_controllers(&req); } -SPDK_RPC_REGISTER("get_nvme_controllers", spdk_rpc_get_nvme_controllers, SPDK_RPC_RUNTIME) +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 { char *name; diff --git a/scripts/rpc.py b/scripts/rpc.py index 7c146e865..630ffcb3b 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -391,14 +391,15 @@ if __name__ == "__main__": help='Enable checking of PI guard for I/O processing.', action='store_true') p.set_defaults(func=construct_nvme_bdev) - def get_nvme_controllers(args): - print_dict(rpc.nvme.get_nvme_controllers(args.client, - name=args.name)) + def bdev_nvme_get_controllers(args): + print_dict(rpc.nvme.bdev_nvme_get_controllers(args.client, + name=args.name)) p = subparsers.add_parser( - 'get_nvme_controllers', help='Display current NVMe controllers list or required NVMe controller') + 'bdev_nvme_get_controllers', aliases=['get_nvme_controllers'], + help='Display current NVMe controllers list or required NVMe controller') p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False) - p.set_defaults(func=get_nvme_controllers) + p.set_defaults(func=bdev_nvme_get_controllers) def delete_nvme_controller(args): rpc.bdev.delete_nvme_controller(args.client, diff --git a/scripts/rpc/nvme.py b/scripts/rpc/nvme.py index a889474bc..eac753e71 100644 --- a/scripts/rpc/nvme.py +++ b/scripts/rpc/nvme.py @@ -1,3 +1,4 @@ +from .helpers import deprecated_alias def send_nvme_cmd(client, name, cmd_type, data_direction, cmdbuf, @@ -39,7 +40,8 @@ def send_nvme_cmd(client, name, cmd_type, data_direction, cmdbuf, return client.call('send_nvme_cmd', params) -def get_nvme_controllers(client, name=None): +@deprecated_alias('get_nvme_controllers') +def bdev_nvme_get_controllers(client, name=None): """Get information about NVMe controllers. Args: @@ -51,4 +53,4 @@ def get_nvme_controllers(client, name=None): params = {} if name: params['name'] = name - return client.call('get_nvme_controllers', params) + return client.call('bdev_nvme_get_controllers', params) diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index f658763ec..493fb17d9 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -62,7 +62,7 @@ def clear_bdev_subsystem(args, bdev_config): if destroy_method: args.client.call(destroy_method, {bdev_name_key: bdev_name}) - nvme_controllers = args.client.call("get_nvme_controllers") + nvme_controllers = args.client.call("bdev_nvme_get_controllers") for ctrlr in nvme_controllers: args.client.call('delete_nvme_controller', {'name': ctrlr['name']})