xref: /spdk/test/unit/lib/nvmf/nvmf.c/nvmf_ut.c (revision 0098e636761237b77c12c30c2408263a5d2260cc)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (c) 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_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(nvmf_transport_accept, uint32_t, (struct spdk_nvmf_transport *transport), 0);
32 DEFINE_STUB_V(nvmf_subsystem_remove_all_listeners, (struct spdk_nvmf_subsystem *subsystem,
33 		bool stop));
34 DEFINE_STUB(spdk_nvmf_subsystem_destroy, int, (struct spdk_nvmf_subsystem *subsystem,
35 		nvmf_subsystem_destroy_cb cpl_cb, void *cpl_cb_arg), 0);
36 DEFINE_STUB(spdk_nvmf_subsystem_get_first_listener, struct spdk_nvmf_subsystem_listener *,
37 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
38 DEFINE_STUB(spdk_nvmf_subsystem_get_next_listener, struct spdk_nvmf_subsystem_listener *,
39 	    (struct spdk_nvmf_subsystem *subsystem,
40 	     struct spdk_nvmf_subsystem_listener *prev_listener), NULL);
41 DEFINE_STUB(spdk_nvmf_subsystem_get_next, struct spdk_nvmf_subsystem *,
42 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
43 DEFINE_STUB(spdk_nvmf_subsystem_get_nqn, const char *,
44 	    (const struct spdk_nvmf_subsystem *subsystem), NULL);
45 DEFINE_STUB(spdk_nvmf_subsystem_get_allow_any_host, bool,
46 	    (const struct spdk_nvmf_subsystem *subsystem), true);
47 DEFINE_STUB(spdk_nvmf_subsystem_get_sn, const char *,
48 	    (const struct spdk_nvmf_subsystem *subsystem),
49 	    NULL);
50 DEFINE_STUB(spdk_nvmf_subsystem_get_mn, const char *,
51 	    (const struct spdk_nvmf_subsystem *subsystem),
52 	    NULL);
53 DEFINE_STUB(spdk_nvmf_subsystem_get_max_namespaces, uint32_t,
54 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
55 DEFINE_STUB(spdk_nvmf_subsystem_get_min_cntlid, uint16_t,
56 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
57 DEFINE_STUB(spdk_nvmf_subsystem_get_max_cntlid, uint16_t,
58 	    (const struct spdk_nvmf_subsystem *subsystem), 0);
59 DEFINE_STUB(spdk_nvmf_subsystem_listener_get_trid, const struct spdk_nvme_transport_id *,
60 	    (struct spdk_nvmf_subsystem_listener *listener), NULL);
61 DEFINE_STUB(spdk_nvme_transport_id_adrfam_str, const char *, (enum spdk_nvmf_adrfam adrfam), NULL);
62 DEFINE_STUB(spdk_nvmf_subsystem_get_first_host, struct spdk_nvmf_host *,
63 	    (struct spdk_nvmf_subsystem *subsystem), 0);
64 DEFINE_STUB(spdk_nvmf_host_get_nqn, const char *, (const struct spdk_nvmf_host *host), NULL);
65 DEFINE_STUB(spdk_nvmf_subsystem_get_next_host, struct spdk_nvmf_host *,
66 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *prev_host), NULL);
67 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns, struct spdk_nvmf_ns *,
68 	    (struct spdk_nvmf_subsystem *subsystem), NULL);
69 DEFINE_STUB(nvmf_subsystem_get_ana_reporting, bool, (struct spdk_nvmf_subsystem *subsystem), 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_opts, (struct spdk_nvmf_transport *transport,
110 		const struct spdk_nvme_transport_id *trid, struct spdk_json_write_ctx *w));
111 
112 struct spdk_io_channel {
113 	struct spdk_thread		*thread;
114 	struct io_device		*dev;
115 	uint32_t			ref;
116 	uint32_t			destroy_ref;
117 	TAILQ_ENTRY(spdk_io_channel)	tailq;
118 	spdk_io_channel_destroy_cb	destroy_cb;
119 
120 	uint8_t				_padding[48];
121 };
122 
123 uint64_t
124 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev)
125 {
126 	return bdev->blockcnt;
127 }
128 
129 const struct spdk_uuid *
130 spdk_bdev_get_uuid(const struct spdk_bdev *bdev)
131 {
132 	return &bdev->uuid;
133 }
134 
135 static void
136 test_nvmf_tgt_create_poll_group(void)
137 {
138 	int rc;
139 	struct spdk_thread		*thread = NULL;
140 	struct spdk_nvmf_tgt		tgt = {};
141 	struct spdk_nvmf_poll_group	group = {};
142 	struct spdk_nvmf_transport	transport = {};
143 	struct spdk_nvmf_subsystem	subsystem = {};
144 	struct spdk_nvmf_ns		ns = {};
145 	struct spdk_bdev		bdev = {};
146 	struct spdk_io_channel		ch = {};
147 	struct spdk_nvmf_transport_poll_group transport_pg = {};
148 
149 	thread = spdk_thread_create(NULL, NULL);
150 	SPDK_CU_ASSERT_FATAL(thread != NULL);
151 	spdk_set_thread(thread);
152 
153 	/* Create group with single subsystem */
154 	ch.thread = thread;
155 	MOCK_SET(spdk_bdev_get_io_channel, &ch);
156 
157 	tgt.max_subsystems = 1;
158 	tgt.subsystems = calloc(tgt.max_subsystems, sizeof(struct spdk_nvmf_subsystem *));
159 	SPDK_CU_ASSERT_FATAL(tgt.subsystems != NULL);
160 
161 	tgt.subsystems[0] = &subsystem;
162 	tgt.subsystems[0]->id = 0;
163 	tgt.subsystems[0]->max_nsid = 1;
164 	tgt.subsystems[0]->ns = calloc(1, sizeof(struct spdk_nvmf_ns *));
165 	SPDK_CU_ASSERT_FATAL(tgt.subsystems[0]->ns != NULL);
166 
167 	tgt.subsystems[0]->ns[0] = &ns;
168 	ns.crkey = 0xaa;
169 	ns.rtype = 0xbb;
170 	TAILQ_INIT(&ns.registrants);
171 	ns.bdev = &bdev;
172 	spdk_uuid_generate(&bdev.uuid);
173 	bdev.blockcnt = 512;
174 
175 	TAILQ_INIT(&tgt.transports);
176 	TAILQ_INIT(&tgt.poll_groups);
177 	pthread_mutex_init(&tgt.mutex, NULL);
178 	transport.tgt = &tgt;
179 	TAILQ_INSERT_TAIL(&tgt.transports, &transport, link);
180 
181 	MOCK_SET(nvmf_transport_poll_group_create, &transport_pg);
182 	rc = nvmf_tgt_create_poll_group((void *)&tgt, (void *)&group);
183 	MOCK_SET(nvmf_transport_poll_group_create, NULL);
184 	CU_ASSERT(rc == 0);
185 	CU_ASSERT(group.num_sgroups == 1);
186 	CU_ASSERT(group.sgroups != NULL);
187 	CU_ASSERT(group.sgroups[0].state == SPDK_NVMF_SUBSYSTEM_ACTIVE);
188 	CU_ASSERT(group.sgroups[0].ns_info[0].channel == &ch);
189 	CU_ASSERT(!memcmp(&group.sgroups[0].ns_info[0].uuid, &bdev.uuid, 16));
190 	CU_ASSERT(group.sgroups[0].ns_info[0].num_blocks == 512);
191 	CU_ASSERT(group.sgroups[0].ns_info[0].crkey == 0xaa);
192 	CU_ASSERT(group.sgroups[0].ns_info[0].rtype == 0xbb);
193 	CU_ASSERT(TAILQ_FIRST(&tgt.poll_groups) == &group);
194 	CU_ASSERT(group.thread == thread);
195 	CU_ASSERT(group.poller != NULL);
196 
197 	nvmf_tgt_destroy_poll_group((void *)&tgt, (void *)&group);
198 	CU_ASSERT(TAILQ_EMPTY(&tgt.poll_groups));
199 	free(tgt.subsystems[0]->ns);
200 	free(tgt.subsystems);
201 
202 	spdk_thread_exit(thread);
203 	while (!spdk_thread_is_exited(thread)) {
204 		spdk_thread_poll(thread, 0, 0);
205 	}
206 	spdk_thread_destroy(thread);
207 	MOCK_CLEAR(spdk_bdev_get_io_channel);
208 }
209 
210 int
211 main(int argc, char **argv)
212 {
213 	CU_pSuite	suite = NULL;
214 	unsigned int	num_failures;
215 
216 	CU_set_error_action(CUEA_ABORT);
217 	CU_initialize_registry();
218 
219 	suite = CU_add_suite("nvmf", NULL, NULL);
220 
221 	CU_ADD_TEST(suite, test_nvmf_tgt_create_poll_group);
222 
223 	CU_basic_set_mode(CU_BRM_VERBOSE);
224 	CU_basic_run_tests();
225 	num_failures = CU_get_number_of_failures();
226 	CU_cleanup_registry();
227 	return num_failures;
228 }
229