From 3402bfbd7c4fdf36d5c0aa1c5a2d04cb682a7a0d Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Thu, 19 Sep 2019 17:13:36 -0400 Subject: [PATCH] rpc: Rename kill_instance to spdk_kill_instance Change-Id: Iebd24cc1be4665f179975f6fc14e0d4c3849d506 Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468901 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Paul Luse Reviewed-by: Ben Walker Reviewed-by: Shuhei Matsumoto --- doc/jsonrpc.md | 6 ++--- module/event/rpc/app_rpc.c | 25 +++++++++++---------- scripts/rpc.py | 11 ++++----- scripts/rpc/app.py | 8 +++++-- scripts/rpc/client.py | 2 +- test/iscsi_tgt/ip_migration/ip_migration.sh | 6 ++--- test/json_config/json_config.sh | 2 +- 7 files changed, 33 insertions(+), 27 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index f281dfe43..af2570d4c 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -56,7 +56,7 @@ This type of error is most common one. It mean that there is an error while proc # App Framework {#jsonrpc_components_app} -## kill_instance {#rpc_kill_instance} +## spdk_kill_instance {#rpc_spdk_kill_instance} Send a signal to the application. @@ -74,7 +74,7 @@ Example request: { "jsonrpc": "2.0", "id": 1, - "method": "kill_instance", + "method": "spdk_kill_instance", "params": { "sig_name": "SIGINT" } @@ -278,7 +278,7 @@ Example response: "get_subsystem_config", "get_subsystems", "context_switch_monitor", - "kill_instance", + "spdk_kill_instance", "ioat_scan_copy_engine", "bdev_virtio_attach_controller", "bdev_virtio_scsi_get_devices", diff --git a/module/event/rpc/app_rpc.c b/module/event/rpc/app_rpc.c index 2f7455c24..b208773e2 100644 --- a/module/event/rpc/app_rpc.c +++ b/module/event/rpc/app_rpc.c @@ -42,23 +42,23 @@ #include "spdk_internal/log.h" -struct rpc_kill_instance { +struct rpc_spdk_kill_instance { char *sig_name; }; static void -free_rpc_kill_instance(struct rpc_kill_instance *req) +free_rpc_spdk_kill_instance(struct rpc_spdk_kill_instance *req) { free(req->sig_name); } -static const struct spdk_json_object_decoder rpc_kill_instance_decoders[] = { - {"sig_name", offsetof(struct rpc_kill_instance, sig_name), spdk_json_decode_string}, +static const struct spdk_json_object_decoder rpc_spdk_kill_instance_decoders[] = { + {"sig_name", offsetof(struct rpc_spdk_kill_instance, sig_name), spdk_json_decode_string}, }; static void -spdk_rpc_kill_instance(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_spdk_kill_instance(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { static const struct { const char *signal_string; @@ -72,11 +72,11 @@ spdk_rpc_kill_instance(struct spdk_jsonrpc_request *request, }; size_t i, sig_count; int signal; - struct rpc_kill_instance req = {}; + struct rpc_spdk_kill_instance req = {}; struct spdk_json_write_ctx *w; - if (spdk_json_decode_object(params, rpc_kill_instance_decoders, - SPDK_COUNTOF(rpc_kill_instance_decoders), + if (spdk_json_decode_object(params, rpc_spdk_kill_instance_decoders, + SPDK_COUNTOF(rpc_spdk_kill_instance_decoders), &req)) { SPDK_DEBUGLOG(SPDK_LOG_REACTOR, "spdk_json_decode_object failed\n"); goto invalid; @@ -96,7 +96,7 @@ spdk_rpc_kill_instance(struct spdk_jsonrpc_request *request, } SPDK_DEBUGLOG(SPDK_LOG_REACTOR, "sending signal %d\n", signals[i].signal); - free_rpc_kill_instance(&req); + free_rpc_spdk_kill_instance(&req); kill(getpid(), signals[i].signal); w = spdk_jsonrpc_begin_result(request); @@ -106,9 +106,10 @@ spdk_rpc_kill_instance(struct spdk_jsonrpc_request *request, invalid: spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); - free_rpc_kill_instance(&req); + free_rpc_spdk_kill_instance(&req); } -SPDK_RPC_REGISTER("kill_instance", spdk_rpc_kill_instance, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("spdk_kill_instance", spdk_rpc_spdk_kill_instance, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(spdk_kill_instance, kill_instance) struct rpc_context_switch_monitor { diff --git a/scripts/rpc.py b/scripts/rpc.py index df1de5db5..ef90c1d40 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -108,13 +108,14 @@ if __name__ == "__main__": p.set_defaults(func=load_subsystem_config) # app - def kill_instance(args): - rpc.app.kill_instance(args.client, - sig_name=args.sig_name) + def spdk_kill_instance(args): + rpc.app.spdk_kill_instance(args.client, + sig_name=args.sig_name) - p = subparsers.add_parser('kill_instance', help='Send signal to instance') + p = subparsers.add_parser('spdk_kill_instance', aliases=['kill_instance'], + help='Send signal to instance') p.add_argument('sig_name', help='signal will be sent to server.') - p.set_defaults(func=kill_instance) + p.set_defaults(func=spdk_kill_instance) def context_switch_monitor(args): enabled = None diff --git a/scripts/rpc/app.py b/scripts/rpc/app.py index 9e8a0fc87..c964fb277 100644 --- a/scripts/rpc/app.py +++ b/scripts/rpc/app.py @@ -1,11 +1,15 @@ -def kill_instance(client, sig_name): +from .helpers import deprecated_alias + + +@deprecated_alias('kill_instance') +def spdk_kill_instance(client, sig_name): """Send a signal to the SPDK process. Args: sig_name: signal to send ("SIGINT", "SIGTERM", "SIGQUIT", "SIGHUP", or "SIGKILL") """ params = {'sig_name': sig_name} - return client.call('kill_instance', params) + return client.call('spdk_kill_instance', params) def context_switch_monitor(client, enabled=None): diff --git a/scripts/rpc/client.py b/scripts/rpc/client.py index 9f5cf73e7..f443e114f 100644 --- a/scripts/rpc/client.py +++ b/scripts/rpc/client.py @@ -151,7 +151,7 @@ class JSONRPCClient(object): response = self.recv() except JSONRPCException as e: """ Don't expect response to kill """ - if not self.sock and method == "kill_instance": + if not self.sock and method == "spdk_kill_instance": self._logger.info("Connection terminated but ignoring since method is '%s'" % method) return {} else: diff --git a/test/iscsi_tgt/ip_migration/ip_migration.sh b/test/iscsi_tgt/ip_migration/ip_migration.sh index 17586c9f0..8425d2522 100755 --- a/test/iscsi_tgt/ip_migration/ip_migration.sh +++ b/test/iscsi_tgt/ip_migration/ip_migration.sh @@ -21,7 +21,7 @@ MIGRATION_ADDRESS=127.0.0.2 function kill_all_iscsi_target() { for ((i = 0; i < 2; i++)); do rpc_addr="/var/tmp/spdk${i}.sock" - $rpc_py -s $rpc_addr kill_instance SIGTERM + $rpc_py -s $rpc_addr spdk_kill_instance SIGTERM done } @@ -78,7 +78,7 @@ $fio_py -p iscsi -i 4096 -d 32 -t randrw -r 10 & fiopid=$! sleep 5 -$rpc_py -s $rpc_first_addr kill_instance SIGTERM +$rpc_py -s $rpc_first_addr spdk_kill_instance SIGTERM rpc_second_addr="/var/tmp/spdk1.sock" rpc_add_target_node $rpc_second_addr @@ -89,7 +89,7 @@ trap - SIGINT SIGTERM EXIT iscsicleanup -$rpc_py -s $rpc_second_addr kill_instance SIGTERM +$rpc_py -s $rpc_second_addr spdk_kill_instance SIGTERM iscsitestfini $1 $2 report_test_completion "iscsi_ip_migration" timing_exit ip_migration diff --git a/test/json_config/json_config.sh b/test/json_config/json_config.sh index 268772960..7f05464f0 100755 --- a/test/json_config/json_config.sh +++ b/test/json_config/json_config.sh @@ -129,7 +129,7 @@ function json_config_test_shutdown_app() { [[ -n "${#app_socket[$app]}" ]] [[ -n "${app_pid[$app]}" ]] - # kill_instance RPC will trigger ASAN + # spdk_kill_instance RPC will trigger ASAN kill -SIGINT ${app_pid[$app]} for (( i=0; i<30; i++ )); do