Commit 46a34859 authored by Jin Yu's avatar Jin Yu Committed by Tomasz Zawadzki
Browse files

rpc: add keep alive parameter in bdev nvme 



Add keep alive timetout parameter in bdev_nvme_set_options.
NVMe bdev can set this value especially when we test with
bdevperf.

Fix github issue: #1690

Change-Id: I255c935671b74cdb615a8d393e7d7e84524f3c23
Signed-off-by: default avatarJin Yu <jin.yu@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5306


Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatar <dongx.yi@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 7083e01b

CHANGELOG.md

+2 −0
Original line number Diff line number Diff line
@@ -32,6 +32,8 @@ be notified of any discovery log changes. 


A new API `spdk_jsonrpc_send_bool_response` was added to allow sending response for

writing json bool results into one function.

Update API `bdev_nvme_set_options` and add a keep_alive_timeout_ms parameter. Now you

can specify the keep_alive_timeout before creating NVMe bdev.



### rpc

doc/jsonrpc.md

+2 −0
Original line number Diff line number Diff line
@@ -2171,6 +2171,7 @@ Name | Optional | Type | Description 
-------------------------- | -------- | ----------- | -----------

action_on_timeout          | Optional | string      | Action to take on command time out: none, reset or abort

timeout_us                 | Optional | number      | Timeout for each command, in microseconds. If 0, don't track timeouts

keep_alive_timeout_ms      | Optional | number      | Keep alive timeout period in milliseconds, default is 10s

retry_count                | Optional | number      | The number of attempts per I/O before an I/O fails

arbitration_burst          | Optional | number      | The value is expressed as a power of two, a value of 111b indicates no limit

low_priority_weight        | Optional | number      | The maximum number of commands that the controller may launch at one time from a low priority queue
@@ -2196,6 +2197,7 @@ request: 
    "high_priority_weight": 8,

    "nvme_adminq_poll_period_us": 2000,

    "timeout_us": 10000000,

    "keep_alive_timeout_ms": 600000,

    "action_on_timeout": "reset",

    "io_queue_requests" : 2048,

    "delay_cmd_submit": true

module/bdev/nvme/bdev_nvme.c

+3 −0
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ 
#include "spdk/log.h"



#define SPDK_BDEV_NVME_DEFAULT_DELAY_CMD_SUBMIT true

#define SPDK_BDEV_NVME_DEFAULT_KEEP_ALIVE_TIMEOUT_IN_MS	(10000)



static int bdev_nvme_config_json(struct spdk_json_write_ctx *w);
@@ -109,6 +110,7 @@ static TAILQ_HEAD(, nvme_probe_skip_entry) g_skipped_nvme_ctrlrs = TAILQ_HEAD_IN 
static struct spdk_bdev_nvme_opts g_opts = {

	.action_on_timeout = SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE,

	.timeout_us = 0,

	.keep_alive_timeout_ms = SPDK_BDEV_NVME_DEFAULT_KEEP_ALIVE_TIMEOUT_IN_MS,

	.retry_count = 4,

	.arbitration_burst = 0,

	.low_priority_weight = 0,
@@ -1957,6 +1959,7 @@ bdev_nvme_create(struct spdk_nvme_transport_id *trid, 


	spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctx->opts, sizeof(ctx->opts));

	ctx->opts.transport_retry_count = g_opts.retry_count;

	ctx->opts.keep_alive_timeout_ms = g_opts.keep_alive_timeout_ms;



	if (hostnqn) {

		snprintf(ctx->opts.hostnqn, sizeof(ctx->opts.hostnqn), "%s", hostnqn);

module/bdev/nvme/bdev_nvme.h

+1 −0
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ enum spdk_bdev_timeout_action { 
struct spdk_bdev_nvme_opts {

	enum spdk_bdev_timeout_action action_on_timeout;

	uint64_t timeout_us;

	uint32_t keep_alive_timeout_ms;

	uint32_t retry_count;

	uint32_t arbitration_burst;

	uint32_t low_priority_weight;

module/bdev/nvme/bdev_nvme_rpc.c

+1 −0
Original line number Diff line number Diff line
@@ -75,6 +75,7 @@ rpc_decode_action_on_timeout(const struct spdk_json_val *val, void *out) 
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},

	{"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, 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},