4 * Copyright (c) 2018-2019 Broadcom. All Rights Reserved.
5 * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 /* NVMF FC Transport Unit Test */
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"
43 #include "ut_multithread.c"
45 #include "transport.h"
46 #include "nvmf_internal.h"
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"
56 #include "nvmf/fc_ls.c"
62 #ifdef SPDK_CONFIG_RDMA
63 const struct spdk_nvmf_transport_ops spdk_nvmf_transport_rdma
= {
64 .type
= SPDK_NVME_TRANSPORT_RDMA
,
73 .listener_discover
= NULL
,
75 .poll_group_create
= NULL
,
76 .poll_group_destroy
= NULL
,
77 .poll_group_add
= NULL
,
78 .poll_group_poll
= NULL
,
84 .qpair_get_peer_trid
= NULL
,
85 .qpair_get_local_trid
= NULL
,
86 .qpair_get_listen_trid
= NULL
,
90 const struct spdk_nvmf_transport_ops spdk_nvmf_transport_tcp
= {
91 .type
= SPDK_NVME_TRANSPORT_TCP
,
94 struct spdk_trace_histories
*g_trace_histories
;
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
),
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);
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 DEFINE_STUB(spdk_nvmf_request_complete
, int, (struct spdk_nvmf_request
*req
),
134 spdk_nvme_transport_id_trtype_str(enum spdk_nvme_transport_type trtype
)
137 case SPDK_NVME_TRANSPORT_PCIE
:
139 case SPDK_NVME_TRANSPORT_RDMA
:
141 case SPDK_NVME_TRANSPORT_FC
:
149 spdk_nvme_transport_id_adrfam_str(enum spdk_nvmf_adrfam adrfam
)
152 case SPDK_NVMF_ADRFAM_IPV4
:
154 case SPDK_NVMF_ADRFAM_IPV6
:
156 case SPDK_NVMF_ADRFAM_IB
:
158 case SPDK_NVMF_ADRFAM_FC
:
165 const struct spdk_uuid
*
166 spdk_bdev_get_uuid(const struct spdk_bdev
*bdev
)
171 static bool g_lld_init_called
= false;
174 nvmf_fc_lld_init(void)
176 g_lld_init_called
= true;
180 static bool g_lld_fini_called
= false;
183 nvmf_fc_lld_fini(void)
185 g_lld_fini_called
= true;
188 DEFINE_STUB_V(nvmf_fc_lld_start
, (void));
189 DEFINE_STUB(nvmf_fc_init_q
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
), 0);
190 DEFINE_STUB_V(nvmf_fc_reinit_q
, (void *queues_prev
, void *queues_curr
));
191 DEFINE_STUB(nvmf_fc_init_rqpair_buffers
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
), 0);
192 DEFINE_STUB(nvmf_fc_set_q_online_state
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
, bool online
), 0);
193 DEFINE_STUB(nvmf_fc_put_xchg
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
, struct spdk_nvmf_fc_xchg
*xri
),
195 DEFINE_STUB(nvmf_fc_recv_data
, int, (struct spdk_nvmf_fc_request
*fc_req
), 0);
196 DEFINE_STUB(nvmf_fc_send_data
, int, (struct spdk_nvmf_fc_request
*fc_req
), 0);
197 DEFINE_STUB_V(nvmf_fc_rqpair_buffer_release
, (struct spdk_nvmf_fc_hwqp
*hwqp
, uint16_t buff_idx
));
198 DEFINE_STUB(nvmf_fc_xmt_rsp
, int, (struct spdk_nvmf_fc_request
*fc_req
, uint8_t *ersp_buf
,
199 uint32_t ersp_len
), 0);
200 DEFINE_STUB(nvmf_fc_xmt_ls_rsp
, int, (struct spdk_nvmf_fc_nport
*tgtport
,
201 struct spdk_nvmf_fc_ls_rqst
*ls_rqst
), 0);
202 DEFINE_STUB(nvmf_fc_issue_abort
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
,
203 struct spdk_nvmf_fc_xchg
*xri
,
204 spdk_nvmf_fc_caller_cb cb
, void *cb_args
), 0);
205 DEFINE_STUB(nvmf_fc_xmt_bls_rsp
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
,
206 uint16_t ox_id
, uint16_t rx_id
,
207 uint16_t rpi
, bool rjt
, uint8_t rjt_exp
,
208 spdk_nvmf_fc_caller_cb cb
, void *cb_args
), 0);
209 DEFINE_STUB(nvmf_fc_alloc_srsr_bufs
, struct spdk_nvmf_fc_srsr_bufs
*, (size_t rqst_len
,
210 size_t rsp_len
), NULL
);
211 DEFINE_STUB_V(nvmf_fc_free_srsr_bufs
, (struct spdk_nvmf_fc_srsr_bufs
*srsr_bufs
));
212 DEFINE_STUB(nvmf_fc_xmt_srsr_req
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
,
213 struct spdk_nvmf_fc_srsr_bufs
*xmt_srsr_bufs
,
214 spdk_nvmf_fc_caller_cb cb
, void *cb_args
), 0);
215 DEFINE_STUB(nvmf_fc_q_sync_available
, bool, (void), true);
216 DEFINE_STUB(nvmf_fc_issue_q_sync
, int, (struct spdk_nvmf_fc_hwqp
*hwqp
, uint64_t u_id
,
217 uint16_t skip_rq
), 0);
218 DEFINE_STUB(nvmf_fc_assign_conn_to_hwqp
, bool, (struct spdk_nvmf_fc_hwqp
*hwqp
,
219 uint64_t *conn_id
, uint32_t sq_size
), true);
220 DEFINE_STUB(nvmf_fc_get_hwqp_from_conn_id
, struct spdk_nvmf_fc_hwqp
*,
221 (struct spdk_nvmf_fc_hwqp
*queues
,
222 uint32_t num_queues
, uint64_t conn_id
), NULL
);
223 DEFINE_STUB_V(nvmf_fc_release_conn
, (struct spdk_nvmf_fc_hwqp
*hwqp
, uint64_t conn_id
,
225 DEFINE_STUB_V(nvmf_fc_dump_all_queues
, (struct spdk_nvmf_fc_hwqp
*ls_queue
,
226 struct spdk_nvmf_fc_hwqp
*io_queues
,
227 uint32_t num_io_queues
,
228 struct spdk_nvmf_fc_queue_dump_info
*dump_info
));
229 DEFINE_STUB_V(nvmf_fc_get_xri_info
, (struct spdk_nvmf_fc_hwqp
*hwqp
,
230 struct spdk_nvmf_fc_xchg_info
*info
));
231 DEFINE_STUB(nvmf_fc_get_rsvd_thread
, struct spdk_thread
*, (void), NULL
);
234 nvmf_fc_process_queue(struct spdk_nvmf_fc_hwqp
*hwqp
)
237 return 0; /* always return 0 or else it will poll forever */
240 struct spdk_nvmf_fc_xchg
*
241 nvmf_fc_get_xri(struct spdk_nvmf_fc_hwqp
*hwqp
)
243 static struct spdk_nvmf_fc_xchg xchg
;
249 #define MAX_FC_UT_POLL_THREADS 8
250 static struct spdk_nvmf_poll_group
*g_poll_groups
[MAX_FC_UT_POLL_THREADS
] = {0};
251 #define MAX_FC_UT_HWQPS MAX_FC_UT_POLL_THREADS
252 static struct spdk_nvmf_tgt
*g_nvmf_tgt
= NULL
;
253 static struct spdk_nvmf_transport
*g_nvmf_tprt
= NULL
;
254 uint8_t g_fc_port_handle
= 0xff;
255 struct spdk_nvmf_fc_hwqp lld_q
[MAX_FC_UT_HWQPS
];
258 _add_transport_done(void *arg
, int status
)
260 CU_ASSERT(status
== 0);
264 _add_transport_done_dup_err(void *arg
, int status
)
266 CU_ASSERT(status
== -EEXIST
);
270 create_transport_test(void)
272 const struct spdk_nvmf_transport_ops
*ops
= NULL
;
273 struct spdk_nvmf_transport_opts opts
= { 0 };
274 struct spdk_nvmf_target_opts tgt_opts
= {
275 .name
= "nvmf_test_tgt",
282 g_nvmf_tgt
= spdk_nvmf_tgt_create(&tgt_opts
);
283 SPDK_CU_ASSERT_FATAL(g_nvmf_tgt
!= NULL
);
285 ops
= nvmf_get_transport_ops(SPDK_NVME_TRANSPORT_NAME_FC
);
286 SPDK_CU_ASSERT_FATAL(ops
!= NULL
);
288 ops
->opts_init(&opts
);
290 g_lld_init_called
= false;
291 g_nvmf_tprt
= spdk_nvmf_transport_create("FC", &opts
);
292 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
294 CU_ASSERT(g_lld_init_called
== true);
295 CU_ASSERT(opts
.max_queue_depth
== g_nvmf_tprt
->opts
.max_queue_depth
);
296 CU_ASSERT(opts
.max_qpairs_per_ctrlr
== g_nvmf_tprt
->opts
.max_qpairs_per_ctrlr
);
297 CU_ASSERT(opts
.in_capsule_data_size
== g_nvmf_tprt
->opts
.in_capsule_data_size
);
298 CU_ASSERT(opts
.max_io_size
== g_nvmf_tprt
->opts
.max_io_size
);
299 CU_ASSERT(opts
.io_unit_size
== g_nvmf_tprt
->opts
.io_unit_size
);
300 CU_ASSERT(opts
.max_aq_depth
== g_nvmf_tprt
->opts
.max_aq_depth
);
304 spdk_nvmf_tgt_add_transport(g_nvmf_tgt
, g_nvmf_tprt
,
305 _add_transport_done
, 0);
308 /* Add transport again - should get error */
309 spdk_nvmf_tgt_add_transport(g_nvmf_tgt
, g_nvmf_tprt
,
310 _add_transport_done_dup_err
, 0);
313 /* create transport with bad args/options */
314 #ifndef SPDK_CONFIG_RDMA
315 CU_ASSERT(spdk_nvmf_transport_create("RDMA", &opts
) == NULL
);
317 CU_ASSERT(spdk_nvmf_transport_create("Bogus Transport", &opts
) == NULL
);
318 opts
.max_io_size
= 1024 ^ 3;
319 CU_ASSERT(spdk_nvmf_transport_create("FC", &opts
) == NULL
);
320 opts
.max_io_size
= 999;
321 opts
.io_unit_size
= 1024;
322 CU_ASSERT(spdk_nvmf_transport_create("FC", &opts
) == NULL
);
326 port_init_cb(uint8_t port_handle
, enum spdk_fc_event event_type
, void *arg
, int err
)
329 CU_ASSERT(port_handle
== 2);
330 g_fc_port_handle
= port_handle
;
334 create_fc_port_test(void)
336 struct spdk_nvmf_fc_hw_port_init_args init_args
= { 0 };
337 struct spdk_nvmf_fc_port
*fc_port
= NULL
;
340 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
342 init_args
.port_handle
= 2;
343 init_args
.io_queue_cnt
= spdk_min(MAX_FC_UT_HWQPS
, spdk_env_get_core_count());
344 init_args
.ls_queue_size
= 100;
345 init_args
.io_queue_size
= 100;
346 init_args
.io_queues
= (void *)lld_q
;
349 err
= nvmf_fc_master_enqueue_event(SPDK_FC_HW_PORT_INIT
, (void *)&init_args
, port_init_cb
);
353 fc_port
= nvmf_fc_port_lookup(g_fc_port_handle
);
354 CU_ASSERT(fc_port
!= NULL
);
358 online_fc_port_test(void)
360 struct spdk_nvmf_fc_port
*fc_port
;
361 struct spdk_nvmf_fc_hw_port_online_args args
;
364 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
366 fc_port
= nvmf_fc_port_lookup(g_fc_port_handle
);
367 SPDK_CU_ASSERT_FATAL(fc_port
!= NULL
);
370 args
.port_handle
= g_fc_port_handle
;
371 err
= nvmf_fc_master_enqueue_event(SPDK_FC_HW_PORT_ONLINE
, (void *)&args
, port_init_cb
);
377 for (i
= 0; i
< fc_port
->num_io_queues
; i
++) {
378 CU_ASSERT(fc_port
->io_queues
[i
].fgroup
!= 0);
379 CU_ASSERT(fc_port
->io_queues
[i
].fgroup
!= 0);
380 CU_ASSERT(fc_port
->io_queues
[i
].fgroup
->hwqp_count
!= 0);
386 create_poll_groups_test(void)
390 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
392 for (i
= 0; i
< MAX_FC_UT_POLL_THREADS
; i
++) {
394 g_poll_groups
[i
] = spdk_nvmf_poll_group_create(g_nvmf_tgt
);
396 CU_ASSERT(g_poll_groups
[i
] != NULL
);
402 poll_group_poll_test(void)
405 unsigned poll_cnt
= 10;
406 struct spdk_nvmf_fc_port
*fc_port
= NULL
;
408 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
411 fc_port
= nvmf_fc_port_lookup(g_fc_port_handle
);
412 SPDK_CU_ASSERT_FATAL(fc_port
!= NULL
);
414 for (i
= 0; i
< fc_port
->num_io_queues
; i
++) {
415 fc_port
->io_queues
[i
].lcore_id
= 0;
418 for (i
= 0; i
< poll_cnt
; i
++) {
419 /* this should cause spdk_nvmf_fc_poll_group_poll to be called() */
423 /* check if hwqp's lcore_id has been updated */
424 for (i
= 0; i
< fc_port
->num_io_queues
; i
++) {
425 CU_ASSERT(fc_port
->io_queues
[i
].lcore_id
== poll_cnt
);
430 remove_hwqps_from_poll_groups_test(void)
433 struct spdk_nvmf_fc_port
*fc_port
= NULL
;
435 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
437 fc_port
= nvmf_fc_port_lookup(g_fc_port_handle
);
438 SPDK_CU_ASSERT_FATAL(fc_port
!= NULL
);
440 for (i
= 0; i
< fc_port
->num_io_queues
; i
++) {
441 nvmf_fc_poll_group_remove_hwqp(&fc_port
->io_queues
[i
]);
443 CU_ASSERT(fc_port
->io_queues
[i
].fgroup
== 0);
448 destroy_transport_test(void)
453 SPDK_CU_ASSERT_FATAL(g_nvmf_tprt
!= NULL
);
455 for (i
= 0; i
< MAX_FC_UT_POLL_THREADS
; i
++) {
457 spdk_nvmf_poll_group_destroy(g_poll_groups
[i
], NULL
, NULL
);
461 SPDK_CU_ASSERT_FATAL(g_nvmf_tgt
!= NULL
);
462 g_lld_fini_called
= false;
463 spdk_nvmf_tgt_destroy(g_nvmf_tgt
, NULL
, NULL
);
465 CU_ASSERT(g_lld_fini_called
== true);
469 nvmf_fc_tests_init(void)
475 nvmf_fc_tests_fini(void)
481 int main(int argc
, char **argv
)
483 unsigned int num_failures
= 0;
484 CU_pSuite suite
= NULL
;
486 CU_set_error_action(CUEA_ABORT
);
487 CU_initialize_registry();
489 suite
= CU_add_suite("NVMf-FC", nvmf_fc_tests_init
, nvmf_fc_tests_fini
);
491 CU_ADD_TEST(suite
, create_transport_test
);
492 CU_ADD_TEST(suite
, create_poll_groups_test
);
493 CU_ADD_TEST(suite
, create_fc_port_test
);
494 CU_ADD_TEST(suite
, online_fc_port_test
);
495 CU_ADD_TEST(suite
, poll_group_poll_test
);
496 CU_ADD_TEST(suite
, remove_hwqps_from_poll_groups_test
);
497 CU_ADD_TEST(suite
, destroy_transport_test
);
499 CU_basic_set_mode(CU_BRM_VERBOSE
);
500 CU_basic_run_tests();
501 num_failures
= CU_get_number_of_failures();
502 CU_cleanup_registry();