Spdk/lib/event/rpc/app_rpc.c
Shuhei Matsumoto e008db08e7 rpc: Add state_mask to each RPC method to make sets of RPCs
Add state_mask to each RPC method and state to RPC server, respectively.
State mask of RPC method is set at registration. State of RPC server
is changed according to the state of the SPDK.

When any RPC method is recieved, if the bit of the RPC server is on in
the state mask of the RPC method, it is allowed. Otherwise, it is
rejected.

When any RPC is rejected by state_mask control, the new error code
is returned to describe the error clearly.

Change-Id: I84e52b8725a286e9329d61c56f498aa2c8664ec1
Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-on: https://review.gerrithub.io/407397
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2018-05-03 19:48:15 +00:00

156 lines
4.7 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "spdk/stdinc.h"
#include "spdk/event.h"
#include "spdk/rpc.h"
#include "spdk/util.h"
#include "spdk_internal/log.h"
struct rpc_kill_instance {
char *sig_name;
};
static void
free_rpc_kill_instance(struct rpc_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 void
spdk_rpc_kill_instance(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
static const struct {
const char *signal_string;
int32_t signal;
} signals[] = {
{"SIGINT", SIGINT},
{"SIGTERM", SIGTERM},
{"SIGQUIT", SIGQUIT},
{"SIGHUP", SIGHUP},
{"SIGKILL", SIGKILL},
};
size_t i, sig_count;
int signal;
struct rpc_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),
&req)) {
SPDK_DEBUGLOG(SPDK_LOG_REACTOR, "spdk_json_decode_object failed\n");
goto invalid;
}
sig_count = SPDK_COUNTOF(signals);
signal = atoi(req.sig_name);
for (i = 0 ; i < sig_count; i++) {
if (strcmp(req.sig_name, signals[i].signal_string) == 0 ||
signal == signals[i].signal) {
break;
}
}
if (i == sig_count) {
goto invalid;
}
SPDK_DEBUGLOG(SPDK_LOG_REACTOR, "sending signal %d\n", signals[i].signal);
free_rpc_kill_instance(&req);
kill(getpid(), signals[i].signal);
w = spdk_jsonrpc_begin_result(request);
if (w == NULL) {
return;
}
spdk_json_write_bool(w, true);
spdk_jsonrpc_end_result(request, w);
return;
invalid:
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
free_rpc_kill_instance(&req);
}
SPDK_RPC_REGISTER("kill_instance", spdk_rpc_kill_instance, SPDK_RPC_RUNTIME)
struct rpc_context_switch_monitor {
bool enabled;
};
static const struct spdk_json_object_decoder rpc_context_switch_monitor_decoders[] = {
{"enabled", offsetof(struct rpc_context_switch_monitor, enabled), spdk_json_decode_bool},
};
static void
spdk_rpc_context_switch_monitor(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_context_switch_monitor req = {};
struct spdk_json_write_ctx *w;
if (params != NULL) {
if (spdk_json_decode_object(params, rpc_context_switch_monitor_decoders,
SPDK_COUNTOF(rpc_context_switch_monitor_decoders),
&req)) {
SPDK_DEBUGLOG(SPDK_LOG_REACTOR, "spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
return;
}
spdk_reactor_enable_context_switch_monitor(req.enabled);
}
w = spdk_jsonrpc_begin_result(request);
if (w == NULL) {
return;
}
spdk_json_write_object_begin(w);
spdk_json_write_name(w, "enabled");
spdk_json_write_bool(w, spdk_reactor_context_switch_monitor_enabled());
spdk_json_write_object_end(w);
spdk_jsonrpc_end_result(request, w);
}
SPDK_RPC_REGISTER("context_switch_monitor", spdk_rpc_context_switch_monitor, SPDK_RPC_RUNTIME)