Commit 3402bfbd authored by Pawel Kaminski's avatar Pawel Kaminski Committed by Jim Harris
Browse files

rpc: Rename kill_instance to spdk_kill_instance 



Change-Id: Iebd24cc1be4665f179975f6fc14e0d4c3849d506
Signed-off-by: default avatarPawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468901


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 0772af4d

doc/jsonrpc.md

+3 −3
Original line number Diff line number Diff line
@@ -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",

module/event/rpc/app_rpc.c

+13 −12
Original line number Diff line number Diff line
@@ -42,22 +42,22 @@ 


#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,

spdk_rpc_spdk_kill_instance(struct spdk_jsonrpc_request *request,

			    const struct spdk_json_val *params)

{

	static const struct {
@@ -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 {

scripts/rpc.py

+6 −5
Original line number Diff line number Diff line
@@ -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,

    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

scripts/rpc/app.py

+6 −2
Original line number Diff line number Diff line 
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):

scripts/rpc/client.py

+1 −1
Original line number Diff line number Diff line
@@ -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: