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