1 /* 2 * BSD LICENSE 3 * 4 * Copyright (c) 2018-2019 Broadcom. All Rights Reserved. 5 * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 /* NVMF FC Transport Unit Test */ 35 36 #include "spdk/env.h" 37 #include "spdk_cunit.h" 38 #include "spdk/nvmf.h" 39 #include "spdk_internal/event.h" 40 #include "spdk/endian.h" 41 #include "spdk/trace.h" 42 #include "spdk_internal/log.h" 43 44 #include "ut_multithread.c" 45 46 #include "transport.h" 47 #include "nvmf_internal.h" 48 49 #include "nvmf_fc.h" 50 51 #include "json/json_util.c" 52 #include "json/json_write.c" 53 #include "nvmf/nvmf.c" 54 #include "nvmf/transport.c" 55 #include "nvmf/subsystem.c" 56 #include "nvmf/fc.c" 57 #include "nvmf/fc_ls.c" 58 59 /* 60 * SPDK Stuff 61 */ 62 63 #ifdef SPDK_CONFIG_RDMA 64 const struct spdk_nvmf_transport_ops spdk_nvmf_transport_rdma = { 65 .type = SPDK_NVME_TRANSPORT_RDMA, 66 .opts_init = NULL, 67 .create = NULL, 68 .destroy = NULL, 69 70 .listen = NULL, 71 .stop_listen = NULL, 72 .accept = NULL, 73 74 .listener_discover = NULL, 75 76 .poll_group_create = NULL, 77 .poll_group_destroy = NULL, 78 .poll_group_add = NULL, 79 .poll_group_poll = NULL, 80 81 .req_free = NULL, 82 .req_complete = NULL, 83 84 .qpair_fini = NULL, 85 .qpair_get_peer_trid = NULL, 86 .qpair_get_local_trid = NULL, 87 .qpair_get_listen_trid = NULL, 88 }; 89 #endif 90 91 const struct spdk_nvmf_transport_ops spdk_nvmf_transport_tcp = { 92 .type = SPDK_NVME_TRANSPORT_TCP, 93 }; 94 95 struct spdk_trace_histories *g_trace_histories; 96 97 DEFINE_STUB_V(_spdk_trace_record, (uint64_t tsc, uint16_t tpoint_id, uint16_t poller_id, 98 uint32_t size, uint64_t object_id, uint64_t arg1)); 99 DEFINE_STUB(spdk_nvme_transport_id_compare, int, 100 (const struct spdk_nvme_transport_id *trid1, 101 const struct spdk_nvme_transport_id *trid2), 0); 102 DEFINE_STUB_V(spdk_trace_register_object, (uint8_t type, char id_prefix)); 103 DEFINE_STUB_V(spdk_trace_register_description, 104 (const char *name, uint16_t tpoint_id, uint8_t owner_type, 105 uint8_t object_type, uint8_t new_object, uint8_t arg1_type, 106 const char *arg1_name)); 107 DEFINE_STUB_V(spdk_trace_add_register_fn, (struct spdk_trace_register_fn *reg_fn)); 108 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), "fc_ut_test"); 109 DEFINE_STUB_V(nvmf_ctrlr_destruct, (struct spdk_nvmf_ctrlr *ctrlr)); 110 DEFINE_STUB_V(nvmf_qpair_free_aer, (struct spdk_nvmf_qpair *qpair)); 111 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *desc), 112 NULL); 113 DEFINE_STUB_V(spdk_nvmf_request_exec, (struct spdk_nvmf_request *req)); 114 DEFINE_STUB_V(nvmf_ctrlr_ns_changed, (struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid)); 115 DEFINE_STUB(spdk_bdev_open, int, (struct spdk_bdev *bdev, bool write, 116 spdk_bdev_remove_cb_t remove_cb, 117 void *remove_ctx, struct spdk_bdev_desc **desc), 0); 118 DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc)); 119 DEFINE_STUB(spdk_bdev_module_claim_bdev, int, 120 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 121 struct spdk_bdev_module *module), 0); 122 DEFINE_STUB_V(spdk_bdev_module_release_bdev, (struct spdk_bdev *bdev)); 123 DEFINE_STUB(spdk_bdev_get_block_size, uint32_t, (const struct spdk_bdev *bdev), 512); 124 DEFINE_STUB(spdk_bdev_get_num_blocks, uint64_t, (const struct spdk_bdev *bdev), 1024); 125 126 DEFINE_STUB(nvmf_ctrlr_async_event_ns_notice, int, (struct spdk_nvmf_ctrlr *ctrlr), 0); 127 DEFINE_STUB_V(spdk_nvme_trid_populate_transport, (struct spdk_nvme_transport_id *trid, 128 enum spdk_nvme_transport_type trtype)); 129 DEFINE_STUB_V(spdk_nvmf_ctrlr_data_init, (struct spdk_nvmf_transport_opts *opts, 130 struct spdk_nvmf_ctrlr_data *cdata)); 131 132 const char * 133 spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trtype) 134 { 135 switch (trtype) { 136 case SPDK_NVME_TRANSPORT_PCIE: 137 return "PCIe"; 138 case SPDK_NVME_TRANSPORT_RDMA: 139 return "RDMA"; 140 case SPDK_NVME_TRANSPORT_FC: 141 return "FC"; 142 default: 143 return NULL; 144 } 145 } 146 147 const char * 148 spdk_nvme_transport_id_adrfam_str(enum spdk_nvmf_adrfam adrfam) 149 { 150 switch (adrfam) { 151 case SPDK_NVMF_ADRFAM_IPV4: 152 return "IPv4"; 153 case SPDK_NVMF_ADRFAM_IPV6: 154 return "IPv6"; 155 case SPDK_NVMF_ADRFAM_IB: 156 return "IB"; 157 case SPDK_NVMF_ADRFAM_FC: 158 return "FC"; 159 default: 160 return NULL; 161 } 162 } 163 164 const struct spdk_uuid * 165 spdk_bdev_get_uuid(const struct spdk_bdev *bdev) 166 { 167 return &bdev->uuid; 168 } 169 170 static bool g_lld_init_called = false; 171 172 int 173 nvmf_fc_lld_init(void) 174 { 175 g_lld_init_called = true; 176 return 0; 177 } 178 179 static bool g_lld_fini_called = false; 180 181 void 182 nvmf_fc_lld_fini(void) 183 { 184 g_lld_fini_called = true; 185 } 186 187 DEFINE_STUB_V(nvmf_fc_lld_start, (void)); 188 DEFINE_STUB(nvmf_fc_init_q, int, (struct spdk_nvmf_fc_hwqp *hwqp), 0); 189 DEFINE_STUB_V(nvmf_fc_reinit_q, (void *queues_prev, void *queues_curr)); 190 DEFINE_STUB(nvmf_fc_init_rqpair_buffers, int, (struct spdk_nvmf_fc_hwqp *hwqp), 0); 191 DEFINE_STUB(nvmf_fc_set_q_online_state, int, (struct spdk_nvmf_fc_hwqp *hwqp, bool online), 0); 192 DEFINE_STUB(nvmf_fc_put_xchg, int, (struct spdk_nvmf_fc_hwqp *hwqp, struct spdk_nvmf_fc_xchg *xri), 193 0); 194 DEFINE_STUB(nvmf_fc_recv_data, int, (struct spdk_nvmf_fc_request *fc_req), 0); 195 DEFINE_STUB(nvmf_fc_send_data, int, (struct spdk_nvmf_fc_request *fc_req), 0); 196 DEFINE_STUB_V(nvmf_fc_rqpair_buffer_release, (struct spdk_nvmf_fc_hwqp *hwqp, uint16_t buff_idx)); 197 DEFINE_STUB(nvmf_fc_xmt_rsp, int, (struct spdk_nvmf_fc_request *fc_req, uint8_t *ersp_buf, 198 uint32_t ersp_len), 0); 199 DEFINE_STUB(nvmf_fc_xmt_ls_rsp, int, (struct spdk_nvmf_fc_nport *tgtport, 200 struct spdk_nvmf_fc_ls_rqst *ls_rqst), 0); 201 DEFINE_STUB(nvmf_fc_issue_abort, int, (struct spdk_nvmf_fc_hwqp *hwqp, 202 struct spdk_nvmf_fc_xchg *xri, 203 spdk_nvmf_fc_caller_cb cb, void *cb_args), 0); 204 DEFINE_STUB(nvmf_fc_xmt_bls_rsp, int, (struct spdk_nvmf_fc_hwqp *hwqp, 205 uint16_t ox_id, uint16_t rx_id, 206 uint16_t rpi, bool rjt, uint8_t rjt_exp, 207 spdk_nvmf_fc_caller_cb cb, void *cb_args), 0); 208 DEFINE_STUB(nvmf_fc_alloc_srsr_bufs, struct spdk_nvmf_fc_srsr_bufs *, (size_t rqst_len, 209 size_t rsp_len), NULL); 210 DEFINE_STUB_V(nvmf_fc_free_srsr_bufs, (struct spdk_nvmf_fc_srsr_bufs *srsr_bufs)); 211 DEFINE_STUB(nvmf_fc_xmt_srsr_req, int, (struct spdk_nvmf_fc_hwqp *hwqp, 212 struct spdk_nvmf_fc_srsr_bufs *xmt_srsr_bufs, 213 spdk_nvmf_fc_caller_cb cb, void *cb_args), 0); 214 DEFINE_STUB(nvmf_fc_q_sync_available, bool, (void), true); 215 DEFINE_STUB(nvmf_fc_issue_q_sync, int, (struct spdk_nvmf_fc_hwqp *hwqp, uint64_t u_id, 216 uint16_t skip_rq), 0); 217 DEFINE_STUB(nvmf_fc_assign_conn_to_hwqp, bool, (struct spdk_nvmf_fc_hwqp *hwqp, 218 uint64_t *conn_id, uint32_t sq_size), true); 219 DEFINE_STUB(nvmf_fc_get_hwqp_from_conn_id, struct spdk_nvmf_fc_hwqp *, 220 (struct spdk_nvmf_fc_hwqp *queues, 221 uint32_t num_queues, uint64_t conn_id), NULL); 222 DEFINE_STUB_V(nvmf_fc_release_conn, (struct spdk_nvmf_fc_hwqp *hwqp, uint64_t conn_id, 223 uint32_t sq_size)); 224 DEFINE_STUB_V(nvmf_fc_dump_all_queues, (struct spdk_nvmf_fc_hwqp *ls_queue, 225 struct spdk_nvmf_fc_hwqp *io_queues, 226 uint32_t num_io_queues, 227 struct spdk_nvmf_fc_queue_dump_info *dump_info)); 228 DEFINE_STUB_V(nvmf_fc_get_xri_info, (struct spdk_nvmf_fc_hwqp *hwqp, 229 struct spdk_nvmf_fc_xchg_info *info)); 230 DEFINE_STUB(nvmf_fc_get_rsvd_thread, struct spdk_thread *, (void), NULL); 231 232 uint32_t 233 nvmf_fc_process_queue(struct spdk_nvmf_fc_hwqp *hwqp) 234 { 235 hwqp->lcore_id++; 236 return 0; /* always return 0 or else it will poll forever */ 237 } 238 239 struct spdk_nvmf_fc_xchg * 240 nvmf_fc_get_xri(struct spdk_nvmf_fc_hwqp *hwqp) 241 { 242 static struct spdk_nvmf_fc_xchg xchg; 243 244 xchg.xchg_id = 1; 245 return &xchg; 246 } 247 248 #define MAX_FC_UT_POLL_THREADS 8 249 static struct spdk_nvmf_poll_group *g_poll_groups[MAX_FC_UT_POLL_THREADS] = {0}; 250 #define MAX_FC_UT_HWQPS MAX_FC_UT_POLL_THREADS 251 static struct spdk_nvmf_tgt *g_nvmf_tgt = NULL; 252 static struct spdk_nvmf_transport *g_nvmf_tprt = NULL; 253 uint8_t g_fc_port_handle = 0xff; 254 struct spdk_nvmf_fc_hwqp lld_q[MAX_FC_UT_HWQPS]; 255 256 static void 257 _add_transport_done(void *arg, int status) 258 { 259 CU_ASSERT(status == 0); 260 } 261 262 static void 263 _add_transport_done_dup_err(void *arg, int status) 264 { 265 CU_ASSERT(status == -EEXIST); 266 } 267 268 static void 269 create_transport_test(void) 270 { 271 const struct spdk_nvmf_transport_ops *ops = NULL; 272 struct spdk_nvmf_transport_opts opts = { 0 }; 273 struct spdk_nvmf_target_opts tgt_opts = { 274 .name = "nvmf_test_tgt", 275 .max_subsystems = 0 276 }; 277 278 allocate_threads(8); 279 set_thread(0); 280 281 g_nvmf_tgt = spdk_nvmf_tgt_create(&tgt_opts); 282 SPDK_CU_ASSERT_FATAL(g_nvmf_tgt != NULL); 283 284 ops = nvmf_get_transport_ops(SPDK_NVME_TRANSPORT_NAME_FC); 285 SPDK_CU_ASSERT_FATAL(ops != NULL); 286 287 ops->opts_init(&opts); 288 289 g_lld_init_called = false; 290 g_nvmf_tprt = spdk_nvmf_transport_create("FC", &opts); 291 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 292 293 CU_ASSERT(g_lld_init_called == true); 294 CU_ASSERT(opts.max_queue_depth == g_nvmf_tprt->opts.max_queue_depth); 295 CU_ASSERT(opts.max_qpairs_per_ctrlr == g_nvmf_tprt->opts.max_qpairs_per_ctrlr); 296 CU_ASSERT(opts.in_capsule_data_size == g_nvmf_tprt->opts.in_capsule_data_size); 297 CU_ASSERT(opts.max_io_size == g_nvmf_tprt->opts.max_io_size); 298 CU_ASSERT(opts.io_unit_size == g_nvmf_tprt->opts.io_unit_size); 299 CU_ASSERT(opts.max_aq_depth == g_nvmf_tprt->opts.max_aq_depth); 300 301 set_thread(0); 302 303 spdk_nvmf_tgt_add_transport(g_nvmf_tgt, g_nvmf_tprt, 304 _add_transport_done, 0); 305 poll_thread(0); 306 307 /* Add transport again - should get error */ 308 spdk_nvmf_tgt_add_transport(g_nvmf_tgt, g_nvmf_tprt, 309 _add_transport_done_dup_err, 0); 310 poll_thread(0); 311 312 /* create transport with bad args/options */ 313 #ifndef SPDK_CONFIG_RDMA 314 CU_ASSERT(spdk_nvmf_transport_create("RDMA", &opts) == NULL); 315 #endif 316 CU_ASSERT(spdk_nvmf_transport_create("Bogus Transport", &opts) == NULL); 317 opts.max_io_size = 1024 ^ 3; 318 CU_ASSERT(spdk_nvmf_transport_create("FC", &opts) == NULL); 319 opts.max_io_size = 999; 320 opts.io_unit_size = 1024; 321 CU_ASSERT(spdk_nvmf_transport_create("FC", &opts) == NULL); 322 } 323 324 static void 325 port_init_cb(uint8_t port_handle, enum spdk_fc_event event_type, void *arg, int err) 326 { 327 CU_ASSERT(err == 0); 328 CU_ASSERT(port_handle == 2); 329 g_fc_port_handle = port_handle; 330 } 331 332 static void 333 create_fc_port_test(void) 334 { 335 struct spdk_nvmf_fc_hw_port_init_args init_args = { 0 }; 336 struct spdk_nvmf_fc_port *fc_port = NULL; 337 int err; 338 339 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 340 341 init_args.port_handle = 2; 342 init_args.io_queue_cnt = spdk_min(MAX_FC_UT_HWQPS, spdk_env_get_core_count()); 343 init_args.ls_queue_size = 100; 344 init_args.io_queue_size = 100; 345 init_args.io_queues = (void *)lld_q; 346 347 set_thread(0); 348 err = spdk_nvmf_fc_master_enqueue_event(SPDK_FC_HW_PORT_INIT, (void *)&init_args, port_init_cb); 349 CU_ASSERT(err == 0); 350 poll_thread(0); 351 352 fc_port = spdk_nvmf_fc_port_lookup(g_fc_port_handle); 353 CU_ASSERT(fc_port != NULL); 354 } 355 356 static void 357 online_fc_port_test(void) 358 { 359 struct spdk_nvmf_fc_port *fc_port; 360 struct spdk_nvmf_fc_hw_port_online_args args; 361 int err; 362 363 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 364 365 fc_port = spdk_nvmf_fc_port_lookup(g_fc_port_handle); 366 SPDK_CU_ASSERT_FATAL(fc_port != NULL); 367 368 set_thread(0); 369 args.port_handle = g_fc_port_handle; 370 err = spdk_nvmf_fc_master_enqueue_event(SPDK_FC_HW_PORT_ONLINE, (void *)&args, port_init_cb); 371 CU_ASSERT(err == 0); 372 poll_threads(); 373 set_thread(0); 374 if (err == 0) { 375 uint32_t i; 376 for (i = 0; i < fc_port->num_io_queues; i++) { 377 CU_ASSERT(fc_port->io_queues[i].fgroup != 0); 378 CU_ASSERT(fc_port->io_queues[i].fgroup != 0); 379 CU_ASSERT(fc_port->io_queues[i].fgroup->hwqp_count != 0); 380 } 381 } 382 } 383 384 static void 385 create_poll_groups_test(void) 386 { 387 unsigned i; 388 389 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 390 391 for (i = 0; i < MAX_FC_UT_POLL_THREADS; i++) { 392 set_thread(i); 393 g_poll_groups[i] = spdk_nvmf_poll_group_create(g_nvmf_tgt); 394 poll_thread(i); 395 CU_ASSERT(g_poll_groups[i] != NULL); 396 } 397 set_thread(0); 398 } 399 400 static void 401 poll_group_poll_test(void) 402 { 403 unsigned i; 404 unsigned poll_cnt = 10; 405 struct spdk_nvmf_fc_port *fc_port = NULL; 406 407 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 408 409 set_thread(0); 410 fc_port = spdk_nvmf_fc_port_lookup(g_fc_port_handle); 411 SPDK_CU_ASSERT_FATAL(fc_port != NULL); 412 413 for (i = 0; i < fc_port->num_io_queues; i++) { 414 fc_port->io_queues[i].lcore_id = 0; 415 } 416 417 for (i = 0; i < poll_cnt; i++) { 418 /* this should cause spdk_nvmf_fc_poll_group_poll to be called() */ 419 poll_threads(); 420 } 421 422 /* check if hwqp's lcore_id has been updated */ 423 for (i = 0; i < fc_port->num_io_queues; i++) { 424 CU_ASSERT(fc_port->io_queues[i].lcore_id == poll_cnt); 425 } 426 } 427 428 static void 429 remove_hwqps_from_poll_groups_test(void) 430 { 431 unsigned i; 432 struct spdk_nvmf_fc_port *fc_port = NULL; 433 434 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 435 436 fc_port = spdk_nvmf_fc_port_lookup(g_fc_port_handle); 437 SPDK_CU_ASSERT_FATAL(fc_port != NULL); 438 439 for (i = 0; i < fc_port->num_io_queues; i++) { 440 spdk_nvmf_fc_poll_group_remove_hwqp(&fc_port->io_queues[i]); 441 poll_threads(); 442 CU_ASSERT(fc_port->io_queues[i].fgroup == 0); 443 } 444 } 445 446 static void 447 destroy_transport_test(void) 448 { 449 unsigned i; 450 451 set_thread(0); 452 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt != NULL); 453 454 for (i = 0; i < MAX_FC_UT_POLL_THREADS; i++) { 455 set_thread(i); 456 spdk_nvmf_poll_group_destroy(g_poll_groups[i], NULL, NULL); 457 poll_thread(0); 458 } 459 460 SPDK_CU_ASSERT_FATAL(g_nvmf_tgt != NULL); 461 g_lld_fini_called = false; 462 spdk_nvmf_tgt_destroy(g_nvmf_tgt, NULL, NULL); 463 poll_threads(); 464 CU_ASSERT(g_lld_fini_called == true); 465 } 466 467 static int 468 nvmf_fc_tests_init(void) 469 { 470 return 0; 471 } 472 473 static int 474 nvmf_fc_tests_fini(void) 475 { 476 free_threads(); 477 return 0; 478 } 479 480 int main(int argc, char **argv) 481 { 482 unsigned int num_failures = 0; 483 CU_pSuite suite = NULL; 484 485 CU_set_error_action(CUEA_ABORT); 486 CU_initialize_registry(); 487 488 suite = CU_add_suite("NVMf-FC", nvmf_fc_tests_init, nvmf_fc_tests_fini); 489 490 CU_ADD_TEST(suite, create_transport_test); 491 CU_ADD_TEST(suite, create_poll_groups_test); 492 CU_ADD_TEST(suite, create_fc_port_test); 493 CU_ADD_TEST(suite, online_fc_port_test); 494 CU_ADD_TEST(suite, poll_group_poll_test); 495 CU_ADD_TEST(suite, remove_hwqps_from_poll_groups_test); 496 CU_ADD_TEST(suite, destroy_transport_test); 497 498 CU_basic_set_mode(CU_BRM_VERBOSE); 499 CU_basic_run_tests(); 500 num_failures = CU_get_number_of_failures(); 501 CU_cleanup_registry(); 502 503 return num_failures; 504 } 505