xref: /spdk/test/unit/lib/nvmf/ctrlr.c/ctrlr_ut.c (revision c899854d0371a7cdb3e2fd8c07ccf3d1f0b8089a)
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/stdinc.h"
35 
36 #include "spdk_cunit.h"
37 #include "spdk_internal/mock.h"
38 
39 #include "common/lib/test_env.c"
40 #include "nvmf/ctrlr.c"
41 
42 SPDK_LOG_REGISTER_COMPONENT("nvmf", SPDK_LOG_NVMF)
43 
44 struct spdk_bdev {
45 	int ut_mock;
46 	uint64_t blockcnt;
47 };
48 
49 DEFINE_STUB(spdk_nvmf_tgt_find_subsystem,
50 	    struct spdk_nvmf_subsystem *,
51 	    (struct spdk_nvmf_tgt *tgt, const char *subnqn),
52 	    NULL);
53 
54 DEFINE_STUB(spdk_nvmf_poll_group_create,
55 	    struct spdk_nvmf_poll_group *,
56 	    (struct spdk_nvmf_tgt *tgt),
57 	    NULL);
58 
59 DEFINE_STUB_V(spdk_nvmf_poll_group_destroy,
60 	      (struct spdk_nvmf_poll_group *group));
61 
62 DEFINE_STUB_V(spdk_nvmf_transport_qpair_fini,
63 	      (struct spdk_nvmf_qpair *qpair));
64 
65 DEFINE_STUB(spdk_nvmf_poll_group_add,
66 	    int,
67 	    (struct spdk_nvmf_poll_group *group, struct spdk_nvmf_qpair *qpair),
68 	    0);
69 
70 DEFINE_STUB(spdk_nvmf_subsystem_get_sn,
71 	    const char *,
72 	    (const struct spdk_nvmf_subsystem *subsystem),
73 	    NULL);
74 
75 DEFINE_STUB(spdk_nvmf_subsystem_get_ns,
76 	    struct spdk_nvmf_ns *,
77 	    (struct spdk_nvmf_subsystem *subsystem, uint32_t nsid),
78 	    NULL);
79 
80 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns,
81 	    struct spdk_nvmf_ns *,
82 	    (struct spdk_nvmf_subsystem *subsystem),
83 	    NULL);
84 
85 DEFINE_STUB(spdk_nvmf_subsystem_get_next_ns,
86 	    struct spdk_nvmf_ns *,
87 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns),
88 	    NULL);
89 
90 DEFINE_STUB(spdk_nvmf_subsystem_host_allowed,
91 	    bool,
92 	    (struct spdk_nvmf_subsystem *subsystem, const char *hostnqn),
93 	    true);
94 
95 DEFINE_STUB(spdk_nvmf_subsystem_add_ctrlr,
96 	    int,
97 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr),
98 	    0);
99 
100 DEFINE_STUB_V(spdk_nvmf_subsystem_remove_ctrlr,
101 	      (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr));
102 
103 DEFINE_STUB(spdk_nvmf_subsystem_get_ctrlr,
104 	    struct spdk_nvmf_ctrlr *,
105 	    (struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid),
106 	    NULL);
107 
108 DEFINE_STUB(spdk_nvmf_ctrlr_dsm_supported,
109 	    bool,
110 	    (struct spdk_nvmf_ctrlr *ctrlr),
111 	    false);
112 
113 DEFINE_STUB(spdk_nvmf_ctrlr_write_zeroes_supported,
114 	    bool,
115 	    (struct spdk_nvmf_ctrlr *ctrlr),
116 	    false);
117 
118 DEFINE_STUB_V(spdk_nvmf_get_discovery_log_page,
119 	      (struct spdk_nvmf_tgt *tgt, void *buffer, uint64_t offset, uint32_t length));
120 
121 DEFINE_STUB(spdk_nvmf_request_complete,
122 	    int,
123 	    (struct spdk_nvmf_request *req),
124 	    -1);
125 
126 DEFINE_STUB(spdk_nvmf_request_free,
127 	    int,
128 	    (struct spdk_nvmf_request *req),
129 	    -1);
130 
131 static void
132 ctrlr_ut_pass_msg(spdk_thread_fn fn, void *ctx, void *thread_ctx)
133 {
134 	fn(ctx);
135 }
136 
137 int
138 spdk_nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata)
139 {
140 	uint64_t num_blocks;
141 
142 	SPDK_CU_ASSERT_FATAL(ns->bdev != NULL);
143 	num_blocks = ns->bdev->blockcnt;
144 	nsdata->nsze = num_blocks;
145 	nsdata->ncap = num_blocks;
146 	nsdata->nuse = num_blocks;
147 	nsdata->nlbaf = 0;
148 	nsdata->flbas.format = 0;
149 	nsdata->lbaf[0].lbads = spdk_u32log2(512);
150 
151 	return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
152 }
153 
154 static void
155 test_get_log_page(void)
156 {
157 	struct spdk_nvmf_subsystem subsystem = {};
158 	struct spdk_nvmf_request req = {};
159 	struct spdk_nvmf_qpair qpair = {};
160 	struct spdk_nvmf_ctrlr ctrlr = {};
161 	union nvmf_h2c_msg cmd = {};
162 	union nvmf_c2h_msg rsp = {};
163 	char data[4096];
164 
165 	subsystem.subtype = SPDK_NVMF_SUBTYPE_NVME;
166 
167 	ctrlr.subsys = &subsystem;
168 
169 	qpair.ctrlr = &ctrlr;
170 
171 	req.qpair = &qpair;
172 	req.cmd = &cmd;
173 	req.rsp = &rsp;
174 	req.data = &data;
175 	req.length = sizeof(data);
176 
177 	/* Get Log Page - all valid */
178 	memset(&cmd, 0, sizeof(cmd));
179 	memset(&rsp, 0, sizeof(rsp));
180 	cmd.nvme_cmd.opc = SPDK_NVME_OPC_GET_LOG_PAGE;
181 	cmd.nvme_cmd.cdw10 = SPDK_NVME_LOG_ERROR | (req.length / 4 - 1) << 16;
182 	CU_ASSERT(spdk_nvmf_ctrlr_get_log_page(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
183 	CU_ASSERT(req.rsp->nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
184 	CU_ASSERT(req.rsp->nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
185 
186 	/* Get Log Page with invalid log ID */
187 	memset(&cmd, 0, sizeof(cmd));
188 	memset(&rsp, 0, sizeof(rsp));
189 	cmd.nvme_cmd.opc = SPDK_NVME_OPC_GET_LOG_PAGE;
190 	cmd.nvme_cmd.cdw10 = 0;
191 	CU_ASSERT(spdk_nvmf_ctrlr_get_log_page(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
192 	CU_ASSERT(req.rsp->nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
193 	CU_ASSERT(req.rsp->nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD);
194 
195 	/* Get Log Page with invalid offset (not dword aligned) */
196 	memset(&cmd, 0, sizeof(cmd));
197 	memset(&rsp, 0, sizeof(rsp));
198 	cmd.nvme_cmd.opc = SPDK_NVME_OPC_GET_LOG_PAGE;
199 	cmd.nvme_cmd.cdw10 = SPDK_NVME_LOG_ERROR | (req.length / 4 - 1) << 16;
200 	cmd.nvme_cmd.cdw12 = 2;
201 	CU_ASSERT(spdk_nvmf_ctrlr_get_log_page(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
202 	CU_ASSERT(req.rsp->nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
203 	CU_ASSERT(req.rsp->nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD);
204 
205 	/* Get Log Page without data buffer */
206 	memset(&cmd, 0, sizeof(cmd));
207 	memset(&rsp, 0, sizeof(rsp));
208 	req.data = NULL;
209 	cmd.nvme_cmd.opc = SPDK_NVME_OPC_GET_LOG_PAGE;
210 	cmd.nvme_cmd.cdw10 = SPDK_NVME_LOG_ERROR | (req.length / 4 - 1) << 16;
211 	CU_ASSERT(spdk_nvmf_ctrlr_get_log_page(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
212 	CU_ASSERT(req.rsp->nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
213 	CU_ASSERT(req.rsp->nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD);
214 	req.data = data;
215 }
216 
217 static void
218 test_process_fabrics_cmd(void)
219 {
220 	struct	spdk_nvmf_request req = {};
221 	int	ret;
222 	struct	spdk_nvmf_qpair req_qpair = {};
223 	union	nvmf_h2c_msg  req_cmd = {};
224 	union	nvmf_c2h_msg   req_rsp = {};
225 
226 	req.qpair = &req_qpair;
227 	req.cmd  = &req_cmd;
228 	req.rsp  = &req_rsp;
229 	req.qpair->ctrlr = NULL;
230 
231 	/* No ctrlr and invalid command check */
232 	req.cmd->nvmf_cmd.fctype = SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET;
233 	ret = spdk_nvmf_ctrlr_process_fabrics_cmd(&req);
234 	CU_ASSERT_EQUAL(req.rsp->nvme_cpl.status.sc, SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR);
235 	CU_ASSERT_EQUAL(ret, SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
236 }
237 
238 static bool
239 nvme_status_success(const struct spdk_nvme_status *status)
240 {
241 	return status->sct == SPDK_NVME_SCT_GENERIC && status->sc == SPDK_NVME_SC_SUCCESS;
242 }
243 
244 static void
245 test_connect(void)
246 {
247 	struct spdk_nvmf_fabric_connect_data connect_data;
248 	struct spdk_thread *thread;
249 	struct spdk_nvmf_poll_group group;
250 	struct spdk_nvmf_transport transport;
251 	struct spdk_nvmf_subsystem subsystem;
252 	struct spdk_nvmf_request req;
253 	struct spdk_nvmf_qpair admin_qpair;
254 	struct spdk_nvmf_qpair qpair;
255 	struct spdk_nvmf_qpair qpair2;
256 	struct spdk_nvmf_ctrlr ctrlr;
257 	struct spdk_nvmf_tgt tgt;
258 	union nvmf_h2c_msg cmd;
259 	union nvmf_c2h_msg rsp;
260 	const uint8_t hostid[16] = {
261 		0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
262 		0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F
263 	};
264 	const char subnqn[] = "nqn.2016-06.io.spdk:subsystem1";
265 	const char hostnqn[] = "nqn.2016-06.io.spdk:host1";
266 	int rc;
267 
268 	thread = spdk_allocate_thread(ctrlr_ut_pass_msg, NULL, NULL, NULL, "ctrlr_ut");
269 	SPDK_CU_ASSERT_FATAL(thread != NULL);
270 
271 	memset(&group, 0, sizeof(group));
272 	group.thread = thread;
273 
274 	memset(&ctrlr, 0, sizeof(ctrlr));
275 	ctrlr.subsys = &subsystem;
276 	ctrlr.qpair_mask = spdk_bit_array_create(3);
277 	SPDK_CU_ASSERT_FATAL(ctrlr.qpair_mask != NULL);
278 	ctrlr.vcprop.cc.bits.en = 1;
279 	ctrlr.vcprop.cc.bits.iosqes = 6;
280 	ctrlr.vcprop.cc.bits.iocqes = 4;
281 
282 	memset(&admin_qpair, 0, sizeof(admin_qpair));
283 	admin_qpair.group = &group;
284 
285 	memset(&tgt, 0, sizeof(tgt));
286 	tgt.opts.max_queue_depth = 64;
287 	tgt.opts.max_qpairs_per_ctrlr = 3;
288 
289 	memset(&transport, 0, sizeof(transport));
290 	transport.tgt = &tgt;
291 
292 	memset(&qpair, 0, sizeof(qpair));
293 	qpair.transport = &transport;
294 	qpair.group = &group;
295 
296 	memset(&connect_data, 0, sizeof(connect_data));
297 	memcpy(connect_data.hostid, hostid, sizeof(hostid));
298 	connect_data.cntlid = 0xFFFF;
299 	snprintf(connect_data.subnqn, sizeof(connect_data.subnqn), "%s", subnqn);
300 	snprintf(connect_data.hostnqn, sizeof(connect_data.hostnqn), "%s", hostnqn);
301 
302 	memset(&subsystem, 0, sizeof(subsystem));
303 	subsystem.thread = thread;
304 	subsystem.id = 1;
305 	TAILQ_INIT(&subsystem.ctrlrs);
306 	subsystem.tgt = &tgt;
307 	subsystem.subtype = SPDK_NVMF_SUBTYPE_NVME;
308 	snprintf(subsystem.subnqn, sizeof(subsystem.subnqn), "%s", subnqn);
309 
310 	memset(&cmd, 0, sizeof(cmd));
311 	cmd.connect_cmd.opcode = SPDK_NVME_OPC_FABRIC;
312 	cmd.connect_cmd.cid = 1;
313 	cmd.connect_cmd.fctype = SPDK_NVMF_FABRIC_COMMAND_CONNECT;
314 	cmd.connect_cmd.recfmt = 0;
315 	cmd.connect_cmd.qid = 0;
316 	cmd.connect_cmd.sqsize = 31;
317 	cmd.connect_cmd.cattr = 0;
318 	cmd.connect_cmd.kato = 120000;
319 
320 	memset(&req, 0, sizeof(req));
321 	req.qpair = &qpair;
322 	req.length = sizeof(connect_data);
323 	req.xfer = SPDK_NVME_DATA_HOST_TO_CONTROLLER;
324 	req.data = &connect_data;
325 	req.cmd = &cmd;
326 	req.rsp = &rsp;
327 
328 	MOCK_SET(spdk_nvmf_tgt_find_subsystem, &subsystem);
329 	MOCK_SET(spdk_nvmf_poll_group_create, &group);
330 
331 	/* Valid admin connect command */
332 	memset(&rsp, 0, sizeof(rsp));
333 	rc = spdk_nvmf_ctrlr_connect(&req);
334 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
335 	CU_ASSERT(nvme_status_success(&rsp.nvme_cpl.status));
336 	CU_ASSERT(qpair.ctrlr != NULL);
337 	spdk_bit_array_free(&qpair.ctrlr->qpair_mask);
338 	free(qpair.ctrlr);
339 	qpair.ctrlr = NULL;
340 
341 	/* Invalid data length */
342 	memset(&rsp, 0, sizeof(rsp));
343 	req.length = sizeof(connect_data) - 1;
344 	rc = spdk_nvmf_ctrlr_connect(&req);
345 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
346 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
347 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD);
348 	CU_ASSERT(qpair.ctrlr == NULL);
349 	req.length = sizeof(connect_data);
350 
351 	/* Invalid recfmt */
352 	memset(&rsp, 0, sizeof(rsp));
353 	cmd.connect_cmd.recfmt = 1234;
354 	rc = spdk_nvmf_ctrlr_connect(&req);
355 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
356 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
357 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT);
358 	CU_ASSERT(qpair.ctrlr == NULL);
359 	cmd.connect_cmd.recfmt = 0;
360 
361 	/* Unterminated subnqn */
362 	memset(&rsp, 0, sizeof(rsp));
363 	memset(connect_data.subnqn, 'a', sizeof(connect_data.subnqn));
364 	rc = spdk_nvmf_ctrlr_connect(&req);
365 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
366 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
367 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
368 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 1);
369 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 256);
370 	CU_ASSERT(qpair.ctrlr == NULL);
371 	snprintf(connect_data.subnqn, sizeof(connect_data.subnqn), "%s", subnqn);
372 
373 	/* Subsystem not found */
374 	memset(&rsp, 0, sizeof(rsp));
375 	MOCK_SET(spdk_nvmf_tgt_find_subsystem, NULL);
376 	rc = spdk_nvmf_ctrlr_connect(&req);
377 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
378 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
379 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
380 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 1);
381 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 256);
382 	CU_ASSERT(qpair.ctrlr == NULL);
383 	MOCK_SET(spdk_nvmf_tgt_find_subsystem, &subsystem);
384 
385 	/* Unterminated hostnqn */
386 	memset(&rsp, 0, sizeof(rsp));
387 	memset(connect_data.hostnqn, 'b', sizeof(connect_data.hostnqn));
388 	rc = spdk_nvmf_ctrlr_connect(&req);
389 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
390 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
391 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
392 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 1);
393 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 512);
394 	CU_ASSERT(qpair.ctrlr == NULL);
395 	snprintf(connect_data.hostnqn, sizeof(connect_data.hostnqn), "%s", hostnqn);
396 
397 	/* Host not allowed */
398 	memset(&rsp, 0, sizeof(rsp));
399 	MOCK_SET(spdk_nvmf_subsystem_host_allowed, false);
400 	rc = spdk_nvmf_ctrlr_connect(&req);
401 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
402 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
403 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_HOST);
404 	CU_ASSERT(qpair.ctrlr == NULL);
405 	MOCK_SET(spdk_nvmf_subsystem_host_allowed, true);
406 
407 	/* Invalid sqsize == 0 */
408 	memset(&rsp, 0, sizeof(rsp));
409 	cmd.connect_cmd.sqsize = 0;
410 	rc = spdk_nvmf_ctrlr_connect(&req);
411 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
412 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
413 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
414 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
415 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 44);
416 	CU_ASSERT(qpair.ctrlr == NULL);
417 	cmd.connect_cmd.sqsize = 31;
418 
419 	/* Invalid sqsize > max_queue_depth */
420 	memset(&rsp, 0, sizeof(rsp));
421 	cmd.connect_cmd.sqsize = 64;
422 	rc = spdk_nvmf_ctrlr_connect(&req);
423 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
424 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
425 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
426 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
427 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 44);
428 	CU_ASSERT(qpair.ctrlr == NULL);
429 	cmd.connect_cmd.sqsize = 31;
430 
431 	/* Invalid cntlid for admin queue */
432 	memset(&rsp, 0, sizeof(rsp));
433 	connect_data.cntlid = 0x1234;
434 	rc = spdk_nvmf_ctrlr_connect(&req);
435 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
436 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
437 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
438 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 1);
439 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 16);
440 	CU_ASSERT(qpair.ctrlr == NULL);
441 	connect_data.cntlid = 0xFFFF;
442 
443 	ctrlr.admin_qpair = &admin_qpair;
444 	ctrlr.subsys = &subsystem;
445 
446 	/* Valid I/O queue connect command */
447 	memset(&rsp, 0, sizeof(rsp));
448 	MOCK_SET(spdk_nvmf_subsystem_get_ctrlr, &ctrlr);
449 	cmd.connect_cmd.qid = 1;
450 	rc = spdk_nvmf_ctrlr_connect(&req);
451 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
452 	CU_ASSERT(nvme_status_success(&rsp.nvme_cpl.status));
453 	CU_ASSERT(qpair.ctrlr == &ctrlr);
454 	qpair.ctrlr = NULL;
455 
456 	/* Non-existent controller */
457 	memset(&rsp, 0, sizeof(rsp));
458 	MOCK_SET(spdk_nvmf_subsystem_get_ctrlr, NULL);
459 	rc = spdk_nvmf_ctrlr_connect(&req);
460 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
461 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
462 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
463 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 1);
464 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 16);
465 	CU_ASSERT(qpair.ctrlr == NULL);
466 	MOCK_SET(spdk_nvmf_subsystem_get_ctrlr, &ctrlr);
467 
468 	/* I/O connect to discovery controller */
469 	memset(&rsp, 0, sizeof(rsp));
470 	subsystem.subtype = SPDK_NVMF_SUBTYPE_DISCOVERY;
471 	rc = spdk_nvmf_ctrlr_connect(&req);
472 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
473 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
474 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
475 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
476 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 42);
477 	CU_ASSERT(qpair.ctrlr == NULL);
478 	subsystem.subtype = SPDK_NVMF_SUBTYPE_NVME;
479 
480 	/* I/O connect to disabled controller */
481 	memset(&rsp, 0, sizeof(rsp));
482 	ctrlr.vcprop.cc.bits.en = 0;
483 	rc = spdk_nvmf_ctrlr_connect(&req);
484 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
485 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
486 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
487 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
488 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 42);
489 	CU_ASSERT(qpair.ctrlr == NULL);
490 	ctrlr.vcprop.cc.bits.en = 1;
491 
492 	/* I/O connect with invalid IOSQES */
493 	memset(&rsp, 0, sizeof(rsp));
494 	ctrlr.vcprop.cc.bits.iosqes = 3;
495 	rc = spdk_nvmf_ctrlr_connect(&req);
496 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
497 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
498 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
499 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
500 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 42);
501 	CU_ASSERT(qpair.ctrlr == NULL);
502 	ctrlr.vcprop.cc.bits.iosqes = 6;
503 
504 	/* I/O connect with invalid IOCQES */
505 	memset(&rsp, 0, sizeof(rsp));
506 	ctrlr.vcprop.cc.bits.iocqes = 3;
507 	rc = spdk_nvmf_ctrlr_connect(&req);
508 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
509 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
510 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVMF_FABRIC_SC_INVALID_PARAM);
511 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.iattr == 0);
512 	CU_ASSERT(rsp.connect_rsp.status_code_specific.invalid.ipo == 42);
513 	CU_ASSERT(qpair.ctrlr == NULL);
514 	ctrlr.vcprop.cc.bits.iocqes = 4;
515 
516 	/* I/O connect with too many existing qpairs */
517 	memset(&rsp, 0, sizeof(rsp));
518 	spdk_bit_array_set(ctrlr.qpair_mask, 0);
519 	spdk_bit_array_set(ctrlr.qpair_mask, 1);
520 	spdk_bit_array_set(ctrlr.qpair_mask, 2);
521 	rc = spdk_nvmf_ctrlr_connect(&req);
522 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
523 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
524 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER);
525 	CU_ASSERT(qpair.ctrlr == NULL);
526 	spdk_bit_array_clear(ctrlr.qpair_mask, 0);
527 	spdk_bit_array_clear(ctrlr.qpair_mask, 1);
528 	spdk_bit_array_clear(ctrlr.qpair_mask, 2);
529 
530 	/* I/O connect with duplicate queue ID */
531 	memset(&rsp, 0, sizeof(rsp));
532 	memset(&qpair2, 0, sizeof(qpair2));
533 	qpair2.group = &group;
534 	qpair2.qid = 1;
535 	spdk_bit_array_set(ctrlr.qpair_mask, 1);
536 	cmd.connect_cmd.qid = 1;
537 	rc = spdk_nvmf_ctrlr_connect(&req);
538 	CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS);
539 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_COMMAND_SPECIFIC);
540 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER);
541 	CU_ASSERT(qpair.ctrlr == NULL);
542 
543 	/* Clean up globals */
544 	MOCK_CLEAR(spdk_nvmf_tgt_find_subsystem);
545 	MOCK_CLEAR(spdk_nvmf_poll_group_create);
546 
547 	spdk_bit_array_free(&ctrlr.qpair_mask);
548 	spdk_free_thread();
549 }
550 
551 static void
552 test_get_ns_id_desc_list(void)
553 {
554 	struct spdk_nvmf_subsystem subsystem;
555 	struct spdk_nvmf_qpair qpair;
556 	struct spdk_nvmf_ctrlr ctrlr;
557 	struct spdk_nvmf_request req;
558 	struct spdk_nvmf_ns *ns_ptrs[1];
559 	struct spdk_nvmf_ns ns;
560 	union nvmf_h2c_msg cmd;
561 	union nvmf_c2h_msg rsp;
562 	struct spdk_bdev bdev;
563 	uint8_t buf[4096];
564 
565 	memset(&subsystem, 0, sizeof(subsystem));
566 	ns_ptrs[0] = &ns;
567 	subsystem.ns = ns_ptrs;
568 	subsystem.max_nsid = 1;
569 	subsystem.subtype = SPDK_NVMF_SUBTYPE_NVME;
570 
571 	memset(&ns, 0, sizeof(ns));
572 	ns.opts.nsid = 1;
573 	ns.bdev = &bdev;
574 
575 	memset(&qpair, 0, sizeof(qpair));
576 	qpair.ctrlr = &ctrlr;
577 
578 	memset(&ctrlr, 0, sizeof(ctrlr));
579 	ctrlr.subsys = &subsystem;
580 	ctrlr.vcprop.cc.bits.en = 1;
581 
582 	memset(&req, 0, sizeof(req));
583 	req.qpair = &qpair;
584 	req.cmd = &cmd;
585 	req.rsp = &rsp;
586 	req.xfer = SPDK_NVME_DATA_CONTROLLER_TO_HOST;
587 	req.data = buf;
588 	req.length = sizeof(buf);
589 
590 	memset(&cmd, 0, sizeof(cmd));
591 	cmd.nvme_cmd.opc = SPDK_NVME_OPC_IDENTIFY;
592 	cmd.nvme_cmd.cdw10 = SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST;
593 
594 	/* Invalid NSID */
595 	cmd.nvme_cmd.nsid = 0;
596 	memset(&rsp, 0, sizeof(rsp));
597 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
598 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
599 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT);
600 
601 	/* Valid NSID, but ns has no IDs defined */
602 	cmd.nvme_cmd.nsid = 1;
603 	memset(&rsp, 0, sizeof(rsp));
604 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
605 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
606 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
607 	CU_ASSERT(spdk_mem_all_zero(buf, sizeof(buf)));
608 
609 	/* Valid NSID, only EUI64 defined */
610 	ns.opts.eui64[0] = 0x11;
611 	ns.opts.eui64[7] = 0xFF;
612 	memset(&rsp, 0, sizeof(rsp));
613 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
614 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
615 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
616 	CU_ASSERT(buf[0] == SPDK_NVME_NIDT_EUI64);
617 	CU_ASSERT(buf[1] == 8);
618 	CU_ASSERT(buf[4] == 0x11);
619 	CU_ASSERT(buf[11] == 0xFF);
620 	CU_ASSERT(buf[13] == 0);
621 
622 	/* Valid NSID, only NGUID defined */
623 	memset(ns.opts.eui64, 0, sizeof(ns.opts.eui64));
624 	ns.opts.nguid[0] = 0x22;
625 	ns.opts.nguid[15] = 0xEE;
626 	memset(&rsp, 0, sizeof(rsp));
627 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
628 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
629 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
630 	CU_ASSERT(buf[0] == SPDK_NVME_NIDT_NGUID);
631 	CU_ASSERT(buf[1] == 16);
632 	CU_ASSERT(buf[4] == 0x22);
633 	CU_ASSERT(buf[19] == 0xEE);
634 	CU_ASSERT(buf[21] == 0);
635 
636 	/* Valid NSID, both EUI64 and NGUID defined */
637 	ns.opts.eui64[0] = 0x11;
638 	ns.opts.eui64[7] = 0xFF;
639 	ns.opts.nguid[0] = 0x22;
640 	ns.opts.nguid[15] = 0xEE;
641 	memset(&rsp, 0, sizeof(rsp));
642 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
643 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
644 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
645 	CU_ASSERT(buf[0] == SPDK_NVME_NIDT_EUI64);
646 	CU_ASSERT(buf[1] == 8);
647 	CU_ASSERT(buf[4] == 0x11);
648 	CU_ASSERT(buf[11] == 0xFF);
649 	CU_ASSERT(buf[12] == SPDK_NVME_NIDT_NGUID);
650 	CU_ASSERT(buf[13] == 16);
651 	CU_ASSERT(buf[16] == 0x22);
652 	CU_ASSERT(buf[31] == 0xEE);
653 	CU_ASSERT(buf[33] == 0);
654 
655 	/* Valid NSID, EUI64, NGUID, and UUID defined */
656 	ns.opts.eui64[0] = 0x11;
657 	ns.opts.eui64[7] = 0xFF;
658 	ns.opts.nguid[0] = 0x22;
659 	ns.opts.nguid[15] = 0xEE;
660 	ns.opts.uuid.u.raw[0] = 0x33;
661 	ns.opts.uuid.u.raw[15] = 0xDD;
662 	memset(&rsp, 0, sizeof(rsp));
663 	CU_ASSERT(spdk_nvmf_ctrlr_process_admin_cmd(&req) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
664 	CU_ASSERT(rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC);
665 	CU_ASSERT(rsp.nvme_cpl.status.sc == SPDK_NVME_SC_SUCCESS);
666 	CU_ASSERT(buf[0] == SPDK_NVME_NIDT_EUI64);
667 	CU_ASSERT(buf[1] == 8);
668 	CU_ASSERT(buf[4] == 0x11);
669 	CU_ASSERT(buf[11] == 0xFF);
670 	CU_ASSERT(buf[12] == SPDK_NVME_NIDT_NGUID);
671 	CU_ASSERT(buf[13] == 16);
672 	CU_ASSERT(buf[16] == 0x22);
673 	CU_ASSERT(buf[31] == 0xEE);
674 	CU_ASSERT(buf[32] == SPDK_NVME_NIDT_UUID);
675 	CU_ASSERT(buf[33] == 16);
676 	CU_ASSERT(buf[36] == 0x33);
677 	CU_ASSERT(buf[51] == 0xDD);
678 	CU_ASSERT(buf[53] == 0);
679 }
680 
681 static void
682 test_identify_ns(void)
683 {
684 	struct spdk_nvmf_subsystem subsystem = {};
685 	struct spdk_nvme_cmd cmd = {};
686 	struct spdk_nvme_cpl rsp = {};
687 	struct spdk_nvme_ns_data nsdata = {};
688 	struct spdk_bdev bdev[3] = {{.blockcnt = 1234}, {.blockcnt = 0}, {.blockcnt = 5678}};
689 	struct spdk_nvmf_ns ns[3] = {{.bdev = &bdev[0]}, {.bdev = NULL}, {.bdev = &bdev[2]}};
690 	struct spdk_nvmf_ns *ns_arr[3] = {&ns[0], NULL, &ns[2]};
691 
692 	subsystem.ns = ns_arr;
693 	subsystem.max_nsid = SPDK_COUNTOF(ns_arr);
694 
695 	/* Invalid NSID 0 */
696 	cmd.nsid = 0;
697 	memset(&nsdata, 0, sizeof(nsdata));
698 	memset(&rsp, 0, sizeof(rsp));
699 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
700 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
701 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
702 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT);
703 	CU_ASSERT(spdk_mem_all_zero(&nsdata, sizeof(nsdata)));
704 
705 	/* Valid NSID 1 */
706 	cmd.nsid = 1;
707 	memset(&nsdata, 0, sizeof(nsdata));
708 	memset(&rsp, 0, sizeof(rsp));
709 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
710 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
711 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
712 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_SUCCESS);
713 	CU_ASSERT(nsdata.nsze == 1234);
714 
715 	/* Valid but inactive NSID 2 */
716 	cmd.nsid = 2;
717 	memset(&nsdata, 0, sizeof(nsdata));
718 	memset(&rsp, 0, sizeof(rsp));
719 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
720 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
721 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
722 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_SUCCESS);
723 	CU_ASSERT(spdk_mem_all_zero(&nsdata, sizeof(nsdata)));
724 
725 	/* Valid NSID 3 */
726 	cmd.nsid = 3;
727 	memset(&nsdata, 0, sizeof(nsdata));
728 	memset(&rsp, 0, sizeof(rsp));
729 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
730 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
731 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
732 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_SUCCESS);
733 	CU_ASSERT(nsdata.nsze == 5678);
734 
735 	/* Invalid NSID 4 */
736 	cmd.nsid = 4;
737 	memset(&nsdata, 0, sizeof(nsdata));
738 	memset(&rsp, 0, sizeof(rsp));
739 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
740 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
741 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
742 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT);
743 	CU_ASSERT(spdk_mem_all_zero(&nsdata, sizeof(nsdata)));
744 
745 	/* Invalid NSID 0xFFFFFFFF (NS management not supported) */
746 	cmd.nsid = 0xFFFFFFFF;
747 	memset(&nsdata, 0, sizeof(nsdata));
748 	memset(&rsp, 0, sizeof(rsp));
749 	CU_ASSERT(spdk_nvmf_ctrlr_identify_ns(&subsystem, &cmd, &rsp,
750 					      &nsdata) == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE);
751 	CU_ASSERT(rsp.status.sct == SPDK_NVME_SCT_GENERIC);
752 	CU_ASSERT(rsp.status.sc == SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT);
753 	CU_ASSERT(spdk_mem_all_zero(&nsdata, sizeof(nsdata)));
754 }
755 
756 int main(int argc, char **argv)
757 {
758 	CU_pSuite	suite = NULL;
759 	unsigned int	num_failures;
760 
761 	if (CU_initialize_registry() != CUE_SUCCESS) {
762 		return CU_get_error();
763 	}
764 
765 	suite = CU_add_suite("nvmf", NULL, NULL);
766 	if (suite == NULL) {
767 		CU_cleanup_registry();
768 		return CU_get_error();
769 	}
770 
771 	if (
772 		CU_add_test(suite, "get_log_page", test_get_log_page) == NULL ||
773 		CU_add_test(suite, "process_fabrics_cmd", test_process_fabrics_cmd) == NULL ||
774 		CU_add_test(suite, "connect", test_connect) == NULL ||
775 		CU_add_test(suite, "get_ns_id_desc_list", test_get_ns_id_desc_list) == NULL ||
776 		CU_add_test(suite, "identify_ns", test_identify_ns) == NULL
777 	) {
778 		CU_cleanup_registry();
779 		return CU_get_error();
780 	}
781 
782 	CU_basic_set_mode(CU_BRM_VERBOSE);
783 	CU_basic_run_tests();
784 	num_failures = CU_get_number_of_failures();
785 	CU_cleanup_registry();
786 	return num_failures;
787 }
788