Commit 4495bda4 authored by Shuhei Matsumoto's avatar Shuhei Matsumoto Committed by Tomasz Zawadzki
Browse files

rpc/bdev_nvme: Deprecate retry_count and add transport_retry_count instead 



retry_count of struct spdk_bdev_nvme_opts controls the number of retries
in the transport layer, and is set to transport_retry_count of struct
spdk_nvme_ctrlr_opts.

The next patch will add bdev_retry_count to struct spdk_bdev_nvme_opts
to control the number of retries in the bdev layer.

For clarification, rename retry_count to transport_retry_count of
struct spdk_bdev_nvme_opts. Then deprecate the retry_count parameter
and add and use an new parameter transport_retry_count instead for
the RPC bdev_nvme_set_options.

Signed-off-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: I0689c54aa1c96ee99d24236e8ff1a594ad7208e4
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9924


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
parent 90245624

CHANGELOG.md

+5 −0
Original line number Diff line number Diff line
@@ -2,6 +2,11 @@ 


## v22.01: (Upcoming Release)



### bdev



The parameter `retry_count` of the RPC `bdev_nvme_set_options` was deprecated and will be

removed in SPDK 22.01, and the parameter `transport_retry_count` is added and used instead.



## v21.10



Structure `spdk_nvmf_target_opts` has been extended with new member `discovery_filter` which allows to specify

doc/jsonrpc.md

+3 −2
Original line number Diff line number Diff line
@@ -2777,7 +2777,7 @@ action_on_timeout | Optional | string | Action to take on command 
timeout_us                 | Optional | number      | Timeout for each command, in microseconds. If 0, don't track timeouts

timeout_admin_us           | Optional | number      | Timeout for each admin command, in microseconds. If 0, treat same as io timeouts ('timeout_us')

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

retry_count                | Optional | number      | The number of attempts per I/O before an I/O fails. (Deprecated. Please use transport_retry_count instead.)

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

medium_priority_weight     | Optional | number      | The maximum number of commands that the controller may launch at one time from a medium priority queue
@@ -2786,6 +2786,7 @@ nvme_adminq_poll_period_us | Optional | number | How often the admin queue 
nvme_ioq_poll_period_us    | Optional | number      | How often I/O queues are polled for completions, in microseconds. Default: 0 (as fast as possible).

io_queue_requests          | Optional | number      | The number of requests allocated for each NVMe I/O queue. Default: 512.

delay_cmd_submit           | Optional | boolean     | Enable delaying NVMe command submission to allow batching of multiple commands. Default: `true`.

transport_retry_count      | Optional | number      | The number of attempts per I/O in the transport layer before an I/O fails.



#### Example
@@ -2795,7 +2796,7 @@ Example request: 
request:

{

  "params": {

    "retry_count": 5,

    "transport_retry_count": 5,

    "arbitration_burst": 3,

    "low_priority_weight": 8,

    "medium_priority_weight":8,

module/bdev/nvme/bdev_nvme.c

+3 −3
Original line number Diff line number Diff line
@@ -131,7 +131,7 @@ static struct spdk_bdev_nvme_opts g_opts = { 
	.timeout_us = 0,

	.timeout_admin_us = 0,

	.keep_alive_timeout_ms = SPDK_BDEV_NVME_DEFAULT_KEEP_ALIVE_TIMEOUT_IN_MS,

	.retry_count = 4,

	.transport_retry_count = 4,

	.arbitration_burst = 0,

	.low_priority_weight = 0,

	.medium_priority_weight = 0,
@@ -3531,7 +3531,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.transport_retry_count = g_opts.transport_retry_count;

	ctx->opts.keep_alive_timeout_ms = g_opts.keep_alive_timeout_ms;

	ctx->opts.disable_read_ana_log_page = true;
@@ -4653,7 +4653,7 @@ bdev_nvme_opts_config_json(struct spdk_json_write_ctx *w) 
	spdk_json_write_named_uint64(w, "timeout_us", g_opts.timeout_us);

	spdk_json_write_named_uint64(w, "timeout_admin_us", g_opts.timeout_admin_us);

	spdk_json_write_named_uint32(w, "keep_alive_timeout_ms", g_opts.keep_alive_timeout_ms);

	spdk_json_write_named_uint32(w, "retry_count", g_opts.retry_count);

	spdk_json_write_named_uint32(w, "transport_retry_count", g_opts.transport_retry_count);

	spdk_json_write_named_uint32(w, "arbitration_burst", g_opts.arbitration_burst);

	spdk_json_write_named_uint32(w, "low_priority_weight", g_opts.low_priority_weight);

	spdk_json_write_named_uint32(w, "medium_priority_weight", g_opts.medium_priority_weight);

module/bdev/nvme/bdev_nvme.h

+2 −1
Original line number Diff line number Diff line
@@ -213,7 +213,8 @@ struct spdk_bdev_nvme_opts { 
	uint64_t timeout_us;

	uint64_t timeout_admin_us;

	uint32_t keep_alive_timeout_ms;

	uint32_t retry_count;

	/* The number of attempts per I/O in the transport layer before an I/O fails. */

	uint32_t transport_retry_count;

	uint32_t arbitration_burst;

	uint32_t low_priority_weight;

	uint32_t medium_priority_weight;

module/bdev/nvme/bdev_nvme_rpc.c

+2 −1
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ static const struct spdk_json_object_decoder rpc_bdev_nvme_options_decoders[] = 
	{"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, retry_count), 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},
@@ -88,6 +88,7 @@ static const struct spdk_json_object_decoder rpc_bdev_nvme_options_decoders[] = 
	{"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},

};



static void