[ceph.git] / ceph / src / spdk / test / unit / lib / nvme / nvme_poll_group.c / nvme_poll_group_ut.c

/*-
 *   BSD LICENSE
 *
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "spdk_cunit.h"

#include "nvme/nvme_poll_group.c"
#include "common/lib/test_env.c"

struct spdk_nvme_transport {
	const char				name[32];
	TAILQ_ENTRY(spdk_nvme_transport)	link;
};

struct spdk_nvme_transport t1 = {
	.name = "transport1",
};

struct spdk_nvme_transport t2 = {
	.name = "transport2",
};

struct spdk_nvme_transport t3 = {
	.name = "transport3",
};

struct spdk_nvme_transport t4 = {
	.name = "transport4",
};

int64_t g_process_completions_return_value = 0;
int g_destroy_return_value = 0;

TAILQ_HEAD(nvme_transport_list, spdk_nvme_transport) g_spdk_nvme_transports =
	TAILQ_HEAD_INITIALIZER(g_spdk_nvme_transports);

static void
unit_test_disconnected_qpair_cb(struct spdk_nvme_qpair *qpair, void *poll_group_ctx)
{

}

const struct spdk_nvme_transport *
nvme_get_first_transport(void)
{
	return TAILQ_FIRST(&g_spdk_nvme_transports);
}

const struct spdk_nvme_transport *
nvme_get_next_transport(const struct spdk_nvme_transport *transport)
{
	return TAILQ_NEXT(transport, link);
}

int
nvme_transport_poll_group_disconnect_qpair(struct spdk_nvme_qpair *qpair)
{
	struct spdk_nvme_transport_poll_group *tgroup;
	struct spdk_nvme_qpair *iter_qp, *tmp_iter_qp;

	tgroup = qpair->poll_group;

	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->connected_qpairs, poll_group_stailq, tmp_iter_qp) {
		if (qpair == iter_qp) {
			STAILQ_REMOVE(&tgroup->connected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
			STAILQ_INSERT_TAIL(&tgroup->disconnected_qpairs, qpair, poll_group_stailq);
			return 0;
		}
	}

	STAILQ_FOREACH(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq) {
		if (qpair == iter_qp) {
			return 0;
		}
	}

	return -EINVAL;
}

int
nvme_transport_poll_group_connect_qpair(struct spdk_nvme_qpair *qpair)
{
	struct spdk_nvme_transport_poll_group *tgroup;
	struct spdk_nvme_qpair *iter_qp, *tmp_iter_qp;

	tgroup = qpair->poll_group;

	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq, tmp_iter_qp) {
		if (qpair == iter_qp) {
			STAILQ_REMOVE(&tgroup->disconnected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
			STAILQ_INSERT_TAIL(&tgroup->connected_qpairs, qpair, poll_group_stailq);
			return 0;
		}
	}

	STAILQ_FOREACH(iter_qp, &tgroup->connected_qpairs, poll_group_stailq) {
		if (qpair == iter_qp) {
			return 0;
		}
	}

	return -EINVAL;
}

struct spdk_nvme_transport_poll_group *
nvme_transport_poll_group_create(const struct spdk_nvme_transport *transport)
{
	struct spdk_nvme_transport_poll_group *group = NULL;

	/* TODO: separate this transport function table from the transport specific one. */
	group = calloc(1, sizeof(*group));
	if (group) {
		group->transport = transport;
		STAILQ_INIT(&group->connected_qpairs);
		STAILQ_INIT(&group->disconnected_qpairs);
	}

	return group;
}

int
nvme_transport_poll_group_destroy(struct spdk_nvme_transport_poll_group *tgroup)
{
	return g_destroy_return_value;
}

int
nvme_transport_poll_group_add(struct spdk_nvme_transport_poll_group *tgroup,
			      struct spdk_nvme_qpair *qpair)
{
	STAILQ_INSERT_TAIL(&tgroup->connected_qpairs, qpair, poll_group_stailq);
	qpair->poll_group = tgroup;

	return 0;
}

int
nvme_transport_poll_group_remove(struct spdk_nvme_transport_poll_group *tgroup,
				 struct spdk_nvme_qpair *qpair)
{
	struct spdk_nvme_qpair *iter_qp, *tmp_iter_qp;

	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->connected_qpairs, poll_group_stailq, tmp_iter_qp) {
		if (qpair == iter_qp) {
			STAILQ_REMOVE(&tgroup->connected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
			return 0;
		}
	}

	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq, tmp_iter_qp) {
		if (qpair == iter_qp) {
			STAILQ_REMOVE(&tgroup->disconnected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
			return 0;
		}
	}

	return -ENODEV;
}

int64_t
nvme_transport_poll_group_process_completions(struct spdk_nvme_transport_poll_group *group,
		uint32_t completions_per_qpair, spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb)
{
	return g_process_completions_return_value;
}

static void
test_spdk_nvme_poll_group_create(void)
{
	struct spdk_nvme_poll_group *group;

	/* basic case - create a poll group with no internal transport poll groups. */
	group = spdk_nvme_poll_group_create(NULL);

	SPDK_CU_ASSERT_FATAL(group != NULL);
	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);

	/* advanced case - create a poll group with three internal poll groups. */
	group = spdk_nvme_poll_group_create(NULL);
	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	/* Failing case - failed to allocate a poll group. */
	MOCK_SET(calloc, NULL);
	group = spdk_nvme_poll_group_create(NULL);
	CU_ASSERT(group == NULL);
	MOCK_CLEAR(calloc);

	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
}

static void
test_spdk_nvme_poll_group_add_remove(void)
{
	struct spdk_nvme_poll_group *group;
	struct spdk_nvme_transport_poll_group *tgroup = NULL, *tmp_tgroup, *tgroup_1 = NULL,
						       *tgroup_2 = NULL,
							*tgroup_4 = NULL;
	struct spdk_nvme_qpair *qpair;
	struct spdk_nvme_qpair qpair1_1 = {0};
	struct spdk_nvme_qpair qpair1_2 = {0};
	struct spdk_nvme_qpair qpair2_1 = {0};
	struct spdk_nvme_qpair qpair2_2 = {0};
	struct spdk_nvme_qpair qpair4_1 = {0};
	struct spdk_nvme_qpair qpair4_2 = {0};
	int i = 0;

	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);

	group = spdk_nvme_poll_group_create(NULL);
	SPDK_CU_ASSERT_FATAL(group != NULL);
	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));

	/* Add qpairs to a single transport. */
	qpair1_1.transport = &t1;
	qpair1_1.state = NVME_QPAIR_DISCONNECTED;
	qpair1_2.transport = &t1;
	qpair1_2.state = NVME_QPAIR_ENABLED;
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_2) == -EINVAL);
	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
		if (tmp_tgroup->transport == &t1) {
			tgroup = tmp_tgroup;
		} else {
			CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
		}
		i++;
	}
	CU_ASSERT(i == 1);
	SPDK_CU_ASSERT_FATAL(tgroup != NULL);
	qpair = STAILQ_FIRST(&tgroup->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);

	/* Add qpairs to a second transport. */
	qpair2_1.transport = &t2;
	qpair2_2.transport = &t2;
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair2_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair2_2) == 0);
	qpair4_1.transport = &t4;
	qpair4_2.transport = &t4;
	/* Add qpairs for a transport that doesn't exist. */
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_1) == -ENODEV);
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_2) == -ENODEV);
	i = 0;
	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
		if (tmp_tgroup->transport == &t1) {
			tgroup_1 = tmp_tgroup;
		} else if (tmp_tgroup->transport == &t2) {
			tgroup_2 = tmp_tgroup;
		} else {
			CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
		}
		i++;
	}
	CU_ASSERT(i == 2);
	SPDK_CU_ASSERT_FATAL(tgroup_1 != NULL);
	qpair = STAILQ_FIRST(&tgroup_1->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);
	SPDK_CU_ASSERT_FATAL(tgroup_2 != NULL);
	qpair = STAILQ_FIRST(&tgroup_2->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_2);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);

	/* Try removing a qpair that belongs to a transport not in our poll group. */
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_1) == -ENODEV);

	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t4, link);
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_2) == 0);
	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
		if (tmp_tgroup->transport == &t1) {
			tgroup_1 = tmp_tgroup;
		} else if (tmp_tgroup->transport == &t2) {
			tgroup_2 = tmp_tgroup;
		} else if (tmp_tgroup->transport == &t4) {
			tgroup_4 = tmp_tgroup;
		} else {
			CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
		}
	}
	SPDK_CU_ASSERT_FATAL(tgroup_1 != NULL);
	qpair = STAILQ_FIRST(&tgroup_1->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);
	SPDK_CU_ASSERT_FATAL(tgroup_2 != NULL);
	qpair = STAILQ_FIRST(&tgroup_2->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_2);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);
	SPDK_CU_ASSERT_FATAL(tgroup_4 != NULL);
	qpair = STAILQ_FIRST(&tgroup_4->connected_qpairs);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair4_1);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	SPDK_CU_ASSERT_FATAL(qpair == &qpair4_2);
	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
	CU_ASSERT(qpair == NULL);

	/* remove all qpairs */
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair1_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair2_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair2_2) == 0);
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_2) == 0);
	/* Confirm the fourth transport group was created. */
	i = 0;
	STAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp_tgroup) {
		CU_ASSERT(STAILQ_EMPTY(&tgroup->connected_qpairs));
		STAILQ_REMOVE(&group->tgroups, tgroup, spdk_nvme_transport_poll_group, link);
		free(tgroup);
		i++;
	}
	CU_ASSERT(i == 3);
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t4, link);
}

static void
test_spdk_nvme_poll_group_process_completions(void)
{
	struct spdk_nvme_poll_group *group;
	struct spdk_nvme_transport_poll_group *tgroup, *tmp_tgroup;
	struct spdk_nvme_qpair qpair1_1 = {0};

	group = spdk_nvme_poll_group_create(NULL);
	SPDK_CU_ASSERT_FATAL(group != NULL);

	/* If we don't have any transport poll groups, we shouldn't get any completions. */
	g_process_completions_return_value = 32;
	CU_ASSERT(spdk_nvme_poll_group_process_completions(group, 128,
			unit_test_disconnected_qpair_cb) == 0);
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);

	/* try it with three transport poll groups. */
	group = spdk_nvme_poll_group_create(NULL);
	SPDK_CU_ASSERT_FATAL(group != NULL);
	qpair1_1.state = NVME_QPAIR_DISCONNECTED;
	qpair1_1.transport = &t1;
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);
	qpair1_1.state = NVME_QPAIR_ENABLED;
	CU_ASSERT(nvme_poll_group_connect_qpair(&qpair1_1) == 0);
	CU_ASSERT(spdk_nvme_poll_group_process_completions(group, 128,
			unit_test_disconnected_qpair_cb) == 32);
	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair1_1) == 0);
	STAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp_tgroup) {
		CU_ASSERT(STAILQ_EMPTY(&tgroup->connected_qpairs));
		STAILQ_REMOVE(&group->tgroups, tgroup, spdk_nvme_transport_poll_group, link);
		free(tgroup);
	}
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
}

static void
test_spdk_nvme_poll_group_destroy(void)
{
	struct spdk_nvme_poll_group *group;
	struct spdk_nvme_transport_poll_group *tgroup, *tgroup_1, *tgroup_2;
	struct spdk_nvme_qpair qpair1_1 = {0};
	int num_tgroups = 0;

	/* Simple destruction of empty poll group. */
	group = spdk_nvme_poll_group_create(NULL);
	SPDK_CU_ASSERT_FATAL(group != NULL);
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);

	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);
	group = spdk_nvme_poll_group_create(NULL);
	SPDK_CU_ASSERT_FATAL(group != NULL);

	qpair1_1.transport = &t1;
	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);

	/* Don't remove busy poll groups. */
	g_destroy_return_value = -EBUSY;
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == -EBUSY);
	STAILQ_FOREACH(tgroup, &group->tgroups, link) {
		num_tgroups++;
	}
	CU_ASSERT(num_tgroups == 1);

	/* destroy poll group with internal poll groups. */
	g_destroy_return_value = 0;
	tgroup_1 = STAILQ_FIRST(&group->tgroups);
	tgroup_2 = STAILQ_NEXT(tgroup_1, link);
	CU_ASSERT(tgroup_2 == NULL)
	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
	free(tgroup_1);
}

int
main(int argc, char **argv)
{
	CU_pSuite	suite = NULL;
	unsigned int	num_failures;

	if (CU_initialize_registry() != CUE_SUCCESS) {
		return CU_get_error();
	}

	suite = CU_add_suite("nvme_ns_cmd", NULL, NULL);
	if (suite == NULL) {
		CU_cleanup_registry();
		return CU_get_error();
	}

	if (
		CU_add_test(suite, "nvme_poll_group_create_test", test_spdk_nvme_poll_group_create) == NULL ||
		CU_add_test(suite, "nvme_poll_group_add_remove_test",
			    test_spdk_nvme_poll_group_add_remove) == NULL ||
		CU_add_test(suite, "nvme_poll_group_process_completions",
			    test_spdk_nvme_poll_group_process_completions) == NULL ||
		CU_add_test(suite, "nvme_poll_group_destroy_test", test_spdk_nvme_poll_group_destroy) == NULL
	) {
		CU_cleanup_registry();
		return CU_get_error();
	}

	CU_basic_set_mode(CU_BRM_VERBOSE);
	CU_basic_run_tests();
	num_failures = CU_get_number_of_failures();
	CU_cleanup_registry();
	return num_failures;
}
Commit	Line	Data
f67539c2 TL	1	/*-
	2	* BSD LICENSE
	3	*
	4	* Copyright (c) Intel Corporation.
	5	* All rights reserved.
	6	*
	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions
	9	* are met:
	10	*
	11	* * Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* * Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in
	15	* the documentation and/or other materials provided with the
	16	* distribution.
	17	* * Neither the name of Intel Corporation nor the names of its
	18	* contributors may be used to endorse or promote products derived
	19	* from this software without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	22	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	23	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	24	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	25	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	26	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	27	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	28	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	29	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	30	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	31	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*/
	33
	34	#include "spdk_cunit.h"
	35
	36	#include "nvme/nvme_poll_group.c"
	37	#include "common/lib/test_env.c"
	38
	39	struct spdk_nvme_transport {
	40	const char name[32];
	41	TAILQ_ENTRY(spdk_nvme_transport) link;
	42	};
	43
	44	struct spdk_nvme_transport t1 = {
	45	.name = "transport1",
	46	};
	47
	48	struct spdk_nvme_transport t2 = {
	49	.name = "transport2",
	50	};
	51
	52	struct spdk_nvme_transport t3 = {
	53	.name = "transport3",
	54	};
	55
	56	struct spdk_nvme_transport t4 = {
	57	.name = "transport4",
	58	};
	59
	60	int64_t g_process_completions_return_value = 0;
	61	int g_destroy_return_value = 0;
	62
	63	TAILQ_HEAD(nvme_transport_list, spdk_nvme_transport) g_spdk_nvme_transports =
	64	TAILQ_HEAD_INITIALIZER(g_spdk_nvme_transports);
65
66	static void
67	unit_test_disconnected_qpair_cb(struct spdk_nvme_qpair qpair, void poll_group_ctx)
68	{
69
70	}
71
72	const struct spdk_nvme_transport *
73	nvme_get_first_transport(void)
74	{
75	return TAILQ_FIRST(&g_spdk_nvme_transports);
76	}
77
78	const struct spdk_nvme_transport *
79	nvme_get_next_transport(const struct spdk_nvme_transport *transport)
80	{
81	return TAILQ_NEXT(transport, link);
82	}
83
84	int
85	nvme_transport_poll_group_disconnect_qpair(struct spdk_nvme_qpair *qpair)
86	{
87	struct spdk_nvme_transport_poll_group *tgroup;
88	struct spdk_nvme_qpair iter_qp, tmp_iter_qp;
89
90	tgroup = qpair->poll_group;
91
92	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->connected_qpairs, poll_group_stailq, tmp_iter_qp) {
93	if (qpair == iter_qp) {
94	STAILQ_REMOVE(&tgroup->connected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
95	STAILQ_INSERT_TAIL(&tgroup->disconnected_qpairs, qpair, poll_group_stailq);
96	return 0;
97	}
98	}
99
100	STAILQ_FOREACH(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq) {
101	if (qpair == iter_qp) {
102	return 0;
103	}
104	}
105
106	return -EINVAL;
107	}
108
109	int
110	nvme_transport_poll_group_connect_qpair(struct spdk_nvme_qpair *qpair)
111	{
112	struct spdk_nvme_transport_poll_group *tgroup;
113	struct spdk_nvme_qpair iter_qp, tmp_iter_qp;
114
115	tgroup = qpair->poll_group;
116
117	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq, tmp_iter_qp) {
118	if (qpair == iter_qp) {
119	STAILQ_REMOVE(&tgroup->disconnected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
120	STAILQ_INSERT_TAIL(&tgroup->connected_qpairs, qpair, poll_group_stailq);
121	return 0;
122	}
123	}
124
125	STAILQ_FOREACH(iter_qp, &tgroup->connected_qpairs, poll_group_stailq) {
126	if (qpair == iter_qp) {
127	return 0;
128	}
129	}
130
131	return -EINVAL;
132	}
133
134	struct spdk_nvme_transport_poll_group *
135	nvme_transport_poll_group_create(const struct spdk_nvme_transport *transport)
136	{
137	struct spdk_nvme_transport_poll_group *group = NULL;
138
139	/* TODO: separate this transport function table from the transport specific one. */
140	group = calloc(1, sizeof(*group));
141	if (group) {
142	group->transport = transport;
143	STAILQ_INIT(&group->connected_qpairs);
144	STAILQ_INIT(&group->disconnected_qpairs);
145	}
146
147	return group;
148	}
149
150	int
151	nvme_transport_poll_group_destroy(struct spdk_nvme_transport_poll_group *tgroup)
152	{
153	return g_destroy_return_value;
154	}
155
156	int
157	nvme_transport_poll_group_add(struct spdk_nvme_transport_poll_group *tgroup,
158	struct spdk_nvme_qpair *qpair)
159	{
160	STAILQ_INSERT_TAIL(&tgroup->connected_qpairs, qpair, poll_group_stailq);
161	qpair->poll_group = tgroup;
162
163	return 0;
164	}
165
166	int
167	nvme_transport_poll_group_remove(struct spdk_nvme_transport_poll_group *tgroup,
168	struct spdk_nvme_qpair *qpair)
169	{
170	struct spdk_nvme_qpair iter_qp, tmp_iter_qp;
171
172	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->connected_qpairs, poll_group_stailq, tmp_iter_qp) {
173	if (qpair == iter_qp) {
174	STAILQ_REMOVE(&tgroup->connected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
175	return 0;
176	}
177	}
178
179	STAILQ_FOREACH_SAFE(iter_qp, &tgroup->disconnected_qpairs, poll_group_stailq, tmp_iter_qp) {
180	if (qpair == iter_qp) {
181	STAILQ_REMOVE(&tgroup->disconnected_qpairs, qpair, spdk_nvme_qpair, poll_group_stailq);
182	return 0;
183	}
184	}
185
186	return -ENODEV;
187	}
188
189	int64_t
190	nvme_transport_poll_group_process_completions(struct spdk_nvme_transport_poll_group *group,
191	uint32_t completions_per_qpair, spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb)
192	{
193	return g_process_completions_return_value;
194	}
195
196	static void
197	test_spdk_nvme_poll_group_create(void)
198	{
199	struct spdk_nvme_poll_group *group;
200
201	/* basic case - create a poll group with no internal transport poll groups. */
202	group = spdk_nvme_poll_group_create(NULL);
203
204	SPDK_CU_ASSERT_FATAL(group != NULL);
205	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));
206	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
207
208	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
209	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
210	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);
211
212	/* advanced case - create a poll group with three internal poll groups. */
213	group = spdk_nvme_poll_group_create(NULL);
214	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));
215	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
216
217	/* Failing case - failed to allocate a poll group. */
218	MOCK_SET(calloc, NULL);
219	group = spdk_nvme_poll_group_create(NULL);
220	CU_ASSERT(group == NULL);
221	MOCK_CLEAR(calloc);
222
223	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
224	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
225	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
226	}
227
228	static void
229	test_spdk_nvme_poll_group_add_remove(void)
230	{
231	struct spdk_nvme_poll_group *group;
232	struct spdk_nvme_transport_poll_group tgroup = NULL, tmp_tgroup, *tgroup_1 = NULL,
233	*tgroup_2 = NULL,
234	*tgroup_4 = NULL;
235	struct spdk_nvme_qpair *qpair;
236	struct spdk_nvme_qpair qpair1_1 = {0};
237	struct spdk_nvme_qpair qpair1_2 = {0};
238	struct spdk_nvme_qpair qpair2_1 = {0};
239	struct spdk_nvme_qpair qpair2_2 = {0};
240	struct spdk_nvme_qpair qpair4_1 = {0};
241	struct spdk_nvme_qpair qpair4_2 = {0};
242	int i = 0;
243
244	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
245	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
246	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);
247
248	group = spdk_nvme_poll_group_create(NULL);
249	SPDK_CU_ASSERT_FATAL(group != NULL);
250	CU_ASSERT(STAILQ_EMPTY(&group->tgroups));
251
252	/* Add qpairs to a single transport. */
253	qpair1_1.transport = &t1;
254	qpair1_1.state = NVME_QPAIR_DISCONNECTED;
255	qpair1_2.transport = &t1;
256	qpair1_2.state = NVME_QPAIR_ENABLED;
257	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);
258	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_2) == -EINVAL);
259	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
260	if (tmp_tgroup->transport == &t1) {
261	tgroup = tmp_tgroup;
262	} else {
263	CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
264	}
265	i++;
266	}
267	CU_ASSERT(i == 1);
268	SPDK_CU_ASSERT_FATAL(tgroup != NULL);
269	qpair = STAILQ_FIRST(&tgroup->connected_qpairs);
270	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
271	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
272	CU_ASSERT(qpair == NULL);
273
274	/* Add qpairs to a second transport. */
275	qpair2_1.transport = &t2;
276	qpair2_2.transport = &t2;
277	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair2_1) == 0);
278	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair2_2) == 0);
279	qpair4_1.transport = &t4;
280	qpair4_2.transport = &t4;
281	/* Add qpairs for a transport that doesn't exist. */
282	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_1) == -ENODEV);
283	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_2) == -ENODEV);
284	i = 0;
285	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
286	if (tmp_tgroup->transport == &t1) {
287	tgroup_1 = tmp_tgroup;
288	} else if (tmp_tgroup->transport == &t2) {
289	tgroup_2 = tmp_tgroup;
290	} else {
291	CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
292	}
293	i++;
294	}
295	CU_ASSERT(i == 2);
296	SPDK_CU_ASSERT_FATAL(tgroup_1 != NULL);
297	qpair = STAILQ_FIRST(&tgroup_1->connected_qpairs);
298	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
299	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
300	CU_ASSERT(qpair == NULL);
301	SPDK_CU_ASSERT_FATAL(tgroup_2 != NULL);
302	qpair = STAILQ_FIRST(&tgroup_2->connected_qpairs);
303	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_1);
304	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
305	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_2);
306	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
307	CU_ASSERT(qpair == NULL);
308
309	/* Try removing a qpair that belongs to a transport not in our poll group. */
310	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_1) == -ENODEV);
311
312	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t4, link);
313	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_1) == 0);
314	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair4_2) == 0);
315	STAILQ_FOREACH(tmp_tgroup, &group->tgroups, link) {
316	if (tmp_tgroup->transport == &t1) {
317	tgroup_1 = tmp_tgroup;
318	} else if (tmp_tgroup->transport == &t2) {
319	tgroup_2 = tmp_tgroup;
320	} else if (tmp_tgroup->transport == &t4) {
321	tgroup_4 = tmp_tgroup;
322	} else {
323	CU_ASSERT(STAILQ_EMPTY(&tmp_tgroup->connected_qpairs));
324	}
325	}
326	SPDK_CU_ASSERT_FATAL(tgroup_1 != NULL);
327	qpair = STAILQ_FIRST(&tgroup_1->connected_qpairs);
328	SPDK_CU_ASSERT_FATAL(qpair == &qpair1_1);
329	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
330	CU_ASSERT(qpair == NULL);
331	SPDK_CU_ASSERT_FATAL(tgroup_2 != NULL);
332	qpair = STAILQ_FIRST(&tgroup_2->connected_qpairs);
333	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_1);
334	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
335	SPDK_CU_ASSERT_FATAL(qpair == &qpair2_2);
336	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
337	CU_ASSERT(qpair == NULL);
338	SPDK_CU_ASSERT_FATAL(tgroup_4 != NULL);
339	qpair = STAILQ_FIRST(&tgroup_4->connected_qpairs);
340	SPDK_CU_ASSERT_FATAL(qpair == &qpair4_1);
341	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
342	SPDK_CU_ASSERT_FATAL(qpair == &qpair4_2);
343	qpair = STAILQ_NEXT(qpair, poll_group_stailq);
344	CU_ASSERT(qpair == NULL);
345
346	/* remove all qpairs */
347	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair1_1) == 0);
348	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair2_1) == 0);
349	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair2_2) == 0);
350	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_1) == 0);
351	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair4_2) == 0);
352	/* Confirm the fourth transport group was created. */
353	i = 0;
354	STAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp_tgroup) {
355	CU_ASSERT(STAILQ_EMPTY(&tgroup->connected_qpairs));
356	STAILQ_REMOVE(&group->tgroups, tgroup, spdk_nvme_transport_poll_group, link);
357	free(tgroup);
358	i++;
359	}
360	CU_ASSERT(i == 3);
361	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
362
363	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
364	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
365	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
366	TAILQ_REMOVE(&g_spdk_nvme_transports, &t4, link);
367	}
368
369	static void
370	test_spdk_nvme_poll_group_process_completions(void)
371	{
372	struct spdk_nvme_poll_group *group;
373	struct spdk_nvme_transport_poll_group tgroup, tmp_tgroup;
374	struct spdk_nvme_qpair qpair1_1 = {0};
375
376	group = spdk_nvme_poll_group_create(NULL);
377	SPDK_CU_ASSERT_FATAL(group != NULL);
378
379	/* If we don't have any transport poll groups, we shouldn't get any completions. */
380	g_process_completions_return_value = 32;
381	CU_ASSERT(spdk_nvme_poll_group_process_completions(group, 128,
382	unit_test_disconnected_qpair_cb) == 0);
383	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
384
385	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
386	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
387	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);
388
389	/* try it with three transport poll groups. */
390	group = spdk_nvme_poll_group_create(NULL);
391	SPDK_CU_ASSERT_FATAL(group != NULL);
392	qpair1_1.state = NVME_QPAIR_DISCONNECTED;
393	qpair1_1.transport = &t1;
394	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);
395	qpair1_1.state = NVME_QPAIR_ENABLED;
396	CU_ASSERT(nvme_poll_group_connect_qpair(&qpair1_1) == 0);
397	CU_ASSERT(spdk_nvme_poll_group_process_completions(group, 128,
398	unit_test_disconnected_qpair_cb) == 32);
399	CU_ASSERT(spdk_nvme_poll_group_remove(group, &qpair1_1) == 0);
400	STAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp_tgroup) {
401	CU_ASSERT(STAILQ_EMPTY(&tgroup->connected_qpairs));
402	STAILQ_REMOVE(&group->tgroups, tgroup, spdk_nvme_transport_poll_group, link);
403	free(tgroup);
404	}
405	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
406
407	TAILQ_REMOVE(&g_spdk_nvme_transports, &t1, link);
408	TAILQ_REMOVE(&g_spdk_nvme_transports, &t2, link);
409	TAILQ_REMOVE(&g_spdk_nvme_transports, &t3, link);
410	}
411
412	static void
413	test_spdk_nvme_poll_group_destroy(void)
414	{
415	struct spdk_nvme_poll_group *group;
416	struct spdk_nvme_transport_poll_group tgroup, tgroup_1, *tgroup_2;
417	struct spdk_nvme_qpair qpair1_1 = {0};
418	int num_tgroups = 0;
419
420	/* Simple destruction of empty poll group. */
421	group = spdk_nvme_poll_group_create(NULL);
422	SPDK_CU_ASSERT_FATAL(group != NULL);
423	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
424
425	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t1, link);
426	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t2, link);
427	TAILQ_INSERT_TAIL(&g_spdk_nvme_transports, &t3, link);
428	group = spdk_nvme_poll_group_create(NULL);
429	SPDK_CU_ASSERT_FATAL(group != NULL);
430
431	qpair1_1.transport = &t1;
432	CU_ASSERT(spdk_nvme_poll_group_add(group, &qpair1_1) == 0);
433
434	/* Don't remove busy poll groups. */
435	g_destroy_return_value = -EBUSY;
436	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == -EBUSY);
437	STAILQ_FOREACH(tgroup, &group->tgroups, link) {
438	num_tgroups++;
439	}
440	CU_ASSERT(num_tgroups == 1);
441
442	/* destroy poll group with internal poll groups. */
443	g_destroy_return_value = 0;
444	tgroup_1 = STAILQ_FIRST(&group->tgroups);
445	tgroup_2 = STAILQ_NEXT(tgroup_1, link);
446	CU_ASSERT(tgroup_2 == NULL)
447	SPDK_CU_ASSERT_FATAL(spdk_nvme_poll_group_destroy(group) == 0);
448	free(tgroup_1);
449	}
450
451	int
452	main(int argc, char **argv)
453	{
454	CU_pSuite suite = NULL;
455	unsigned int num_failures;
456
457	if (CU_initialize_registry() != CUE_SUCCESS) {
458	return CU_get_error();
459	}
460
461	suite = CU_add_suite("nvme_ns_cmd", NULL, NULL);
462	if (suite == NULL) {
463	CU_cleanup_registry();
464	return CU_get_error();
465	}
466
467	if (
468	CU_add_test(suite, "nvme_poll_group_create_test", test_spdk_nvme_poll_group_create) == NULL \|\|
469	CU_add_test(suite, "nvme_poll_group_add_remove_test",
470	test_spdk_nvme_poll_group_add_remove) == NULL \|\|
471	CU_add_test(suite, "nvme_poll_group_process_completions",
472	test_spdk_nvme_poll_group_process_completions) == NULL \|\|
473	CU_add_test(suite, "nvme_poll_group_destroy_test", test_spdk_nvme_poll_group_destroy) == NULL
474	) {
475	CU_cleanup_registry();
476	return CU_get_error();
477	}
478
479	CU_basic_set_mode(CU_BRM_VERBOSE);
480	CU_basic_run_tests();
481	num_failures = CU_get_number_of_failures();
482	CU_cleanup_registry();
483	return num_failures;
484	}