1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2018 Intel Corporation. 3 * All rights reserved. 4 * Copyright (c) 2021, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 */ 6 7 #include "spdk/stdinc.h" 8 #include "spdk/nvmf_spec.h" 9 #include "spdk_internal/cunit.h" 10 #include "spdk/bdev_zone.h" 11 12 #include "common/lib/test_env.c" 13 #include "common/lib/test_sock.c" 14 15 #include "nvmf/ctrlr.c" 16 #include "nvmf/tcp.c" 17 #include "spdk/sock.h" 18 #include "spdk/hexlify.h" 19 20 #define UT_IPV4_ADDR "192.168.0.1" 21 #define UT_PORT "4420" 22 #define UT_NVMF_ADRFAM_INVALID 0xf 23 #define UT_MAX_QUEUE_DEPTH 128 24 #define UT_MAX_QPAIRS_PER_CTRLR 128 25 #define UT_IN_CAPSULE_DATA_SIZE 1024 26 #define UT_MAX_IO_SIZE 4096 27 #define UT_IO_UNIT_SIZE 1024 28 #define UT_MAX_AQ_DEPTH 64 29 #define UT_SQ_HEAD_MAX 128 30 #define UT_NUM_SHARED_BUFFERS 128 31 32 static void *g_accel_p = (void *)0xdeadbeaf; 33 34 SPDK_LOG_REGISTER_COMPONENT(nvmf) 35 36 DEFINE_STUB(spdk_nvmf_qpair_get_listen_trid, 37 int, 38 (struct spdk_nvmf_qpair *qpair, struct spdk_nvme_transport_id *trid), 39 0); 40 41 DEFINE_STUB(nvmf_subsystem_add_ctrlr, 42 int, 43 (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr), 44 0); 45 46 DEFINE_STUB(nvmf_subsystem_get_ctrlr, 47 struct spdk_nvmf_ctrlr *, 48 (struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid), 49 NULL); 50 51 DEFINE_STUB(spdk_nvmf_tgt_find_subsystem, 52 struct spdk_nvmf_subsystem *, 53 (struct spdk_nvmf_tgt *tgt, const char *subnqn), 54 NULL); 55 56 DEFINE_STUB(spdk_nvmf_subsystem_listener_allowed, 57 bool, 58 (struct spdk_nvmf_subsystem *subsystem, const struct spdk_nvme_transport_id *trid), 59 true); 60 61 DEFINE_STUB(nvmf_subsystem_find_listener, 62 struct spdk_nvmf_subsystem_listener *, 63 (struct spdk_nvmf_subsystem *subsystem, 64 const struct spdk_nvme_transport_id *trid), 65 (void *)0x1); 66 67 DEFINE_STUB_V(nvmf_get_discovery_log_page, 68 (struct spdk_nvmf_tgt *tgt, const char *hostnqn, struct iovec *iov, 69 uint32_t iovcnt, uint64_t offset, uint32_t length, struct spdk_nvme_transport_id *cmd_src_trid)); 70 71 DEFINE_STUB_V(nvmf_subsystem_remove_ctrlr, 72 (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr)); 73 74 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns, 75 struct spdk_nvmf_ns *, 76 (struct spdk_nvmf_subsystem *subsystem), 77 NULL); 78 79 DEFINE_STUB(spdk_nvmf_subsystem_get_next_ns, 80 struct spdk_nvmf_ns *, 81 (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns), 82 NULL); 83 84 DEFINE_STUB(spdk_nvmf_subsystem_host_allowed, 85 bool, 86 (struct spdk_nvmf_subsystem *subsystem, const char *hostnqn), 87 true); 88 89 DEFINE_STUB(nvmf_ctrlr_dsm_supported, 90 bool, 91 (struct spdk_nvmf_ctrlr *ctrlr), 92 false); 93 94 DEFINE_STUB(nvmf_ctrlr_write_zeroes_supported, 95 bool, 96 (struct spdk_nvmf_ctrlr *ctrlr), 97 false); 98 99 DEFINE_STUB(nvmf_ctrlr_copy_supported, 100 bool, 101 (struct spdk_nvmf_ctrlr *ctrlr), 102 false); 103 104 DEFINE_STUB(nvmf_bdev_ctrlr_read_cmd, 105 int, 106 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 107 struct spdk_nvmf_request *req), 108 0); 109 110 DEFINE_STUB(nvmf_bdev_ctrlr_write_cmd, 111 int, 112 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 113 struct spdk_nvmf_request *req), 114 0); 115 116 DEFINE_STUB(nvmf_bdev_ctrlr_compare_cmd, 117 int, 118 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 119 struct spdk_nvmf_request *req), 120 0); 121 122 DEFINE_STUB(nvmf_bdev_ctrlr_compare_and_write_cmd, 123 int, 124 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 125 struct spdk_nvmf_request *cmp_req, struct spdk_nvmf_request *write_req), 126 0); 127 128 DEFINE_STUB(nvmf_bdev_ctrlr_write_zeroes_cmd, 129 int, 130 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 131 struct spdk_nvmf_request *req), 132 0); 133 134 DEFINE_STUB(nvmf_bdev_ctrlr_flush_cmd, 135 int, 136 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 137 struct spdk_nvmf_request *req), 138 0); 139 140 DEFINE_STUB(nvmf_bdev_ctrlr_dsm_cmd, 141 int, 142 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 143 struct spdk_nvmf_request *req), 144 0); 145 146 DEFINE_STUB(nvmf_bdev_ctrlr_copy_cmd, 147 int, 148 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 149 struct spdk_nvmf_request *req), 150 0); 151 152 DEFINE_STUB(nvmf_bdev_ctrlr_nvme_passthru_io, 153 int, 154 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 155 struct spdk_nvmf_request *req), 156 0); 157 158 DEFINE_STUB(spdk_nvmf_bdev_ctrlr_abort_cmd, 159 int, 160 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 161 struct spdk_nvmf_request *req, struct spdk_nvmf_request *req_to_abort), 162 0); 163 164 DEFINE_STUB(nvmf_bdev_ctrlr_get_dif_ctx, 165 bool, 166 (struct spdk_bdev *bdev, struct spdk_nvme_cmd *cmd, struct spdk_dif_ctx *dif_ctx), 167 false); 168 169 DEFINE_STUB(nvmf_transport_req_complete, 170 int, 171 (struct spdk_nvmf_request *req), 172 0); 173 174 DEFINE_STUB(nvmf_bdev_zcopy_enabled, 175 bool, 176 (struct spdk_bdev *bdev), 177 false); 178 179 DEFINE_STUB(nvmf_bdev_ctrlr_zcopy_start, 180 int, 181 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 182 struct spdk_nvmf_request *req), 183 0); 184 185 DEFINE_STUB_V(nvmf_bdev_ctrlr_zcopy_end, (struct spdk_nvmf_request *req, bool commit)); 186 187 DEFINE_STUB_V(spdk_nvmf_request_free_buffers, 188 (struct spdk_nvmf_request *req, struct spdk_nvmf_transport_poll_group *group, 189 struct spdk_nvmf_transport *transport)); 190 191 DEFINE_STUB(spdk_sock_get_optimal_sock_group, 192 int, 193 (struct spdk_sock *sock, struct spdk_sock_group **group, struct spdk_sock_group *hint), 194 0); 195 196 DEFINE_STUB(spdk_sock_group_get_ctx, 197 void *, 198 (struct spdk_sock_group *group), 199 NULL); 200 201 DEFINE_STUB_V(nvmf_ns_reservation_request, (void *ctx)); 202 203 DEFINE_STUB_V(spdk_nvme_trid_populate_transport, (struct spdk_nvme_transport_id *trid, 204 enum spdk_nvme_transport_type trtype)); 205 DEFINE_STUB_V(spdk_nvmf_transport_register, (const struct spdk_nvmf_transport_ops *ops)); 206 207 DEFINE_STUB_V(spdk_nvmf_tgt_new_qpair, (struct spdk_nvmf_tgt *tgt, struct spdk_nvmf_qpair *qpair)); 208 209 DEFINE_STUB_V(nvmf_transport_qpair_abort_request, 210 (struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_request *req)); 211 212 DEFINE_STUB_V(spdk_nvme_print_command, (uint16_t qid, struct spdk_nvme_cmd *cmd)); 213 DEFINE_STUB_V(spdk_nvme_print_completion, (uint16_t qid, struct spdk_nvme_cpl *cpl)); 214 215 DEFINE_STUB(nvmf_transport_req_free, 216 int, 217 (struct spdk_nvmf_request *req), 218 0); 219 220 DEFINE_STUB(accel_channel_create, int, (void *io_device, void *ctx_buf), 0); 221 DEFINE_STUB_V(accel_channel_destroy, (void *io_device, void *ctx_buf)); 222 DEFINE_STUB(spdk_bdev_reset, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 223 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 224 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io)); 225 226 DEFINE_STUB(spdk_bdev_get_max_active_zones, uint32_t, 227 (const struct spdk_bdev *bdev), 0); 228 DEFINE_STUB(spdk_bdev_get_max_open_zones, uint32_t, 229 (const struct spdk_bdev *bdev), 0); 230 DEFINE_STUB(spdk_bdev_is_zoned, bool, (const struct spdk_bdev *bdev), false); 231 DEFINE_STUB(spdk_bdev_get_zone_size, uint64_t, (const struct spdk_bdev *bdev), 0); 232 233 DEFINE_STUB(spdk_nvme_ns_get_format_index, uint32_t, 234 (const struct spdk_nvme_ns_data *nsdata), 0); 235 236 DEFINE_STUB(spdk_sock_get_impl_name, const char *, (struct spdk_sock *sock), ""); 237 238 DEFINE_STUB(spdk_nvmf_subsystem_is_discovery, bool, (struct spdk_nvmf_subsystem *subsystem), false); 239 240 DEFINE_STUB(nvmf_ns_is_ptpl_capable, bool, (const struct spdk_nvmf_ns *ns), false); 241 242 struct spdk_io_channel * 243 spdk_accel_get_io_channel(void) 244 { 245 return spdk_get_io_channel(g_accel_p); 246 } 247 248 DEFINE_STUB(spdk_accel_submit_crc32cv, 249 int, 250 (struct spdk_io_channel *ch, uint32_t *dst, struct iovec *iovs, 251 uint32_t iovcnt, uint32_t seed, spdk_accel_completion_cb cb_fn, void *cb_arg), 252 0); 253 254 DEFINE_STUB(spdk_nvmf_bdev_ctrlr_nvme_passthru_admin, 255 int, 256 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 257 struct spdk_io_channel *ch, struct spdk_nvmf_request *req, 258 spdk_nvmf_nvme_passthru_cmd_cb cb_fn), 259 0) 260 261 struct spdk_bdev { 262 int ut_mock; 263 uint64_t blockcnt; 264 }; 265 266 int 267 spdk_nvme_transport_id_compare(const struct spdk_nvme_transport_id *trid1, 268 const struct spdk_nvme_transport_id *trid2) 269 { 270 return 0; 271 } 272 273 const char * 274 spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trtype) 275 { 276 switch (trtype) { 277 case SPDK_NVME_TRANSPORT_PCIE: 278 return "PCIe"; 279 case SPDK_NVME_TRANSPORT_RDMA: 280 return "RDMA"; 281 case SPDK_NVME_TRANSPORT_FC: 282 return "FC"; 283 default: 284 return NULL; 285 } 286 } 287 288 int 289 spdk_nvme_transport_id_populate_trstring(struct spdk_nvme_transport_id *trid, const char *trstring) 290 { 291 int len, i; 292 293 if (trstring == NULL) { 294 return -EINVAL; 295 } 296 297 len = strnlen(trstring, SPDK_NVMF_TRSTRING_MAX_LEN); 298 if (len == SPDK_NVMF_TRSTRING_MAX_LEN) { 299 return -EINVAL; 300 } 301 302 /* cast official trstring to uppercase version of input. */ 303 for (i = 0; i < len; i++) { 304 trid->trstring[i] = toupper(trstring[i]); 305 } 306 return 0; 307 } 308 309 int 310 spdk_nvmf_qpair_disconnect(struct spdk_nvmf_qpair *qpair, nvmf_qpair_disconnect_cb cb_fn, void *ctx) 311 { 312 return 0; 313 } 314 315 int 316 spdk_nvmf_request_get_buffers(struct spdk_nvmf_request *req, 317 struct spdk_nvmf_transport_poll_group *group, 318 struct spdk_nvmf_transport *transport, 319 uint32_t length) 320 { 321 /* length more than 1 io unit length will fail. */ 322 if (length >= transport->opts.io_unit_size) { 323 return -EINVAL; 324 } 325 326 req->iovcnt = 1; 327 req->iov[0].iov_base = (void *)0xDEADBEEF; 328 329 return 0; 330 } 331 332 333 void 334 nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata, 335 bool dif_insert_or_strip) 336 { 337 uint64_t num_blocks; 338 339 SPDK_CU_ASSERT_FATAL(ns->bdev != NULL); 340 num_blocks = ns->bdev->blockcnt; 341 nsdata->nsze = num_blocks; 342 nsdata->ncap = num_blocks; 343 nsdata->nuse = num_blocks; 344 nsdata->nlbaf = 0; 345 nsdata->flbas.format = 0; 346 nsdata->flbas.msb_format = 0; 347 nsdata->lbaf[0].lbads = spdk_u32log2(512); 348 } 349 350 const char * 351 spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem) 352 { 353 return subsystem->sn; 354 } 355 356 const char * 357 spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem) 358 { 359 return subsystem->mn; 360 } 361 362 static void 363 test_nvmf_tcp_create(void) 364 { 365 struct spdk_thread *thread; 366 struct spdk_nvmf_transport *transport; 367 struct spdk_nvmf_tcp_transport *ttransport; 368 struct spdk_nvmf_transport_opts opts; 369 370 thread = spdk_thread_create(NULL, NULL); 371 SPDK_CU_ASSERT_FATAL(thread != NULL); 372 spdk_set_thread(thread); 373 374 /* case 1 */ 375 memset(&opts, 0, sizeof(opts)); 376 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 377 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 378 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 379 opts.max_io_size = UT_MAX_IO_SIZE; 380 opts.io_unit_size = UT_IO_UNIT_SIZE; 381 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 382 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 383 /* expect success */ 384 transport = nvmf_tcp_create(&opts); 385 CU_ASSERT_PTR_NOT_NULL(transport); 386 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 387 SPDK_CU_ASSERT_FATAL(ttransport != NULL); 388 transport->opts = opts; 389 CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH); 390 CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE); 391 CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE); 392 CU_ASSERT(transport->opts.io_unit_size == UT_IO_UNIT_SIZE); 393 /* destroy transport */ 394 CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0); 395 396 /* case 2 */ 397 memset(&opts, 0, sizeof(opts)); 398 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 399 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 400 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 401 opts.max_io_size = UT_MAX_IO_SIZE; 402 opts.io_unit_size = UT_MAX_IO_SIZE + 1; 403 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 404 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 405 /* expect success */ 406 transport = nvmf_tcp_create(&opts); 407 CU_ASSERT_PTR_NOT_NULL(transport); 408 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 409 SPDK_CU_ASSERT_FATAL(ttransport != NULL); 410 transport->opts = opts; 411 CU_ASSERT(transport->opts.max_queue_depth == UT_MAX_QUEUE_DEPTH); 412 CU_ASSERT(transport->opts.max_io_size == UT_MAX_IO_SIZE); 413 CU_ASSERT(transport->opts.in_capsule_data_size == UT_IN_CAPSULE_DATA_SIZE); 414 CU_ASSERT(transport->opts.io_unit_size == UT_MAX_IO_SIZE); 415 /* destroy transport */ 416 CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0); 417 418 /* case 3 */ 419 memset(&opts, 0, sizeof(opts)); 420 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 421 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 422 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 423 opts.max_io_size = UT_MAX_IO_SIZE; 424 opts.io_unit_size = 16; 425 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 426 /* expect fails */ 427 transport = nvmf_tcp_create(&opts); 428 CU_ASSERT_PTR_NULL(transport); 429 430 spdk_thread_exit(thread); 431 while (!spdk_thread_is_exited(thread)) { 432 spdk_thread_poll(thread, 0, 0); 433 } 434 spdk_thread_destroy(thread); 435 } 436 437 static void 438 test_nvmf_tcp_destroy(void) 439 { 440 struct spdk_thread *thread; 441 struct spdk_nvmf_transport *transport; 442 struct spdk_nvmf_transport_opts opts; 443 444 thread = spdk_thread_create(NULL, NULL); 445 SPDK_CU_ASSERT_FATAL(thread != NULL); 446 spdk_set_thread(thread); 447 448 /* case 1 */ 449 memset(&opts, 0, sizeof(opts)); 450 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 451 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 452 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 453 opts.max_io_size = UT_MAX_IO_SIZE; 454 opts.io_unit_size = UT_IO_UNIT_SIZE; 455 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 456 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 457 transport = nvmf_tcp_create(&opts); 458 CU_ASSERT_PTR_NOT_NULL(transport); 459 transport->opts = opts; 460 /* destroy transport */ 461 CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0); 462 463 spdk_thread_exit(thread); 464 while (!spdk_thread_is_exited(thread)) { 465 spdk_thread_poll(thread, 0, 0); 466 } 467 spdk_thread_destroy(thread); 468 } 469 470 static void 471 init_accel(void) 472 { 473 spdk_io_device_register(g_accel_p, accel_channel_create, accel_channel_destroy, 474 sizeof(int), "accel_p"); 475 } 476 477 static void 478 fini_accel(void) 479 { 480 spdk_io_device_unregister(g_accel_p, NULL); 481 } 482 483 static void 484 test_nvmf_tcp_poll_group_create(void) 485 { 486 struct spdk_nvmf_transport *transport; 487 struct spdk_nvmf_transport_poll_group *group; 488 struct spdk_nvmf_tcp_poll_group *tgroup; 489 struct spdk_thread *thread; 490 struct spdk_nvmf_transport_opts opts; 491 struct spdk_sock_group grp = {}; 492 493 thread = spdk_thread_create(NULL, NULL); 494 SPDK_CU_ASSERT_FATAL(thread != NULL); 495 spdk_set_thread(thread); 496 497 init_accel(); 498 499 memset(&opts, 0, sizeof(opts)); 500 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 501 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 502 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 503 opts.max_io_size = UT_MAX_IO_SIZE; 504 opts.io_unit_size = UT_IO_UNIT_SIZE; 505 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 506 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 507 transport = nvmf_tcp_create(&opts); 508 CU_ASSERT_PTR_NOT_NULL(transport); 509 transport->opts = opts; 510 MOCK_SET(spdk_sock_group_create, &grp); 511 group = nvmf_tcp_poll_group_create(transport, NULL); 512 MOCK_CLEAR_P(spdk_sock_group_create); 513 SPDK_CU_ASSERT_FATAL(group); 514 if (opts.in_capsule_data_size < SPDK_NVME_TCP_IN_CAPSULE_DATA_MAX_SIZE) { 515 tgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_tcp_poll_group, group); 516 SPDK_CU_ASSERT_FATAL(tgroup->control_msg_list); 517 } 518 group->transport = transport; 519 nvmf_tcp_poll_group_destroy(group); 520 nvmf_tcp_destroy(transport, NULL, NULL); 521 522 fini_accel(); 523 spdk_thread_exit(thread); 524 while (!spdk_thread_is_exited(thread)) { 525 spdk_thread_poll(thread, 0, 0); 526 } 527 spdk_thread_destroy(thread); 528 } 529 530 static void 531 test_nvmf_tcp_send_c2h_data(void) 532 { 533 struct spdk_thread *thread; 534 struct spdk_nvmf_tcp_transport ttransport = {}; 535 struct spdk_nvmf_tcp_qpair tqpair = {}; 536 struct spdk_nvmf_tcp_req tcp_req = {}; 537 struct nvme_tcp_pdu pdu = {}; 538 struct spdk_nvme_tcp_c2h_data_hdr *c2h_data; 539 540 ttransport.tcp_opts.c2h_success = true; 541 thread = spdk_thread_create(NULL, NULL); 542 SPDK_CU_ASSERT_FATAL(thread != NULL); 543 spdk_set_thread(thread); 544 545 tcp_req.pdu = &pdu; 546 tcp_req.req.length = 300; 547 tcp_req.req.qpair = &tqpair.qpair; 548 549 tqpair.qpair.transport = &ttransport.transport; 550 551 /* Set qpair state to make unrelated operations NOP */ 552 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 553 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR; 554 555 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 556 557 tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF; 558 tcp_req.req.iov[0].iov_len = 101; 559 tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF; 560 tcp_req.req.iov[1].iov_len = 100; 561 tcp_req.req.iov[2].iov_base = (void *)0xC0FFEE; 562 tcp_req.req.iov[2].iov_len = 99; 563 tcp_req.req.iovcnt = 3; 564 tcp_req.req.length = 300; 565 566 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 567 568 c2h_data = &pdu.hdr.c2h_data; 569 CU_ASSERT(c2h_data->datao == 0); 570 CU_ASSERT(c2h_data->datal = 300); 571 CU_ASSERT(c2h_data->common.plen == sizeof(*c2h_data) + 300); 572 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 573 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS); 574 575 CU_ASSERT(pdu.data_iovcnt == 3); 576 CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF); 577 CU_ASSERT(pdu.data_iov[0].iov_len == 101); 578 CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF); 579 CU_ASSERT(pdu.data_iov[1].iov_len == 100); 580 CU_ASSERT((uint64_t)pdu.data_iov[2].iov_base == 0xC0FFEE); 581 CU_ASSERT(pdu.data_iov[2].iov_len == 99); 582 583 tcp_req.pdu_in_use = false; 584 tcp_req.rsp.cdw0 = 1; 585 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 586 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) == 0); 589 590 ttransport.tcp_opts.c2h_success = false; 591 tcp_req.pdu_in_use = false; 592 tcp_req.rsp.cdw0 = 0; 593 nvmf_tcp_send_c2h_data(&tqpair, &tcp_req); 594 595 CU_ASSERT(c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_LAST_PDU); 596 CU_ASSERT((c2h_data->common.flags & SPDK_NVME_TCP_C2H_DATA_FLAGS_SUCCESS) == 0); 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 spdk_thread_exit(thread); 606 while (!spdk_thread_is_exited(thread)) { 607 spdk_thread_poll(thread, 0, 0); 608 } 609 spdk_thread_destroy(thread); 610 } 611 612 #define NVMF_TCP_PDU_MAX_H2C_DATA_SIZE (128 * 1024) 613 614 static void 615 test_nvmf_tcp_h2c_data_hdr_handle(void) 616 { 617 struct spdk_nvmf_tcp_transport ttransport = {}; 618 struct spdk_nvmf_tcp_qpair tqpair = {}; 619 struct nvme_tcp_pdu pdu = {}; 620 struct spdk_nvmf_tcp_req tcp_req = {}; 621 struct spdk_nvme_tcp_h2c_data_hdr *h2c_data; 622 623 /* Set qpair state to make unrelated operations NOP */ 624 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 625 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_ERROR; 626 tqpair.resource_count = 1; 627 tqpair.reqs = &tcp_req; 628 629 tcp_req.req.iov[0].iov_base = (void *)0xDEADBEEF; 630 tcp_req.req.iov[0].iov_len = 101; 631 tcp_req.req.iov[1].iov_base = (void *)0xFEEDBEEF; 632 tcp_req.req.iov[1].iov_len = 99; 633 tcp_req.req.iovcnt = 2; 634 tcp_req.req.length = 200; 635 tcp_req.state = TCP_REQUEST_STATE_TRANSFERRING_HOST_TO_CONTROLLER; 636 637 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 638 tcp_req.req.cmd->nvme_cmd.cid = 1; 639 tcp_req.ttag = 1; 640 641 h2c_data = &pdu.hdr.h2c_data; 642 h2c_data->cccid = 1; 643 h2c_data->ttag = 1; 644 h2c_data->datao = 0; 645 h2c_data->datal = 200; 646 647 nvmf_tcp_h2c_data_hdr_handle(&ttransport, &tqpair, &pdu); 648 649 CU_ASSERT(pdu.data_iovcnt == 2); 650 CU_ASSERT((uint64_t)pdu.data_iov[0].iov_base == 0xDEADBEEF); 651 CU_ASSERT(pdu.data_iov[0].iov_len == 101); 652 CU_ASSERT((uint64_t)pdu.data_iov[1].iov_base == 0xFEEDBEEF); 653 CU_ASSERT(pdu.data_iov[1].iov_len == 99); 654 } 655 656 657 static void 658 test_nvmf_tcp_in_capsule_data_handle(void) 659 { 660 struct spdk_nvmf_tcp_transport ttransport = {}; 661 struct spdk_nvmf_tcp_qpair tqpair = {}; 662 struct nvme_tcp_pdu *pdu, pdu_in_progress = {}; 663 union nvmf_c2h_msg rsp0 = {}; 664 union nvmf_c2h_msg rsp = {}; 665 666 struct spdk_nvmf_request *req_temp = NULL; 667 struct spdk_nvmf_tcp_req tcp_req2 = {}; 668 struct spdk_nvmf_tcp_req tcp_req1 = {}; 669 670 struct spdk_nvme_tcp_cmd *capsule_data; 671 struct spdk_nvmf_capsule_cmd *nvmf_capsule_data; 672 struct spdk_nvme_sgl_descriptor *sgl; 673 674 struct spdk_nvmf_transport_poll_group *group; 675 struct spdk_nvmf_tcp_poll_group tcp_group = {}; 676 struct spdk_sock_group grp = {}; 677 678 tqpair.pdu_in_progress = &pdu_in_progress; 679 ttransport.transport.opts.max_io_size = UT_MAX_IO_SIZE; 680 ttransport.transport.opts.io_unit_size = UT_IO_UNIT_SIZE; 681 682 tcp_group.sock_group = &grp; 683 TAILQ_INIT(&tcp_group.qpairs); 684 group = &tcp_group.group; 685 group->transport = &ttransport.transport; 686 STAILQ_INIT(&group->pending_buf_queue); 687 tqpair.group = &tcp_group; 688 689 TAILQ_INIT(&tqpair.tcp_req_free_queue); 690 TAILQ_INIT(&tqpair.tcp_req_working_queue); 691 692 TAILQ_INSERT_TAIL(&tqpair.tcp_req_free_queue, &tcp_req2, state_link); 693 tqpair.state_cntr[TCP_REQUEST_STATE_FREE]++; 694 tqpair.qpair.transport = &ttransport.transport; 695 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 696 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH; 697 tqpair.qpair.state = SPDK_NVMF_QPAIR_ACTIVE; 698 699 /* init a null tcp_req into tqpair TCP_REQUEST_STATE_FREE queue */ 700 tcp_req2.req.qpair = &tqpair.qpair; 701 tcp_req2.req.cmd = (union nvmf_h2c_msg *)&tcp_req2.cmd; 702 tcp_req2.req.rsp = &rsp; 703 704 /* init tcp_req1 */ 705 tcp_req1.req.qpair = &tqpair.qpair; 706 tcp_req1.req.cmd = (union nvmf_h2c_msg *)&tcp_req1.cmd; 707 tcp_req1.req.rsp = &rsp0; 708 tcp_req1.state = TCP_REQUEST_STATE_NEW; 709 710 TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, &tcp_req1, state_link); 711 tqpair.state_cntr[TCP_REQUEST_STATE_NEW]++; 712 713 /* init pdu, make pdu need sgl buff */ 714 pdu = tqpair.pdu_in_progress; 715 capsule_data = &pdu->hdr.capsule_cmd; 716 nvmf_capsule_data = (struct spdk_nvmf_capsule_cmd *)&pdu->hdr.capsule_cmd.ccsqe; 717 sgl = &capsule_data->ccsqe.dptr.sgl1; 718 719 capsule_data->common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 720 capsule_data->common.hlen = sizeof(*capsule_data); 721 capsule_data->common.plen = 1096; 722 capsule_data->ccsqe.opc = SPDK_NVME_OPC_FABRIC; 723 724 sgl->unkeyed.subtype = SPDK_NVME_SGL_SUBTYPE_TRANSPORT; 725 sgl->generic.type = SPDK_NVME_SGL_TYPE_TRANSPORT_DATA_BLOCK; 726 sgl->unkeyed.length = UT_IO_UNIT_SIZE; 727 728 nvmf_capsule_data->fctype = SPDK_NVMF_FABRIC_COMMAND_CONNECT; 729 730 /* insert tcp_req1 to pending_buf_queue, And this req takes precedence over the next req. */ 731 nvmf_tcp_req_process(&ttransport, &tcp_req1); 732 CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req); 733 734 sgl->unkeyed.length = UT_IO_UNIT_SIZE - 1; 735 736 /* process tqpair capsule req. but we still remain req in pending_buff. */ 737 nvmf_tcp_capsule_cmd_hdr_handle(&ttransport, &tqpair, tqpair.pdu_in_progress); 738 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PAYLOAD); 739 CU_ASSERT(STAILQ_FIRST(&group->pending_buf_queue) == &tcp_req1.req); 740 STAILQ_FOREACH(req_temp, &group->pending_buf_queue, buf_link) { 741 if (req_temp == &tcp_req2.req) { 742 break; 743 } 744 } 745 CU_ASSERT(req_temp == NULL); 746 CU_ASSERT(tqpair.pdu_in_progress->req == (void *)&tcp_req2); 747 } 748 749 static void 750 test_nvmf_tcp_qpair_init_mem_resource(void) 751 { 752 int rc; 753 struct spdk_nvmf_tcp_qpair *tqpair = NULL; 754 struct spdk_nvmf_transport transport = {}; 755 struct spdk_thread *thread; 756 757 thread = spdk_thread_create(NULL, NULL); 758 SPDK_CU_ASSERT_FATAL(thread != NULL); 759 spdk_set_thread(thread); 760 761 tqpair = calloc(1, sizeof(*tqpair)); 762 tqpair->qpair.transport = &transport; 763 764 nvmf_tcp_opts_init(&transport.opts); 765 CU_ASSERT(transport.opts.max_queue_depth == SPDK_NVMF_TCP_DEFAULT_MAX_IO_QUEUE_DEPTH); 766 CU_ASSERT(transport.opts.max_qpairs_per_ctrlr == SPDK_NVMF_TCP_DEFAULT_MAX_QPAIRS_PER_CTRLR); 767 CU_ASSERT(transport.opts.in_capsule_data_size == SPDK_NVMF_TCP_DEFAULT_IN_CAPSULE_DATA_SIZE); 768 CU_ASSERT(transport.opts.max_io_size == SPDK_NVMF_TCP_DEFAULT_MAX_IO_SIZE); 769 CU_ASSERT(transport.opts.io_unit_size == SPDK_NVMF_TCP_DEFAULT_IO_UNIT_SIZE); 770 CU_ASSERT(transport.opts.max_aq_depth == SPDK_NVMF_TCP_DEFAULT_MAX_ADMIN_QUEUE_DEPTH); 771 CU_ASSERT(transport.opts.num_shared_buffers == SPDK_NVMF_TCP_DEFAULT_NUM_SHARED_BUFFERS); 772 CU_ASSERT(transport.opts.buf_cache_size == SPDK_NVMF_TCP_DEFAULT_BUFFER_CACHE_SIZE); 773 CU_ASSERT(transport.opts.dif_insert_or_strip == SPDK_NVMF_TCP_DEFAULT_DIF_INSERT_OR_STRIP); 774 CU_ASSERT(transport.opts.abort_timeout_sec == SPDK_NVMF_TCP_DEFAULT_ABORT_TIMEOUT_SEC); 775 CU_ASSERT(transport.opts.transport_specific == NULL); 776 777 rc = nvmf_tcp_qpair_init(&tqpair->qpair); 778 CU_ASSERT(rc == 0); 779 CU_ASSERT(tqpair->host_hdgst_enable == true); 780 CU_ASSERT(tqpair->host_ddgst_enable == true); 781 782 rc = nvmf_tcp_qpair_init_mem_resource(tqpair); 783 CU_ASSERT(rc == 0); 784 CU_ASSERT(tqpair->resource_count == SPDK_NVMF_TCP_DEFAULT_MAX_IO_QUEUE_DEPTH); 785 CU_ASSERT(tqpair->reqs != NULL); 786 CU_ASSERT(tqpair->bufs != NULL); 787 CU_ASSERT(tqpair->pdus != NULL); 788 /* Just to check the first and last entry */ 789 CU_ASSERT(tqpair->reqs[0].ttag == 1); 790 CU_ASSERT(tqpair->reqs[0].req.qpair == &tqpair->qpair); 791 CU_ASSERT(tqpair->reqs[0].pdu == &tqpair->pdus[0]); 792 CU_ASSERT(tqpair->reqs[0].pdu->qpair == &tqpair->qpair); 793 CU_ASSERT(tqpair->reqs[0].buf == (void *)((uintptr_t)tqpair->bufs)); 794 CU_ASSERT(tqpair->reqs[0].req.rsp == (void *)&tqpair->reqs[0].rsp); 795 CU_ASSERT(tqpair->reqs[0].req.cmd == (void *)&tqpair->reqs[0].cmd); 796 CU_ASSERT(tqpair->reqs[0].state == TCP_REQUEST_STATE_FREE); 797 CU_ASSERT(tqpair->reqs[127].ttag == 128); 798 CU_ASSERT(tqpair->reqs[127].req.qpair == &tqpair->qpair); 799 CU_ASSERT(tqpair->reqs[127].pdu == &tqpair->pdus[127]); 800 CU_ASSERT(tqpair->reqs[127].pdu->qpair == &tqpair->qpair); 801 CU_ASSERT(tqpair->reqs[127].buf == (void *)((uintptr_t)tqpair->bufs) + 127 * 4096); 802 CU_ASSERT(tqpair->reqs[127].req.rsp == (void *)&tqpair->reqs[127].rsp); 803 CU_ASSERT(tqpair->reqs[127].req.cmd == (void *)&tqpair->reqs[127].cmd); 804 CU_ASSERT(tqpair->reqs[127].state == TCP_REQUEST_STATE_FREE); 805 CU_ASSERT(tqpair->state_cntr[TCP_REQUEST_STATE_FREE] == SPDK_NVMF_TCP_DEFAULT_MAX_IO_QUEUE_DEPTH); 806 CU_ASSERT(tqpair->mgmt_pdu == &tqpair->pdus[2 * SPDK_NVMF_TCP_DEFAULT_MAX_IO_QUEUE_DEPTH]); 807 CU_ASSERT(tqpair->mgmt_pdu->qpair == tqpair); 808 CU_ASSERT(tqpair->pdu_in_progress == 809 &tqpair->pdus[2 * SPDK_NVMF_TCP_DEFAULT_MAX_IO_QUEUE_DEPTH - 1]); 810 CU_ASSERT(tqpair->recv_buf_size == (4096 + sizeof(struct spdk_nvme_tcp_cmd) + 2 * 811 SPDK_NVME_TCP_DIGEST_LEN) * SPDK_NVMF_TCP_RECV_BUF_SIZE_FACTOR); 812 813 /* Free all of tqpair resource */ 814 nvmf_tcp_qpair_destroy(tqpair); 815 816 spdk_thread_exit(thread); 817 while (!spdk_thread_is_exited(thread)) { 818 spdk_thread_poll(thread, 0, 0); 819 } 820 spdk_thread_destroy(thread); 821 } 822 823 static void 824 test_nvmf_tcp_send_c2h_term_req(void) 825 { 826 struct spdk_nvmf_tcp_qpair tqpair = {}; 827 struct nvme_tcp_pdu pdu = {}, mgmt_pdu = {}, pdu_in_progress = {}; 828 enum spdk_nvme_tcp_term_req_fes fes = SPDK_NVME_TCP_TERM_REQ_FES_INVALID_HEADER_FIELD; 829 uint32_t error_offset = 1; 830 831 mgmt_pdu.qpair = &tqpair; 832 tqpair.mgmt_pdu = &mgmt_pdu; 833 tqpair.pdu_in_progress = &pdu_in_progress; 834 tqpair.tcp_pdu_working_count = 1; 835 836 /* case1: hlen < SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE, Expect: copy_len == hlen */ 837 pdu.hdr.common.hlen = 64; 838 nvmf_tcp_send_c2h_term_req(&tqpair, &pdu, fes, error_offset); 839 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 840 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 841 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 842 pdu.hdr.common.hlen); 843 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 844 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fes == SPDK_NVME_TCP_TERM_REQ_FES_INVALID_HEADER_FIELD); 845 846 /* case2: hlen > SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE, Expect: copy_len == SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE */ 847 pdu.hdr.common.hlen = 255; 848 nvmf_tcp_send_c2h_term_req(&tqpair, &pdu, fes, error_offset); 849 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 850 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 851 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == (unsigned) 852 tqpair.mgmt_pdu->hdr.term_req.common.hlen + SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE); 853 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 854 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fes == SPDK_NVME_TCP_TERM_REQ_FES_INVALID_HEADER_FIELD); 855 } 856 857 static void 858 test_nvmf_tcp_send_capsule_resp_pdu(void) 859 { 860 struct spdk_nvmf_tcp_req tcp_req = {}; 861 struct spdk_nvmf_tcp_qpair tqpair = {}; 862 struct nvme_tcp_pdu pdu = {}; 863 864 tcp_req.pdu_in_use = false; 865 tcp_req.req.qpair = &tqpair.qpair; 866 tcp_req.pdu = &pdu; 867 tcp_req.req.rsp = (union nvmf_c2h_msg *)&tcp_req.rsp; 868 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 869 tqpair.host_hdgst_enable = true; 870 871 nvmf_tcp_send_capsule_resp_pdu(&tcp_req, &tqpair); 872 CU_ASSERT(pdu.hdr.capsule_resp.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_CAPSULE_RESP); 873 CU_ASSERT(pdu.hdr.capsule_resp.common.plen == sizeof(struct spdk_nvme_tcp_rsp) + 874 SPDK_NVME_TCP_DIGEST_LEN); 875 CU_ASSERT(pdu.hdr.capsule_resp.common.hlen == sizeof(struct spdk_nvme_tcp_rsp)); 876 CU_ASSERT(!memcmp(&pdu.hdr.capsule_resp.rccqe, &tcp_req.req.rsp->nvme_cpl, 877 sizeof(struct spdk_nvme_cpl))); 878 CU_ASSERT(pdu.hdr.capsule_resp.common.flags & SPDK_NVME_TCP_CH_FLAGS_HDGSTF); 879 CU_ASSERT(pdu.cb_fn == nvmf_tcp_request_free); 880 CU_ASSERT(pdu.cb_arg == &tcp_req); 881 CU_ASSERT(pdu.iov[0].iov_base == &pdu.hdr.raw); 882 CU_ASSERT(pdu.iov[0].iov_len == sizeof(struct spdk_nvme_tcp_rsp) + SPDK_NVME_TCP_DIGEST_LEN); 883 884 /* hdgst disable */ 885 tqpair.host_hdgst_enable = false; 886 tcp_req.pdu_in_use = false; 887 memset(&pdu, 0, sizeof(pdu)); 888 889 nvmf_tcp_send_capsule_resp_pdu(&tcp_req, &tqpair); 890 CU_ASSERT(pdu.hdr.capsule_resp.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_CAPSULE_RESP); 891 CU_ASSERT(pdu.hdr.capsule_resp.common.plen == sizeof(struct spdk_nvme_tcp_rsp)); 892 CU_ASSERT(pdu.hdr.capsule_resp.common.hlen == sizeof(struct spdk_nvme_tcp_rsp)); 893 CU_ASSERT(!memcmp(&pdu.hdr.capsule_resp.rccqe, &tcp_req.req.rsp->nvme_cpl, 894 sizeof(struct spdk_nvme_cpl))); 895 CU_ASSERT(!(pdu.hdr.capsule_resp.common.flags & SPDK_NVME_TCP_CH_FLAGS_HDGSTF)); 896 CU_ASSERT(pdu.cb_fn == nvmf_tcp_request_free); 897 CU_ASSERT(pdu.cb_arg == &tcp_req); 898 CU_ASSERT(pdu.iov[0].iov_base == &pdu.hdr.raw); 899 CU_ASSERT(pdu.iov[0].iov_len == sizeof(struct spdk_nvme_tcp_rsp)); 900 } 901 902 static void 903 test_nvmf_tcp_icreq_handle(void) 904 { 905 struct spdk_nvmf_tcp_transport ttransport = {}; 906 struct spdk_nvmf_tcp_qpair tqpair = {}; 907 struct nvme_tcp_pdu pdu = {}; 908 struct nvme_tcp_pdu mgmt_pdu = {}; 909 struct nvme_tcp_pdu pdu_in_progress = {}; 910 struct spdk_nvme_tcp_ic_resp *ic_resp; 911 912 mgmt_pdu.qpair = &tqpair; 913 tqpair.mgmt_pdu = &mgmt_pdu; 914 tqpair.pdu_in_progress = &pdu_in_progress; 915 tqpair.tcp_pdu_working_count = 1; 916 917 /* case 1: Expected ICReq PFV 0 and got are different. */ 918 pdu.hdr.ic_req.pfv = 1; 919 920 nvmf_tcp_icreq_handle(&ttransport, &tqpair, &pdu); 921 922 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 923 924 /* case 2: Expected ICReq HPDA in range 0-31 and got are different. */ 925 pdu.hdr.ic_req.hpda = SPDK_NVME_TCP_HPDA_MAX + 1; 926 927 nvmf_tcp_icreq_handle(&ttransport, &tqpair, &pdu); 928 929 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 930 931 /* case 3: Expect: PASS. */ 932 ttransport.transport.opts.max_io_size = 32; 933 pdu.hdr.ic_req.pfv = 0; 934 tqpair.host_hdgst_enable = false; 935 tqpair.host_ddgst_enable = false; 936 tqpair.recv_buf_size = 64; 937 pdu.hdr.ic_req.hpda = 16; 938 939 nvmf_tcp_icreq_handle(&ttransport, &tqpair, &pdu); 940 941 ic_resp = &tqpair.mgmt_pdu->hdr.ic_resp; 942 CU_ASSERT(tqpair.recv_buf_size == MIN_SOCK_PIPE_SIZE); 943 CU_ASSERT(tqpair.cpda == pdu.hdr.ic_req.hpda); 944 CU_ASSERT(ic_resp->common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_IC_RESP); 945 CU_ASSERT(ic_resp->common.hlen == sizeof(struct spdk_nvme_tcp_ic_resp)); 946 CU_ASSERT(ic_resp->common.plen == sizeof(struct spdk_nvme_tcp_ic_resp)); 947 CU_ASSERT(ic_resp->pfv == 0); 948 CU_ASSERT(ic_resp->cpda == tqpair.cpda); 949 CU_ASSERT(ic_resp->maxh2cdata == ttransport.transport.opts.max_io_size); 950 CU_ASSERT(ic_resp->dgst.bits.hdgst_enable == 0); 951 CU_ASSERT(ic_resp->dgst.bits.ddgst_enable == 0); 952 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_READY); 953 } 954 955 static void 956 test_nvmf_tcp_check_xfer_type(void) 957 { 958 const uint16_t cid = 0xAA; 959 struct spdk_nvmf_tcp_transport ttransport = {}; 960 struct spdk_nvmf_tcp_qpair tqpair = {}; 961 struct nvme_tcp_pdu pdu_in_progress = {}; 962 union nvmf_c2h_msg rsp0 = {}; 963 964 struct spdk_nvmf_tcp_req tcp_req = {}; 965 struct nvme_tcp_pdu rsp_pdu = {}; 966 967 struct spdk_nvme_tcp_cmd *capsule_data; 968 struct spdk_nvme_sgl_descriptor *sgl; 969 970 struct spdk_nvmf_transport_poll_group *group; 971 struct spdk_nvmf_tcp_poll_group tcp_group = {}; 972 struct spdk_sock_group grp = {}; 973 974 tqpair.pdu_in_progress = &pdu_in_progress; 975 ttransport.transport.opts.max_io_size = UT_MAX_IO_SIZE; 976 ttransport.transport.opts.io_unit_size = UT_IO_UNIT_SIZE; 977 978 tcp_group.sock_group = &grp; 979 TAILQ_INIT(&tcp_group.qpairs); 980 group = &tcp_group.group; 981 group->transport = &ttransport.transport; 982 STAILQ_INIT(&group->pending_buf_queue); 983 tqpair.group = &tcp_group; 984 985 TAILQ_INIT(&tqpair.tcp_req_free_queue); 986 TAILQ_INIT(&tqpair.tcp_req_working_queue); 987 988 tqpair.qpair.transport = &ttransport.transport; 989 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 990 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH; 991 tqpair.qpair.state = SPDK_NVMF_QPAIR_ACTIVE; 992 993 /* init tcp_req */ 994 tcp_req.req.qpair = &tqpair.qpair; 995 tcp_req.pdu = &rsp_pdu; 996 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 997 tcp_req.req.rsp = &rsp0; 998 tcp_req.state = TCP_REQUEST_STATE_NEW; 999 1000 TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, &tcp_req, state_link); 1001 tqpair.state_cntr[TCP_REQUEST_STATE_NEW]++; 1002 1003 /* init pdu, make pdu need sgl buff */ 1004 capsule_data = &tqpair.pdu_in_progress->hdr.capsule_cmd; 1005 sgl = &capsule_data->ccsqe.dptr.sgl1; 1006 1007 capsule_data->common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 1008 capsule_data->common.hlen = sizeof(*capsule_data); 1009 capsule_data->common.plen = 1096; 1010 capsule_data->ccsqe.opc = 0x10 | SPDK_NVME_DATA_BIDIRECTIONAL; 1011 /* Need to set to a non zero valid to check it gets copied to the response */ 1012 capsule_data->ccsqe.cid = cid; 1013 1014 /* Set up SGL to ensure nvmf_tcp_req_parse_sgl returns an error */ 1015 sgl->unkeyed.subtype = SPDK_NVME_SGL_SUBTYPE_TRANSPORT; 1016 sgl->generic.type = SPDK_NVME_SGL_TYPE_TRANSPORT_DATA_BLOCK; 1017 sgl->unkeyed.length = UT_IO_UNIT_SIZE; 1018 1019 /* Process a command and ensure that it fails and the request is set up to return an error */ 1020 nvmf_tcp_req_process(&ttransport, &tcp_req); 1021 CU_ASSERT(STAILQ_EMPTY(&group->pending_buf_queue)); 1022 CU_ASSERT(tcp_req.state == TCP_REQUEST_STATE_TRANSFERRING_CONTROLLER_TO_HOST); 1023 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_READY); 1024 CU_ASSERT(tcp_req.req.rsp->nvme_cpl.cid == cid); 1025 CU_ASSERT(tcp_req.req.rsp->nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 1026 CU_ASSERT(tcp_req.req.rsp->nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_OPCODE); 1027 } 1028 1029 static void 1030 test_nvmf_tcp_invalid_sgl(void) 1031 { 1032 const uint16_t cid = 0xAABB; 1033 struct spdk_nvmf_tcp_transport ttransport = {}; 1034 struct spdk_nvmf_tcp_qpair tqpair = {}; 1035 struct nvme_tcp_pdu pdu_in_progress = {}; 1036 union nvmf_c2h_msg rsp0 = {}; 1037 1038 struct spdk_nvmf_tcp_req tcp_req = {}; 1039 struct nvme_tcp_pdu rsp_pdu = {}; 1040 struct nvme_tcp_pdu mgmt_pdu = {}; 1041 1042 struct spdk_nvme_tcp_cmd *capsule_data; 1043 struct spdk_nvme_sgl_descriptor *sgl; 1044 1045 struct spdk_nvmf_transport_poll_group *group; 1046 struct spdk_nvmf_tcp_poll_group tcp_group = {}; 1047 struct spdk_sock_group grp = {}; 1048 1049 tqpair.pdu_in_progress = &pdu_in_progress; 1050 ttransport.transport.opts.max_io_size = UT_MAX_IO_SIZE; 1051 ttransport.transport.opts.io_unit_size = UT_IO_UNIT_SIZE; 1052 1053 tcp_group.sock_group = &grp; 1054 TAILQ_INIT(&tcp_group.qpairs); 1055 group = &tcp_group.group; 1056 group->transport = &ttransport.transport; 1057 STAILQ_INIT(&group->pending_buf_queue); 1058 tqpair.group = &tcp_group; 1059 1060 TAILQ_INIT(&tqpair.tcp_req_free_queue); 1061 TAILQ_INIT(&tqpair.tcp_req_working_queue); 1062 1063 tqpair.qpair.transport = &ttransport.transport; 1064 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1065 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH; 1066 tqpair.qpair.state = SPDK_NVMF_QPAIR_ACTIVE; 1067 1068 /* init tcp_req */ 1069 tcp_req.req.qpair = &tqpair.qpair; 1070 tcp_req.pdu = &rsp_pdu; 1071 tcp_req.pdu->qpair = &tqpair; 1072 tqpair.mgmt_pdu = &mgmt_pdu; 1073 tqpair.mgmt_pdu->qpair = &tqpair; 1074 tcp_req.req.cmd = (union nvmf_h2c_msg *)&tcp_req.cmd; 1075 tcp_req.req.rsp = &rsp0; 1076 tcp_req.state = TCP_REQUEST_STATE_NEW; 1077 1078 TAILQ_INSERT_TAIL(&tqpair.tcp_req_working_queue, &tcp_req, state_link); 1079 tqpair.state_cntr[TCP_REQUEST_STATE_NEW]++; 1080 1081 /* init pdu, make pdu need sgl buff */ 1082 capsule_data = &tqpair.pdu_in_progress->hdr.capsule_cmd; 1083 sgl = &capsule_data->ccsqe.dptr.sgl1; 1084 1085 capsule_data->common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 1086 capsule_data->common.hlen = sizeof(*capsule_data); 1087 capsule_data->common.plen = 1096; 1088 capsule_data->ccsqe.opc = SPDK_NVME_OPC_WRITE; 1089 /* Need to set to a non zero valid to check it gets copied to the response */ 1090 capsule_data->ccsqe.cid = cid; 1091 1092 /* Set up SGL to ensure nvmf_tcp_req_parse_sgl returns an error */ 1093 sgl->unkeyed.subtype = SPDK_NVME_SGL_SUBTYPE_TRANSPORT; 1094 sgl->generic.type = SPDK_NVME_SGL_TYPE_TRANSPORT_DATA_BLOCK; 1095 sgl->unkeyed.length = UT_MAX_IO_SIZE + 1; 1096 1097 /* Process a command and ensure that it fails and the request is set up to return an error */ 1098 nvmf_tcp_req_process(&ttransport, &tcp_req); 1099 CU_ASSERT(!STAILQ_EMPTY(&group->pending_buf_queue)); 1100 CU_ASSERT(tcp_req.state == TCP_REQUEST_STATE_NEED_BUFFER); 1101 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1102 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1103 } 1104 1105 static void 1106 test_nvmf_tcp_pdu_ch_handle(void) 1107 { 1108 struct spdk_nvmf_tcp_qpair tqpair = {}; 1109 struct nvme_tcp_pdu mgmt_pdu = {}, pdu_in_progress = {}; 1110 1111 mgmt_pdu.qpair = &tqpair; 1112 tqpair.mgmt_pdu = &mgmt_pdu; 1113 tqpair.pdu_in_progress = &pdu_in_progress; 1114 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1115 tqpair.cpda = 0; 1116 1117 /* Test case: Already received ICreq PDU. Expect: fail */ 1118 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_IC_REQ; 1119 tqpair.state = NVME_TCP_QPAIR_STATE_INITIALIZING; 1120 nvmf_tcp_pdu_ch_handle(&tqpair); 1121 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1122 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1123 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1124 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen); 1125 1126 /* Test case: Expected PDU header length and received are different. Expect: fail */ 1127 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1128 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_IC_REQ; 1129 tqpair.state = NVME_TCP_QPAIR_STATE_INVALID; 1130 tqpair.pdu_in_progress->hdr.common.plen = sizeof(struct spdk_nvme_tcp_ic_req); 1131 tqpair.pdu_in_progress->hdr.common.hlen = 0; 1132 nvmf_tcp_pdu_ch_handle(&tqpair); 1133 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1134 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1135 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1136 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen); 1137 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 2); 1138 1139 /* Test case: The TCP/IP tqpair connection is not negotitated. Expect: fail */ 1140 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1141 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_IC_RESP; 1142 tqpair.state = NVME_TCP_QPAIR_STATE_INVALID; 1143 tqpair.pdu_in_progress->hdr.common.plen = sizeof(struct spdk_nvme_tcp_ic_req); 1144 tqpair.pdu_in_progress->hdr.common.hlen = 0; 1145 nvmf_tcp_pdu_ch_handle(&tqpair); 1146 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1147 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1148 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1149 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen); 1150 1151 /* Test case: Unexpected PDU type. Expect: fail */ 1152 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1153 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_RESP; 1154 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1155 tqpair.pdu_in_progress->hdr.common.plen = 0; 1156 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_ic_req); 1157 nvmf_tcp_pdu_ch_handle(&tqpair); 1158 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1159 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1160 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1161 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 1162 (unsigned)SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE); 1163 1164 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_IC_REQ, let plen error. Expect: fail */ 1165 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1166 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_IC_REQ; 1167 tqpair.state = NVME_TCP_QPAIR_STATE_INVALID; 1168 tqpair.pdu_in_progress->hdr.common.plen = 0; 1169 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_ic_req); 1170 nvmf_tcp_pdu_ch_handle(&tqpair); 1171 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1172 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1173 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1174 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 1175 (unsigned)SPDK_NVME_TCP_TERM_REQ_ERROR_DATA_MAX_SIZE); 1176 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 4); 1177 1178 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD, let plen error. Expect: fail */ 1179 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1180 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 1181 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1182 tqpair.pdu_in_progress->hdr.common.flags = SPDK_NVME_TCP_CH_FLAGS_HDGSTF; 1183 tqpair.pdu_in_progress->hdr.common.plen = 0; 1184 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_cmd); 1185 nvmf_tcp_pdu_ch_handle(&tqpair); 1186 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1187 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1188 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1189 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == sizeof(struct spdk_nvme_tcp_cmd) + sizeof( 1190 struct spdk_nvme_tcp_term_req_hdr)); 1191 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 4); 1192 1193 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_H2C_DATA, let plen error. Expect: fail */ 1194 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1195 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_H2C_DATA; 1196 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1197 tqpair.pdu_in_progress->hdr.common.plen = 0; 1198 tqpair.pdu_in_progress->hdr.common.pdo = 64; 1199 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_h2c_data_hdr); 1200 nvmf_tcp_pdu_ch_handle(&tqpair); 1201 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1202 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1203 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1204 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 1205 (unsigned)sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1206 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 4); 1207 1208 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_H2C_TERM_REQ, let plen error. Expect: fail */ 1209 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1210 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_H2C_TERM_REQ; 1211 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1212 tqpair.pdu_in_progress->hdr.common.plen = 0; 1213 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_term_req_hdr); 1214 nvmf_tcp_pdu_ch_handle(&tqpair); 1215 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1216 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1217 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1218 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 1219 (unsigned)sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1220 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 4); 1221 1222 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD, let pdo error. Expect: fail */ 1223 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1224 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_CAPSULE_CMD; 1225 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1226 tqpair.cpda = 1; 1227 tqpair.pdu_in_progress->hdr.common.flags = SPDK_NVME_TCP_CH_FLAGS_HDGSTF; 1228 tqpair.pdu_in_progress->hdr.common.plen = 0; 1229 tqpair.pdu_in_progress->hdr.common.pdo = 63; 1230 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_cmd); 1231 nvmf_tcp_pdu_ch_handle(&tqpair); 1232 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1233 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1234 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1235 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == sizeof(struct spdk_nvme_tcp_cmd) + sizeof( 1236 struct spdk_nvme_tcp_term_req_hdr)); 1237 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 3); 1238 1239 /* Test case: PDU type is SPDK_NVME_TCP_PDU_TYPE_H2C_DATA, let pdo error. Expect: fail */ 1240 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1241 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_H2C_DATA; 1242 tqpair.state = NVME_TCP_QPAIR_STATE_RUNNING; 1243 tqpair.cpda = 1; 1244 tqpair.pdu_in_progress->hdr.common.plen = 0; 1245 tqpair.pdu_in_progress->hdr.common.pdo = 63; 1246 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_h2c_data_hdr); 1247 nvmf_tcp_pdu_ch_handle(&tqpair); 1248 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_QUIESCING); 1249 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.pdu_type == SPDK_NVME_TCP_PDU_TYPE_C2H_TERM_REQ); 1250 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.hlen == sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1251 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.common.plen == tqpair.mgmt_pdu->hdr.term_req.common.hlen + 1252 (unsigned)sizeof(struct spdk_nvme_tcp_term_req_hdr)); 1253 CU_ASSERT(tqpair.mgmt_pdu->hdr.term_req.fei[0] == 3); 1254 1255 /* Test case: All parameters is conformed to the function. Expect: PASS */ 1256 tqpair.recv_state = NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_CH; 1257 tqpair.pdu_in_progress->hdr.common.pdu_type = SPDK_NVME_TCP_PDU_TYPE_IC_REQ; 1258 tqpair.state = NVME_TCP_QPAIR_STATE_INVALID; 1259 tqpair.pdu_in_progress->hdr.common.plen = sizeof(struct spdk_nvme_tcp_ic_req); 1260 tqpair.pdu_in_progress->hdr.common.hlen = sizeof(struct spdk_nvme_tcp_ic_req); 1261 nvmf_tcp_pdu_ch_handle(&tqpair); 1262 CU_ASSERT(tqpair.recv_state == NVME_TCP_PDU_RECV_STATE_AWAIT_PDU_PSH); 1263 CU_ASSERT(tqpair.pdu_in_progress->psh_len == tqpair.pdu_in_progress->hdr.common.hlen - sizeof( 1264 struct spdk_nvme_tcp_common_pdu_hdr)); 1265 } 1266 1267 static void 1268 test_nvmf_tcp_tls_add_remove_credentials(void) 1269 { 1270 struct spdk_thread *thread; 1271 struct spdk_nvmf_transport *transport; 1272 struct spdk_nvmf_tcp_transport *ttransport; 1273 struct spdk_nvmf_transport_opts opts; 1274 struct spdk_nvmf_subsystem subsystem; 1275 struct tcp_psk_entry *entry; 1276 const char subnqn[] = {"nqn.2016-06.io.spdk:cnode1"}; 1277 const char hostnqn[] = {"nqn.2016-06.io.spdk:host1"}; 1278 const char *psk = "NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:"; 1279 char *psk_file_path = "/tmp/psk.txt"; 1280 bool found = false; 1281 FILE *psk_file = NULL; 1282 mode_t oldmask; 1283 1284 thread = spdk_thread_create(NULL, NULL); 1285 SPDK_CU_ASSERT_FATAL(thread != NULL); 1286 spdk_set_thread(thread); 1287 1288 memset(&opts, 0, sizeof(opts)); 1289 opts.max_queue_depth = UT_MAX_QUEUE_DEPTH; 1290 opts.max_qpairs_per_ctrlr = UT_MAX_QPAIRS_PER_CTRLR; 1291 opts.in_capsule_data_size = UT_IN_CAPSULE_DATA_SIZE; 1292 opts.max_io_size = UT_MAX_IO_SIZE; 1293 opts.io_unit_size = UT_IO_UNIT_SIZE; 1294 opts.max_aq_depth = UT_MAX_AQ_DEPTH; 1295 opts.num_shared_buffers = UT_NUM_SHARED_BUFFERS; 1296 transport = nvmf_tcp_create(&opts); 1297 1298 memset(&subsystem, 0, sizeof(subsystem)); 1299 snprintf(subsystem.subnqn, sizeof(subsystem.subnqn), "%s", subnqn); 1300 1301 /* Create a text file containing PSK in interchange format. */ 1302 oldmask = umask(S_IXUSR | S_IRWXG | S_IRWXO); 1303 psk_file = fopen(psk_file_path, "w"); 1304 CU_ASSERT(psk_file != NULL); 1305 CU_ASSERT(fprintf(psk_file, "%s", psk) > 0); 1306 CU_ASSERT(fclose(psk_file) == 0); 1307 umask(oldmask); 1308 1309 struct spdk_json_val psk_json[] = { 1310 {"", 2, SPDK_JSON_VAL_OBJECT_BEGIN}, 1311 {"psk", 3, SPDK_JSON_VAL_NAME}, 1312 {psk_file_path, strlen(psk_file_path), SPDK_JSON_VAL_STRING}, 1313 {"", 0, SPDK_JSON_VAL_OBJECT_END}, 1314 }; 1315 1316 nvmf_tcp_subsystem_add_host(transport, &subsystem, hostnqn, psk_json); 1317 1318 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 1319 TAILQ_FOREACH(entry, &ttransport->psks, link) { 1320 if ((strcmp(subnqn, entry->subnqn) == 0) && 1321 (strcmp(hostnqn, entry->hostnqn) == 0)) { 1322 found = true; 1323 } 1324 } 1325 1326 CU_ASSERT(found == true); 1327 found = false; 1328 1329 nvmf_tcp_subsystem_remove_host(transport, &subsystem, hostnqn); 1330 1331 ttransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_tcp_transport, transport); 1332 TAILQ_FOREACH(entry, &ttransport->psks, link) { 1333 if ((strcmp(subnqn, entry->subnqn) == 0) && 1334 (strcmp(hostnqn, entry->hostnqn) == 0)) { 1335 found = true; 1336 } 1337 } 1338 1339 CU_ASSERT(found == false); 1340 1341 CU_ASSERT(remove(psk_file_path) == 0); 1342 1343 CU_ASSERT(nvmf_tcp_destroy(transport, NULL, NULL) == 0); 1344 1345 spdk_thread_exit(thread); 1346 while (!spdk_thread_is_exited(thread)) { 1347 spdk_thread_poll(thread, 0, 0); 1348 } 1349 spdk_thread_destroy(thread); 1350 } 1351 1352 static void 1353 test_nvmf_tcp_tls_generate_psk_id(void) 1354 { 1355 const char psk_id_reference[] = {"NVMe0R01 nqn.2016-06.io.spdk:host1 nqn.2016-06.io.spdk:cnode1"}; 1356 const char subnqn[] = {"nqn.2016-06.io.spdk:cnode1"}; 1357 const char hostnqn[] = {"nqn.2016-06.io.spdk:host1"}; 1358 char psk_id[NVMF_PSK_IDENTITY_LEN] = {}; 1359 char too_small_psk_id[5] = {}; 1360 1361 /* Check if we can generate expected PSK id. */ 1362 CU_ASSERT(nvme_tcp_generate_psk_identity(psk_id, NVMF_PSK_IDENTITY_LEN, hostnqn, 1363 subnqn, NVME_TCP_CIPHER_AES_128_GCM_SHA256) == 0); 1364 CU_ASSERT(strcmp(psk_id, psk_id_reference) == 0); 1365 1366 /* Test with a buffer that is too small to fit PSK id. */ 1367 CU_ASSERT(nvme_tcp_generate_psk_identity(too_small_psk_id, sizeof(too_small_psk_id), hostnqn, 1368 subnqn, NVME_TCP_CIPHER_AES_128_GCM_SHA256) != 0); 1369 1370 /* Test with unknown cipher suite. */ 1371 CU_ASSERT(nvme_tcp_generate_psk_identity(psk_id, NVMF_PSK_IDENTITY_LEN, hostnqn, 1372 subnqn, UINT8_MAX) != 0); 1373 } 1374 1375 static void 1376 test_nvmf_tcp_tls_generate_retained_psk(void) 1377 { 1378 const char hostnqn[] = {"nqn.2016-06.io.spdk:host1"}; 1379 const char psk_reference1[] = {"1234567890ABCDEF"}; 1380 const char psk_reference2[] = {"FEDCBA0987654321"}; 1381 uint8_t unhexlified_str1[SPDK_TLS_PSK_MAX_LEN] = {}; 1382 uint8_t unhexlified_str2[SPDK_TLS_PSK_MAX_LEN] = {}; 1383 char *unhexlified1; 1384 char *unhexlified2; 1385 uint8_t psk_retained1[SPDK_TLS_PSK_MAX_LEN] = {}; 1386 uint8_t psk_retained2[SPDK_TLS_PSK_MAX_LEN] = {}; 1387 uint8_t too_small_psk_retained[5] = {}; 1388 int psk_retained_len1, psk_retained_len2; 1389 int retained_size; 1390 1391 unhexlified1 = spdk_unhexlify(psk_reference1); 1392 SPDK_CU_ASSERT_FATAL(unhexlified1 != NULL); 1393 unhexlified2 = spdk_unhexlify(psk_reference2); 1394 SPDK_CU_ASSERT_FATAL(unhexlified2 != NULL); 1395 1396 memcpy(unhexlified_str1, unhexlified1, strlen(psk_reference1) / 2); 1397 memcpy(unhexlified_str2, unhexlified2, strlen(psk_reference2) / 2); 1398 free(unhexlified1); 1399 free(unhexlified2); 1400 1401 /* Make sure that retained PSKs are different with different input PSKs and the same hash. */ 1402 retained_size = nvme_tcp_derive_retained_psk(unhexlified_str1, strlen(psk_reference1) / 2, hostnqn, 1403 psk_retained1, SPDK_TLS_PSK_MAX_LEN, NVME_TCP_HASH_ALGORITHM_SHA256); 1404 CU_ASSERT(retained_size > 0); 1405 1406 CU_ASSERT(nvme_tcp_derive_retained_psk(unhexlified_str2, strlen(psk_reference2) / 2, hostnqn, 1407 psk_retained2, 1408 SPDK_TLS_PSK_MAX_LEN, NVME_TCP_HASH_ALGORITHM_SHA256) > 0); 1409 CU_ASSERT(memcmp(psk_retained1, psk_retained2, retained_size) != 0); 1410 1411 /* Make sure that retained PSKs are different with different hash and the same input PSKs. */ 1412 psk_retained_len1 = nvme_tcp_derive_retained_psk(unhexlified_str1, strlen(psk_reference1) / 2, 1413 hostnqn, psk_retained1, SPDK_TLS_PSK_MAX_LEN, NVME_TCP_HASH_ALGORITHM_SHA256); 1414 CU_ASSERT(psk_retained_len1 > 0); 1415 psk_retained_len2 = nvme_tcp_derive_retained_psk(unhexlified_str1, strlen(psk_reference1) / 2, 1416 hostnqn, psk_retained2, SPDK_TLS_PSK_MAX_LEN, NVME_TCP_HASH_ALGORITHM_SHA384); 1417 CU_ASSERT(psk_retained_len2 > 0); 1418 CU_ASSERT(psk_retained_len1 < psk_retained_len2); 1419 1420 /* Make sure that passing unknown value as hash errors out the function. */ 1421 CU_ASSERT(nvme_tcp_derive_retained_psk(unhexlified_str1, strlen(psk_reference1) / 2, hostnqn, 1422 psk_retained1, SPDK_TLS_PSK_MAX_LEN, -1) < 0); 1423 1424 /* Make sure that passing buffer insufficient in size errors out the function. */ 1425 CU_ASSERT(nvme_tcp_derive_retained_psk(unhexlified_str1, strlen(psk_reference1) / 2, hostnqn, 1426 too_small_psk_retained, sizeof(too_small_psk_retained), NVME_TCP_HASH_ALGORITHM_SHA256) < 0); 1427 } 1428 1429 static void 1430 test_nvmf_tcp_tls_generate_tls_psk(void) 1431 { 1432 const char psk_id_reference[] = {"NVMe0R01 nqn.2016-06.io.spdk:host1 nqn.2016-06.io.spdk:cnode1"}; 1433 const char hostnqn[] = {"nqn.2016-06.io.spdk:host1"}; 1434 const char psk_reference[] = {"1234567890ABCDEF"}; 1435 char *unhexlified; 1436 uint8_t unhexlified_str[SPDK_TLS_PSK_MAX_LEN] = {}; 1437 uint8_t psk_retained[SPDK_TLS_PSK_MAX_LEN] = {}; 1438 uint8_t psk_key1[SPDK_TLS_PSK_MAX_LEN] = {}, psk_key2[SPDK_TLS_PSK_MAX_LEN] = {}; 1439 uint8_t too_small_psk_tls[5] = {}; 1440 int retained_size, tls_size; 1441 1442 unhexlified = spdk_unhexlify(psk_reference); 1443 CU_ASSERT(unhexlified != NULL); 1444 1445 memcpy(unhexlified_str, unhexlified, strlen(psk_reference) / 2); 1446 free(unhexlified); 1447 1448 retained_size = nvme_tcp_derive_retained_psk(unhexlified_str, strlen(psk_reference) / 2, hostnqn, 1449 psk_retained, SPDK_TLS_PSK_MAX_LEN, NVME_TCP_HASH_ALGORITHM_SHA256); 1450 CU_ASSERT(retained_size > 0); 1451 1452 /* Make sure that different cipher suites produce different TLS PSKs. */ 1453 tls_size = nvme_tcp_derive_tls_psk(psk_retained, retained_size, psk_id_reference, psk_key1, 1454 SPDK_TLS_PSK_MAX_LEN, NVME_TCP_CIPHER_AES_128_GCM_SHA256); 1455 CU_ASSERT(tls_size > 0); 1456 CU_ASSERT(nvme_tcp_derive_tls_psk(psk_retained, retained_size, psk_id_reference, psk_key2, 1457 SPDK_TLS_PSK_MAX_LEN, NVME_TCP_CIPHER_AES_256_GCM_SHA384) > 0); 1458 CU_ASSERT(memcmp(psk_key1, psk_key2, tls_size) != 0); 1459 1460 /* Make sure that passing unknown value as hash errors out the function. */ 1461 CU_ASSERT(nvme_tcp_derive_tls_psk(psk_retained, retained_size, psk_id_reference, 1462 psk_key1, SPDK_TLS_PSK_MAX_LEN, UINT8_MAX) < 0); 1463 1464 /* Make sure that passing buffer insufficient in size errors out the function. */ 1465 CU_ASSERT(nvme_tcp_derive_tls_psk(psk_retained, retained_size, psk_id_reference, 1466 too_small_psk_tls, sizeof(too_small_psk_tls), 1467 NVME_TCP_CIPHER_AES_128_GCM_SHA256) < 0); 1468 } 1469 1470 int 1471 main(int argc, char **argv) 1472 { 1473 CU_pSuite suite = NULL; 1474 unsigned int num_failures; 1475 1476 CU_initialize_registry(); 1477 1478 suite = CU_add_suite("nvmf", NULL, NULL); 1479 1480 CU_ADD_TEST(suite, test_nvmf_tcp_create); 1481 CU_ADD_TEST(suite, test_nvmf_tcp_destroy); 1482 CU_ADD_TEST(suite, test_nvmf_tcp_poll_group_create); 1483 CU_ADD_TEST(suite, test_nvmf_tcp_send_c2h_data); 1484 CU_ADD_TEST(suite, test_nvmf_tcp_h2c_data_hdr_handle); 1485 CU_ADD_TEST(suite, test_nvmf_tcp_in_capsule_data_handle); 1486 CU_ADD_TEST(suite, test_nvmf_tcp_qpair_init_mem_resource); 1487 CU_ADD_TEST(suite, test_nvmf_tcp_send_c2h_term_req); 1488 CU_ADD_TEST(suite, test_nvmf_tcp_send_capsule_resp_pdu); 1489 CU_ADD_TEST(suite, test_nvmf_tcp_icreq_handle); 1490 CU_ADD_TEST(suite, test_nvmf_tcp_check_xfer_type); 1491 CU_ADD_TEST(suite, test_nvmf_tcp_invalid_sgl); 1492 CU_ADD_TEST(suite, test_nvmf_tcp_pdu_ch_handle); 1493 CU_ADD_TEST(suite, test_nvmf_tcp_tls_add_remove_credentials); 1494 CU_ADD_TEST(suite, test_nvmf_tcp_tls_generate_psk_id); 1495 CU_ADD_TEST(suite, test_nvmf_tcp_tls_generate_retained_psk); 1496 CU_ADD_TEST(suite, test_nvmf_tcp_tls_generate_tls_psk); 1497 1498 num_failures = spdk_ut_run_tests(argc, argv, NULL); 1499 CU_cleanup_registry(); 1500 return num_failures; 1501 } 1502