1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * 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 36 #include "common/lib/test_env.c" 37 #include "spdk_cunit.h" 38 #include "spdk_internal/mock.h" 39 40 #include "nvmf/subsystem.c" 41 42 SPDK_LOG_REGISTER_COMPONENT("nvmf", SPDK_LOG_NVMF) 43 44 DEFINE_STUB(spdk_bdev_module_claim_bdev, 45 int, 46 (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 47 struct spdk_bdev_module *module), 0); 48 49 DEFINE_STUB_V(spdk_bdev_module_release_bdev, 50 (struct spdk_bdev *bdev)); 51 52 static void 53 _subsystem_send_msg(spdk_thread_fn fn, void *ctx, void *thread_ctx) 54 { 55 fn(ctx); 56 } 57 58 static void 59 subsystem_ns_remove_cb(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status) 60 { 61 } 62 63 uint32_t 64 spdk_env_get_current_core(void) 65 { 66 return 0; 67 } 68 69 struct spdk_event * 70 spdk_event_allocate(uint32_t core, spdk_event_fn fn, void *arg1, void *arg2) 71 { 72 return NULL; 73 } 74 75 void 76 spdk_event_call(struct spdk_event *event) 77 { 78 79 } 80 81 int 82 spdk_nvmf_transport_listen(struct spdk_nvmf_transport *transport, 83 const struct spdk_nvme_transport_id *trid) 84 { 85 return 0; 86 } 87 88 void 89 spdk_nvmf_transport_listener_discover(struct spdk_nvmf_transport *transport, 90 struct spdk_nvme_transport_id *trid, 91 struct spdk_nvmf_discovery_log_page_entry *entry) 92 { 93 entry->trtype = 42; 94 } 95 96 bool 97 spdk_nvmf_transport_qpair_is_idle(struct spdk_nvmf_qpair *qpair) 98 { 99 return false; 100 } 101 102 static struct spdk_nvmf_transport g_transport = {}; 103 104 struct spdk_nvmf_transport * 105 spdk_nvmf_transport_create(enum spdk_nvme_transport_type type, 106 struct spdk_nvmf_transport_opts *tprt_opts) 107 { 108 if (type == SPDK_NVME_TRANSPORT_RDMA) { 109 return &g_transport; 110 } 111 112 return NULL; 113 } 114 115 struct spdk_nvmf_subsystem * 116 spdk_nvmf_tgt_find_subsystem(struct spdk_nvmf_tgt *tgt, const char *subnqn) 117 { 118 return NULL; 119 } 120 121 struct spdk_nvmf_transport * 122 spdk_nvmf_tgt_get_transport(struct spdk_nvmf_tgt *tgt, enum spdk_nvme_transport_type trtype) 123 { 124 if (trtype == SPDK_NVME_TRANSPORT_RDMA) { 125 return &g_transport; 126 } 127 128 return NULL; 129 } 130 131 int 132 spdk_nvmf_poll_group_update_subsystem(struct spdk_nvmf_poll_group *group, 133 struct spdk_nvmf_subsystem *subsystem) 134 { 135 return 0; 136 } 137 138 void 139 spdk_nvmf_poll_group_add_subsystem(struct spdk_nvmf_poll_group *group, 140 struct spdk_nvmf_subsystem *subsystem, 141 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 142 { 143 } 144 145 void 146 spdk_nvmf_poll_group_remove_subsystem(struct spdk_nvmf_poll_group *group, 147 struct spdk_nvmf_subsystem *subsystem, 148 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 149 { 150 } 151 152 void 153 spdk_nvmf_poll_group_pause_subsystem(struct spdk_nvmf_poll_group *group, 154 struct spdk_nvmf_subsystem *subsystem, 155 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 156 { 157 } 158 159 void 160 spdk_nvmf_poll_group_resume_subsystem(struct spdk_nvmf_poll_group *group, 161 struct spdk_nvmf_subsystem *subsystem, 162 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 163 { 164 } 165 166 int 167 spdk_nvme_transport_id_parse_trtype(enum spdk_nvme_transport_type *trtype, const char *str) 168 { 169 if (trtype == NULL || str == NULL) { 170 return -EINVAL; 171 } 172 173 if (strcasecmp(str, "PCIe") == 0) { 174 *trtype = SPDK_NVME_TRANSPORT_PCIE; 175 } else if (strcasecmp(str, "RDMA") == 0) { 176 *trtype = SPDK_NVME_TRANSPORT_RDMA; 177 } else { 178 return -ENOENT; 179 } 180 return 0; 181 } 182 183 int 184 spdk_nvme_transport_id_compare(const struct spdk_nvme_transport_id *trid1, 185 const struct spdk_nvme_transport_id *trid2) 186 { 187 return 0; 188 } 189 190 int32_t 191 spdk_nvme_ctrlr_process_admin_completions(struct spdk_nvme_ctrlr *ctrlr) 192 { 193 return -1; 194 } 195 196 int32_t 197 spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair *qpair, uint32_t max_completions) 198 { 199 return -1; 200 } 201 202 int 203 spdk_nvme_detach(struct spdk_nvme_ctrlr *ctrlr) 204 { 205 return -1; 206 } 207 208 void 209 spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 210 { 211 } 212 213 void 214 spdk_nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 215 { 216 } 217 218 int 219 spdk_bdev_open(struct spdk_bdev *bdev, bool write, spdk_bdev_remove_cb_t remove_cb, 220 void *remove_ctx, struct spdk_bdev_desc **desc) 221 { 222 return 0; 223 } 224 225 void 226 spdk_bdev_close(struct spdk_bdev_desc *desc) 227 { 228 } 229 230 const char * 231 spdk_bdev_get_name(const struct spdk_bdev *bdev) 232 { 233 return "test"; 234 } 235 236 const struct spdk_uuid * 237 spdk_bdev_get_uuid(const struct spdk_bdev *bdev) 238 { 239 return &bdev->uuid; 240 } 241 242 static void 243 test_spdk_nvmf_subsystem_add_ns(void) 244 { 245 struct spdk_nvmf_tgt tgt = {}; 246 struct spdk_nvmf_subsystem subsystem = { 247 .max_nsid = 0, 248 .ns = NULL, 249 .tgt = &tgt 250 }; 251 struct spdk_bdev bdev1 = {}, bdev2 = {}; 252 struct spdk_nvmf_ns_opts ns_opts; 253 uint32_t nsid; 254 255 tgt.opts.max_subsystems = 1024; 256 tgt.subsystems = calloc(tgt.opts.max_subsystems, sizeof(struct spdk_nvmf_subsystem *)); 257 SPDK_CU_ASSERT_FATAL(tgt.subsystems != NULL); 258 259 /* Allow NSID to be assigned automatically */ 260 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 261 nsid = spdk_nvmf_subsystem_add_ns(&subsystem, &bdev1, &ns_opts, sizeof(ns_opts)); 262 /* NSID 1 is the first unused ID */ 263 CU_ASSERT(nsid == 1); 264 CU_ASSERT(subsystem.max_nsid == 1); 265 SPDK_CU_ASSERT_FATAL(subsystem.ns != NULL); 266 SPDK_CU_ASSERT_FATAL(subsystem.ns[nsid - 1] != NULL); 267 CU_ASSERT(subsystem.ns[nsid - 1]->bdev == &bdev1); 268 269 /* Request a specific NSID */ 270 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 271 ns_opts.nsid = 5; 272 nsid = spdk_nvmf_subsystem_add_ns(&subsystem, &bdev2, &ns_opts, sizeof(ns_opts)); 273 CU_ASSERT(nsid == 5); 274 CU_ASSERT(subsystem.max_nsid == 5); 275 SPDK_CU_ASSERT_FATAL(subsystem.ns[nsid - 1] != NULL); 276 CU_ASSERT(subsystem.ns[nsid - 1]->bdev == &bdev2); 277 278 /* Request an NSID that is already in use */ 279 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 280 ns_opts.nsid = 5; 281 nsid = spdk_nvmf_subsystem_add_ns(&subsystem, &bdev2, &ns_opts, sizeof(ns_opts)); 282 CU_ASSERT(nsid == 0); 283 CU_ASSERT(subsystem.max_nsid == 5); 284 285 /* Request 0xFFFFFFFF (invalid NSID, reserved for broadcast) */ 286 spdk_nvmf_ns_opts_get_defaults(&ns_opts, sizeof(ns_opts)); 287 ns_opts.nsid = 0xFFFFFFFF; 288 nsid = spdk_nvmf_subsystem_add_ns(&subsystem, &bdev2, &ns_opts, sizeof(ns_opts)); 289 CU_ASSERT(nsid == 0); 290 CU_ASSERT(subsystem.max_nsid == 5); 291 292 spdk_nvmf_subsystem_remove_ns(&subsystem, 1, subsystem_ns_remove_cb, NULL); 293 spdk_nvmf_subsystem_remove_ns(&subsystem, 5, subsystem_ns_remove_cb, NULL); 294 295 free(subsystem.ns); 296 free(tgt.subsystems); 297 } 298 299 static void 300 nvmf_test_create_subsystem(void) 301 { 302 struct spdk_nvmf_tgt tgt = {}; 303 char nqn[256]; 304 struct spdk_nvmf_subsystem *subsystem; 305 306 tgt.opts.max_subsystems = 1024; 307 tgt.subsystems = calloc(tgt.opts.max_subsystems, sizeof(struct spdk_nvmf_subsystem *)); 308 SPDK_CU_ASSERT_FATAL(tgt.subsystems != NULL); 309 310 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:subsystem1"); 311 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 312 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 313 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 314 spdk_nvmf_subsystem_destroy(subsystem); 315 316 /* valid name with complex reverse domain */ 317 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk-full--rev-domain.name:subsystem1"); 318 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 319 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 320 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 321 spdk_nvmf_subsystem_destroy(subsystem); 322 323 /* Valid name discovery controller */ 324 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:subsystem1"); 325 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 326 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 327 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 328 spdk_nvmf_subsystem_destroy(subsystem); 329 330 331 /* Invalid name, no user supplied string */ 332 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:"); 333 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 334 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 335 336 /* Valid name, only contains top-level domain name */ 337 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:subsystem1"); 338 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 339 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 340 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 341 spdk_nvmf_subsystem_destroy(subsystem); 342 343 /* Invalid name, domain label > 63 characters */ 344 snprintf(nqn, sizeof(nqn), 345 "nqn.2016-06.io.abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz:sub"); 346 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 347 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 348 349 /* Invalid name, domain label starts with digit */ 350 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.3spdk:sub"); 351 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 352 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 353 354 /* Invalid name, domain label starts with - */ 355 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.-spdk:subsystem1"); 356 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 357 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 358 359 /* Invalid name, domain label ends with - */ 360 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk-:subsystem1"); 361 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 362 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 363 364 /* Invalid name, domain label with multiple consecutive periods */ 365 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io..spdk:subsystem1"); 366 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 367 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 368 369 /* Longest valid name */ 370 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:"); 371 memset(nqn + strlen(nqn), 'a', 223 - strlen(nqn)); 372 nqn[223] = '\0'; 373 CU_ASSERT(strlen(nqn) == 223); 374 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 375 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 376 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 377 spdk_nvmf_subsystem_destroy(subsystem); 378 379 /* Invalid name, too long */ 380 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:"); 381 memset(nqn + strlen(nqn), 'a', 224 - strlen(nqn)); 382 nqn[224] = '\0'; 383 CU_ASSERT(strlen(nqn) == 224); 384 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 385 CU_ASSERT(subsystem == NULL); 386 387 /* Valid name using uuid format */ 388 snprintf(nqn, sizeof(nqn), "nqn.2014-08.org.nvmexpress:uuid:11111111-aaaa-bbdd-FFEE-123456789abc"); 389 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 390 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 391 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 392 spdk_nvmf_subsystem_destroy(subsystem); 393 394 /* Invalid name user string contains an invalid utf-8 character */ 395 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:\xFFsubsystem1"); 396 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 397 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 398 399 /* Valid name with non-ascii but valid utf-8 characters */ 400 snprintf(nqn, sizeof(nqn), "nqn.2016-06.io.spdk:\xe1\x8a\x88subsystem1\xca\x80"); 401 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 402 SPDK_CU_ASSERT_FATAL(subsystem != NULL); 403 CU_ASSERT_STRING_EQUAL(subsystem->subnqn, nqn); 404 spdk_nvmf_subsystem_destroy(subsystem); 405 406 /* Invalid uuid (too long) */ 407 snprintf(nqn, sizeof(nqn), 408 "nqn.2014-08.org.nvmexpress:uuid:11111111-aaaa-bbdd-FFEE-123456789abcdef"); 409 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 410 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 411 412 /* Invalid uuid (dashes placed incorrectly) */ 413 snprintf(nqn, sizeof(nqn), "nqn.2014-08.org.nvmexpress:uuid:111111-11aaaa-bbdd-FFEE-123456789abc"); 414 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 415 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 416 417 /* Invalid uuid (invalid characters in uuid) */ 418 snprintf(nqn, sizeof(nqn), "nqn.2014-08.org.nvmexpress:uuid:111hg111-aaaa-bbdd-FFEE-123456789abc"); 419 subsystem = spdk_nvmf_subsystem_create(&tgt, nqn, SPDK_NVMF_SUBTYPE_NVME, 0); 420 SPDK_CU_ASSERT_FATAL(subsystem == NULL); 421 422 free(tgt.subsystems); 423 } 424 425 static void 426 test_spdk_nvmf_subsystem_set_sn(void) 427 { 428 struct spdk_nvmf_subsystem subsystem = {}; 429 430 /* Basic valid serial number */ 431 CU_ASSERT(spdk_nvmf_subsystem_set_sn(&subsystem, "abcd xyz") == 0); 432 CU_ASSERT(strcmp(subsystem.sn, "abcd xyz") == 0); 433 434 /* Exactly 20 characters (valid) */ 435 CU_ASSERT(spdk_nvmf_subsystem_set_sn(&subsystem, "12345678901234567890") == 0); 436 CU_ASSERT(strcmp(subsystem.sn, "12345678901234567890") == 0); 437 438 /* 21 characters (too long, invalid) */ 439 CU_ASSERT(spdk_nvmf_subsystem_set_sn(&subsystem, "123456789012345678901") < 0); 440 441 /* Non-ASCII characters (invalid) */ 442 CU_ASSERT(spdk_nvmf_subsystem_set_sn(&subsystem, "abcd\txyz") < 0); 443 } 444 445 int main(int argc, char **argv) 446 { 447 CU_pSuite suite = NULL; 448 unsigned int num_failures; 449 450 if (CU_initialize_registry() != CUE_SUCCESS) { 451 return CU_get_error(); 452 } 453 454 suite = CU_add_suite("nvmf", NULL, NULL); 455 if (suite == NULL) { 456 CU_cleanup_registry(); 457 return CU_get_error(); 458 } 459 460 if ( 461 CU_add_test(suite, "create_subsystem", nvmf_test_create_subsystem) == NULL || 462 CU_add_test(suite, "nvmf_subsystem_add_ns", test_spdk_nvmf_subsystem_add_ns) == NULL || 463 CU_add_test(suite, "nvmf_subsystem_set_sn", test_spdk_nvmf_subsystem_set_sn) == NULL) { 464 CU_cleanup_registry(); 465 return CU_get_error(); 466 } 467 468 spdk_allocate_thread(_subsystem_send_msg, NULL, NULL, NULL, "thread0"); 469 CU_basic_set_mode(CU_BRM_VERBOSE); 470 CU_basic_run_tests(); 471 num_failures = CU_get_number_of_failures(); 472 CU_cleanup_registry(); 473 spdk_free_thread(); 474 475 return num_failures; 476 } 477