1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2019, 2021 Mellanox Technologies LTD. All rights reserved. 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 #include "spdk/stdinc.h" 35 #include "spdk_cunit.h" 36 #include "common/lib/test_env.c" 37 #include "nvmf/nvmf.c" 38 #include "spdk/bdev_module.h" 39 40 DEFINE_STUB_V(nvmf_transport_poll_group_destroy, (struct spdk_nvmf_transport_poll_group *group)); 41 DEFINE_STUB_V(nvmf_ctrlr_destruct, (struct spdk_nvmf_ctrlr *ctrlr)); 42 DEFINE_STUB_V(nvmf_transport_qpair_fini, (struct spdk_nvmf_qpair *qpair, 43 spdk_nvmf_transport_qpair_fini_cb cb_fn, 44 void *cb_arg)); 45 DEFINE_STUB_V(nvmf_qpair_free_aer, (struct spdk_nvmf_qpair *qpair)); 46 DEFINE_STUB_V(nvmf_qpair_abort_pending_zcopy_reqs, (struct spdk_nvmf_qpair *qpair)); 47 DEFINE_STUB(nvmf_transport_poll_group_create, struct spdk_nvmf_transport_poll_group *, 48 (struct spdk_nvmf_transport *transport, 49 struct spdk_nvmf_poll_group *group), NULL); 50 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *desc), 51 NULL); 52 DEFINE_STUB(nvmf_ctrlr_async_event_ns_notice, int, (struct spdk_nvmf_ctrlr *ctrlr), 0); 53 DEFINE_STUB(nvmf_ctrlr_async_event_ana_change_notice, int, 54 (struct spdk_nvmf_ctrlr *ctrlr), 0); 55 DEFINE_STUB(nvmf_transport_poll_group_remove, int, (struct spdk_nvmf_transport_poll_group *group, 56 struct spdk_nvmf_qpair *qpair), 0); 57 DEFINE_STUB(nvmf_transport_req_free, int, (struct spdk_nvmf_request *req), 0); 58 DEFINE_STUB(nvmf_transport_poll_group_poll, int, (struct spdk_nvmf_transport_poll_group *group), 0); 59 DEFINE_STUB(nvmf_transport_accept, uint32_t, (struct spdk_nvmf_transport *transport), 0); 60 DEFINE_STUB_V(nvmf_subsystem_remove_all_listeners, (struct spdk_nvmf_subsystem *subsystem, 61 bool stop)); 62 DEFINE_STUB(spdk_nvmf_subsystem_destroy, int, (struct spdk_nvmf_subsystem *subsystem, 63 nvmf_subsystem_destroy_cb cpl_cb, void *cpl_cb_arg), 0); 64 DEFINE_STUB(spdk_nvmf_subsystem_get_first_listener, struct spdk_nvmf_subsystem_listener *, 65 (struct spdk_nvmf_subsystem *subsystem), NULL); 66 DEFINE_STUB(spdk_nvmf_subsystem_get_next_listener, struct spdk_nvmf_subsystem_listener *, 67 (struct spdk_nvmf_subsystem *subsystem, 68 struct spdk_nvmf_subsystem_listener *prev_listener), NULL); 69 DEFINE_STUB(spdk_nvmf_subsystem_get_next, struct spdk_nvmf_subsystem *, 70 (struct spdk_nvmf_subsystem *subsystem), NULL); 71 DEFINE_STUB(spdk_nvmf_subsystem_get_nqn, const char *, 72 (const struct spdk_nvmf_subsystem *subsystem), NULL); 73 DEFINE_STUB(spdk_nvmf_subsystem_get_allow_any_host, bool, 74 (const struct spdk_nvmf_subsystem *subsystem), true); 75 DEFINE_STUB(spdk_nvmf_subsystem_get_sn, const char *, 76 (const struct spdk_nvmf_subsystem *subsystem), 77 NULL); 78 DEFINE_STUB(spdk_nvmf_subsystem_get_mn, const char *, 79 (const struct spdk_nvmf_subsystem *subsystem), 80 NULL); 81 DEFINE_STUB(spdk_nvmf_subsystem_get_max_namespaces, uint32_t, 82 (const struct spdk_nvmf_subsystem *subsystem), 0); 83 DEFINE_STUB(spdk_nvmf_subsystem_get_min_cntlid, uint16_t, 84 (const struct spdk_nvmf_subsystem *subsystem), 0); 85 DEFINE_STUB(spdk_nvmf_subsystem_get_max_cntlid, uint16_t, 86 (const struct spdk_nvmf_subsystem *subsystem), 0); 87 DEFINE_STUB(spdk_nvmf_subsystem_listener_get_trid, const struct spdk_nvme_transport_id *, 88 (struct spdk_nvmf_subsystem_listener *listener), NULL); 89 DEFINE_STUB(spdk_nvme_transport_id_adrfam_str, const char *, (enum spdk_nvmf_adrfam adrfam), NULL); 90 DEFINE_STUB(spdk_nvmf_subsystem_get_first_host, struct spdk_nvmf_host *, 91 (struct spdk_nvmf_subsystem *subsystem), 0); 92 DEFINE_STUB(spdk_nvmf_host_get_nqn, const char *, (const struct spdk_nvmf_host *host), NULL); 93 DEFINE_STUB(spdk_nvmf_subsystem_get_next_host, struct spdk_nvmf_host *, 94 (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *prev_host), NULL); 95 DEFINE_STUB(spdk_nvmf_subsystem_get_first_ns, struct spdk_nvmf_ns *, 96 (struct spdk_nvmf_subsystem *subsystem), NULL); 97 DEFINE_STUB(nvmf_subsystem_get_ana_reporting, bool, (struct spdk_nvmf_subsystem *subsystem), false); 98 DEFINE_STUB_V(spdk_nvmf_ns_get_opts, (const struct spdk_nvmf_ns *ns, 99 struct spdk_nvmf_ns_opts *opts, size_t opts_size)); 100 DEFINE_STUB(spdk_nvmf_ns_get_id, uint32_t, (const struct spdk_nvmf_ns *ns), 0); 101 DEFINE_STUB(spdk_nvmf_ns_get_bdev, struct spdk_bdev *, (struct spdk_nvmf_ns *ns), NULL); 102 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), 0); 103 DEFINE_STUB(spdk_nvmf_subsystem_get_next_ns, struct spdk_nvmf_ns *, 104 (struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns), NULL); 105 DEFINE_STUB(spdk_nvmf_transport_listen, int, (struct spdk_nvmf_transport *transport, 106 const struct spdk_nvme_transport_id *trid, 107 struct spdk_nvmf_listen_opts *opts), 0); 108 DEFINE_STUB(spdk_nvmf_transport_stop_listen, int, 109 (struct spdk_nvmf_transport *transport, 110 const struct spdk_nvme_transport_id *trid), 0) 111 DEFINE_STUB(nvmf_transport_get_optimal_poll_group, struct spdk_nvmf_transport_poll_group *, 112 (struct spdk_nvmf_transport *transport, struct spdk_nvmf_qpair *qpair), NULL); 113 DEFINE_STUB(nvmf_transport_poll_group_add, int, 114 (struct spdk_nvmf_transport_poll_group *group, 115 struct spdk_nvmf_qpair *qpair), 0); 116 DEFINE_STUB(nvmf_transport_qpair_get_peer_trid, int, 117 (struct spdk_nvmf_qpair *qpair, 118 struct spdk_nvme_transport_id *trid), 0); 119 DEFINE_STUB(nvmf_transport_qpair_get_local_trid, int, 120 (struct spdk_nvmf_qpair *qpair, 121 struct spdk_nvme_transport_id *trid), 0); 122 DEFINE_STUB(nvmf_transport_qpair_get_listen_trid, int, 123 (struct spdk_nvmf_qpair *qpair, 124 struct spdk_nvme_transport_id *trid), 0); 125 DEFINE_STUB_V(spdk_nvmf_request_exec, (struct spdk_nvmf_request *req)); 126 DEFINE_STUB_V(spdk_nvmf_request_zcopy_start, (struct spdk_nvmf_request *req)); 127 DEFINE_STUB(spdk_nvmf_get_transport_name, const char *, 128 (struct spdk_nvmf_transport *transport), NULL); 129 DEFINE_STUB(spdk_nvmf_transport_destroy, int, (struct spdk_nvmf_transport *transport, 130 spdk_nvmf_transport_destroy_done_cb cb_fn, void *cb_arg), 0); 131 DEFINE_STUB(spdk_nvmf_subsystem_get_type, enum spdk_nvmf_subtype, 132 (struct spdk_nvmf_subsystem *subsystem), 0); 133 DEFINE_STUB(spdk_nvmf_subsystem_get_first, struct spdk_nvmf_subsystem *, 134 (struct spdk_nvmf_tgt *tgt), NULL); 135 DEFINE_STUB_V(nvmf_transport_dump_opts, (struct spdk_nvmf_transport *transport, 136 struct spdk_json_write_ctx *w, bool named)); 137 DEFINE_STUB_V(nvmf_transport_listen_dump_opts, (struct spdk_nvmf_transport *transport, 138 const struct spdk_nvme_transport_id *trid, struct spdk_json_write_ctx *w)); 139 140 struct spdk_io_channel { 141 struct spdk_thread *thread; 142 struct io_device *dev; 143 uint32_t ref; 144 uint32_t destroy_ref; 145 TAILQ_ENTRY(spdk_io_channel) tailq; 146 spdk_io_channel_destroy_cb destroy_cb; 147 148 uint8_t _padding[48]; 149 }; 150 151 uint64_t 152 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev) 153 { 154 return bdev->blockcnt; 155 } 156 157 const struct spdk_uuid * 158 spdk_bdev_get_uuid(const struct spdk_bdev *bdev) 159 { 160 return &bdev->uuid; 161 } 162 163 static void 164 test_nvmf_tgt_create_poll_group(void) 165 { 166 int rc; 167 struct spdk_thread *thread = NULL; 168 struct spdk_nvmf_tgt tgt = {}; 169 struct spdk_nvmf_poll_group group = {}; 170 struct spdk_nvmf_transport transport = {}; 171 struct spdk_nvmf_subsystem subsystem = {}; 172 struct spdk_nvmf_ns ns = {}; 173 struct spdk_bdev bdev = {}; 174 struct spdk_io_channel ch = {}; 175 struct spdk_nvmf_transport_poll_group transport_pg = {}; 176 177 thread = spdk_thread_create(NULL, NULL); 178 SPDK_CU_ASSERT_FATAL(thread != NULL); 179 spdk_set_thread(thread); 180 181 /* Create group with single subsystem */ 182 ch.thread = thread; 183 MOCK_SET(spdk_bdev_get_io_channel, &ch); 184 185 tgt.max_subsystems = 1; 186 tgt.subsystems = calloc(tgt.max_subsystems, sizeof(struct spdk_nvmf_subsystem *)); 187 SPDK_CU_ASSERT_FATAL(tgt.subsystems != NULL); 188 189 tgt.subsystems[0] = &subsystem; 190 tgt.subsystems[0]->id = 0; 191 tgt.subsystems[0]->max_nsid = 1; 192 tgt.subsystems[0]->ns = calloc(1, sizeof(struct spdk_nvmf_ns *)); 193 SPDK_CU_ASSERT_FATAL(tgt.subsystems[0]->ns != NULL); 194 195 tgt.subsystems[0]->ns[0] = &ns; 196 ns.crkey = 0xaa; 197 ns.rtype = 0xbb; 198 TAILQ_INIT(&ns.registrants); 199 ns.bdev = &bdev; 200 spdk_uuid_generate(&bdev.uuid); 201 bdev.blockcnt = 512; 202 203 TAILQ_INIT(&tgt.transports); 204 TAILQ_INIT(&tgt.poll_groups); 205 pthread_mutex_init(&tgt.mutex, NULL); 206 transport.tgt = &tgt; 207 TAILQ_INSERT_TAIL(&tgt.transports, &transport, link); 208 209 MOCK_SET(nvmf_transport_poll_group_create, &transport_pg); 210 rc = nvmf_tgt_create_poll_group((void *)&tgt, (void *)&group); 211 MOCK_SET(nvmf_transport_poll_group_create, NULL); 212 CU_ASSERT(rc == 0); 213 CU_ASSERT(group.num_sgroups == 1); 214 CU_ASSERT(group.sgroups != NULL); 215 CU_ASSERT(group.sgroups[0].state == SPDK_NVMF_SUBSYSTEM_ACTIVE); 216 CU_ASSERT(group.sgroups[0].ns_info[0].channel == &ch); 217 CU_ASSERT(!memcmp(&group.sgroups[0].ns_info[0].uuid, &bdev.uuid, 16)); 218 CU_ASSERT(group.sgroups[0].ns_info[0].num_blocks == 512); 219 CU_ASSERT(group.sgroups[0].ns_info[0].crkey == 0xaa); 220 CU_ASSERT(group.sgroups[0].ns_info[0].rtype == 0xbb); 221 CU_ASSERT(TAILQ_FIRST(&tgt.poll_groups) == &group); 222 CU_ASSERT(group.thread == thread); 223 CU_ASSERT(group.poller != NULL); 224 225 nvmf_tgt_destroy_poll_group((void *)&tgt, (void *)&group); 226 CU_ASSERT(TAILQ_EMPTY(&tgt.poll_groups)); 227 free(tgt.subsystems[0]->ns); 228 free(tgt.subsystems); 229 230 spdk_thread_exit(thread); 231 while (!spdk_thread_is_exited(thread)) { 232 spdk_thread_poll(thread, 0, 0); 233 } 234 spdk_thread_destroy(thread); 235 MOCK_CLEAR(spdk_bdev_get_io_channel); 236 } 237 238 int main(int argc, char **argv) 239 { 240 CU_pSuite suite = NULL; 241 unsigned int num_failures; 242 243 CU_set_error_action(CUEA_ABORT); 244 CU_initialize_registry(); 245 246 suite = CU_add_suite("nvmf", NULL, NULL); 247 248 CU_ADD_TEST(suite, test_nvmf_tgt_create_poll_group); 249 250 CU_basic_set_mode(CU_BRM_VERBOSE); 251 CU_basic_run_tests(); 252 num_failures = CU_get_number_of_failures(); 253 CU_cleanup_registry(); 254 return num_failures; 255 } 256