1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2016 Intel Corporation. All rights reserved. 3 * Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved. 4 * Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 */ 6 7 #include "spdk/stdinc.h" 8 9 #include "nvmf_internal.h" 10 #include "transport.h" 11 12 #include "spdk/assert.h" 13 #include "spdk/likely.h" 14 #include "spdk/string.h" 15 #include "spdk/trace.h" 16 #include "spdk/nvmf_spec.h" 17 #include "spdk/uuid.h" 18 #include "spdk/json.h" 19 #include "spdk/file.h" 20 #include "spdk/bit_array.h" 21 #include "spdk/bdev.h" 22 23 #define __SPDK_BDEV_MODULE_ONLY 24 #include "spdk/bdev_module.h" 25 #include "spdk/log.h" 26 #include "spdk_internal/utf.h" 27 #include "spdk_internal/usdt.h" 28 29 #define MODEL_NUMBER_DEFAULT "SPDK bdev Controller" 30 #define NVMF_SUBSYSTEM_DEFAULT_NAMESPACES 32 31 32 /* 33 * States for parsing valid domains in NQNs according to RFC 1034 34 */ 35 enum spdk_nvmf_nqn_domain_states { 36 /* First character of a domain must be a letter */ 37 SPDK_NVMF_DOMAIN_ACCEPT_LETTER = 0, 38 39 /* Subsequent characters can be any of letter, digit, or hyphen */ 40 SPDK_NVMF_DOMAIN_ACCEPT_LDH = 1, 41 42 /* A domain label must end with either a letter or digit */ 43 SPDK_NVMF_DOMAIN_ACCEPT_ANY = 2 44 }; 45 46 static int _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem); 47 48 /* Returns true if is a valid ASCII string as defined by the NVMe spec */ 49 static bool 50 nvmf_valid_ascii_string(const void *buf, size_t size) 51 { 52 const uint8_t *str = buf; 53 size_t i; 54 55 for (i = 0; i < size; i++) { 56 if (str[i] < 0x20 || str[i] > 0x7E) { 57 return false; 58 } 59 } 60 61 return true; 62 } 63 64 bool 65 nvmf_nqn_is_valid(const char *nqn) 66 { 67 size_t len; 68 struct spdk_uuid uuid_value; 69 uint32_t i; 70 int bytes_consumed; 71 uint32_t domain_label_length; 72 char *reverse_domain_end; 73 uint32_t reverse_domain_end_index; 74 enum spdk_nvmf_nqn_domain_states domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER; 75 76 /* Check for length requirements */ 77 len = strlen(nqn); 78 if (len > SPDK_NVMF_NQN_MAX_LEN) { 79 SPDK_ERRLOG("Invalid NQN \"%s\": length %zu > max %d\n", nqn, len, SPDK_NVMF_NQN_MAX_LEN); 80 return false; 81 } 82 83 /* The nqn must be at least as long as SPDK_NVMF_NQN_MIN_LEN to contain the necessary prefix. */ 84 if (len < SPDK_NVMF_NQN_MIN_LEN) { 85 SPDK_ERRLOG("Invalid NQN \"%s\": length %zu < min %d\n", nqn, len, SPDK_NVMF_NQN_MIN_LEN); 86 return false; 87 } 88 89 /* Check for discovery controller nqn */ 90 if (!strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN)) { 91 return true; 92 } 93 94 /* Check for equality with the generic nqn structure of the form "nqn.2014-08.org.nvmexpress:uuid:11111111-2222-3333-4444-555555555555" */ 95 if (!strncmp(nqn, SPDK_NVMF_NQN_UUID_PRE, SPDK_NVMF_NQN_UUID_PRE_LEN)) { 96 if (len != SPDK_NVMF_NQN_UUID_PRE_LEN + SPDK_NVMF_UUID_STRING_LEN) { 97 SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not the correct length\n", nqn); 98 return false; 99 } 100 101 if (spdk_uuid_parse(&uuid_value, &nqn[SPDK_NVMF_NQN_UUID_PRE_LEN])) { 102 SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not formatted correctly\n", nqn); 103 return false; 104 } 105 return true; 106 } 107 108 /* If the nqn does not match the uuid structure, the next several checks validate the form "nqn.yyyy-mm.reverse.domain:user-string" */ 109 110 if (strncmp(nqn, "nqn.", 4) != 0) { 111 SPDK_ERRLOG("Invalid NQN \"%s\": NQN must begin with \"nqn.\".\n", nqn); 112 return false; 113 } 114 115 /* Check for yyyy-mm. */ 116 if (!(isdigit(nqn[4]) && isdigit(nqn[5]) && isdigit(nqn[6]) && isdigit(nqn[7]) && 117 nqn[8] == '-' && isdigit(nqn[9]) && isdigit(nqn[10]) && nqn[11] == '.')) { 118 SPDK_ERRLOG("Invalid date code in NQN \"%s\"\n", nqn); 119 return false; 120 } 121 122 reverse_domain_end = strchr(nqn, ':'); 123 if (reverse_domain_end != NULL && (reverse_domain_end_index = reverse_domain_end - nqn) < len - 1) { 124 } else { 125 SPDK_ERRLOG("Invalid NQN \"%s\". NQN must contain user specified name with a ':' as a prefix.\n", 126 nqn); 127 return false; 128 } 129 130 /* Check for valid reverse domain */ 131 domain_label_length = 0; 132 for (i = 12; i < reverse_domain_end_index; i++) { 133 if (domain_label_length > SPDK_DOMAIN_LABEL_MAX_LEN) { 134 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". At least one Label is too long.\n", nqn); 135 return false; 136 } 137 138 switch (domain_state) { 139 140 case SPDK_NVMF_DOMAIN_ACCEPT_LETTER: { 141 if (isalpha(nqn[i])) { 142 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY; 143 domain_label_length++; 144 break; 145 } else { 146 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must start with a letter.\n", nqn); 147 return false; 148 } 149 } 150 151 case SPDK_NVMF_DOMAIN_ACCEPT_LDH: { 152 if (isalpha(nqn[i]) || isdigit(nqn[i])) { 153 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY; 154 domain_label_length++; 155 break; 156 } else if (nqn[i] == '-') { 157 if (i == reverse_domain_end_index - 1) { 158 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n", 159 nqn); 160 return false; 161 } 162 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH; 163 domain_label_length++; 164 break; 165 } else if (nqn[i] == '.') { 166 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n", 167 nqn); 168 return false; 169 } else { 170 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n", 171 nqn); 172 return false; 173 } 174 } 175 176 case SPDK_NVMF_DOMAIN_ACCEPT_ANY: { 177 if (isalpha(nqn[i]) || isdigit(nqn[i])) { 178 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY; 179 domain_label_length++; 180 break; 181 } else if (nqn[i] == '-') { 182 if (i == reverse_domain_end_index - 1) { 183 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n", 184 nqn); 185 return false; 186 } 187 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH; 188 domain_label_length++; 189 break; 190 } else if (nqn[i] == '.') { 191 domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER; 192 domain_label_length = 0; 193 break; 194 } else { 195 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n", 196 nqn); 197 return false; 198 } 199 } 200 } 201 } 202 203 i = reverse_domain_end_index + 1; 204 while (i < len) { 205 bytes_consumed = utf8_valid(&nqn[i], &nqn[len]); 206 if (bytes_consumed <= 0) { 207 SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only valid utf-8.\n", nqn); 208 return false; 209 } 210 211 i += bytes_consumed; 212 } 213 return true; 214 } 215 216 static void subsystem_state_change_on_pg(struct spdk_io_channel_iter *i); 217 218 struct spdk_nvmf_subsystem * 219 spdk_nvmf_subsystem_create(struct spdk_nvmf_tgt *tgt, 220 const char *nqn, 221 enum spdk_nvmf_subtype type, 222 uint32_t num_ns) 223 { 224 struct spdk_nvmf_subsystem *subsystem; 225 uint32_t sid; 226 227 if (spdk_nvmf_tgt_find_subsystem(tgt, nqn)) { 228 SPDK_ERRLOG("Subsystem NQN '%s' already exists\n", nqn); 229 return NULL; 230 } 231 232 if (!nvmf_nqn_is_valid(nqn)) { 233 SPDK_ERRLOG("Subsystem NQN '%s' is invalid\n", nqn); 234 return NULL; 235 } 236 237 if (type == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT || 238 type == SPDK_NVMF_SUBTYPE_DISCOVERY) { 239 if (num_ns != 0) { 240 SPDK_ERRLOG("Discovery subsystem cannot have namespaces.\n"); 241 return NULL; 242 } 243 } else if (num_ns == 0) { 244 num_ns = NVMF_SUBSYSTEM_DEFAULT_NAMESPACES; 245 } 246 247 /* Find a free subsystem id (sid) */ 248 sid = spdk_bit_array_find_first_clear(tgt->subsystem_ids, 0); 249 if (sid == UINT32_MAX) { 250 SPDK_ERRLOG("No free subsystem IDs are available for subsystem creation\n"); 251 return NULL; 252 } 253 subsystem = calloc(1, sizeof(struct spdk_nvmf_subsystem)); 254 if (subsystem == NULL) { 255 SPDK_ERRLOG("Subsystem memory allocation failed\n"); 256 return NULL; 257 } 258 259 subsystem->thread = spdk_get_thread(); 260 subsystem->state = SPDK_NVMF_SUBSYSTEM_INACTIVE; 261 subsystem->tgt = tgt; 262 subsystem->id = sid; 263 subsystem->subtype = type; 264 subsystem->max_nsid = num_ns; 265 subsystem->next_cntlid = 1; 266 subsystem->min_cntlid = NVMF_MIN_CNTLID; 267 subsystem->max_cntlid = NVMF_MAX_CNTLID; 268 snprintf(subsystem->subnqn, sizeof(subsystem->subnqn), "%s", nqn); 269 pthread_mutex_init(&subsystem->mutex, NULL); 270 TAILQ_INIT(&subsystem->listeners); 271 TAILQ_INIT(&subsystem->hosts); 272 TAILQ_INIT(&subsystem->ctrlrs); 273 TAILQ_INIT(&subsystem->state_changes); 274 subsystem->used_listener_ids = spdk_bit_array_create(NVMF_MAX_LISTENERS_PER_SUBSYSTEM); 275 if (subsystem->used_listener_ids == NULL) { 276 pthread_mutex_destroy(&subsystem->mutex); 277 free(subsystem); 278 SPDK_ERRLOG("Listener id array memory allocation failed\n"); 279 return NULL; 280 } 281 282 if (num_ns != 0) { 283 subsystem->ns = calloc(num_ns, sizeof(struct spdk_nvmf_ns *)); 284 if (subsystem->ns == NULL) { 285 SPDK_ERRLOG("Namespace memory allocation failed\n"); 286 pthread_mutex_destroy(&subsystem->mutex); 287 spdk_bit_array_free(&subsystem->used_listener_ids); 288 free(subsystem); 289 return NULL; 290 } 291 subsystem->ana_group = calloc(num_ns, sizeof(uint32_t)); 292 if (subsystem->ana_group == NULL) { 293 SPDK_ERRLOG("ANA group memory allocation failed\n"); 294 pthread_mutex_destroy(&subsystem->mutex); 295 free(subsystem->ns); 296 spdk_bit_array_free(&subsystem->used_listener_ids); 297 free(subsystem); 298 return NULL; 299 } 300 } 301 302 memset(subsystem->sn, '0', sizeof(subsystem->sn) - 1); 303 subsystem->sn[sizeof(subsystem->sn) - 1] = '\0'; 304 305 snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", 306 MODEL_NUMBER_DEFAULT); 307 308 spdk_bit_array_set(tgt->subsystem_ids, sid); 309 RB_INSERT(subsystem_tree, &tgt->subsystems, subsystem); 310 311 SPDK_DTRACE_PROBE1(nvmf_subsystem_create, subsystem->subnqn); 312 313 return subsystem; 314 } 315 316 static void 317 nvmf_host_free(struct spdk_nvmf_host *host) 318 { 319 spdk_keyring_put_key(host->dhchap_key); 320 spdk_keyring_put_key(host->dhchap_ctrlr_key); 321 free(host); 322 } 323 324 /* Must hold subsystem->mutex while calling this function */ 325 static void 326 nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *host) 327 { 328 TAILQ_REMOVE(&subsystem->hosts, host, link); 329 nvmf_host_free(host); 330 } 331 332 static void 333 _nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem, 334 struct spdk_nvmf_subsystem_listener *listener, 335 bool stop) 336 { 337 struct spdk_nvmf_transport *transport; 338 struct spdk_nvmf_ctrlr *ctrlr; 339 340 if (stop) { 341 transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, listener->trid->trstring); 342 if (transport != NULL) { 343 spdk_nvmf_transport_stop_listen(transport, listener->trid); 344 } 345 } 346 347 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 348 if (ctrlr->listener == listener) { 349 ctrlr->listener = NULL; 350 } 351 } 352 353 TAILQ_REMOVE(&subsystem->listeners, listener, link); 354 if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) { 355 nvmf_tgt_update_mdns_prr(listener->subsystem->tgt); 356 } 357 spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL); 358 free(listener->ana_state); 359 spdk_bit_array_clear(subsystem->used_listener_ids, listener->id); 360 free(listener->opts.sock_impl); 361 free(listener); 362 } 363 364 static void 365 _nvmf_subsystem_destroy_msg(void *cb_arg) 366 { 367 struct spdk_nvmf_subsystem *subsystem = cb_arg; 368 369 _nvmf_subsystem_destroy(subsystem); 370 } 371 372 static int 373 _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem) 374 { 375 struct nvmf_subsystem_state_change_ctx *ctx; 376 struct spdk_nvmf_ns *ns; 377 nvmf_subsystem_destroy_cb async_destroy_cb = NULL; 378 void *async_destroy_cb_arg = NULL; 379 int rc; 380 381 if (!TAILQ_EMPTY(&subsystem->ctrlrs)) { 382 SPDK_DEBUGLOG(nvmf, "subsystem %p %s has active controllers\n", subsystem, subsystem->subnqn); 383 subsystem->async_destroy = true; 384 rc = spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_destroy_msg, subsystem); 385 if (rc) { 386 SPDK_ERRLOG("Failed to send thread msg, rc %d\n", rc); 387 assert(0); 388 return rc; 389 } 390 return -EINPROGRESS; 391 } 392 393 ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 394 while (ns != NULL) { 395 struct spdk_nvmf_ns *next_ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns); 396 397 spdk_nvmf_subsystem_remove_ns(subsystem, ns->opts.nsid); 398 ns = next_ns; 399 } 400 401 while ((ctx = TAILQ_FIRST(&subsystem->state_changes))) { 402 SPDK_WARNLOG("subsystem %s has pending state change requests\n", subsystem->subnqn); 403 TAILQ_REMOVE(&subsystem->state_changes, ctx, link); 404 if (ctx->cb_fn != NULL) { 405 ctx->cb_fn(subsystem, ctx->cb_arg, -ECANCELED); 406 } 407 free(ctx); 408 } 409 410 free(subsystem->ns); 411 free(subsystem->ana_group); 412 413 RB_REMOVE(subsystem_tree, &subsystem->tgt->subsystems, subsystem); 414 assert(spdk_bit_array_get(subsystem->tgt->subsystem_ids, subsystem->id) == true); 415 spdk_bit_array_clear(subsystem->tgt->subsystem_ids, subsystem->id); 416 417 pthread_mutex_destroy(&subsystem->mutex); 418 419 spdk_bit_array_free(&subsystem->used_listener_ids); 420 421 if (subsystem->async_destroy) { 422 async_destroy_cb = subsystem->async_destroy_cb; 423 async_destroy_cb_arg = subsystem->async_destroy_cb_arg; 424 } 425 426 free(subsystem); 427 428 if (async_destroy_cb) { 429 async_destroy_cb(async_destroy_cb_arg); 430 } 431 432 return 0; 433 } 434 435 static struct spdk_nvmf_ns * 436 _nvmf_subsystem_get_first_zoned_ns(struct spdk_nvmf_subsystem *subsystem) 437 { 438 struct spdk_nvmf_ns *ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 439 while (ns != NULL) { 440 if (ns->csi == SPDK_NVME_CSI_ZNS) { 441 return ns; 442 } 443 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns); 444 } 445 return NULL; 446 } 447 448 int 449 spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem, nvmf_subsystem_destroy_cb cpl_cb, 450 void *cpl_cb_arg) 451 { 452 struct spdk_nvmf_host *host, *host_tmp; 453 struct spdk_nvmf_transport *transport; 454 455 if (!subsystem) { 456 return -EINVAL; 457 } 458 459 SPDK_DTRACE_PROBE1(nvmf_subsystem_destroy, subsystem->subnqn); 460 461 assert(spdk_get_thread() == subsystem->thread); 462 463 if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) { 464 SPDK_ERRLOG("Subsystem can only be destroyed in inactive state, %s state %d\n", 465 subsystem->subnqn, subsystem->state); 466 return -EAGAIN; 467 } 468 if (subsystem->destroying) { 469 SPDK_ERRLOG("Subsystem destruction is already started\n"); 470 assert(0); 471 return -EALREADY; 472 } 473 474 subsystem->destroying = true; 475 476 SPDK_DEBUGLOG(nvmf, "subsystem is %p %s\n", subsystem, subsystem->subnqn); 477 478 nvmf_subsystem_remove_all_listeners(subsystem, false); 479 480 pthread_mutex_lock(&subsystem->mutex); 481 482 TAILQ_FOREACH_SAFE(host, &subsystem->hosts, link, host_tmp) { 483 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 484 transport = spdk_nvmf_transport_get_next(transport)) { 485 if (transport->ops->subsystem_remove_host) { 486 transport->ops->subsystem_remove_host(transport, subsystem, host->nqn); 487 } 488 } 489 nvmf_subsystem_remove_host(subsystem, host); 490 } 491 492 pthread_mutex_unlock(&subsystem->mutex); 493 494 subsystem->async_destroy_cb = cpl_cb; 495 subsystem->async_destroy_cb_arg = cpl_cb_arg; 496 497 return _nvmf_subsystem_destroy(subsystem); 498 } 499 500 /* we have to use the typedef in the function declaration to appease astyle. */ 501 typedef enum spdk_nvmf_subsystem_state spdk_nvmf_subsystem_state_t; 502 503 static spdk_nvmf_subsystem_state_t 504 nvmf_subsystem_get_intermediate_state(enum spdk_nvmf_subsystem_state current_state, 505 enum spdk_nvmf_subsystem_state requested_state) 506 { 507 switch (requested_state) { 508 case SPDK_NVMF_SUBSYSTEM_INACTIVE: 509 return SPDK_NVMF_SUBSYSTEM_DEACTIVATING; 510 case SPDK_NVMF_SUBSYSTEM_ACTIVE: 511 if (current_state == SPDK_NVMF_SUBSYSTEM_PAUSED) { 512 return SPDK_NVMF_SUBSYSTEM_RESUMING; 513 } else { 514 return SPDK_NVMF_SUBSYSTEM_ACTIVATING; 515 } 516 case SPDK_NVMF_SUBSYSTEM_PAUSED: 517 return SPDK_NVMF_SUBSYSTEM_PAUSING; 518 default: 519 assert(false); 520 return SPDK_NVMF_SUBSYSTEM_NUM_STATES; 521 } 522 } 523 524 static int 525 nvmf_subsystem_set_state(struct spdk_nvmf_subsystem *subsystem, 526 enum spdk_nvmf_subsystem_state state) 527 { 528 enum spdk_nvmf_subsystem_state actual_old_state, expected_old_state; 529 bool exchanged; 530 531 switch (state) { 532 case SPDK_NVMF_SUBSYSTEM_INACTIVE: 533 expected_old_state = SPDK_NVMF_SUBSYSTEM_DEACTIVATING; 534 break; 535 case SPDK_NVMF_SUBSYSTEM_ACTIVATING: 536 expected_old_state = SPDK_NVMF_SUBSYSTEM_INACTIVE; 537 break; 538 case SPDK_NVMF_SUBSYSTEM_ACTIVE: 539 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING; 540 break; 541 case SPDK_NVMF_SUBSYSTEM_PAUSING: 542 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 543 break; 544 case SPDK_NVMF_SUBSYSTEM_PAUSED: 545 expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSING; 546 break; 547 case SPDK_NVMF_SUBSYSTEM_RESUMING: 548 expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED; 549 break; 550 case SPDK_NVMF_SUBSYSTEM_DEACTIVATING: 551 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 552 break; 553 default: 554 assert(false); 555 return -1; 556 } 557 558 actual_old_state = expected_old_state; 559 exchanged = __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false, 560 __ATOMIC_RELAXED, __ATOMIC_RELAXED); 561 if (spdk_unlikely(exchanged == false)) { 562 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING && 563 state == SPDK_NVMF_SUBSYSTEM_ACTIVE) { 564 expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING; 565 } 566 /* This is for the case when activating the subsystem fails. */ 567 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_ACTIVATING && 568 state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) { 569 expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING; 570 } 571 /* This is for the case when resuming the subsystem fails. */ 572 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING && 573 state == SPDK_NVMF_SUBSYSTEM_PAUSING) { 574 expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING; 575 } 576 /* This is for the case when stopping paused subsystem */ 577 if (actual_old_state == SPDK_NVMF_SUBSYSTEM_PAUSED && 578 state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) { 579 expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED; 580 } 581 actual_old_state = expected_old_state; 582 __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false, 583 __ATOMIC_RELAXED, __ATOMIC_RELAXED); 584 } 585 assert(actual_old_state == expected_old_state); 586 return actual_old_state - expected_old_state; 587 } 588 589 static void nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx); 590 591 static void 592 _nvmf_subsystem_state_change_complete(void *_ctx) 593 { 594 struct nvmf_subsystem_state_change_ctx *next, *ctx = _ctx; 595 struct spdk_nvmf_subsystem *subsystem = ctx->subsystem; 596 597 pthread_mutex_lock(&subsystem->mutex); 598 assert(TAILQ_FIRST(&subsystem->state_changes) == ctx); 599 TAILQ_REMOVE(&subsystem->state_changes, ctx, link); 600 next = TAILQ_FIRST(&subsystem->state_changes); 601 pthread_mutex_unlock(&subsystem->mutex); 602 603 if (ctx->cb_fn != NULL) { 604 ctx->cb_fn(subsystem, ctx->cb_arg, ctx->status); 605 } 606 free(ctx); 607 608 if (next != NULL) { 609 nvmf_subsystem_do_state_change(next); 610 } 611 } 612 613 static void 614 nvmf_subsystem_state_change_complete(struct nvmf_subsystem_state_change_ctx *ctx, int status) 615 { 616 ctx->status = status; 617 spdk_thread_exec_msg(ctx->thread, _nvmf_subsystem_state_change_complete, ctx); 618 } 619 620 static void 621 subsystem_state_change_revert_done(struct spdk_io_channel_iter *i, int status) 622 { 623 struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 624 625 /* Nothing to be done here if the state setting fails, we are just screwed. */ 626 if (nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state)) { 627 SPDK_ERRLOG("Unable to revert the subsystem state after operation failure.\n"); 628 } 629 630 /* return a failure here. This function only exists in an error path. */ 631 nvmf_subsystem_state_change_complete(ctx, -1); 632 } 633 634 static void 635 subsystem_state_change_done(struct spdk_io_channel_iter *i, int status) 636 { 637 struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 638 enum spdk_nvmf_subsystem_state intermediate_state; 639 640 SPDK_DTRACE_PROBE4(nvmf_subsystem_change_state_done, ctx->subsystem->subnqn, 641 ctx->requested_state, ctx->original_state, status); 642 643 if (status == 0) { 644 status = nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state); 645 if (status) { 646 status = -1; 647 } 648 } 649 650 if (status) { 651 intermediate_state = nvmf_subsystem_get_intermediate_state(ctx->requested_state, 652 ctx->original_state); 653 assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES); 654 655 if (nvmf_subsystem_set_state(ctx->subsystem, intermediate_state)) { 656 goto out; 657 } 658 ctx->requested_state = ctx->original_state; 659 spdk_for_each_channel(ctx->subsystem->tgt, 660 subsystem_state_change_on_pg, 661 ctx, 662 subsystem_state_change_revert_done); 663 return; 664 } 665 666 out: 667 nvmf_subsystem_state_change_complete(ctx, status); 668 } 669 670 static void 671 subsystem_state_change_continue(void *ctx, int status) 672 { 673 struct spdk_io_channel_iter *i = ctx; 674 struct nvmf_subsystem_state_change_ctx *_ctx __attribute__((unused)); 675 676 _ctx = spdk_io_channel_iter_get_ctx(i); 677 SPDK_DTRACE_PROBE3(nvmf_pg_change_state_done, _ctx->subsystem->subnqn, 678 _ctx->requested_state, spdk_thread_get_id(spdk_get_thread())); 679 680 spdk_for_each_channel_continue(i, status); 681 } 682 683 static void 684 subsystem_state_change_on_pg(struct spdk_io_channel_iter *i) 685 { 686 struct nvmf_subsystem_state_change_ctx *ctx; 687 struct spdk_io_channel *ch; 688 struct spdk_nvmf_poll_group *group; 689 690 ctx = spdk_io_channel_iter_get_ctx(i); 691 ch = spdk_io_channel_iter_get_channel(i); 692 group = spdk_io_channel_get_ctx(ch); 693 694 SPDK_DTRACE_PROBE3(nvmf_pg_change_state, ctx->subsystem->subnqn, 695 ctx->requested_state, spdk_thread_get_id(spdk_get_thread())); 696 switch (ctx->requested_state) { 697 case SPDK_NVMF_SUBSYSTEM_INACTIVE: 698 nvmf_poll_group_remove_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i); 699 break; 700 case SPDK_NVMF_SUBSYSTEM_ACTIVE: 701 if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_ACTIVATING) { 702 nvmf_poll_group_add_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i); 703 } else if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_RESUMING) { 704 nvmf_poll_group_resume_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i); 705 } 706 break; 707 case SPDK_NVMF_SUBSYSTEM_PAUSED: 708 nvmf_poll_group_pause_subsystem(group, ctx->subsystem, ctx->nsid, subsystem_state_change_continue, 709 i); 710 break; 711 default: 712 assert(false); 713 break; 714 } 715 } 716 717 static void 718 nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx) 719 { 720 struct spdk_nvmf_subsystem *subsystem = ctx->subsystem; 721 enum spdk_nvmf_subsystem_state intermediate_state; 722 int rc; 723 724 SPDK_DTRACE_PROBE3(nvmf_subsystem_change_state, subsystem->subnqn, 725 ctx->requested_state, subsystem->state); 726 727 /* If we are already in the requested state, just call the callback immediately. */ 728 if (subsystem->state == ctx->requested_state) { 729 nvmf_subsystem_state_change_complete(ctx, 0); 730 return; 731 } 732 733 intermediate_state = nvmf_subsystem_get_intermediate_state(subsystem->state, 734 ctx->requested_state); 735 assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES); 736 737 ctx->original_state = subsystem->state; 738 rc = nvmf_subsystem_set_state(subsystem, intermediate_state); 739 if (rc) { 740 nvmf_subsystem_state_change_complete(ctx, -1); 741 return; 742 } 743 744 spdk_for_each_channel(subsystem->tgt, 745 subsystem_state_change_on_pg, 746 ctx, 747 subsystem_state_change_done); 748 } 749 750 751 static int 752 nvmf_subsystem_state_change(struct spdk_nvmf_subsystem *subsystem, 753 uint32_t nsid, 754 enum spdk_nvmf_subsystem_state requested_state, 755 spdk_nvmf_subsystem_state_change_done cb_fn, 756 void *cb_arg) 757 { 758 struct nvmf_subsystem_state_change_ctx *ctx; 759 struct spdk_thread *thread; 760 761 thread = spdk_get_thread(); 762 if (thread == NULL) { 763 return -EINVAL; 764 } 765 766 ctx = calloc(1, sizeof(*ctx)); 767 if (!ctx) { 768 return -ENOMEM; 769 } 770 771 ctx->subsystem = subsystem; 772 ctx->nsid = nsid; 773 ctx->requested_state = requested_state; 774 ctx->cb_fn = cb_fn; 775 ctx->cb_arg = cb_arg; 776 ctx->thread = thread; 777 778 pthread_mutex_lock(&subsystem->mutex); 779 TAILQ_INSERT_TAIL(&subsystem->state_changes, ctx, link); 780 if (ctx != TAILQ_FIRST(&subsystem->state_changes)) { 781 pthread_mutex_unlock(&subsystem->mutex); 782 return 0; 783 } 784 pthread_mutex_unlock(&subsystem->mutex); 785 786 nvmf_subsystem_do_state_change(ctx); 787 788 return 0; 789 } 790 791 int 792 spdk_nvmf_subsystem_start(struct spdk_nvmf_subsystem *subsystem, 793 spdk_nvmf_subsystem_state_change_done cb_fn, 794 void *cb_arg) 795 { 796 return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg); 797 } 798 799 int 800 spdk_nvmf_subsystem_stop(struct spdk_nvmf_subsystem *subsystem, 801 spdk_nvmf_subsystem_state_change_done cb_fn, 802 void *cb_arg) 803 { 804 return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_INACTIVE, cb_fn, cb_arg); 805 } 806 807 int 808 spdk_nvmf_subsystem_pause(struct spdk_nvmf_subsystem *subsystem, 809 uint32_t nsid, 810 spdk_nvmf_subsystem_state_change_done cb_fn, 811 void *cb_arg) 812 { 813 return nvmf_subsystem_state_change(subsystem, nsid, SPDK_NVMF_SUBSYSTEM_PAUSED, cb_fn, cb_arg); 814 } 815 816 int 817 spdk_nvmf_subsystem_resume(struct spdk_nvmf_subsystem *subsystem, 818 spdk_nvmf_subsystem_state_change_done cb_fn, 819 void *cb_arg) 820 { 821 return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg); 822 } 823 824 struct spdk_nvmf_subsystem * 825 spdk_nvmf_subsystem_get_first(struct spdk_nvmf_tgt *tgt) 826 { 827 return RB_MIN(subsystem_tree, &tgt->subsystems); 828 } 829 830 struct spdk_nvmf_subsystem * 831 spdk_nvmf_subsystem_get_next(struct spdk_nvmf_subsystem *subsystem) 832 { 833 if (!subsystem) { 834 return NULL; 835 } 836 837 return RB_NEXT(subsystem_tree, &tgt->subsystems, subsystem); 838 } 839 840 static int 841 nvmf_ns_add_host(struct spdk_nvmf_ns *ns, const char *hostnqn) 842 { 843 struct spdk_nvmf_host *host; 844 845 host = calloc(1, sizeof(*host)); 846 if (!host) { 847 return -ENOMEM; 848 } 849 snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn); 850 TAILQ_INSERT_HEAD(&ns->hosts, host, link); 851 return 0; 852 } 853 854 static void 855 nvmf_ns_remove_host(struct spdk_nvmf_ns *ns, struct spdk_nvmf_host *host) 856 { 857 TAILQ_REMOVE(&ns->hosts, host, link); 858 free(host); 859 } 860 861 static void 862 _async_event_ns_notice(void *_ctrlr) 863 { 864 struct spdk_nvmf_ctrlr *ctrlr = _ctrlr; 865 866 nvmf_ctrlr_async_event_ns_notice(ctrlr); 867 } 868 869 static void 870 send_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 871 { 872 spdk_thread_send_msg(ctrlr->thread, _async_event_ns_notice, ctrlr); 873 } 874 875 static int 876 nvmf_ns_visible(struct spdk_nvmf_subsystem *subsystem, 877 uint32_t nsid, 878 const char *hostnqn, 879 bool visible) 880 { 881 struct spdk_nvmf_ns *ns; 882 struct spdk_nvmf_ctrlr *ctrlr; 883 struct spdk_nvmf_host *host; 884 int rc; 885 886 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 887 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 888 assert(false); 889 return -1; 890 } 891 892 if (hostnqn == NULL || !nvmf_nqn_is_valid(hostnqn)) { 893 return -EINVAL; 894 } 895 896 if (nsid == 0 || nsid > subsystem->max_nsid) { 897 return -EINVAL; 898 } 899 900 ns = subsystem->ns[nsid - 1]; 901 if (!ns) { 902 return -ENOENT; 903 } 904 905 if (ns->always_visible) { 906 /* No individual host control */ 907 return -EPERM; 908 } 909 910 /* Save host info to use for any future controllers. */ 911 host = nvmf_ns_find_host(ns, hostnqn); 912 if (visible && host == NULL) { 913 rc = nvmf_ns_add_host(ns, hostnqn); 914 if (rc) { 915 return rc; 916 } 917 } else if (!visible && host != NULL) { 918 nvmf_ns_remove_host(ns, host); 919 } 920 921 /* Also apply to existing controllers. */ 922 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 923 if (strcmp(hostnqn, ctrlr->hostnqn) || 924 nvmf_ctrlr_ns_is_visible(ctrlr, nsid) == visible) { 925 continue; 926 } 927 nvmf_ctrlr_ns_set_visible(ctrlr, nsid, visible); 928 send_async_event_ns_notice(ctrlr); 929 nvmf_ctrlr_ns_changed(ctrlr, nsid); 930 } 931 932 return 0; 933 } 934 935 int 936 spdk_nvmf_ns_add_host(struct spdk_nvmf_subsystem *subsystem, 937 uint32_t nsid, 938 const char *hostnqn, 939 uint32_t flags) 940 { 941 SPDK_DTRACE_PROBE4(spdk_nvmf_ns_add_host, 942 subsystem->subnqn, 943 nsid, 944 hostnqn, 945 flags); 946 return nvmf_ns_visible(subsystem, nsid, hostnqn, true); 947 } 948 949 int 950 spdk_nvmf_ns_remove_host(struct spdk_nvmf_subsystem *subsystem, 951 uint32_t nsid, 952 const char *hostnqn, 953 uint32_t flags) 954 { 955 SPDK_DTRACE_PROBE4(spdk_nvmf_ns_remove_host, 956 subsystem->subnqn, 957 nsid, 958 hostnqn, 959 flags); 960 return nvmf_ns_visible(subsystem, nsid, hostnqn, false); 961 } 962 963 /* Must hold subsystem->mutex while calling this function */ 964 static struct spdk_nvmf_host * 965 nvmf_subsystem_find_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 966 { 967 struct spdk_nvmf_host *host = NULL; 968 969 TAILQ_FOREACH(host, &subsystem->hosts, link) { 970 if (strcmp(hostnqn, host->nqn) == 0) { 971 return host; 972 } 973 } 974 975 return NULL; 976 } 977 978 int 979 spdk_nvmf_subsystem_add_host_ext(struct spdk_nvmf_subsystem *subsystem, 980 const char *hostnqn, struct spdk_nvmf_host_opts *opts) 981 { 982 struct spdk_nvmf_host *host; 983 struct spdk_nvmf_transport *transport; 984 struct spdk_key *key; 985 int rc; 986 987 if (!nvmf_nqn_is_valid(hostnqn)) { 988 return -EINVAL; 989 } 990 991 pthread_mutex_lock(&subsystem->mutex); 992 993 if (nvmf_subsystem_find_host(subsystem, hostnqn)) { 994 /* This subsystem already allows the specified host. */ 995 pthread_mutex_unlock(&subsystem->mutex); 996 return -EINVAL; 997 } 998 999 host = calloc(1, sizeof(*host)); 1000 if (!host) { 1001 pthread_mutex_unlock(&subsystem->mutex); 1002 return -ENOMEM; 1003 } 1004 1005 key = SPDK_GET_FIELD(opts, dhchap_key, NULL); 1006 if (key != NULL) { 1007 if (!nvmf_auth_is_supported()) { 1008 SPDK_ERRLOG("NVMe in-band authentication is unsupported\n"); 1009 pthread_mutex_unlock(&subsystem->mutex); 1010 nvmf_host_free(host); 1011 return -EINVAL; 1012 } 1013 host->dhchap_key = spdk_key_dup(key); 1014 if (host->dhchap_key == NULL) { 1015 pthread_mutex_unlock(&subsystem->mutex); 1016 nvmf_host_free(host); 1017 return -EINVAL; 1018 } 1019 key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL); 1020 if (key != NULL) { 1021 host->dhchap_ctrlr_key = spdk_key_dup(key); 1022 if (host->dhchap_ctrlr_key == NULL) { 1023 pthread_mutex_unlock(&subsystem->mutex); 1024 nvmf_host_free(host); 1025 return -EINVAL; 1026 } 1027 } 1028 } else if (SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL) != NULL) { 1029 SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n"); 1030 pthread_mutex_unlock(&subsystem->mutex); 1031 nvmf_host_free(host); 1032 return -EINVAL; 1033 } 1034 1035 snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn); 1036 1037 SPDK_DTRACE_PROBE2(nvmf_subsystem_add_host, subsystem->subnqn, host->nqn); 1038 1039 TAILQ_INSERT_HEAD(&subsystem->hosts, host, link); 1040 1041 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1042 spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn); 1043 } 1044 1045 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1046 transport = spdk_nvmf_transport_get_next(transport)) { 1047 if (transport->ops->subsystem_add_host) { 1048 rc = transport->ops->subsystem_add_host(transport, subsystem, hostnqn, 1049 SPDK_GET_FIELD(opts, params, NULL)); 1050 if (rc) { 1051 SPDK_ERRLOG("Unable to add host to %s transport\n", transport->ops->name); 1052 /* Remove this host from all transports we've managed to add it to. */ 1053 pthread_mutex_unlock(&subsystem->mutex); 1054 spdk_nvmf_subsystem_remove_host(subsystem, hostnqn); 1055 return rc; 1056 } 1057 } 1058 } 1059 1060 pthread_mutex_unlock(&subsystem->mutex); 1061 1062 return 0; 1063 } 1064 1065 int 1066 spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1067 const struct spdk_json_val *params) 1068 { 1069 struct spdk_nvmf_host_opts opts = {}; 1070 1071 opts.size = SPDK_SIZEOF(&opts, params); 1072 opts.params = params; 1073 1074 return spdk_nvmf_subsystem_add_host_ext(subsystem, hostnqn, &opts); 1075 } 1076 1077 int 1078 spdk_nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1079 { 1080 struct spdk_nvmf_host *host; 1081 struct spdk_nvmf_transport *transport; 1082 1083 pthread_mutex_lock(&subsystem->mutex); 1084 1085 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1086 if (host == NULL) { 1087 pthread_mutex_unlock(&subsystem->mutex); 1088 return -ENOENT; 1089 } 1090 1091 SPDK_DTRACE_PROBE2(nvmf_subsystem_remove_host, subsystem->subnqn, host->nqn); 1092 1093 nvmf_subsystem_remove_host(subsystem, host); 1094 1095 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1096 spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn); 1097 } 1098 1099 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1100 transport = spdk_nvmf_transport_get_next(transport)) { 1101 if (transport->ops->subsystem_remove_host) { 1102 transport->ops->subsystem_remove_host(transport, subsystem, hostnqn); 1103 } 1104 } 1105 1106 pthread_mutex_unlock(&subsystem->mutex); 1107 1108 return 0; 1109 } 1110 1111 int 1112 spdk_nvmf_subsystem_set_keys(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1113 struct spdk_nvmf_subsystem_key_opts *opts) 1114 { 1115 struct spdk_nvmf_host *host; 1116 struct spdk_key *key, *ckey; 1117 1118 if (!nvmf_auth_is_supported()) { 1119 SPDK_ERRLOG("NVMe in-band authentication is unsupported\n"); 1120 return -EINVAL; 1121 } 1122 1123 pthread_mutex_lock(&subsystem->mutex); 1124 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1125 if (host == NULL) { 1126 pthread_mutex_unlock(&subsystem->mutex); 1127 return -EINVAL; 1128 } 1129 1130 if (SPDK_GET_FIELD(opts, dhchap_key, host->dhchap_key) == NULL && 1131 SPDK_GET_FIELD(opts, dhchap_ctrlr_key, host->dhchap_ctrlr_key) != NULL) { 1132 SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n"); 1133 pthread_mutex_unlock(&subsystem->mutex); 1134 return -EINVAL; 1135 } 1136 key = SPDK_GET_FIELD(opts, dhchap_key, NULL); 1137 if (key != NULL) { 1138 key = spdk_key_dup(key); 1139 if (key == NULL) { 1140 pthread_mutex_unlock(&subsystem->mutex); 1141 return -EINVAL; 1142 } 1143 } 1144 ckey = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL); 1145 if (ckey != NULL) { 1146 ckey = spdk_key_dup(ckey); 1147 if (ckey == NULL) { 1148 pthread_mutex_unlock(&subsystem->mutex); 1149 spdk_keyring_put_key(key); 1150 return -EINVAL; 1151 } 1152 } 1153 if (SPDK_FIELD_VALID(opts, dhchap_key)) { 1154 spdk_keyring_put_key(host->dhchap_key); 1155 host->dhchap_key = key; 1156 } 1157 if (SPDK_FIELD_VALID(opts, dhchap_ctrlr_key)) { 1158 spdk_keyring_put_key(host->dhchap_ctrlr_key); 1159 host->dhchap_ctrlr_key = ckey; 1160 } 1161 pthread_mutex_unlock(&subsystem->mutex); 1162 1163 return 0; 1164 } 1165 1166 struct nvmf_subsystem_disconnect_host_ctx { 1167 struct spdk_nvmf_subsystem *subsystem; 1168 char *hostnqn; 1169 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn; 1170 void *cb_arg; 1171 }; 1172 1173 static void 1174 nvmf_subsystem_disconnect_host_fini(struct spdk_io_channel_iter *i, int status) 1175 { 1176 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1177 1178 ctx = spdk_io_channel_iter_get_ctx(i); 1179 1180 if (ctx->cb_fn) { 1181 ctx->cb_fn(ctx->cb_arg, status); 1182 } 1183 free(ctx->hostnqn); 1184 free(ctx); 1185 } 1186 1187 static void 1188 nvmf_subsystem_disconnect_qpairs_by_host(struct spdk_io_channel_iter *i) 1189 { 1190 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1191 struct spdk_nvmf_poll_group *group; 1192 struct spdk_io_channel *ch; 1193 struct spdk_nvmf_qpair *qpair, *tmp_qpair; 1194 struct spdk_nvmf_ctrlr *ctrlr; 1195 1196 ctx = spdk_io_channel_iter_get_ctx(i); 1197 ch = spdk_io_channel_iter_get_channel(i); 1198 group = spdk_io_channel_get_ctx(ch); 1199 1200 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) { 1201 ctrlr = qpair->ctrlr; 1202 1203 if (ctrlr == NULL || ctrlr->subsys != ctx->subsystem) { 1204 continue; 1205 } 1206 1207 if (strncmp(ctrlr->hostnqn, ctx->hostnqn, sizeof(ctrlr->hostnqn)) == 0) { 1208 /* Right now this does not wait for the queue pairs to actually disconnect. */ 1209 spdk_nvmf_qpair_disconnect(qpair); 1210 } 1211 } 1212 spdk_for_each_channel_continue(i, 0); 1213 } 1214 1215 int 1216 spdk_nvmf_subsystem_disconnect_host(struct spdk_nvmf_subsystem *subsystem, 1217 const char *hostnqn, 1218 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1219 void *cb_arg) 1220 { 1221 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1222 1223 ctx = calloc(1, sizeof(struct nvmf_subsystem_disconnect_host_ctx)); 1224 if (ctx == NULL) { 1225 return -ENOMEM; 1226 } 1227 1228 ctx->hostnqn = strdup(hostnqn); 1229 if (ctx->hostnqn == NULL) { 1230 free(ctx); 1231 return -ENOMEM; 1232 } 1233 1234 ctx->subsystem = subsystem; 1235 ctx->cb_fn = cb_fn; 1236 ctx->cb_arg = cb_arg; 1237 1238 spdk_for_each_channel(subsystem->tgt, nvmf_subsystem_disconnect_qpairs_by_host, ctx, 1239 nvmf_subsystem_disconnect_host_fini); 1240 1241 return 0; 1242 } 1243 1244 int 1245 spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem, bool allow_any_host) 1246 { 1247 pthread_mutex_lock(&subsystem->mutex); 1248 subsystem->allow_any_host = allow_any_host; 1249 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1250 spdk_nvmf_send_discovery_log_notice(subsystem->tgt, NULL); 1251 } 1252 pthread_mutex_unlock(&subsystem->mutex); 1253 1254 return 0; 1255 } 1256 1257 bool 1258 spdk_nvmf_subsystem_get_allow_any_host(const struct spdk_nvmf_subsystem *subsystem) 1259 { 1260 bool allow_any_host; 1261 struct spdk_nvmf_subsystem *sub; 1262 1263 /* Technically, taking the mutex modifies data in the subsystem. But the const 1264 * is still important to convey that this doesn't mutate any other data. Cast 1265 * it away to work around this. */ 1266 sub = (struct spdk_nvmf_subsystem *)subsystem; 1267 1268 pthread_mutex_lock(&sub->mutex); 1269 allow_any_host = sub->allow_any_host; 1270 pthread_mutex_unlock(&sub->mutex); 1271 1272 return allow_any_host; 1273 } 1274 1275 bool 1276 spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1277 { 1278 bool allowed; 1279 1280 if (!hostnqn) { 1281 return false; 1282 } 1283 1284 pthread_mutex_lock(&subsystem->mutex); 1285 1286 if (subsystem->allow_any_host) { 1287 pthread_mutex_unlock(&subsystem->mutex); 1288 return true; 1289 } 1290 1291 allowed = nvmf_subsystem_find_host(subsystem, hostnqn) != NULL; 1292 pthread_mutex_unlock(&subsystem->mutex); 1293 1294 return allowed; 1295 } 1296 1297 bool 1298 nvmf_subsystem_host_auth_required(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1299 { 1300 struct spdk_nvmf_host *host; 1301 bool status; 1302 1303 pthread_mutex_lock(&subsystem->mutex); 1304 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1305 status = host != NULL && host->dhchap_key != NULL; 1306 pthread_mutex_unlock(&subsystem->mutex); 1307 1308 return status; 1309 } 1310 1311 struct spdk_key * 1312 nvmf_subsystem_get_dhchap_key(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1313 enum nvmf_auth_key_type type) 1314 { 1315 struct spdk_nvmf_host *host; 1316 struct spdk_key *key = NULL; 1317 1318 pthread_mutex_lock(&subsystem->mutex); 1319 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1320 if (host != NULL) { 1321 switch (type) { 1322 case NVMF_AUTH_KEY_HOST: 1323 key = host->dhchap_key; 1324 break; 1325 case NVMF_AUTH_KEY_CTRLR: 1326 key = host->dhchap_ctrlr_key; 1327 break; 1328 } 1329 if (key != NULL) { 1330 key = spdk_key_dup(key); 1331 } 1332 } 1333 pthread_mutex_unlock(&subsystem->mutex); 1334 1335 return key; 1336 } 1337 1338 struct spdk_nvmf_host * 1339 spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem) 1340 { 1341 return TAILQ_FIRST(&subsystem->hosts); 1342 } 1343 1344 1345 struct spdk_nvmf_host * 1346 spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem, 1347 struct spdk_nvmf_host *prev_host) 1348 { 1349 return TAILQ_NEXT(prev_host, link); 1350 } 1351 1352 const char * 1353 spdk_nvmf_host_get_nqn(const struct spdk_nvmf_host *host) 1354 { 1355 return host->nqn; 1356 } 1357 1358 struct spdk_nvmf_subsystem_listener * 1359 nvmf_subsystem_find_listener(struct spdk_nvmf_subsystem *subsystem, 1360 const struct spdk_nvme_transport_id *trid) 1361 { 1362 struct spdk_nvmf_subsystem_listener *listener; 1363 1364 TAILQ_FOREACH(listener, &subsystem->listeners, link) { 1365 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) { 1366 return listener; 1367 } 1368 } 1369 1370 return NULL; 1371 } 1372 1373 /** 1374 * Function to be called once the target is listening. 1375 * 1376 * \param ctx Context argument passed to this function. 1377 * \param status 0 if it completed successfully, or negative errno if it failed. 1378 */ 1379 static void 1380 _nvmf_subsystem_add_listener_done(void *ctx, int status) 1381 { 1382 struct spdk_nvmf_subsystem_listener *listener = ctx; 1383 1384 if (status) { 1385 listener->cb_fn(listener->cb_arg, status); 1386 free(listener); 1387 return; 1388 } 1389 1390 TAILQ_INSERT_HEAD(&listener->subsystem->listeners, listener, link); 1391 1392 if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) { 1393 status = nvmf_tgt_update_mdns_prr(listener->subsystem->tgt); 1394 if (status) { 1395 TAILQ_REMOVE(&listener->subsystem->listeners, listener, link); 1396 listener->cb_fn(listener->cb_arg, status); 1397 free(listener); 1398 return; 1399 } 1400 } 1401 1402 spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL); 1403 listener->cb_fn(listener->cb_arg, status); 1404 } 1405 1406 void 1407 spdk_nvmf_subsystem_listener_opts_init(struct spdk_nvmf_listener_opts *opts, size_t size) 1408 { 1409 if (opts == NULL) { 1410 SPDK_ERRLOG("opts should not be NULL\n"); 1411 assert(false); 1412 return; 1413 } 1414 if (size == 0) { 1415 SPDK_ERRLOG("size should not be zero\n"); 1416 assert(false); 1417 return; 1418 } 1419 1420 memset(opts, 0, size); 1421 opts->opts_size = size; 1422 1423 #define FIELD_OK(field) \ 1424 offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(opts->field) <= size 1425 1426 #define SET_FIELD(field, value) \ 1427 if (FIELD_OK(field)) { \ 1428 opts->field = value; \ 1429 } \ 1430 1431 SET_FIELD(secure_channel, false); 1432 SET_FIELD(ana_state, SPDK_NVME_ANA_OPTIMIZED_STATE); 1433 SET_FIELD(sock_impl, NULL); 1434 1435 #undef FIELD_OK 1436 #undef SET_FIELD 1437 } 1438 1439 static int 1440 listener_opts_copy(struct spdk_nvmf_listener_opts *src, struct spdk_nvmf_listener_opts *dst) 1441 { 1442 if (src->opts_size == 0) { 1443 SPDK_ERRLOG("source structure size should not be zero\n"); 1444 assert(false); 1445 return -EINVAL; 1446 } 1447 1448 memset(dst, 0, sizeof(*dst)); 1449 dst->opts_size = src->opts_size; 1450 1451 #define FIELD_OK(field) \ 1452 offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(src->field) <= src->opts_size 1453 1454 #define SET_FIELD(field) \ 1455 if (FIELD_OK(field)) { \ 1456 dst->field = src->field; \ 1457 } \ 1458 1459 SET_FIELD(secure_channel); 1460 SET_FIELD(ana_state); 1461 SET_FIELD(sock_impl); 1462 /* We should not remove this statement, but need to update the assert statement 1463 * if we add a new field, and also add a corresponding SET_FIELD statement. */ 1464 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_listener_opts) == 24, "Incorrect size"); 1465 1466 #undef SET_FIELD 1467 #undef FIELD_OK 1468 1469 return 0; 1470 } 1471 1472 static void 1473 _nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem, 1474 struct spdk_nvme_transport_id *trid, 1475 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1476 void *cb_arg, struct spdk_nvmf_listener_opts *opts) 1477 { 1478 struct spdk_nvmf_transport *transport; 1479 struct spdk_nvmf_subsystem_listener *listener; 1480 struct spdk_nvmf_listener *tr_listener; 1481 uint32_t i; 1482 uint32_t id; 1483 int rc = 0; 1484 1485 assert(cb_fn != NULL); 1486 1487 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1488 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1489 cb_fn(cb_arg, -EAGAIN); 1490 return; 1491 } 1492 1493 if (nvmf_subsystem_find_listener(subsystem, trid)) { 1494 /* Listener already exists in this subsystem */ 1495 cb_fn(cb_arg, 0); 1496 return; 1497 } 1498 1499 transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, trid->trstring); 1500 if (!transport) { 1501 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 1502 trid->trstring); 1503 cb_fn(cb_arg, -EINVAL); 1504 return; 1505 } 1506 1507 tr_listener = nvmf_transport_find_listener(transport, trid); 1508 if (!tr_listener) { 1509 SPDK_ERRLOG("Cannot find transport listener for %s\n", trid->traddr); 1510 cb_fn(cb_arg, -EINVAL); 1511 return; 1512 } 1513 1514 listener = calloc(1, sizeof(*listener)); 1515 if (!listener) { 1516 cb_fn(cb_arg, -ENOMEM); 1517 return; 1518 } 1519 1520 listener->trid = &tr_listener->trid; 1521 listener->transport = transport; 1522 listener->cb_fn = cb_fn; 1523 listener->cb_arg = cb_arg; 1524 listener->subsystem = subsystem; 1525 listener->ana_state = calloc(subsystem->max_nsid, sizeof(enum spdk_nvme_ana_state)); 1526 if (!listener->ana_state) { 1527 free(listener); 1528 cb_fn(cb_arg, -ENOMEM); 1529 return; 1530 } 1531 1532 spdk_nvmf_subsystem_listener_opts_init(&listener->opts, sizeof(listener->opts)); 1533 if (opts != NULL) { 1534 rc = listener_opts_copy(opts, &listener->opts); 1535 if (rc) { 1536 SPDK_ERRLOG("Unable to copy listener options\n"); 1537 free(listener->ana_state); 1538 free(listener); 1539 cb_fn(cb_arg, -EINVAL); 1540 return; 1541 } 1542 } 1543 1544 id = spdk_bit_array_find_first_clear(subsystem->used_listener_ids, 0); 1545 if (id == UINT32_MAX) { 1546 SPDK_ERRLOG("Cannot add any more listeners\n"); 1547 free(listener->ana_state); 1548 free(listener->opts.sock_impl); 1549 free(listener); 1550 cb_fn(cb_arg, -EINVAL); 1551 return; 1552 } 1553 1554 spdk_bit_array_set(subsystem->used_listener_ids, id); 1555 listener->id = id; 1556 1557 for (i = 0; i < subsystem->max_nsid; i++) { 1558 listener->ana_state[i] = listener->opts.ana_state; 1559 } 1560 1561 if (transport->ops->listen_associate != NULL) { 1562 rc = transport->ops->listen_associate(transport, subsystem, trid); 1563 } 1564 1565 SPDK_DTRACE_PROBE4(nvmf_subsystem_add_listener, subsystem->subnqn, listener->trid->trtype, 1566 listener->trid->traddr, listener->trid->trsvcid); 1567 1568 _nvmf_subsystem_add_listener_done(listener, rc); 1569 } 1570 1571 void 1572 spdk_nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem, 1573 struct spdk_nvme_transport_id *trid, 1574 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1575 void *cb_arg) 1576 { 1577 _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, NULL); 1578 } 1579 1580 void 1581 spdk_nvmf_subsystem_add_listener_ext(struct spdk_nvmf_subsystem *subsystem, 1582 struct spdk_nvme_transport_id *trid, 1583 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1584 void *cb_arg, struct spdk_nvmf_listener_opts *opts) 1585 { 1586 _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, opts); 1587 } 1588 1589 int 1590 spdk_nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem, 1591 const struct spdk_nvme_transport_id *trid) 1592 { 1593 struct spdk_nvmf_subsystem_listener *listener; 1594 1595 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1596 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1597 return -EAGAIN; 1598 } 1599 1600 listener = nvmf_subsystem_find_listener(subsystem, trid); 1601 if (listener == NULL) { 1602 return -ENOENT; 1603 } 1604 1605 SPDK_DTRACE_PROBE4(nvmf_subsystem_remove_listener, subsystem->subnqn, listener->trid->trtype, 1606 listener->trid->traddr, listener->trid->trsvcid); 1607 1608 _nvmf_subsystem_remove_listener(subsystem, listener, false); 1609 1610 return 0; 1611 } 1612 1613 void 1614 nvmf_subsystem_remove_all_listeners(struct spdk_nvmf_subsystem *subsystem, 1615 bool stop) 1616 { 1617 struct spdk_nvmf_subsystem_listener *listener, *listener_tmp; 1618 1619 TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) { 1620 _nvmf_subsystem_remove_listener(subsystem, listener, stop); 1621 } 1622 } 1623 1624 bool 1625 spdk_nvmf_subsystem_listener_allowed(struct spdk_nvmf_subsystem *subsystem, 1626 const struct spdk_nvme_transport_id *trid) 1627 { 1628 struct spdk_nvmf_subsystem_listener *listener; 1629 1630 TAILQ_FOREACH(listener, &subsystem->listeners, link) { 1631 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) { 1632 return true; 1633 } 1634 } 1635 1636 if (!strcmp(subsystem->subnqn, SPDK_NVMF_DISCOVERY_NQN)) { 1637 SPDK_WARNLOG("Allowing connection to discovery subsystem on %s/%s/%s, " 1638 "even though this listener was not added to the discovery " 1639 "subsystem. This behavior is deprecated and will be removed " 1640 "in a future release.\n", 1641 spdk_nvme_transport_id_trtype_str(trid->trtype), trid->traddr, trid->trsvcid); 1642 return true; 1643 } 1644 1645 return false; 1646 } 1647 1648 struct spdk_nvmf_subsystem_listener * 1649 spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem) 1650 { 1651 return TAILQ_FIRST(&subsystem->listeners); 1652 } 1653 1654 struct spdk_nvmf_subsystem_listener * 1655 spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem, 1656 struct spdk_nvmf_subsystem_listener *prev_listener) 1657 { 1658 return TAILQ_NEXT(prev_listener, link); 1659 } 1660 1661 const struct spdk_nvme_transport_id * 1662 spdk_nvmf_subsystem_listener_get_trid(struct spdk_nvmf_subsystem_listener *listener) 1663 { 1664 return listener->trid; 1665 } 1666 1667 void 1668 spdk_nvmf_subsystem_allow_any_listener(struct spdk_nvmf_subsystem *subsystem, 1669 bool allow_any_listener) 1670 { 1671 subsystem->flags.allow_any_listener = allow_any_listener; 1672 } 1673 1674 bool 1675 spdk_nvmf_subsystem_any_listener_allowed(struct spdk_nvmf_subsystem *subsystem) 1676 { 1677 return subsystem->flags.allow_any_listener; 1678 } 1679 1680 struct subsystem_update_ns_ctx { 1681 struct spdk_nvmf_subsystem *subsystem; 1682 1683 spdk_nvmf_subsystem_state_change_done cb_fn; 1684 void *cb_arg; 1685 }; 1686 1687 static void 1688 subsystem_update_ns_done(struct spdk_io_channel_iter *i, int status) 1689 { 1690 struct subsystem_update_ns_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1691 1692 if (ctx->cb_fn) { 1693 ctx->cb_fn(ctx->subsystem, ctx->cb_arg, status); 1694 } 1695 free(ctx); 1696 } 1697 1698 static void 1699 subsystem_update_ns_on_pg(struct spdk_io_channel_iter *i) 1700 { 1701 int rc; 1702 struct subsystem_update_ns_ctx *ctx; 1703 struct spdk_nvmf_poll_group *group; 1704 struct spdk_nvmf_subsystem *subsystem; 1705 1706 ctx = spdk_io_channel_iter_get_ctx(i); 1707 group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i)); 1708 subsystem = ctx->subsystem; 1709 1710 rc = nvmf_poll_group_update_subsystem(group, subsystem); 1711 spdk_for_each_channel_continue(i, rc); 1712 } 1713 1714 static int 1715 nvmf_subsystem_update_ns(struct spdk_nvmf_subsystem *subsystem, 1716 spdk_nvmf_subsystem_state_change_done cb_fn, void *cb_arg) 1717 { 1718 struct subsystem_update_ns_ctx *ctx; 1719 1720 ctx = calloc(1, sizeof(*ctx)); 1721 if (ctx == NULL) { 1722 SPDK_ERRLOG("Can't alloc subsystem poll group update context\n"); 1723 return -ENOMEM; 1724 } 1725 ctx->subsystem = subsystem; 1726 ctx->cb_fn = cb_fn; 1727 ctx->cb_arg = cb_arg; 1728 1729 spdk_for_each_channel(subsystem->tgt, 1730 subsystem_update_ns_on_pg, 1731 ctx, 1732 subsystem_update_ns_done); 1733 return 0; 1734 } 1735 1736 static void 1737 nvmf_subsystem_ns_changed(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 1738 { 1739 struct spdk_nvmf_ctrlr *ctrlr; 1740 1741 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 1742 if (nvmf_ctrlr_ns_is_visible(ctrlr, nsid)) { 1743 nvmf_ctrlr_ns_changed(ctrlr, nsid); 1744 } 1745 } 1746 } 1747 1748 static uint32_t nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns); 1749 1750 int 1751 spdk_nvmf_subsystem_remove_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 1752 { 1753 struct spdk_nvmf_transport *transport; 1754 struct spdk_nvmf_ns *ns; 1755 struct spdk_nvmf_host *host, *tmp; 1756 struct spdk_nvmf_ctrlr *ctrlr; 1757 1758 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1759 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1760 assert(false); 1761 return -1; 1762 } 1763 1764 if (nsid == 0 || nsid > subsystem->max_nsid) { 1765 return -1; 1766 } 1767 1768 ns = subsystem->ns[nsid - 1]; 1769 if (!ns) { 1770 return -1; 1771 } 1772 1773 subsystem->ns[nsid - 1] = NULL; 1774 1775 assert(ns->anagrpid - 1 < subsystem->max_nsid); 1776 assert(subsystem->ana_group[ns->anagrpid - 1] > 0); 1777 1778 subsystem->ana_group[ns->anagrpid - 1]--; 1779 1780 TAILQ_FOREACH_SAFE(host, &ns->hosts, link, tmp) { 1781 nvmf_ns_remove_host(ns, host); 1782 } 1783 1784 free(ns->ptpl_file); 1785 nvmf_ns_reservation_clear_all_registrants(ns); 1786 spdk_bdev_module_release_bdev(ns->bdev); 1787 spdk_bdev_close(ns->desc); 1788 free(ns); 1789 1790 if (subsystem->fdp_supported && !spdk_nvmf_subsystem_get_first_ns(subsystem)) { 1791 subsystem->fdp_supported = false; 1792 SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u doesn't have FDP capability.\n", 1793 subsystem->id); 1794 } 1795 1796 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1797 transport = spdk_nvmf_transport_get_next(transport)) { 1798 if (transport->ops->subsystem_remove_ns) { 1799 transport->ops->subsystem_remove_ns(transport, subsystem, nsid); 1800 } 1801 } 1802 1803 nvmf_subsystem_ns_changed(subsystem, nsid); 1804 1805 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 1806 nvmf_ctrlr_ns_set_visible(ctrlr, nsid, false); 1807 } 1808 1809 return 0; 1810 } 1811 1812 struct subsystem_ns_change_ctx { 1813 struct spdk_nvmf_subsystem *subsystem; 1814 spdk_nvmf_subsystem_state_change_done cb_fn; 1815 uint32_t nsid; 1816 }; 1817 1818 static void 1819 _nvmf_ns_hot_remove(struct spdk_nvmf_subsystem *subsystem, 1820 void *cb_arg, int status) 1821 { 1822 struct subsystem_ns_change_ctx *ctx = cb_arg; 1823 int rc; 1824 1825 rc = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1826 if (rc != 0) { 1827 SPDK_ERRLOG("Failed to make changes to NVME-oF subsystem with id: %u\n", subsystem->id); 1828 } 1829 1830 rc = spdk_nvmf_subsystem_resume(subsystem, NULL, NULL); 1831 if (rc != 0) { 1832 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id); 1833 } 1834 1835 free(ctx); 1836 } 1837 1838 static void 1839 nvmf_ns_change_msg(void *ns_ctx) 1840 { 1841 struct subsystem_ns_change_ctx *ctx = ns_ctx; 1842 int rc; 1843 1844 SPDK_DTRACE_PROBE2(nvmf_ns_change, ctx->nsid, ctx->subsystem->subnqn); 1845 1846 rc = spdk_nvmf_subsystem_pause(ctx->subsystem, ctx->nsid, ctx->cb_fn, ctx); 1847 if (rc) { 1848 if (rc == -EBUSY) { 1849 /* Try again, this is not a permanent situation. */ 1850 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ctx); 1851 } else { 1852 free(ctx); 1853 SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n"); 1854 } 1855 } 1856 } 1857 1858 static void 1859 nvmf_ns_hot_remove(void *remove_ctx) 1860 { 1861 struct spdk_nvmf_ns *ns = remove_ctx; 1862 struct subsystem_ns_change_ctx *ns_ctx; 1863 int rc; 1864 1865 /* We have to allocate a new context because this op 1866 * is asynchronous and we could lose the ns in the middle. 1867 */ 1868 ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx)); 1869 if (!ns_ctx) { 1870 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n"); 1871 return; 1872 } 1873 1874 ns_ctx->subsystem = ns->subsystem; 1875 ns_ctx->nsid = ns->opts.nsid; 1876 ns_ctx->cb_fn = _nvmf_ns_hot_remove; 1877 1878 rc = spdk_nvmf_subsystem_pause(ns->subsystem, ns_ctx->nsid, _nvmf_ns_hot_remove, ns_ctx); 1879 if (rc) { 1880 if (rc == -EBUSY) { 1881 /* Try again, this is not a permanent situation. */ 1882 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx); 1883 } else { 1884 SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n"); 1885 free(ns_ctx); 1886 } 1887 } 1888 } 1889 1890 static void 1891 _nvmf_ns_resize(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status) 1892 { 1893 struct subsystem_ns_change_ctx *ctx = cb_arg; 1894 1895 nvmf_subsystem_ns_changed(subsystem, ctx->nsid); 1896 if (spdk_nvmf_subsystem_resume(subsystem, NULL, NULL) != 0) { 1897 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id); 1898 } 1899 1900 free(ctx); 1901 } 1902 1903 static void 1904 nvmf_ns_resize(void *event_ctx) 1905 { 1906 struct spdk_nvmf_ns *ns = event_ctx; 1907 struct subsystem_ns_change_ctx *ns_ctx; 1908 int rc; 1909 1910 /* We have to allocate a new context because this op 1911 * is asynchronous and we could lose the ns in the middle. 1912 */ 1913 ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx)); 1914 if (!ns_ctx) { 1915 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n"); 1916 return; 1917 } 1918 1919 ns_ctx->subsystem = ns->subsystem; 1920 ns_ctx->nsid = ns->opts.nsid; 1921 ns_ctx->cb_fn = _nvmf_ns_resize; 1922 1923 /* Specify 0 for the nsid here, because we do not need to pause the namespace. 1924 * Namespaces can only be resized bigger, so there is no need to quiesce I/O. 1925 */ 1926 rc = spdk_nvmf_subsystem_pause(ns->subsystem, 0, _nvmf_ns_resize, ns_ctx); 1927 if (rc) { 1928 if (rc == -EBUSY) { 1929 /* Try again, this is not a permanent situation. */ 1930 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx); 1931 } else { 1932 SPDK_ERRLOG("Unable to pause subsystem to process namespace resize!\n"); 1933 free(ns_ctx); 1934 } 1935 } 1936 } 1937 1938 static void 1939 nvmf_ns_event(enum spdk_bdev_event_type type, 1940 struct spdk_bdev *bdev, 1941 void *event_ctx) 1942 { 1943 SPDK_DEBUGLOG(nvmf, "Bdev event: type %d, name %s, subsystem_id %d, ns_id %d\n", 1944 type, 1945 spdk_bdev_get_name(bdev), 1946 ((struct spdk_nvmf_ns *)event_ctx)->subsystem->id, 1947 ((struct spdk_nvmf_ns *)event_ctx)->nsid); 1948 1949 switch (type) { 1950 case SPDK_BDEV_EVENT_REMOVE: 1951 nvmf_ns_hot_remove(event_ctx); 1952 break; 1953 case SPDK_BDEV_EVENT_RESIZE: 1954 nvmf_ns_resize(event_ctx); 1955 break; 1956 default: 1957 SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type); 1958 break; 1959 } 1960 } 1961 1962 void 1963 spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size) 1964 { 1965 if (!opts) { 1966 SPDK_ERRLOG("opts should not be NULL.\n"); 1967 return; 1968 } 1969 1970 if (!opts_size) { 1971 SPDK_ERRLOG("opts_size should not be zero.\n"); 1972 return; 1973 } 1974 1975 memset(opts, 0, opts_size); 1976 opts->opts_size = opts_size; 1977 1978 #define FIELD_OK(field) \ 1979 offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= opts_size 1980 1981 #define SET_FIELD(field, value) \ 1982 if (FIELD_OK(field)) { \ 1983 opts->field = value; \ 1984 } \ 1985 1986 /* All current fields are set to 0 by default. */ 1987 SET_FIELD(nsid, 0); 1988 if (FIELD_OK(nguid)) { 1989 memset(opts->nguid, 0, sizeof(opts->nguid)); 1990 } 1991 if (FIELD_OK(eui64)) { 1992 memset(opts->eui64, 0, sizeof(opts->eui64)); 1993 } 1994 if (FIELD_OK(uuid)) { 1995 spdk_uuid_set_null(&opts->uuid); 1996 } 1997 SET_FIELD(anagrpid, 0); 1998 SET_FIELD(transport_specific, NULL); 1999 2000 #undef FIELD_OK 2001 #undef SET_FIELD 2002 } 2003 2004 static void 2005 nvmf_ns_opts_copy(struct spdk_nvmf_ns_opts *opts, 2006 const struct spdk_nvmf_ns_opts *user_opts, 2007 size_t opts_size) 2008 { 2009 #define FIELD_OK(field) \ 2010 offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= user_opts->opts_size 2011 2012 #define SET_FIELD(field) \ 2013 if (FIELD_OK(field)) { \ 2014 opts->field = user_opts->field; \ 2015 } \ 2016 2017 SET_FIELD(nsid); 2018 if (FIELD_OK(nguid)) { 2019 memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid)); 2020 } 2021 if (FIELD_OK(eui64)) { 2022 memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64)); 2023 } 2024 if (FIELD_OK(uuid)) { 2025 spdk_uuid_copy(&opts->uuid, &user_opts->uuid); 2026 } 2027 SET_FIELD(anagrpid); 2028 SET_FIELD(no_auto_visible); 2029 SET_FIELD(transport_specific); 2030 2031 opts->opts_size = user_opts->opts_size; 2032 2033 /* We should not remove this statement, but need to update the assert statement 2034 * if we add a new field, and also add a corresponding SET_FIELD statement. 2035 */ 2036 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ns_opts) == 72, "Incorrect size"); 2037 2038 #undef FIELD_OK 2039 #undef SET_FIELD 2040 } 2041 2042 /* Dummy bdev module used to to claim bdevs. */ 2043 static struct spdk_bdev_module ns_bdev_module = { 2044 .name = "NVMe-oF Target", 2045 }; 2046 2047 static int nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns, 2048 const struct spdk_nvmf_reservation_info *info); 2049 static int nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, 2050 struct spdk_nvmf_reservation_info *info); 2051 static int nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, 2052 struct spdk_nvmf_reservation_info *info); 2053 2054 bool 2055 nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem) 2056 { 2057 struct spdk_nvmf_ns *ns; 2058 2059 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 2060 ns != NULL; 2061 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 2062 if (spdk_bdev_is_zoned(ns->bdev) && 2063 spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZONE_APPEND)) { 2064 return true; 2065 } 2066 } 2067 2068 return false; 2069 } 2070 2071 uint32_t 2072 spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem, const char *bdev_name, 2073 const struct spdk_nvmf_ns_opts *user_opts, size_t opts_size, 2074 const char *ptpl_file) 2075 { 2076 struct spdk_nvmf_transport *transport; 2077 struct spdk_nvmf_ns_opts opts; 2078 struct spdk_nvmf_ns *ns, *first_ns; 2079 struct spdk_nvmf_ctrlr *ctrlr; 2080 struct spdk_nvmf_reservation_info info = {0}; 2081 struct spdk_nvme_ns *nvme_ns; 2082 int rc; 2083 bool zone_append_supported; 2084 uint64_t max_zone_append_size_kib; 2085 2086 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 2087 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 2088 return 0; 2089 } 2090 2091 spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts)); 2092 if (user_opts) { 2093 nvmf_ns_opts_copy(&opts, user_opts, opts_size); 2094 } 2095 2096 if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) { 2097 SPDK_ERRLOG("Invalid NSID %" PRIu32 "\n", opts.nsid); 2098 return 0; 2099 } 2100 2101 if (opts.nsid == 0) { 2102 /* 2103 * NSID not specified - find a free index. 2104 * 2105 * If no free slots are found, return error. 2106 */ 2107 for (opts.nsid = 1; opts.nsid <= subsystem->max_nsid; opts.nsid++) { 2108 if (_nvmf_subsystem_get_ns(subsystem, opts.nsid) == NULL) { 2109 break; 2110 } 2111 } 2112 if (opts.nsid > subsystem->max_nsid) { 2113 SPDK_ERRLOG("No free namespace slot available in the subsystem\n"); 2114 return 0; 2115 } 2116 } 2117 2118 if (opts.nsid > subsystem->max_nsid) { 2119 SPDK_ERRLOG("NSID greater than maximum not allowed\n"); 2120 return 0; 2121 } 2122 2123 if (_nvmf_subsystem_get_ns(subsystem, opts.nsid)) { 2124 SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", opts.nsid); 2125 return 0; 2126 } 2127 2128 if (opts.anagrpid == 0) { 2129 opts.anagrpid = opts.nsid; 2130 } 2131 2132 if (opts.anagrpid > subsystem->max_nsid) { 2133 SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n"); 2134 return 0; 2135 } 2136 2137 ns = calloc(1, sizeof(*ns)); 2138 if (ns == NULL) { 2139 SPDK_ERRLOG("Namespace allocation failed\n"); 2140 return 0; 2141 } 2142 2143 TAILQ_INIT(&ns->hosts); 2144 ns->always_visible = !opts.no_auto_visible; 2145 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2146 nvmf_ctrlr_ns_set_visible(ctrlr, opts.nsid, ns->always_visible); 2147 } 2148 2149 rc = spdk_bdev_open_ext(bdev_name, true, nvmf_ns_event, ns, &ns->desc); 2150 if (rc != 0) { 2151 SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n", 2152 subsystem->subnqn, bdev_name, rc); 2153 free(ns); 2154 return 0; 2155 } 2156 2157 ns->bdev = spdk_bdev_desc_get_bdev(ns->desc); 2158 2159 if (spdk_bdev_get_md_size(ns->bdev) != 0) { 2160 if (!spdk_bdev_is_md_interleaved(ns->bdev)) { 2161 SPDK_ERRLOG("Can't attach bdev with separate metadata.\n"); 2162 spdk_bdev_close(ns->desc); 2163 free(ns); 2164 return 0; 2165 } 2166 2167 if (spdk_bdev_get_md_size(ns->bdev) > SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE) { 2168 SPDK_ERRLOG("Maximum supported interleaved md size %u, current md size %u\n", 2169 SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE, spdk_bdev_get_md_size(ns->bdev)); 2170 spdk_bdev_close(ns->desc); 2171 free(ns); 2172 return 0; 2173 } 2174 } 2175 2176 rc = spdk_bdev_module_claim_bdev(ns->bdev, ns->desc, &ns_bdev_module); 2177 if (rc != 0) { 2178 spdk_bdev_close(ns->desc); 2179 free(ns); 2180 return 0; 2181 } 2182 2183 if (!strncmp(spdk_bdev_get_module_name(ns->bdev), "nvme", 2184 strlen(spdk_bdev_get_module_name(ns->bdev)))) { 2185 nvme_ns = (struct spdk_nvme_ns *) spdk_bdev_get_module_ctx(ns->desc); 2186 ns->passthrough_nsid = spdk_nvme_ns_get_id(nvme_ns); 2187 } else if (subsystem->passthrough) { 2188 SPDK_ERRLOG("Only bdev_nvme namespaces can be added to a passthrough subsystem.\n"); 2189 goto err; 2190 } 2191 2192 /* Cache the zcopy capability of the bdev device */ 2193 ns->zcopy = spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZCOPY); 2194 2195 if (spdk_uuid_is_null(&opts.uuid)) { 2196 opts.uuid = *spdk_bdev_get_uuid(ns->bdev); 2197 } 2198 2199 /* if nguid descriptor is supported by bdev module (nvme) then uuid = nguid */ 2200 if (spdk_mem_all_zero(opts.nguid, sizeof(opts.nguid))) { 2201 SPDK_STATIC_ASSERT(sizeof(opts.nguid) == sizeof(opts.uuid), "size mismatch"); 2202 memcpy(opts.nguid, spdk_bdev_get_uuid(ns->bdev), sizeof(opts.nguid)); 2203 } 2204 2205 if (spdk_bdev_is_zoned(ns->bdev)) { 2206 SPDK_DEBUGLOG(nvmf, "The added namespace is backed by a zoned block device.\n"); 2207 ns->csi = SPDK_NVME_CSI_ZNS; 2208 2209 zone_append_supported = spdk_bdev_io_type_supported(ns->bdev, 2210 SPDK_BDEV_IO_TYPE_ZONE_APPEND); 2211 max_zone_append_size_kib = spdk_bdev_get_max_zone_append_size( 2212 ns->bdev) * spdk_bdev_get_block_size(ns->bdev); 2213 2214 if (_nvmf_subsystem_get_first_zoned_ns(subsystem) != NULL && 2215 (nvmf_subsystem_zone_append_supported(subsystem) != zone_append_supported || 2216 subsystem->max_zone_append_size_kib != max_zone_append_size_kib)) { 2217 SPDK_ERRLOG("Namespaces with different zone append support or different zone append size are not allowed.\n"); 2218 goto err; 2219 } 2220 2221 subsystem->max_zone_append_size_kib = max_zone_append_size_kib; 2222 } 2223 2224 first_ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 2225 if (!first_ns) { 2226 if (spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) { 2227 SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u has FDP capability.\n", 2228 subsystem->id); 2229 subsystem->fdp_supported = true; 2230 } 2231 } else { 2232 if (spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps != 2233 spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) { 2234 SPDK_ERRLOG("Subsystem with id: %u can%s FDP namespace.\n", subsystem->id, 2235 spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps ? " only add" : "not add"); 2236 goto err; 2237 } 2238 } 2239 2240 ns->opts = opts; 2241 ns->subsystem = subsystem; 2242 subsystem->ns[opts.nsid - 1] = ns; 2243 ns->nsid = opts.nsid; 2244 ns->anagrpid = opts.anagrpid; 2245 subsystem->ana_group[ns->anagrpid - 1]++; 2246 TAILQ_INIT(&ns->registrants); 2247 if (ptpl_file) { 2248 ns->ptpl_file = strdup(ptpl_file); 2249 if (!ns->ptpl_file) { 2250 SPDK_ERRLOG("Namespace ns->ptpl_file allocation failed\n"); 2251 goto err; 2252 } 2253 } 2254 2255 if (nvmf_ns_is_ptpl_capable(ns)) { 2256 rc = nvmf_ns_reservation_load(ns, &info); 2257 if (rc) { 2258 SPDK_ERRLOG("Subsystem load reservation failed\n"); 2259 goto err; 2260 } 2261 2262 rc = nvmf_ns_reservation_restore(ns, &info); 2263 if (rc) { 2264 SPDK_ERRLOG("Subsystem restore reservation failed\n"); 2265 goto err; 2266 } 2267 } 2268 2269 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 2270 transport = spdk_nvmf_transport_get_next(transport)) { 2271 if (transport->ops->subsystem_add_ns) { 2272 rc = transport->ops->subsystem_add_ns(transport, subsystem, ns); 2273 if (rc) { 2274 SPDK_ERRLOG("Namespace attachment is not allowed by %s transport\n", transport->ops->name); 2275 nvmf_ns_reservation_clear_all_registrants(ns); 2276 goto err; 2277 } 2278 } 2279 } 2280 2281 /* JSON value obj is freed before sending the response. Set NULL to prevent usage of dangling pointer. */ 2282 ns->opts.transport_specific = NULL; 2283 2284 SPDK_DEBUGLOG(nvmf, "Subsystem %s: bdev %s assigned nsid %" PRIu32 "\n", 2285 spdk_nvmf_subsystem_get_nqn(subsystem), 2286 bdev_name, 2287 opts.nsid); 2288 2289 nvmf_subsystem_ns_changed(subsystem, opts.nsid); 2290 2291 SPDK_DTRACE_PROBE2(nvmf_subsystem_add_ns, subsystem->subnqn, ns->nsid); 2292 2293 return opts.nsid; 2294 err: 2295 subsystem->ns[opts.nsid - 1] = NULL; 2296 spdk_bdev_module_release_bdev(ns->bdev); 2297 spdk_bdev_close(ns->desc); 2298 free(ns->ptpl_file); 2299 free(ns); 2300 2301 return 0; 2302 } 2303 2304 int 2305 spdk_nvmf_subsystem_set_ns_ana_group(struct spdk_nvmf_subsystem *subsystem, 2306 uint32_t nsid, uint32_t anagrpid) 2307 { 2308 struct spdk_nvmf_ns *ns; 2309 2310 if (anagrpid > subsystem->max_nsid) { 2311 SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n"); 2312 return -1; 2313 } 2314 2315 if (anagrpid == 0) { 2316 SPDK_ERRLOG("Zero is not allowed to ANAGRPID\n"); 2317 return -1; 2318 } 2319 2320 if (nsid == 0 || nsid > subsystem->max_nsid) { 2321 return -1; 2322 } 2323 2324 ns = subsystem->ns[nsid - 1]; 2325 if (!ns) { 2326 return -1; 2327 } 2328 2329 assert(ns->anagrpid - 1 < subsystem->max_nsid); 2330 2331 assert(subsystem->ana_group[ns->anagrpid - 1] > 0); 2332 2333 subsystem->ana_group[ns->anagrpid - 1]--; 2334 2335 subsystem->ana_group[anagrpid - 1]++; 2336 2337 ns->anagrpid = anagrpid; 2338 ns->opts.anagrpid = anagrpid; 2339 2340 nvmf_subsystem_ns_changed(subsystem, nsid); 2341 2342 return 0; 2343 } 2344 2345 static uint32_t 2346 nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem, 2347 uint32_t prev_nsid) 2348 { 2349 uint32_t nsid; 2350 2351 if (prev_nsid >= subsystem->max_nsid) { 2352 return 0; 2353 } 2354 2355 for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) { 2356 if (subsystem->ns[nsid - 1]) { 2357 return nsid; 2358 } 2359 } 2360 2361 return 0; 2362 } 2363 2364 struct spdk_nvmf_ns * 2365 spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem) 2366 { 2367 uint32_t first_nsid; 2368 2369 first_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, 0); 2370 return _nvmf_subsystem_get_ns(subsystem, first_nsid); 2371 } 2372 2373 struct spdk_nvmf_ns * 2374 spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem, 2375 struct spdk_nvmf_ns *prev_ns) 2376 { 2377 uint32_t next_nsid; 2378 2379 next_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->opts.nsid); 2380 return _nvmf_subsystem_get_ns(subsystem, next_nsid); 2381 } 2382 2383 struct spdk_nvmf_ns * 2384 spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 2385 { 2386 return _nvmf_subsystem_get_ns(subsystem, nsid); 2387 } 2388 2389 uint32_t 2390 spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns) 2391 { 2392 return ns->opts.nsid; 2393 } 2394 2395 struct spdk_bdev * 2396 spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns) 2397 { 2398 return ns->bdev; 2399 } 2400 2401 void 2402 spdk_nvmf_ns_get_opts(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_ns_opts *opts, 2403 size_t opts_size) 2404 { 2405 memset(opts, 0, opts_size); 2406 memcpy(opts, &ns->opts, spdk_min(sizeof(ns->opts), opts_size)); 2407 } 2408 2409 const char * 2410 spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem) 2411 { 2412 return subsystem->sn; 2413 } 2414 2415 int 2416 spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn) 2417 { 2418 size_t len, max_len; 2419 2420 max_len = sizeof(subsystem->sn) - 1; 2421 len = strlen(sn); 2422 if (len > max_len) { 2423 SPDK_DEBUGLOG(nvmf, "Invalid sn \"%s\": length %zu > max %zu\n", 2424 sn, len, max_len); 2425 return -1; 2426 } 2427 2428 if (!nvmf_valid_ascii_string(sn, len)) { 2429 SPDK_DEBUGLOG(nvmf, "Non-ASCII sn\n"); 2430 SPDK_LOGDUMP(nvmf, "sn", sn, len); 2431 return -1; 2432 } 2433 2434 snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn); 2435 2436 return 0; 2437 } 2438 2439 const char * 2440 spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem) 2441 { 2442 return subsystem->mn; 2443 } 2444 2445 int 2446 spdk_nvmf_subsystem_set_mn(struct spdk_nvmf_subsystem *subsystem, const char *mn) 2447 { 2448 size_t len, max_len; 2449 2450 if (mn == NULL) { 2451 mn = MODEL_NUMBER_DEFAULT; 2452 } 2453 max_len = sizeof(subsystem->mn) - 1; 2454 len = strlen(mn); 2455 if (len > max_len) { 2456 SPDK_DEBUGLOG(nvmf, "Invalid mn \"%s\": length %zu > max %zu\n", 2457 mn, len, max_len); 2458 return -1; 2459 } 2460 2461 if (!nvmf_valid_ascii_string(mn, len)) { 2462 SPDK_DEBUGLOG(nvmf, "Non-ASCII mn\n"); 2463 SPDK_LOGDUMP(nvmf, "mn", mn, len); 2464 return -1; 2465 } 2466 2467 snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", mn); 2468 2469 return 0; 2470 } 2471 2472 const char * 2473 spdk_nvmf_subsystem_get_nqn(const struct spdk_nvmf_subsystem *subsystem) 2474 { 2475 return subsystem->subnqn; 2476 } 2477 2478 /* We have to use the typedef in the function declaration to appease astyle. */ 2479 typedef enum spdk_nvmf_subtype spdk_nvmf_subtype_t; 2480 2481 spdk_nvmf_subtype_t 2482 spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem) 2483 { 2484 return subsystem->subtype; 2485 } 2486 2487 uint32_t 2488 spdk_nvmf_subsystem_get_max_nsid(struct spdk_nvmf_subsystem *subsystem) 2489 { 2490 return subsystem->max_nsid; 2491 } 2492 2493 int 2494 spdk_nvmf_subsystem_set_cntlid_range(struct spdk_nvmf_subsystem *subsystem, 2495 uint16_t min_cntlid, uint16_t max_cntlid) 2496 { 2497 if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) { 2498 return -EAGAIN; 2499 } 2500 2501 if (min_cntlid > max_cntlid) { 2502 return -EINVAL; 2503 } 2504 /* The spec reserves cntlid values in the range FFF0h to FFFFh. */ 2505 if (min_cntlid < NVMF_MIN_CNTLID || min_cntlid > NVMF_MAX_CNTLID || 2506 max_cntlid < NVMF_MIN_CNTLID || max_cntlid > NVMF_MAX_CNTLID) { 2507 return -EINVAL; 2508 } 2509 subsystem->min_cntlid = min_cntlid; 2510 subsystem->max_cntlid = max_cntlid; 2511 if (subsystem->next_cntlid < min_cntlid || subsystem->next_cntlid > max_cntlid) { 2512 subsystem->next_cntlid = min_cntlid; 2513 } 2514 2515 return 0; 2516 } 2517 2518 uint16_t 2519 nvmf_subsystem_gen_cntlid(struct spdk_nvmf_subsystem *subsystem) 2520 { 2521 int count; 2522 uint16_t cntlid; 2523 2524 /* 2525 * In the worst case, we might have to try all CNTLID values between min_cntlid and max_cntlid 2526 * before we find one that is unused (or find that all values are in use). 2527 */ 2528 for (count = 0; count < subsystem->max_cntlid - subsystem->min_cntlid + 1; count++) { 2529 cntlid = subsystem->next_cntlid; 2530 subsystem->next_cntlid++; 2531 2532 if (subsystem->next_cntlid > subsystem->max_cntlid) { 2533 subsystem->next_cntlid = subsystem->min_cntlid; 2534 } 2535 2536 /* Check if a controller with this cntlid currently exists. */ 2537 if (nvmf_subsystem_get_ctrlr(subsystem, cntlid) == NULL) { 2538 /* Found unused cntlid */ 2539 return cntlid; 2540 } 2541 } 2542 2543 /* All valid cntlid values are in use. */ 2544 return 0xFFFF; 2545 } 2546 2547 int 2548 nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr) 2549 { 2550 2551 if (ctrlr->dynamic_ctrlr) { 2552 ctrlr->cntlid = nvmf_subsystem_gen_cntlid(subsystem); 2553 if (ctrlr->cntlid == 0xFFFF) { 2554 /* Unable to get a cntlid */ 2555 SPDK_ERRLOG("Reached max simultaneous ctrlrs\n"); 2556 return -EBUSY; 2557 } 2558 } else if (nvmf_subsystem_get_ctrlr(subsystem, ctrlr->cntlid) != NULL) { 2559 SPDK_ERRLOG("Ctrlr with cntlid %u already exist\n", ctrlr->cntlid); 2560 return -EEXIST; 2561 } 2562 2563 TAILQ_INSERT_TAIL(&subsystem->ctrlrs, ctrlr, link); 2564 2565 SPDK_DTRACE_PROBE3(nvmf_subsystem_add_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn); 2566 2567 return 0; 2568 } 2569 2570 void 2571 nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem, 2572 struct spdk_nvmf_ctrlr *ctrlr) 2573 { 2574 SPDK_DTRACE_PROBE3(nvmf_subsystem_remove_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn); 2575 2576 assert(spdk_get_thread() == subsystem->thread); 2577 assert(subsystem == ctrlr->subsys); 2578 SPDK_DEBUGLOG(nvmf, "remove ctrlr %p id 0x%x from subsys %p %s\n", ctrlr, ctrlr->cntlid, subsystem, 2579 subsystem->subnqn); 2580 TAILQ_REMOVE(&subsystem->ctrlrs, ctrlr, link); 2581 } 2582 2583 struct spdk_nvmf_ctrlr * 2584 nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid) 2585 { 2586 struct spdk_nvmf_ctrlr *ctrlr; 2587 2588 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2589 if (ctrlr->cntlid == cntlid) { 2590 return ctrlr; 2591 } 2592 } 2593 2594 return NULL; 2595 } 2596 2597 uint32_t 2598 spdk_nvmf_subsystem_get_max_namespaces(const struct spdk_nvmf_subsystem *subsystem) 2599 { 2600 return subsystem->max_nsid; 2601 } 2602 2603 uint16_t 2604 spdk_nvmf_subsystem_get_min_cntlid(const struct spdk_nvmf_subsystem *subsystem) 2605 { 2606 return subsystem->min_cntlid; 2607 } 2608 2609 uint16_t 2610 spdk_nvmf_subsystem_get_max_cntlid(const struct spdk_nvmf_subsystem *subsystem) 2611 { 2612 return subsystem->max_cntlid; 2613 } 2614 2615 struct _nvmf_ns_registrant { 2616 uint64_t rkey; 2617 char *host_uuid; 2618 }; 2619 2620 struct _nvmf_ns_registrants { 2621 size_t num_regs; 2622 struct _nvmf_ns_registrant reg[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 2623 }; 2624 2625 struct _nvmf_ns_reservation { 2626 bool ptpl_activated; 2627 enum spdk_nvme_reservation_type rtype; 2628 uint64_t crkey; 2629 char *bdev_uuid; 2630 char *holder_uuid; 2631 struct _nvmf_ns_registrants regs; 2632 }; 2633 2634 static const struct spdk_json_object_decoder nvmf_ns_pr_reg_decoders[] = { 2635 {"rkey", offsetof(struct _nvmf_ns_registrant, rkey), spdk_json_decode_uint64}, 2636 {"host_uuid", offsetof(struct _nvmf_ns_registrant, host_uuid), spdk_json_decode_string}, 2637 }; 2638 2639 static int 2640 nvmf_decode_ns_pr_reg(const struct spdk_json_val *val, void *out) 2641 { 2642 struct _nvmf_ns_registrant *reg = out; 2643 2644 return spdk_json_decode_object(val, nvmf_ns_pr_reg_decoders, 2645 SPDK_COUNTOF(nvmf_ns_pr_reg_decoders), reg); 2646 } 2647 2648 static int 2649 nvmf_decode_ns_pr_regs(const struct spdk_json_val *val, void *out) 2650 { 2651 struct _nvmf_ns_registrants *regs = out; 2652 2653 return spdk_json_decode_array(val, nvmf_decode_ns_pr_reg, regs->reg, 2654 SPDK_NVMF_MAX_NUM_REGISTRANTS, ®s->num_regs, 2655 sizeof(struct _nvmf_ns_registrant)); 2656 } 2657 2658 static const struct spdk_json_object_decoder nvmf_ns_pr_decoders[] = { 2659 {"ptpl", offsetof(struct _nvmf_ns_reservation, ptpl_activated), spdk_json_decode_bool, true}, 2660 {"rtype", offsetof(struct _nvmf_ns_reservation, rtype), spdk_json_decode_uint32, true}, 2661 {"crkey", offsetof(struct _nvmf_ns_reservation, crkey), spdk_json_decode_uint64, true}, 2662 {"bdev_uuid", offsetof(struct _nvmf_ns_reservation, bdev_uuid), spdk_json_decode_string}, 2663 {"holder_uuid", offsetof(struct _nvmf_ns_reservation, holder_uuid), spdk_json_decode_string, true}, 2664 {"registrants", offsetof(struct _nvmf_ns_reservation, regs), nvmf_decode_ns_pr_regs}, 2665 }; 2666 2667 static int 2668 nvmf_ns_reservation_load_json(const struct spdk_nvmf_ns *ns, 2669 struct spdk_nvmf_reservation_info *info) 2670 { 2671 size_t json_size; 2672 ssize_t values_cnt, rc; 2673 void *json = NULL, *end; 2674 struct spdk_json_val *values = NULL; 2675 struct _nvmf_ns_reservation res = {}; 2676 const char *file = ns->ptpl_file; 2677 uint32_t i; 2678 2679 /* It's not an error if the file does not exist */ 2680 if (access(file, F_OK) != 0) { 2681 SPDK_DEBUGLOG(nvmf, "File %s does not exist\n", file); 2682 return 0; 2683 } 2684 2685 /* Load all persist file contents into a local buffer */ 2686 json = spdk_posix_file_load_from_name(file, &json_size); 2687 if (!json) { 2688 SPDK_ERRLOG("Load persist file %s failed\n", file); 2689 return -ENOMEM; 2690 } 2691 2692 rc = spdk_json_parse(json, json_size, NULL, 0, &end, 0); 2693 if (rc < 0) { 2694 SPDK_NOTICELOG("Parsing JSON configuration failed (%zd)\n", rc); 2695 goto exit; 2696 } 2697 2698 values_cnt = rc; 2699 values = calloc(values_cnt, sizeof(struct spdk_json_val)); 2700 if (values == NULL) { 2701 goto exit; 2702 } 2703 2704 rc = spdk_json_parse(json, json_size, values, values_cnt, &end, 0); 2705 if (rc != values_cnt) { 2706 SPDK_ERRLOG("Parsing JSON configuration failed (%zd)\n", rc); 2707 goto exit; 2708 } 2709 2710 /* Decode json */ 2711 if (spdk_json_decode_object(values, nvmf_ns_pr_decoders, 2712 SPDK_COUNTOF(nvmf_ns_pr_decoders), 2713 &res)) { 2714 SPDK_ERRLOG("Invalid objects in the persist file %s\n", file); 2715 rc = -EINVAL; 2716 goto exit; 2717 } 2718 2719 if (res.regs.num_regs > SPDK_NVMF_MAX_NUM_REGISTRANTS) { 2720 SPDK_ERRLOG("Can only support up to %u registrants\n", SPDK_NVMF_MAX_NUM_REGISTRANTS); 2721 rc = -ERANGE; 2722 goto exit; 2723 } 2724 2725 rc = 0; 2726 info->ptpl_activated = res.ptpl_activated; 2727 info->rtype = res.rtype; 2728 info->crkey = res.crkey; 2729 snprintf(info->bdev_uuid, sizeof(info->bdev_uuid), "%s", res.bdev_uuid); 2730 snprintf(info->holder_uuid, sizeof(info->holder_uuid), "%s", res.holder_uuid); 2731 info->num_regs = res.regs.num_regs; 2732 for (i = 0; i < res.regs.num_regs; i++) { 2733 info->registrants[i].rkey = res.regs.reg[i].rkey; 2734 snprintf(info->registrants[i].host_uuid, sizeof(info->registrants[i].host_uuid), "%s", 2735 res.regs.reg[i].host_uuid); 2736 } 2737 2738 exit: 2739 free(json); 2740 free(values); 2741 free(res.bdev_uuid); 2742 free(res.holder_uuid); 2743 for (i = 0; i < res.regs.num_regs; i++) { 2744 free(res.regs.reg[i].host_uuid); 2745 } 2746 2747 return rc; 2748 } 2749 2750 static bool nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns); 2751 2752 static int 2753 nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info) 2754 { 2755 uint32_t i; 2756 struct spdk_nvmf_registrant *reg, *holder = NULL; 2757 struct spdk_uuid bdev_uuid, holder_uuid; 2758 bool rkey_flag = false; 2759 2760 SPDK_DEBUGLOG(nvmf, "NSID %u, PTPL %u, Number of registrants %u\n", 2761 ns->nsid, info->ptpl_activated, info->num_regs); 2762 2763 /* it's not an error */ 2764 if (!info->ptpl_activated || !info->num_regs) { 2765 return 0; 2766 } 2767 2768 /* Check info->crkey exist or not in info->registrants[i].rkey */ 2769 for (i = 0; i < info->num_regs; i++) { 2770 if (info->crkey == info->registrants[i].rkey) { 2771 rkey_flag = true; 2772 } 2773 } 2774 if (!rkey_flag && info->crkey != 0) { 2775 return -EINVAL; 2776 } 2777 2778 spdk_uuid_parse(&bdev_uuid, info->bdev_uuid); 2779 if (spdk_uuid_compare(&bdev_uuid, spdk_bdev_get_uuid(ns->bdev))) { 2780 SPDK_ERRLOG("Existing bdev UUID is not same with configuration file\n"); 2781 return -EINVAL; 2782 } 2783 2784 ns->crkey = info->crkey; 2785 ns->rtype = info->rtype; 2786 ns->ptpl_activated = info->ptpl_activated; 2787 spdk_uuid_parse(&holder_uuid, info->holder_uuid); 2788 2789 SPDK_DEBUGLOG(nvmf, "Bdev UUID %s\n", info->bdev_uuid); 2790 if (info->rtype) { 2791 SPDK_DEBUGLOG(nvmf, "Holder UUID %s, RTYPE %u, RKEY 0x%"PRIx64"\n", 2792 info->holder_uuid, info->rtype, info->crkey); 2793 } 2794 2795 for (i = 0; i < info->num_regs; i++) { 2796 reg = calloc(1, sizeof(*reg)); 2797 if (!reg) { 2798 return -ENOMEM; 2799 } 2800 spdk_uuid_parse(®->hostid, info->registrants[i].host_uuid); 2801 reg->rkey = info->registrants[i].rkey; 2802 TAILQ_INSERT_TAIL(&ns->registrants, reg, link); 2803 if (info->crkey != 0 && !spdk_uuid_compare(&holder_uuid, ®->hostid)) { 2804 holder = reg; 2805 } 2806 SPDK_DEBUGLOG(nvmf, "Registrant RKEY 0x%"PRIx64", Host UUID %s\n", 2807 info->registrants[i].rkey, info->registrants[i].host_uuid); 2808 } 2809 2810 if (nvmf_ns_reservation_all_registrants_type(ns)) { 2811 ns->holder = TAILQ_FIRST(&ns->registrants); 2812 } else { 2813 ns->holder = holder; 2814 } 2815 2816 return 0; 2817 } 2818 2819 static int 2820 nvmf_ns_json_write_cb(void *cb_ctx, const void *data, size_t size) 2821 { 2822 char *file = cb_ctx; 2823 size_t rc; 2824 FILE *fd; 2825 2826 fd = fopen(file, "w"); 2827 if (!fd) { 2828 SPDK_ERRLOG("Can't open file %s for write\n", file); 2829 return -ENOENT; 2830 } 2831 rc = fwrite(data, 1, size, fd); 2832 fclose(fd); 2833 2834 return rc == size ? 0 : -1; 2835 } 2836 2837 static int 2838 nvmf_ns_reservation_update_json(const struct spdk_nvmf_ns *ns, 2839 const struct spdk_nvmf_reservation_info *info) 2840 { 2841 const char *file = ns->ptpl_file; 2842 struct spdk_json_write_ctx *w; 2843 uint32_t i; 2844 int rc = 0; 2845 2846 w = spdk_json_write_begin(nvmf_ns_json_write_cb, (void *)file, 0); 2847 if (w == NULL) { 2848 return -ENOMEM; 2849 } 2850 /* clear the configuration file */ 2851 if (!info->ptpl_activated) { 2852 goto exit; 2853 } 2854 2855 spdk_json_write_object_begin(w); 2856 spdk_json_write_named_bool(w, "ptpl", info->ptpl_activated); 2857 spdk_json_write_named_uint32(w, "rtype", info->rtype); 2858 spdk_json_write_named_uint64(w, "crkey", info->crkey); 2859 spdk_json_write_named_string(w, "bdev_uuid", info->bdev_uuid); 2860 spdk_json_write_named_string(w, "holder_uuid", info->holder_uuid); 2861 2862 spdk_json_write_named_array_begin(w, "registrants"); 2863 for (i = 0; i < info->num_regs; i++) { 2864 spdk_json_write_object_begin(w); 2865 spdk_json_write_named_uint64(w, "rkey", info->registrants[i].rkey); 2866 spdk_json_write_named_string(w, "host_uuid", info->registrants[i].host_uuid); 2867 spdk_json_write_object_end(w); 2868 } 2869 spdk_json_write_array_end(w); 2870 spdk_json_write_object_end(w); 2871 2872 exit: 2873 rc = spdk_json_write_end(w); 2874 return rc; 2875 } 2876 2877 static int 2878 nvmf_ns_update_reservation_info(struct spdk_nvmf_ns *ns) 2879 { 2880 struct spdk_nvmf_reservation_info info; 2881 struct spdk_nvmf_registrant *reg, *tmp; 2882 uint32_t i = 0; 2883 2884 assert(ns != NULL); 2885 2886 if (!ns->bdev || !nvmf_ns_is_ptpl_capable(ns)) { 2887 return 0; 2888 } 2889 2890 memset(&info, 0, sizeof(info)); 2891 spdk_uuid_fmt_lower(info.bdev_uuid, sizeof(info.bdev_uuid), spdk_bdev_get_uuid(ns->bdev)); 2892 2893 if (ns->rtype) { 2894 info.rtype = ns->rtype; 2895 info.crkey = ns->crkey; 2896 if (!nvmf_ns_reservation_all_registrants_type(ns)) { 2897 assert(ns->holder != NULL); 2898 spdk_uuid_fmt_lower(info.holder_uuid, sizeof(info.holder_uuid), &ns->holder->hostid); 2899 } 2900 } 2901 2902 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2903 spdk_uuid_fmt_lower(info.registrants[i].host_uuid, sizeof(info.registrants[i].host_uuid), 2904 ®->hostid); 2905 info.registrants[i++].rkey = reg->rkey; 2906 } 2907 2908 info.num_regs = i; 2909 info.ptpl_activated = ns->ptpl_activated; 2910 2911 return nvmf_ns_reservation_update(ns, &info); 2912 } 2913 2914 static struct spdk_nvmf_registrant * 2915 nvmf_ns_reservation_get_registrant(struct spdk_nvmf_ns *ns, 2916 struct spdk_uuid *uuid) 2917 { 2918 struct spdk_nvmf_registrant *reg, *tmp; 2919 2920 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2921 if (!spdk_uuid_compare(®->hostid, uuid)) { 2922 return reg; 2923 } 2924 } 2925 2926 return NULL; 2927 } 2928 2929 /* Generate reservation notice log to registered HostID controllers */ 2930 static void 2931 nvmf_subsystem_gen_ctrlr_notification(struct spdk_nvmf_subsystem *subsystem, 2932 struct spdk_nvmf_ns *ns, 2933 struct spdk_uuid *hostid_list, 2934 uint32_t num_hostid, 2935 enum spdk_nvme_reservation_notification_log_page_type type) 2936 { 2937 struct spdk_nvmf_ctrlr *ctrlr; 2938 uint32_t i; 2939 2940 for (i = 0; i < num_hostid; i++) { 2941 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2942 if (!spdk_uuid_compare(&ctrlr->hostid, &hostid_list[i])) { 2943 nvmf_ctrlr_reservation_notice_log(ctrlr, ns, type); 2944 } 2945 } 2946 } 2947 } 2948 2949 /* Get all registrants' hostid other than the controller who issued the command */ 2950 static uint32_t 2951 nvmf_ns_reservation_get_all_other_hostid(struct spdk_nvmf_ns *ns, 2952 struct spdk_uuid *hostid_list, 2953 uint32_t max_num_hostid, 2954 struct spdk_uuid *current_hostid) 2955 { 2956 struct spdk_nvmf_registrant *reg, *tmp; 2957 uint32_t num_hostid = 0; 2958 2959 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2960 if (spdk_uuid_compare(®->hostid, current_hostid)) { 2961 if (num_hostid == max_num_hostid) { 2962 assert(false); 2963 return max_num_hostid; 2964 } 2965 hostid_list[num_hostid++] = reg->hostid; 2966 } 2967 } 2968 2969 return num_hostid; 2970 } 2971 2972 /* Calculate the unregistered HostID list according to list 2973 * prior to execute preempt command and list after executing 2974 * preempt command. 2975 */ 2976 static uint32_t 2977 nvmf_ns_reservation_get_unregistered_hostid(struct spdk_uuid *old_hostid_list, 2978 uint32_t old_num_hostid, 2979 struct spdk_uuid *remaining_hostid_list, 2980 uint32_t remaining_num_hostid) 2981 { 2982 struct spdk_uuid temp_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 2983 uint32_t i, j, num_hostid = 0; 2984 bool found; 2985 2986 if (!remaining_num_hostid) { 2987 return old_num_hostid; 2988 } 2989 2990 for (i = 0; i < old_num_hostid; i++) { 2991 found = false; 2992 for (j = 0; j < remaining_num_hostid; j++) { 2993 if (!spdk_uuid_compare(&old_hostid_list[i], &remaining_hostid_list[j])) { 2994 found = true; 2995 break; 2996 } 2997 } 2998 if (!found) { 2999 spdk_uuid_copy(&temp_hostid_list[num_hostid++], &old_hostid_list[i]); 3000 } 3001 } 3002 3003 if (num_hostid) { 3004 memcpy(old_hostid_list, temp_hostid_list, sizeof(struct spdk_uuid) * num_hostid); 3005 } 3006 3007 return num_hostid; 3008 } 3009 3010 /* current reservation type is all registrants or not */ 3011 static bool 3012 nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns) 3013 { 3014 return (ns->rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS || 3015 ns->rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS); 3016 } 3017 3018 /* current registrant is reservation holder or not */ 3019 static bool 3020 nvmf_ns_reservation_registrant_is_holder(struct spdk_nvmf_ns *ns, 3021 struct spdk_nvmf_registrant *reg) 3022 { 3023 if (!reg) { 3024 return false; 3025 } 3026 3027 if (nvmf_ns_reservation_all_registrants_type(ns)) { 3028 return true; 3029 } 3030 3031 return (ns->holder == reg); 3032 } 3033 3034 static int 3035 nvmf_ns_reservation_add_registrant(struct spdk_nvmf_ns *ns, 3036 struct spdk_nvmf_ctrlr *ctrlr, 3037 uint64_t nrkey) 3038 { 3039 struct spdk_nvmf_registrant *reg; 3040 3041 reg = calloc(1, sizeof(*reg)); 3042 if (!reg) { 3043 return -ENOMEM; 3044 } 3045 3046 reg->rkey = nrkey; 3047 /* set hostid for the registrant */ 3048 spdk_uuid_copy(®->hostid, &ctrlr->hostid); 3049 TAILQ_INSERT_TAIL(&ns->registrants, reg, link); 3050 ns->gen++; 3051 3052 return 0; 3053 } 3054 3055 static void 3056 nvmf_ns_reservation_release_reservation(struct spdk_nvmf_ns *ns) 3057 { 3058 ns->rtype = 0; 3059 ns->crkey = 0; 3060 ns->holder = NULL; 3061 } 3062 3063 /* release the reservation if the last registrant was removed */ 3064 static void 3065 nvmf_ns_reservation_check_release_on_remove_registrant(struct spdk_nvmf_ns *ns, 3066 struct spdk_nvmf_registrant *reg) 3067 { 3068 struct spdk_nvmf_registrant *next_reg; 3069 3070 /* no reservation holder */ 3071 if (!ns->holder) { 3072 assert(ns->rtype == 0); 3073 return; 3074 } 3075 3076 next_reg = TAILQ_FIRST(&ns->registrants); 3077 if (next_reg && nvmf_ns_reservation_all_registrants_type(ns)) { 3078 /* the next valid registrant is the new holder now */ 3079 ns->holder = next_reg; 3080 } else if (nvmf_ns_reservation_registrant_is_holder(ns, reg)) { 3081 /* release the reservation */ 3082 nvmf_ns_reservation_release_reservation(ns); 3083 } 3084 } 3085 3086 static void 3087 nvmf_ns_reservation_remove_registrant(struct spdk_nvmf_ns *ns, 3088 struct spdk_nvmf_registrant *reg) 3089 { 3090 TAILQ_REMOVE(&ns->registrants, reg, link); 3091 nvmf_ns_reservation_check_release_on_remove_registrant(ns, reg); 3092 free(reg); 3093 ns->gen++; 3094 return; 3095 } 3096 3097 static uint32_t 3098 nvmf_ns_reservation_remove_registrants_by_key(struct spdk_nvmf_ns *ns, 3099 uint64_t rkey) 3100 { 3101 struct spdk_nvmf_registrant *reg, *tmp; 3102 uint32_t count = 0; 3103 3104 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3105 if (reg->rkey == rkey) { 3106 nvmf_ns_reservation_remove_registrant(ns, reg); 3107 count++; 3108 } 3109 } 3110 return count; 3111 } 3112 3113 static uint32_t 3114 nvmf_ns_reservation_remove_all_other_registrants(struct spdk_nvmf_ns *ns, 3115 struct spdk_nvmf_registrant *reg) 3116 { 3117 struct spdk_nvmf_registrant *reg_tmp, *reg_tmp2; 3118 uint32_t count = 0; 3119 3120 TAILQ_FOREACH_SAFE(reg_tmp, &ns->registrants, link, reg_tmp2) { 3121 if (reg_tmp != reg) { 3122 nvmf_ns_reservation_remove_registrant(ns, reg_tmp); 3123 count++; 3124 } 3125 } 3126 return count; 3127 } 3128 3129 static uint32_t 3130 nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns) 3131 { 3132 struct spdk_nvmf_registrant *reg, *reg_tmp; 3133 uint32_t count = 0; 3134 3135 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, reg_tmp) { 3136 nvmf_ns_reservation_remove_registrant(ns, reg); 3137 count++; 3138 } 3139 return count; 3140 } 3141 3142 static void 3143 nvmf_ns_reservation_acquire_reservation(struct spdk_nvmf_ns *ns, uint64_t rkey, 3144 enum spdk_nvme_reservation_type rtype, 3145 struct spdk_nvmf_registrant *holder) 3146 { 3147 ns->rtype = rtype; 3148 ns->crkey = rkey; 3149 assert(ns->holder == NULL); 3150 ns->holder = holder; 3151 } 3152 3153 static bool 3154 nvmf_ns_reservation_register(struct spdk_nvmf_ns *ns, 3155 struct spdk_nvmf_ctrlr *ctrlr, 3156 struct spdk_nvmf_request *req) 3157 { 3158 struct spdk_nvme_reservation_register_data key = { 0 }; 3159 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3160 uint8_t rrega, iekey, cptpl, rtype; 3161 struct spdk_nvmf_registrant *reg; 3162 uint8_t status = SPDK_NVME_SC_SUCCESS; 3163 bool update_sgroup = false; 3164 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3165 uint32_t num_hostid = 0; 3166 int rc; 3167 3168 rrega = cmd->cdw10_bits.resv_register.rrega; 3169 iekey = cmd->cdw10_bits.resv_register.iekey; 3170 cptpl = cmd->cdw10_bits.resv_register.cptpl; 3171 3172 if (req->iovcnt > 0 && req->length >= sizeof(key)) { 3173 struct spdk_iov_xfer ix; 3174 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3175 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key)); 3176 } else { 3177 SPDK_ERRLOG("No key provided. Failing request.\n"); 3178 status = SPDK_NVME_SC_INVALID_FIELD; 3179 goto exit; 3180 } 3181 3182 SPDK_DEBUGLOG(nvmf, "REGISTER: RREGA %u, IEKEY %u, CPTPL %u, " 3183 "NRKEY 0x%"PRIx64", NRKEY 0x%"PRIx64"\n", 3184 rrega, iekey, cptpl, key.crkey, key.nrkey); 3185 3186 if (cptpl == SPDK_NVME_RESERVE_PTPL_CLEAR_POWER_ON) { 3187 /* True to OFF state, and need to be updated in the configuration file */ 3188 if (ns->ptpl_activated) { 3189 ns->ptpl_activated = 0; 3190 update_sgroup = true; 3191 } 3192 } else if (cptpl == SPDK_NVME_RESERVE_PTPL_PERSIST_POWER_LOSS) { 3193 if (!nvmf_ns_is_ptpl_capable(ns)) { 3194 status = SPDK_NVME_SC_INVALID_FIELD; 3195 goto exit; 3196 } else if (ns->ptpl_activated == 0) { 3197 ns->ptpl_activated = 1; 3198 update_sgroup = true; 3199 } 3200 } 3201 3202 /* current Host Identifier has registrant or not */ 3203 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3204 3205 switch (rrega) { 3206 case SPDK_NVME_RESERVE_REGISTER_KEY: 3207 if (!reg) { 3208 /* register new controller */ 3209 if (key.nrkey == 0) { 3210 SPDK_ERRLOG("Can't register zeroed new key\n"); 3211 status = SPDK_NVME_SC_INVALID_FIELD; 3212 goto exit; 3213 } 3214 rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey); 3215 if (rc < 0) { 3216 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3217 goto exit; 3218 } 3219 update_sgroup = true; 3220 } else { 3221 /* register with same key is not an error */ 3222 if (reg->rkey != key.nrkey) { 3223 SPDK_ERRLOG("The same host already register a " 3224 "key with 0x%"PRIx64"\n", 3225 reg->rkey); 3226 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3227 goto exit; 3228 } 3229 } 3230 break; 3231 case SPDK_NVME_RESERVE_UNREGISTER_KEY: 3232 if (!reg || (!iekey && reg->rkey != key.crkey)) { 3233 SPDK_ERRLOG("No registrant or current key doesn't match " 3234 "with existing registrant key\n"); 3235 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3236 goto exit; 3237 } 3238 3239 rtype = ns->rtype; 3240 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3241 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3242 &ctrlr->hostid); 3243 3244 nvmf_ns_reservation_remove_registrant(ns, reg); 3245 3246 if (!ns->rtype && num_hostid && (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_REG_ONLY || 3247 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY)) { 3248 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3249 hostid_list, 3250 num_hostid, 3251 SPDK_NVME_RESERVATION_RELEASED); 3252 } 3253 update_sgroup = true; 3254 break; 3255 case SPDK_NVME_RESERVE_REPLACE_KEY: 3256 if (key.nrkey == 0) { 3257 SPDK_ERRLOG("Can't register zeroed new key\n"); 3258 status = SPDK_NVME_SC_INVALID_FIELD; 3259 goto exit; 3260 } 3261 /* Registrant exists */ 3262 if (reg) { 3263 if (!iekey && reg->rkey != key.crkey) { 3264 SPDK_ERRLOG("Current key doesn't match " 3265 "existing registrant key\n"); 3266 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3267 goto exit; 3268 } 3269 if (reg->rkey == key.nrkey) { 3270 goto exit; 3271 } 3272 reg->rkey = key.nrkey; 3273 } else if (iekey) { /* No registrant but IEKEY is set */ 3274 /* new registrant */ 3275 rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey); 3276 if (rc < 0) { 3277 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3278 goto exit; 3279 } 3280 } else { /* No registrant */ 3281 SPDK_ERRLOG("No registrant\n"); 3282 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3283 goto exit; 3284 3285 } 3286 update_sgroup = true; 3287 break; 3288 default: 3289 status = SPDK_NVME_SC_INVALID_FIELD; 3290 goto exit; 3291 } 3292 3293 exit: 3294 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3295 req->rsp->nvme_cpl.status.sc = status; 3296 return update_sgroup; 3297 } 3298 3299 static bool 3300 nvmf_ns_reservation_acquire(struct spdk_nvmf_ns *ns, 3301 struct spdk_nvmf_ctrlr *ctrlr, 3302 struct spdk_nvmf_request *req) 3303 { 3304 struct spdk_nvme_reservation_acquire_data key = { 0 }; 3305 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3306 uint8_t racqa, iekey, rtype; 3307 struct spdk_nvmf_registrant *reg; 3308 bool all_regs = false; 3309 uint32_t count = 0; 3310 bool update_sgroup = true; 3311 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3312 uint32_t num_hostid = 0; 3313 struct spdk_uuid new_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3314 uint32_t new_num_hostid = 0; 3315 bool reservation_released = false; 3316 uint8_t status = SPDK_NVME_SC_SUCCESS; 3317 3318 racqa = cmd->cdw10_bits.resv_acquire.racqa; 3319 iekey = cmd->cdw10_bits.resv_acquire.iekey; 3320 rtype = cmd->cdw10_bits.resv_acquire.rtype; 3321 3322 if (req->iovcnt > 0 && req->length >= sizeof(key)) { 3323 struct spdk_iov_xfer ix; 3324 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3325 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key)); 3326 } else { 3327 SPDK_ERRLOG("No key provided. Failing request.\n"); 3328 status = SPDK_NVME_SC_INVALID_FIELD; 3329 goto exit; 3330 } 3331 3332 SPDK_DEBUGLOG(nvmf, "ACQUIRE: RACQA %u, IEKEY %u, RTYPE %u, " 3333 "NRKEY 0x%"PRIx64", PRKEY 0x%"PRIx64"\n", 3334 racqa, iekey, rtype, key.crkey, key.prkey); 3335 3336 if (iekey || rtype > SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) { 3337 SPDK_ERRLOG("Ignore existing key field set to 1\n"); 3338 status = SPDK_NVME_SC_INVALID_FIELD; 3339 update_sgroup = false; 3340 goto exit; 3341 } 3342 3343 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3344 /* must be registrant and CRKEY must match */ 3345 if (!reg || reg->rkey != key.crkey) { 3346 SPDK_ERRLOG("No registrant or current key doesn't match " 3347 "with existing registrant key\n"); 3348 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3349 update_sgroup = false; 3350 goto exit; 3351 } 3352 3353 all_regs = nvmf_ns_reservation_all_registrants_type(ns); 3354 3355 switch (racqa) { 3356 case SPDK_NVME_RESERVE_ACQUIRE: 3357 /* it's not an error for the holder to acquire same reservation type again */ 3358 if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && ns->rtype == rtype) { 3359 /* do nothing */ 3360 update_sgroup = false; 3361 } else if (ns->holder == NULL) { 3362 /* first time to acquire the reservation */ 3363 nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg); 3364 } else { 3365 SPDK_ERRLOG("Invalid rtype or current registrant is not holder\n"); 3366 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3367 update_sgroup = false; 3368 goto exit; 3369 } 3370 break; 3371 case SPDK_NVME_RESERVE_PREEMPT: 3372 /* no reservation holder */ 3373 if (!ns->holder) { 3374 /* unregister with PRKEY */ 3375 nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3376 break; 3377 } 3378 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3379 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3380 &ctrlr->hostid); 3381 3382 /* only 1 reservation holder and reservation key is valid */ 3383 if (!all_regs) { 3384 /* preempt itself */ 3385 if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && 3386 ns->crkey == key.prkey) { 3387 ns->rtype = rtype; 3388 reservation_released = true; 3389 break; 3390 } 3391 3392 if (ns->crkey == key.prkey) { 3393 nvmf_ns_reservation_remove_registrant(ns, ns->holder); 3394 nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg); 3395 reservation_released = true; 3396 } else if (key.prkey != 0) { 3397 nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3398 } else { 3399 /* PRKEY is zero */ 3400 SPDK_ERRLOG("Current PRKEY is zero\n"); 3401 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3402 update_sgroup = false; 3403 goto exit; 3404 } 3405 } else { 3406 /* release all other registrants except for the current one */ 3407 if (key.prkey == 0) { 3408 nvmf_ns_reservation_remove_all_other_registrants(ns, reg); 3409 assert(ns->holder == reg); 3410 } else { 3411 count = nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3412 if (count == 0) { 3413 SPDK_ERRLOG("PRKEY doesn't match any registrant\n"); 3414 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3415 update_sgroup = false; 3416 goto exit; 3417 } 3418 } 3419 } 3420 break; 3421 default: 3422 status = SPDK_NVME_SC_INVALID_FIELD; 3423 update_sgroup = false; 3424 break; 3425 } 3426 3427 exit: 3428 if (update_sgroup && racqa == SPDK_NVME_RESERVE_PREEMPT) { 3429 new_num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, new_hostid_list, 3430 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3431 &ctrlr->hostid); 3432 /* Preempt notification occurs on the unregistered controllers 3433 * other than the controller who issued the command. 3434 */ 3435 num_hostid = nvmf_ns_reservation_get_unregistered_hostid(hostid_list, 3436 num_hostid, 3437 new_hostid_list, 3438 new_num_hostid); 3439 if (num_hostid) { 3440 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3441 hostid_list, 3442 num_hostid, 3443 SPDK_NVME_REGISTRATION_PREEMPTED); 3444 3445 } 3446 /* Reservation released notification occurs on the 3447 * controllers which are the remaining registrants other than 3448 * the controller who issued the command. 3449 */ 3450 if (reservation_released && new_num_hostid) { 3451 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3452 new_hostid_list, 3453 new_num_hostid, 3454 SPDK_NVME_RESERVATION_RELEASED); 3455 3456 } 3457 } 3458 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3459 req->rsp->nvme_cpl.status.sc = status; 3460 return update_sgroup; 3461 } 3462 3463 static bool 3464 nvmf_ns_reservation_release(struct spdk_nvmf_ns *ns, 3465 struct spdk_nvmf_ctrlr *ctrlr, 3466 struct spdk_nvmf_request *req) 3467 { 3468 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3469 uint8_t rrela, iekey, rtype; 3470 struct spdk_nvmf_registrant *reg; 3471 uint64_t crkey = 0; 3472 uint8_t status = SPDK_NVME_SC_SUCCESS; 3473 bool update_sgroup = true; 3474 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3475 uint32_t num_hostid = 0; 3476 3477 rrela = cmd->cdw10_bits.resv_release.rrela; 3478 iekey = cmd->cdw10_bits.resv_release.iekey; 3479 rtype = cmd->cdw10_bits.resv_release.rtype; 3480 3481 if (req->iovcnt > 0 && req->length >= sizeof(crkey)) { 3482 struct spdk_iov_xfer ix; 3483 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3484 spdk_iov_xfer_to_buf(&ix, &crkey, sizeof(crkey)); 3485 } else { 3486 SPDK_ERRLOG("No key provided. Failing request.\n"); 3487 status = SPDK_NVME_SC_INVALID_FIELD; 3488 goto exit; 3489 } 3490 3491 SPDK_DEBUGLOG(nvmf, "RELEASE: RRELA %u, IEKEY %u, RTYPE %u, " 3492 "CRKEY 0x%"PRIx64"\n", rrela, iekey, rtype, crkey); 3493 3494 if (iekey) { 3495 SPDK_ERRLOG("Ignore existing key field set to 1\n"); 3496 status = SPDK_NVME_SC_INVALID_FIELD; 3497 update_sgroup = false; 3498 goto exit; 3499 } 3500 3501 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3502 if (!reg || reg->rkey != crkey) { 3503 SPDK_ERRLOG("No registrant or current key doesn't match " 3504 "with existing registrant key\n"); 3505 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3506 update_sgroup = false; 3507 goto exit; 3508 } 3509 3510 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3511 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3512 &ctrlr->hostid); 3513 3514 switch (rrela) { 3515 case SPDK_NVME_RESERVE_RELEASE: 3516 if (!ns->holder) { 3517 SPDK_DEBUGLOG(nvmf, "RELEASE: no holder\n"); 3518 update_sgroup = false; 3519 goto exit; 3520 } 3521 if (ns->rtype != rtype) { 3522 SPDK_ERRLOG("Type doesn't match\n"); 3523 status = SPDK_NVME_SC_INVALID_FIELD; 3524 update_sgroup = false; 3525 goto exit; 3526 } 3527 if (!nvmf_ns_reservation_registrant_is_holder(ns, reg)) { 3528 /* not the reservation holder, this isn't an error */ 3529 update_sgroup = false; 3530 goto exit; 3531 } 3532 3533 rtype = ns->rtype; 3534 nvmf_ns_reservation_release_reservation(ns); 3535 3536 if (num_hostid && rtype != SPDK_NVME_RESERVE_WRITE_EXCLUSIVE && 3537 rtype != SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 3538 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3539 hostid_list, 3540 num_hostid, 3541 SPDK_NVME_RESERVATION_RELEASED); 3542 } 3543 break; 3544 case SPDK_NVME_RESERVE_CLEAR: 3545 nvmf_ns_reservation_clear_all_registrants(ns); 3546 if (num_hostid) { 3547 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3548 hostid_list, 3549 num_hostid, 3550 SPDK_NVME_RESERVATION_PREEMPTED); 3551 } 3552 break; 3553 default: 3554 status = SPDK_NVME_SC_INVALID_FIELD; 3555 update_sgroup = false; 3556 goto exit; 3557 } 3558 3559 exit: 3560 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3561 req->rsp->nvme_cpl.status.sc = status; 3562 return update_sgroup; 3563 } 3564 3565 static void 3566 nvmf_ns_reservation_report(struct spdk_nvmf_ns *ns, 3567 struct spdk_nvmf_ctrlr *ctrlr, 3568 struct spdk_nvmf_request *req) 3569 { 3570 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3571 struct spdk_nvmf_registrant *reg, *tmp; 3572 struct spdk_nvme_reservation_status_extended_data status_data = { 0 }; 3573 struct spdk_iov_xfer ix; 3574 uint32_t transfer_len; 3575 uint32_t regctl = 0; 3576 uint8_t status = SPDK_NVME_SC_SUCCESS; 3577 3578 if (req->iovcnt == 0) { 3579 SPDK_ERRLOG("No data transfer specified for request. " 3580 " Unable to transfer back response.\n"); 3581 status = SPDK_NVME_SC_INVALID_FIELD; 3582 goto exit; 3583 } 3584 3585 if (!cmd->cdw11_bits.resv_report.eds) { 3586 SPDK_ERRLOG("NVMeoF uses extended controller data structure, " 3587 "please set EDS bit in cdw11 and try again\n"); 3588 status = SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT; 3589 goto exit; 3590 } 3591 3592 /* Number of Dwords of the Reservation Status data structure to transfer */ 3593 transfer_len = (cmd->cdw10 + 1) * sizeof(uint32_t); 3594 3595 if (transfer_len < sizeof(struct spdk_nvme_reservation_status_extended_data)) { 3596 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3597 goto exit; 3598 } 3599 3600 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3601 3602 status_data.data.gen = ns->gen; 3603 status_data.data.rtype = ns->rtype; 3604 status_data.data.ptpls = ns->ptpl_activated; 3605 3606 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3607 regctl++; 3608 } 3609 3610 /* 3611 * We report the number of registrants as per the spec here, even if 3612 * the iov isn't big enough to contain them all. In that case, the 3613 * spdk_iov_xfer_from_buf() won't actually copy any of the remaining 3614 * data; as it keeps track of the iov cursor itself, it's simplest to 3615 * just walk the entire list anyway. 3616 */ 3617 status_data.data.regctl = regctl; 3618 3619 spdk_iov_xfer_from_buf(&ix, &status_data, sizeof(status_data)); 3620 3621 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3622 struct spdk_nvme_registered_ctrlr_extended_data ctrlr_data = { 0 }; 3623 3624 /* Set to 0xffffh for dynamic controller */ 3625 ctrlr_data.cntlid = 0xffff; 3626 ctrlr_data.rcsts.status = (ns->holder == reg) ? true : false; 3627 ctrlr_data.rkey = reg->rkey; 3628 spdk_uuid_copy((struct spdk_uuid *)ctrlr_data.hostid, ®->hostid); 3629 3630 spdk_iov_xfer_from_buf(&ix, &ctrlr_data, sizeof(ctrlr_data)); 3631 } 3632 3633 exit: 3634 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3635 req->rsp->nvme_cpl.status.sc = status; 3636 return; 3637 } 3638 3639 static void 3640 nvmf_ns_reservation_complete(void *ctx) 3641 { 3642 struct spdk_nvmf_request *req = ctx; 3643 3644 spdk_nvmf_request_complete(req); 3645 } 3646 3647 static void 3648 _nvmf_ns_reservation_update_done(struct spdk_nvmf_subsystem *subsystem, 3649 void *cb_arg, int status) 3650 { 3651 struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)cb_arg; 3652 struct spdk_nvmf_poll_group *group = req->qpair->group; 3653 3654 spdk_thread_send_msg(group->thread, nvmf_ns_reservation_complete, req); 3655 } 3656 3657 void 3658 nvmf_ns_reservation_request(void *ctx) 3659 { 3660 struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)ctx; 3661 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3662 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3663 uint32_t nsid; 3664 struct spdk_nvmf_ns *ns; 3665 bool update_sgroup = false; 3666 int status = 0; 3667 3668 nsid = cmd->nsid; 3669 ns = _nvmf_subsystem_get_ns(ctrlr->subsys, nsid); 3670 assert(ns != NULL); 3671 3672 switch (cmd->opc) { 3673 case SPDK_NVME_OPC_RESERVATION_REGISTER: 3674 update_sgroup = nvmf_ns_reservation_register(ns, ctrlr, req); 3675 break; 3676 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 3677 update_sgroup = nvmf_ns_reservation_acquire(ns, ctrlr, req); 3678 break; 3679 case SPDK_NVME_OPC_RESERVATION_RELEASE: 3680 update_sgroup = nvmf_ns_reservation_release(ns, ctrlr, req); 3681 break; 3682 case SPDK_NVME_OPC_RESERVATION_REPORT: 3683 nvmf_ns_reservation_report(ns, ctrlr, req); 3684 break; 3685 default: 3686 break; 3687 } 3688 3689 /* update reservation information to subsystem's poll group */ 3690 if (update_sgroup) { 3691 if (ns->ptpl_activated || cmd->opc == SPDK_NVME_OPC_RESERVATION_REGISTER) { 3692 if (nvmf_ns_update_reservation_info(ns) != 0) { 3693 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3694 } 3695 } 3696 status = nvmf_subsystem_update_ns(ctrlr->subsys, _nvmf_ns_reservation_update_done, req); 3697 if (status == 0) { 3698 return; 3699 } 3700 } 3701 3702 _nvmf_ns_reservation_update_done(ctrlr->subsys, req, status); 3703 } 3704 3705 static bool 3706 nvmf_ns_is_ptpl_capable_json(const struct spdk_nvmf_ns *ns) 3707 { 3708 return ns->ptpl_file != NULL; 3709 } 3710 3711 static struct spdk_nvmf_ns_reservation_ops g_reservation_ops = { 3712 .is_ptpl_capable = nvmf_ns_is_ptpl_capable_json, 3713 .update = nvmf_ns_reservation_update_json, 3714 .load = nvmf_ns_reservation_load_json, 3715 }; 3716 3717 bool 3718 nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns) 3719 { 3720 return g_reservation_ops.is_ptpl_capable(ns); 3721 } 3722 3723 static int 3724 nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns, 3725 const struct spdk_nvmf_reservation_info *info) 3726 { 3727 return g_reservation_ops.update(ns, info); 3728 } 3729 3730 static int 3731 nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info) 3732 { 3733 return g_reservation_ops.load(ns, info); 3734 } 3735 3736 void 3737 spdk_nvmf_set_custom_ns_reservation_ops(const struct spdk_nvmf_ns_reservation_ops *ops) 3738 { 3739 g_reservation_ops = *ops; 3740 } 3741 3742 int 3743 spdk_nvmf_subsystem_set_ana_reporting(struct spdk_nvmf_subsystem *subsystem, 3744 bool ana_reporting) 3745 { 3746 if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) { 3747 return -EAGAIN; 3748 } 3749 3750 subsystem->flags.ana_reporting = ana_reporting; 3751 3752 return 0; 3753 } 3754 3755 bool 3756 spdk_nvmf_subsystem_get_ana_reporting(struct spdk_nvmf_subsystem *subsystem) 3757 { 3758 return subsystem->flags.ana_reporting; 3759 } 3760 3761 struct subsystem_listener_update_ctx { 3762 struct spdk_nvmf_subsystem_listener *listener; 3763 3764 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn; 3765 void *cb_arg; 3766 }; 3767 3768 static void 3769 subsystem_listener_update_done(struct spdk_io_channel_iter *i, int status) 3770 { 3771 struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 3772 3773 if (ctx->cb_fn) { 3774 ctx->cb_fn(ctx->cb_arg, status); 3775 } 3776 free(ctx); 3777 } 3778 3779 static void 3780 subsystem_listener_update_on_pg(struct spdk_io_channel_iter *i) 3781 { 3782 struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 3783 struct spdk_nvmf_subsystem_listener *listener; 3784 struct spdk_nvmf_poll_group *group; 3785 struct spdk_nvmf_ctrlr *ctrlr; 3786 3787 listener = ctx->listener; 3788 group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i)); 3789 3790 TAILQ_FOREACH(ctrlr, &listener->subsystem->ctrlrs, link) { 3791 if (ctrlr->thread != spdk_get_thread()) { 3792 continue; 3793 } 3794 3795 if (ctrlr->admin_qpair && ctrlr->admin_qpair->group == group && ctrlr->listener == listener) { 3796 nvmf_ctrlr_async_event_ana_change_notice(ctrlr); 3797 } 3798 } 3799 3800 spdk_for_each_channel_continue(i, 0); 3801 } 3802 3803 void 3804 spdk_nvmf_subsystem_set_ana_state(struct spdk_nvmf_subsystem *subsystem, 3805 const struct spdk_nvme_transport_id *trid, 3806 enum spdk_nvme_ana_state ana_state, uint32_t anagrpid, 3807 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, void *cb_arg) 3808 { 3809 struct spdk_nvmf_subsystem_listener *listener; 3810 struct subsystem_listener_update_ctx *ctx; 3811 uint32_t i; 3812 3813 assert(cb_fn != NULL); 3814 assert(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 3815 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED); 3816 3817 if (!subsystem->flags.ana_reporting) { 3818 SPDK_ERRLOG("ANA reporting is disabled\n"); 3819 cb_fn(cb_arg, -EINVAL); 3820 return; 3821 } 3822 3823 /* ANA Change state is not used, ANA Persistent Loss state 3824 * is not supported yet. 3825 */ 3826 if (!(ana_state == SPDK_NVME_ANA_OPTIMIZED_STATE || 3827 ana_state == SPDK_NVME_ANA_NON_OPTIMIZED_STATE || 3828 ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE)) { 3829 SPDK_ERRLOG("ANA state %d is not supported\n", ana_state); 3830 cb_fn(cb_arg, -ENOTSUP); 3831 return; 3832 } 3833 3834 if (anagrpid > subsystem->max_nsid) { 3835 SPDK_ERRLOG("ANA group ID %" PRIu32 " is more than maximum\n", anagrpid); 3836 cb_fn(cb_arg, -EINVAL); 3837 return; 3838 } 3839 3840 listener = nvmf_subsystem_find_listener(subsystem, trid); 3841 if (!listener) { 3842 SPDK_ERRLOG("Unable to find listener.\n"); 3843 cb_fn(cb_arg, -EINVAL); 3844 return; 3845 } 3846 3847 if (anagrpid != 0 && listener->ana_state[anagrpid - 1] == ana_state) { 3848 cb_fn(cb_arg, 0); 3849 return; 3850 } 3851 3852 ctx = calloc(1, sizeof(*ctx)); 3853 if (!ctx) { 3854 SPDK_ERRLOG("Unable to allocate context\n"); 3855 cb_fn(cb_arg, -ENOMEM); 3856 return; 3857 } 3858 3859 for (i = 1; i <= subsystem->max_nsid; i++) { 3860 if (anagrpid == 0 || i == anagrpid) { 3861 listener->ana_state[i - 1] = ana_state; 3862 } 3863 } 3864 listener->ana_state_change_count++; 3865 3866 ctx->listener = listener; 3867 ctx->cb_fn = cb_fn; 3868 ctx->cb_arg = cb_arg; 3869 3870 spdk_for_each_channel(subsystem->tgt, 3871 subsystem_listener_update_on_pg, 3872 ctx, 3873 subsystem_listener_update_done); 3874 } 3875 3876 int 3877 spdk_nvmf_subsystem_get_ana_state(struct spdk_nvmf_subsystem *subsystem, 3878 const struct spdk_nvme_transport_id *trid, 3879 uint32_t anagrpid, 3880 enum spdk_nvme_ana_state *ana_state) 3881 { 3882 assert(ana_state != NULL); 3883 3884 struct spdk_nvmf_subsystem_listener *listener; 3885 3886 if (!subsystem->flags.ana_reporting) { 3887 SPDK_ERRLOG("ANA reporting is disabled\n"); 3888 return -EINVAL; 3889 } 3890 3891 if (anagrpid <= 0 || anagrpid > subsystem->max_nsid) { 3892 SPDK_ERRLOG("ANA group ID %" PRIu32 " is invalid\n", anagrpid); 3893 return -EINVAL; 3894 } 3895 3896 listener = nvmf_subsystem_find_listener(subsystem, trid); 3897 if (!listener) { 3898 SPDK_ERRLOG("Unable to find listener.\n"); 3899 return -EINVAL; 3900 } 3901 3902 *ana_state = listener->ana_state[anagrpid - 1]; 3903 return 0; 3904 } 3905 3906 bool 3907 spdk_nvmf_subsystem_is_discovery(struct spdk_nvmf_subsystem *subsystem) 3908 { 3909 return subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT || 3910 subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY; 3911 } 3912 3913 bool 3914 nvmf_nqn_is_discovery(const char *nqn) 3915 { 3916 return strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN) == 0; 3917 } 3918