app: add option to read json configuration files during startup
New '--json' long option is added to load JSON configuration file during startup. Change-Id: I2a89b7b98b3957e53758dd06686307caf7ec6090 Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com> Reviewed-on: https://review.gerrithub.io/c/430356 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
This commit is contained in:
parent
2b787d487e
commit
8687128696
@ -89,6 +89,7 @@ typedef void (*spdk_sighandler_t)(int signal);
|
||||
struct spdk_app_opts {
|
||||
const char *name;
|
||||
const char *config_file;
|
||||
const char *json_config_file;
|
||||
const char *rpc_addr; /* Can be UNIX domain socket path or IP address + TCP port */
|
||||
const char *reactor_mask;
|
||||
const char *tpoint_group_mask;
|
||||
|
@ -35,7 +35,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)
|
||||
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
|
||||
|
||||
LIBNAME = event
|
||||
C_SRCS = app.c reactor.c rpc.c subsystem.c
|
||||
C_SRCS = app.c reactor.c rpc.c subsystem.c json_config.c
|
||||
|
||||
DIRS-y = rpc subsystems
|
||||
|
||||
|
@ -44,6 +44,8 @@
|
||||
#include "spdk/rpc.h"
|
||||
#include "spdk/util.h"
|
||||
|
||||
#include "json_config.h"
|
||||
|
||||
#define SPDK_APP_DEFAULT_LOG_LEVEL SPDK_LOG_NOTICE
|
||||
#define SPDK_APP_DEFAULT_LOG_PRINT_LEVEL SPDK_LOG_INFO
|
||||
#define SPDK_APP_DEFAULT_BACKTRACE_LOG_LEVEL SPDK_LOG_ERROR
|
||||
@ -121,6 +123,8 @@ static const struct option g_cmdline_options[] = {
|
||||
{"num-trace-entries", required_argument, NULL, NUM_TRACE_ENTRIES_OPT_IDX},
|
||||
#define MAX_REACTOR_DELAY_OPT_IDX 261
|
||||
{"max-delay", required_argument, NULL, MAX_REACTOR_DELAY_OPT_IDX},
|
||||
#define JSON_CONFIG_OPT_IDX 262
|
||||
{"json", required_argument, NULL, JSON_CONFIG_OPT_IDX},
|
||||
};
|
||||
|
||||
/* Global section */
|
||||
@ -357,6 +361,15 @@ spdk_app_start_rpc(void *arg1, void *arg2)
|
||||
}
|
||||
}
|
||||
|
||||
static void
|
||||
_spdk_app_json_config_load(void *_app_opts, void *_event_done)
|
||||
{
|
||||
struct spdk_app_opts *app_opts = _app_opts;
|
||||
struct spdk_event *event_done = _event_done;
|
||||
|
||||
spdk_app_json_config_load(app_opts, event_done);
|
||||
}
|
||||
|
||||
static struct spdk_conf *
|
||||
spdk_app_setup_conf(const char *config_file)
|
||||
{
|
||||
@ -556,7 +569,7 @@ spdk_app_start(struct spdk_app_opts *opts, spdk_event_fn start_fn,
|
||||
{
|
||||
struct spdk_conf *config = NULL;
|
||||
int rc;
|
||||
struct spdk_event *rpc_start_event;
|
||||
struct spdk_event *rpc_start_event, *config_load_event;
|
||||
char *tty;
|
||||
|
||||
if (!opts) {
|
||||
@ -650,10 +663,17 @@ spdk_app_start(struct spdk_app_opts *opts, spdk_event_fn start_fn,
|
||||
rpc_start_event = spdk_event_allocate(g_init_lcore, spdk_app_start_rpc,
|
||||
(void *)opts->rpc_addr, NULL);
|
||||
|
||||
if (!g_delay_subsystem_init) {
|
||||
spdk_subsystem_init(rpc_start_event);
|
||||
if (opts->json_config_file) {
|
||||
g_delay_subsystem_init = false;
|
||||
config_load_event = spdk_event_allocate(g_init_lcore, _spdk_app_json_config_load,
|
||||
opts, rpc_start_event);
|
||||
spdk_event_call(config_load_event);
|
||||
} else {
|
||||
spdk_event_call(rpc_start_event);
|
||||
if (!g_delay_subsystem_init) {
|
||||
spdk_subsystem_init(rpc_start_event);
|
||||
} else {
|
||||
spdk_event_call(rpc_start_event);
|
||||
}
|
||||
}
|
||||
|
||||
/* This blocks until spdk_app_stop is called */
|
||||
@ -713,6 +733,8 @@ usage(void (*app_usage)(void))
|
||||
printf("options:\n");
|
||||
printf(" -c, --config <config> config file (default %s)\n",
|
||||
g_default_opts.config_file != NULL ? g_default_opts.config_file : "none");
|
||||
printf(" --json <config> JSON config file (default %s)\n",
|
||||
g_default_opts.json_config_file != NULL ? g_default_opts.json_config_file : "none");
|
||||
printf(" -d, --limit-coredump do not set max coredump size to RLIM_INFINITY\n");
|
||||
printf(" -g, --single-file-segments\n");
|
||||
printf(" force creating just one hugetlbfs file\n");
|
||||
@ -763,10 +785,16 @@ spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
|
||||
|
||||
memcpy(&g_default_opts, opts, sizeof(g_default_opts));
|
||||
|
||||
if (opts->config_file && access(opts->config_file, F_OK) != 0) {
|
||||
if (opts->config_file && access(opts->config_file, R_OK) != 0) {
|
||||
SPDK_WARNLOG("Can't read legacy configuration file '%s'\n", opts->config_file);
|
||||
opts->config_file = NULL;
|
||||
}
|
||||
|
||||
if (opts->json_config_file && access(opts->json_config_file, R_OK) != 0) {
|
||||
SPDK_WARNLOG("Can't read JSON configuration file '%s'\n", opts->json_config_file);
|
||||
opts->json_config_file = NULL;
|
||||
}
|
||||
|
||||
if (app_long_opts == NULL) {
|
||||
app_long_opts_len = 0;
|
||||
} else {
|
||||
@ -811,6 +839,9 @@ spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
|
||||
case CONFIG_FILE_OPT_IDX:
|
||||
opts->config_file = optarg;
|
||||
break;
|
||||
case JSON_CONFIG_OPT_IDX:
|
||||
opts->json_config_file = optarg;
|
||||
break;
|
||||
case LIMIT_COREDUMP_OPT_IDX:
|
||||
opts->enable_coredump = false;
|
||||
break;
|
||||
@ -965,6 +996,16 @@ spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
|
||||
}
|
||||
}
|
||||
|
||||
if (opts->config_file && opts->json_config_file) {
|
||||
fprintf(stderr, "ERROR: Legacy config and JSON config can't be used together.\n");
|
||||
goto out;
|
||||
}
|
||||
|
||||
if (opts->json_config_file && opts->delay_subsystem_init) {
|
||||
fprintf(stderr, "ERROR: JSON configuration file can't be used together with --wait-for-rpc.\n");
|
||||
goto out;
|
||||
}
|
||||
|
||||
/* TBD: Replace warning by failure when RPCs for startup are prepared. */
|
||||
if (opts->config_file && opts->delay_subsystem_init) {
|
||||
fprintf(stderr,
|
||||
|
621
lib/event/json_config.c
Normal file
621
lib/event/json_config.c
Normal file
@ -0,0 +1,621 @@
|
||||
/*-
|
||||
* 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 "json_config.h"
|
||||
|
||||
#include "spdk/stdinc.h"
|
||||
|
||||
#include "spdk/util.h"
|
||||
#include "spdk/log.h"
|
||||
#include "spdk/event.h"
|
||||
#include "spdk/env.h"
|
||||
#include "spdk/thread.h"
|
||||
#include "spdk/jsonrpc.h"
|
||||
#include "spdk/rpc.h"
|
||||
|
||||
#include "spdk_internal/event.h"
|
||||
#include "spdk_internal/log.h"
|
||||
|
||||
#define SPDK_DEBUG_APP_CFG(...) SPDK_DEBUGLOG(SPDK_LOG_APP_CONFIG, __VA_ARGS__)
|
||||
|
||||
/* JSON configuration format is as follows
|
||||
*
|
||||
* {
|
||||
* "subsystems" : [ <<== *subsystems JSON array
|
||||
* { <<== *subsystems_it array entry pointer (iterator)
|
||||
* "subsystem": "<< SUBSYSTEM NAME >>",
|
||||
* "config": [ <<== *config JSON array
|
||||
* { <<== *config_it array entry pointer (iterator)
|
||||
* "method": "<< METHOD NAME >>", <<== *method
|
||||
* "params": { << PARAMS >> } <<== *params
|
||||
* },
|
||||
* << MORE "config" ARRY ENTRIES >>
|
||||
* ]
|
||||
* },
|
||||
* << MORE "subsystems" ARRAY ENTRIES >>
|
||||
* ]
|
||||
*
|
||||
* << ANYTHING ELSE IS IGNORRED IN ROOT OBJECT>>
|
||||
* }
|
||||
*
|
||||
*/
|
||||
|
||||
struct load_json_config_ctx;
|
||||
typedef void (*client_resp_handler)(struct load_json_config_ctx *,
|
||||
struct spdk_jsonrpc_client_response *);
|
||||
|
||||
#define RPC_SOCKET_PATH_MAX sizeof(((struct sockaddr_un *)0)->sun_path)
|
||||
|
||||
/* 1s connections timeout */
|
||||
#define RPC_CLIENT_CONNECT_TIMEOUT_US (1U * 1000U * 1000U)
|
||||
|
||||
/*
|
||||
* Currently there is no timeout in SPDK for any RPC command. This result that
|
||||
* we can't put a hard limit during configuration load as it most likely randomly fail.
|
||||
* So just print WARNLOG every 10s. */
|
||||
#define RPC_CLIENT_REQUEST_TIMEOUT_US (10U * 1000 * 1000)
|
||||
|
||||
struct load_json_config_ctx {
|
||||
/* Thread used during configuration. */
|
||||
struct spdk_thread *thread;
|
||||
struct spdk_event *done_event;
|
||||
|
||||
/* Current subsystem */
|
||||
struct spdk_json_val *subsystems; /* "subsystems" array */
|
||||
struct spdk_json_val *subsystems_it; /* current subsystem array position in "subsystems" array */
|
||||
|
||||
struct spdk_json_val *subsystem_name; /* current subsystem name */
|
||||
|
||||
/* Current "config" entry we are processing */
|
||||
struct spdk_json_val *config; /* "config" array */
|
||||
struct spdk_json_val *config_it; /* current config position in "config" array */
|
||||
|
||||
/* Current request id we are sending. */
|
||||
uint32_t rpc_request_id;
|
||||
|
||||
/* Whole configuration file read and parsed. */
|
||||
size_t json_data_size;
|
||||
char *json_data;
|
||||
|
||||
size_t values_cnt;
|
||||
struct spdk_json_val *values;
|
||||
|
||||
char rpc_socket_path_temp[RPC_SOCKET_PATH_MAX + 1];
|
||||
|
||||
struct spdk_jsonrpc_client *client_conn;
|
||||
struct spdk_poller *client_conn_poller;
|
||||
|
||||
client_resp_handler client_resp_cb;
|
||||
|
||||
/* Timeout for current RPC client action. */
|
||||
uint64_t timeout;
|
||||
};
|
||||
|
||||
static void spdk_app_json_config_load_subsystem(void *_ctx);
|
||||
|
||||
static void
|
||||
spdk_app_json_config_load_done(struct load_json_config_ctx *ctx, int rc)
|
||||
{
|
||||
spdk_poller_unregister(&ctx->client_conn_poller);
|
||||
spdk_jsonrpc_client_close(ctx->client_conn);
|
||||
spdk_rpc_finish();
|
||||
|
||||
if (rc) {
|
||||
SPDK_ERRLOG("Config load failed. Stopping SPDK application.\n");
|
||||
spdk_app_stop(rc);
|
||||
} else {
|
||||
spdk_event_call(ctx->done_event);
|
||||
}
|
||||
|
||||
SPDK_DEBUG_APP_CFG("Config load finished\n");
|
||||
free(ctx->json_data);
|
||||
free(ctx->values);
|
||||
free(ctx);
|
||||
}
|
||||
|
||||
static void
|
||||
rpc_client_set_timeout(struct load_json_config_ctx *ctx, uint64_t timeout_us)
|
||||
{
|
||||
ctx->timeout = spdk_get_ticks() + timeout_us * spdk_get_ticks_hz() / (1000 * 1000);
|
||||
}
|
||||
|
||||
static int
|
||||
rpc_client_check_timeout(struct load_json_config_ctx *ctx)
|
||||
{
|
||||
if (ctx->timeout < spdk_get_ticks()) {
|
||||
SPDK_WARNLOG("RPC client command timeout.\n");
|
||||
return -ETIMEDOUT;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int
|
||||
rpc_client_poller(void *arg)
|
||||
{
|
||||
struct load_json_config_ctx *ctx = arg;
|
||||
struct spdk_jsonrpc_client_response *resp;
|
||||
client_resp_handler cb;
|
||||
int rc;
|
||||
|
||||
assert(spdk_get_thread() == ctx->thread);
|
||||
|
||||
rc = spdk_jsonrpc_client_poll(ctx->client_conn, 0);
|
||||
if (rc == 0) {
|
||||
rc = rpc_client_check_timeout(ctx);
|
||||
if (rc == -ETIMEDOUT) {
|
||||
rpc_client_set_timeout(ctx, RPC_CLIENT_REQUEST_TIMEOUT_US);
|
||||
rc = 0;
|
||||
}
|
||||
}
|
||||
|
||||
if (rc == 0) {
|
||||
/* No response yet */
|
||||
return -1;
|
||||
} else if (rc < 0) {
|
||||
spdk_app_json_config_load_done(ctx, rc);
|
||||
return -1;
|
||||
}
|
||||
|
||||
resp = spdk_jsonrpc_client_get_response(ctx->client_conn);
|
||||
assert(resp);
|
||||
|
||||
if (resp->error) {
|
||||
SPDK_ERRLOG("error response: %*s", (int)resp->error->len, (char *)resp->error->start);
|
||||
spdk_jsonrpc_client_free_response(resp);
|
||||
spdk_app_json_config_load_done(ctx, -EINVAL);
|
||||
} else {
|
||||
/* We have response so we must have callback for it. */
|
||||
cb = ctx->client_resp_cb;
|
||||
assert(cb != NULL);
|
||||
|
||||
/* Mark we are done with this handler. */
|
||||
ctx->client_resp_cb = NULL;
|
||||
cb(ctx, resp);
|
||||
}
|
||||
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
static int
|
||||
rpc_client_connect_poller(void *_ctx)
|
||||
{
|
||||
struct load_json_config_ctx *ctx = _ctx;
|
||||
int rc;
|
||||
|
||||
rc = spdk_jsonrpc_client_poll(ctx->client_conn, 0);
|
||||
if (rc != -ENOTCONN) {
|
||||
/* We are connected. Start regular poller and issue first request */
|
||||
spdk_poller_unregister(&ctx->client_conn_poller);
|
||||
ctx->client_conn_poller = spdk_poller_register(rpc_client_poller, ctx, 100);
|
||||
spdk_app_json_config_load_subsystem(ctx);
|
||||
} else {
|
||||
rc = rpc_client_check_timeout(ctx);
|
||||
if (rc) {
|
||||
spdk_app_json_config_load_done(ctx, rc);
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
static int
|
||||
client_send_request(struct load_json_config_ctx *ctx, struct spdk_jsonrpc_client_request *request,
|
||||
client_resp_handler client_resp_cb)
|
||||
{
|
||||
int rc;
|
||||
|
||||
assert(spdk_get_thread() == ctx->thread);
|
||||
|
||||
ctx->client_resp_cb = client_resp_cb;
|
||||
rpc_client_set_timeout(ctx, RPC_CLIENT_REQUEST_TIMEOUT_US);
|
||||
rc = spdk_jsonrpc_client_send_request(ctx->client_conn, request);
|
||||
|
||||
if (rc) {
|
||||
SPDK_DEBUG_APP_CFG("Sending request to client failed (%d)\n", rc);
|
||||
}
|
||||
|
||||
return rc;
|
||||
}
|
||||
|
||||
static int
|
||||
cap_string(const struct spdk_json_val *val, void *out)
|
||||
{
|
||||
const struct spdk_json_val **vptr = out;
|
||||
|
||||
if (val->type != SPDK_JSON_VAL_STRING) {
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
*vptr = val;
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int
|
||||
cap_object(const struct spdk_json_val *val, void *out)
|
||||
{
|
||||
const struct spdk_json_val **vptr = out;
|
||||
|
||||
if (val->type != SPDK_JSON_VAL_OBJECT_BEGIN) {
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
*vptr = val;
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
static int
|
||||
cap_array_or_null(const struct spdk_json_val *val, void *out)
|
||||
{
|
||||
const struct spdk_json_val **vptr = out;
|
||||
|
||||
if (val->type != SPDK_JSON_VAL_ARRAY_BEGIN && val->type != SPDK_JSON_VAL_NULL) {
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
*vptr = val;
|
||||
return 0;
|
||||
}
|
||||
|
||||
struct config_entry {
|
||||
char *method;
|
||||
struct spdk_json_val *params;
|
||||
};
|
||||
|
||||
static struct spdk_json_object_decoder jsonrpc_cmd_decoders[] = {
|
||||
{"method", offsetof(struct config_entry, method), spdk_json_decode_string},
|
||||
{"params", offsetof(struct config_entry, params), cap_object, true}
|
||||
};
|
||||
|
||||
static void spdk_app_json_config_load_subsystem_config_entry(void *_ctx);
|
||||
|
||||
static void
|
||||
spdk_app_json_config_load_subsystem_config_entry_next(struct load_json_config_ctx *ctx,
|
||||
struct spdk_jsonrpc_client_response *resp)
|
||||
{
|
||||
/* Don't care about the response as long it is not
|
||||
* an error (which is validated by poller) */
|
||||
spdk_jsonrpc_client_free_response(resp);
|
||||
|
||||
ctx->config_it = spdk_json_next(ctx->config_it);
|
||||
spdk_app_json_config_load_subsystem_config_entry(ctx);
|
||||
}
|
||||
|
||||
/* Load "config" entry */
|
||||
static void
|
||||
spdk_app_json_config_load_subsystem_config_entry(void *_ctx)
|
||||
{
|
||||
struct load_json_config_ctx *ctx = _ctx;
|
||||
struct spdk_jsonrpc_client_request *rpc_request;
|
||||
struct spdk_json_write_ctx *w;
|
||||
struct config_entry cfg = {};
|
||||
struct spdk_json_val *params_end;
|
||||
size_t params_len;
|
||||
int rc;
|
||||
|
||||
if (ctx->config_it == NULL) {
|
||||
SPDK_DEBUG_APP_CFG("Subsystem '%.*s': configuration done.\n", ctx->subsystem_name->len,
|
||||
(char *)ctx->subsystem_name->start);
|
||||
ctx->subsystems_it = spdk_json_next(ctx->subsystems_it);
|
||||
/* Invoke later to avoid recurrency */
|
||||
spdk_thread_send_msg(ctx->thread, spdk_app_json_config_load_subsystem, ctx);
|
||||
return;
|
||||
}
|
||||
|
||||
if (spdk_json_decode_object(ctx->config_it, jsonrpc_cmd_decoders,
|
||||
SPDK_COUNTOF(jsonrpc_cmd_decoders), &cfg)) {
|
||||
params_end = spdk_json_next(ctx->config_it);
|
||||
params_len = params_end->start - ctx->config->start + 1;
|
||||
SPDK_ERRLOG("Failed to decode config entry: %*s!\n", (int)params_len, (char *)ctx->config_it);
|
||||
spdk_app_json_config_load_done(ctx, -EINVAL);
|
||||
goto out;
|
||||
}
|
||||
|
||||
rc = spdk_rpc_is_method_allowed(cfg.method, spdk_rpc_get_state());
|
||||
if (rc == -EPERM) {
|
||||
SPDK_DEBUG_APP_CFG("Method '%s' not allowed -> skipping\n", cfg.method);
|
||||
/* Invoke later to avoid recurrency */
|
||||
ctx->config_it = spdk_json_next(ctx->config_it);
|
||||
spdk_thread_send_msg(ctx->thread, spdk_app_json_config_load_subsystem_config_entry, ctx);
|
||||
goto out;
|
||||
}
|
||||
|
||||
/* Get _END by skipping params and going back by one element. */
|
||||
params_end = cfg.params + spdk_json_val_len(cfg.params) - 1;
|
||||
|
||||
/* Need to add one character to include '}' */
|
||||
params_len = params_end->start - cfg.params->start + 1;
|
||||
|
||||
SPDK_DEBUG_APP_CFG("\tmethod: %s\n", cfg.method);
|
||||
SPDK_DEBUG_APP_CFG("\tparams: %.*s\n", (int)params_len, (char *)cfg.params->start);
|
||||
|
||||
rpc_request = spdk_jsonrpc_client_create_request();
|
||||
if (!rpc_request) {
|
||||
spdk_app_json_config_load_done(ctx, -errno);
|
||||
goto out;
|
||||
}
|
||||
|
||||
w = spdk_jsonrpc_begin_request(rpc_request, ctx->rpc_request_id, NULL);
|
||||
if (!w) {
|
||||
spdk_jsonrpc_client_free_request(rpc_request);
|
||||
spdk_app_json_config_load_done(ctx, -ENOMEM);
|
||||
goto out;
|
||||
}
|
||||
|
||||
spdk_json_write_named_string(w, "method", cfg.method);
|
||||
|
||||
/* No need to parse "params". Just dump the whole content of "params"
|
||||
* directly into the request and let the remote side verify it. */
|
||||
spdk_json_write_name(w, "params");
|
||||
spdk_json_write_val_raw(w, cfg.params->start, params_len);
|
||||
spdk_jsonrpc_end_request(rpc_request, w);
|
||||
|
||||
rc = client_send_request(ctx, rpc_request, spdk_app_json_config_load_subsystem_config_entry_next);
|
||||
if (rc != 0) {
|
||||
spdk_app_json_config_load_done(ctx, -rc);
|
||||
goto out;
|
||||
}
|
||||
out:
|
||||
free(cfg.method);
|
||||
}
|
||||
|
||||
static void
|
||||
subsystem_init_done_resp_cb(struct load_json_config_ctx *ctx,
|
||||
struct spdk_jsonrpc_client_response *resp)
|
||||
{
|
||||
spdk_jsonrpc_client_free_response(resp);
|
||||
|
||||
/* Another round. This time for RUNTIME methods */
|
||||
SPDK_DEBUG_APP_CFG("'start_subsystem_init' done - continuing configuration\n");
|
||||
if (ctx->subsystems) {
|
||||
ctx->subsystems_it = spdk_json_array_first(ctx->subsystems);
|
||||
}
|
||||
|
||||
spdk_app_json_config_load_subsystem(ctx);
|
||||
}
|
||||
|
||||
static struct spdk_json_object_decoder subsystem_decoders[] = {
|
||||
{"subsystem", offsetof(struct load_json_config_ctx, subsystem_name), cap_string},
|
||||
{"config", offsetof(struct load_json_config_ctx, config), cap_array_or_null}
|
||||
};
|
||||
|
||||
/*
|
||||
* Start loading subsystem pointed by ctx->subsystems_it. This must point to the
|
||||
* beginning of the "subsystem" object in "subsystems" array or be NULL. If it is
|
||||
* NULL then no more subsystems to load.
|
||||
*
|
||||
* There are two iterations:
|
||||
*
|
||||
* In first iteration only STARTUP RPC methods are used, other methods are ignored. When
|
||||
* allsubsystems are walked the ctx->subsystems_it became NULL and "start_subsystem_init"
|
||||
* is called to let the SPDK move to RUNTIME state (initialize all subsystems) and
|
||||
* second iteration begins.
|
||||
*
|
||||
* In second iteration "subsystems" array is walked through again, this time only
|
||||
* RUNTIME RPC methods are used. When ctx->subsystems_it became NULL second time it
|
||||
* indicate that there is no more subsystems to load. The done_event is called to finish
|
||||
* configuration.
|
||||
*/
|
||||
static void
|
||||
spdk_app_json_config_load_subsystem(void *_ctx)
|
||||
{
|
||||
struct load_json_config_ctx *ctx = _ctx;
|
||||
struct spdk_jsonrpc_client_request *req;
|
||||
struct spdk_json_write_ctx *w;
|
||||
|
||||
if (ctx->subsystems_it == NULL) {
|
||||
if (spdk_rpc_get_state() == SPDK_RPC_STARTUP) {
|
||||
SPDK_DEBUG_APP_CFG("No more entries for current state, calling 'start_subsystem_init'\n");
|
||||
req = spdk_jsonrpc_client_create_request();
|
||||
w = spdk_jsonrpc_begin_request(req, ctx->rpc_request_id++, "start_subsystem_init");
|
||||
if (!w) {
|
||||
spdk_jsonrpc_client_free_request(req);
|
||||
spdk_app_json_config_load_done(ctx, -ENOMEM);
|
||||
return;
|
||||
}
|
||||
spdk_jsonrpc_end_request(req, w);
|
||||
|
||||
client_send_request(ctx, req, subsystem_init_done_resp_cb);
|
||||
} else {
|
||||
spdk_app_json_config_load_done(ctx, 0);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/* Capture subsystem name and config array */
|
||||
if (spdk_json_decode_object(ctx->subsystems_it, subsystem_decoders,
|
||||
SPDK_COUNTOF(subsystem_decoders), ctx)) {
|
||||
SPDK_ERRLOG("Failed to parse subsystem configuration\n");
|
||||
spdk_app_json_config_load_done(ctx, -EINVAL);
|
||||
return;
|
||||
}
|
||||
|
||||
SPDK_DEBUG_APP_CFG("Loading subsystem '%.*s' configuration\n", ctx->subsystem_name->len,
|
||||
(char *)ctx->subsystem_name->start);
|
||||
|
||||
/* Get 'config' array first configuration entry */
|
||||
ctx->config_it = spdk_json_array_first(ctx->config);
|
||||
spdk_app_json_config_load_subsystem_config_entry(ctx);
|
||||
}
|
||||
|
||||
|
||||
static void *
|
||||
read_file(const char *filename, size_t *size)
|
||||
{
|
||||
FILE *file = fopen(filename, "r");
|
||||
void *data = NULL;
|
||||
long int rc = 0;
|
||||
|
||||
if (file == NULL) {
|
||||
/* errno is set by fopen */
|
||||
return NULL;
|
||||
}
|
||||
|
||||
rc = fseek(file, 0, SEEK_END);
|
||||
if (rc == 0) {
|
||||
rc = ftell(file);
|
||||
rewind(file);
|
||||
}
|
||||
|
||||
if (rc != -1) {
|
||||
*size = rc;
|
||||
data = malloc(*size);
|
||||
}
|
||||
|
||||
if (data != NULL) {
|
||||
rc = fread(data, 1, *size, file);
|
||||
if (rc != (long int)*size) {
|
||||
free(data);
|
||||
data = NULL;
|
||||
errno = EIO;
|
||||
}
|
||||
}
|
||||
|
||||
fclose(file);
|
||||
return data;
|
||||
}
|
||||
|
||||
static int
|
||||
spdk_app_json_config_read(const char *config_file, struct load_json_config_ctx *ctx)
|
||||
{
|
||||
struct spdk_json_val *values = NULL;
|
||||
void *json = NULL, *end;
|
||||
ssize_t values_cnt, rc;
|
||||
size_t json_size;
|
||||
|
||||
json = read_file(config_file, &json_size);
|
||||
if (!json) {
|
||||
return -errno;
|
||||
}
|
||||
|
||||
rc = spdk_json_parse(json, json_size, NULL, 0, &end,
|
||||
SPDK_JSON_PARSE_FLAG_ALLOW_COMMENTS);
|
||||
if (rc < 0) {
|
||||
fprintf(stderr, "Parsing JSON configuration failed (%zd)\n", rc);
|
||||
goto err;
|
||||
}
|
||||
|
||||
values_cnt = rc;
|
||||
values = calloc(values_cnt, sizeof(struct spdk_json_val));
|
||||
if (values == NULL) {
|
||||
fprintf(stderr, "Out of memory\n");
|
||||
goto err;
|
||||
}
|
||||
|
||||
rc = spdk_json_parse(json, json_size, values, values_cnt, &end,
|
||||
SPDK_JSON_PARSE_FLAG_ALLOW_COMMENTS);
|
||||
if (rc != values_cnt) {
|
||||
fprintf(stderr, "Parsing JSON configuration failed (%zd)\n", rc);
|
||||
goto err;
|
||||
}
|
||||
|
||||
ctx->json_data = json;
|
||||
ctx->json_data_size = json_size;
|
||||
|
||||
ctx->values = values;
|
||||
ctx->values_cnt = values_cnt;
|
||||
|
||||
return 0;
|
||||
err:
|
||||
free(json);
|
||||
free(values);
|
||||
return rc;
|
||||
}
|
||||
|
||||
void
|
||||
spdk_app_json_config_load(const struct spdk_app_opts *opts, struct spdk_event *done_event)
|
||||
{
|
||||
struct load_json_config_ctx *ctx = calloc(1, sizeof(*ctx));
|
||||
const char *rpc_addr;
|
||||
int rc;
|
||||
|
||||
assert(done_event);
|
||||
if (!ctx) {
|
||||
spdk_app_stop(-ENOMEM);
|
||||
return;
|
||||
}
|
||||
|
||||
ctx->done_event = done_event;
|
||||
ctx->thread = spdk_get_thread();
|
||||
|
||||
rc = spdk_app_json_config_read(opts->json_config_file, ctx);
|
||||
if (rc) {
|
||||
goto fail;
|
||||
}
|
||||
|
||||
/* Capture subsystems array */
|
||||
rc = spdk_json_find_array(ctx->values, "subsystems", NULL, &ctx->subsystems);
|
||||
if (rc) {
|
||||
SPDK_WARNLOG("No 'subsystems' key JSON configuration file.\n");
|
||||
} else {
|
||||
/* Get first subsystem */
|
||||
ctx->subsystems_it = spdk_json_array_first(ctx->subsystems);
|
||||
if (ctx->subsystems_it == NULL) {
|
||||
SPDK_NOTICELOG("'subsystems' configuration is empty\n");
|
||||
}
|
||||
}
|
||||
|
||||
rpc_addr = opts->rpc_addr;
|
||||
/* If rpc_addr is not an Unix socket use default address as prefix. */
|
||||
if (rpc_addr == NULL || rpc_addr[0] != '/') {
|
||||
rpc_addr = SPDK_DEFAULT_RPC_ADDR;
|
||||
}
|
||||
|
||||
/* FIXME: rpc client should use socketpair() instead of this temporary socket nonsense */
|
||||
rc = snprintf(ctx->rpc_socket_path_temp, sizeof(ctx->rpc_socket_path_temp), "%s.%d_config",
|
||||
rpc_addr, getpid());
|
||||
if (rc >= (int)sizeof(ctx->rpc_socket_path_temp)) {
|
||||
SPDK_ERRLOG("Socket name create failed\n");
|
||||
goto fail;
|
||||
}
|
||||
|
||||
/* FIXME: spdk_rpc_initialize() function should return error code. */
|
||||
spdk_rpc_initialize(ctx->rpc_socket_path_temp);
|
||||
ctx->client_conn = spdk_jsonrpc_client_connect(ctx->rpc_socket_path_temp, AF_UNIX);
|
||||
if (ctx->client_conn == NULL) {
|
||||
SPDK_ERRLOG("Failed to connect to '%s'\n", ctx->rpc_socket_path_temp);
|
||||
goto fail;
|
||||
}
|
||||
|
||||
rpc_client_set_timeout(ctx, RPC_CLIENT_CONNECT_TIMEOUT_US);
|
||||
ctx->client_conn_poller = spdk_poller_register(rpc_client_connect_poller, ctx, 100);
|
||||
return;
|
||||
|
||||
fail:
|
||||
spdk_app_json_config_load_done(ctx, -EINVAL);
|
||||
}
|
||||
|
||||
SPDK_LOG_REGISTER_COMPONENT("app_config", SPDK_LOG_APP_CONFIG)
|
41
lib/event/json_config.h
Normal file
41
lib/event/json_config.h
Normal file
@ -0,0 +1,41 @@
|
||||
/*-
|
||||
* 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.
|
||||
*/
|
||||
|
||||
#ifndef SPDK_JSON_CONFIG_H
|
||||
#define SPDK_JSON_CONFIG_H
|
||||
|
||||
#include "spdk/event.h"
|
||||
|
||||
void spdk_app_json_config_load(const struct spdk_app_opts *opts, struct spdk_event *done_event);
|
||||
|
||||
#endif /* SPDK_JSON_CONFIG_H */
|
@ -48,6 +48,8 @@ DEFINE_STUB_V(spdk_rpc_register_method, (const char *method, spdk_rpc_method_han
|
||||
uint32_t state_mask));
|
||||
DEFINE_STUB_V(spdk_rpc_set_state, (uint32_t state));
|
||||
DEFINE_STUB(spdk_rpc_get_state, uint32_t, (void), SPDK_RPC_RUNTIME);
|
||||
DEFINE_STUB_V(spdk_app_json_config_load, (const struct spdk_app_opts *opts,
|
||||
struct spdk_event *done_event));
|
||||
|
||||
static void
|
||||
unittest_usage(void)
|
||||
|
Loading…
Reference in New Issue
Block a user