xref: /spdk/test/unit/lib/nvmf/nvmf.c/nvmf_ut.c (revision c164db9ffe3718ad4e4f5bab380ccfa62c2fa672)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (C) 2021 Intel Corporation. All rights reserved.
3  *   Copyright (c) 2019, 2021 Mellanox Technologies LTD. All rights reserved.
4  */
5 
6 #include "spdk/stdinc.h"
7 #include "spdk_internal/cunit.h"
8 #include "common/lib/test_env.c"
9 #include "nvmf/nvmf.c"
10 #include "spdk/bdev_module.h"
11 
12 DEFINE_STUB_V(nvmf_transport_poll_group_destroy, (struct spdk_nvmf_transport_poll_group *group));
13 DEFINE_STUB_V(nvmf_ctrlr_destruct, (struct spdk_nvmf_ctrlr *ctrlr));
14 DEFINE_STUB_V(nvmf_transport_qpair_fini, (struct spdk_nvmf_qpair *qpair,
15 		spdk_nvmf_transport_qpair_fini_cb cb_fn,
16 		void *cb_arg));
17 DEFINE_STUB_V(nvmf_qpair_free_aer, (struct spdk_nvmf_qpair *qpair));
18 DEFINE_STUB_V(nvmf_qpair_abort_pending_zcopy_reqs, (struct spdk_nvmf_qpair *qpair));
19 DEFINE_STUB(nvmf_transport_poll_group_create, struct spdk_nvmf_transport_poll_group *,
20 	    (struct spdk_nvmf_transport *transport,
21 	     struct spdk_nvmf_poll_group *group), NULL);
22 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *desc),
23 	    NULL);
24 DEFINE_STUB(nvmf_ctrlr_async_event_ns_notice, int, (struct spdk_nvmf_ctrlr *ctrlr), 0);
25 DEFINE_STUB(nvmf_ctrlr_async_event_ana_change_notice, int,
26 	    (struct spdk_nvmf_ctrlr *ctrlr), 0);
27 DEFINE_STUB(nvmf_transport_poll_group_remove, int, (struct spdk_nvmf_transport_poll_group *group,
28 		struct spdk_nvmf_qpair *qpair), 0);
29 DEFINE_STUB(nvmf_transport_req_free, int, (struct spdk_nvmf_request *req), 0);
30 DEFINE_STUB(nvmf_transport_poll_group_poll, int, (struct spdk_nvmf_transport_poll_group *group), 0);
31 DEFINE_STUB_V(nvmf_subsystem_remove_all_listeners, (struct spdk_nvmf_subsystem *subsystem,
32 		bool stop));
33 DEFINE_STUB(spdk_nvmf_subsystem_destroy, int, (struct spdk_nvmf_subsystem *subsystem,
34 		nvmf_subsystem_destroy_cb cpl_cb, void *cpl_cb_arg), 0);
35 DEFINE_STUB(spdk_nvmf_subsystem_get_first_listener, struct spdk_nvmf_subsystem_listener *,
36 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
37 DEFINE_STUB(spdk_nvmf_subsystem_get_next_listener, struct spdk_nvmf_subsystem_listener *,
38 	    (struct spdk_nvmf_subsystem *subsystem,
39 	     struct spdk_nvmf_subsystem_listener *prev_listener), NULL);
40 DEFINE_STUB(spdk_nvmf_subsystem_get_next, struct spdk_nvmf_subsystem *,
41 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
42 DEFINE_STUB(spdk_nvmf_subsystem_get_nqn, const char *,
43 	    (const struct spdk_nvmf_subsystem *subsystem), NULL);
44 DEFINE_STUB(spdk_nvmf_subsystem_get_allow_any_host, bool,
45 	    (const struct spdk_nvmf_subsystem *subsystem), true);
46 DEFINE_STUB(spdk_nvmf_subsystem_get_sn, const char *,
47 	    (const struct spdk_nvmf_subsystem *subsystem),
48 	    NULL);
49 DEFINE_STUB(spdk_nvmf_subsystem_get_mn, const char *,
50 	    (const struct spdk_nvmf_subsystem *subsystem),
51 	    NULL);
52 DEFINE_STUB(spdk_nvmf_subsystem_get_max_namespaces, uint32_t,
53 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
54 DEFINE_STUB(spdk_nvmf_subsystem_get_min_cntlid, uint16_t,
55 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
56 DEFINE_STUB(spdk_nvmf_subsystem_get_max_cntlid, uint16_t,
57 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
58 DEFINE_STUB(spdk_nvmf_subsystem_listener_get_trid, const struct spdk_nvme_transport_id *,
59 	    (struct spdk_nvmf_subsystem_listener *listener), NULL);
60 DEFINE_STUB(spdk_nvme_transport_id_adrfam_str, const char *, (enum spdk_nvmf_adrfam adrfam), NULL);
61 DEFINE_STUB(spdk_nvmf_subsystem_get_first_host, struct spdk_nvmf_host *,
62 	    (struct spdk_nvmf_subsystem *subsystem), 0);
63 DEFINE_STUB(spdk_nvmf_host_get_nqn, const char *, (const struct spdk_nvmf_host *host), NULL);
64 DEFINE_STUB(spdk_nvmf_subsystem_get_next_host, struct spdk_nvmf_host *,
65 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *prev_host), NULL);
66 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns, struct spdk_nvmf_ns *,
67 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
68 DEFINE_STUB(spdk_nvmf_subsystem_get_ana_reporting, bool, (struct spdk_nvmf_subsystem *subsystem),
69 	    false);
70 DEFINE_STUB_V(spdk_nvmf_ns_get_opts, (const struct spdk_nvmf_ns *ns,
71 				      struct spdk_nvmf_ns_opts *opts, size_t opts_size));
72 DEFINE_STUB(spdk_nvmf_ns_get_id, uint32_t, (const struct spdk_nvmf_ns *ns), 0);
73 DEFINE_STUB(spdk_nvmf_ns_get_bdev, struct spdk_bdev *, (struct spdk_nvmf_ns *ns), NULL);
74 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), 0);
75 DEFINE_STUB(spdk_nvmf_subsystem_get_next_ns, struct spdk_nvmf_ns *,
76 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns), NULL);
77 DEFINE_STUB(spdk_nvmf_transport_listen, int, (struct spdk_nvmf_transport *transport,
78 		const struct spdk_nvme_transport_id *trid,
79 		struct spdk_nvmf_listen_opts *opts), 0);
80 DEFINE_STUB(spdk_nvmf_transport_stop_listen, int,
81 	    (struct spdk_nvmf_transport *transport,
82 	     const struct spdk_nvme_transport_id *trid), 0)
83 DEFINE_STUB(nvmf_transport_get_optimal_poll_group, struct spdk_nvmf_transport_poll_group *,
84 	    (struct spdk_nvmf_transport *transport, struct spdk_nvmf_qpair *qpair), NULL);
85 DEFINE_STUB(nvmf_transport_poll_group_add, int,
86 	    (struct spdk_nvmf_transport_poll_group *group,
87 	     struct spdk_nvmf_qpair *qpair), 0);
88 DEFINE_STUB(nvmf_transport_qpair_get_peer_trid, int,
89 	    (struct spdk_nvmf_qpair *qpair,
90 	     struct spdk_nvme_transport_id *trid), 0);
91 DEFINE_STUB(nvmf_transport_qpair_get_local_trid, int,
92 	    (struct spdk_nvmf_qpair *qpair,
93 	     struct spdk_nvme_transport_id *trid), 0);
94 DEFINE_STUB(nvmf_transport_qpair_get_listen_trid, int,
95 	    (struct spdk_nvmf_qpair *qpair,
96 	     struct spdk_nvme_transport_id *trid), 0);
97 DEFINE_STUB_V(spdk_nvmf_request_exec, (struct spdk_nvmf_request *req));
98 DEFINE_STUB_V(spdk_nvmf_request_zcopy_start, (struct spdk_nvmf_request *req));
99 DEFINE_STUB(spdk_nvmf_get_transport_name, const char *,
100 	    (struct spdk_nvmf_transport *transport), NULL);
101 DEFINE_STUB(spdk_nvmf_transport_destroy, int, (struct spdk_nvmf_transport *transport,
102 		spdk_nvmf_transport_destroy_done_cb cb_fn, void *cb_arg), 0);
103 DEFINE_STUB(spdk_nvmf_subsystem_get_type, enum spdk_nvmf_subtype,
104 	    (struct spdk_nvmf_subsystem *subsystem), 0);
105 DEFINE_STUB(spdk_nvmf_subsystem_get_first, struct spdk_nvmf_subsystem *,
106 	    (struct spdk_nvmf_tgt *tgt), NULL);
107 DEFINE_STUB_V(nvmf_transport_dump_opts, (struct spdk_nvmf_transport *transport,
108 		struct spdk_json_write_ctx *w, bool named));
109 DEFINE_STUB_V(nvmf_transport_listen_dump_trid, (const struct spdk_nvme_transport_id *trid,
110 		struct spdk_json_write_ctx *w));
111 DEFINE_STUB(spdk_nvme_transport_id_compare, int, (const struct spdk_nvme_transport_id *trid1,
112 		const struct spdk_nvme_transport_id *trid2), 0);
113 DEFINE_STUB_V(spdk_nvmf_send_discovery_log_notice, (struct spdk_nvmf_tgt *tgt,
114 		const char *hostnqn));
115 DEFINE_STUB(nvmf_nqn_is_valid, bool, (const char *nqn), true);
116 DEFINE_STUB(nvmf_nqn_is_discovery, bool, (const char *nqn), true);
117 DEFINE_STUB(spdk_key_get_name, const char *, (struct spdk_key *k), NULL);
118 DEFINE_STUB(nvmf_qpair_auth_init, int, (struct spdk_nvmf_qpair *q), 0);
119 DEFINE_STUB_V(nvmf_qpair_auth_destroy, (struct spdk_nvmf_qpair *q));
120 DEFINE_STUB_V(nvmf_tgt_stop_mdns_prr, (struct spdk_nvmf_tgt *tgt));
121 
122 struct spdk_io_channel {
123 	struct spdk_thread		*thread;
124 	struct io_device		*dev;
125 	uint32_t			ref;
126 	uint32_t			destroy_ref;
127 	TAILQ_ENTRY(spdk_io_channel)	tailq;
128 	spdk_io_channel_destroy_cb	destroy_cb;
129 
130 	uint8_t				_padding[48];
131 };
132 
133 uint64_t
134 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev)
135 {
136 	return bdev->blockcnt;
137 }
138 
139 const struct spdk_uuid *
140 spdk_bdev_get_uuid(const struct spdk_bdev *bdev)
141 {
142 	return &bdev->uuid;
143 }
144 
145 static void
146 test_nvmf_tgt_create_poll_group(void)
147 {
148 	int rc;
149 	struct spdk_thread		*thread = NULL;
150 	struct spdk_nvmf_tgt		tgt = {};
151 	struct spdk_nvmf_poll_group	group = {};
152 	struct spdk_nvmf_transport	transport = {};
153 	struct spdk_nvmf_subsystem	subsystem = {};
154 	struct spdk_nvmf_ns		ns = {};
155 	struct spdk_bdev		bdev = {};
156 	struct spdk_io_channel		ch = {};
157 	struct spdk_nvmf_transport_poll_group transport_pg = {};
158 
159 	thread = spdk_thread_create(NULL, NULL);
160 	SPDK_CU_ASSERT_FATAL(thread != NULL);
161 	spdk_set_thread(thread);
162 
163 	/* Create group with single subsystem */
164 	ch.thread = thread;
165 	MOCK_SET(spdk_bdev_get_io_channel, &ch);
166 
167 	tgt.max_subsystems = 1;
168 	RB_INIT(&tgt.subsystems);
169 
170 	/* Make sure subsystem has enough in subnqn so it can be
171 	 * inserted into RB-tree.
172 	 */
173 	snprintf(subsystem.subnqn, sizeof(subsystem.subnqn), "abc");
174 	RB_INSERT(subsystem_tree, &tgt.subsystems, &subsystem);
175 	subsystem.id = 0;
176 	subsystem.max_nsid = 1;
177 	subsystem.ns = calloc(1, sizeof(struct spdk_nvmf_ns *));
178 	SPDK_CU_ASSERT_FATAL(subsystem.ns != NULL);
179 	MOCK_SET(spdk_nvmf_subsystem_get_first, &subsystem);
180 
181 	subsystem.ns[0] = &ns;
182 	ns.crkey = 0xaa;
183 	ns.rtype = 0xbb;
184 	TAILQ_INIT(&ns.registrants);
185 	ns.bdev = &bdev;
186 	spdk_uuid_generate(&bdev.uuid);
187 	bdev.blockcnt = 512;
188 
189 	TAILQ_INIT(&tgt.transports);
190 	TAILQ_INIT(&tgt.poll_groups);
191 	tgt.num_poll_groups = 0;
192 	pthread_mutex_init(&tgt.mutex, NULL);
193 	transport.tgt = &tgt;
194 	TAILQ_INSERT_TAIL(&tgt.transports, &transport, link);
195 
196 	MOCK_SET(nvmf_transport_poll_group_create, &transport_pg);
197 	rc = nvmf_tgt_create_poll_group((void *)&tgt, (void *)&group);
198 	MOCK_SET(nvmf_transport_poll_group_create, NULL);
199 	CU_ASSERT(rc == 0);
200 	CU_ASSERT(group.num_sgroups == 1);
201 	CU_ASSERT(group.sgroups != NULL);
202 	CU_ASSERT(group.sgroups[0].state == SPDK_NVMF_SUBSYSTEM_ACTIVE);
203 	CU_ASSERT(group.sgroups[0].ns_info[0].channel == &ch);
204 	CU_ASSERT(!memcmp(&group.sgroups[0].ns_info[0].uuid, &bdev.uuid, 16));
205 	CU_ASSERT(group.sgroups[0].ns_info[0].num_blocks == 512);
206 	CU_ASSERT(group.sgroups[0].ns_info[0].crkey == 0xaa);
207 	CU_ASSERT(group.sgroups[0].ns_info[0].rtype == 0xbb);
208 	CU_ASSERT(TAILQ_FIRST(&tgt.poll_groups) == &group);
209 	CU_ASSERT(tgt.num_poll_groups == 1);
210 	CU_ASSERT(group.thread == thread);
211 	CU_ASSERT(group.poller != NULL);
212 
213 	nvmf_tgt_destroy_poll_group((void *)&tgt, (void *)&group);
214 	CU_ASSERT(TAILQ_EMPTY(&tgt.poll_groups));
215 	CU_ASSERT(tgt.num_poll_groups == 0);
216 	free(subsystem.ns);
217 	MOCK_CLEAR(spdk_nvmf_subsystem_get_first);
218 
219 	spdk_thread_exit(thread);
220 	while (!spdk_thread_is_exited(thread)) {
221 		spdk_thread_poll(thread, 0, 0);
222 	}
223 	spdk_thread_destroy(thread);
224 	MOCK_CLEAR(spdk_bdev_get_io_channel);
225 }
226 
227 int
228 main(int argc, char **argv)
229 {
230 	CU_pSuite	suite = NULL;
231 	unsigned int	num_failures;
232 
233 	CU_initialize_registry();
234 
235 	suite = CU_add_suite("nvmf", NULL, NULL);
236 
237 	CU_ADD_TEST(suite, test_nvmf_tgt_create_poll_group);
238 
239 	num_failures = spdk_ut_run_tests(argc, argv, NULL);
240 	CU_cleanup_registry();
241 	return num_failures;
242 }
243