Commit b7a2058a authored by JinYu's avatar JinYu Committed by Changpeng Liu
Browse files

unit/nvme: Add unit test for the tcp sgl 



It seems that autotest doesn't cover the function
nvme_tcp_build_sgl_request(), So add the unit test.

Change-Id: I2e243910cb38ffc49bdd6048b365dc7fa60892c2
Signed-off-by: default avatarJinYu <jin.yu@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/456728


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
parent 0e35d799

test/unit/lib/nvme/nvme_tcp.c/nvme_tcp_ut.c

+114 −2
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ 


#include "nvme/nvme_tcp.c"



SPDK_LOG_REGISTER_COMPONENT("nvme", SPDK_LOG_NVME)

SPDK_LOG_REGISTER_COMPONENT("nvme", SPDK_LOG_NVME);



DEFINE_STUB(nvme_request_check_timeout, int, (struct nvme_request *req, uint16_t cid,

		struct spdk_nvme_ctrlr_process *active_proc, uint64_t now_tick), 1);
@@ -181,6 +181,116 @@ test_nvme_tcp_build_iovs(void) 
	CU_ASSERT(iovs[1].iov_len == 4096 * 2);

}



struct nvme_tcp_ut_bdev_io {

	struct iovec iovs[NVME_TCP_MAX_SGL_DESCRIPTORS];

	int iovpos;

};



/* essentially a simplification of bdev_nvme_next_sge and bdev_nvme_reset_sgl */

static void

nvme_tcp_ut_reset_sgl(void *cb_arg, uint32_t offset)

{

	struct nvme_tcp_ut_bdev_io *bio = cb_arg;

	struct iovec *iov;



	for (bio->iovpos = 0; bio->iovpos < NVME_TCP_MAX_SGL_DESCRIPTORS; bio->iovpos++) {

		iov = &bio->iovs[bio->iovpos];

		/* Offset must be aligned with the start of any SGL entry */

		if (offset == 0) {

			break;

		}



		SPDK_CU_ASSERT_FATAL(offset >= iov->iov_len);

		offset -= iov->iov_len;

	}



	SPDK_CU_ASSERT_FATAL(offset == 0);

	SPDK_CU_ASSERT_FATAL(bio->iovpos < NVME_TCP_MAX_SGL_DESCRIPTORS);

}



static int

nvme_tcp_ut_next_sge(void *cb_arg, void **address, uint32_t *length)

{

	struct nvme_tcp_ut_bdev_io *bio = cb_arg;

	struct iovec *iov;



	SPDK_CU_ASSERT_FATAL(bio->iovpos < NVME_TCP_MAX_SGL_DESCRIPTORS);



	iov = &bio->iovs[bio->iovpos];



	*address = iov->iov_base;

	*length = iov->iov_len;

	bio->iovpos++;



	return 0;

}



static void

test_nvme_tcp_build_sgl_request(void)

{

	struct nvme_tcp_qpair tqpair;

	struct nvme_tcp_req tcp_req = {0};

	struct nvme_request req = {{0}};

	struct nvme_tcp_ut_bdev_io bio;

	uint64_t i;

	int rc;



	tcp_req.req = &req;



	req.payload.reset_sgl_fn = nvme_tcp_ut_reset_sgl;

	req.payload.next_sge_fn = nvme_tcp_ut_next_sge;

	req.payload.contig_or_cb_arg = &bio;

	req.qpair = &tqpair.qpair;



	for (i = 0; i < NVME_TCP_MAX_SGL_DESCRIPTORS; i++) {

		bio.iovs[i].iov_base = (void *)(0xFEEDB000 + i * 0x1000);

		bio.iovs[i].iov_len = 0;

	}



	/* Test case 1: Single SGL. Expected: PASS */

	bio.iovpos = 0;

	req.payload_offset = 0;

	req.payload_size = 0x1000;

	bio.iovs[0].iov_len = 0x1000;

	rc = nvme_tcp_build_sgl_request(&tqpair, &tcp_req);

	SPDK_CU_ASSERT_FATAL(rc == 0);

	CU_ASSERT(bio.iovpos == 1);

	CU_ASSERT((uint64_t)tcp_req.iov[0].iov_base == (uint64_t)bio.iovs[0].iov_base);

	CU_ASSERT(tcp_req.iov[0].iov_len == bio.iovs[0].iov_len);

	CU_ASSERT(tcp_req.iovcnt == 1);



	/* Test case 2: Multiple SGL. Expected: PASS */

	bio.iovpos = 0;

	req.payload_offset = 0;

	req.payload_size = 0x4000;

	for (i = 0; i < 4; i++) {

		bio.iovs[i].iov_len = 0x1000;

	}

	rc = nvme_tcp_build_sgl_request(&tqpair, &tcp_req);

	SPDK_CU_ASSERT_FATAL(rc == 0);

	CU_ASSERT(bio.iovpos == 4);

	CU_ASSERT(tcp_req.iovcnt == 4);

	for (i = 0; i < 4; i++) {

		CU_ASSERT(tcp_req.iov[i].iov_len == bio.iovs[i].iov_len);

		CU_ASSERT((uint64_t)tcp_req.iov[i].iov_base == (uint64_t)bio.iovs[i].iov_base);

	}



	/* Test case 3: Payload is bigger than SGL. Expected: FAIL */

	bio.iovpos = 0;

	req.payload_offset = 0;

	req.payload_size = 0x17000;

	for (i = 0; i < NVME_TCP_MAX_SGL_DESCRIPTORS; i++) {

		bio.iovs[i].iov_len = 0x1000;

	}

	rc = nvme_tcp_build_sgl_request(&tqpair, &tcp_req);

	SPDK_CU_ASSERT_FATAL(rc != 0);

	CU_ASSERT(bio.iovpos == NVME_TCP_MAX_SGL_DESCRIPTORS);

	for (i = 0; i < NVME_TCP_MAX_SGL_DESCRIPTORS; i++) {

		CU_ASSERT(tcp_req.iov[i].iov_len == bio.iovs[i].iov_len);

		CU_ASSERT((uint64_t)tcp_req.iov[i].iov_base == (uint64_t)bio.iovs[i].iov_base);

	}

}



int main(int argc, char **argv)

{

	CU_pSuite	suite = NULL;
@@ -199,7 +309,9 @@ int main(int argc, char **argv) 
	if (CU_add_test(suite, "nvme_tcp_pdu_set_data_buf",

			test_nvme_tcp_pdu_set_data_buf) == NULL ||

	    CU_add_test(suite, "nvme_tcp_build_iovs",

			test_nvme_tcp_build_iovs) == NULL

			test_nvme_tcp_build_iovs) == NULL ||

	    CU_add_test(suite, "build_sgl_request",

			test_nvme_tcp_build_sgl_request) == NULL

	   ) {

		CU_cleanup_registry();

		return CU_get_error();