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_bdev { 250 int ut_mock; 251 uint64_t blockcnt; 252 }; 253 254 int 255 spdk_nvme_transport_id_compare(const struct spdk_nvme_transport_id *trid1, 256 const struct spdk_nvme_transport_id *trid2) 257 { 258 return 0; 259 } 260 261 const char * 262 spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trtype) 263 { 264 switch (trtype) { 265 case SPDK_NVME_TRANSPORT_PCIE: 266 return "PCIe"; 267 case SPDK_NVME_TRANSPORT_RDMA: 268 return "RDMA"; 269 case SPDK_NVME_TRANSPORT_FC: 270 return "FC"; 271 default: 272 return NULL; 273 } 274 } 275 276 int 277 spdk_nvme_transport_id_populate_trstring(struct spdk_nvme_transport_id *trid, const char *trstring) 278 { 279 int len, i; 280 281 if (trstring == NULL) { 282 return -EINVAL; 283 } 284 285 len = strnlen(trstring, SPDK_NVMF_TRSTRING_MAX_LEN); 286 if (len == SPDK_NVMF_TRSTRING_MAX_LEN) { 287 return -EINVAL; 288 } 289 290 /* cast official trstring to uppercase version of input. */ 291 for (i = 0; i < len; i++) { 292 trid->trstring[i] = toupper(trstring[i]); 293 } 294 return 0; 295 } 296 297 int 298 spdk_nvmf_qpair_disconnect(struct spdk_nvmf_qpair *qpair, nvmf_qpair_disconnect_cb cb_fn, void *ctx) 299 { 300 return 0; 301 } 302 303 int 304 spdk_nvmf_request_get_buffers(struct spdk_nvmf_request *req, 305 struct spdk_nvmf_transport_poll_group *group, 306 struct spdk_nvmf_transport *transport, 307 uint32_t length) 308 { 309 /* length more than 1 io unit length will fail. */ 310 if (length >= transport->opts.io_unit_size) { 311 return -EINVAL; 312 } 313 314 req->iovcnt = 1; 315 req->iov[0].iov_base = (void *)0xDEADBEEF; 316 317 return 0; 318 } 319 320 321 void 322 nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata, 323 bool dif_insert_or_strip) 324 { 325 uint64_t num_blocks; 326 327 SPDK_CU_ASSERT_FATAL(ns->bdev != NULL); 328 num_blocks = ns->bdev->blockcnt; 329 nsdata->nsze = num_blocks; 330 nsdata->ncap = num_blocks; 331 nsdata->nuse = num_blocks; 332 nsdata->nlbaf = 0; 333 nsdata->flbas.format = 0; 334 nsdata->lbaf[0].lbads = spdk_u32log2(512); 335 } 336 337 const char * 338 spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem) 339 { 340 return subsystem->sn; 341 } 342 343 const char * 344 spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem) 345 { 346 return subsystem->mn; 347 } 348 349 static void 350 test_nvmf_tcp_create(void) 351 { 352 struct spdk_thread *thread; 353 struct spdk_nvmf_transport *transport; 354 struct spdk_nvmf_tcp_transport *ttransport; 355 struct spdk_nvmf_transport_opts opts; 356 357 thread = spdk_thread_create(NULL, NULL); 358 SPDK_CU_ASSERT_FATAL(thread != NULL); 359 spdk_set_thread(thread); 360 361 /* case 1 */ 362 memset(&opts, 0, sizeof(opts)); 363 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 364 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 365 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 366 opts.max_io_size = UT_MAX_IO_SIZE; 367 opts.io_unit_size = UT_IO_UNIT_SIZE; 368 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 369 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 370 /* expect success */ 371 transport = nvmf_tcp_create(&opts); 372 CU_ASSERT_PTR_NOT_NULL(transport); 373 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 374 SPDK_CU_ASSERT_FATAL(ttransport != NULL); 375 transport->opts = opts; 376 CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH); 377 CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE); 378 CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE); 379 CU_ASSERT(transport->opts.io_unit_size == UT_IO_UNIT_SIZE); 380 /* destroy transport */ 381 spdk_mempool_free(ttransport->transport.data_buf_pool); 382 free(ttransport); 383 384 /* case 2 */ 385 memset(&opts, 0, sizeof(opts)); 386 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 387 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 388 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 389 opts.max_io_size = UT_MAX_IO_SIZE; 390 opts.io_unit_size = UT_MAX_IO_SIZE + 1; 391 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 392 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 393 /* expect success */ 394 transport = nvmf_tcp_create(&opts); 395 CU_ASSERT_PTR_NOT_NULL(transport); 396 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 397 SPDK_CU_ASSERT_FATAL(ttransport != NULL); 398 transport->opts = opts; 399 CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH); 400 CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE); 401 CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE); 402 CU_ASSERT(transport->opts.io_unit_size == UT_MAX_IO_SIZE); 403 /* destroy transport */ 404 spdk_mempool_free(ttransport->transport.data_buf_pool); 405 free(ttransport); 406 407 /* case 3 */ 408 memset(&opts, 0, sizeof(opts)); 409 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 410 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 411 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 412 opts.max_io_size = UT_MAX_IO_SIZE; 413 opts.io_unit_size = 16; 414 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 415 /* expect failse */ 416 transport = nvmf_tcp_create(&opts); 417 CU_ASSERT_PTR_NULL(transport); 418 419 spdk_thread_exit(thread); 420 while (!spdk_thread_is_exited(thread)) { 421 spdk_thread_poll(thread, 0, 0); 422 } 423 spdk_thread_destroy(thread); 424 } 425 426 static void 427 test_nvmf_tcp_destroy(void) 428 { 429 struct spdk_thread *thread; 430 struct spdk_nvmf_transport *transport; 431 struct spdk_nvmf_transport_opts opts; 432 433 thread = spdk_thread_create(NULL, NULL); 434 SPDK_CU_ASSERT_FATAL(thread != NULL); 435 spdk_set_thread(thread); 436 437 /* case 1 */ 438 memset(&opts, 0, sizeof(opts)); 439 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 440 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 441 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 442 opts.max_io_size = UT_MAX_IO_SIZE; 443 opts.io_unit_size = UT_IO_UNIT_SIZE; 444 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 445 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 446 transport = nvmf_tcp_create(&opts); 447 CU_ASSERT_PTR_NOT_NULL(transport); 448 transport->opts = opts; 449 /* destroy transport */ 450 CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0); 451 452 spdk_thread_exit(thread); 453 while (!spdk_thread_is_exited(thread)) { 454 spdk_thread_poll(thread, 0, 0); 455 } 456 spdk_thread_destroy(thread); 457 } 458 459 static void 460 init_accel(void) 461 { 462 spdk_io_device_register(g_accel_p, accel_engine_create_cb, accel_engine_destroy_cb, 463 sizeof(int), "accel_p"); 464 } 465 466 static void 467 fini_accel(void) 468 { 469 spdk_io_device_unregister(g_accel_p, NULL); 470 } 471 472 static void 473 test_nvmf_tcp_poll_group_create(void) 474 { 475 struct spdk_nvmf_transport *transport; 476 struct spdk_nvmf_transport_poll_group *group; 477 struct spdk_nvmf_tcp_poll_group *tgroup; 478 struct spdk_thread *thread; 479 struct spdk_nvmf_transport_opts opts; 480 struct spdk_sock_group grp = {}; 481 482 thread = spdk_thread_create(NULL, NULL); 483 SPDK_CU_ASSERT_FATAL(thread != NULL); 484 spdk_set_thread(thread); 485 486 init_accel(); 487 488 memset(&opts, 0, sizeof(opts)); 489 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 490 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 491 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 492 opts.max_io_size = UT_MAX_IO_SIZE; 493 opts.io_unit_size = UT_IO_UNIT_SIZE; 494 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 495 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 496 transport = nvmf_tcp_create(&opts); 497 CU_ASSERT_PTR_NOT_NULL(transport); 498 transport->opts = opts; 499 MOCK_SET(spdk_sock_group_create, &grp); 500 group = nvmf_tcp_poll_group_create(transport); 501 MOCK_CLEAR_P(spdk_sock_group_create); 502 SPDK_CU_ASSERT_FATAL(group); 503 if (opts.in_capsule_data_size < SPDK_NVME_TCP_IN_CAPSULE_DATA_MAX_SIZE) { 504 tgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_tcp_poll_group, group); 505 SPDK_CU_ASSERT_FATAL(tgroup->control_msg_list); 506 } 507 group->transport = transport; 508 nvmf_tcp_poll_group_destroy(group); 509 nvmf_tcp_destroy(transport, NULL, NULL); 510 511 fini_accel(); 512 spdk_thread_exit(thread); 513 while (!spdk_thread_is_exited(thread)) { 514 spdk_thread_poll(thread, 0, 0); 515 } 516 spdk_thread_destroy(thread); 517 } 518 519 static void 520 test_nvmf_tcp_send_c2h_data(void) 521 { 522 struct spdk_thread *thread; 523 struct spdk_nvmf_tcp_transport ttransport = {}; 524 struct spdk_nvmf_tcp_qpair tqpair = {}; 525 struct spdk_nvmf_tcp_req tcp_req = {}; 526 struct nvme_tcp_pdu pdu = {}; 527 struct spdk_nvme_tcp_c2h_data_hdr *c2h_data; 528 529 ttransport.tcp_opts.c2h_success = true; 530 thread = spdk_thread_create(NULL, NULL); 531 SPDK_CU_ASSERT_FATAL(thread != NULL); 532 spdk_set_thread(thread); 533 534 tcp_req.pdu = &pdu; 535 tcp_req.req.length = 300; 536 tcp_req.req.qpair = &tqpair.qpair; 537 538 tqpair.qpair.transport = &ttransport.transport; 539 540 /* Set qpair state to make unrelated operations NOP */ 541 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 542 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR; 543 544 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 545 546 tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF; 547 tcp_req.req.iov[0].iov_len = 101; 548 tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF; 549 tcp_req.req.iov[1].iov_len = 100; 550 tcp_req.req.iov[2].iov_base = (void *)0xC0FFEE; 551 tcp_req.req.iov[2].iov_len = 99; 552 tcp_req.req.iovcnt = 3; 553 tcp_req.req.length = 300; 554 555 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 556 557 c2h_data = &pdu.hdr.c2h_data; 558 CU_ASSERT(c2h_data->datao == 0); 559 CU_ASSERT(c2h_data->datal = 300); 560 CU_ASSERT(c2h_data->common.plen == sizeof(*c2h_data) + 300); 561 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 562 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS); 563 564 CU_ASSERT(pdu.data_iovcnt == 3); 565 CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF); 566 CU_ASSERT(pdu.data_iov[0].iov_len == 101); 567 CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF); 568 CU_ASSERT(pdu.data_iov[1].iov_len == 100); 569 CU_ASSERT((uint64_t)pdu.data_iov[2].iov_base == 0xC0FFEE); 570 CU_ASSERT(pdu.data_iov[2].iov_len == 99); 571 572 tcp_req.pdu_in_use = false; 573 tcp_req.rsp.cdw0 = 1; 574 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 575 576 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 577 CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0); 578 579 ttransport.tcp_opts.c2h_success = false; 580 tcp_req.pdu_in_use = false; 581 tcp_req.rsp.cdw0 = 0; 582 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 583 584 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 585 CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0); 586 587 tcp_req.pdu_in_use = false; 588 tcp_req.rsp.cdw0 = 1; 589 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 590 591 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 592 CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0); 593 594 spdk_thread_exit(thread); 595 while (!spdk_thread_is_exited(thread)) { 596 spdk_thread_poll(thread, 0, 0); 597 } 598 spdk_thread_destroy(thread); 599 } 600 601 #define NVMF_TCP_PDU_MAX_H2C_DATA_SIZE (128 * 1024) 602 603 static void 604 test_nvmf_tcp_h2c_data_hdr_handle(void) 605 { 606 struct spdk_nvmf_tcp_transport ttransport = {}; 607 struct spdk_nvmf_tcp_qpair tqpair = {}; 608 struct nvme_tcp_pdu pdu = {}; 609 struct spdk_nvmf_tcp_req tcp_req = {}; 610 struct spdk_nvme_tcp_h2c_data_hdr *h2c_data; 611 612 TAILQ_INIT(&tqpair.tcp_req_working_queue); 613 614 /* Set qpair state to make unrelated operations NOP */ 615 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 616 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR; 617 618 tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF; 619 tcp_req.req.iov[0].iov_len = 101; 620 tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF; 621 tcp_req.req.iov[1].iov_len = 99; 622 tcp_req.req.iovcnt = 2; 623 tcp_req.req.length = 200; 624 tcp_req.state = TCP_REQUEST_STATE_TRANSFERRING_HOST_TO_CONTROLLER; 625 626 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 627 tcp_req.req.cmd->nvme_cmd.cid = 1; 628 tcp_req.ttag = 2; 629 630 TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, 631 &tcp_req, state_link); 632 633 h2c_data = &pdu.hdr.h2c_data; 634 h2c_data->cccid = 1; 635 h2c_data->ttag = 2; 636 h2c_data->datao = 0; 637 h2c_data->datal = 200; 638 639 nvmf_tcp_h2c_data_hdr_handle(&ttransport, &tqpair, &pdu); 640 641 CU_ASSERT(pdu.data_iovcnt == 2); 642 CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF); 643 CU_ASSERT(pdu.data_iov[0].iov_len == 101); 644 CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF); 645 CU_ASSERT(pdu.data_iov[1].iov_len == 99); 646 647 CU_ASSERT(TAILQ_FIRST(&tqpair.tcp_req_working_queue) == 648 &tcp_req); 649 TAILQ_REMOVE(&tqpair.tcp_req_working_queue, 650 &tcp_req, state_link); 651 } 652 653 654 static void 655 test_nvmf_tcp_incapsule_data_handle(void) 656 { 657 struct spdk_nvmf_tcp_transport ttransport = {}; 658 struct spdk_nvmf_tcp_qpair tqpair = {}; 659 struct nvme_tcp_pdu *pdu, pdu_in_progress = {}; 660 union nvmf_c2h_msg rsp0 = {}; 661 union nvmf_c2h_msg rsp = {}; 662 663 struct spdk_nvmf_request *req_temp = NULL; 664 struct spdk_nvmf_tcp_req tcp_req2 = {}; 665 struct spdk_nvmf_tcp_req tcp_req1 = {}; 666 667 struct spdk_nvme_tcp_cmd *capsule_data; 668 struct spdk_nvmf_capsule_cmd *nvmf_capsule_data; 669 struct spdk_nvme_sgl_descriptor *sgl; 670 671 struct spdk_nvmf_transport_poll_group *group; 672 struct spdk_nvmf_tcp_poll_group tcp_group = {}; 673 struct spdk_sock_group grp = {}; 674 675 tqpair.pdu_in_progress = &pdu_in_progress; 676 ttransport.transport.opts.max_io_size = UT_MAX_IO_SIZE; 677 ttransport.transport.opts.io_unit_size = UT_IO_UNIT_SIZE; 678 679 tcp_group.sock_group = &grp; 680 TAILQ_INIT(&tcp_group.qpairs); 681 group = &tcp_group.group; 682 group->transport = &ttransport.transport; 683 STAILQ_INIT(&group->pending_buf_queue); 684 tqpair.group = &tcp_group; 685 686 TAILQ_INIT(&tqpair.tcp_req_free_queue); 687 TAILQ_INIT(&tqpair.tcp_req_working_queue); 688 689 TAILQ_INSERT_TAIL(&tqpair.tcp_req_free_queue, &tcp_req2, state_link); 690 tqpair.state_cntr[TCP_REQUEST_STATE_FREE]++; 691 tqpair.qpair.transport = &ttransport.transport; 692 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 693 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH; 694 tqpair.qpair.state = SPDK_NVMF_QPAIR_ACTIVE; 695 696 /* init a null tcp_req into tqpair TCP_REQUEST_STATE_FREE queue */ 697 tcp_req2.req.qpair = &tqpair.qpair; 698 tcp_req2.req.cmd = (union nvmf_h2c_msg *)&tcp_req2.cmd; 699 tcp_req2.req.rsp = &rsp; 700 701 /* init tcp_req1 */ 702 tcp_req1.req.qpair = &tqpair.qpair; 703 tcp_req1.req.cmd = (union nvmf_h2c_msg *)&tcp_req1.cmd; 704 tcp_req1.req.rsp = &rsp0; 705 tcp_req1.state = TCP_REQUEST_STATE_NEW; 706 707 TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, &tcp_req1, state_link); 708 tqpair.state_cntr[TCP_REQUEST_STATE_NEW]++; 709 710 /* init pdu, make pdu need sgl buff */ 711 pdu = tqpair.pdu_in_progress; 712 capsule_data = &pdu->hdr.capsule_cmd; 713 nvmf_capsule_data = (struct spdk_nvmf_capsule_cmd *)&pdu->hdr.capsule_cmd.ccsqe; 714 sgl = &capsule_data->ccsqe.dptr.sgl1; 715 716 capsule_data->common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 717 capsule_data->common.hlen = sizeof(*capsule_data); 718 capsule_data->common.plen = 1096; 719 capsule_data->ccsqe.opc = SPDK_NVME_OPC_FABRIC; 720 721 sgl->unkeyed.subtype = SPDK_NVME_SGL_SUBTYPE_TRANSPORT; 722 sgl->generic.type = SPDK_NVME_SGL_TYPE_TRANSPORT_DATA_BLOCK; 723 sgl->unkeyed.length = UT_IO_UNIT_SIZE; 724 725 nvmf_capsule_data->fctype = SPDK_NVMF_FABRIC_COMMAND_CONNECT; 726 727 /* insert tcp_req1 to pending_buf_queue, And this req takes precedence over the next req. */ 728 nvmf_tcp_req_process(&ttransport, &tcp_req1); 729 CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req); 730 731 sgl->unkeyed.length = UT_IO_UNIT_SIZE - 1; 732 733 /* process tqpair capsule req. but we still remain req in pending_buff. */ 734 nvmf_tcp_capsule_cmd_hdr_handle(&ttransport, &tqpair, tqpair.pdu_in_progress); 735 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PAYLOAD); 736 CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req); 737 STAILQ_FOREACH(req_temp, &group->pending_buf_queue, buf_link) { 738 if (req_temp == &tcp_req2.req) { 739 break; 740 } 741 } 742 CU_ASSERT(req_temp == NULL); 743 CU_ASSERT(tqpair.pdu_in_progress->req == (void *)&tcp_req2); 744 } 745 746 static void 747 test_nvmf_tcp_qpair_init_mem_resource(void) 748 { 749 int rc; 750 struct spdk_nvmf_tcp_qpair *tqpair = NULL; 751 struct spdk_nvmf_transport transport = {}; 752 753 tqpair = calloc(1, sizeof(*tqpair)); 754 tqpair->qpair.transport = &transport; 755 756 nvmf_tcp_opts_init(&transport.opts); 757 CU_ASSERT(transport.opts.max_queue_depth == SPDK_NVMF_TCP_DEFAULT_MAX_QUEUE_DEPTH); 758 CU_ASSERT(transport.opts.max_qpairs_per_ctrlr == SPDK_NVMF_TCP_DEFAULT_MAX_QPAIRS_PER_CTRLR); 759 CU_ASSERT(transport.opts.in_capsule_data_size == SPDK_NVMF_TCP_DEFAULT_IN_CAPSULE_DATA_SIZE); 760 CU_ASSERT(transport.opts.max_io_size == SPDK_NVMF_TCP_DEFAULT_MAX_IO_SIZE); 761 CU_ASSERT(transport.opts.io_unit_size == SPDK_NVMF_TCP_DEFAULT_IO_UNIT_SIZE); 762 CU_ASSERT(transport.opts.max_aq_depth == SPDK_NVMF_TCP_DEFAULT_AQ_DEPTH); 763 CU_ASSERT(transport.opts.num_shared_buffers == SPDK_NVMF_TCP_DEFAULT_NUM_SHARED_BUFFERS); 764 CU_ASSERT(transport.opts.buf_cache_size == SPDK_NVMF_TCP_DEFAULT_BUFFER_CACHE_SIZE); 765 CU_ASSERT(transport.opts.dif_insert_or_strip == SPDK_NVMF_TCP_DEFAULT_DIF_INSERT_OR_STRIP); 766 CU_ASSERT(transport.opts.abort_timeout_sec == SPDK_NVMF_TCP_DEFAULT_ABORT_TIMEOUT_SEC); 767 CU_ASSERT(transport.opts.transport_specific == NULL); 768 769 rc = nvmf_tcp_qpair_init(&tqpair->qpair); 770 CU_ASSERT(rc == 0); 771 CU_ASSERT(tqpair->host_hdgst_enable == true); 772 CU_ASSERT(tqpair->host_ddgst_enable == true); 773 774 rc = nvmf_tcp_qpair_init_mem_resource(tqpair); 775 CU_ASSERT(rc == 0); 776 CU_ASSERT(tqpair->resource_count == SPDK_NVMF_TCP_DEFAULT_MAX_QUEUE_DEPTH); 777 CU_ASSERT(tqpair->reqs != NULL); 778 CU_ASSERT(tqpair->bufs != NULL); 779 CU_ASSERT(tqpair->pdus != NULL); 780 /* Just to check the first and last entry */ 781 CU_ASSERT(tqpair->reqs[0].ttag == 1); 782 CU_ASSERT(tqpair->reqs[0].req.qpair == &tqpair->qpair); 783 CU_ASSERT(tqpair->reqs[0].pdu == &tqpair->pdus[0]); 784 CU_ASSERT(tqpair->reqs[0].pdu->qpair == &tqpair->qpair); 785 CU_ASSERT(tqpair->reqs[0].buf == (void *)((uintptr_t)tqpair->bufs)); 786 CU_ASSERT(tqpair->reqs[0].req.rsp == (void *)&tqpair->reqs[0].rsp); 787 CU_ASSERT(tqpair->reqs[0].req.cmd == (void *)&tqpair->reqs[0].cmd); 788 CU_ASSERT(tqpair->reqs[0].state == TCP_REQUEST_STATE_FREE); 789 CU_ASSERT(tqpair->reqs[127].ttag == 128); 790 CU_ASSERT(tqpair->reqs[127].req.qpair == &tqpair->qpair); 791 CU_ASSERT(tqpair->reqs[127].pdu == &tqpair->pdus[127]); 792 CU_ASSERT(tqpair->reqs[127].pdu->qpair == &tqpair->qpair); 793 CU_ASSERT(tqpair->reqs[127].buf == (void *)((uintptr_t)tqpair->bufs) + 127 * 4096); 794 CU_ASSERT(tqpair->reqs[127].req.rsp == (void *)&tqpair->reqs[127].rsp); 795 CU_ASSERT(tqpair->reqs[127].req.cmd == (void *)&tqpair->reqs[127].cmd); 796 CU_ASSERT(tqpair->reqs[127].state == TCP_REQUEST_STATE_FREE); 797 CU_ASSERT(tqpair->state_cntr[TCP_REQUEST_STATE_FREE] == SPDK_NVMF_TCP_DEFAULT_MAX_QUEUE_DEPTH); 798 CU_ASSERT(tqpair->mgmt_pdu == &tqpair->pdus[SPDK_NVMF_TCP_DEFAULT_MAX_QUEUE_DEPTH]); 799 CU_ASSERT(tqpair->mgmt_pdu->qpair == tqpair); 800 CU_ASSERT(tqpair->pdu_in_progress == &tqpair->pdus[SPDK_NVMF_TCP_DEFAULT_MAX_QUEUE_DEPTH + 1]); 801 CU_ASSERT(tqpair->recv_buf_size == (4096 + sizeof(struct spdk_nvme_tcp_cmd) + 2 * 802 SPDK_NVME_TCP_DIGEST_LEN) * SPDK_NVMF_TCP_RECV_BUF_SIZE_FACTOR); 803 804 /* Free all of tqpair resource */ 805 nvmf_tcp_qpair_destroy(tqpair); 806 } 807 808 int main(int argc, char **argv) 809 { 810 CU_pSuite suite = NULL; 811 unsigned int num_failures; 812 813 CU_set_error_action(CUEA_ABORT); 814 CU_initialize_registry(); 815 816 suite = CU_add_suite("nvmf", NULL, NULL); 817 818 CU_ADD_TEST(suite, test_nvmf_tcp_create); 819 CU_ADD_TEST(suite, test_nvmf_tcp_destroy); 820 CU_ADD_TEST(suite, test_nvmf_tcp_poll_group_create); 821 CU_ADD_TEST(suite, test_nvmf_tcp_send_c2h_data); 822 CU_ADD_TEST(suite, test_nvmf_tcp_h2c_data_hdr_handle); 823 CU_ADD_TEST(suite, test_nvmf_tcp_incapsule_data_handle); 824 CU_ADD_TEST(suite, test_nvmf_tcp_qpair_init_mem_resource); 825 826 CU_basic_set_mode(CU_BRM_VERBOSE); 827 CU_basic_run_tests(); 828 num_failures = CU_get_number_of_failures(); 829 CU_cleanup_registry(); 830 return num_failures; 831 } 832