xref: /spdk/test/unit/lib/nvmf/tcp.c/tcp_ut.c (revision 32999ab917f67af61872f868585fd3d78ad6fb8a)
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 #include "spdk/nvmf_spec.h"
36 #include "spdk_cunit.h"
37 
38 #include "spdk_internal/mock.h"
39 
40 #include "common/lib/test_env.c"
41 #include "common/lib/test_sock.c"
42 
43 #include "nvmf/ctrlr.c"
44 #include "nvmf/tcp.c"
45 
46 #define UT_IPV4_ADDR "192.168.0.1"
47 #define UT_PORT "4420"
48 #define UT_NVMF_ADRFAM_INVALID 0xf
49 #define UT_MAX_QUEUE_DEPTH 128
50 #define UT_MAX_QPAIRS_PER_CTRLR 128
51 #define UT_IN_CAPSULE_DATA_SIZE 1024
52 #define UT_MAX_IO_SIZE 4096
53 #define UT_IO_UNIT_SIZE 1024
54 #define UT_MAX_AQ_DEPTH 64
55 #define UT_SQ_HEAD_MAX 128
56 #define UT_NUM_SHARED_BUFFERS 128
57 
58 static void *g_accel_p = (void *)0xdeadbeaf;
59 
60 SPDK_LOG_REGISTER_COMPONENT(nvmf)
61 
62 DEFINE_STUB(spdk_nvmf_qpair_get_listen_trid,
63 	    int,
64 	    (struct spdk_nvmf_qpair *qpair, struct spdk_nvme_transport_id *trid),
65 	    0);
66 
67 DEFINE_STUB(nvmf_subsystem_add_ctrlr,
68 	    int,
69 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr),
70 	    0);
71 
72 DEFINE_STUB(nvmf_subsystem_get_ctrlr,
73 	    struct spdk_nvmf_ctrlr *,
74 	    (struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid),
75 	    NULL);
76 
77 DEFINE_STUB(spdk_nvmf_tgt_find_subsystem,
78 	    struct spdk_nvmf_subsystem *,
79 	    (struct spdk_nvmf_tgt *tgt, const char *subnqn),
80 	    NULL);
81 
82 DEFINE_STUB(spdk_nvmf_subsystem_listener_allowed,
83 	    bool,
84 	    (struct spdk_nvmf_subsystem *subsystem, const struct spdk_nvme_transport_id *trid),
85 	    true);
86 
87 DEFINE_STUB(nvmf_subsystem_find_listener,
88 	    struct spdk_nvmf_subsystem_listener *,
89 	    (struct spdk_nvmf_subsystem *subsystem,
90 	     const struct spdk_nvme_transport_id *trid),
91 	    (void *)0x1);
92 
93 DEFINE_STUB_V(nvmf_get_discovery_log_page,
94 	      (struct spdk_nvmf_tgt *tgt, const char *hostnqn, struct iovec *iov,
95 	       uint32_t iovcnt, uint64_t offset, uint32_t length));
96 
97 DEFINE_STUB_V(nvmf_subsystem_remove_ctrlr,
98 	      (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr));
99 
100 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns,
101 	    struct spdk_nvmf_ns *,
102 	    (struct spdk_nvmf_subsystem *subsystem),
103 	    NULL);
104 
105 DEFINE_STUB(spdk_nvmf_subsystem_get_next_ns,
106 	    struct spdk_nvmf_ns *,
107 	    (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns),
108 	    NULL);
109 
110 DEFINE_STUB(spdk_nvmf_subsystem_host_allowed,
111 	    bool,
112 	    (struct spdk_nvmf_subsystem *subsystem, const char *hostnqn),
113 	    true);
114 
115 DEFINE_STUB(nvmf_ctrlr_dsm_supported,
116 	    bool,
117 	    (struct spdk_nvmf_ctrlr *ctrlr),
118 	    false);
119 
120 DEFINE_STUB(nvmf_ctrlr_write_zeroes_supported,
121 	    bool,
122 	    (struct spdk_nvmf_ctrlr *ctrlr),
123 	    false);
124 
125 DEFINE_STUB(nvmf_bdev_ctrlr_read_cmd,
126 	    int,
127 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
128 	     struct spdk_nvmf_request *req),
129 	    0);
130 
131 DEFINE_STUB(nvmf_bdev_ctrlr_write_cmd,
132 	    int,
133 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
134 	     struct spdk_nvmf_request *req),
135 	    0);
136 
137 DEFINE_STUB(nvmf_bdev_ctrlr_compare_cmd,
138 	    int,
139 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
140 	     struct spdk_nvmf_request *req),
141 	    0);
142 
143 DEFINE_STUB(nvmf_bdev_ctrlr_compare_and_write_cmd,
144 	    int,
145 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
146 	     struct spdk_nvmf_request *cmp_req, struct spdk_nvmf_request *write_req),
147 	    0);
148 
149 DEFINE_STUB(nvmf_bdev_ctrlr_write_zeroes_cmd,
150 	    int,
151 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
152 	     struct spdk_nvmf_request *req),
153 	    0);
154 
155 DEFINE_STUB(nvmf_bdev_ctrlr_flush_cmd,
156 	    int,
157 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
158 	     struct spdk_nvmf_request *req),
159 	    0);
160 
161 DEFINE_STUB(nvmf_bdev_ctrlr_dsm_cmd,
162 	    int,
163 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
164 	     struct spdk_nvmf_request *req),
165 	    0);
166 
167 DEFINE_STUB(nvmf_bdev_ctrlr_nvme_passthru_io,
168 	    int,
169 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
170 	     struct spdk_nvmf_request *req),
171 	    0);
172 
173 DEFINE_STUB(spdk_nvmf_bdev_ctrlr_abort_cmd,
174 	    int,
175 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
176 	     struct spdk_nvmf_request *req, struct spdk_nvmf_request *req_to_abort),
177 	    0);
178 
179 DEFINE_STUB(nvmf_bdev_ctrlr_get_dif_ctx,
180 	    bool,
181 	    (struct spdk_bdev *bdev, struct spdk_nvme_cmd *cmd, struct spdk_dif_ctx *dif_ctx),
182 	    false);
183 
184 DEFINE_STUB(nvmf_transport_req_complete,
185 	    int,
186 	    (struct spdk_nvmf_request *req),
187 	    0);
188 
189 DEFINE_STUB_V(spdk_nvmf_request_free_buffers,
190 	      (struct spdk_nvmf_request *req, struct spdk_nvmf_transport_poll_group *group,
191 	       struct spdk_nvmf_transport *transport));
192 
193 DEFINE_STUB(spdk_sock_get_optimal_sock_group,
194 	    int,
195 	    (struct spdk_sock *sock, struct spdk_sock_group **group),
196 	    0);
197 
198 DEFINE_STUB(spdk_sock_group_get_ctx,
199 	    void *,
200 	    (struct spdk_sock_group *group),
201 	    NULL);
202 
203 DEFINE_STUB(spdk_sock_set_priority,
204 	    int,
205 	    (struct spdk_sock *sock, int priority),
206 	    0);
207 
208 DEFINE_STUB_V(nvmf_ns_reservation_request, (void *ctx));
209 
210 DEFINE_STUB_V(spdk_nvme_trid_populate_transport, (struct spdk_nvme_transport_id *trid,
211 		enum spdk_nvme_transport_type trtype));
212 DEFINE_STUB_V(spdk_nvmf_transport_register, (const struct spdk_nvmf_transport_ops *ops));
213 
214 DEFINE_STUB_V(spdk_nvmf_tgt_new_qpair, (struct spdk_nvmf_tgt *tgt, struct spdk_nvmf_qpair *qpair));
215 
216 DEFINE_STUB_V(nvmf_transport_qpair_abort_request,
217 	      (struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_request *req));
218 
219 DEFINE_STUB_V(spdk_nvme_print_command, (uint16_t qid, struct spdk_nvme_cmd *cmd));
220 DEFINE_STUB_V(spdk_nvme_print_completion, (uint16_t qid, struct spdk_nvme_cpl *cpl));
221 
222 DEFINE_STUB(nvmf_transport_req_free,
223 	    int,
224 	    (struct spdk_nvmf_request *req),
225 	    0);
226 
227 DEFINE_STUB(accel_engine_create_cb, int, (void *io_device, void *ctx_buf), 0);
228 DEFINE_STUB_V(accel_engine_destroy_cb, (void *io_device, void *ctx_buf));
229 
230 struct spdk_io_channel *
231 spdk_accel_engine_get_io_channel(void)
232 {
233 	return spdk_get_io_channel(g_accel_p);
234 }
235 
236 DEFINE_STUB(spdk_accel_submit_crc32cv,
237 	    int,
238 	    (struct spdk_io_channel *ch, uint32_t *dst, struct iovec *iovs,
239 	     uint32_t iovcnt, uint32_t seed, spdk_accel_completion_cb cb_fn, void *cb_arg),
240 	    0);
241 
242 DEFINE_STUB(spdk_nvmf_bdev_ctrlr_nvme_passthru_admin,
243 	    int,
244 	    (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
245 	     struct spdk_io_channel *ch, struct spdk_nvmf_request *req,
246 	     spdk_nvmf_nvme_passthru_cmd_cb cb_fn),
247 	    0)
248 
249 struct spdk_trace_histories *g_trace_histories;
250 
251 struct spdk_bdev {
252 	int ut_mock;
253 	uint64_t blockcnt;
254 };
255 
256 int
257 spdk_nvme_transport_id_compare(const struct spdk_nvme_transport_id *trid1,
258 			       const struct spdk_nvme_transport_id *trid2)
259 {
260 	return 0;
261 }
262 
263 void
264 spdk_trace_register_object(uint8_t type, char id_prefix)
265 {
266 }
267 
268 void
269 spdk_trace_register_description(const char *name,
270 				uint16_t tpoint_id, uint8_t owner_type,
271 				uint8_t object_type, uint8_t new_object,
272 				uint8_t arg1_type, const char *arg1_name)
273 {
274 }
275 
276 void
277 _spdk_trace_record(uint64_t tsc, uint16_t tpoint_id, uint16_t poller_id,
278 		   uint32_t size, uint64_t object_id, uint64_t arg1)
279 {
280 }
281 
282 const char *
283 spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trtype)
284 {
285 	switch (trtype) {
286 	case SPDK_NVME_TRANSPORT_PCIE:
287 		return "PCIe";
288 	case SPDK_NVME_TRANSPORT_RDMA:
289 		return "RDMA";
290 	case SPDK_NVME_TRANSPORT_FC:
291 		return "FC";
292 	default:
293 		return NULL;
294 	}
295 }
296 
297 int
298 spdk_nvme_transport_id_populate_trstring(struct spdk_nvme_transport_id *trid, const char *trstring)
299 {
300 	int len, i;
301 
302 	if (trstring == NULL) {
303 		return -EINVAL;
304 	}
305 
306 	len = strnlen(trstring, SPDK_NVMF_TRSTRING_MAX_LEN);
307 	if (len == SPDK_NVMF_TRSTRING_MAX_LEN) {
308 		return -EINVAL;
309 	}
310 
311 	/* cast official trstring to uppercase version of input. */
312 	for (i = 0; i < len; i++) {
313 		trid->trstring[i] = toupper(trstring[i]);
314 	}
315 	return 0;
316 }
317 
318 int
319 spdk_nvmf_qpair_disconnect(struct spdk_nvmf_qpair *qpair, nvmf_qpair_disconnect_cb cb_fn, void *ctx)
320 {
321 	return 0;
322 }
323 
324 int
325 spdk_nvmf_request_get_buffers(struct spdk_nvmf_request *req,
326 			      struct spdk_nvmf_transport_poll_group *group,
327 			      struct spdk_nvmf_transport *transport,
328 			      uint32_t length)
329 {
330 	/* length more than 1 io unit length will fail. */
331 	if (length >= transport->opts.io_unit_size) {
332 		return -EINVAL;
333 	}
334 
335 	req->iovcnt = 1;
336 	req->iov[0].iov_base = (void *)0xDEADBEEF;
337 
338 	return 0;
339 }
340 
341 
342 void
343 nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata,
344 			    bool dif_insert_or_strip)
345 {
346 	uint64_t num_blocks;
347 
348 	SPDK_CU_ASSERT_FATAL(ns->bdev != NULL);
349 	num_blocks = ns->bdev->blockcnt;
350 	nsdata->nsze = num_blocks;
351 	nsdata->ncap = num_blocks;
352 	nsdata->nuse = num_blocks;
353 	nsdata->nlbaf = 0;
354 	nsdata->flbas.format = 0;
355 	nsdata->lbaf[0].lbads = spdk_u32log2(512);
356 }
357 
358 const char *
359 spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem)
360 {
361 	return subsystem->sn;
362 }
363 
364 const char *
365 spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem)
366 {
367 	return subsystem->mn;
368 }
369 
370 void
371 spdk_trace_add_register_fn(struct spdk_trace_register_fn *reg_fn)
372 {
373 }
374 
375 static void
376 test_nvmf_tcp_create(void)
377 {
378 	struct spdk_thread *thread;
379 	struct spdk_nvmf_transport *transport;
380 	struct spdk_nvmf_tcp_transport *ttransport;
381 	struct spdk_nvmf_transport_opts opts;
382 
383 	thread = spdk_thread_create(NULL, NULL);
384 	SPDK_CU_ASSERT_FATAL(thread != NULL);
385 	spdk_set_thread(thread);
386 
387 	/* case 1 */
388 	memset(&opts, 0, sizeof(opts));
389 	opts.max_queue_depth = UT_MAX_QUEUE_DEPTH;
390 	opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR;
391 	opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE;
392 	opts.max_io_size = UT_MAX_IO_SIZE;
393 	opts.io_unit_size = UT_IO_UNIT_SIZE;
394 	opts.max_aq_depth = UT_MAX_AQ_DEPTH;
395 	opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS;
396 	/* expect success */
397 	transport = nvmf_tcp_create(&opts);
398 	CU_ASSERT_PTR_NOT_NULL(transport);
399 	ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport);
400 	SPDK_CU_ASSERT_FATAL(ttransport != NULL);
401 	transport->opts = opts;
402 	CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH);
403 	CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE);
404 	CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE);
405 	CU_ASSERT(transport->opts.io_unit_size == UT_IO_UNIT_SIZE);
406 	/* destroy transport */
407 	spdk_mempool_free(ttransport->transport.data_buf_pool);
408 	free(ttransport);
409 
410 	/* case 2 */
411 	memset(&opts, 0, sizeof(opts));
412 	opts.max_queue_depth = UT_MAX_QUEUE_DEPTH;
413 	opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR;
414 	opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE;
415 	opts.max_io_size = UT_MAX_IO_SIZE;
416 	opts.io_unit_size = UT_MAX_IO_SIZE + 1;
417 	opts.max_aq_depth = UT_MAX_AQ_DEPTH;
418 	opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS;
419 	/* expect success */
420 	transport = nvmf_tcp_create(&opts);
421 	CU_ASSERT_PTR_NOT_NULL(transport);
422 	ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport);
423 	SPDK_CU_ASSERT_FATAL(ttransport != NULL);
424 	transport->opts = opts;
425 	CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH);
426 	CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE);
427 	CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE);
428 	CU_ASSERT(transport->opts.io_unit_size == UT_MAX_IO_SIZE);
429 	/* destroy transport */
430 	spdk_mempool_free(ttransport->transport.data_buf_pool);
431 	free(ttransport);
432 
433 	/* case 3 */
434 	memset(&opts, 0, sizeof(opts));
435 	opts.max_queue_depth = UT_MAX_QUEUE_DEPTH;
436 	opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR;
437 	opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE;
438 	opts.max_io_size = UT_MAX_IO_SIZE;
439 	opts.io_unit_size = 16;
440 	opts.max_aq_depth = UT_MAX_AQ_DEPTH;
441 	/* expect failse */
442 	transport = nvmf_tcp_create(&opts);
443 	CU_ASSERT_PTR_NULL(transport);
444 
445 	spdk_thread_exit(thread);
446 	while (!spdk_thread_is_exited(thread)) {
447 		spdk_thread_poll(thread, 0, 0);
448 	}
449 	spdk_thread_destroy(thread);
450 }
451 
452 static void
453 test_nvmf_tcp_destroy(void)
454 {
455 	struct spdk_thread *thread;
456 	struct spdk_nvmf_transport *transport;
457 	struct spdk_nvmf_transport_opts opts;
458 
459 	thread = spdk_thread_create(NULL, NULL);
460 	SPDK_CU_ASSERT_FATAL(thread != NULL);
461 	spdk_set_thread(thread);
462 
463 	/* case 1 */
464 	memset(&opts, 0, sizeof(opts));
465 	opts.max_queue_depth = UT_MAX_QUEUE_DEPTH;
466 	opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR;
467 	opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE;
468 	opts.max_io_size = UT_MAX_IO_SIZE;
469 	opts.io_unit_size = UT_IO_UNIT_SIZE;
470 	opts.max_aq_depth = UT_MAX_AQ_DEPTH;
471 	opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS;
472 	transport = nvmf_tcp_create(&opts);
473 	CU_ASSERT_PTR_NOT_NULL(transport);
474 	transport->opts = opts;
475 	/* destroy transport */
476 	CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0);
477 
478 	spdk_thread_exit(thread);
479 	while (!spdk_thread_is_exited(thread)) {
480 		spdk_thread_poll(thread, 0, 0);
481 	}
482 	spdk_thread_destroy(thread);
483 }
484 
485 static void
486 init_accel(void)
487 {
488 	spdk_io_device_register(g_accel_p, accel_engine_create_cb, accel_engine_destroy_cb,
489 				sizeof(int), "accel_p");
490 }
491 
492 static void
493 fini_accel(void)
494 {
495 	spdk_io_device_unregister(g_accel_p, NULL);
496 }
497 
498 static void
499 test_nvmf_tcp_poll_group_create(void)
500 {
501 	struct spdk_nvmf_transport *transport;
502 	struct spdk_nvmf_transport_poll_group *group;
503 	struct spdk_nvmf_tcp_poll_group *tgroup;
504 	struct spdk_thread *thread;
505 	struct spdk_nvmf_transport_opts opts;
506 	struct spdk_sock_group grp = {};
507 
508 	thread = spdk_thread_create(NULL, NULL);
509 	SPDK_CU_ASSERT_FATAL(thread != NULL);
510 	spdk_set_thread(thread);
511 
512 	init_accel();
513 
514 	memset(&opts, 0, sizeof(opts));
515 	opts.max_queue_depth = UT_MAX_QUEUE_DEPTH;
516 	opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR;
517 	opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE;
518 	opts.max_io_size = UT_MAX_IO_SIZE;
519 	opts.io_unit_size = UT_IO_UNIT_SIZE;
520 	opts.max_aq_depth = UT_MAX_AQ_DEPTH;
521 	opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS;
522 	transport = nvmf_tcp_create(&opts);
523 	CU_ASSERT_PTR_NOT_NULL(transport);
524 	transport->opts = opts;
525 	MOCK_SET(spdk_sock_group_create, &grp);
526 	group = nvmf_tcp_poll_group_create(transport);
527 	MOCK_CLEAR_P(spdk_sock_group_create);
528 	SPDK_CU_ASSERT_FATAL(group);
529 	if (opts.in_capsule_data_size < SPDK_NVME_TCP_IN_CAPSULE_DATA_MAX_SIZE) {
530 		tgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_tcp_poll_group, group);
531 		SPDK_CU_ASSERT_FATAL(tgroup->control_msg_list);
532 	}
533 	group->transport = transport;
534 	nvmf_tcp_poll_group_destroy(group);
535 	nvmf_tcp_destroy(transport, NULL, NULL);
536 
537 	fini_accel();
538 	spdk_thread_exit(thread);
539 	while (!spdk_thread_is_exited(thread)) {
540 		spdk_thread_poll(thread, 0, 0);
541 	}
542 	spdk_thread_destroy(thread);
543 }
544 
545 static void
546 test_nvmf_tcp_send_c2h_data(void)
547 {
548 	struct spdk_thread *thread;
549 	struct spdk_nvmf_tcp_transport ttransport = {};
550 	struct spdk_nvmf_tcp_qpair tqpair = {};
551 	struct spdk_nvmf_tcp_req tcp_req = {};
552 	struct nvme_tcp_pdu pdu = {};
553 	struct spdk_nvme_tcp_c2h_data_hdr *c2h_data;
554 
555 	ttransport.tcp_opts.c2h_success = true;
556 	thread = spdk_thread_create(NULL, NULL);
557 	SPDK_CU_ASSERT_FATAL(thread != NULL);
558 	spdk_set_thread(thread);
559 
560 	tcp_req.pdu = &pdu;
561 	tcp_req.req.length = 300;
562 	tcp_req.req.qpair = &tqpair.qpair;
563 
564 	tqpair.qpair.transport = &ttransport.transport;
565 
566 	/* Set qpair state to make unrelated operations NOP */
567 	tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING;
568 	tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR;
569 
570 	tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd;
571 
572 	tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF;
573 	tcp_req.req.iov[0].iov_len = 101;
574 	tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF;
575 	tcp_req.req.iov[1].iov_len = 100;
576 	tcp_req.req.iov[2].iov_base = (void *)0xC0FFEE;
577 	tcp_req.req.iov[2].iov_len = 99;
578 	tcp_req.req.iovcnt = 3;
579 	tcp_req.req.length = 300;
580 
581 	nvmf_tcp_send_c2h_data(&tqpair, &tcp_req);
582 
583 	c2h_data = &pdu.hdr.c2h_data;
584 	CU_ASSERT(c2h_data->datao == 0);
585 	CU_ASSERT(c2h_data->datal = 300);
586 	CU_ASSERT(c2h_data->common.plen == sizeof(*c2h_data) + 300);
587 	CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU);
588 	CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS);
589 
590 	CU_ASSERT(pdu.data_iovcnt == 3);
591 	CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF);
592 	CU_ASSERT(pdu.data_iov[0].iov_len == 101);
593 	CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF);
594 	CU_ASSERT(pdu.data_iov[1].iov_len == 100);
595 	CU_ASSERT((uint64_t)pdu.data_iov[2].iov_base == 0xC0FFEE);
596 	CU_ASSERT(pdu.data_iov[2].iov_len == 99);
597 
598 	tcp_req.pdu_in_use = false;
599 	tcp_req.rsp.cdw0 = 1;
600 	nvmf_tcp_send_c2h_data(&tqpair, &tcp_req);
601 
602 	CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU);
603 	CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0);
604 
605 	ttransport.tcp_opts.c2h_success = false;
606 	tcp_req.pdu_in_use = false;
607 	tcp_req.rsp.cdw0 = 0;
608 	nvmf_tcp_send_c2h_data(&tqpair, &tcp_req);
609 
610 	CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU);
611 	CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0);
612 
613 	tcp_req.pdu_in_use = false;
614 	tcp_req.rsp.cdw0 = 1;
615 	nvmf_tcp_send_c2h_data(&tqpair, &tcp_req);
616 
617 	CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU);
618 	CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0);
619 
620 	spdk_thread_exit(thread);
621 	while (!spdk_thread_is_exited(thread)) {
622 		spdk_thread_poll(thread, 0, 0);
623 	}
624 	spdk_thread_destroy(thread);
625 }
626 
627 #define NVMF_TCP_PDU_MAX_H2C_DATA_SIZE (128 * 1024)
628 
629 static void
630 test_nvmf_tcp_h2c_data_hdr_handle(void)
631 {
632 	struct spdk_nvmf_tcp_transport ttransport = {};
633 	struct spdk_nvmf_tcp_qpair tqpair = {};
634 	struct nvme_tcp_pdu pdu = {};
635 	struct spdk_nvmf_tcp_req tcp_req = {};
636 	struct spdk_nvme_tcp_h2c_data_hdr *h2c_data;
637 
638 	TAILQ_INIT(&tqpair.tcp_req_working_queue);
639 
640 	/* Set qpair state to make unrelated operations NOP */
641 	tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING;
642 	tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR;
643 
644 	tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF;
645 	tcp_req.req.iov[0].iov_len = 101;
646 	tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF;
647 	tcp_req.req.iov[1].iov_len = 99;
648 	tcp_req.req.iovcnt = 2;
649 	tcp_req.req.length = 200;
650 	tcp_req.state = TCP_REQUEST_STATE_TRANSFERRING_HOST_TO_CONTROLLER;
651 
652 	tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd;
653 	tcp_req.req.cmd->nvme_cmd.cid = 1;
654 	tcp_req.ttag = 2;
655 
656 	TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue,
657 			  &tcp_req, state_link);
658 
659 	h2c_data = &pdu.hdr.h2c_data;
660 	h2c_data->cccid = 1;
661 	h2c_data->ttag = 2;
662 	h2c_data->datao = 0;
663 	h2c_data->datal = 200;
664 
665 	nvmf_tcp_h2c_data_hdr_handle(&ttransport, &tqpair, &pdu);
666 
667 	CU_ASSERT(pdu.data_iovcnt == 2);
668 	CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF);
669 	CU_ASSERT(pdu.data_iov[0].iov_len == 101);
670 	CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF);
671 	CU_ASSERT(pdu.data_iov[1].iov_len == 99);
672 
673 	CU_ASSERT(TAILQ_FIRST(&tqpair.tcp_req_working_queue) ==
674 		  &tcp_req);
675 	TAILQ_REMOVE(&tqpair.tcp_req_working_queue,
676 		     &tcp_req, state_link);
677 }
678 
679 
680 static void
681 test_nvmf_tcp_incapsule_data_handle(void)
682 {
683 	struct spdk_nvmf_tcp_transport ttransport = {};
684 	struct spdk_nvmf_tcp_qpair tqpair = {};
685 	struct nvme_tcp_pdu *pdu;
686 	union nvmf_c2h_msg rsp0 = {};
687 	union nvmf_c2h_msg rsp = {};
688 
689 	struct spdk_nvmf_request *req_temp = NULL;
690 	struct spdk_nvmf_tcp_req tcp_req2 = {};
691 	struct spdk_nvmf_tcp_req tcp_req1 = {};
692 
693 	struct spdk_nvme_tcp_cmd *capsule_data;
694 	struct spdk_nvmf_capsule_cmd *nvmf_capsule_data;
695 	struct spdk_nvme_sgl_descriptor *sgl;
696 
697 	struct spdk_nvmf_transport_poll_group *group;
698 	struct spdk_nvmf_tcp_poll_group tcp_group = {};
699 	struct spdk_sock_group grp = {};
700 
701 	ttransport.transport.opts.max_io_size = UT_MAX_IO_SIZE;
702 	ttransport.transport.opts.io_unit_size = UT_IO_UNIT_SIZE;
703 
704 	tcp_group.sock_group = &grp;
705 	TAILQ_INIT(&tcp_group.qpairs);
706 	group = &tcp_group.group;
707 	group->transport = &ttransport.transport;
708 	STAILQ_INIT(&group->pending_buf_queue);
709 	tqpair.group = &tcp_group;
710 
711 	TAILQ_INIT(&tqpair.tcp_req_free_queue);
712 	TAILQ_INIT(&tqpair.tcp_req_working_queue);
713 
714 	TAILQ_INSERT_TAIL(&tqpair.tcp_req_free_queue, &tcp_req2, state_link);
715 	tqpair.state_cntr[TCP_REQUEST_STATE_FREE]++;
716 	tqpair.qpair.transport = &ttransport.transport;
717 	tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING;
718 	tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH;
719 	tqpair.qpair.state = SPDK_NVMF_QPAIR_ACTIVE;
720 
721 	/* init a null tcp_req into tqpair TCP_REQUEST_STATE_FREE queue */
722 	tcp_req2.req.qpair = &tqpair.qpair;
723 	tcp_req2.req.cmd = (union nvmf_h2c_msg *)&tcp_req2.cmd;
724 	tcp_req2.req.rsp = &rsp;
725 
726 	/* init tcp_req1 */
727 	tcp_req1.req.qpair = &tqpair.qpair;
728 	tcp_req1.req.cmd = (union nvmf_h2c_msg *)&tcp_req1.cmd;
729 	tcp_req1.req.rsp = &rsp0;
730 	tcp_req1.state = TCP_REQUEST_STATE_NEW;
731 
732 	TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, &tcp_req1, state_link);
733 	tqpair.state_cntr[TCP_REQUEST_STATE_NEW]++;
734 
735 	/* init pdu, make pdu need sgl buff */
736 	pdu = &tqpair.pdu_in_progress;
737 	capsule_data = &pdu->hdr.capsule_cmd;
738 	nvmf_capsule_data = (struct spdk_nvmf_capsule_cmd *)&pdu->hdr.capsule_cmd.ccsqe;
739 	sgl = &capsule_data->ccsqe.dptr.sgl1;
740 
741 	capsule_data->common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD;
742 	capsule_data->common.hlen = sizeof(*capsule_data);
743 	capsule_data->common.plen = 1096;
744 	capsule_data->ccsqe.opc = SPDK_NVME_OPC_FABRIC;
745 
746 	sgl->unkeyed.subtype = SPDK_NVME_SGL_SUBTYPE_TRANSPORT;
747 	sgl->generic.type = SPDK_NVME_SGL_TYPE_TRANSPORT_DATA_BLOCK;
748 	sgl->unkeyed.length = UT_IO_UNIT_SIZE;
749 
750 	nvmf_capsule_data->fctype = SPDK_NVMF_FABRIC_COMMAND_CONNECT;
751 
752 	/* insert tcp_req1 to pending_buf_queue, And this req takes precedence over the next req. */
753 	nvmf_tcp_req_process(&ttransport, &tcp_req1);
754 	CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req);
755 
756 	sgl->unkeyed.length = UT_IO_UNIT_SIZE - 1;
757 
758 	/* process tqpair capsule req. but we still remain req in pending_buff. */
759 	nvmf_tcp_capsule_cmd_hdr_handle(&ttransport, &tqpair, &tqpair.pdu_in_progress);
760 	CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PAYLOAD);
761 	CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req);
762 	STAILQ_FOREACH(req_temp, &group->pending_buf_queue, buf_link) {
763 		if (req_temp == &tcp_req2.req) {
764 			break;
765 		}
766 	}
767 	CU_ASSERT(req_temp == NULL);
768 	CU_ASSERT(tqpair.pdu_in_progress.req == (void *)&tcp_req2);
769 }
770 
771 int main(int argc, char **argv)
772 {
773 	CU_pSuite	suite = NULL;
774 	unsigned int	num_failures;
775 
776 	CU_set_error_action(CUEA_ABORT);
777 	CU_initialize_registry();
778 
779 	suite = CU_add_suite("nvmf", NULL, NULL);
780 
781 	CU_ADD_TEST(suite, test_nvmf_tcp_create);
782 	CU_ADD_TEST(suite, test_nvmf_tcp_destroy);
783 	CU_ADD_TEST(suite, test_nvmf_tcp_poll_group_create);
784 	CU_ADD_TEST(suite, test_nvmf_tcp_send_c2h_data);
785 	CU_ADD_TEST(suite, test_nvmf_tcp_h2c_data_hdr_handle);
786 	CU_ADD_TEST(suite, test_nvmf_tcp_incapsule_data_handle);
787 
788 	CU_basic_set_mode(CU_BRM_VERBOSE);
789 	CU_basic_run_tests();
790 	num_failures = CU_get_number_of_failures();
791 	CU_cleanup_registry();
792 	return num_failures;
793 }
794