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