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