rpc: Rename set_bdev_nvme_options to bdev_nvme_set_options

Change-Id: I9050bdc82917fafd0de755a9449a3b6c4ee92da1
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466048
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
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>

doc/jsonrpc.md

@@ -1395,7 +1395,7 @@ Example response:
 }
 ~~~
 
-## set_bdev_nvme_options {#rpc_set_bdev_nvme_options}
+## bdev_nvme_set_options {#rpc_bdev_nvme_set_options}
 
 Set global parameters for all bdev NVMe. This RPC may only be called before SPDK subsystems have been initialized.
 
@@ -1425,7 +1425,7 @@ request:
     "io_queue_requests" : 2048,
   },
   "jsonrpc": "2.0",
-  "method": "set_bdev_nvme_options",
+  "method": "bdev_nvme_set_options",
   "id": 1
 }
 ~~~

module/bdev/nvme/bdev_nvme.c

@@ -2097,7 +2097,7 @@ bdev_nvme_config_json(struct spdk_json_write_ctx *w)
 
 	spdk_json_write_object_begin(w);
 
-	spdk_json_write_named_string(w, "method", "set_bdev_nvme_options");
+	spdk_json_write_named_string(w, "method", "bdev_nvme_set_options");
 
 	spdk_json_write_named_object_begin(w, "params");
 	spdk_json_write_named_string(w, "action_on_timeout", action);

module/bdev/nvme/bdev_nvme_rpc.c

@@ -79,7 +79,7 @@ static const struct spdk_json_object_decoder rpc_bdev_nvme_options_decoders[] =
 };
 
 static void
-spdk_rpc_set_bdev_nvme_options(struct spdk_jsonrpc_request *request,
+spdk_rpc_bdev_nvme_set_options(struct spdk_jsonrpc_request *request,
 			       const struct spdk_json_val *params)
 {
 	struct spdk_bdev_nvme_opts opts;
@@ -108,7 +108,8 @@ spdk_rpc_set_bdev_nvme_options(struct spdk_jsonrpc_request *request,
 
 	return;
 }
-SPDK_RPC_REGISTER("set_bdev_nvme_options", spdk_rpc_set_bdev_nvme_options, SPDK_RPC_STARTUP)
+SPDK_RPC_REGISTER("bdev_nvme_set_options", spdk_rpc_bdev_nvme_set_options, SPDK_RPC_STARTUP)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(set_bdev_nvme_options, bdev_nvme_set_options)
 
 struct rpc_bdev_nvme_hotplug {
 	bool enabled;

scripts/config_converter.py

@@ -9,7 +9,7 @@ from collections import OrderedDict
 bdev_dict = OrderedDict()
 bdev_dict["set_bdev_options"] = []
 bdev_dict["construct_split_vbdev"] = []
-bdev_dict["set_bdev_nvme_options"] = []
+bdev_dict["bdev_nvme_set_options"] = []
 bdev_dict["construct_nvme_bdev"] = []
 bdev_dict["set_bdev_nvme_hotplug"] = []
 bdev_dict["bdev_malloc_create"] = []
@@ -242,7 +242,7 @@ def get_nvme_bdev_json(config, section):
     })
     nvme_json.append({
         "params": to_json_params(params[0:5]),
-        "method": "set_bdev_nvme_options"
+        "method": "bdev_nvme_set_options"
     })
     return nvme_json
 

scripts/rpc.py

@@ -318,8 +318,8 @@ if __name__ == "__main__":
     p.add_argument('name', help='aio bdev name')
     p.set_defaults(func=bdev_aio_delete)
 
-    def set_bdev_nvme_options(args):
+    def bdev_nvme_set_options(args):
-        rpc.bdev.set_bdev_nvme_options(args.client,
+        rpc.bdev.bdev_nvme_set_options(args.client,
                                        action_on_timeout=args.action_on_timeout,
                                        timeout_us=args.timeout_us,
                                        retry_count=args.retry_count,
@@ -327,7 +327,7 @@ if __name__ == "__main__":
                                        nvme_ioq_poll_period_us=args.nvme_ioq_poll_period_us,
                                        io_queue_requests=args.io_queue_requests)
 
-    p = subparsers.add_parser('set_bdev_nvme_options',
+    p = subparsers.add_parser('bdev_nvme_set_options', aliases=['set_bdev_nvme_options'],
                               help='Set options for the bdev nvme type. This is startup command.')
     p.add_argument('-a', '--action-on-timeout',
                    help="Action to take on command time out. Valid valies are: none, reset, abort")
@@ -341,7 +341,7 @@ if __name__ == "__main__":
                    help='How often to poll I/O queues for completions', type=int)
     p.add_argument('-s', '--io-queue-requests',
                    help='The number of requests allocated for each NVMe I/O queue. Default: 512', type=int)
-    p.set_defaults(func=set_bdev_nvme_options)
+    p.set_defaults(func=bdev_nvme_set_options)
 
     def set_bdev_nvme_hotplug(args):
         rpc.bdev.set_bdev_nvme_hotplug(args.client, enable=args.enable, period_us=args.period_us)

scripts/rpc/bdev.py

@@ -316,7 +316,8 @@ def bdev_aio_delete(client, name):
     return client.call('bdev_aio_delete', params)
 
 
-def set_bdev_nvme_options(client, action_on_timeout=None, timeout_us=None, retry_count=None,
+@deprecated_alias('set_bdev_nvme_options')
+def bdev_nvme_set_options(client, action_on_timeout=None, timeout_us=None, retry_count=None,
                           nvme_adminq_poll_period_us=None, nvme_ioq_poll_period_us=None, io_queue_requests=None):
     """Set options for the bdev nvme. This is startup command.
 
@@ -348,7 +349,7 @@ def set_bdev_nvme_options(client, action_on_timeout=None, timeout_us=None, retry
     if io_queue_requests:
         params['io_queue_requests'] = io_queue_requests
 
-    return client.call('set_bdev_nvme_options', params)
+    return client.call('bdev_nvme_set_options', params)
 
 
 def set_bdev_nvme_hotplug(client, enable, period_us=None):

test/config_converter/spdk_config.json

@@ -38,7 +38,7 @@
             "nvme_ioq_poll_period_us": 0,
             "action_on_timeout": "none"
           },
-          "method": "set_bdev_nvme_options"
+          "method": "bdev_nvme_set_options"
         },
         {
           "params": {

test/config_converter/spdk_config_virtio.json

@@ -30,7 +30,7 @@
             "nvme_ioq_poll_period_us": 0,
             "action_on_timeout": "none"
           },
-          "method": "set_bdev_nvme_options"
+          "method": "bdev_nvme_set_options"
         },
         {
           "params": {

test/iscsi_tgt/fio/iscsi.json

@@ -10,7 +10,7 @@
             "nvme_ioq_poll_period_us": 0,
             "action_on_timeout": "none"
           },
-          "method": "set_bdev_nvme_options"
+          "method": "bdev_nvme_set_options"
         }
       ]
     },

test/json_config/config_filter.py

@@ -28,7 +28,7 @@ def filter_methods(do_remove_global_rpcs):
         'set_nvmf_target_max_subsystems',
         'nvmf_create_transport',
         'set_bdev_options',
-        'set_bdev_nvme_options',
+        'bdev_nvme_set_options',
         'set_bdev_nvme_hotplug',
     ]