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