Spdk/module/bdev/nvme/bdev_nvme_rpc.c
Shuhei Matsumoto 5200552452 bdev/nvme: Add max_bdevs parameter for attach_controller RPC
The target subsystem may expose more than 128 namespaces. To support
such subsystem, add a new parameter max_bdevs for the
bdev_nvme_attach_controller RPC.

Signed-off-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Change-Id: I8fab20b9c4d52818205e05de6a31dbe0d31a10fe
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/17651
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
2023-05-09 17:58:11 +08:00

2636 lines
82 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (C) 2016 Intel Corporation. All rights reserved.
* Copyright (c) 2019-2021 Mellanox Technologies LTD. All rights reserved.
* Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* Copyright (c) 2022 Dell Inc, or its subsidiaries. All rights reserved.
*/
#include "spdk/stdinc.h"
#include "bdev_nvme.h"
#include "spdk/config.h"
#include "spdk/string.h"
#include "spdk/rpc.h"
#include "spdk/util.h"
#include "spdk/env.h"
#include "spdk/nvme.h"
#include "spdk/nvme_spec.h"
#include "spdk/log.h"
#include "spdk/bdev_module.h"
static int
rpc_decode_action_on_timeout(const struct spdk_json_val *val, void *out)
{
enum spdk_bdev_timeout_action *action = out;
if (spdk_json_strequal(val, "none") == true) {
*action = SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE;
} else if (spdk_json_strequal(val, "abort") == true) {
*action = SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT;
} else if (spdk_json_strequal(val, "reset") == true) {
*action = SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET;
} else {
SPDK_NOTICELOG("Invalid parameter value: action_on_timeout\n");
return -EINVAL;
}
return 0;
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_options_decoders[] = {
{"action_on_timeout", offsetof(struct spdk_bdev_nvme_opts, action_on_timeout), rpc_decode_action_on_timeout, true},
{"timeout_us", offsetof(struct spdk_bdev_nvme_opts, timeout_us), spdk_json_decode_uint64, true},
{"timeout_admin_us", offsetof(struct spdk_bdev_nvme_opts, timeout_admin_us), spdk_json_decode_uint64, true},
{"keep_alive_timeout_ms", offsetof(struct spdk_bdev_nvme_opts, keep_alive_timeout_ms), spdk_json_decode_uint32, true},
{"retry_count", offsetof(struct spdk_bdev_nvme_opts, transport_retry_count), spdk_json_decode_uint32, true},
{"arbitration_burst", offsetof(struct spdk_bdev_nvme_opts, arbitration_burst), spdk_json_decode_uint32, true},
{"low_priority_weight", offsetof(struct spdk_bdev_nvme_opts, low_priority_weight), spdk_json_decode_uint32, true},
{"medium_priority_weight", offsetof(struct spdk_bdev_nvme_opts, medium_priority_weight), spdk_json_decode_uint32, true},
{"high_priority_weight", offsetof(struct spdk_bdev_nvme_opts, high_priority_weight), spdk_json_decode_uint32, true},
{"nvme_adminq_poll_period_us", offsetof(struct spdk_bdev_nvme_opts, nvme_adminq_poll_period_us), spdk_json_decode_uint64, true},
{"nvme_ioq_poll_period_us", offsetof(struct spdk_bdev_nvme_opts, nvme_ioq_poll_period_us), spdk_json_decode_uint64, true},
{"io_queue_requests", offsetof(struct spdk_bdev_nvme_opts, io_queue_requests), spdk_json_decode_uint32, true},
{"delay_cmd_submit", offsetof(struct spdk_bdev_nvme_opts, delay_cmd_submit), spdk_json_decode_bool, true},
{"transport_retry_count", offsetof(struct spdk_bdev_nvme_opts, transport_retry_count), spdk_json_decode_uint32, true},
{"bdev_retry_count", offsetof(struct spdk_bdev_nvme_opts, bdev_retry_count), spdk_json_decode_int32, true},
{"transport_ack_timeout", offsetof(struct spdk_bdev_nvme_opts, transport_ack_timeout), spdk_json_decode_uint8, true},
{"ctrlr_loss_timeout_sec", offsetof(struct spdk_bdev_nvme_opts, ctrlr_loss_timeout_sec), spdk_json_decode_int32, true},
{"reconnect_delay_sec", offsetof(struct spdk_bdev_nvme_opts, reconnect_delay_sec), spdk_json_decode_uint32, true},
{"fast_io_fail_timeout_sec", offsetof(struct spdk_bdev_nvme_opts, fast_io_fail_timeout_sec), spdk_json_decode_uint32, true},
{"disable_auto_failback", offsetof(struct spdk_bdev_nvme_opts, disable_auto_failback), spdk_json_decode_bool, true},
{"generate_uuids", offsetof(struct spdk_bdev_nvme_opts, generate_uuids), spdk_json_decode_bool, true},
{"transport_tos", offsetof(struct spdk_bdev_nvme_opts, transport_tos), spdk_json_decode_uint8, true},
{"nvme_error_stat", offsetof(struct spdk_bdev_nvme_opts, nvme_error_stat), spdk_json_decode_bool, true},
{"rdma_srq_size", offsetof(struct spdk_bdev_nvme_opts, rdma_srq_size), spdk_json_decode_uint32, true},
{"io_path_stat", offsetof(struct spdk_bdev_nvme_opts, io_path_stat), spdk_json_decode_bool, true},
};
static void
rpc_bdev_nvme_set_options(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct spdk_bdev_nvme_opts opts;
int rc;
bdev_nvme_get_opts(&opts);
if (params && spdk_json_decode_object(params, rpc_bdev_nvme_options_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_options_decoders),
&opts)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
return;
}
rc = bdev_nvme_set_opts(&opts);
if (rc == -EPERM) {
spdk_jsonrpc_send_error_response(request, -EPERM,
"RPC not permitted with nvme controllers already attached");
} else if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
} else {
spdk_jsonrpc_send_bool_response(request, true);
}
return;
}
SPDK_RPC_REGISTER("bdev_nvme_set_options", rpc_bdev_nvme_set_options,
SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_hotplug {
bool enabled;
uint64_t period_us;
};
static const struct spdk_json_object_decoder rpc_bdev_nvme_hotplug_decoders[] = {
{"enable", offsetof(struct rpc_bdev_nvme_hotplug, enabled), spdk_json_decode_bool, false},
{"period_us", offsetof(struct rpc_bdev_nvme_hotplug, period_us), spdk_json_decode_uint64, true},
};
static void
rpc_bdev_nvme_set_hotplug_done(void *ctx)
{
struct spdk_jsonrpc_request *request = ctx;
spdk_jsonrpc_send_bool_response(request, true);
}
static void
rpc_bdev_nvme_set_hotplug(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_hotplug req = {false, 0};
int rc;
if (spdk_json_decode_object(params, rpc_bdev_nvme_hotplug_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_hotplug_decoders), &req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
rc = -EINVAL;
goto invalid;
}
rc = bdev_nvme_set_hotplug(req.enabled, req.period_us, rpc_bdev_nvme_set_hotplug_done,
request);
if (rc) {
goto invalid;
}
return;
invalid:
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc));
}
SPDK_RPC_REGISTER("bdev_nvme_set_hotplug", rpc_bdev_nvme_set_hotplug, SPDK_RPC_RUNTIME)
enum bdev_nvme_multipath_mode {
BDEV_NVME_MP_MODE_FAILOVER,
BDEV_NVME_MP_MODE_MULTIPATH,
BDEV_NVME_MP_MODE_DISABLE,
};
struct rpc_bdev_nvme_attach_controller {
char *name;
char *trtype;
char *adrfam;
char *traddr;
char *trsvcid;
char *priority;
char *subnqn;
char *hostnqn;
char *hostaddr;
char *hostsvcid;
char *psk;
enum bdev_nvme_multipath_mode multipath;
struct nvme_ctrlr_opts bdev_opts;
struct spdk_nvme_ctrlr_opts drv_opts;
uint32_t max_bdevs;
};
static void
free_rpc_bdev_nvme_attach_controller(struct rpc_bdev_nvme_attach_controller *req)
{
free(req->name);
free(req->trtype);
free(req->adrfam);
free(req->traddr);
free(req->trsvcid);
free(req->priority);
free(req->subnqn);
free(req->hostnqn);
free(req->hostaddr);
free(req->hostsvcid);
free(req->psk);
}
static int
bdev_nvme_decode_reftag(const struct spdk_json_val *val, void *out)
{
uint32_t *flag = out;
bool reftag;
int rc;
rc = spdk_json_decode_bool(val, &reftag);
if (rc == 0 && reftag == true) {
*flag |= SPDK_NVME_IO_FLAGS_PRCHK_REFTAG;
}
return rc;
}
static int
bdev_nvme_decode_guard(const struct spdk_json_val *val, void *out)
{
uint32_t *flag = out;
bool guard;
int rc;
rc = spdk_json_decode_bool(val, &guard);
if (rc == 0 && guard == true) {
*flag |= SPDK_NVME_IO_FLAGS_PRCHK_GUARD;
}
return rc;
}
static int
bdev_nvme_decode_multipath(const struct spdk_json_val *val, void *out)
{
enum bdev_nvme_multipath_mode *multipath = out;
if (spdk_json_strequal(val, "failover") == true) {
*multipath = BDEV_NVME_MP_MODE_FAILOVER;
} else if (spdk_json_strequal(val, "multipath") == true) {
*multipath = BDEV_NVME_MP_MODE_MULTIPATH;
} else if (spdk_json_strequal(val, "disable") == true) {
*multipath = BDEV_NVME_MP_MODE_DISABLE;
} else {
SPDK_NOTICELOG("Invalid parameter value: multipath\n");
return -EINVAL;
}
return 0;
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_attach_controller_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_attach_controller, name), spdk_json_decode_string},
{"trtype", offsetof(struct rpc_bdev_nvme_attach_controller, trtype), spdk_json_decode_string},
{"traddr", offsetof(struct rpc_bdev_nvme_attach_controller, traddr), spdk_json_decode_string},
{"adrfam", offsetof(struct rpc_bdev_nvme_attach_controller, adrfam), spdk_json_decode_string, true},
{"trsvcid", offsetof(struct rpc_bdev_nvme_attach_controller, trsvcid), spdk_json_decode_string, true},
{"priority", offsetof(struct rpc_bdev_nvme_attach_controller, priority), spdk_json_decode_string, true},
{"subnqn", offsetof(struct rpc_bdev_nvme_attach_controller, subnqn), spdk_json_decode_string, true},
{"hostnqn", offsetof(struct rpc_bdev_nvme_attach_controller, hostnqn), spdk_json_decode_string, true},
{"hostaddr", offsetof(struct rpc_bdev_nvme_attach_controller, hostaddr), spdk_json_decode_string, true},
{"hostsvcid", offsetof(struct rpc_bdev_nvme_attach_controller, hostsvcid), spdk_json_decode_string, true},
{"prchk_reftag", offsetof(struct rpc_bdev_nvme_attach_controller, bdev_opts.prchk_flags), bdev_nvme_decode_reftag, true},
{"prchk_guard", offsetof(struct rpc_bdev_nvme_attach_controller, bdev_opts.prchk_flags), bdev_nvme_decode_guard, true},
{"hdgst", offsetof(struct rpc_bdev_nvme_attach_controller, drv_opts.header_digest), spdk_json_decode_bool, true},
{"ddgst", offsetof(struct rpc_bdev_nvme_attach_controller, drv_opts.data_digest), spdk_json_decode_bool, true},
{"fabrics_connect_timeout_us", offsetof(struct rpc_bdev_nvme_attach_controller, drv_opts.fabrics_connect_timeout_us), spdk_json_decode_uint64, true},
{"multipath", offsetof(struct rpc_bdev_nvme_attach_controller, multipath), bdev_nvme_decode_multipath, true},
{"num_io_queues", offsetof(struct rpc_bdev_nvme_attach_controller, drv_opts.num_io_queues), spdk_json_decode_uint32, true},
{"ctrlr_loss_timeout_sec", offsetof(struct rpc_bdev_nvme_attach_controller, bdev_opts.ctrlr_loss_timeout_sec), spdk_json_decode_int32, true},
{"reconnect_delay_sec", offsetof(struct rpc_bdev_nvme_attach_controller, bdev_opts.reconnect_delay_sec), spdk_json_decode_uint32, true},
{"fast_io_fail_timeout_sec", offsetof(struct rpc_bdev_nvme_attach_controller, bdev_opts.fast_io_fail_timeout_sec), spdk_json_decode_uint32, true},
{"psk", offsetof(struct rpc_bdev_nvme_attach_controller, psk), spdk_json_decode_string, true},
{"max_bdevs", offsetof(struct rpc_bdev_nvme_attach_controller, max_bdevs), spdk_json_decode_uint32, true},
};
#define DEFAULT_MAX_BDEVS_PER_RPC 128
struct rpc_bdev_nvme_attach_controller_ctx {
struct rpc_bdev_nvme_attach_controller req;
size_t bdev_count;
const char **names;
struct spdk_jsonrpc_request *request;
};
static void
free_rpc_bdev_nvme_attach_controller_ctx(struct rpc_bdev_nvme_attach_controller_ctx *ctx)
{
free_rpc_bdev_nvme_attach_controller(&ctx->req);
free(ctx->names);
free(ctx);
}
static void
rpc_bdev_nvme_attach_controller_examined(void *cb_ctx)
{
struct rpc_bdev_nvme_attach_controller_ctx *ctx = cb_ctx;
struct spdk_jsonrpc_request *request = ctx->request;
struct spdk_json_write_ctx *w;
size_t i;
w = spdk_jsonrpc_begin_result(request);
spdk_json_write_array_begin(w);
for (i = 0; i < ctx->bdev_count; i++) {
spdk_json_write_string(w, ctx->names[i]);
}
spdk_json_write_array_end(w);
spdk_jsonrpc_end_result(request, w);
free_rpc_bdev_nvme_attach_controller_ctx(ctx);
}
static void
rpc_bdev_nvme_attach_controller_done(void *cb_ctx, size_t bdev_count, int rc)
{
struct rpc_bdev_nvme_attach_controller_ctx *ctx = cb_ctx;
struct spdk_jsonrpc_request *request = ctx->request;
if (rc < 0) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
free_rpc_bdev_nvme_attach_controller_ctx(ctx);
return;
}
ctx->bdev_count = bdev_count;
spdk_bdev_wait_for_examine(rpc_bdev_nvme_attach_controller_examined, ctx);
}
static void
rpc_bdev_nvme_attach_controller(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_attach_controller_ctx *ctx;
struct spdk_nvme_transport_id trid = {};
const struct spdk_nvme_ctrlr_opts *drv_opts;
const struct spdk_nvme_transport_id *ctrlr_trid;
struct nvme_ctrlr *ctrlr = NULL;
size_t len, maxlen;
bool multipath = false;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctx->req.drv_opts, sizeof(ctx->req.drv_opts));
bdev_nvme_get_default_ctrlr_opts(&ctx->req.bdev_opts);
/* For now, initialize the multipath parameter to add a failover path. This maintains backward
* compatibility with past behavior. In the future, this behavior will change to "disable". */
ctx->req.multipath = BDEV_NVME_MP_MODE_FAILOVER;
ctx->req.max_bdevs = DEFAULT_MAX_BDEVS_PER_RPC;
if (spdk_json_decode_object(params, rpc_bdev_nvme_attach_controller_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_attach_controller_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
if (ctx->req.max_bdevs == 0) {
spdk_jsonrpc_send_error_response(request, -EINVAL, "max_bdevs cannot be zero");
goto cleanup;
}
ctx->names = calloc(ctx->req.max_bdevs, sizeof(char *));
if (ctx->names == NULL) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
goto cleanup;
}
/* Parse trstring */
rc = spdk_nvme_transport_id_populate_trstring(&trid, ctx->req.trtype);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse trtype: %s\n", ctx->req.trtype);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s",
ctx->req.trtype);
goto cleanup;
}
/* Parse trtype */
rc = spdk_nvme_transport_id_parse_trtype(&trid.trtype, ctx->req.trtype);
assert(rc == 0);
/* Parse traddr */
maxlen = sizeof(trid.traddr);
len = strnlen(ctx->req.traddr, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "traddr too long: %s",
ctx->req.traddr);
goto cleanup;
}
memcpy(trid.traddr, ctx->req.traddr, len + 1);
/* Parse adrfam */
if (ctx->req.adrfam) {
rc = spdk_nvme_transport_id_parse_adrfam(&trid.adrfam, ctx->req.adrfam);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse adrfam: %s\n", ctx->req.adrfam);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse adrfam: %s",
ctx->req.adrfam);
goto cleanup;
}
}
/* Parse trsvcid */
if (ctx->req.trsvcid) {
maxlen = sizeof(trid.trsvcid);
len = strnlen(ctx->req.trsvcid, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "trsvcid too long: %s",
ctx->req.trsvcid);
goto cleanup;
}
memcpy(trid.trsvcid, ctx->req.trsvcid, len + 1);
}
/* Parse priority for the NVMe-oF transport connection */
if (ctx->req.priority) {
trid.priority = spdk_strtol(ctx->req.priority, 10);
}
/* Parse subnqn */
if (ctx->req.subnqn) {
maxlen = sizeof(trid.subnqn);
len = strnlen(ctx->req.subnqn, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "subnqn too long: %s",
ctx->req.subnqn);
goto cleanup;
}
memcpy(trid.subnqn, ctx->req.subnqn, len + 1);
}
if (ctx->req.hostnqn) {
snprintf(ctx->req.drv_opts.hostnqn, sizeof(ctx->req.drv_opts.hostnqn), "%s",
ctx->req.hostnqn);
}
if (ctx->req.psk) {
snprintf(ctx->req.drv_opts.psk, sizeof(ctx->req.drv_opts.psk), "%s",
ctx->req.psk);
}
if (ctx->req.hostaddr) {
maxlen = sizeof(ctx->req.drv_opts.src_addr);
len = strnlen(ctx->req.hostaddr, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostaddr too long: %s",
ctx->req.hostaddr);
goto cleanup;
}
snprintf(ctx->req.drv_opts.src_addr, maxlen, "%s", ctx->req.hostaddr);
}
if (ctx->req.hostsvcid) {
maxlen = sizeof(ctx->req.drv_opts.src_svcid);
len = strnlen(ctx->req.hostsvcid, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostsvcid too long: %s",
ctx->req.hostsvcid);
goto cleanup;
}
snprintf(ctx->req.drv_opts.src_svcid, maxlen, "%s", ctx->req.hostsvcid);
}
ctrlr = nvme_ctrlr_get_by_name(ctx->req.name);
if (ctrlr) {
/* This controller already exists. Check what the user wants to do. */
if (ctx->req.multipath == BDEV_NVME_MP_MODE_DISABLE) {
/* The user does not want to do any form of multipathing. */
spdk_jsonrpc_send_error_response_fmt(request, -EALREADY,
"A controller named %s already exists and multipath is disabled\n",
ctx->req.name);
goto cleanup;
}
assert(ctx->req.multipath == BDEV_NVME_MP_MODE_FAILOVER ||
ctx->req.multipath == BDEV_NVME_MP_MODE_MULTIPATH);
/* The user wants to add this as a failover path or add this to create multipath. */
drv_opts = spdk_nvme_ctrlr_get_opts(ctrlr->ctrlr);
ctrlr_trid = spdk_nvme_ctrlr_get_transport_id(ctrlr->ctrlr);
if (strncmp(trid.traddr, ctrlr_trid->traddr, sizeof(trid.traddr)) == 0 &&
strncmp(trid.trsvcid, ctrlr_trid->trsvcid, sizeof(trid.trsvcid)) == 0 &&
strncmp(ctx->req.drv_opts.src_addr, drv_opts->src_addr, sizeof(drv_opts->src_addr)) == 0 &&
strncmp(ctx->req.drv_opts.src_svcid, drv_opts->src_svcid, sizeof(drv_opts->src_svcid)) == 0) {
/* Exactly same network path can't be added a second time */
spdk_jsonrpc_send_error_response_fmt(request, -EALREADY,
"A controller named %s already exists with the specified network path\n",
ctx->req.name);
goto cleanup;
}
if (strncmp(trid.subnqn,
ctrlr_trid->subnqn,
SPDK_NVMF_NQN_MAX_LEN) != 0) {
/* Different SUBNQN is not allowed when specifying the same controller name. */
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL,
"A controller named %s already exists, but uses a different subnqn (%s)\n",
ctx->req.name, ctrlr_trid->subnqn);
goto cleanup;
}
if (strncmp(ctx->req.drv_opts.hostnqn, drv_opts->hostnqn, SPDK_NVMF_NQN_MAX_LEN) != 0) {
/* Different HOSTNQN is not allowed when specifying the same controller name. */
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL,
"A controller named %s already exists, but uses a different hostnqn (%s)\n",
ctx->req.name, drv_opts->hostnqn);
goto cleanup;
}
if (ctx->req.bdev_opts.prchk_flags) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL,
"A controller named %s already exists. To add a path, do not specify PI options.\n",
ctx->req.name);
goto cleanup;
}
ctx->req.bdev_opts.prchk_flags = ctrlr->opts.prchk_flags;
}
if (ctx->req.multipath == BDEV_NVME_MP_MODE_MULTIPATH) {
multipath = true;
}
if (ctx->req.drv_opts.num_io_queues == 0 || ctx->req.drv_opts.num_io_queues > UINT16_MAX + 1) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL,
"num_io_queues out of bounds, min: %u max: %u\n",
1, UINT16_MAX + 1);
goto cleanup;
}
ctx->request = request;
/* Should already be zero due to the calloc(), but set explicitly for clarity. */
ctx->req.bdev_opts.from_discovery_service = false;
rc = bdev_nvme_create(&trid, ctx->req.name, ctx->names, ctx->req.max_bdevs,
rpc_bdev_nvme_attach_controller_done, ctx, &ctx->req.drv_opts,
&ctx->req.bdev_opts, multipath);
if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
goto cleanup;
}
return;
cleanup:
free_rpc_bdev_nvme_attach_controller_ctx(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_attach_controller", rpc_bdev_nvme_attach_controller,
SPDK_RPC_RUNTIME)
static void
rpc_dump_nvme_bdev_controller_info(struct nvme_bdev_ctrlr *nbdev_ctrlr, void *ctx)
{
struct spdk_json_write_ctx *w = ctx;
struct nvme_ctrlr *nvme_ctrlr;
spdk_json_write_object_begin(w);
spdk_json_write_named_string(w, "name", nbdev_ctrlr->name);
spdk_json_write_named_array_begin(w, "ctrlrs");
TAILQ_FOREACH(nvme_ctrlr, &nbdev_ctrlr->ctrlrs, tailq) {
nvme_ctrlr_info_json(w, nvme_ctrlr);
}
spdk_json_write_array_end(w);
spdk_json_write_object_end(w);
}
struct rpc_bdev_nvme_get_controllers {
char *name;
};
static void
free_rpc_bdev_nvme_get_controllers(struct rpc_bdev_nvme_get_controllers *r)
{
free(r->name);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_get_controllers_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_get_controllers, name), spdk_json_decode_string, true},
};
static void
rpc_bdev_nvme_get_controllers(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_get_controllers req = {};
struct spdk_json_write_ctx *w;
struct nvme_bdev_ctrlr *nbdev_ctrlr = NULL;
if (params && spdk_json_decode_object(params, rpc_bdev_nvme_get_controllers_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_get_controllers_decoders),
&req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
if (req.name) {
nbdev_ctrlr = nvme_bdev_ctrlr_get_by_name(req.name);
if (nbdev_ctrlr == NULL) {
SPDK_ERRLOG("ctrlr '%s' does not exist\n", req.name);
spdk_jsonrpc_send_error_response_fmt(request, EINVAL, "Controller %s does not exist", req.name);
goto cleanup;
}
}
w = spdk_jsonrpc_begin_result(request);
spdk_json_write_array_begin(w);
if (nbdev_ctrlr != NULL) {
rpc_dump_nvme_bdev_controller_info(nbdev_ctrlr, w);
} else {
nvme_bdev_ctrlr_for_each(rpc_dump_nvme_bdev_controller_info, w);
}
spdk_json_write_array_end(w);
spdk_jsonrpc_end_result(request, w);
cleanup:
free_rpc_bdev_nvme_get_controllers(&req);
}
SPDK_RPC_REGISTER("bdev_nvme_get_controllers", rpc_bdev_nvme_get_controllers, SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_detach_controller {
char *name;
char *trtype;
char *adrfam;
char *traddr;
char *trsvcid;
char *subnqn;
char *hostaddr;
char *hostsvcid;
};
static void
free_rpc_bdev_nvme_detach_controller(struct rpc_bdev_nvme_detach_controller *req)
{
free(req->name);
free(req->trtype);
free(req->adrfam);
free(req->traddr);
free(req->trsvcid);
free(req->subnqn);
free(req->hostaddr);
free(req->hostsvcid);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_detach_controller_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_detach_controller, name), spdk_json_decode_string},
{"trtype", offsetof(struct rpc_bdev_nvme_detach_controller, trtype), spdk_json_decode_string, true},
{"traddr", offsetof(struct rpc_bdev_nvme_detach_controller, traddr), spdk_json_decode_string, true},
{"adrfam", offsetof(struct rpc_bdev_nvme_detach_controller, adrfam), spdk_json_decode_string, true},
{"trsvcid", offsetof(struct rpc_bdev_nvme_detach_controller, trsvcid), spdk_json_decode_string, true},
{"subnqn", offsetof(struct rpc_bdev_nvme_detach_controller, subnqn), spdk_json_decode_string, true},
{"hostaddr", offsetof(struct rpc_bdev_nvme_detach_controller, hostaddr), spdk_json_decode_string, true},
{"hostsvcid", offsetof(struct rpc_bdev_nvme_detach_controller, hostsvcid), spdk_json_decode_string, true},
};
static void
rpc_bdev_nvme_detach_controller(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_detach_controller req = {NULL};
struct nvme_path_id path = {};
size_t len, maxlen;
int rc = 0;
if (spdk_json_decode_object(params, rpc_bdev_nvme_detach_controller_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_detach_controller_decoders),
&req)) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
if (req.trtype != NULL) {
rc = spdk_nvme_transport_id_populate_trstring(&path.trid, req.trtype);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse trtype: %s\n", req.trtype);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s",
req.trtype);
goto cleanup;
}
rc = spdk_nvme_transport_id_parse_trtype(&path.trid.trtype, req.trtype);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse trtype: %s\n", req.trtype);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s",
req.trtype);
goto cleanup;
}
}
if (req.traddr != NULL) {
maxlen = sizeof(path.trid.traddr);
len = strnlen(req.traddr, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "traddr too long: %s",
req.traddr);
goto cleanup;
}
memcpy(path.trid.traddr, req.traddr, len + 1);
}
if (req.adrfam != NULL) {
rc = spdk_nvme_transport_id_parse_adrfam(&path.trid.adrfam, req.adrfam);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse adrfam: %s\n", req.adrfam);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse adrfam: %s",
req.adrfam);
goto cleanup;
}
}
if (req.trsvcid != NULL) {
maxlen = sizeof(path.trid.trsvcid);
len = strnlen(req.trsvcid, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "trsvcid too long: %s",
req.trsvcid);
goto cleanup;
}
memcpy(path.trid.trsvcid, req.trsvcid, len + 1);
}
/* Parse subnqn */
if (req.subnqn != NULL) {
maxlen = sizeof(path.trid.subnqn);
len = strnlen(req.subnqn, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "subnqn too long: %s",
req.subnqn);
goto cleanup;
}
memcpy(path.trid.subnqn, req.subnqn, len + 1);
}
if (req.hostaddr) {
maxlen = sizeof(path.hostid.hostaddr);
len = strnlen(req.hostaddr, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostaddr too long: %s",
req.hostaddr);
goto cleanup;
}
snprintf(path.hostid.hostaddr, maxlen, "%s", req.hostaddr);
}
if (req.hostsvcid) {
maxlen = sizeof(path.hostid.hostsvcid);
len = strnlen(req.hostsvcid, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "hostsvcid too long: %s",
req.hostsvcid);
goto cleanup;
}
snprintf(path.hostid.hostsvcid, maxlen, "%s", req.hostsvcid);
}
rc = bdev_nvme_delete(req.name, &path);
if (rc != 0) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
goto cleanup;
}
spdk_jsonrpc_send_bool_response(request, true);
cleanup:
free_rpc_bdev_nvme_detach_controller(&req);
}
SPDK_RPC_REGISTER("bdev_nvme_detach_controller", rpc_bdev_nvme_detach_controller,
SPDK_RPC_RUNTIME)
struct rpc_apply_firmware {
char *filename;
char *bdev_name;
};
static void
free_rpc_apply_firmware(struct rpc_apply_firmware *req)
{
free(req->filename);
free(req->bdev_name);
}
static const struct spdk_json_object_decoder rpc_apply_firmware_decoders[] = {
{"filename", offsetof(struct rpc_apply_firmware, filename), spdk_json_decode_string},
{"bdev_name", offsetof(struct rpc_apply_firmware, bdev_name), spdk_json_decode_string},
};
struct firmware_update_info {
void *fw_image;
void *p;
unsigned int size;
unsigned int size_remaining;
unsigned int offset;
unsigned int transfer;
bool success;
struct spdk_bdev_desc *desc;
struct spdk_io_channel *ch;
struct spdk_thread *orig_thread;
struct spdk_jsonrpc_request *request;
struct spdk_nvme_ctrlr *ctrlr;
struct rpc_apply_firmware req;
};
static void
apply_firmware_cleanup(struct firmware_update_info *firm_ctx)
{
assert(firm_ctx != NULL);
assert(firm_ctx->orig_thread == spdk_get_thread());
if (firm_ctx->fw_image) {
spdk_free(firm_ctx->fw_image);
}
free_rpc_apply_firmware(&firm_ctx->req);
if (firm_ctx->ch) {
spdk_put_io_channel(firm_ctx->ch);
}
if (firm_ctx->desc) {
spdk_bdev_close(firm_ctx->desc);
}
free(firm_ctx);
}
static void
_apply_firmware_complete_reset(void *ctx)
{
struct spdk_json_write_ctx *w;
struct firmware_update_info *firm_ctx = ctx;
assert(firm_ctx->orig_thread == spdk_get_thread());
if (!firm_ctx->success) {
spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"firmware commit failed.");
apply_firmware_cleanup(firm_ctx);
return;
}
if (spdk_nvme_ctrlr_reset(firm_ctx->ctrlr) != 0) {
spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Controller reset failed.");
apply_firmware_cleanup(firm_ctx);
return;
}
w = spdk_jsonrpc_begin_result(firm_ctx->request);
spdk_json_write_string(w, "firmware commit succeeded. Controller reset in progress.");
spdk_jsonrpc_end_result(firm_ctx->request, w);
apply_firmware_cleanup(firm_ctx);
}
static void
apply_firmware_complete_reset(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
{
struct firmware_update_info *firm_ctx = cb_arg;
spdk_bdev_free_io(bdev_io);
firm_ctx->success = success;
spdk_thread_exec_msg(firm_ctx->orig_thread, _apply_firmware_complete_reset, firm_ctx);
}
static void apply_firmware_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg);
static void
_apply_firmware_complete(void *ctx)
{
struct spdk_nvme_cmd cmd = {};
struct spdk_nvme_fw_commit fw_commit;
int slot = 0;
int rc;
struct firmware_update_info *firm_ctx = ctx;
enum spdk_nvme_fw_commit_action commit_action = SPDK_NVME_FW_COMMIT_REPLACE_AND_ENABLE_IMG;
assert(firm_ctx->orig_thread == spdk_get_thread());
if (!firm_ctx->success) {
spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"firmware download failed .");
apply_firmware_cleanup(firm_ctx);
return;
}
firm_ctx->p += firm_ctx->transfer;
firm_ctx->offset += firm_ctx->transfer;
firm_ctx->size_remaining -= firm_ctx->transfer;
switch (firm_ctx->size_remaining) {
case 0:
/* firmware download completed. Commit firmware */
memset(&fw_commit, 0, sizeof(struct spdk_nvme_fw_commit));
fw_commit.fs = slot;
fw_commit.ca = commit_action;
cmd.opc = SPDK_NVME_OPC_FIRMWARE_COMMIT;
memcpy(&cmd.cdw10, &fw_commit, sizeof(uint32_t));
rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, &cmd, NULL, 0,
apply_firmware_complete_reset, firm_ctx);
if (rc) {
spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"firmware commit failed.");
apply_firmware_cleanup(firm_ctx);
return;
}
break;
default:
firm_ctx->transfer = spdk_min(firm_ctx->size_remaining, 4096);
cmd.opc = SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD;
cmd.cdw10 = spdk_nvme_bytes_to_numd(firm_ctx->transfer);
cmd.cdw11 = firm_ctx->offset >> 2;
rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, &cmd, firm_ctx->p,
firm_ctx->transfer, apply_firmware_complete, firm_ctx);
if (rc) {
spdk_jsonrpc_send_error_response(firm_ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"firmware download failed.");
apply_firmware_cleanup(firm_ctx);
return;
}
break;
}
}
static void
apply_firmware_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
{
struct firmware_update_info *firm_ctx = cb_arg;
spdk_bdev_free_io(bdev_io);
firm_ctx->success = success;
spdk_thread_exec_msg(firm_ctx->orig_thread, _apply_firmware_complete, firm_ctx);
}
static void
apply_firmware_open_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx)
{
}
static void
rpc_bdev_nvme_apply_firmware(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
int rc;
int fd = -1;
struct stat fw_stat;
struct spdk_bdev *bdev;
struct spdk_nvme_cmd cmd = {};
struct firmware_update_info *firm_ctx;
firm_ctx = calloc(1, sizeof(struct firmware_update_info));
if (!firm_ctx) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Memory allocation error.");
return;
}
firm_ctx->fw_image = NULL;
firm_ctx->request = request;
firm_ctx->orig_thread = spdk_get_thread();
if (spdk_json_decode_object(params, rpc_apply_firmware_decoders,
SPDK_COUNTOF(rpc_apply_firmware_decoders), &firm_ctx->req)) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed.");
goto err;
}
if (spdk_bdev_open_ext(firm_ctx->req.bdev_name, true, apply_firmware_open_cb, NULL,
&firm_ctx->desc) != 0) {
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"bdev %s could not be opened",
firm_ctx->req.bdev_name);
goto err;
}
bdev = spdk_bdev_desc_get_bdev(firm_ctx->desc);
if ((firm_ctx->ctrlr = bdev_nvme_get_ctrlr(bdev)) == NULL) {
spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Controller information for %s were not found.",
firm_ctx->req.bdev_name);
goto err;
}
firm_ctx->ch = spdk_bdev_get_io_channel(firm_ctx->desc);
if (!firm_ctx->ch) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"No channels were found.");
goto err;
}
fd = open(firm_ctx->req.filename, O_RDONLY);
if (fd < 0) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"open file failed.");
goto err;
}
rc = fstat(fd, &fw_stat);
if (rc < 0) {
close(fd);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"fstat failed.");
goto err;
}
firm_ctx->size = fw_stat.st_size;
if (fw_stat.st_size % 4) {
close(fd);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Firmware image size is not multiple of 4.");
goto err;
}
firm_ctx->fw_image = spdk_zmalloc(firm_ctx->size, 4096, NULL,
SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
if (!firm_ctx->fw_image) {
close(fd);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Memory allocation error.");
goto err;
}
firm_ctx->p = firm_ctx->fw_image;
if (read(fd, firm_ctx->p, firm_ctx->size) != ((ssize_t)(firm_ctx->size))) {
close(fd);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Read firmware image failed!");
goto err;
}
close(fd);
firm_ctx->offset = 0;
firm_ctx->size_remaining = firm_ctx->size;
firm_ctx->transfer = spdk_min(firm_ctx->size_remaining, 4096);
cmd.opc = SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD;
cmd.cdw10 = spdk_nvme_bytes_to_numd(firm_ctx->transfer);
cmd.cdw11 = firm_ctx->offset >> 2;
rc = spdk_bdev_nvme_admin_passthru(firm_ctx->desc, firm_ctx->ch, &cmd, firm_ctx->p,
firm_ctx->transfer, apply_firmware_complete, firm_ctx);
if (rc == 0) {
/* normal return here. */
return;
}
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Read firmware image failed!");
err:
apply_firmware_cleanup(firm_ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_apply_firmware", rpc_bdev_nvme_apply_firmware, SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_transport_stat_ctx {
struct spdk_jsonrpc_request *request;
struct spdk_json_write_ctx *w;
};
static void
rpc_bdev_nvme_rdma_stats(struct spdk_json_write_ctx *w,
struct spdk_nvme_transport_poll_group_stat *stat)
{
struct spdk_nvme_rdma_device_stat *device_stats;
uint32_t i;
spdk_json_write_named_array_begin(w, "devices");
for (i = 0; i < stat->rdma.num_devices; i++) {
device_stats = &stat->rdma.device_stats[i];
spdk_json_write_object_begin(w);
spdk_json_write_named_string(w, "dev_name", device_stats->name);
spdk_json_write_named_uint64(w, "polls", device_stats->polls);
spdk_json_write_named_uint64(w, "idle_polls", device_stats->idle_polls);
spdk_json_write_named_uint64(w, "completions", device_stats->completions);
spdk_json_write_named_uint64(w, "queued_requests", device_stats->queued_requests);
spdk_json_write_named_uint64(w, "total_send_wrs", device_stats->total_send_wrs);
spdk_json_write_named_uint64(w, "send_doorbell_updates", device_stats->send_doorbell_updates);
spdk_json_write_named_uint64(w, "total_recv_wrs", device_stats->total_recv_wrs);
spdk_json_write_named_uint64(w, "recv_doorbell_updates", device_stats->recv_doorbell_updates);
spdk_json_write_object_end(w);
}
spdk_json_write_array_end(w);
}
static void
rpc_bdev_nvme_pcie_stats(struct spdk_json_write_ctx *w,
struct spdk_nvme_transport_poll_group_stat *stat)
{
spdk_json_write_named_uint64(w, "polls", stat->pcie.polls);
spdk_json_write_named_uint64(w, "idle_polls", stat->pcie.idle_polls);
spdk_json_write_named_uint64(w, "completions", stat->pcie.completions);
spdk_json_write_named_uint64(w, "cq_mmio_doorbell_updates", stat->pcie.cq_mmio_doorbell_updates);
spdk_json_write_named_uint64(w, "cq_shadow_doorbell_updates",
stat->pcie.cq_shadow_doorbell_updates);
spdk_json_write_named_uint64(w, "queued_requests", stat->pcie.queued_requests);
spdk_json_write_named_uint64(w, "submitted_requests", stat->pcie.submitted_requests);
spdk_json_write_named_uint64(w, "sq_mmio_doorbell_updates", stat->pcie.sq_mmio_doorbell_updates);
spdk_json_write_named_uint64(w, "sq_shadow_doorbell_updates",
stat->pcie.sq_shadow_doorbell_updates);
}
static void
rpc_bdev_nvme_tcp_stats(struct spdk_json_write_ctx *w,
struct spdk_nvme_transport_poll_group_stat *stat)
{
spdk_json_write_named_uint64(w, "polls", stat->tcp.polls);
spdk_json_write_named_uint64(w, "idle_polls", stat->tcp.idle_polls);
spdk_json_write_named_uint64(w, "socket_completions", stat->tcp.socket_completions);
spdk_json_write_named_uint64(w, "nvme_completions", stat->tcp.nvme_completions);
spdk_json_write_named_uint64(w, "queued_requests", stat->tcp.queued_requests);
spdk_json_write_named_uint64(w, "submitted_requests", stat->tcp.submitted_requests);
}
static void
rpc_bdev_nvme_stats_per_channel(struct spdk_io_channel_iter *i)
{
struct rpc_bdev_nvme_transport_stat_ctx *ctx;
struct spdk_io_channel *ch;
struct nvme_poll_group *group;
struct spdk_nvme_poll_group_stat *stat;
struct spdk_nvme_transport_poll_group_stat *tr_stat;
uint32_t j;
int rc;
ctx = spdk_io_channel_iter_get_ctx(i);
ch = spdk_io_channel_iter_get_channel(i);
group = spdk_io_channel_get_ctx(ch);
rc = spdk_nvme_poll_group_get_stats(group->group, &stat);
if (rc) {
spdk_for_each_channel_continue(i, rc);
return;
}
spdk_json_write_object_begin(ctx->w);
spdk_json_write_named_string(ctx->w, "thread", spdk_thread_get_name(spdk_get_thread()));
spdk_json_write_named_array_begin(ctx->w, "transports");
for (j = 0; j < stat->num_transports; j++) {
tr_stat = stat->transport_stat[j];
spdk_json_write_object_begin(ctx->w);
spdk_json_write_named_string(ctx->w, "trname", spdk_nvme_transport_id_trtype_str(tr_stat->trtype));
switch (stat->transport_stat[j]->trtype) {
case SPDK_NVME_TRANSPORT_RDMA:
rpc_bdev_nvme_rdma_stats(ctx->w, tr_stat);
break;
case SPDK_NVME_TRANSPORT_PCIE:
case SPDK_NVME_TRANSPORT_VFIOUSER:
rpc_bdev_nvme_pcie_stats(ctx->w, tr_stat);
break;
case SPDK_NVME_TRANSPORT_TCP:
rpc_bdev_nvme_tcp_stats(ctx->w, tr_stat);
break;
default:
SPDK_WARNLOG("Can't handle trtype %d %s\n", tr_stat->trtype,
spdk_nvme_transport_id_trtype_str(tr_stat->trtype));
}
spdk_json_write_object_end(ctx->w);
}
/* transports array */
spdk_json_write_array_end(ctx->w);
spdk_json_write_object_end(ctx->w);
spdk_nvme_poll_group_free_stats(group->group, stat);
spdk_for_each_channel_continue(i, 0);
}
static void
rpc_bdev_nvme_stats_done(struct spdk_io_channel_iter *i, int status)
{
struct rpc_bdev_nvme_transport_stat_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
spdk_json_write_array_end(ctx->w);
spdk_json_write_object_end(ctx->w);
spdk_jsonrpc_end_result(ctx->request, ctx->w);
free(ctx);
}
static void
rpc_bdev_nvme_get_transport_statistics(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_transport_stat_ctx *ctx;
if (params) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
"'bdev_nvme_get_transport_statistics' requires no arguments");
return;
}
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Memory allocation error");
return;
}
ctx->request = request;
ctx->w = spdk_jsonrpc_begin_result(ctx->request);
spdk_json_write_object_begin(ctx->w);
spdk_json_write_named_array_begin(ctx->w, "poll_groups");
spdk_for_each_channel(&g_nvme_bdev_ctrlrs,
rpc_bdev_nvme_stats_per_channel,
ctx,
rpc_bdev_nvme_stats_done);
}
SPDK_RPC_REGISTER("bdev_nvme_get_transport_statistics", rpc_bdev_nvme_get_transport_statistics,
SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_reset_controller_req {
char *name;
};
static void
free_rpc_bdev_nvme_reset_controller_req(struct rpc_bdev_nvme_reset_controller_req *r)
{
free(r->name);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_reset_controller_req_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_reset_controller_req, name), spdk_json_decode_string},
};
struct rpc_bdev_nvme_reset_controller_ctx {
struct spdk_jsonrpc_request *request;
bool success;
struct spdk_thread *orig_thread;
};
static void
_rpc_bdev_nvme_reset_controller_cb(void *_ctx)
{
struct rpc_bdev_nvme_reset_controller_ctx *ctx = _ctx;
if (ctx->success) {
spdk_jsonrpc_send_bool_response(ctx->request, true);
} else {
spdk_jsonrpc_send_error_response(ctx->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Controller reset failed");
}
free(ctx);
}
static void
rpc_bdev_nvme_reset_controller_cb(void *cb_arg, bool success)
{
struct rpc_bdev_nvme_reset_controller_ctx *ctx = cb_arg;
ctx->success = success;
spdk_thread_send_msg(ctx->orig_thread, _rpc_bdev_nvme_reset_controller_cb, ctx);
}
static void
rpc_bdev_nvme_reset_controller(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_reset_controller_req req = {NULL};
struct rpc_bdev_nvme_reset_controller_ctx *ctx;
struct nvme_ctrlr *nvme_ctrlr;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (ctx == NULL) {
SPDK_ERRLOG("Memory allocation failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Memory allocation failed");
return;
}
if (spdk_json_decode_object(params, rpc_bdev_nvme_reset_controller_req_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_reset_controller_req_decoders),
&req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(EINVAL));
goto err;
}
nvme_ctrlr = nvme_ctrlr_get_by_name(req.name);
if (nvme_ctrlr == NULL) {
SPDK_ERRLOG("Failed at device lookup\n");
spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
goto err;
}
ctx->request = request;
ctx->orig_thread = spdk_get_thread();
rc = bdev_nvme_reset_rpc(nvme_ctrlr, rpc_bdev_nvme_reset_controller_cb, ctx);
if (rc != 0) {
SPDK_NOTICELOG("Failed at bdev_nvme_reset_rpc\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, spdk_strerror(-rc));
goto err;
}
free_rpc_bdev_nvme_reset_controller_req(&req);
return;
err:
free_rpc_bdev_nvme_reset_controller_req(&req);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_reset_controller", rpc_bdev_nvme_reset_controller, SPDK_RPC_RUNTIME)
struct rpc_get_controller_health_info {
char *name;
};
struct spdk_nvme_health_info_context {
struct spdk_jsonrpc_request *request;
struct spdk_nvme_ctrlr *ctrlr;
struct spdk_nvme_health_information_page health_page;
};
static void
free_rpc_get_controller_health_info(struct rpc_get_controller_health_info *r)
{
free(r->name);
}
static const struct spdk_json_object_decoder rpc_get_controller_health_info_decoders[] = {
{"name", offsetof(struct rpc_get_controller_health_info, name), spdk_json_decode_string, true},
};
static void
nvme_health_info_cleanup(struct spdk_nvme_health_info_context *context, bool response)
{
if (response == true) {
spdk_jsonrpc_send_error_response(context->request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Internal error.");
}
free(context);
}
static void
get_health_log_page_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
{
int i;
char buf[128];
struct spdk_nvme_health_info_context *context = cb_arg;
struct spdk_jsonrpc_request *request = context->request;
struct spdk_json_write_ctx *w;
struct spdk_nvme_ctrlr *ctrlr = context->ctrlr;
const struct spdk_nvme_transport_id *trid = NULL;
const struct spdk_nvme_ctrlr_data *cdata = NULL;
struct spdk_nvme_health_information_page *health_page = NULL;
if (spdk_nvme_cpl_is_error(cpl)) {
nvme_health_info_cleanup(context, true);
SPDK_ERRLOG("get log page failed\n");
return;
}
if (ctrlr == NULL) {
nvme_health_info_cleanup(context, true);
SPDK_ERRLOG("ctrlr is NULL\n");
return;
} else {
trid = spdk_nvme_ctrlr_get_transport_id(ctrlr);
cdata = spdk_nvme_ctrlr_get_data(ctrlr);
health_page = &(context->health_page);
}
w = spdk_jsonrpc_begin_result(request);
spdk_json_write_object_begin(w);
snprintf(buf, sizeof(cdata->mn) + 1, "%s", cdata->mn);
spdk_str_trim(buf);
spdk_json_write_named_string(w, "model_number", buf);
snprintf(buf, sizeof(cdata->sn) + 1, "%s", cdata->sn);
spdk_str_trim(buf);
spdk_json_write_named_string(w, "serial_number", buf);
snprintf(buf, sizeof(cdata->fr) + 1, "%s", cdata->fr);
spdk_str_trim(buf);
spdk_json_write_named_string(w, "firmware_revision", buf);
spdk_json_write_named_string(w, "traddr", trid->traddr);
spdk_json_write_named_uint64(w, "temperature_celsius", health_page->temperature - 273);
spdk_json_write_named_uint64(w, "available_spare_percentage", health_page->available_spare);
spdk_json_write_named_uint64(w, "available_spare_threshold_percentage",
health_page->available_spare_threshold);
spdk_json_write_named_uint64(w, "percentage_used", health_page->percentage_used);
spdk_json_write_named_uint128(w, "data_units_read",
health_page->data_units_read[0], health_page->data_units_read[1]);
spdk_json_write_named_uint128(w, "data_units_written",
health_page->data_units_written[0], health_page->data_units_written[1]);
spdk_json_write_named_uint128(w, "host_read_commands",
health_page->host_read_commands[0], health_page->host_read_commands[1]);
spdk_json_write_named_uint128(w, "host_write_commands",
health_page->host_write_commands[0], health_page->host_write_commands[1]);
spdk_json_write_named_uint128(w, "controller_busy_time",
health_page->controller_busy_time[0], health_page->controller_busy_time[1]);
spdk_json_write_named_uint128(w, "power_cycles",
health_page->power_cycles[0], health_page->power_cycles[1]);
spdk_json_write_named_uint128(w, "power_on_hours",
health_page->power_on_hours[0], health_page->power_on_hours[1]);
spdk_json_write_named_uint128(w, "unsafe_shutdowns",
health_page->unsafe_shutdowns[0], health_page->unsafe_shutdowns[1]);
spdk_json_write_named_uint128(w, "media_errors",
health_page->media_errors[0], health_page->media_errors[1]);
spdk_json_write_named_uint128(w, "num_err_log_entries",
health_page->num_error_info_log_entries[0], health_page->num_error_info_log_entries[1]);
spdk_json_write_named_uint64(w, "warning_temperature_time_minutes", health_page->warning_temp_time);
spdk_json_write_named_uint64(w, "critical_composite_temperature_time_minutes",
health_page->critical_temp_time);
for (i = 0; i < 8; i++) {
if (health_page->temp_sensor[i] != 0) {
spdk_json_write_named_uint64(w, "temperature_sensor_celsius", health_page->temp_sensor[i] - 273);
}
}
spdk_json_write_object_end(w);
spdk_jsonrpc_end_result(request, w);
nvme_health_info_cleanup(context, false);
}
static void
get_health_log_page(struct spdk_nvme_health_info_context *context)
{
struct spdk_nvme_ctrlr *ctrlr = context->ctrlr;
if (spdk_nvme_ctrlr_cmd_get_log_page(ctrlr, SPDK_NVME_LOG_HEALTH_INFORMATION,
SPDK_NVME_GLOBAL_NS_TAG,
&(context->health_page), sizeof(context->health_page), 0,
get_health_log_page_completion, context)) {
nvme_health_info_cleanup(context, true);
SPDK_ERRLOG("spdk_nvme_ctrlr_cmd_get_log_page() failed\n");
}
}
static void
get_temperature_threshold_feature_completion(void *cb_arg, const struct spdk_nvme_cpl *cpl)
{
struct spdk_nvme_health_info_context *context = cb_arg;
if (spdk_nvme_cpl_is_error(cpl)) {
nvme_health_info_cleanup(context, true);
SPDK_ERRLOG("feature SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD failed in completion\n");
} else {
get_health_log_page(context);
}
}
static int
get_temperature_threshold_feature(struct spdk_nvme_health_info_context *context)
{
struct spdk_nvme_cmd cmd = {};
cmd.opc = SPDK_NVME_OPC_GET_FEATURES;
cmd.cdw10 = SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD;
return spdk_nvme_ctrlr_cmd_admin_raw(context->ctrlr, &cmd, NULL, 0,
get_temperature_threshold_feature_completion, context);
}
static void
get_controller_health_info(struct spdk_jsonrpc_request *request, struct spdk_nvme_ctrlr *ctrlr)
{
struct spdk_nvme_health_info_context *context;
context = calloc(1, sizeof(struct spdk_nvme_health_info_context));
if (!context) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Memory allocation error.");
return;
}
context->request = request;
context->ctrlr = ctrlr;
if (get_temperature_threshold_feature(context)) {
nvme_health_info_cleanup(context, true);
SPDK_ERRLOG("feature SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD failed to submit\n");
}
return;
}
static void
rpc_bdev_nvme_get_controller_health_info(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_get_controller_health_info req = {};
struct nvme_ctrlr *nvme_ctrlr = NULL;
if (!params) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Missing device name");
return;
}
if (spdk_json_decode_object(params, rpc_get_controller_health_info_decoders,
SPDK_COUNTOF(rpc_get_controller_health_info_decoders), &req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
free_rpc_get_controller_health_info(&req);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Invalid parameters");
return;
}
nvme_ctrlr = nvme_ctrlr_get_by_name(req.name);
if (!nvme_ctrlr) {
SPDK_ERRLOG("nvme ctrlr name '%s' does not exist\n", req.name);
free_rpc_get_controller_health_info(&req);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"Device not found");
return;
}
get_controller_health_info(request, nvme_ctrlr->ctrlr);
free_rpc_get_controller_health_info(&req);
return;
}
SPDK_RPC_REGISTER("bdev_nvme_get_controller_health_info",
rpc_bdev_nvme_get_controller_health_info, SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_start_discovery {
char *name;
char *trtype;
char *adrfam;
char *traddr;
char *trsvcid;
char *hostnqn;
bool wait_for_attach;
uint64_t attach_timeout_ms;
struct spdk_nvme_ctrlr_opts opts;
struct nvme_ctrlr_opts bdev_opts;
};
static void
free_rpc_bdev_nvme_start_discovery(struct rpc_bdev_nvme_start_discovery *req)
{
free(req->name);
free(req->trtype);
free(req->adrfam);
free(req->traddr);
free(req->trsvcid);
free(req->hostnqn);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_start_discovery_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_start_discovery, name), spdk_json_decode_string},
{"trtype", offsetof(struct rpc_bdev_nvme_start_discovery, trtype), spdk_json_decode_string},
{"traddr", offsetof(struct rpc_bdev_nvme_start_discovery, traddr), spdk_json_decode_string},
{"adrfam", offsetof(struct rpc_bdev_nvme_start_discovery, adrfam), spdk_json_decode_string, true},
{"trsvcid", offsetof(struct rpc_bdev_nvme_start_discovery, trsvcid), spdk_json_decode_string, true},
{"hostnqn", offsetof(struct rpc_bdev_nvme_start_discovery, hostnqn), spdk_json_decode_string, true},
{"wait_for_attach", offsetof(struct rpc_bdev_nvme_start_discovery, wait_for_attach), spdk_json_decode_bool, true},
{"attach_timeout_ms", offsetof(struct rpc_bdev_nvme_start_discovery, attach_timeout_ms), spdk_json_decode_uint64, true},
{"ctrlr_loss_timeout_sec", offsetof(struct rpc_bdev_nvme_start_discovery, bdev_opts.ctrlr_loss_timeout_sec), spdk_json_decode_int32, true},
{"reconnect_delay_sec", offsetof(struct rpc_bdev_nvme_start_discovery, bdev_opts.reconnect_delay_sec), spdk_json_decode_uint32, true},
{"fast_io_fail_timeout_sec", offsetof(struct rpc_bdev_nvme_start_discovery, bdev_opts.fast_io_fail_timeout_sec), spdk_json_decode_uint32, true},
};
struct rpc_bdev_nvme_start_discovery_ctx {
struct rpc_bdev_nvme_start_discovery req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_start_discovery_done(void *ctx, int status)
{
struct spdk_jsonrpc_request *request = ctx;
if (status != 0) {
spdk_jsonrpc_send_error_response(request, status, spdk_strerror(-status));
} else {
spdk_jsonrpc_send_bool_response(request, true);
}
}
static void
rpc_bdev_nvme_start_discovery(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_start_discovery_ctx *ctx;
struct spdk_nvme_transport_id trid = {};
size_t len, maxlen;
int rc;
spdk_bdev_nvme_start_discovery_fn cb_fn;
void *cb_ctx;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctx->req.opts, sizeof(ctx->req.opts));
if (spdk_json_decode_object(params, rpc_bdev_nvme_start_discovery_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_start_discovery_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
/* Parse trstring */
rc = spdk_nvme_transport_id_populate_trstring(&trid, ctx->req.trtype);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse trtype: %s\n", ctx->req.trtype);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse trtype: %s",
ctx->req.trtype);
goto cleanup;
}
/* Parse trtype */
rc = spdk_nvme_transport_id_parse_trtype(&trid.trtype, ctx->req.trtype);
assert(rc == 0);
/* Parse traddr */
maxlen = sizeof(trid.traddr);
len = strnlen(ctx->req.traddr, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "traddr too long: %s",
ctx->req.traddr);
goto cleanup;
}
memcpy(trid.traddr, ctx->req.traddr, len + 1);
/* Parse adrfam */
if (ctx->req.adrfam) {
rc = spdk_nvme_transport_id_parse_adrfam(&trid.adrfam, ctx->req.adrfam);
if (rc < 0) {
SPDK_ERRLOG("Failed to parse adrfam: %s\n", ctx->req.adrfam);
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "Failed to parse adrfam: %s",
ctx->req.adrfam);
goto cleanup;
}
}
/* Parse trsvcid */
if (ctx->req.trsvcid) {
maxlen = sizeof(trid.trsvcid);
len = strnlen(ctx->req.trsvcid, maxlen);
if (len == maxlen) {
spdk_jsonrpc_send_error_response_fmt(request, -EINVAL, "trsvcid too long: %s",
ctx->req.trsvcid);
goto cleanup;
}
memcpy(trid.trsvcid, ctx->req.trsvcid, len + 1);
}
if (ctx->req.hostnqn) {
snprintf(ctx->req.opts.hostnqn, sizeof(ctx->req.opts.hostnqn), "%s",
ctx->req.hostnqn);
}
if (ctx->req.attach_timeout_ms != 0) {
ctx->req.wait_for_attach = true;
}
ctx->request = request;
cb_fn = ctx->req.wait_for_attach ? rpc_bdev_nvme_start_discovery_done : NULL;
cb_ctx = ctx->req.wait_for_attach ? request : NULL;
rc = bdev_nvme_start_discovery(&trid, ctx->req.name, &ctx->req.opts, &ctx->req.bdev_opts,
ctx->req.attach_timeout_ms, false, cb_fn, cb_ctx);
if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
} else if (!ctx->req.wait_for_attach) {
rpc_bdev_nvme_start_discovery_done(request, 0);
}
cleanup:
free_rpc_bdev_nvme_start_discovery(&ctx->req);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_start_discovery", rpc_bdev_nvme_start_discovery,
SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_stop_discovery {
char *name;
};
static const struct spdk_json_object_decoder rpc_bdev_nvme_stop_discovery_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_stop_discovery, name), spdk_json_decode_string},
};
struct rpc_bdev_nvme_stop_discovery_ctx {
struct rpc_bdev_nvme_stop_discovery req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_stop_discovery_done(void *cb_ctx)
{
struct rpc_bdev_nvme_stop_discovery_ctx *ctx = cb_ctx;
spdk_jsonrpc_send_bool_response(ctx->request, true);
free(ctx->req.name);
free(ctx);
}
static void
rpc_bdev_nvme_stop_discovery(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_stop_discovery_ctx *ctx;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
if (spdk_json_decode_object(params, rpc_bdev_nvme_stop_discovery_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_stop_discovery_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
ctx->request = request;
rc = bdev_nvme_stop_discovery(ctx->req.name, rpc_bdev_nvme_stop_discovery_done, ctx);
if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
goto cleanup;
}
return;
cleanup:
free(ctx->req.name);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_stop_discovery", rpc_bdev_nvme_stop_discovery,
SPDK_RPC_RUNTIME)
static void
rpc_bdev_nvme_get_discovery_info(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct spdk_json_write_ctx *w;
w = spdk_jsonrpc_begin_result(request);
bdev_nvme_get_discovery_info(w);
spdk_jsonrpc_end_result(request, w);
}
SPDK_RPC_REGISTER("bdev_nvme_get_discovery_info", rpc_bdev_nvme_get_discovery_info,
SPDK_RPC_RUNTIME)
enum error_injection_cmd_type {
NVME_ADMIN_CMD = 1,
NVME_IO_CMD,
};
struct rpc_add_error_injection {
char *name;
enum error_injection_cmd_type cmd_type;
uint8_t opc;
bool do_not_submit;
uint64_t timeout_in_us;
uint32_t err_count;
uint8_t sct;
uint8_t sc;
};
static void
free_rpc_add_error_injection(struct rpc_add_error_injection *req)
{
free(req->name);
}
static int
rpc_error_injection_decode_cmd_type(const struct spdk_json_val *val, void *out)
{
int *cmd_type = out;
if (spdk_json_strequal(val, "admin")) {
*cmd_type = NVME_ADMIN_CMD;
} else if (spdk_json_strequal(val, "io")) {
*cmd_type = NVME_IO_CMD;
} else {
SPDK_ERRLOG("Invalid parameter value: cmd_type\n");
return -EINVAL;
}
return 0;
}
static const struct spdk_json_object_decoder rpc_add_error_injection_decoders[] = {
{ "name", offsetof(struct rpc_add_error_injection, name), spdk_json_decode_string },
{ "cmd_type", offsetof(struct rpc_add_error_injection, cmd_type), rpc_error_injection_decode_cmd_type },
{ "opc", offsetof(struct rpc_add_error_injection, opc), spdk_json_decode_uint8 },
{ "do_not_submit", offsetof(struct rpc_add_error_injection, do_not_submit), spdk_json_decode_bool, true },
{ "timeout_in_us", offsetof(struct rpc_add_error_injection, timeout_in_us), spdk_json_decode_uint64, true },
{ "err_count", offsetof(struct rpc_add_error_injection, err_count), spdk_json_decode_uint32, true },
{ "sct", offsetof(struct rpc_add_error_injection, sct), spdk_json_decode_uint8, true},
{ "sc", offsetof(struct rpc_add_error_injection, sc), spdk_json_decode_uint8, true},
};
struct rpc_add_error_injection_ctx {
struct spdk_jsonrpc_request *request;
struct rpc_add_error_injection rpc;
};
static void
rpc_add_error_injection_done(struct spdk_io_channel_iter *i, int status)
{
struct rpc_add_error_injection_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
if (status) {
spdk_jsonrpc_send_error_response(ctx->request, status,
"Failed to add the error injection.");
} else {
spdk_jsonrpc_send_bool_response(ctx->request, true);
}
free_rpc_add_error_injection(&ctx->rpc);
free(ctx);
}
static void
rpc_add_error_injection_per_channel(struct spdk_io_channel_iter *i)
{
struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
struct rpc_add_error_injection_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
struct nvme_ctrlr_channel *ctrlr_ch = spdk_io_channel_get_ctx(ch);
struct spdk_nvme_qpair *qpair = ctrlr_ch->qpair->qpair;
struct spdk_nvme_ctrlr *ctrlr = ctrlr_ch->qpair->ctrlr->ctrlr;
int rc = 0;
if (qpair != NULL) {
rc = spdk_nvme_qpair_add_cmd_error_injection(ctrlr, qpair, ctx->rpc.opc,
ctx->rpc.do_not_submit, ctx->rpc.timeout_in_us, ctx->rpc.err_count,
ctx->rpc.sct, ctx->rpc.sc);
}
spdk_for_each_channel_continue(i, rc);
}
static void
rpc_bdev_nvme_add_error_injection(
struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_add_error_injection_ctx *ctx;
struct nvme_ctrlr *nvme_ctrlr;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
ctx->rpc.err_count = 1;
ctx->request = request;
if (spdk_json_decode_object(params,
rpc_add_error_injection_decoders,
SPDK_COUNTOF(rpc_add_error_injection_decoders),
&ctx->rpc)) {
spdk_jsonrpc_send_error_response(request, -EINVAL,
"Failed to parse the request");
goto cleanup;
}
nvme_ctrlr = nvme_ctrlr_get_by_name(ctx->rpc.name);
if (nvme_ctrlr == NULL) {
SPDK_ERRLOG("No controller with specified name was found.\n");
spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
goto cleanup;
}
if (ctx->rpc.cmd_type == NVME_IO_CMD) {
spdk_for_each_channel(nvme_ctrlr,
rpc_add_error_injection_per_channel,
ctx,
rpc_add_error_injection_done);
return;
} else {
rc = spdk_nvme_qpair_add_cmd_error_injection(nvme_ctrlr->ctrlr, NULL, ctx->rpc.opc,
ctx->rpc.do_not_submit, ctx->rpc.timeout_in_us, ctx->rpc.err_count,
ctx->rpc.sct, ctx->rpc.sc);
if (rc) {
spdk_jsonrpc_send_error_response(request, -rc,
"Failed to add the error injection");
} else {
spdk_jsonrpc_send_bool_response(ctx->request, true);
}
}
cleanup:
free_rpc_add_error_injection(&ctx->rpc);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_add_error_injection", rpc_bdev_nvme_add_error_injection,
SPDK_RPC_RUNTIME)
struct rpc_remove_error_injection {
char *name;
enum error_injection_cmd_type cmd_type;
uint8_t opc;
};
static void
free_rpc_remove_error_injection(struct rpc_remove_error_injection *req)
{
free(req->name);
}
static const struct spdk_json_object_decoder rpc_remove_error_injection_decoders[] = {
{ "name", offsetof(struct rpc_remove_error_injection, name), spdk_json_decode_string },
{ "cmd_type", offsetof(struct rpc_remove_error_injection, cmd_type), rpc_error_injection_decode_cmd_type },
{ "opc", offsetof(struct rpc_remove_error_injection, opc), spdk_json_decode_uint8 },
};
struct rpc_remove_error_injection_ctx {
struct spdk_jsonrpc_request *request;
struct rpc_remove_error_injection rpc;
};
static void
rpc_remove_error_injection_done(struct spdk_io_channel_iter *i, int status)
{
struct rpc_remove_error_injection_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
if (status) {
spdk_jsonrpc_send_error_response(ctx->request, status,
"Failed to remove the error injection.");
} else {
spdk_jsonrpc_send_bool_response(ctx->request, true);
}
free_rpc_remove_error_injection(&ctx->rpc);
free(ctx);
}
static void
rpc_remove_error_injection_per_channel(struct spdk_io_channel_iter *i)
{
struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
struct rpc_remove_error_injection_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
struct nvme_ctrlr_channel *ctrlr_ch = spdk_io_channel_get_ctx(ch);
struct spdk_nvme_qpair *qpair = ctrlr_ch->qpair->qpair;
struct spdk_nvme_ctrlr *ctrlr = ctrlr_ch->qpair->ctrlr->ctrlr;
if (qpair != NULL) {
spdk_nvme_qpair_remove_cmd_error_injection(ctrlr, qpair, ctx->rpc.opc);
}
spdk_for_each_channel_continue(i, 0);
}
static void
rpc_bdev_nvme_remove_error_injection(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_remove_error_injection_ctx *ctx;
struct nvme_ctrlr *nvme_ctrlr;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
ctx->request = request;
if (spdk_json_decode_object(params,
rpc_remove_error_injection_decoders,
SPDK_COUNTOF(rpc_remove_error_injection_decoders),
&ctx->rpc)) {
spdk_jsonrpc_send_error_response(request, -EINVAL,
"Failed to parse the request");
goto cleanup;
}
nvme_ctrlr = nvme_ctrlr_get_by_name(ctx->rpc.name);
if (nvme_ctrlr == NULL) {
SPDK_ERRLOG("No controller with specified name was found.\n");
spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
goto cleanup;
}
if (ctx->rpc.cmd_type == NVME_IO_CMD) {
spdk_for_each_channel(nvme_ctrlr,
rpc_remove_error_injection_per_channel,
ctx,
rpc_remove_error_injection_done);
return;
} else {
spdk_nvme_qpair_remove_cmd_error_injection(nvme_ctrlr->ctrlr, NULL, ctx->rpc.opc);
spdk_jsonrpc_send_bool_response(ctx->request, true);
}
cleanup:
free_rpc_remove_error_injection(&ctx->rpc);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_remove_error_injection", rpc_bdev_nvme_remove_error_injection,
SPDK_RPC_RUNTIME)
struct rpc_get_io_paths {
char *name;
};
static void
free_rpc_get_io_paths(struct rpc_get_io_paths *r)
{
free(r->name);
}
static const struct spdk_json_object_decoder rpc_get_io_paths_decoders[] = {
{"name", offsetof(struct rpc_get_io_paths, name), spdk_json_decode_string, true},
};
struct rpc_get_io_paths_ctx {
struct rpc_get_io_paths req;
struct spdk_jsonrpc_request *request;
struct spdk_json_write_ctx *w;
};
static void
rpc_bdev_nvme_get_io_paths_done(struct spdk_io_channel_iter *i, int status)
{
struct rpc_get_io_paths_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
spdk_json_write_array_end(ctx->w);
spdk_json_write_object_end(ctx->w);
spdk_jsonrpc_end_result(ctx->request, ctx->w);
free_rpc_get_io_paths(&ctx->req);
free(ctx);
}
static void
_rpc_bdev_nvme_get_io_paths(struct spdk_io_channel_iter *i)
{
struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
struct nvme_poll_group *group = spdk_io_channel_get_ctx(_ch);
struct rpc_get_io_paths_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
struct nvme_qpair *qpair;
struct nvme_io_path *io_path;
struct nvme_bdev *nbdev;
spdk_json_write_object_begin(ctx->w);
spdk_json_write_named_string(ctx->w, "thread", spdk_thread_get_name(spdk_get_thread()));
spdk_json_write_named_array_begin(ctx->w, "io_paths");
TAILQ_FOREACH(qpair, &group->qpair_list, tailq) {
TAILQ_FOREACH(io_path, &qpair->io_path_list, tailq) {
nbdev = io_path->nvme_ns->bdev;
if (ctx->req.name != NULL &&
strcmp(ctx->req.name, nbdev->disk.name) != 0) {
continue;
}
nvme_io_path_info_json(ctx->w, io_path);
}
}
spdk_json_write_array_end(ctx->w);
spdk_json_write_object_end(ctx->w);
spdk_for_each_channel_continue(i, 0);
}
static void
rpc_bdev_nvme_get_io_paths(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_get_io_paths_ctx *ctx;
ctx = calloc(1, sizeof(*ctx));
if (ctx == NULL) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
if (params != NULL &&
spdk_json_decode_object(params, rpc_get_io_paths_decoders,
SPDK_COUNTOF(rpc_get_io_paths_decoders),
&ctx->req)) {
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
"bdev_nvme_get_io_paths requires no parameters");
free_rpc_get_io_paths(&ctx->req);
free(ctx);
return;
}
ctx->request = request;
ctx->w = spdk_jsonrpc_begin_result(request);
spdk_json_write_object_begin(ctx->w);
spdk_json_write_named_array_begin(ctx->w, "poll_groups");
spdk_for_each_channel(&g_nvme_bdev_ctrlrs,
_rpc_bdev_nvme_get_io_paths,
ctx,
rpc_bdev_nvme_get_io_paths_done);
}
SPDK_RPC_REGISTER("bdev_nvme_get_io_paths", rpc_bdev_nvme_get_io_paths, SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_set_preferred_path {
char *name;
uint16_t cntlid;
};
static void
free_rpc_bdev_nvme_set_preferred_path(struct rpc_bdev_nvme_set_preferred_path *req)
{
free(req->name);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_set_preferred_path_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_set_preferred_path, name), spdk_json_decode_string},
{"cntlid", offsetof(struct rpc_bdev_nvme_set_preferred_path, cntlid), spdk_json_decode_uint16},
};
struct rpc_bdev_nvme_set_preferred_path_ctx {
struct rpc_bdev_nvme_set_preferred_path req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_set_preferred_path_done(void *cb_arg, int rc)
{
struct rpc_bdev_nvme_set_preferred_path_ctx *ctx = cb_arg;
if (rc == 0) {
spdk_jsonrpc_send_bool_response(ctx->request, true);
} else {
spdk_jsonrpc_send_error_response(ctx->request, rc, spdk_strerror(-rc));
}
free_rpc_bdev_nvme_set_preferred_path(&ctx->req);
free(ctx);
}
static void
rpc_bdev_nvme_set_preferred_path(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_set_preferred_path_ctx *ctx;
ctx = calloc(1, sizeof(*ctx));
if (ctx == NULL) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
if (spdk_json_decode_object(params, rpc_bdev_nvme_set_preferred_path_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_set_preferred_path_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
ctx->request = request;
bdev_nvme_set_preferred_path(ctx->req.name, ctx->req.cntlid,
rpc_bdev_nvme_set_preferred_path_done, ctx);
return;
cleanup:
free_rpc_bdev_nvme_set_preferred_path(&ctx->req);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_set_preferred_path", rpc_bdev_nvme_set_preferred_path,
SPDK_RPC_RUNTIME)
struct rpc_set_multipath_policy {
char *name;
enum bdev_nvme_multipath_policy policy;
enum bdev_nvme_multipath_selector selector;
uint32_t rr_min_io;
};
static void
free_rpc_set_multipath_policy(struct rpc_set_multipath_policy *req)
{
free(req->name);
}
static int
rpc_decode_mp_policy(const struct spdk_json_val *val, void *out)
{
enum bdev_nvme_multipath_policy *policy = out;
if (spdk_json_strequal(val, "active_passive") == true) {
*policy = BDEV_NVME_MP_POLICY_ACTIVE_PASSIVE;
} else if (spdk_json_strequal(val, "active_active") == true) {
*policy = BDEV_NVME_MP_POLICY_ACTIVE_ACTIVE;
} else {
SPDK_NOTICELOG("Invalid parameter value: policy\n");
return -EINVAL;
}
return 0;
}
static int
rpc_decode_mp_selector(const struct spdk_json_val *val, void *out)
{
enum bdev_nvme_multipath_selector *selector = out;
if (spdk_json_strequal(val, "round_robin") == true) {
*selector = BDEV_NVME_MP_SELECTOR_ROUND_ROBIN;
} else if (spdk_json_strequal(val, "queue_depth") == true) {
*selector = BDEV_NVME_MP_SELECTOR_QUEUE_DEPTH;
} else {
SPDK_NOTICELOG("Invalid parameter value: selector\n");
return -EINVAL;
}
return 0;
}
static const struct spdk_json_object_decoder rpc_set_multipath_policy_decoders[] = {
{"name", offsetof(struct rpc_set_multipath_policy, name), spdk_json_decode_string},
{"policy", offsetof(struct rpc_set_multipath_policy, policy), rpc_decode_mp_policy},
{"selector", offsetof(struct rpc_set_multipath_policy, selector), rpc_decode_mp_selector, true},
{"rr_min_io", offsetof(struct rpc_set_multipath_policy, rr_min_io), spdk_json_decode_uint32, true},
};
struct rpc_set_multipath_policy_ctx {
struct rpc_set_multipath_policy req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_set_multipath_policy_done(void *cb_arg, int rc)
{
struct rpc_set_multipath_policy_ctx *ctx = cb_arg;
if (rc == 0) {
spdk_jsonrpc_send_bool_response(ctx->request, true);
} else {
spdk_jsonrpc_send_error_response(ctx->request, rc, spdk_strerror(-rc));
}
free_rpc_set_multipath_policy(&ctx->req);
free(ctx);
}
static void
rpc_bdev_nvme_set_multipath_policy(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_set_multipath_policy_ctx *ctx;
ctx = calloc(1, sizeof(*ctx));
if (ctx == NULL) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
ctx->req.rr_min_io = UINT32_MAX;
if (spdk_json_decode_object(params, rpc_set_multipath_policy_decoders,
SPDK_COUNTOF(rpc_set_multipath_policy_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
ctx->request = request;
if (ctx->req.policy != BDEV_NVME_MP_POLICY_ACTIVE_ACTIVE && ctx->req.selector > 0) {
SPDK_ERRLOG("selector only works in active_active mode\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
bdev_nvme_set_multipath_policy(ctx->req.name, ctx->req.policy, ctx->req.selector,
ctx->req.rr_min_io,
rpc_bdev_nvme_set_multipath_policy_done, ctx);
return;
cleanup:
free_rpc_set_multipath_policy(&ctx->req);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_set_multipath_policy", rpc_bdev_nvme_set_multipath_policy,
SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_start_mdns_discovery {
char *name;
char *svcname;
char *hostnqn;
struct spdk_nvme_ctrlr_opts opts;
struct nvme_ctrlr_opts bdev_opts;
};
static void
free_rpc_bdev_nvme_start_mdns_discovery(struct rpc_bdev_nvme_start_mdns_discovery *req)
{
free(req->name);
free(req->svcname);
free(req->hostnqn);
}
static const struct spdk_json_object_decoder rpc_bdev_nvme_start_mdns_discovery_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_start_mdns_discovery, name), spdk_json_decode_string},
{"svcname", offsetof(struct rpc_bdev_nvme_start_mdns_discovery, svcname), spdk_json_decode_string},
{"hostnqn", offsetof(struct rpc_bdev_nvme_start_mdns_discovery, hostnqn), spdk_json_decode_string, true},
};
struct rpc_bdev_nvme_start_mdns_discovery_ctx {
struct rpc_bdev_nvme_start_mdns_discovery req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_start_mdns_discovery(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_start_mdns_discovery_ctx *ctx;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctx->req.opts, sizeof(ctx->req.opts));
if (spdk_json_decode_object(params, rpc_bdev_nvme_start_mdns_discovery_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_start_mdns_discovery_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
if (ctx->req.hostnqn) {
snprintf(ctx->req.opts.hostnqn, sizeof(ctx->req.opts.hostnqn), "%s",
ctx->req.hostnqn);
}
ctx->request = request;
rc = bdev_nvme_start_mdns_discovery(ctx->req.name, ctx->req.svcname, &ctx->req.opts,
&ctx->req.bdev_opts);
if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
} else {
spdk_jsonrpc_send_bool_response(request, true);
}
cleanup:
free_rpc_bdev_nvme_start_mdns_discovery(&ctx->req);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_start_mdns_discovery", rpc_bdev_nvme_start_mdns_discovery,
SPDK_RPC_RUNTIME)
struct rpc_bdev_nvme_stop_mdns_discovery {
char *name;
};
static const struct spdk_json_object_decoder rpc_bdev_nvme_stop_mdns_discovery_decoders[] = {
{"name", offsetof(struct rpc_bdev_nvme_stop_mdns_discovery, name), spdk_json_decode_string},
};
struct rpc_bdev_nvme_stop_mdns_discovery_ctx {
struct rpc_bdev_nvme_stop_mdns_discovery req;
struct spdk_jsonrpc_request *request;
};
static void
rpc_bdev_nvme_stop_mdns_discovery(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_bdev_nvme_stop_mdns_discovery_ctx *ctx;
int rc;
ctx = calloc(1, sizeof(*ctx));
if (!ctx) {
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
if (spdk_json_decode_object(params, rpc_bdev_nvme_stop_mdns_discovery_decoders,
SPDK_COUNTOF(rpc_bdev_nvme_stop_mdns_discovery_decoders),
&ctx->req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
goto cleanup;
}
ctx->request = request;
rc = bdev_nvme_stop_mdns_discovery(ctx->req.name);
if (rc) {
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
goto cleanup;
}
spdk_jsonrpc_send_bool_response(ctx->request, true);
cleanup:
free(ctx->req.name);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_stop_mdns_discovery", rpc_bdev_nvme_stop_mdns_discovery,
SPDK_RPC_RUNTIME)
static void
rpc_bdev_nvme_get_mdns_discovery_info(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
bdev_nvme_get_mdns_discovery_info(request);
}
SPDK_RPC_REGISTER("bdev_nvme_get_mdns_discovery_info", rpc_bdev_nvme_get_mdns_discovery_info,
SPDK_RPC_RUNTIME)
struct rpc_get_path_stat {
char *name;
};
struct path_stat {
struct spdk_bdev_io_stat stat;
struct spdk_nvme_transport_id trid;
struct nvme_ns *ns;
};
struct rpc_bdev_nvme_path_stat_ctx {
struct spdk_jsonrpc_request *request;
struct path_stat *path_stat;
uint32_t num_paths;
struct spdk_bdev_desc *desc;
};
static void
free_rpc_get_path_stat(struct rpc_get_path_stat *req)
{
free(req->name);
}
static const struct spdk_json_object_decoder rpc_get_path_stat_decoders[] = {
{"name", offsetof(struct rpc_get_path_stat, name), spdk_json_decode_string},
};
static void
dummy_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *ctx)
{
}
static void
rpc_bdev_nvme_path_stat_per_channel(struct spdk_io_channel_iter *i)
{
struct rpc_bdev_nvme_path_stat_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
struct nvme_bdev_channel *nbdev_ch = spdk_io_channel_get_ctx(ch);
struct nvme_io_path *io_path;
struct path_stat *path_stat;
uint32_t j;
assert(ctx->num_paths != 0);
for (j = 0; j < ctx->num_paths; j++) {
path_stat = &ctx->path_stat[j];
STAILQ_FOREACH(io_path, &nbdev_ch->io_path_list, stailq) {
if (path_stat->ns == io_path->nvme_ns) {
assert(io_path->stat != NULL);
spdk_bdev_add_io_stat(&path_stat->stat, io_path->stat);
}
}
}
spdk_for_each_channel_continue(i, 0);
}
static void
rpc_bdev_nvme_path_stat_done(struct spdk_io_channel_iter *i, int status)
{
struct rpc_bdev_nvme_path_stat_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
struct nvme_bdev *nbdev = spdk_io_channel_iter_get_io_device(i);
struct spdk_json_write_ctx *w;
struct path_stat *path_stat;
uint32_t j;
assert(ctx->num_paths != 0);
w = spdk_jsonrpc_begin_result(ctx->request);
spdk_json_write_object_begin(w);
spdk_json_write_named_string(w, "name", nbdev->disk.name);
spdk_json_write_named_array_begin(w, "stats");
for (j = 0; j < ctx->num_paths; j++) {
path_stat = &ctx->path_stat[j];
spdk_json_write_object_begin(w);
spdk_json_write_named_object_begin(w, "trid");
nvme_bdev_dump_trid_json(&path_stat->trid, w);
spdk_json_write_object_end(w);
spdk_json_write_named_object_begin(w, "stat");
spdk_bdev_dump_io_stat_json(&path_stat->stat, w);
spdk_json_write_object_end(w);
spdk_json_write_object_end(w);
}
spdk_json_write_array_end(w);
spdk_json_write_object_end(w);
spdk_jsonrpc_end_result(ctx->request, w);
spdk_bdev_close(ctx->desc);
free(ctx->path_stat);
free(ctx);
}
static void
rpc_bdev_nvme_get_path_iostat(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_get_path_stat req = {};
struct spdk_bdev_desc *desc = NULL;
struct spdk_bdev *bdev;
struct nvme_bdev *nbdev;
struct nvme_ns *nvme_ns;
struct path_stat *path_stat;
struct rpc_bdev_nvme_path_stat_ctx *ctx;
struct spdk_bdev_nvme_opts opts;
uint32_t num_paths = 0, i = 0;
int rc;
bdev_nvme_get_opts(&opts);
if (!opts.io_path_stat) {
SPDK_ERRLOG("RPC not enabled if enable_io_path_stat is false\n");
spdk_jsonrpc_send_error_response(request, -EPERM,
"RPC not enabled if enable_io_path_stat is false");
return;
}
if (spdk_json_decode_object(params, rpc_get_path_stat_decoders,
SPDK_COUNTOF(rpc_get_path_stat_decoders),
&req)) {
SPDK_ERRLOG("spdk_json_decode_object failed\n");
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
"spdk_json_decode_object failed");
free_rpc_get_path_stat(&req);
return;
}
rc = spdk_bdev_open_ext(req.name, false, dummy_bdev_event_cb, NULL, &desc);
if (rc != 0) {
SPDK_ERRLOG("Failed to open bdev '%s': %d\n", req.name, rc);
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
free_rpc_get_path_stat(&req);
return;
}
free_rpc_get_path_stat(&req);
ctx = calloc(1, sizeof(struct rpc_bdev_nvme_path_stat_ctx));
if (ctx == NULL) {
spdk_bdev_close(desc);
SPDK_ERRLOG("Failed to allocate rpc_bdev_nvme_path_stat_ctx struct\n");
spdk_jsonrpc_send_error_response(request, -ENOMEM, spdk_strerror(ENOMEM));
return;
}
bdev = spdk_bdev_desc_get_bdev(desc);
nbdev = bdev->ctxt;
pthread_mutex_lock(&nbdev->mutex);
if (nbdev->ref == 0) {
rc = -ENOENT;
goto err;
}
num_paths = nbdev->ref;
path_stat = calloc(num_paths, sizeof(struct path_stat));
if (path_stat == NULL) {
rc = -ENOMEM;
SPDK_ERRLOG("Failed to allocate memory for path_stat.\n");
goto err;
}
/* store the history stat */
TAILQ_FOREACH(nvme_ns, &nbdev->nvme_ns_list, tailq) {
assert(i < num_paths);
path_stat[i].ns = nvme_ns;
path_stat[i].trid = nvme_ns->ctrlr->active_path_id->trid;
assert(nvme_ns->stat != NULL);
memcpy(&path_stat[i].stat, nvme_ns->stat, sizeof(struct spdk_bdev_io_stat));
i++;
}
pthread_mutex_unlock(&nbdev->mutex);
ctx->request = request;
ctx->desc = desc;
ctx->path_stat = path_stat;
ctx->num_paths = num_paths;
spdk_for_each_channel(nbdev,
rpc_bdev_nvme_path_stat_per_channel,
ctx,
rpc_bdev_nvme_path_stat_done);
return;
err:
pthread_mutex_unlock(&nbdev->mutex);
spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));
spdk_bdev_close(desc);
free(ctx);
}
SPDK_RPC_REGISTER("bdev_nvme_get_path_iostat", rpc_bdev_nvme_get_path_iostat,
SPDK_RPC_RUNTIME)