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 nvmf_update_discovery_log(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 spdk_bit_array_get(ctrlr->visible_ns, nsid - 1) == visible) { 925 continue; 926 } 927 if (visible) { 928 spdk_bit_array_set(ctrlr->visible_ns, nsid - 1); 929 } else { 930 spdk_bit_array_clear(ctrlr->visible_ns, nsid - 1); 931 } 932 send_async_event_ns_notice(ctrlr); 933 nvmf_ctrlr_ns_changed(ctrlr, nsid); 934 } 935 936 return 0; 937 } 938 939 int 940 spdk_nvmf_ns_add_host(struct spdk_nvmf_subsystem *subsystem, 941 uint32_t nsid, 942 const char *hostnqn, 943 uint32_t flags) 944 { 945 SPDK_DTRACE_PROBE4(spdk_nvmf_ns_add_host, 946 subsystem->subnqn, 947 nsid, 948 hostnqn, 949 flags); 950 return nvmf_ns_visible(subsystem, nsid, hostnqn, true); 951 } 952 953 int 954 spdk_nvmf_ns_remove_host(struct spdk_nvmf_subsystem *subsystem, 955 uint32_t nsid, 956 const char *hostnqn, 957 uint32_t flags) 958 { 959 SPDK_DTRACE_PROBE4(spdk_nvmf_ns_remove_host, 960 subsystem->subnqn, 961 nsid, 962 hostnqn, 963 flags); 964 return nvmf_ns_visible(subsystem, nsid, hostnqn, false); 965 } 966 967 /* Must hold subsystem->mutex while calling this function */ 968 static struct spdk_nvmf_host * 969 nvmf_subsystem_find_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 970 { 971 struct spdk_nvmf_host *host = NULL; 972 973 TAILQ_FOREACH(host, &subsystem->hosts, link) { 974 if (strcmp(hostnqn, host->nqn) == 0) { 975 return host; 976 } 977 } 978 979 return NULL; 980 } 981 982 int 983 spdk_nvmf_subsystem_add_host_ext(struct spdk_nvmf_subsystem *subsystem, 984 const char *hostnqn, struct spdk_nvmf_host_opts *opts) 985 { 986 struct spdk_nvmf_host *host; 987 struct spdk_nvmf_transport *transport; 988 struct spdk_key *key; 989 int rc; 990 991 if (!nvmf_nqn_is_valid(hostnqn)) { 992 return -EINVAL; 993 } 994 995 pthread_mutex_lock(&subsystem->mutex); 996 997 if (nvmf_subsystem_find_host(subsystem, hostnqn)) { 998 /* This subsystem already allows the specified host. */ 999 pthread_mutex_unlock(&subsystem->mutex); 1000 return -EINVAL; 1001 } 1002 1003 host = calloc(1, sizeof(*host)); 1004 if (!host) { 1005 pthread_mutex_unlock(&subsystem->mutex); 1006 return -ENOMEM; 1007 } 1008 1009 key = SPDK_GET_FIELD(opts, dhchap_key, NULL); 1010 if (key != NULL) { 1011 if (!nvmf_auth_is_supported()) { 1012 SPDK_ERRLOG("NVMe in-band authentication is unsupported\n"); 1013 pthread_mutex_unlock(&subsystem->mutex); 1014 nvmf_host_free(host); 1015 return -EINVAL; 1016 } 1017 host->dhchap_key = spdk_key_dup(key); 1018 if (host->dhchap_key == NULL) { 1019 pthread_mutex_unlock(&subsystem->mutex); 1020 nvmf_host_free(host); 1021 return -EINVAL; 1022 } 1023 key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL); 1024 if (key != NULL) { 1025 host->dhchap_ctrlr_key = spdk_key_dup(key); 1026 if (host->dhchap_ctrlr_key == NULL) { 1027 pthread_mutex_unlock(&subsystem->mutex); 1028 nvmf_host_free(host); 1029 return -EINVAL; 1030 } 1031 } 1032 } else if (SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL) != NULL) { 1033 SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n"); 1034 pthread_mutex_unlock(&subsystem->mutex); 1035 nvmf_host_free(host); 1036 return -EINVAL; 1037 } 1038 1039 snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn); 1040 1041 SPDK_DTRACE_PROBE2(nvmf_subsystem_add_host, subsystem->subnqn, host->nqn); 1042 1043 TAILQ_INSERT_HEAD(&subsystem->hosts, host, link); 1044 1045 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1046 nvmf_update_discovery_log(subsystem->tgt, hostnqn); 1047 } 1048 1049 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1050 transport = spdk_nvmf_transport_get_next(transport)) { 1051 if (transport->ops->subsystem_add_host) { 1052 rc = transport->ops->subsystem_add_host(transport, subsystem, hostnqn, 1053 SPDK_GET_FIELD(opts, params, NULL)); 1054 if (rc) { 1055 SPDK_ERRLOG("Unable to add host to %s transport\n", transport->ops->name); 1056 /* Remove this host from all transports we've managed to add it to. */ 1057 pthread_mutex_unlock(&subsystem->mutex); 1058 spdk_nvmf_subsystem_remove_host(subsystem, hostnqn); 1059 return rc; 1060 } 1061 } 1062 } 1063 1064 pthread_mutex_unlock(&subsystem->mutex); 1065 1066 return 0; 1067 } 1068 1069 int 1070 spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1071 const struct spdk_json_val *params) 1072 { 1073 struct spdk_nvmf_host_opts opts = {}; 1074 1075 opts.size = SPDK_SIZEOF(&opts, params); 1076 opts.params = params; 1077 1078 return spdk_nvmf_subsystem_add_host_ext(subsystem, hostnqn, &opts); 1079 } 1080 1081 int 1082 spdk_nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1083 { 1084 struct spdk_nvmf_host *host; 1085 struct spdk_nvmf_transport *transport; 1086 1087 pthread_mutex_lock(&subsystem->mutex); 1088 1089 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1090 if (host == NULL) { 1091 pthread_mutex_unlock(&subsystem->mutex); 1092 return -ENOENT; 1093 } 1094 1095 SPDK_DTRACE_PROBE2(nvmf_subsystem_remove_host, subsystem->subnqn, host->nqn); 1096 1097 nvmf_subsystem_remove_host(subsystem, host); 1098 1099 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1100 nvmf_update_discovery_log(subsystem->tgt, hostnqn); 1101 } 1102 1103 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1104 transport = spdk_nvmf_transport_get_next(transport)) { 1105 if (transport->ops->subsystem_remove_host) { 1106 transport->ops->subsystem_remove_host(transport, subsystem, hostnqn); 1107 } 1108 } 1109 1110 pthread_mutex_unlock(&subsystem->mutex); 1111 1112 return 0; 1113 } 1114 1115 int 1116 spdk_nvmf_subsystem_set_keys(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1117 struct spdk_nvmf_subsystem_key_opts *opts) 1118 { 1119 struct spdk_nvmf_host *host; 1120 struct spdk_key *key, *ckey; 1121 1122 if (!nvmf_auth_is_supported()) { 1123 SPDK_ERRLOG("NVMe in-band authentication is unsupported\n"); 1124 return -EINVAL; 1125 } 1126 1127 pthread_mutex_lock(&subsystem->mutex); 1128 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1129 if (host == NULL) { 1130 pthread_mutex_unlock(&subsystem->mutex); 1131 return -EINVAL; 1132 } 1133 1134 if (SPDK_GET_FIELD(opts, dhchap_key, host->dhchap_key) == NULL && 1135 SPDK_GET_FIELD(opts, dhchap_ctrlr_key, host->dhchap_ctrlr_key) != NULL) { 1136 SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n"); 1137 pthread_mutex_unlock(&subsystem->mutex); 1138 return -EINVAL; 1139 } 1140 key = SPDK_GET_FIELD(opts, dhchap_key, NULL); 1141 if (key != NULL) { 1142 key = spdk_key_dup(key); 1143 if (key == NULL) { 1144 pthread_mutex_unlock(&subsystem->mutex); 1145 return -EINVAL; 1146 } 1147 } 1148 ckey = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL); 1149 if (ckey != NULL) { 1150 ckey = spdk_key_dup(ckey); 1151 if (ckey == NULL) { 1152 pthread_mutex_unlock(&subsystem->mutex); 1153 spdk_keyring_put_key(key); 1154 return -EINVAL; 1155 } 1156 } 1157 if (SPDK_FIELD_VALID(opts, dhchap_key)) { 1158 spdk_keyring_put_key(host->dhchap_key); 1159 host->dhchap_key = key; 1160 } 1161 if (SPDK_FIELD_VALID(opts, dhchap_ctrlr_key)) { 1162 spdk_keyring_put_key(host->dhchap_ctrlr_key); 1163 host->dhchap_ctrlr_key = ckey; 1164 } 1165 pthread_mutex_unlock(&subsystem->mutex); 1166 1167 return 0; 1168 } 1169 1170 struct nvmf_subsystem_disconnect_host_ctx { 1171 struct spdk_nvmf_subsystem *subsystem; 1172 char *hostnqn; 1173 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn; 1174 void *cb_arg; 1175 }; 1176 1177 static void 1178 nvmf_subsystem_disconnect_host_fini(struct spdk_io_channel_iter *i, int status) 1179 { 1180 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1181 1182 ctx = spdk_io_channel_iter_get_ctx(i); 1183 1184 if (ctx->cb_fn) { 1185 ctx->cb_fn(ctx->cb_arg, status); 1186 } 1187 free(ctx->hostnqn); 1188 free(ctx); 1189 } 1190 1191 static void 1192 nvmf_subsystem_disconnect_qpairs_by_host(struct spdk_io_channel_iter *i) 1193 { 1194 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1195 struct spdk_nvmf_poll_group *group; 1196 struct spdk_io_channel *ch; 1197 struct spdk_nvmf_qpair *qpair, *tmp_qpair; 1198 struct spdk_nvmf_ctrlr *ctrlr; 1199 1200 ctx = spdk_io_channel_iter_get_ctx(i); 1201 ch = spdk_io_channel_iter_get_channel(i); 1202 group = spdk_io_channel_get_ctx(ch); 1203 1204 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) { 1205 ctrlr = qpair->ctrlr; 1206 1207 if (ctrlr == NULL || ctrlr->subsys != ctx->subsystem) { 1208 continue; 1209 } 1210 1211 if (strncmp(ctrlr->hostnqn, ctx->hostnqn, sizeof(ctrlr->hostnqn)) == 0) { 1212 /* Right now this does not wait for the queue pairs to actually disconnect. */ 1213 spdk_nvmf_qpair_disconnect(qpair); 1214 } 1215 } 1216 spdk_for_each_channel_continue(i, 0); 1217 } 1218 1219 int 1220 spdk_nvmf_subsystem_disconnect_host(struct spdk_nvmf_subsystem *subsystem, 1221 const char *hostnqn, 1222 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1223 void *cb_arg) 1224 { 1225 struct nvmf_subsystem_disconnect_host_ctx *ctx; 1226 1227 ctx = calloc(1, sizeof(struct nvmf_subsystem_disconnect_host_ctx)); 1228 if (ctx == NULL) { 1229 return -ENOMEM; 1230 } 1231 1232 ctx->hostnqn = strdup(hostnqn); 1233 if (ctx->hostnqn == NULL) { 1234 free(ctx); 1235 return -ENOMEM; 1236 } 1237 1238 ctx->subsystem = subsystem; 1239 ctx->cb_fn = cb_fn; 1240 ctx->cb_arg = cb_arg; 1241 1242 spdk_for_each_channel(subsystem->tgt, nvmf_subsystem_disconnect_qpairs_by_host, ctx, 1243 nvmf_subsystem_disconnect_host_fini); 1244 1245 return 0; 1246 } 1247 1248 int 1249 spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem, bool allow_any_host) 1250 { 1251 pthread_mutex_lock(&subsystem->mutex); 1252 subsystem->allow_any_host = allow_any_host; 1253 if (!TAILQ_EMPTY(&subsystem->listeners)) { 1254 nvmf_update_discovery_log(subsystem->tgt, NULL); 1255 } 1256 pthread_mutex_unlock(&subsystem->mutex); 1257 1258 return 0; 1259 } 1260 1261 bool 1262 spdk_nvmf_subsystem_get_allow_any_host(const struct spdk_nvmf_subsystem *subsystem) 1263 { 1264 bool allow_any_host; 1265 struct spdk_nvmf_subsystem *sub; 1266 1267 /* Technically, taking the mutex modifies data in the subsystem. But the const 1268 * is still important to convey that this doesn't mutate any other data. Cast 1269 * it away to work around this. */ 1270 sub = (struct spdk_nvmf_subsystem *)subsystem; 1271 1272 pthread_mutex_lock(&sub->mutex); 1273 allow_any_host = sub->allow_any_host; 1274 pthread_mutex_unlock(&sub->mutex); 1275 1276 return allow_any_host; 1277 } 1278 1279 bool 1280 spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1281 { 1282 bool allowed; 1283 1284 if (!hostnqn) { 1285 return false; 1286 } 1287 1288 pthread_mutex_lock(&subsystem->mutex); 1289 1290 if (subsystem->allow_any_host) { 1291 pthread_mutex_unlock(&subsystem->mutex); 1292 return true; 1293 } 1294 1295 allowed = nvmf_subsystem_find_host(subsystem, hostnqn) != NULL; 1296 pthread_mutex_unlock(&subsystem->mutex); 1297 1298 return allowed; 1299 } 1300 1301 bool 1302 nvmf_subsystem_host_auth_required(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn) 1303 { 1304 struct spdk_nvmf_host *host; 1305 bool status; 1306 1307 pthread_mutex_lock(&subsystem->mutex); 1308 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1309 status = host != NULL && host->dhchap_key != NULL; 1310 pthread_mutex_unlock(&subsystem->mutex); 1311 1312 return status; 1313 } 1314 1315 struct spdk_key * 1316 nvmf_subsystem_get_dhchap_key(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn, 1317 enum nvmf_auth_key_type type) 1318 { 1319 struct spdk_nvmf_host *host; 1320 struct spdk_key *key = NULL; 1321 1322 pthread_mutex_lock(&subsystem->mutex); 1323 host = nvmf_subsystem_find_host(subsystem, hostnqn); 1324 if (host != NULL) { 1325 switch (type) { 1326 case NVMF_AUTH_KEY_HOST: 1327 key = host->dhchap_key; 1328 break; 1329 case NVMF_AUTH_KEY_CTRLR: 1330 key = host->dhchap_ctrlr_key; 1331 break; 1332 } 1333 if (key != NULL) { 1334 key = spdk_key_dup(key); 1335 } 1336 } 1337 pthread_mutex_unlock(&subsystem->mutex); 1338 1339 return key; 1340 } 1341 1342 struct spdk_nvmf_host * 1343 spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem) 1344 { 1345 return TAILQ_FIRST(&subsystem->hosts); 1346 } 1347 1348 1349 struct spdk_nvmf_host * 1350 spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem, 1351 struct spdk_nvmf_host *prev_host) 1352 { 1353 return TAILQ_NEXT(prev_host, link); 1354 } 1355 1356 const char * 1357 spdk_nvmf_host_get_nqn(const struct spdk_nvmf_host *host) 1358 { 1359 return host->nqn; 1360 } 1361 1362 struct spdk_nvmf_subsystem_listener * 1363 nvmf_subsystem_find_listener(struct spdk_nvmf_subsystem *subsystem, 1364 const struct spdk_nvme_transport_id *trid) 1365 { 1366 struct spdk_nvmf_subsystem_listener *listener; 1367 1368 TAILQ_FOREACH(listener, &subsystem->listeners, link) { 1369 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) { 1370 return listener; 1371 } 1372 } 1373 1374 return NULL; 1375 } 1376 1377 /** 1378 * Function to be called once the target is listening. 1379 * 1380 * \param ctx Context argument passed to this function. 1381 * \param status 0 if it completed successfully, or negative errno if it failed. 1382 */ 1383 static void 1384 _nvmf_subsystem_add_listener_done(void *ctx, int status) 1385 { 1386 struct spdk_nvmf_subsystem_listener *listener = ctx; 1387 1388 if (status) { 1389 listener->cb_fn(listener->cb_arg, status); 1390 free(listener); 1391 return; 1392 } 1393 1394 TAILQ_INSERT_HEAD(&listener->subsystem->listeners, listener, link); 1395 1396 if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) { 1397 status = nvmf_tgt_update_mdns_prr(listener->subsystem->tgt); 1398 if (status) { 1399 TAILQ_REMOVE(&listener->subsystem->listeners, listener, link); 1400 listener->cb_fn(listener->cb_arg, status); 1401 free(listener); 1402 return; 1403 } 1404 } 1405 1406 nvmf_update_discovery_log(listener->subsystem->tgt, NULL); 1407 listener->cb_fn(listener->cb_arg, status); 1408 } 1409 1410 void 1411 spdk_nvmf_subsystem_listener_opts_init(struct spdk_nvmf_listener_opts *opts, size_t size) 1412 { 1413 if (opts == NULL) { 1414 SPDK_ERRLOG("opts should not be NULL\n"); 1415 assert(false); 1416 return; 1417 } 1418 if (size == 0) { 1419 SPDK_ERRLOG("size should not be zero\n"); 1420 assert(false); 1421 return; 1422 } 1423 1424 memset(opts, 0, size); 1425 opts->opts_size = size; 1426 1427 #define FIELD_OK(field) \ 1428 offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(opts->field) <= size 1429 1430 #define SET_FIELD(field, value) \ 1431 if (FIELD_OK(field)) { \ 1432 opts->field = value; \ 1433 } \ 1434 1435 SET_FIELD(secure_channel, false); 1436 SET_FIELD(ana_state, SPDK_NVME_ANA_OPTIMIZED_STATE); 1437 SET_FIELD(sock_impl, NULL); 1438 1439 #undef FIELD_OK 1440 #undef SET_FIELD 1441 } 1442 1443 static int 1444 listener_opts_copy(struct spdk_nvmf_listener_opts *src, struct spdk_nvmf_listener_opts *dst) 1445 { 1446 if (src->opts_size == 0) { 1447 SPDK_ERRLOG("source structure size should not be zero\n"); 1448 assert(false); 1449 return -EINVAL; 1450 } 1451 1452 memset(dst, 0, sizeof(*dst)); 1453 dst->opts_size = src->opts_size; 1454 1455 #define FIELD_OK(field) \ 1456 offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(src->field) <= src->opts_size 1457 1458 #define SET_FIELD(field) \ 1459 if (FIELD_OK(field)) { \ 1460 dst->field = src->field; \ 1461 } \ 1462 1463 SET_FIELD(secure_channel); 1464 SET_FIELD(ana_state); 1465 SET_FIELD(sock_impl); 1466 /* We should not remove this statement, but need to update the assert statement 1467 * if we add a new field, and also add a corresponding SET_FIELD statement. */ 1468 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_listener_opts) == 24, "Incorrect size"); 1469 1470 #undef SET_FIELD 1471 #undef FIELD_OK 1472 1473 return 0; 1474 } 1475 1476 static void 1477 _nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem, 1478 struct spdk_nvme_transport_id *trid, 1479 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1480 void *cb_arg, struct spdk_nvmf_listener_opts *opts) 1481 { 1482 struct spdk_nvmf_transport *transport; 1483 struct spdk_nvmf_subsystem_listener *listener; 1484 struct spdk_nvmf_listener *tr_listener; 1485 uint32_t i; 1486 uint32_t id; 1487 int rc = 0; 1488 1489 assert(cb_fn != NULL); 1490 1491 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1492 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1493 cb_fn(cb_arg, -EAGAIN); 1494 return; 1495 } 1496 1497 if (nvmf_subsystem_find_listener(subsystem, trid)) { 1498 /* Listener already exists in this subsystem */ 1499 cb_fn(cb_arg, 0); 1500 return; 1501 } 1502 1503 transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, trid->trstring); 1504 if (!transport) { 1505 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 1506 trid->trstring); 1507 cb_fn(cb_arg, -EINVAL); 1508 return; 1509 } 1510 1511 tr_listener = nvmf_transport_find_listener(transport, trid); 1512 if (!tr_listener) { 1513 SPDK_ERRLOG("Cannot find transport listener for %s\n", trid->traddr); 1514 cb_fn(cb_arg, -EINVAL); 1515 return; 1516 } 1517 1518 listener = calloc(1, sizeof(*listener)); 1519 if (!listener) { 1520 cb_fn(cb_arg, -ENOMEM); 1521 return; 1522 } 1523 1524 listener->trid = &tr_listener->trid; 1525 listener->transport = transport; 1526 listener->cb_fn = cb_fn; 1527 listener->cb_arg = cb_arg; 1528 listener->subsystem = subsystem; 1529 listener->ana_state = calloc(subsystem->max_nsid, sizeof(enum spdk_nvme_ana_state)); 1530 if (!listener->ana_state) { 1531 free(listener); 1532 cb_fn(cb_arg, -ENOMEM); 1533 return; 1534 } 1535 1536 spdk_nvmf_subsystem_listener_opts_init(&listener->opts, sizeof(listener->opts)); 1537 if (opts != NULL) { 1538 rc = listener_opts_copy(opts, &listener->opts); 1539 if (rc) { 1540 SPDK_ERRLOG("Unable to copy listener options\n"); 1541 free(listener->ana_state); 1542 free(listener); 1543 cb_fn(cb_arg, -EINVAL); 1544 return; 1545 } 1546 } 1547 1548 id = spdk_bit_array_find_first_clear(subsystem->used_listener_ids, 0); 1549 if (id == UINT32_MAX) { 1550 SPDK_ERRLOG("Cannot add any more listeners\n"); 1551 free(listener->ana_state); 1552 free(listener->opts.sock_impl); 1553 free(listener); 1554 cb_fn(cb_arg, -EINVAL); 1555 return; 1556 } 1557 1558 spdk_bit_array_set(subsystem->used_listener_ids, id); 1559 listener->id = id; 1560 1561 for (i = 0; i < subsystem->max_nsid; i++) { 1562 listener->ana_state[i] = listener->opts.ana_state; 1563 } 1564 1565 if (transport->ops->listen_associate != NULL) { 1566 rc = transport->ops->listen_associate(transport, subsystem, trid); 1567 } 1568 1569 SPDK_DTRACE_PROBE4(nvmf_subsystem_add_listener, subsystem->subnqn, listener->trid->trtype, 1570 listener->trid->traddr, listener->trid->trsvcid); 1571 1572 _nvmf_subsystem_add_listener_done(listener, rc); 1573 } 1574 1575 void 1576 spdk_nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem, 1577 struct spdk_nvme_transport_id *trid, 1578 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1579 void *cb_arg) 1580 { 1581 _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, NULL); 1582 } 1583 1584 void 1585 spdk_nvmf_subsystem_add_listener_ext(struct spdk_nvmf_subsystem *subsystem, 1586 struct spdk_nvme_transport_id *trid, 1587 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, 1588 void *cb_arg, struct spdk_nvmf_listener_opts *opts) 1589 { 1590 _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, opts); 1591 } 1592 1593 int 1594 spdk_nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem, 1595 const struct spdk_nvme_transport_id *trid) 1596 { 1597 struct spdk_nvmf_subsystem_listener *listener; 1598 1599 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1600 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1601 return -EAGAIN; 1602 } 1603 1604 listener = nvmf_subsystem_find_listener(subsystem, trid); 1605 if (listener == NULL) { 1606 return -ENOENT; 1607 } 1608 1609 SPDK_DTRACE_PROBE4(nvmf_subsystem_remove_listener, subsystem->subnqn, listener->trid->trtype, 1610 listener->trid->traddr, listener->trid->trsvcid); 1611 1612 _nvmf_subsystem_remove_listener(subsystem, listener, false); 1613 1614 return 0; 1615 } 1616 1617 void 1618 nvmf_subsystem_remove_all_listeners(struct spdk_nvmf_subsystem *subsystem, 1619 bool stop) 1620 { 1621 struct spdk_nvmf_subsystem_listener *listener, *listener_tmp; 1622 1623 TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) { 1624 _nvmf_subsystem_remove_listener(subsystem, listener, stop); 1625 } 1626 } 1627 1628 bool 1629 spdk_nvmf_subsystem_listener_allowed(struct spdk_nvmf_subsystem *subsystem, 1630 const struct spdk_nvme_transport_id *trid) 1631 { 1632 struct spdk_nvmf_subsystem_listener *listener; 1633 1634 TAILQ_FOREACH(listener, &subsystem->listeners, link) { 1635 if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) { 1636 return true; 1637 } 1638 } 1639 1640 if (!strcmp(subsystem->subnqn, SPDK_NVMF_DISCOVERY_NQN)) { 1641 SPDK_WARNLOG("Allowing connection to discovery subsystem on %s/%s/%s, " 1642 "even though this listener was not added to the discovery " 1643 "subsystem. This behavior is deprecated and will be removed " 1644 "in a future release.\n", 1645 spdk_nvme_transport_id_trtype_str(trid->trtype), trid->traddr, trid->trsvcid); 1646 return true; 1647 } 1648 1649 return false; 1650 } 1651 1652 struct spdk_nvmf_subsystem_listener * 1653 spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem) 1654 { 1655 return TAILQ_FIRST(&subsystem->listeners); 1656 } 1657 1658 struct spdk_nvmf_subsystem_listener * 1659 spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem, 1660 struct spdk_nvmf_subsystem_listener *prev_listener) 1661 { 1662 return TAILQ_NEXT(prev_listener, link); 1663 } 1664 1665 const struct spdk_nvme_transport_id * 1666 spdk_nvmf_subsystem_listener_get_trid(struct spdk_nvmf_subsystem_listener *listener) 1667 { 1668 return listener->trid; 1669 } 1670 1671 void 1672 spdk_nvmf_subsystem_allow_any_listener(struct spdk_nvmf_subsystem *subsystem, 1673 bool allow_any_listener) 1674 { 1675 subsystem->flags.allow_any_listener = allow_any_listener; 1676 } 1677 1678 bool 1679 spdk_nvmf_subsystem_any_listener_allowed(struct spdk_nvmf_subsystem *subsystem) 1680 { 1681 return subsystem->flags.allow_any_listener; 1682 } 1683 1684 struct subsystem_update_ns_ctx { 1685 struct spdk_nvmf_subsystem *subsystem; 1686 1687 spdk_nvmf_subsystem_state_change_done cb_fn; 1688 void *cb_arg; 1689 }; 1690 1691 static void 1692 subsystem_update_ns_done(struct spdk_io_channel_iter *i, int status) 1693 { 1694 struct subsystem_update_ns_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1695 1696 if (ctx->cb_fn) { 1697 ctx->cb_fn(ctx->subsystem, ctx->cb_arg, status); 1698 } 1699 free(ctx); 1700 } 1701 1702 static void 1703 subsystem_update_ns_on_pg(struct spdk_io_channel_iter *i) 1704 { 1705 int rc; 1706 struct subsystem_update_ns_ctx *ctx; 1707 struct spdk_nvmf_poll_group *group; 1708 struct spdk_nvmf_subsystem *subsystem; 1709 1710 ctx = spdk_io_channel_iter_get_ctx(i); 1711 group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i)); 1712 subsystem = ctx->subsystem; 1713 1714 rc = nvmf_poll_group_update_subsystem(group, subsystem); 1715 spdk_for_each_channel_continue(i, rc); 1716 } 1717 1718 static int 1719 nvmf_subsystem_update_ns(struct spdk_nvmf_subsystem *subsystem, 1720 spdk_nvmf_subsystem_state_change_done cb_fn, void *cb_arg) 1721 { 1722 struct subsystem_update_ns_ctx *ctx; 1723 1724 ctx = calloc(1, sizeof(*ctx)); 1725 if (ctx == NULL) { 1726 SPDK_ERRLOG("Can't alloc subsystem poll group update context\n"); 1727 return -ENOMEM; 1728 } 1729 ctx->subsystem = subsystem; 1730 ctx->cb_fn = cb_fn; 1731 ctx->cb_arg = cb_arg; 1732 1733 spdk_for_each_channel(subsystem->tgt, 1734 subsystem_update_ns_on_pg, 1735 ctx, 1736 subsystem_update_ns_done); 1737 return 0; 1738 } 1739 1740 static void 1741 nvmf_subsystem_ns_changed(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 1742 { 1743 struct spdk_nvmf_ctrlr *ctrlr; 1744 1745 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 1746 if (nvmf_ctrlr_ns_is_visible(ctrlr, nsid)) { 1747 nvmf_ctrlr_ns_changed(ctrlr, nsid); 1748 } 1749 } 1750 } 1751 1752 static uint32_t nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns); 1753 1754 int 1755 spdk_nvmf_subsystem_remove_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 1756 { 1757 struct spdk_nvmf_transport *transport; 1758 struct spdk_nvmf_ns *ns; 1759 struct spdk_nvmf_host *host, *tmp; 1760 struct spdk_nvmf_ctrlr *ctrlr; 1761 1762 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 1763 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 1764 assert(false); 1765 return -1; 1766 } 1767 1768 if (nsid == 0 || nsid > subsystem->max_nsid) { 1769 return -1; 1770 } 1771 1772 ns = subsystem->ns[nsid - 1]; 1773 if (!ns) { 1774 return -1; 1775 } 1776 1777 subsystem->ns[nsid - 1] = NULL; 1778 1779 assert(ns->anagrpid - 1 < subsystem->max_nsid); 1780 assert(subsystem->ana_group[ns->anagrpid - 1] > 0); 1781 1782 subsystem->ana_group[ns->anagrpid - 1]--; 1783 1784 TAILQ_FOREACH_SAFE(host, &ns->hosts, link, tmp) { 1785 nvmf_ns_remove_host(ns, host); 1786 } 1787 1788 free(ns->ptpl_file); 1789 nvmf_ns_reservation_clear_all_registrants(ns); 1790 spdk_bdev_module_release_bdev(ns->bdev); 1791 spdk_bdev_close(ns->desc); 1792 free(ns); 1793 1794 if (subsystem->fdp_supported && !spdk_nvmf_subsystem_get_first_ns(subsystem)) { 1795 subsystem->fdp_supported = false; 1796 SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u doesn't have FDP capability.\n", 1797 subsystem->id); 1798 } 1799 1800 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 1801 transport = spdk_nvmf_transport_get_next(transport)) { 1802 if (transport->ops->subsystem_remove_ns) { 1803 transport->ops->subsystem_remove_ns(transport, subsystem, nsid); 1804 } 1805 } 1806 1807 nvmf_subsystem_ns_changed(subsystem, nsid); 1808 1809 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 1810 spdk_bit_array_clear(ctrlr->visible_ns, nsid - 1); 1811 } 1812 1813 return 0; 1814 } 1815 1816 struct subsystem_ns_change_ctx { 1817 struct spdk_nvmf_subsystem *subsystem; 1818 spdk_nvmf_subsystem_state_change_done cb_fn; 1819 uint32_t nsid; 1820 }; 1821 1822 static void 1823 _nvmf_ns_hot_remove(struct spdk_nvmf_subsystem *subsystem, 1824 void *cb_arg, int status) 1825 { 1826 struct subsystem_ns_change_ctx *ctx = cb_arg; 1827 int rc; 1828 1829 rc = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid); 1830 if (rc != 0) { 1831 SPDK_ERRLOG("Failed to make changes to NVME-oF subsystem with id: %u\n", subsystem->id); 1832 } 1833 1834 rc = spdk_nvmf_subsystem_resume(subsystem, NULL, NULL); 1835 if (rc != 0) { 1836 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id); 1837 } 1838 1839 free(ctx); 1840 } 1841 1842 static void 1843 nvmf_ns_change_msg(void *ns_ctx) 1844 { 1845 struct subsystem_ns_change_ctx *ctx = ns_ctx; 1846 int rc; 1847 1848 SPDK_DTRACE_PROBE2(nvmf_ns_change, ctx->nsid, ctx->subsystem->subnqn); 1849 1850 rc = spdk_nvmf_subsystem_pause(ctx->subsystem, ctx->nsid, ctx->cb_fn, ctx); 1851 if (rc) { 1852 if (rc == -EBUSY) { 1853 /* Try again, this is not a permanent situation. */ 1854 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ctx); 1855 } else { 1856 free(ctx); 1857 SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n"); 1858 } 1859 } 1860 } 1861 1862 static void 1863 nvmf_ns_hot_remove(void *remove_ctx) 1864 { 1865 struct spdk_nvmf_ns *ns = remove_ctx; 1866 struct subsystem_ns_change_ctx *ns_ctx; 1867 int rc; 1868 1869 /* We have to allocate a new context because this op 1870 * is asynchronous and we could lose the ns in the middle. 1871 */ 1872 ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx)); 1873 if (!ns_ctx) { 1874 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n"); 1875 return; 1876 } 1877 1878 ns_ctx->subsystem = ns->subsystem; 1879 ns_ctx->nsid = ns->opts.nsid; 1880 ns_ctx->cb_fn = _nvmf_ns_hot_remove; 1881 1882 rc = spdk_nvmf_subsystem_pause(ns->subsystem, ns_ctx->nsid, _nvmf_ns_hot_remove, ns_ctx); 1883 if (rc) { 1884 if (rc == -EBUSY) { 1885 /* Try again, this is not a permanent situation. */ 1886 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx); 1887 } else { 1888 SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n"); 1889 free(ns_ctx); 1890 } 1891 } 1892 } 1893 1894 static void 1895 _nvmf_ns_resize(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status) 1896 { 1897 struct subsystem_ns_change_ctx *ctx = cb_arg; 1898 1899 nvmf_subsystem_ns_changed(subsystem, ctx->nsid); 1900 if (spdk_nvmf_subsystem_resume(subsystem, NULL, NULL) != 0) { 1901 SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id); 1902 } 1903 1904 free(ctx); 1905 } 1906 1907 static void 1908 nvmf_ns_resize(void *event_ctx) 1909 { 1910 struct spdk_nvmf_ns *ns = event_ctx; 1911 struct subsystem_ns_change_ctx *ns_ctx; 1912 int rc; 1913 1914 /* We have to allocate a new context because this op 1915 * is asynchronous and we could lose the ns in the middle. 1916 */ 1917 ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx)); 1918 if (!ns_ctx) { 1919 SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n"); 1920 return; 1921 } 1922 1923 ns_ctx->subsystem = ns->subsystem; 1924 ns_ctx->nsid = ns->opts.nsid; 1925 ns_ctx->cb_fn = _nvmf_ns_resize; 1926 1927 /* Specify 0 for the nsid here, because we do not need to pause the namespace. 1928 * Namespaces can only be resized bigger, so there is no need to quiesce I/O. 1929 */ 1930 rc = spdk_nvmf_subsystem_pause(ns->subsystem, 0, _nvmf_ns_resize, ns_ctx); 1931 if (rc) { 1932 if (rc == -EBUSY) { 1933 /* Try again, this is not a permanent situation. */ 1934 spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx); 1935 } else { 1936 SPDK_ERRLOG("Unable to pause subsystem to process namespace resize!\n"); 1937 free(ns_ctx); 1938 } 1939 } 1940 } 1941 1942 static void 1943 nvmf_ns_event(enum spdk_bdev_event_type type, 1944 struct spdk_bdev *bdev, 1945 void *event_ctx) 1946 { 1947 SPDK_DEBUGLOG(nvmf, "Bdev event: type %d, name %s, subsystem_id %d, ns_id %d\n", 1948 type, 1949 spdk_bdev_get_name(bdev), 1950 ((struct spdk_nvmf_ns *)event_ctx)->subsystem->id, 1951 ((struct spdk_nvmf_ns *)event_ctx)->nsid); 1952 1953 switch (type) { 1954 case SPDK_BDEV_EVENT_REMOVE: 1955 nvmf_ns_hot_remove(event_ctx); 1956 break; 1957 case SPDK_BDEV_EVENT_RESIZE: 1958 nvmf_ns_resize(event_ctx); 1959 break; 1960 default: 1961 SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type); 1962 break; 1963 } 1964 } 1965 1966 void 1967 spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size) 1968 { 1969 if (!opts) { 1970 SPDK_ERRLOG("opts should not be NULL.\n"); 1971 return; 1972 } 1973 1974 if (!opts_size) { 1975 SPDK_ERRLOG("opts_size should not be zero.\n"); 1976 return; 1977 } 1978 1979 memset(opts, 0, opts_size); 1980 opts->opts_size = opts_size; 1981 1982 #define FIELD_OK(field) \ 1983 offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= opts_size 1984 1985 #define SET_FIELD(field, value) \ 1986 if (FIELD_OK(field)) { \ 1987 opts->field = value; \ 1988 } \ 1989 1990 /* All current fields are set to 0 by default. */ 1991 SET_FIELD(nsid, 0); 1992 if (FIELD_OK(nguid)) { 1993 memset(opts->nguid, 0, sizeof(opts->nguid)); 1994 } 1995 if (FIELD_OK(eui64)) { 1996 memset(opts->eui64, 0, sizeof(opts->eui64)); 1997 } 1998 if (FIELD_OK(uuid)) { 1999 spdk_uuid_set_null(&opts->uuid); 2000 } 2001 SET_FIELD(anagrpid, 0); 2002 SET_FIELD(transport_specific, NULL); 2003 2004 #undef FIELD_OK 2005 #undef SET_FIELD 2006 } 2007 2008 static void 2009 nvmf_ns_opts_copy(struct spdk_nvmf_ns_opts *opts, 2010 const struct spdk_nvmf_ns_opts *user_opts, 2011 size_t opts_size) 2012 { 2013 #define FIELD_OK(field) \ 2014 offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= user_opts->opts_size 2015 2016 #define SET_FIELD(field) \ 2017 if (FIELD_OK(field)) { \ 2018 opts->field = user_opts->field; \ 2019 } \ 2020 2021 SET_FIELD(nsid); 2022 if (FIELD_OK(nguid)) { 2023 memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid)); 2024 } 2025 if (FIELD_OK(eui64)) { 2026 memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64)); 2027 } 2028 if (FIELD_OK(uuid)) { 2029 spdk_uuid_copy(&opts->uuid, &user_opts->uuid); 2030 } 2031 SET_FIELD(anagrpid); 2032 SET_FIELD(no_auto_visible); 2033 SET_FIELD(transport_specific); 2034 2035 opts->opts_size = user_opts->opts_size; 2036 2037 /* We should not remove this statement, but need to update the assert statement 2038 * if we add a new field, and also add a corresponding SET_FIELD statement. 2039 */ 2040 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ns_opts) == 72, "Incorrect size"); 2041 2042 #undef FIELD_OK 2043 #undef SET_FIELD 2044 } 2045 2046 /* Dummy bdev module used to to claim bdevs. */ 2047 static struct spdk_bdev_module ns_bdev_module = { 2048 .name = "NVMe-oF Target", 2049 }; 2050 2051 static int nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns, 2052 const struct spdk_nvmf_reservation_info *info); 2053 static int nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, 2054 struct spdk_nvmf_reservation_info *info); 2055 static int nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, 2056 struct spdk_nvmf_reservation_info *info); 2057 2058 bool 2059 nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem) 2060 { 2061 struct spdk_nvmf_ns *ns; 2062 2063 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 2064 ns != NULL; 2065 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 2066 if (spdk_bdev_is_zoned(ns->bdev) && 2067 spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZONE_APPEND)) { 2068 return true; 2069 } 2070 } 2071 2072 return false; 2073 } 2074 2075 uint32_t 2076 spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem, const char *bdev_name, 2077 const struct spdk_nvmf_ns_opts *user_opts, size_t opts_size, 2078 const char *ptpl_file) 2079 { 2080 struct spdk_nvmf_transport *transport; 2081 struct spdk_nvmf_ns_opts opts; 2082 struct spdk_nvmf_ns *ns, *first_ns; 2083 struct spdk_nvmf_ctrlr *ctrlr; 2084 struct spdk_nvmf_reservation_info info = {0}; 2085 struct spdk_nvme_ns *nvme_ns; 2086 int rc; 2087 bool zone_append_supported; 2088 uint64_t max_zone_append_size_kib; 2089 2090 if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 2091 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) { 2092 return 0; 2093 } 2094 2095 spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts)); 2096 if (user_opts) { 2097 nvmf_ns_opts_copy(&opts, user_opts, opts_size); 2098 } 2099 2100 if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) { 2101 SPDK_ERRLOG("Invalid NSID %" PRIu32 "\n", opts.nsid); 2102 return 0; 2103 } 2104 2105 if (opts.nsid == 0) { 2106 /* 2107 * NSID not specified - find a free index. 2108 * 2109 * If no free slots are found, return error. 2110 */ 2111 for (opts.nsid = 1; opts.nsid <= subsystem->max_nsid; opts.nsid++) { 2112 if (_nvmf_subsystem_get_ns(subsystem, opts.nsid) == NULL) { 2113 break; 2114 } 2115 } 2116 if (opts.nsid > subsystem->max_nsid) { 2117 SPDK_ERRLOG("No free namespace slot available in the subsystem\n"); 2118 return 0; 2119 } 2120 } 2121 2122 if (opts.nsid > subsystem->max_nsid) { 2123 SPDK_ERRLOG("NSID greater than maximum not allowed\n"); 2124 return 0; 2125 } 2126 2127 if (_nvmf_subsystem_get_ns(subsystem, opts.nsid)) { 2128 SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", opts.nsid); 2129 return 0; 2130 } 2131 2132 if (opts.anagrpid == 0) { 2133 opts.anagrpid = opts.nsid; 2134 } 2135 2136 if (opts.anagrpid > subsystem->max_nsid) { 2137 SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n"); 2138 return 0; 2139 } 2140 2141 ns = calloc(1, sizeof(*ns)); 2142 if (ns == NULL) { 2143 SPDK_ERRLOG("Namespace allocation failed\n"); 2144 return 0; 2145 } 2146 2147 TAILQ_INIT(&ns->hosts); 2148 ns->always_visible = !opts.no_auto_visible; 2149 if (ns->always_visible) { 2150 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2151 spdk_bit_array_set(ctrlr->visible_ns, opts.nsid - 1); 2152 } 2153 } 2154 2155 rc = spdk_bdev_open_ext(bdev_name, true, nvmf_ns_event, ns, &ns->desc); 2156 if (rc != 0) { 2157 SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n", 2158 subsystem->subnqn, bdev_name, rc); 2159 free(ns); 2160 return 0; 2161 } 2162 2163 ns->bdev = spdk_bdev_desc_get_bdev(ns->desc); 2164 2165 if (spdk_bdev_get_md_size(ns->bdev) != 0) { 2166 if (!spdk_bdev_is_md_interleaved(ns->bdev)) { 2167 SPDK_ERRLOG("Can't attach bdev with separate metadata.\n"); 2168 spdk_bdev_close(ns->desc); 2169 free(ns); 2170 return 0; 2171 } 2172 2173 if (spdk_bdev_get_md_size(ns->bdev) > SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE) { 2174 SPDK_ERRLOG("Maximum supported interleaved md size %u, current md size %u\n", 2175 SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE, spdk_bdev_get_md_size(ns->bdev)); 2176 spdk_bdev_close(ns->desc); 2177 free(ns); 2178 return 0; 2179 } 2180 } 2181 2182 rc = spdk_bdev_module_claim_bdev(ns->bdev, ns->desc, &ns_bdev_module); 2183 if (rc != 0) { 2184 spdk_bdev_close(ns->desc); 2185 free(ns); 2186 return 0; 2187 } 2188 2189 if (!strncmp(spdk_bdev_get_module_name(ns->bdev), "nvme", 2190 strlen(spdk_bdev_get_module_name(ns->bdev)))) { 2191 nvme_ns = (struct spdk_nvme_ns *) spdk_bdev_get_module_ctx(ns->desc); 2192 ns->passthrough_nsid = spdk_nvme_ns_get_id(nvme_ns); 2193 } else if (subsystem->passthrough) { 2194 SPDK_ERRLOG("Only bdev_nvme namespaces can be added to a passthrough subsystem.\n"); 2195 goto err; 2196 } 2197 2198 /* Cache the zcopy capability of the bdev device */ 2199 ns->zcopy = spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZCOPY); 2200 2201 if (spdk_uuid_is_null(&opts.uuid)) { 2202 opts.uuid = *spdk_bdev_get_uuid(ns->bdev); 2203 } 2204 2205 /* if nguid descriptor is supported by bdev module (nvme) then uuid = nguid */ 2206 if (spdk_mem_all_zero(opts.nguid, sizeof(opts.nguid))) { 2207 SPDK_STATIC_ASSERT(sizeof(opts.nguid) == sizeof(opts.uuid), "size mismatch"); 2208 memcpy(opts.nguid, spdk_bdev_get_uuid(ns->bdev), sizeof(opts.nguid)); 2209 } 2210 2211 if (spdk_bdev_is_zoned(ns->bdev)) { 2212 SPDK_DEBUGLOG(nvmf, "The added namespace is backed by a zoned block device.\n"); 2213 ns->csi = SPDK_NVME_CSI_ZNS; 2214 2215 zone_append_supported = spdk_bdev_io_type_supported(ns->bdev, 2216 SPDK_BDEV_IO_TYPE_ZONE_APPEND); 2217 max_zone_append_size_kib = spdk_bdev_get_max_zone_append_size( 2218 ns->bdev) * spdk_bdev_get_block_size(ns->bdev); 2219 2220 if (_nvmf_subsystem_get_first_zoned_ns(subsystem) != NULL && 2221 (nvmf_subsystem_zone_append_supported(subsystem) != zone_append_supported || 2222 subsystem->max_zone_append_size_kib != max_zone_append_size_kib)) { 2223 SPDK_ERRLOG("Namespaces with different zone append support or different zone append size are not allowed.\n"); 2224 goto err; 2225 } 2226 2227 subsystem->max_zone_append_size_kib = max_zone_append_size_kib; 2228 } 2229 2230 first_ns = spdk_nvmf_subsystem_get_first_ns(subsystem); 2231 if (!first_ns) { 2232 if (spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) { 2233 SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u has FDP capability.\n", 2234 subsystem->id); 2235 subsystem->fdp_supported = true; 2236 } 2237 } else { 2238 if (spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps != 2239 spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) { 2240 SPDK_ERRLOG("Subsystem with id: %u can%s FDP namespace.\n", subsystem->id, 2241 spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps ? " only add" : "not add"); 2242 goto err; 2243 } 2244 } 2245 2246 ns->opts = opts; 2247 ns->subsystem = subsystem; 2248 subsystem->ns[opts.nsid - 1] = ns; 2249 ns->nsid = opts.nsid; 2250 ns->anagrpid = opts.anagrpid; 2251 subsystem->ana_group[ns->anagrpid - 1]++; 2252 TAILQ_INIT(&ns->registrants); 2253 if (ptpl_file) { 2254 ns->ptpl_file = strdup(ptpl_file); 2255 if (!ns->ptpl_file) { 2256 SPDK_ERRLOG("Namespace ns->ptpl_file allocation failed\n"); 2257 goto err; 2258 } 2259 } 2260 2261 if (nvmf_ns_is_ptpl_capable(ns)) { 2262 rc = nvmf_ns_reservation_load(ns, &info); 2263 if (rc) { 2264 SPDK_ERRLOG("Subsystem load reservation failed\n"); 2265 goto err; 2266 } 2267 2268 rc = nvmf_ns_reservation_restore(ns, &info); 2269 if (rc) { 2270 SPDK_ERRLOG("Subsystem restore reservation failed\n"); 2271 goto err; 2272 } 2273 } 2274 2275 for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport; 2276 transport = spdk_nvmf_transport_get_next(transport)) { 2277 if (transport->ops->subsystem_add_ns) { 2278 rc = transport->ops->subsystem_add_ns(transport, subsystem, ns); 2279 if (rc) { 2280 SPDK_ERRLOG("Namespace attachment is not allowed by %s transport\n", transport->ops->name); 2281 nvmf_ns_reservation_clear_all_registrants(ns); 2282 goto err; 2283 } 2284 } 2285 } 2286 2287 /* JSON value obj is freed before sending the response. Set NULL to prevent usage of dangling pointer. */ 2288 ns->opts.transport_specific = NULL; 2289 2290 SPDK_DEBUGLOG(nvmf, "Subsystem %s: bdev %s assigned nsid %" PRIu32 "\n", 2291 spdk_nvmf_subsystem_get_nqn(subsystem), 2292 bdev_name, 2293 opts.nsid); 2294 2295 nvmf_subsystem_ns_changed(subsystem, opts.nsid); 2296 2297 SPDK_DTRACE_PROBE2(nvmf_subsystem_add_ns, subsystem->subnqn, ns->nsid); 2298 2299 return opts.nsid; 2300 err: 2301 subsystem->ns[opts.nsid - 1] = NULL; 2302 spdk_bdev_module_release_bdev(ns->bdev); 2303 spdk_bdev_close(ns->desc); 2304 free(ns->ptpl_file); 2305 free(ns); 2306 2307 return 0; 2308 } 2309 2310 int 2311 spdk_nvmf_subsystem_set_ns_ana_group(struct spdk_nvmf_subsystem *subsystem, 2312 uint32_t nsid, uint32_t anagrpid) 2313 { 2314 struct spdk_nvmf_ns *ns; 2315 2316 if (anagrpid > subsystem->max_nsid) { 2317 SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n"); 2318 return -1; 2319 } 2320 2321 if (anagrpid == 0) { 2322 SPDK_ERRLOG("Zero is not allowed to ANAGRPID\n"); 2323 return -1; 2324 } 2325 2326 if (nsid == 0 || nsid > subsystem->max_nsid) { 2327 return -1; 2328 } 2329 2330 ns = subsystem->ns[nsid - 1]; 2331 if (!ns) { 2332 return -1; 2333 } 2334 2335 assert(ns->anagrpid - 1 < subsystem->max_nsid); 2336 2337 assert(subsystem->ana_group[ns->anagrpid - 1] > 0); 2338 2339 subsystem->ana_group[ns->anagrpid - 1]--; 2340 2341 subsystem->ana_group[anagrpid - 1]++; 2342 2343 ns->anagrpid = anagrpid; 2344 ns->opts.anagrpid = anagrpid; 2345 2346 nvmf_subsystem_ns_changed(subsystem, nsid); 2347 2348 return 0; 2349 } 2350 2351 static uint32_t 2352 nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem, 2353 uint32_t prev_nsid) 2354 { 2355 uint32_t nsid; 2356 2357 if (prev_nsid >= subsystem->max_nsid) { 2358 return 0; 2359 } 2360 2361 for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) { 2362 if (subsystem->ns[nsid - 1]) { 2363 return nsid; 2364 } 2365 } 2366 2367 return 0; 2368 } 2369 2370 struct spdk_nvmf_ns * 2371 spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem) 2372 { 2373 uint32_t first_nsid; 2374 2375 first_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, 0); 2376 return _nvmf_subsystem_get_ns(subsystem, first_nsid); 2377 } 2378 2379 struct spdk_nvmf_ns * 2380 spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem, 2381 struct spdk_nvmf_ns *prev_ns) 2382 { 2383 uint32_t next_nsid; 2384 2385 next_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->opts.nsid); 2386 return _nvmf_subsystem_get_ns(subsystem, next_nsid); 2387 } 2388 2389 struct spdk_nvmf_ns * 2390 spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 2391 { 2392 return _nvmf_subsystem_get_ns(subsystem, nsid); 2393 } 2394 2395 uint32_t 2396 spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns) 2397 { 2398 return ns->opts.nsid; 2399 } 2400 2401 struct spdk_bdev * 2402 spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns) 2403 { 2404 return ns->bdev; 2405 } 2406 2407 void 2408 spdk_nvmf_ns_get_opts(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_ns_opts *opts, 2409 size_t opts_size) 2410 { 2411 memset(opts, 0, opts_size); 2412 memcpy(opts, &ns->opts, spdk_min(sizeof(ns->opts), opts_size)); 2413 } 2414 2415 const char * 2416 spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem) 2417 { 2418 return subsystem->sn; 2419 } 2420 2421 int 2422 spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn) 2423 { 2424 size_t len, max_len; 2425 2426 max_len = sizeof(subsystem->sn) - 1; 2427 len = strlen(sn); 2428 if (len > max_len) { 2429 SPDK_DEBUGLOG(nvmf, "Invalid sn \"%s\": length %zu > max %zu\n", 2430 sn, len, max_len); 2431 return -1; 2432 } 2433 2434 if (!nvmf_valid_ascii_string(sn, len)) { 2435 SPDK_DEBUGLOG(nvmf, "Non-ASCII sn\n"); 2436 SPDK_LOGDUMP(nvmf, "sn", sn, len); 2437 return -1; 2438 } 2439 2440 snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn); 2441 2442 return 0; 2443 } 2444 2445 const char * 2446 spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem) 2447 { 2448 return subsystem->mn; 2449 } 2450 2451 int 2452 spdk_nvmf_subsystem_set_mn(struct spdk_nvmf_subsystem *subsystem, const char *mn) 2453 { 2454 size_t len, max_len; 2455 2456 if (mn == NULL) { 2457 mn = MODEL_NUMBER_DEFAULT; 2458 } 2459 max_len = sizeof(subsystem->mn) - 1; 2460 len = strlen(mn); 2461 if (len > max_len) { 2462 SPDK_DEBUGLOG(nvmf, "Invalid mn \"%s\": length %zu > max %zu\n", 2463 mn, len, max_len); 2464 return -1; 2465 } 2466 2467 if (!nvmf_valid_ascii_string(mn, len)) { 2468 SPDK_DEBUGLOG(nvmf, "Non-ASCII mn\n"); 2469 SPDK_LOGDUMP(nvmf, "mn", mn, len); 2470 return -1; 2471 } 2472 2473 snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", mn); 2474 2475 return 0; 2476 } 2477 2478 const char * 2479 spdk_nvmf_subsystem_get_nqn(const struct spdk_nvmf_subsystem *subsystem) 2480 { 2481 return subsystem->subnqn; 2482 } 2483 2484 /* We have to use the typedef in the function declaration to appease astyle. */ 2485 typedef enum spdk_nvmf_subtype spdk_nvmf_subtype_t; 2486 2487 spdk_nvmf_subtype_t 2488 spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem) 2489 { 2490 return subsystem->subtype; 2491 } 2492 2493 uint32_t 2494 spdk_nvmf_subsystem_get_max_nsid(struct spdk_nvmf_subsystem *subsystem) 2495 { 2496 return subsystem->max_nsid; 2497 } 2498 2499 int 2500 spdk_nvmf_subsystem_set_cntlid_range(struct spdk_nvmf_subsystem *subsystem, 2501 uint16_t min_cntlid, uint16_t max_cntlid) 2502 { 2503 if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) { 2504 return -EAGAIN; 2505 } 2506 2507 if (min_cntlid > max_cntlid) { 2508 return -EINVAL; 2509 } 2510 /* The spec reserves cntlid values in the range FFF0h to FFFFh. */ 2511 if (min_cntlid < NVMF_MIN_CNTLID || min_cntlid > NVMF_MAX_CNTLID || 2512 max_cntlid < NVMF_MIN_CNTLID || max_cntlid > NVMF_MAX_CNTLID) { 2513 return -EINVAL; 2514 } 2515 subsystem->min_cntlid = min_cntlid; 2516 subsystem->max_cntlid = max_cntlid; 2517 if (subsystem->next_cntlid < min_cntlid || subsystem->next_cntlid > max_cntlid) { 2518 subsystem->next_cntlid = min_cntlid; 2519 } 2520 2521 return 0; 2522 } 2523 2524 uint16_t 2525 nvmf_subsystem_gen_cntlid(struct spdk_nvmf_subsystem *subsystem) 2526 { 2527 int count; 2528 uint16_t cntlid; 2529 2530 /* 2531 * In the worst case, we might have to try all CNTLID values between min_cntlid and max_cntlid 2532 * before we find one that is unused (or find that all values are in use). 2533 */ 2534 for (count = 0; count < subsystem->max_cntlid - subsystem->min_cntlid + 1; count++) { 2535 cntlid = subsystem->next_cntlid; 2536 subsystem->next_cntlid++; 2537 2538 if (subsystem->next_cntlid > subsystem->max_cntlid) { 2539 subsystem->next_cntlid = subsystem->min_cntlid; 2540 } 2541 2542 /* Check if a controller with this cntlid currently exists. */ 2543 if (nvmf_subsystem_get_ctrlr(subsystem, cntlid) == NULL) { 2544 /* Found unused cntlid */ 2545 return cntlid; 2546 } 2547 } 2548 2549 /* All valid cntlid values are in use. */ 2550 return 0xFFFF; 2551 } 2552 2553 int 2554 nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr) 2555 { 2556 2557 if (ctrlr->dynamic_ctrlr) { 2558 ctrlr->cntlid = nvmf_subsystem_gen_cntlid(subsystem); 2559 if (ctrlr->cntlid == 0xFFFF) { 2560 /* Unable to get a cntlid */ 2561 SPDK_ERRLOG("Reached max simultaneous ctrlrs\n"); 2562 return -EBUSY; 2563 } 2564 } else if (nvmf_subsystem_get_ctrlr(subsystem, ctrlr->cntlid) != NULL) { 2565 SPDK_ERRLOG("Ctrlr with cntlid %u already exist\n", ctrlr->cntlid); 2566 return -EEXIST; 2567 } 2568 2569 TAILQ_INSERT_TAIL(&subsystem->ctrlrs, ctrlr, link); 2570 2571 SPDK_DTRACE_PROBE3(nvmf_subsystem_add_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn); 2572 2573 return 0; 2574 } 2575 2576 void 2577 nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem, 2578 struct spdk_nvmf_ctrlr *ctrlr) 2579 { 2580 SPDK_DTRACE_PROBE3(nvmf_subsystem_remove_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn); 2581 2582 assert(spdk_get_thread() == subsystem->thread); 2583 assert(subsystem == ctrlr->subsys); 2584 SPDK_DEBUGLOG(nvmf, "remove ctrlr %p id 0x%x from subsys %p %s\n", ctrlr, ctrlr->cntlid, subsystem, 2585 subsystem->subnqn); 2586 TAILQ_REMOVE(&subsystem->ctrlrs, ctrlr, link); 2587 } 2588 2589 struct spdk_nvmf_ctrlr * 2590 nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid) 2591 { 2592 struct spdk_nvmf_ctrlr *ctrlr; 2593 2594 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2595 if (ctrlr->cntlid == cntlid) { 2596 return ctrlr; 2597 } 2598 } 2599 2600 return NULL; 2601 } 2602 2603 uint32_t 2604 spdk_nvmf_subsystem_get_max_namespaces(const struct spdk_nvmf_subsystem *subsystem) 2605 { 2606 return subsystem->max_nsid; 2607 } 2608 2609 uint16_t 2610 spdk_nvmf_subsystem_get_min_cntlid(const struct spdk_nvmf_subsystem *subsystem) 2611 { 2612 return subsystem->min_cntlid; 2613 } 2614 2615 uint16_t 2616 spdk_nvmf_subsystem_get_max_cntlid(const struct spdk_nvmf_subsystem *subsystem) 2617 { 2618 return subsystem->max_cntlid; 2619 } 2620 2621 struct _nvmf_ns_registrant { 2622 uint64_t rkey; 2623 char *host_uuid; 2624 }; 2625 2626 struct _nvmf_ns_registrants { 2627 size_t num_regs; 2628 struct _nvmf_ns_registrant reg[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 2629 }; 2630 2631 struct _nvmf_ns_reservation { 2632 bool ptpl_activated; 2633 enum spdk_nvme_reservation_type rtype; 2634 uint64_t crkey; 2635 char *bdev_uuid; 2636 char *holder_uuid; 2637 struct _nvmf_ns_registrants regs; 2638 }; 2639 2640 static const struct spdk_json_object_decoder nvmf_ns_pr_reg_decoders[] = { 2641 {"rkey", offsetof(struct _nvmf_ns_registrant, rkey), spdk_json_decode_uint64}, 2642 {"host_uuid", offsetof(struct _nvmf_ns_registrant, host_uuid), spdk_json_decode_string}, 2643 }; 2644 2645 static int 2646 nvmf_decode_ns_pr_reg(const struct spdk_json_val *val, void *out) 2647 { 2648 struct _nvmf_ns_registrant *reg = out; 2649 2650 return spdk_json_decode_object(val, nvmf_ns_pr_reg_decoders, 2651 SPDK_COUNTOF(nvmf_ns_pr_reg_decoders), reg); 2652 } 2653 2654 static int 2655 nvmf_decode_ns_pr_regs(const struct spdk_json_val *val, void *out) 2656 { 2657 struct _nvmf_ns_registrants *regs = out; 2658 2659 return spdk_json_decode_array(val, nvmf_decode_ns_pr_reg, regs->reg, 2660 SPDK_NVMF_MAX_NUM_REGISTRANTS, ®s->num_regs, 2661 sizeof(struct _nvmf_ns_registrant)); 2662 } 2663 2664 static const struct spdk_json_object_decoder nvmf_ns_pr_decoders[] = { 2665 {"ptpl", offsetof(struct _nvmf_ns_reservation, ptpl_activated), spdk_json_decode_bool, true}, 2666 {"rtype", offsetof(struct _nvmf_ns_reservation, rtype), spdk_json_decode_uint32, true}, 2667 {"crkey", offsetof(struct _nvmf_ns_reservation, crkey), spdk_json_decode_uint64, true}, 2668 {"bdev_uuid", offsetof(struct _nvmf_ns_reservation, bdev_uuid), spdk_json_decode_string}, 2669 {"holder_uuid", offsetof(struct _nvmf_ns_reservation, holder_uuid), spdk_json_decode_string, true}, 2670 {"registrants", offsetof(struct _nvmf_ns_reservation, regs), nvmf_decode_ns_pr_regs}, 2671 }; 2672 2673 static int 2674 nvmf_ns_reservation_load_json(const struct spdk_nvmf_ns *ns, 2675 struct spdk_nvmf_reservation_info *info) 2676 { 2677 size_t json_size; 2678 ssize_t values_cnt, rc; 2679 void *json = NULL, *end; 2680 struct spdk_json_val *values = NULL; 2681 struct _nvmf_ns_reservation res = {}; 2682 const char *file = ns->ptpl_file; 2683 uint32_t i; 2684 2685 /* It's not an error if the file does not exist */ 2686 if (access(file, F_OK) != 0) { 2687 SPDK_DEBUGLOG(nvmf, "File %s does not exist\n", file); 2688 return 0; 2689 } 2690 2691 /* Load all persist file contents into a local buffer */ 2692 json = spdk_posix_file_load_from_name(file, &json_size); 2693 if (!json) { 2694 SPDK_ERRLOG("Load persist file %s failed\n", file); 2695 return -ENOMEM; 2696 } 2697 2698 rc = spdk_json_parse(json, json_size, NULL, 0, &end, 0); 2699 if (rc < 0) { 2700 SPDK_NOTICELOG("Parsing JSON configuration failed (%zd)\n", rc); 2701 goto exit; 2702 } 2703 2704 values_cnt = rc; 2705 values = calloc(values_cnt, sizeof(struct spdk_json_val)); 2706 if (values == NULL) { 2707 goto exit; 2708 } 2709 2710 rc = spdk_json_parse(json, json_size, values, values_cnt, &end, 0); 2711 if (rc != values_cnt) { 2712 SPDK_ERRLOG("Parsing JSON configuration failed (%zd)\n", rc); 2713 goto exit; 2714 } 2715 2716 /* Decode json */ 2717 if (spdk_json_decode_object(values, nvmf_ns_pr_decoders, 2718 SPDK_COUNTOF(nvmf_ns_pr_decoders), 2719 &res)) { 2720 SPDK_ERRLOG("Invalid objects in the persist file %s\n", file); 2721 rc = -EINVAL; 2722 goto exit; 2723 } 2724 2725 if (res.regs.num_regs > SPDK_NVMF_MAX_NUM_REGISTRANTS) { 2726 SPDK_ERRLOG("Can only support up to %u registrants\n", SPDK_NVMF_MAX_NUM_REGISTRANTS); 2727 rc = -ERANGE; 2728 goto exit; 2729 } 2730 2731 rc = 0; 2732 info->ptpl_activated = res.ptpl_activated; 2733 info->rtype = res.rtype; 2734 info->crkey = res.crkey; 2735 snprintf(info->bdev_uuid, sizeof(info->bdev_uuid), "%s", res.bdev_uuid); 2736 snprintf(info->holder_uuid, sizeof(info->holder_uuid), "%s", res.holder_uuid); 2737 info->num_regs = res.regs.num_regs; 2738 for (i = 0; i < res.regs.num_regs; i++) { 2739 info->registrants[i].rkey = res.regs.reg[i].rkey; 2740 snprintf(info->registrants[i].host_uuid, sizeof(info->registrants[i].host_uuid), "%s", 2741 res.regs.reg[i].host_uuid); 2742 } 2743 2744 exit: 2745 free(json); 2746 free(values); 2747 free(res.bdev_uuid); 2748 free(res.holder_uuid); 2749 for (i = 0; i < res.regs.num_regs; i++) { 2750 free(res.regs.reg[i].host_uuid); 2751 } 2752 2753 return rc; 2754 } 2755 2756 static bool nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns); 2757 2758 static int 2759 nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info) 2760 { 2761 uint32_t i; 2762 struct spdk_nvmf_registrant *reg, *holder = NULL; 2763 struct spdk_uuid bdev_uuid, holder_uuid; 2764 bool rkey_flag = false; 2765 2766 SPDK_DEBUGLOG(nvmf, "NSID %u, PTPL %u, Number of registrants %u\n", 2767 ns->nsid, info->ptpl_activated, info->num_regs); 2768 2769 /* it's not an error */ 2770 if (!info->ptpl_activated || !info->num_regs) { 2771 return 0; 2772 } 2773 2774 /* Check info->crkey exist or not in info->registrants[i].rkey */ 2775 for (i = 0; i < info->num_regs; i++) { 2776 if (info->crkey == info->registrants[i].rkey) { 2777 rkey_flag = true; 2778 } 2779 } 2780 if (!rkey_flag && info->crkey != 0) { 2781 return -EINVAL; 2782 } 2783 2784 spdk_uuid_parse(&bdev_uuid, info->bdev_uuid); 2785 if (spdk_uuid_compare(&bdev_uuid, spdk_bdev_get_uuid(ns->bdev))) { 2786 SPDK_ERRLOG("Existing bdev UUID is not same with configuration file\n"); 2787 return -EINVAL; 2788 } 2789 2790 ns->crkey = info->crkey; 2791 ns->rtype = info->rtype; 2792 ns->ptpl_activated = info->ptpl_activated; 2793 spdk_uuid_parse(&holder_uuid, info->holder_uuid); 2794 2795 SPDK_DEBUGLOG(nvmf, "Bdev UUID %s\n", info->bdev_uuid); 2796 if (info->rtype) { 2797 SPDK_DEBUGLOG(nvmf, "Holder UUID %s, RTYPE %u, RKEY 0x%"PRIx64"\n", 2798 info->holder_uuid, info->rtype, info->crkey); 2799 } 2800 2801 for (i = 0; i < info->num_regs; i++) { 2802 reg = calloc(1, sizeof(*reg)); 2803 if (!reg) { 2804 return -ENOMEM; 2805 } 2806 spdk_uuid_parse(®->hostid, info->registrants[i].host_uuid); 2807 reg->rkey = info->registrants[i].rkey; 2808 TAILQ_INSERT_TAIL(&ns->registrants, reg, link); 2809 if (info->crkey != 0 && !spdk_uuid_compare(&holder_uuid, ®->hostid)) { 2810 holder = reg; 2811 } 2812 SPDK_DEBUGLOG(nvmf, "Registrant RKEY 0x%"PRIx64", Host UUID %s\n", 2813 info->registrants[i].rkey, info->registrants[i].host_uuid); 2814 } 2815 2816 if (nvmf_ns_reservation_all_registrants_type(ns)) { 2817 ns->holder = TAILQ_FIRST(&ns->registrants); 2818 } else { 2819 ns->holder = holder; 2820 } 2821 2822 return 0; 2823 } 2824 2825 static int 2826 nvmf_ns_json_write_cb(void *cb_ctx, const void *data, size_t size) 2827 { 2828 char *file = cb_ctx; 2829 size_t rc; 2830 FILE *fd; 2831 2832 fd = fopen(file, "w"); 2833 if (!fd) { 2834 SPDK_ERRLOG("Can't open file %s for write\n", file); 2835 return -ENOENT; 2836 } 2837 rc = fwrite(data, 1, size, fd); 2838 fclose(fd); 2839 2840 return rc == size ? 0 : -1; 2841 } 2842 2843 static int 2844 nvmf_ns_reservation_update_json(const struct spdk_nvmf_ns *ns, 2845 const struct spdk_nvmf_reservation_info *info) 2846 { 2847 const char *file = ns->ptpl_file; 2848 struct spdk_json_write_ctx *w; 2849 uint32_t i; 2850 int rc = 0; 2851 2852 w = spdk_json_write_begin(nvmf_ns_json_write_cb, (void *)file, 0); 2853 if (w == NULL) { 2854 return -ENOMEM; 2855 } 2856 /* clear the configuration file */ 2857 if (!info->ptpl_activated) { 2858 goto exit; 2859 } 2860 2861 spdk_json_write_object_begin(w); 2862 spdk_json_write_named_bool(w, "ptpl", info->ptpl_activated); 2863 spdk_json_write_named_uint32(w, "rtype", info->rtype); 2864 spdk_json_write_named_uint64(w, "crkey", info->crkey); 2865 spdk_json_write_named_string(w, "bdev_uuid", info->bdev_uuid); 2866 spdk_json_write_named_string(w, "holder_uuid", info->holder_uuid); 2867 2868 spdk_json_write_named_array_begin(w, "registrants"); 2869 for (i = 0; i < info->num_regs; i++) { 2870 spdk_json_write_object_begin(w); 2871 spdk_json_write_named_uint64(w, "rkey", info->registrants[i].rkey); 2872 spdk_json_write_named_string(w, "host_uuid", info->registrants[i].host_uuid); 2873 spdk_json_write_object_end(w); 2874 } 2875 spdk_json_write_array_end(w); 2876 spdk_json_write_object_end(w); 2877 2878 exit: 2879 rc = spdk_json_write_end(w); 2880 return rc; 2881 } 2882 2883 static int 2884 nvmf_ns_update_reservation_info(struct spdk_nvmf_ns *ns) 2885 { 2886 struct spdk_nvmf_reservation_info info; 2887 struct spdk_nvmf_registrant *reg, *tmp; 2888 uint32_t i = 0; 2889 2890 assert(ns != NULL); 2891 2892 if (!ns->bdev || !nvmf_ns_is_ptpl_capable(ns)) { 2893 return 0; 2894 } 2895 2896 memset(&info, 0, sizeof(info)); 2897 spdk_uuid_fmt_lower(info.bdev_uuid, sizeof(info.bdev_uuid), spdk_bdev_get_uuid(ns->bdev)); 2898 2899 if (ns->rtype) { 2900 info.rtype = ns->rtype; 2901 info.crkey = ns->crkey; 2902 if (!nvmf_ns_reservation_all_registrants_type(ns)) { 2903 assert(ns->holder != NULL); 2904 spdk_uuid_fmt_lower(info.holder_uuid, sizeof(info.holder_uuid), &ns->holder->hostid); 2905 } 2906 } 2907 2908 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2909 spdk_uuid_fmt_lower(info.registrants[i].host_uuid, sizeof(info.registrants[i].host_uuid), 2910 ®->hostid); 2911 info.registrants[i++].rkey = reg->rkey; 2912 } 2913 2914 info.num_regs = i; 2915 info.ptpl_activated = ns->ptpl_activated; 2916 2917 return nvmf_ns_reservation_update(ns, &info); 2918 } 2919 2920 static struct spdk_nvmf_registrant * 2921 nvmf_ns_reservation_get_registrant(struct spdk_nvmf_ns *ns, 2922 struct spdk_uuid *uuid) 2923 { 2924 struct spdk_nvmf_registrant *reg, *tmp; 2925 2926 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2927 if (!spdk_uuid_compare(®->hostid, uuid)) { 2928 return reg; 2929 } 2930 } 2931 2932 return NULL; 2933 } 2934 2935 /* Generate reservation notice log to registered HostID controllers */ 2936 static void 2937 nvmf_subsystem_gen_ctrlr_notification(struct spdk_nvmf_subsystem *subsystem, 2938 struct spdk_nvmf_ns *ns, 2939 struct spdk_uuid *hostid_list, 2940 uint32_t num_hostid, 2941 enum spdk_nvme_reservation_notification_log_page_type type) 2942 { 2943 struct spdk_nvmf_ctrlr *ctrlr; 2944 uint32_t i; 2945 2946 for (i = 0; i < num_hostid; i++) { 2947 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 2948 if (!spdk_uuid_compare(&ctrlr->hostid, &hostid_list[i])) { 2949 nvmf_ctrlr_reservation_notice_log(ctrlr, ns, type); 2950 } 2951 } 2952 } 2953 } 2954 2955 /* Get all registrants' hostid other than the controller who issued the command */ 2956 static uint32_t 2957 nvmf_ns_reservation_get_all_other_hostid(struct spdk_nvmf_ns *ns, 2958 struct spdk_uuid *hostid_list, 2959 uint32_t max_num_hostid, 2960 struct spdk_uuid *current_hostid) 2961 { 2962 struct spdk_nvmf_registrant *reg, *tmp; 2963 uint32_t num_hostid = 0; 2964 2965 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 2966 if (spdk_uuid_compare(®->hostid, current_hostid)) { 2967 if (num_hostid == max_num_hostid) { 2968 assert(false); 2969 return max_num_hostid; 2970 } 2971 hostid_list[num_hostid++] = reg->hostid; 2972 } 2973 } 2974 2975 return num_hostid; 2976 } 2977 2978 /* Calculate the unregistered HostID list according to list 2979 * prior to execute preempt command and list after executing 2980 * preempt command. 2981 */ 2982 static uint32_t 2983 nvmf_ns_reservation_get_unregistered_hostid(struct spdk_uuid *old_hostid_list, 2984 uint32_t old_num_hostid, 2985 struct spdk_uuid *remaining_hostid_list, 2986 uint32_t remaining_num_hostid) 2987 { 2988 struct spdk_uuid temp_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 2989 uint32_t i, j, num_hostid = 0; 2990 bool found; 2991 2992 if (!remaining_num_hostid) { 2993 return old_num_hostid; 2994 } 2995 2996 for (i = 0; i < old_num_hostid; i++) { 2997 found = false; 2998 for (j = 0; j < remaining_num_hostid; j++) { 2999 if (!spdk_uuid_compare(&old_hostid_list[i], &remaining_hostid_list[j])) { 3000 found = true; 3001 break; 3002 } 3003 } 3004 if (!found) { 3005 spdk_uuid_copy(&temp_hostid_list[num_hostid++], &old_hostid_list[i]); 3006 } 3007 } 3008 3009 if (num_hostid) { 3010 memcpy(old_hostid_list, temp_hostid_list, sizeof(struct spdk_uuid) * num_hostid); 3011 } 3012 3013 return num_hostid; 3014 } 3015 3016 /* current reservation type is all registrants or not */ 3017 static bool 3018 nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns) 3019 { 3020 return (ns->rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS || 3021 ns->rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS); 3022 } 3023 3024 /* current registrant is reservation holder or not */ 3025 static bool 3026 nvmf_ns_reservation_registrant_is_holder(struct spdk_nvmf_ns *ns, 3027 struct spdk_nvmf_registrant *reg) 3028 { 3029 if (!reg) { 3030 return false; 3031 } 3032 3033 if (nvmf_ns_reservation_all_registrants_type(ns)) { 3034 return true; 3035 } 3036 3037 return (ns->holder == reg); 3038 } 3039 3040 static int 3041 nvmf_ns_reservation_add_registrant(struct spdk_nvmf_ns *ns, 3042 struct spdk_nvmf_ctrlr *ctrlr, 3043 uint64_t nrkey) 3044 { 3045 struct spdk_nvmf_registrant *reg; 3046 3047 reg = calloc(1, sizeof(*reg)); 3048 if (!reg) { 3049 return -ENOMEM; 3050 } 3051 3052 reg->rkey = nrkey; 3053 /* set hostid for the registrant */ 3054 spdk_uuid_copy(®->hostid, &ctrlr->hostid); 3055 TAILQ_INSERT_TAIL(&ns->registrants, reg, link); 3056 ns->gen++; 3057 3058 return 0; 3059 } 3060 3061 static void 3062 nvmf_ns_reservation_release_reservation(struct spdk_nvmf_ns *ns) 3063 { 3064 ns->rtype = 0; 3065 ns->crkey = 0; 3066 ns->holder = NULL; 3067 } 3068 3069 /* release the reservation if the last registrant was removed */ 3070 static void 3071 nvmf_ns_reservation_check_release_on_remove_registrant(struct spdk_nvmf_ns *ns, 3072 struct spdk_nvmf_registrant *reg) 3073 { 3074 struct spdk_nvmf_registrant *next_reg; 3075 3076 /* no reservation holder */ 3077 if (!ns->holder) { 3078 assert(ns->rtype == 0); 3079 return; 3080 } 3081 3082 next_reg = TAILQ_FIRST(&ns->registrants); 3083 if (next_reg && nvmf_ns_reservation_all_registrants_type(ns)) { 3084 /* the next valid registrant is the new holder now */ 3085 ns->holder = next_reg; 3086 } else if (nvmf_ns_reservation_registrant_is_holder(ns, reg)) { 3087 /* release the reservation */ 3088 nvmf_ns_reservation_release_reservation(ns); 3089 } 3090 } 3091 3092 static void 3093 nvmf_ns_reservation_remove_registrant(struct spdk_nvmf_ns *ns, 3094 struct spdk_nvmf_registrant *reg) 3095 { 3096 TAILQ_REMOVE(&ns->registrants, reg, link); 3097 nvmf_ns_reservation_check_release_on_remove_registrant(ns, reg); 3098 free(reg); 3099 ns->gen++; 3100 return; 3101 } 3102 3103 static uint32_t 3104 nvmf_ns_reservation_remove_registrants_by_key(struct spdk_nvmf_ns *ns, 3105 uint64_t rkey) 3106 { 3107 struct spdk_nvmf_registrant *reg, *tmp; 3108 uint32_t count = 0; 3109 3110 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3111 if (reg->rkey == rkey) { 3112 nvmf_ns_reservation_remove_registrant(ns, reg); 3113 count++; 3114 } 3115 } 3116 return count; 3117 } 3118 3119 static uint32_t 3120 nvmf_ns_reservation_remove_all_other_registrants(struct spdk_nvmf_ns *ns, 3121 struct spdk_nvmf_registrant *reg) 3122 { 3123 struct spdk_nvmf_registrant *reg_tmp, *reg_tmp2; 3124 uint32_t count = 0; 3125 3126 TAILQ_FOREACH_SAFE(reg_tmp, &ns->registrants, link, reg_tmp2) { 3127 if (reg_tmp != reg) { 3128 nvmf_ns_reservation_remove_registrant(ns, reg_tmp); 3129 count++; 3130 } 3131 } 3132 return count; 3133 } 3134 3135 static uint32_t 3136 nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns) 3137 { 3138 struct spdk_nvmf_registrant *reg, *reg_tmp; 3139 uint32_t count = 0; 3140 3141 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, reg_tmp) { 3142 nvmf_ns_reservation_remove_registrant(ns, reg); 3143 count++; 3144 } 3145 return count; 3146 } 3147 3148 static void 3149 nvmf_ns_reservation_acquire_reservation(struct spdk_nvmf_ns *ns, uint64_t rkey, 3150 enum spdk_nvme_reservation_type rtype, 3151 struct spdk_nvmf_registrant *holder) 3152 { 3153 ns->rtype = rtype; 3154 ns->crkey = rkey; 3155 assert(ns->holder == NULL); 3156 ns->holder = holder; 3157 } 3158 3159 static bool 3160 nvmf_ns_reservation_register(struct spdk_nvmf_ns *ns, 3161 struct spdk_nvmf_ctrlr *ctrlr, 3162 struct spdk_nvmf_request *req) 3163 { 3164 struct spdk_nvme_reservation_register_data key = { 0 }; 3165 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3166 uint8_t rrega, iekey, cptpl, rtype; 3167 struct spdk_nvmf_registrant *reg; 3168 uint8_t status = SPDK_NVME_SC_SUCCESS; 3169 bool update_sgroup = false; 3170 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3171 uint32_t num_hostid = 0; 3172 int rc; 3173 3174 rrega = cmd->cdw10_bits.resv_register.rrega; 3175 iekey = cmd->cdw10_bits.resv_register.iekey; 3176 cptpl = cmd->cdw10_bits.resv_register.cptpl; 3177 3178 if (req->iovcnt > 0 && req->length >= sizeof(key)) { 3179 struct spdk_iov_xfer ix; 3180 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3181 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key)); 3182 } else { 3183 SPDK_ERRLOG("No key provided. Failing request.\n"); 3184 status = SPDK_NVME_SC_INVALID_FIELD; 3185 goto exit; 3186 } 3187 3188 SPDK_DEBUGLOG(nvmf, "REGISTER: RREGA %u, IEKEY %u, CPTPL %u, " 3189 "NRKEY 0x%"PRIx64", NRKEY 0x%"PRIx64"\n", 3190 rrega, iekey, cptpl, key.crkey, key.nrkey); 3191 3192 if (cptpl == SPDK_NVME_RESERVE_PTPL_CLEAR_POWER_ON) { 3193 /* True to OFF state, and need to be updated in the configuration file */ 3194 if (ns->ptpl_activated) { 3195 ns->ptpl_activated = 0; 3196 update_sgroup = true; 3197 } 3198 } else if (cptpl == SPDK_NVME_RESERVE_PTPL_PERSIST_POWER_LOSS) { 3199 if (!nvmf_ns_is_ptpl_capable(ns)) { 3200 status = SPDK_NVME_SC_INVALID_FIELD; 3201 goto exit; 3202 } else if (ns->ptpl_activated == 0) { 3203 ns->ptpl_activated = 1; 3204 update_sgroup = true; 3205 } 3206 } 3207 3208 /* current Host Identifier has registrant or not */ 3209 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3210 3211 switch (rrega) { 3212 case SPDK_NVME_RESERVE_REGISTER_KEY: 3213 if (!reg) { 3214 /* register new controller */ 3215 if (key.nrkey == 0) { 3216 SPDK_ERRLOG("Can't register zeroed new key\n"); 3217 status = SPDK_NVME_SC_INVALID_FIELD; 3218 goto exit; 3219 } 3220 rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey); 3221 if (rc < 0) { 3222 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3223 goto exit; 3224 } 3225 update_sgroup = true; 3226 } else { 3227 /* register with same key is not an error */ 3228 if (reg->rkey != key.nrkey) { 3229 SPDK_ERRLOG("The same host already register a " 3230 "key with 0x%"PRIx64"\n", 3231 reg->rkey); 3232 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3233 goto exit; 3234 } 3235 } 3236 break; 3237 case SPDK_NVME_RESERVE_UNREGISTER_KEY: 3238 if (!reg || (!iekey && reg->rkey != key.crkey)) { 3239 SPDK_ERRLOG("No registrant or current key doesn't match " 3240 "with existing registrant key\n"); 3241 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3242 goto exit; 3243 } 3244 3245 rtype = ns->rtype; 3246 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3247 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3248 &ctrlr->hostid); 3249 3250 nvmf_ns_reservation_remove_registrant(ns, reg); 3251 3252 if (!ns->rtype && num_hostid && (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_REG_ONLY || 3253 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY)) { 3254 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3255 hostid_list, 3256 num_hostid, 3257 SPDK_NVME_RESERVATION_RELEASED); 3258 } 3259 update_sgroup = true; 3260 break; 3261 case SPDK_NVME_RESERVE_REPLACE_KEY: 3262 if (key.nrkey == 0) { 3263 SPDK_ERRLOG("Can't register zeroed new key\n"); 3264 status = SPDK_NVME_SC_INVALID_FIELD; 3265 goto exit; 3266 } 3267 /* Registrant exists */ 3268 if (reg) { 3269 if (!iekey && reg->rkey != key.crkey) { 3270 SPDK_ERRLOG("Current key doesn't match " 3271 "existing registrant key\n"); 3272 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3273 goto exit; 3274 } 3275 if (reg->rkey == key.nrkey) { 3276 goto exit; 3277 } 3278 reg->rkey = key.nrkey; 3279 } else if (iekey) { /* No registrant but IEKEY is set */ 3280 /* new registrant */ 3281 rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey); 3282 if (rc < 0) { 3283 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3284 goto exit; 3285 } 3286 } else { /* No registrant */ 3287 SPDK_ERRLOG("No registrant\n"); 3288 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3289 goto exit; 3290 3291 } 3292 update_sgroup = true; 3293 break; 3294 default: 3295 status = SPDK_NVME_SC_INVALID_FIELD; 3296 goto exit; 3297 } 3298 3299 exit: 3300 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3301 req->rsp->nvme_cpl.status.sc = status; 3302 return update_sgroup; 3303 } 3304 3305 static bool 3306 nvmf_ns_reservation_acquire(struct spdk_nvmf_ns *ns, 3307 struct spdk_nvmf_ctrlr *ctrlr, 3308 struct spdk_nvmf_request *req) 3309 { 3310 struct spdk_nvme_reservation_acquire_data key = { 0 }; 3311 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3312 uint8_t racqa, iekey, rtype; 3313 struct spdk_nvmf_registrant *reg; 3314 bool all_regs = false; 3315 uint32_t count = 0; 3316 bool update_sgroup = true; 3317 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3318 uint32_t num_hostid = 0; 3319 struct spdk_uuid new_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3320 uint32_t new_num_hostid = 0; 3321 bool reservation_released = false; 3322 uint8_t status = SPDK_NVME_SC_SUCCESS; 3323 3324 racqa = cmd->cdw10_bits.resv_acquire.racqa; 3325 iekey = cmd->cdw10_bits.resv_acquire.iekey; 3326 rtype = cmd->cdw10_bits.resv_acquire.rtype; 3327 3328 if (req->iovcnt > 0 && req->length >= sizeof(key)) { 3329 struct spdk_iov_xfer ix; 3330 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3331 spdk_iov_xfer_to_buf(&ix, &key, sizeof(key)); 3332 } else { 3333 SPDK_ERRLOG("No key provided. Failing request.\n"); 3334 status = SPDK_NVME_SC_INVALID_FIELD; 3335 goto exit; 3336 } 3337 3338 SPDK_DEBUGLOG(nvmf, "ACQUIRE: RACQA %u, IEKEY %u, RTYPE %u, " 3339 "NRKEY 0x%"PRIx64", PRKEY 0x%"PRIx64"\n", 3340 racqa, iekey, rtype, key.crkey, key.prkey); 3341 3342 if (iekey || rtype > SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) { 3343 SPDK_ERRLOG("Ignore existing key field set to 1\n"); 3344 status = SPDK_NVME_SC_INVALID_FIELD; 3345 update_sgroup = false; 3346 goto exit; 3347 } 3348 3349 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3350 /* must be registrant and CRKEY must match */ 3351 if (!reg || reg->rkey != key.crkey) { 3352 SPDK_ERRLOG("No registrant or current key doesn't match " 3353 "with existing registrant key\n"); 3354 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3355 update_sgroup = false; 3356 goto exit; 3357 } 3358 3359 all_regs = nvmf_ns_reservation_all_registrants_type(ns); 3360 3361 switch (racqa) { 3362 case SPDK_NVME_RESERVE_ACQUIRE: 3363 /* it's not an error for the holder to acquire same reservation type again */ 3364 if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && ns->rtype == rtype) { 3365 /* do nothing */ 3366 update_sgroup = false; 3367 } else if (ns->holder == NULL) { 3368 /* first time to acquire the reservation */ 3369 nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg); 3370 } else { 3371 SPDK_ERRLOG("Invalid rtype or current registrant is not holder\n"); 3372 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3373 update_sgroup = false; 3374 goto exit; 3375 } 3376 break; 3377 case SPDK_NVME_RESERVE_PREEMPT: 3378 /* no reservation holder */ 3379 if (!ns->holder) { 3380 /* unregister with PRKEY */ 3381 nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3382 break; 3383 } 3384 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3385 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3386 &ctrlr->hostid); 3387 3388 /* only 1 reservation holder and reservation key is valid */ 3389 if (!all_regs) { 3390 /* preempt itself */ 3391 if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && 3392 ns->crkey == key.prkey) { 3393 ns->rtype = rtype; 3394 reservation_released = true; 3395 break; 3396 } 3397 3398 if (ns->crkey == key.prkey) { 3399 nvmf_ns_reservation_remove_registrant(ns, ns->holder); 3400 nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg); 3401 reservation_released = true; 3402 } else if (key.prkey != 0) { 3403 nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3404 } else { 3405 /* PRKEY is zero */ 3406 SPDK_ERRLOG("Current PRKEY is zero\n"); 3407 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3408 update_sgroup = false; 3409 goto exit; 3410 } 3411 } else { 3412 /* release all other registrants except for the current one */ 3413 if (key.prkey == 0) { 3414 nvmf_ns_reservation_remove_all_other_registrants(ns, reg); 3415 assert(ns->holder == reg); 3416 } else { 3417 count = nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey); 3418 if (count == 0) { 3419 SPDK_ERRLOG("PRKEY doesn't match any registrant\n"); 3420 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3421 update_sgroup = false; 3422 goto exit; 3423 } 3424 } 3425 } 3426 break; 3427 default: 3428 status = SPDK_NVME_SC_INVALID_FIELD; 3429 update_sgroup = false; 3430 break; 3431 } 3432 3433 exit: 3434 if (update_sgroup && racqa == SPDK_NVME_RESERVE_PREEMPT) { 3435 new_num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, new_hostid_list, 3436 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3437 &ctrlr->hostid); 3438 /* Preempt notification occurs on the unregistered controllers 3439 * other than the controller who issued the command. 3440 */ 3441 num_hostid = nvmf_ns_reservation_get_unregistered_hostid(hostid_list, 3442 num_hostid, 3443 new_hostid_list, 3444 new_num_hostid); 3445 if (num_hostid) { 3446 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3447 hostid_list, 3448 num_hostid, 3449 SPDK_NVME_REGISTRATION_PREEMPTED); 3450 3451 } 3452 /* Reservation released notification occurs on the 3453 * controllers which are the remaining registrants other than 3454 * the controller who issued the command. 3455 */ 3456 if (reservation_released && new_num_hostid) { 3457 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3458 new_hostid_list, 3459 new_num_hostid, 3460 SPDK_NVME_RESERVATION_RELEASED); 3461 3462 } 3463 } 3464 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3465 req->rsp->nvme_cpl.status.sc = status; 3466 return update_sgroup; 3467 } 3468 3469 static bool 3470 nvmf_ns_reservation_release(struct spdk_nvmf_ns *ns, 3471 struct spdk_nvmf_ctrlr *ctrlr, 3472 struct spdk_nvmf_request *req) 3473 { 3474 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3475 uint8_t rrela, iekey, rtype; 3476 struct spdk_nvmf_registrant *reg; 3477 uint64_t crkey = 0; 3478 uint8_t status = SPDK_NVME_SC_SUCCESS; 3479 bool update_sgroup = true; 3480 struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS]; 3481 uint32_t num_hostid = 0; 3482 3483 rrela = cmd->cdw10_bits.resv_release.rrela; 3484 iekey = cmd->cdw10_bits.resv_release.iekey; 3485 rtype = cmd->cdw10_bits.resv_release.rtype; 3486 3487 if (req->iovcnt > 0 && req->length >= sizeof(crkey)) { 3488 struct spdk_iov_xfer ix; 3489 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3490 spdk_iov_xfer_to_buf(&ix, &crkey, sizeof(crkey)); 3491 } else { 3492 SPDK_ERRLOG("No key provided. Failing request.\n"); 3493 status = SPDK_NVME_SC_INVALID_FIELD; 3494 goto exit; 3495 } 3496 3497 SPDK_DEBUGLOG(nvmf, "RELEASE: RRELA %u, IEKEY %u, RTYPE %u, " 3498 "CRKEY 0x%"PRIx64"\n", rrela, iekey, rtype, crkey); 3499 3500 if (iekey) { 3501 SPDK_ERRLOG("Ignore existing key field set to 1\n"); 3502 status = SPDK_NVME_SC_INVALID_FIELD; 3503 update_sgroup = false; 3504 goto exit; 3505 } 3506 3507 reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid); 3508 if (!reg || reg->rkey != crkey) { 3509 SPDK_ERRLOG("No registrant or current key doesn't match " 3510 "with existing registrant key\n"); 3511 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 3512 update_sgroup = false; 3513 goto exit; 3514 } 3515 3516 num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list, 3517 SPDK_NVMF_MAX_NUM_REGISTRANTS, 3518 &ctrlr->hostid); 3519 3520 switch (rrela) { 3521 case SPDK_NVME_RESERVE_RELEASE: 3522 if (!ns->holder) { 3523 SPDK_DEBUGLOG(nvmf, "RELEASE: no holder\n"); 3524 update_sgroup = false; 3525 goto exit; 3526 } 3527 if (ns->rtype != rtype) { 3528 SPDK_ERRLOG("Type doesn't match\n"); 3529 status = SPDK_NVME_SC_INVALID_FIELD; 3530 update_sgroup = false; 3531 goto exit; 3532 } 3533 if (!nvmf_ns_reservation_registrant_is_holder(ns, reg)) { 3534 /* not the reservation holder, this isn't an error */ 3535 update_sgroup = false; 3536 goto exit; 3537 } 3538 3539 rtype = ns->rtype; 3540 nvmf_ns_reservation_release_reservation(ns); 3541 3542 if (num_hostid && rtype != SPDK_NVME_RESERVE_WRITE_EXCLUSIVE && 3543 rtype != SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 3544 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3545 hostid_list, 3546 num_hostid, 3547 SPDK_NVME_RESERVATION_RELEASED); 3548 } 3549 break; 3550 case SPDK_NVME_RESERVE_CLEAR: 3551 nvmf_ns_reservation_clear_all_registrants(ns); 3552 if (num_hostid) { 3553 nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns, 3554 hostid_list, 3555 num_hostid, 3556 SPDK_NVME_RESERVATION_PREEMPTED); 3557 } 3558 break; 3559 default: 3560 status = SPDK_NVME_SC_INVALID_FIELD; 3561 update_sgroup = false; 3562 goto exit; 3563 } 3564 3565 exit: 3566 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3567 req->rsp->nvme_cpl.status.sc = status; 3568 return update_sgroup; 3569 } 3570 3571 static void 3572 nvmf_ns_reservation_report(struct spdk_nvmf_ns *ns, 3573 struct spdk_nvmf_ctrlr *ctrlr, 3574 struct spdk_nvmf_request *req) 3575 { 3576 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3577 struct spdk_nvmf_registrant *reg, *tmp; 3578 struct spdk_nvme_reservation_status_extended_data status_data = { 0 }; 3579 struct spdk_iov_xfer ix; 3580 uint32_t transfer_len; 3581 uint32_t regctl = 0; 3582 uint8_t status = SPDK_NVME_SC_SUCCESS; 3583 3584 if (req->iovcnt == 0) { 3585 SPDK_ERRLOG("No data transfer specified for request. " 3586 " Unable to transfer back response.\n"); 3587 status = SPDK_NVME_SC_INVALID_FIELD; 3588 goto exit; 3589 } 3590 3591 if (!cmd->cdw11_bits.resv_report.eds) { 3592 SPDK_ERRLOG("NVMeoF uses extended controller data structure, " 3593 "please set EDS bit in cdw11 and try again\n"); 3594 status = SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT; 3595 goto exit; 3596 } 3597 3598 /* Number of Dwords of the Reservation Status data structure to transfer */ 3599 transfer_len = (cmd->cdw10 + 1) * sizeof(uint32_t); 3600 3601 if (transfer_len < sizeof(struct spdk_nvme_reservation_status_extended_data)) { 3602 status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3603 goto exit; 3604 } 3605 3606 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3607 3608 status_data.data.gen = ns->gen; 3609 status_data.data.rtype = ns->rtype; 3610 status_data.data.ptpls = ns->ptpl_activated; 3611 3612 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3613 regctl++; 3614 } 3615 3616 /* 3617 * We report the number of registrants as per the spec here, even if 3618 * the iov isn't big enough to contain them all. In that case, the 3619 * spdk_iov_xfer_from_buf() won't actually copy any of the remaining 3620 * data; as it keeps track of the iov cursor itself, it's simplest to 3621 * just walk the entire list anyway. 3622 */ 3623 status_data.data.regctl = regctl; 3624 3625 spdk_iov_xfer_from_buf(&ix, &status_data, sizeof(status_data)); 3626 3627 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 3628 struct spdk_nvme_registered_ctrlr_extended_data ctrlr_data = { 0 }; 3629 3630 /* Set to 0xffffh for dynamic controller */ 3631 ctrlr_data.cntlid = 0xffff; 3632 ctrlr_data.rcsts.status = (ns->holder == reg) ? true : false; 3633 ctrlr_data.rkey = reg->rkey; 3634 spdk_uuid_copy((struct spdk_uuid *)ctrlr_data.hostid, ®->hostid); 3635 3636 spdk_iov_xfer_from_buf(&ix, &ctrlr_data, sizeof(ctrlr_data)); 3637 } 3638 3639 exit: 3640 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3641 req->rsp->nvme_cpl.status.sc = status; 3642 return; 3643 } 3644 3645 static void 3646 nvmf_ns_reservation_complete(void *ctx) 3647 { 3648 struct spdk_nvmf_request *req = ctx; 3649 3650 spdk_nvmf_request_complete(req); 3651 } 3652 3653 static void 3654 _nvmf_ns_reservation_update_done(struct spdk_nvmf_subsystem *subsystem, 3655 void *cb_arg, int status) 3656 { 3657 struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)cb_arg; 3658 struct spdk_nvmf_poll_group *group = req->qpair->group; 3659 3660 spdk_thread_send_msg(group->thread, nvmf_ns_reservation_complete, req); 3661 } 3662 3663 void 3664 nvmf_ns_reservation_request(void *ctx) 3665 { 3666 struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)ctx; 3667 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3668 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3669 uint32_t nsid; 3670 struct spdk_nvmf_ns *ns; 3671 bool update_sgroup = false; 3672 int status = 0; 3673 3674 nsid = cmd->nsid; 3675 ns = _nvmf_subsystem_get_ns(ctrlr->subsys, nsid); 3676 assert(ns != NULL); 3677 3678 switch (cmd->opc) { 3679 case SPDK_NVME_OPC_RESERVATION_REGISTER: 3680 update_sgroup = nvmf_ns_reservation_register(ns, ctrlr, req); 3681 break; 3682 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 3683 update_sgroup = nvmf_ns_reservation_acquire(ns, ctrlr, req); 3684 break; 3685 case SPDK_NVME_OPC_RESERVATION_RELEASE: 3686 update_sgroup = nvmf_ns_reservation_release(ns, ctrlr, req); 3687 break; 3688 case SPDK_NVME_OPC_RESERVATION_REPORT: 3689 nvmf_ns_reservation_report(ns, ctrlr, req); 3690 break; 3691 default: 3692 break; 3693 } 3694 3695 /* update reservation information to subsystem's poll group */ 3696 if (update_sgroup) { 3697 if (ns->ptpl_activated || cmd->opc == SPDK_NVME_OPC_RESERVATION_REGISTER) { 3698 if (nvmf_ns_update_reservation_info(ns) != 0) { 3699 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 3700 } 3701 } 3702 status = nvmf_subsystem_update_ns(ctrlr->subsys, _nvmf_ns_reservation_update_done, req); 3703 if (status == 0) { 3704 return; 3705 } 3706 } 3707 3708 _nvmf_ns_reservation_update_done(ctrlr->subsys, req, status); 3709 } 3710 3711 static bool 3712 nvmf_ns_is_ptpl_capable_json(const struct spdk_nvmf_ns *ns) 3713 { 3714 return ns->ptpl_file != NULL; 3715 } 3716 3717 static struct spdk_nvmf_ns_reservation_ops g_reservation_ops = { 3718 .is_ptpl_capable = nvmf_ns_is_ptpl_capable_json, 3719 .update = nvmf_ns_reservation_update_json, 3720 .load = nvmf_ns_reservation_load_json, 3721 }; 3722 3723 bool 3724 nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns) 3725 { 3726 return g_reservation_ops.is_ptpl_capable(ns); 3727 } 3728 3729 static int 3730 nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns, 3731 const struct spdk_nvmf_reservation_info *info) 3732 { 3733 return g_reservation_ops.update(ns, info); 3734 } 3735 3736 static int 3737 nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info) 3738 { 3739 return g_reservation_ops.load(ns, info); 3740 } 3741 3742 void 3743 spdk_nvmf_set_custom_ns_reservation_ops(const struct spdk_nvmf_ns_reservation_ops *ops) 3744 { 3745 g_reservation_ops = *ops; 3746 } 3747 3748 int 3749 spdk_nvmf_subsystem_set_ana_reporting(struct spdk_nvmf_subsystem *subsystem, 3750 bool ana_reporting) 3751 { 3752 if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) { 3753 return -EAGAIN; 3754 } 3755 3756 subsystem->flags.ana_reporting = ana_reporting; 3757 3758 return 0; 3759 } 3760 3761 bool 3762 spdk_nvmf_subsystem_get_ana_reporting(struct spdk_nvmf_subsystem *subsystem) 3763 { 3764 return subsystem->flags.ana_reporting; 3765 } 3766 3767 struct subsystem_listener_update_ctx { 3768 struct spdk_nvmf_subsystem_listener *listener; 3769 3770 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn; 3771 void *cb_arg; 3772 }; 3773 3774 static void 3775 subsystem_listener_update_done(struct spdk_io_channel_iter *i, int status) 3776 { 3777 struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 3778 3779 if (ctx->cb_fn) { 3780 ctx->cb_fn(ctx->cb_arg, status); 3781 } 3782 free(ctx); 3783 } 3784 3785 static void 3786 subsystem_listener_update_on_pg(struct spdk_io_channel_iter *i) 3787 { 3788 struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 3789 struct spdk_nvmf_subsystem_listener *listener; 3790 struct spdk_nvmf_poll_group *group; 3791 struct spdk_nvmf_ctrlr *ctrlr; 3792 3793 listener = ctx->listener; 3794 group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i)); 3795 3796 TAILQ_FOREACH(ctrlr, &listener->subsystem->ctrlrs, link) { 3797 if (ctrlr->thread != spdk_get_thread()) { 3798 continue; 3799 } 3800 3801 if (ctrlr->admin_qpair && ctrlr->admin_qpair->group == group && ctrlr->listener == listener) { 3802 nvmf_ctrlr_async_event_ana_change_notice(ctrlr); 3803 } 3804 } 3805 3806 spdk_for_each_channel_continue(i, 0); 3807 } 3808 3809 void 3810 spdk_nvmf_subsystem_set_ana_state(struct spdk_nvmf_subsystem *subsystem, 3811 const struct spdk_nvme_transport_id *trid, 3812 enum spdk_nvme_ana_state ana_state, uint32_t anagrpid, 3813 spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, void *cb_arg) 3814 { 3815 struct spdk_nvmf_subsystem_listener *listener; 3816 struct subsystem_listener_update_ctx *ctx; 3817 uint32_t i; 3818 3819 assert(cb_fn != NULL); 3820 assert(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE || 3821 subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED); 3822 3823 if (!subsystem->flags.ana_reporting) { 3824 SPDK_ERRLOG("ANA reporting is disabled\n"); 3825 cb_fn(cb_arg, -EINVAL); 3826 return; 3827 } 3828 3829 /* ANA Change state is not used, ANA Persistent Loss state 3830 * is not supported yet. 3831 */ 3832 if (!(ana_state == SPDK_NVME_ANA_OPTIMIZED_STATE || 3833 ana_state == SPDK_NVME_ANA_NON_OPTIMIZED_STATE || 3834 ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE)) { 3835 SPDK_ERRLOG("ANA state %d is not supported\n", ana_state); 3836 cb_fn(cb_arg, -ENOTSUP); 3837 return; 3838 } 3839 3840 if (anagrpid > subsystem->max_nsid) { 3841 SPDK_ERRLOG("ANA group ID %" PRIu32 " is more than maximum\n", anagrpid); 3842 cb_fn(cb_arg, -EINVAL); 3843 return; 3844 } 3845 3846 listener = nvmf_subsystem_find_listener(subsystem, trid); 3847 if (!listener) { 3848 SPDK_ERRLOG("Unable to find listener.\n"); 3849 cb_fn(cb_arg, -EINVAL); 3850 return; 3851 } 3852 3853 if (anagrpid != 0 && listener->ana_state[anagrpid - 1] == ana_state) { 3854 cb_fn(cb_arg, 0); 3855 return; 3856 } 3857 3858 ctx = calloc(1, sizeof(*ctx)); 3859 if (!ctx) { 3860 SPDK_ERRLOG("Unable to allocate context\n"); 3861 cb_fn(cb_arg, -ENOMEM); 3862 return; 3863 } 3864 3865 for (i = 1; i <= subsystem->max_nsid; i++) { 3866 if (anagrpid == 0 || i == anagrpid) { 3867 listener->ana_state[i - 1] = ana_state; 3868 } 3869 } 3870 listener->ana_state_change_count++; 3871 3872 ctx->listener = listener; 3873 ctx->cb_fn = cb_fn; 3874 ctx->cb_arg = cb_arg; 3875 3876 spdk_for_each_channel(subsystem->tgt, 3877 subsystem_listener_update_on_pg, 3878 ctx, 3879 subsystem_listener_update_done); 3880 } 3881 3882 int 3883 spdk_nvmf_subsystem_get_ana_state(struct spdk_nvmf_subsystem *subsystem, 3884 const struct spdk_nvme_transport_id *trid, 3885 uint32_t anagrpid, 3886 enum spdk_nvme_ana_state *ana_state) 3887 { 3888 assert(ana_state != NULL); 3889 3890 struct spdk_nvmf_subsystem_listener *listener; 3891 3892 if (!subsystem->flags.ana_reporting) { 3893 SPDK_ERRLOG("ANA reporting is disabled\n"); 3894 return -EINVAL; 3895 } 3896 3897 if (anagrpid <= 0 || anagrpid > subsystem->max_nsid) { 3898 SPDK_ERRLOG("ANA group ID %" PRIu32 " is invalid\n", anagrpid); 3899 return -EINVAL; 3900 } 3901 3902 listener = nvmf_subsystem_find_listener(subsystem, trid); 3903 if (!listener) { 3904 SPDK_ERRLOG("Unable to find listener.\n"); 3905 return -EINVAL; 3906 } 3907 3908 *ana_state = listener->ana_state[anagrpid - 1]; 3909 return 0; 3910 } 3911 3912 bool 3913 spdk_nvmf_subsystem_is_discovery(struct spdk_nvmf_subsystem *subsystem) 3914 { 3915 return subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT || 3916 subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY; 3917 } 3918 3919 bool 3920 nvmf_nqn_is_discovery(const char *nqn) 3921 { 3922 return strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN) == 0; 3923 } 3924