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

lib/nvmf: Accept KATO for discovery controller 



Some NVMe applications require SPDK NVMe-oF target to support
KATO for discovery controller.  Hence change discovery controller
to accept KATO.  Update unit tests accordingly.

Fixes the issue #1089.

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


Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Community-CI: SPDK CI Jenkins <sys_sgci@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAlexey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarMaciej Wawryk <maciejx.wawryk@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avataryidong0635 <dongx.yi@intel.com>
parent bc1a01c1

lib/nvmf/ctrlr.c

+5 −11
Original line number Diff line number Diff line
@@ -292,17 +292,9 @@ spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 
	ctrlr->feat.volatile_write_cache.bits.wce = 1;



	if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) {

		/* Don't accept keep-alive timeout for discovery controllers */

		if (ctrlr->feat.keep_alive_timer.bits.kato != 0) {

			SPDK_ERRLOG("Discovery controller don't accept keep-alive timeout\n");

			spdk_bit_array_free(&ctrlr->qpair_mask);

			free(ctrlr);

			return NULL;

		}



		/*

		 * Discovery controllers use some arbitrary high value in order

		 * to cleanup stale discovery sessions

		 * If keep-alive timeout is not set, discovery controllers use some

		 * arbitrary high value in order to cleanup stale discovery sessions

		 *

		 * From the 1.0a nvme-of spec:

		 * "The Keep Alive command is reserved for
@@ -314,8 +306,10 @@ spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 
		 * actions for Keep Alive Timer expiration".

		 * kato is in millisecond.

		 */

		if (ctrlr->feat.keep_alive_timer.bits.kato == 0) {

			ctrlr->feat.keep_alive_timer.bits.kato = NVMF_DISC_KATO_IN_MS;

		}

	}



	/* Subtract 1 for admin queue, 1 for 0's based */

	ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 -

test/unit/lib/nvmf/ctrlr.c/ctrlr_ut.c

+30 −5
Original line number Diff line number Diff line
@@ -586,19 +586,44 @@ test_connect(void) 
	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 42);

	CU_ASSERT(qpair.ctrlr == NULL);



	/* I/O connect to discovery controller keep-alive-timeout should be 0 */

	/* I/O connect to discovery controller with keep-alive-timeout != 0 */

	cmd.connect_cmd.qid = 0;

	cmd.connect_cmd.kato = 120000;

	memset(&rsp, 0, sizeof(rsp));

	subsystem.subtype = SPDK_NVMF_SUBTYPE_DISCOVERY;

	subsystem.state = SPDK_NVMF_SUBSYSTEM_ACTIVE;

	TAILQ_INSERT_TAIL(&qpair.outstanding, &req, link);

	rc = spdk_nvmf_ctrlr_connect(&req);

	poll_threads();

	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);

	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);

	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INTERNAL_DEVICE_ERROR);

	CU_ASSERT(qpair.ctrlr == NULL);

	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);

	CU_ASSERT(nvme_status_success(&rsp.nvme_cpl.status));

	CU_ASSERT(qpair.ctrlr != NULL);

	CU_ASSERT(qpair.ctrlr->keep_alive_poller != NULL);

	spdk_nvmf_ctrlr_stop_keep_alive_timer(qpair.ctrlr);

	spdk_bit_array_free(&qpair.ctrlr->qpair_mask);

	free(qpair.ctrlr);

	qpair.ctrlr = NULL;



	/* I/O connect to discovery controller with keep-alive-timeout == 0.

	 *  Then, a fixed timeout value is set to keep-alive-timeout.

	 */

	cmd.connect_cmd.kato = 0;

	memset(&rsp, 0, sizeof(rsp));

	subsystem.subtype = SPDK_NVMF_SUBTYPE_DISCOVERY;

	subsystem.state = SPDK_NVMF_SUBSYSTEM_ACTIVE;

	TAILQ_INSERT_TAIL(&qpair.outstanding, &req, link);

	rc = spdk_nvmf_ctrlr_connect(&req);

	poll_threads();

	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);

	CU_ASSERT(nvme_status_success(&rsp.nvme_cpl.status));

	CU_ASSERT(qpair.ctrlr != NULL);

	CU_ASSERT(qpair.ctrlr->keep_alive_poller != NULL);

	spdk_nvmf_ctrlr_stop_keep_alive_timer(qpair.ctrlr);

	spdk_bit_array_free(&qpair.ctrlr->qpair_mask);

	free(qpair.ctrlr);

	qpair.ctrlr = NULL;

	cmd.connect_cmd.qid = 1;

	cmd.connect_cmd.kato = 120000;

	subsystem.subtype = SPDK_NVMF_SUBTYPE_NVME;



	/* I/O connect to disabled controller */