1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2016 Intel Corporation. All rights reserved. 3 * Copyright (c) 2018-2019, 2021 Mellanox Technologies LTD. All rights reserved. 4 * Copyright (c) 2021, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 */ 6 7 #include "spdk/stdinc.h" 8 9 #include "spdk/bdev.h" 10 #include "spdk/bit_array.h" 11 #include "spdk/thread.h" 12 #include "spdk/nvmf.h" 13 #include "spdk/endian.h" 14 #include "spdk/string.h" 15 #include "spdk/log.h" 16 #include "spdk_internal/usdt.h" 17 18 #include "nvmf_internal.h" 19 #include "transport.h" 20 21 SPDK_LOG_REGISTER_COMPONENT(nvmf) 22 23 #define SPDK_NVMF_DEFAULT_MAX_SUBSYSTEMS 1024 24 25 static TAILQ_HEAD(, spdk_nvmf_tgt) g_nvmf_tgts = TAILQ_HEAD_INITIALIZER(g_nvmf_tgts); 26 27 typedef void (*nvmf_qpair_disconnect_cpl)(void *ctx, int status); 28 29 /* supplied to a single call to nvmf_qpair_disconnect */ 30 struct nvmf_qpair_disconnect_ctx { 31 struct spdk_nvmf_qpair *qpair; 32 struct spdk_nvmf_ctrlr *ctrlr; 33 nvmf_qpair_disconnect_cb cb_fn; 34 struct spdk_thread *thread; 35 void *ctx; 36 uint16_t qid; 37 }; 38 39 /* 40 * There are several times when we need to iterate through the list of all qpairs and selectively delete them. 41 * In order to do this sequentially without overlap, we must provide a context to recover the next qpair from 42 * to enable calling nvmf_qpair_disconnect on the next desired qpair. 43 */ 44 struct nvmf_qpair_disconnect_many_ctx { 45 struct spdk_nvmf_subsystem *subsystem; 46 struct spdk_nvmf_poll_group *group; 47 spdk_nvmf_poll_group_mod_done cpl_fn; 48 void *cpl_ctx; 49 }; 50 51 static struct spdk_nvmf_referral * 52 nvmf_tgt_find_referral(struct spdk_nvmf_tgt *tgt, 53 const struct spdk_nvme_transport_id *trid) 54 { 55 struct spdk_nvmf_referral *referral; 56 57 TAILQ_FOREACH(referral, &tgt->referrals, link) { 58 if (spdk_nvme_transport_id_compare(&referral->trid, trid) == 0) { 59 return referral; 60 } 61 } 62 63 return NULL; 64 } 65 66 int 67 spdk_nvmf_tgt_add_referral(struct spdk_nvmf_tgt *tgt, 68 const struct spdk_nvmf_referral_opts *uopts) 69 { 70 struct spdk_nvmf_referral *referral; 71 struct spdk_nvmf_referral_opts opts = {}; 72 struct spdk_nvme_transport_id *trid = &opts.trid; 73 74 memcpy(&opts, uopts, spdk_min(uopts->size, sizeof(opts))); 75 if (trid->subnqn[0] == '\0') { 76 snprintf(trid->subnqn, sizeof(trid->subnqn), "%s", SPDK_NVMF_DISCOVERY_NQN); 77 } 78 79 if (!nvmf_nqn_is_valid(trid->subnqn)) { 80 SPDK_ERRLOG("Invalid subsystem NQN\n"); 81 return -EINVAL; 82 } 83 84 /* If the entry already exists, just ignore it. */ 85 if (nvmf_tgt_find_referral(tgt, trid)) { 86 return 0; 87 } 88 89 referral = calloc(1, sizeof(*referral)); 90 if (!referral) { 91 SPDK_ERRLOG("Failed to allocate memory for a referral\n"); 92 return -ENOMEM; 93 } 94 95 referral->entry.subtype = nvmf_nqn_is_discovery(trid->subnqn) ? 96 SPDK_NVMF_SUBTYPE_DISCOVERY : 97 SPDK_NVMF_SUBTYPE_NVME; 98 referral->entry.treq.secure_channel = opts.secure_channel ? 99 SPDK_NVMF_TREQ_SECURE_CHANNEL_REQUIRED : 100 SPDK_NVMF_TREQ_SECURE_CHANNEL_NOT_REQUIRED; 101 referral->entry.cntlid = 0xffff; 102 referral->entry.trtype = trid->trtype; 103 referral->entry.adrfam = trid->adrfam; 104 memcpy(&referral->trid, trid, sizeof(struct spdk_nvme_transport_id)); 105 spdk_strcpy_pad(referral->entry.subnqn, trid->subnqn, sizeof(trid->subnqn), '\0'); 106 spdk_strcpy_pad(referral->entry.trsvcid, trid->trsvcid, sizeof(referral->entry.trsvcid), ' '); 107 spdk_strcpy_pad(referral->entry.traddr, trid->traddr, sizeof(referral->entry.traddr), ' '); 108 109 TAILQ_INSERT_HEAD(&tgt->referrals, referral, link); 110 nvmf_update_discovery_log(tgt, NULL); 111 112 return 0; 113 } 114 115 int 116 spdk_nvmf_tgt_remove_referral(struct spdk_nvmf_tgt *tgt, 117 const struct spdk_nvmf_referral_opts *uopts) 118 { 119 struct spdk_nvmf_referral *referral; 120 struct spdk_nvmf_referral_opts opts = {}; 121 struct spdk_nvme_transport_id *trid = &opts.trid; 122 123 memcpy(&opts, uopts, spdk_min(uopts->size, sizeof(opts))); 124 if (trid->subnqn[0] == '\0') { 125 snprintf(trid->subnqn, sizeof(trid->subnqn), "%s", SPDK_NVMF_DISCOVERY_NQN); 126 } 127 128 referral = nvmf_tgt_find_referral(tgt, &opts.trid); 129 if (referral == NULL) { 130 return -ENOENT; 131 } 132 133 TAILQ_REMOVE(&tgt->referrals, referral, link); 134 nvmf_update_discovery_log(tgt, NULL); 135 136 free(referral); 137 138 return 0; 139 } 140 141 static void 142 nvmf_qpair_set_state(struct spdk_nvmf_qpair *qpair, 143 enum spdk_nvmf_qpair_state state) 144 { 145 assert(qpair != NULL); 146 assert(qpair->group->thread == spdk_get_thread()); 147 148 qpair->state = state; 149 } 150 151 static int 152 nvmf_poll_group_poll(void *ctx) 153 { 154 struct spdk_nvmf_poll_group *group = ctx; 155 int rc; 156 int count = 0; 157 struct spdk_nvmf_transport_poll_group *tgroup; 158 159 TAILQ_FOREACH(tgroup, &group->tgroups, link) { 160 rc = nvmf_transport_poll_group_poll(tgroup); 161 if (rc < 0) { 162 return SPDK_POLLER_BUSY; 163 } 164 count += rc; 165 } 166 167 return count > 0 ? SPDK_POLLER_BUSY : SPDK_POLLER_IDLE; 168 } 169 170 /* 171 * Reset and clean up the poll group (I/O channel code will actually free the 172 * group). 173 */ 174 static void 175 nvmf_tgt_cleanup_poll_group(struct spdk_nvmf_poll_group *group) 176 { 177 struct spdk_nvmf_transport_poll_group *tgroup, *tmp; 178 struct spdk_nvmf_subsystem_poll_group *sgroup; 179 uint32_t sid, nsid; 180 181 TAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp) { 182 TAILQ_REMOVE(&group->tgroups, tgroup, link); 183 nvmf_transport_poll_group_destroy(tgroup); 184 } 185 186 for (sid = 0; sid < group->num_sgroups; sid++) { 187 sgroup = &group->sgroups[sid]; 188 189 assert(sgroup != NULL); 190 191 for (nsid = 0; nsid < sgroup->num_ns; nsid++) { 192 if (sgroup->ns_info[nsid].channel) { 193 spdk_put_io_channel(sgroup->ns_info[nsid].channel); 194 sgroup->ns_info[nsid].channel = NULL; 195 } 196 } 197 198 free(sgroup->ns_info); 199 } 200 201 free(group->sgroups); 202 203 spdk_poller_unregister(&group->poller); 204 205 if (group->destroy_cb_fn) { 206 group->destroy_cb_fn(group->destroy_cb_arg, 0); 207 } 208 } 209 210 /* 211 * Callback to unregister a poll group from the target, and clean up its state. 212 */ 213 static void 214 nvmf_tgt_destroy_poll_group(void *io_device, void *ctx_buf) 215 { 216 struct spdk_nvmf_tgt *tgt = io_device; 217 struct spdk_nvmf_poll_group *group = ctx_buf; 218 219 SPDK_DTRACE_PROBE1_TICKS(nvmf_destroy_poll_group, spdk_thread_get_id(group->thread)); 220 221 pthread_mutex_lock(&tgt->mutex); 222 TAILQ_REMOVE(&tgt->poll_groups, group, link); 223 tgt->num_poll_groups--; 224 pthread_mutex_unlock(&tgt->mutex); 225 226 assert(!(tgt->state == NVMF_TGT_PAUSING || tgt->state == NVMF_TGT_RESUMING)); 227 nvmf_tgt_cleanup_poll_group(group); 228 } 229 230 static int 231 nvmf_poll_group_add_transport(struct spdk_nvmf_poll_group *group, 232 struct spdk_nvmf_transport *transport) 233 { 234 struct spdk_nvmf_transport_poll_group *tgroup; 235 236 TAILQ_FOREACH(tgroup, &group->tgroups, link) { 237 if (tgroup->transport == transport) { 238 /* Transport already in the poll group */ 239 return 0; 240 } 241 } 242 243 tgroup = nvmf_transport_poll_group_create(transport, group); 244 if (!tgroup) { 245 SPDK_ERRLOG("Unable to create poll group for transport\n"); 246 return -1; 247 } 248 SPDK_DTRACE_PROBE2_TICKS(nvmf_transport_poll_group_create, transport, 249 spdk_thread_get_id(group->thread)); 250 251 tgroup->group = group; 252 TAILQ_INSERT_TAIL(&group->tgroups, tgroup, link); 253 254 return 0; 255 } 256 257 static int 258 nvmf_tgt_create_poll_group(void *io_device, void *ctx_buf) 259 { 260 struct spdk_nvmf_tgt *tgt = io_device; 261 struct spdk_nvmf_poll_group *group = ctx_buf; 262 struct spdk_nvmf_transport *transport; 263 struct spdk_nvmf_subsystem *subsystem; 264 struct spdk_thread *thread = spdk_get_thread(); 265 int rc; 266 267 group->tgt = tgt; 268 TAILQ_INIT(&group->tgroups); 269 TAILQ_INIT(&group->qpairs); 270 group->thread = thread; 271 pthread_mutex_init(&group->mutex, NULL); 272 273 group->poller = SPDK_POLLER_REGISTER(nvmf_poll_group_poll, group, 0); 274 275 SPDK_DTRACE_PROBE1_TICKS(nvmf_create_poll_group, spdk_thread_get_id(thread)); 276 277 TAILQ_FOREACH(transport, &tgt->transports, link) { 278 rc = nvmf_poll_group_add_transport(group, transport); 279 if (rc != 0) { 280 nvmf_tgt_cleanup_poll_group(group); 281 return rc; 282 } 283 } 284 285 group->num_sgroups = tgt->max_subsystems; 286 group->sgroups = calloc(tgt->max_subsystems, sizeof(struct spdk_nvmf_subsystem_poll_group)); 287 if (!group->sgroups) { 288 nvmf_tgt_cleanup_poll_group(group); 289 return -ENOMEM; 290 } 291 292 for (subsystem = spdk_nvmf_subsystem_get_first(tgt); 293 subsystem != NULL; 294 subsystem = spdk_nvmf_subsystem_get_next(subsystem)) { 295 if (nvmf_poll_group_add_subsystem(group, subsystem, NULL, NULL) != 0) { 296 nvmf_tgt_cleanup_poll_group(group); 297 return -1; 298 } 299 } 300 301 pthread_mutex_lock(&tgt->mutex); 302 tgt->num_poll_groups++; 303 TAILQ_INSERT_TAIL(&tgt->poll_groups, group, link); 304 pthread_mutex_unlock(&tgt->mutex); 305 306 return 0; 307 } 308 309 static void 310 _nvmf_tgt_disconnect_qpairs(void *ctx) 311 { 312 struct spdk_nvmf_qpair *qpair, *qpair_tmp; 313 struct nvmf_qpair_disconnect_many_ctx *qpair_ctx = ctx; 314 struct spdk_nvmf_poll_group *group = qpair_ctx->group; 315 struct spdk_io_channel *ch; 316 int rc; 317 318 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, qpair_tmp) { 319 rc = spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 320 if (rc && rc != -EINPROGRESS) { 321 break; 322 } 323 } 324 325 if (TAILQ_EMPTY(&group->qpairs)) { 326 /* When the refcount from the channels reaches 0, nvmf_tgt_destroy_poll_group will be called. */ 327 ch = spdk_io_channel_from_ctx(group); 328 spdk_put_io_channel(ch); 329 free(qpair_ctx); 330 return; 331 } 332 333 /* Some qpairs are in process of being disconnected. Send a message and try to remove them again */ 334 spdk_thread_send_msg(spdk_get_thread(), _nvmf_tgt_disconnect_qpairs, ctx); 335 } 336 337 static void 338 nvmf_tgt_destroy_poll_group_qpairs(struct spdk_nvmf_poll_group *group) 339 { 340 struct nvmf_qpair_disconnect_many_ctx *ctx; 341 342 SPDK_DTRACE_PROBE1_TICKS(nvmf_destroy_poll_group_qpairs, spdk_thread_get_id(group->thread)); 343 344 ctx = calloc(1, sizeof(struct nvmf_qpair_disconnect_many_ctx)); 345 if (!ctx) { 346 SPDK_ERRLOG("Failed to allocate memory for destroy poll group ctx\n"); 347 return; 348 } 349 350 ctx->group = group; 351 _nvmf_tgt_disconnect_qpairs(ctx); 352 } 353 354 struct spdk_nvmf_tgt * 355 spdk_nvmf_tgt_create(struct spdk_nvmf_target_opts *opts) 356 { 357 struct spdk_nvmf_tgt *tgt, *tmp_tgt; 358 359 if (strnlen(opts->name, NVMF_TGT_NAME_MAX_LENGTH) == NVMF_TGT_NAME_MAX_LENGTH) { 360 SPDK_ERRLOG("Provided target name exceeds the max length of %u.\n", NVMF_TGT_NAME_MAX_LENGTH); 361 return NULL; 362 } 363 364 TAILQ_FOREACH(tmp_tgt, &g_nvmf_tgts, link) { 365 if (!strncmp(opts->name, tmp_tgt->name, NVMF_TGT_NAME_MAX_LENGTH)) { 366 SPDK_ERRLOG("Provided target name must be unique.\n"); 367 return NULL; 368 } 369 } 370 371 tgt = calloc(1, sizeof(*tgt)); 372 if (!tgt) { 373 return NULL; 374 } 375 376 snprintf(tgt->name, NVMF_TGT_NAME_MAX_LENGTH, "%s", opts->name); 377 378 if (!opts || !opts->max_subsystems) { 379 tgt->max_subsystems = SPDK_NVMF_DEFAULT_MAX_SUBSYSTEMS; 380 } else { 381 tgt->max_subsystems = opts->max_subsystems; 382 } 383 384 if (!opts) { 385 tgt->crdt[0] = 0; 386 tgt->crdt[1] = 0; 387 tgt->crdt[2] = 0; 388 } else { 389 tgt->crdt[0] = opts->crdt[0]; 390 tgt->crdt[1] = opts->crdt[1]; 391 tgt->crdt[2] = opts->crdt[2]; 392 } 393 394 if (!opts) { 395 tgt->discovery_filter = SPDK_NVMF_TGT_DISCOVERY_MATCH_ANY; 396 } else { 397 tgt->discovery_filter = opts->discovery_filter; 398 } 399 400 tgt->discovery_genctr = 0; 401 TAILQ_INIT(&tgt->transports); 402 TAILQ_INIT(&tgt->poll_groups); 403 TAILQ_INIT(&tgt->referrals); 404 tgt->num_poll_groups = 0; 405 406 tgt->subsystem_ids = spdk_bit_array_create(tgt->max_subsystems); 407 if (tgt->subsystem_ids == NULL) { 408 free(tgt); 409 return NULL; 410 } 411 412 RB_INIT(&tgt->subsystems); 413 414 pthread_mutex_init(&tgt->mutex, NULL); 415 416 spdk_io_device_register(tgt, 417 nvmf_tgt_create_poll_group, 418 nvmf_tgt_destroy_poll_group, 419 sizeof(struct spdk_nvmf_poll_group), 420 tgt->name); 421 422 tgt->state = NVMF_TGT_RUNNING; 423 424 TAILQ_INSERT_HEAD(&g_nvmf_tgts, tgt, link); 425 426 return tgt; 427 } 428 429 static void 430 _nvmf_tgt_destroy_next_transport(void *ctx) 431 { 432 struct spdk_nvmf_tgt *tgt = ctx; 433 struct spdk_nvmf_transport *transport; 434 435 if (!TAILQ_EMPTY(&tgt->transports)) { 436 transport = TAILQ_FIRST(&tgt->transports); 437 TAILQ_REMOVE(&tgt->transports, transport, link); 438 spdk_nvmf_transport_destroy(transport, _nvmf_tgt_destroy_next_transport, tgt); 439 } else { 440 spdk_nvmf_tgt_destroy_done_fn *destroy_cb_fn = tgt->destroy_cb_fn; 441 void *destroy_cb_arg = tgt->destroy_cb_arg; 442 443 pthread_mutex_destroy(&tgt->mutex); 444 free(tgt); 445 446 if (destroy_cb_fn) { 447 destroy_cb_fn(destroy_cb_arg, 0); 448 } 449 } 450 } 451 452 static void 453 nvmf_tgt_destroy_cb(void *io_device) 454 { 455 struct spdk_nvmf_tgt *tgt = io_device; 456 struct spdk_nvmf_subsystem *subsystem, *subsystem_next; 457 int rc; 458 struct spdk_nvmf_referral *referral; 459 460 while ((referral = TAILQ_FIRST(&tgt->referrals))) { 461 TAILQ_REMOVE(&tgt->referrals, referral, link); 462 free(referral); 463 } 464 465 /* We will be freeing subsystems in this loop, so we always need to get the next one 466 * ahead of time, since we can't call get_next() on a subsystem that's been freed. 467 */ 468 for (subsystem = spdk_nvmf_subsystem_get_first(tgt), 469 subsystem_next = spdk_nvmf_subsystem_get_next(subsystem); 470 subsystem != NULL; 471 subsystem = subsystem_next, 472 subsystem_next = spdk_nvmf_subsystem_get_next(subsystem_next)) { 473 nvmf_subsystem_remove_all_listeners(subsystem, true); 474 475 rc = spdk_nvmf_subsystem_destroy(subsystem, nvmf_tgt_destroy_cb, tgt); 476 if (rc) { 477 if (rc == -EINPROGRESS) { 478 /* If rc is -EINPROGRESS, nvmf_tgt_destroy_cb will be called again when subsystem #i 479 * is destroyed, nvmf_tgt_destroy_cb will continue to destroy other subsystems if any */ 480 return; 481 } else { 482 SPDK_ERRLOG("Failed to destroy subsystem %s, rc %d\n", subsystem->subnqn, rc); 483 } 484 } 485 } 486 spdk_bit_array_free(&tgt->subsystem_ids); 487 _nvmf_tgt_destroy_next_transport(tgt); 488 } 489 490 void 491 spdk_nvmf_tgt_destroy(struct spdk_nvmf_tgt *tgt, 492 spdk_nvmf_tgt_destroy_done_fn cb_fn, 493 void *cb_arg) 494 { 495 assert(!(tgt->state == NVMF_TGT_PAUSING || tgt->state == NVMF_TGT_RESUMING)); 496 497 tgt->destroy_cb_fn = cb_fn; 498 tgt->destroy_cb_arg = cb_arg; 499 500 TAILQ_REMOVE(&g_nvmf_tgts, tgt, link); 501 502 spdk_io_device_unregister(tgt, nvmf_tgt_destroy_cb); 503 } 504 505 const char * 506 spdk_nvmf_tgt_get_name(struct spdk_nvmf_tgt *tgt) 507 { 508 return tgt->name; 509 } 510 511 struct spdk_nvmf_tgt * 512 spdk_nvmf_get_tgt(const char *name) 513 { 514 struct spdk_nvmf_tgt *tgt; 515 uint32_t num_targets = 0; 516 517 TAILQ_FOREACH(tgt, &g_nvmf_tgts, link) { 518 if (name) { 519 if (!strncmp(tgt->name, name, NVMF_TGT_NAME_MAX_LENGTH)) { 520 return tgt; 521 } 522 } 523 num_targets++; 524 } 525 526 /* 527 * special case. If there is only one target and 528 * no name was specified, return the only available 529 * target. If there is more than one target, name must 530 * be specified. 531 */ 532 if (!name && num_targets == 1) { 533 return TAILQ_FIRST(&g_nvmf_tgts); 534 } 535 536 return NULL; 537 } 538 539 struct spdk_nvmf_tgt * 540 spdk_nvmf_get_first_tgt(void) 541 { 542 return TAILQ_FIRST(&g_nvmf_tgts); 543 } 544 545 struct spdk_nvmf_tgt * 546 spdk_nvmf_get_next_tgt(struct spdk_nvmf_tgt *prev) 547 { 548 return TAILQ_NEXT(prev, link); 549 } 550 551 static void 552 nvmf_write_nvme_subsystem_config(struct spdk_json_write_ctx *w, 553 struct spdk_nvmf_subsystem *subsystem) 554 { 555 struct spdk_nvmf_host *host; 556 struct spdk_nvmf_ns *ns; 557 struct spdk_nvmf_ns_opts ns_opts; 558 uint32_t max_namespaces; 559 struct spdk_nvmf_transport *transport; 560 561 assert(spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME); 562 563 /* { */ 564 spdk_json_write_object_begin(w); 565 spdk_json_write_named_string(w, "method", "nvmf_create_subsystem"); 566 567 /* "params" : { */ 568 spdk_json_write_named_object_begin(w, "params"); 569 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 570 spdk_json_write_named_bool(w, "allow_any_host", spdk_nvmf_subsystem_get_allow_any_host(subsystem)); 571 spdk_json_write_named_string(w, "serial_number", spdk_nvmf_subsystem_get_sn(subsystem)); 572 spdk_json_write_named_string(w, "model_number", spdk_nvmf_subsystem_get_mn(subsystem)); 573 574 max_namespaces = spdk_nvmf_subsystem_get_max_namespaces(subsystem); 575 if (max_namespaces != 0) { 576 spdk_json_write_named_uint32(w, "max_namespaces", max_namespaces); 577 } 578 579 spdk_json_write_named_uint32(w, "min_cntlid", spdk_nvmf_subsystem_get_min_cntlid(subsystem)); 580 spdk_json_write_named_uint32(w, "max_cntlid", spdk_nvmf_subsystem_get_max_cntlid(subsystem)); 581 spdk_json_write_named_bool(w, "ana_reporting", nvmf_subsystem_get_ana_reporting(subsystem)); 582 583 /* } "params" */ 584 spdk_json_write_object_end(w); 585 586 /* } */ 587 spdk_json_write_object_end(w); 588 589 for (host = spdk_nvmf_subsystem_get_first_host(subsystem); host != NULL; 590 host = spdk_nvmf_subsystem_get_next_host(subsystem, host)) { 591 592 spdk_json_write_object_begin(w); 593 spdk_json_write_named_string(w, "method", "nvmf_subsystem_add_host"); 594 595 /* "params" : { */ 596 spdk_json_write_named_object_begin(w, "params"); 597 598 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 599 spdk_json_write_named_string(w, "host", spdk_nvmf_host_get_nqn(host)); 600 601 TAILQ_FOREACH(transport, &subsystem->tgt->transports, link) { 602 if (transport->ops->subsystem_dump_host != NULL) { 603 transport->ops->subsystem_dump_host(transport, subsystem, host->nqn, w); 604 } 605 } 606 607 /* } "params" */ 608 spdk_json_write_object_end(w); 609 610 /* } */ 611 spdk_json_write_object_end(w); 612 } 613 614 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 615 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 616 spdk_nvmf_ns_get_opts(ns, &ns_opts, sizeof(ns_opts)); 617 618 spdk_json_write_object_begin(w); 619 spdk_json_write_named_string(w, "method", "nvmf_subsystem_add_ns"); 620 621 /* "params" : { */ 622 spdk_json_write_named_object_begin(w, "params"); 623 624 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 625 626 /* "namespace" : { */ 627 spdk_json_write_named_object_begin(w, "namespace"); 628 629 spdk_json_write_named_uint32(w, "nsid", spdk_nvmf_ns_get_id(ns)); 630 spdk_json_write_named_string(w, "bdev_name", spdk_bdev_get_name(spdk_nvmf_ns_get_bdev(ns))); 631 632 if (ns->ptpl_file != NULL) { 633 spdk_json_write_named_string(w, "ptpl_file", ns->ptpl_file); 634 } 635 636 if (!spdk_mem_all_zero(ns_opts.nguid, sizeof(ns_opts.nguid))) { 637 SPDK_STATIC_ASSERT(sizeof(ns_opts.nguid) == sizeof(uint64_t) * 2, "size mismatch"); 638 spdk_json_write_named_string_fmt(w, "nguid", "%016"PRIX64"%016"PRIX64, from_be64(&ns_opts.nguid[0]), 639 from_be64(&ns_opts.nguid[8])); 640 } 641 642 if (!spdk_mem_all_zero(ns_opts.eui64, sizeof(ns_opts.eui64))) { 643 SPDK_STATIC_ASSERT(sizeof(ns_opts.eui64) == sizeof(uint64_t), "size mismatch"); 644 spdk_json_write_named_string_fmt(w, "eui64", "%016"PRIX64, from_be64(&ns_opts.eui64)); 645 } 646 647 if (!spdk_uuid_is_null(&ns_opts.uuid)) { 648 spdk_json_write_named_uuid(w, "uuid", &ns_opts.uuid); 649 } 650 651 if (nvmf_subsystem_get_ana_reporting(subsystem)) { 652 spdk_json_write_named_uint32(w, "anagrpid", ns_opts.anagrpid); 653 } 654 655 /* "namespace" */ 656 spdk_json_write_object_end(w); 657 658 /* } "params" */ 659 spdk_json_write_object_end(w); 660 661 /* } */ 662 spdk_json_write_object_end(w); 663 } 664 } 665 666 static void 667 nvmf_write_subsystem_config_json(struct spdk_json_write_ctx *w, 668 struct spdk_nvmf_subsystem *subsystem) 669 { 670 struct spdk_nvmf_subsystem_listener *listener; 671 struct spdk_nvmf_transport *transport; 672 const struct spdk_nvme_transport_id *trid; 673 674 if (spdk_nvmf_subsystem_get_type(subsystem) == SPDK_NVMF_SUBTYPE_NVME) { 675 nvmf_write_nvme_subsystem_config(w, subsystem); 676 } 677 678 for (listener = spdk_nvmf_subsystem_get_first_listener(subsystem); listener != NULL; 679 listener = spdk_nvmf_subsystem_get_next_listener(subsystem, listener)) { 680 transport = listener->transport; 681 trid = spdk_nvmf_subsystem_listener_get_trid(listener); 682 683 spdk_json_write_object_begin(w); 684 spdk_json_write_named_string(w, "method", "nvmf_subsystem_add_listener"); 685 686 /* "params" : { */ 687 spdk_json_write_named_object_begin(w, "params"); 688 689 spdk_json_write_named_string(w, "nqn", spdk_nvmf_subsystem_get_nqn(subsystem)); 690 691 spdk_json_write_named_object_begin(w, "listen_address"); 692 nvmf_transport_listen_dump_trid(trid, w); 693 spdk_json_write_object_end(w); 694 if (transport->ops->listen_dump_opts) { 695 transport->ops->listen_dump_opts(transport, trid, w); 696 } 697 698 spdk_json_write_named_bool(w, "secure_channel", listener->opts.secure_channel); 699 700 /* } "params" */ 701 spdk_json_write_object_end(w); 702 703 /* } */ 704 spdk_json_write_object_end(w); 705 } 706 } 707 708 void 709 spdk_nvmf_tgt_write_config_json(struct spdk_json_write_ctx *w, struct spdk_nvmf_tgt *tgt) 710 { 711 struct spdk_nvmf_subsystem *subsystem; 712 struct spdk_nvmf_transport *transport; 713 struct spdk_nvmf_referral *referral; 714 715 spdk_json_write_object_begin(w); 716 spdk_json_write_named_string(w, "method", "nvmf_set_max_subsystems"); 717 718 spdk_json_write_named_object_begin(w, "params"); 719 spdk_json_write_named_uint32(w, "max_subsystems", tgt->max_subsystems); 720 spdk_json_write_object_end(w); 721 722 spdk_json_write_object_end(w); 723 724 spdk_json_write_object_begin(w); 725 spdk_json_write_named_string(w, "method", "nvmf_set_crdt"); 726 spdk_json_write_named_object_begin(w, "params"); 727 spdk_json_write_named_uint32(w, "crdt1", tgt->crdt[0]); 728 spdk_json_write_named_uint32(w, "crdt2", tgt->crdt[1]); 729 spdk_json_write_named_uint32(w, "crdt3", tgt->crdt[2]); 730 spdk_json_write_object_end(w); 731 spdk_json_write_object_end(w); 732 733 /* write transports */ 734 TAILQ_FOREACH(transport, &tgt->transports, link) { 735 spdk_json_write_object_begin(w); 736 spdk_json_write_named_string(w, "method", "nvmf_create_transport"); 737 nvmf_transport_dump_opts(transport, w, true); 738 spdk_json_write_object_end(w); 739 } 740 741 TAILQ_FOREACH(referral, &tgt->referrals, link) { 742 spdk_json_write_object_begin(w); 743 spdk_json_write_named_string(w, "method", "nvmf_discovery_add_referral"); 744 745 spdk_json_write_named_object_begin(w, "params"); 746 spdk_json_write_named_object_begin(w, "address"); 747 nvmf_transport_listen_dump_trid(&referral->trid, w); 748 spdk_json_write_object_end(w); 749 spdk_json_write_named_bool(w, "secure_channel", 750 referral->entry.treq.secure_channel == 751 SPDK_NVMF_TREQ_SECURE_CHANNEL_REQUIRED); 752 spdk_json_write_named_string(w, "subnqn", referral->trid.subnqn); 753 spdk_json_write_object_end(w); 754 755 spdk_json_write_object_end(w); 756 } 757 758 subsystem = spdk_nvmf_subsystem_get_first(tgt); 759 while (subsystem) { 760 nvmf_write_subsystem_config_json(w, subsystem); 761 subsystem = spdk_nvmf_subsystem_get_next(subsystem); 762 } 763 } 764 765 static void 766 nvmf_listen_opts_copy(struct spdk_nvmf_listen_opts *opts, 767 const struct spdk_nvmf_listen_opts *opts_src, size_t opts_size) 768 { 769 assert(opts); 770 assert(opts_src); 771 772 opts->opts_size = opts_size; 773 774 #define SET_FIELD(field) \ 775 if (offsetof(struct spdk_nvmf_listen_opts, field) + sizeof(opts->field) <= opts_size) { \ 776 opts->field = opts_src->field; \ 777 } \ 778 779 SET_FIELD(transport_specific); 780 SET_FIELD(secure_channel); 781 SET_FIELD(ana_state); 782 #undef SET_FIELD 783 784 /* Do not remove this statement, you should always update this statement when you adding a new field, 785 * and do not forget to add the SET_FIELD statement for your added field. */ 786 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_listen_opts) == 24, "Incorrect size"); 787 } 788 789 void 790 spdk_nvmf_listen_opts_init(struct spdk_nvmf_listen_opts *opts, size_t opts_size) 791 { 792 struct spdk_nvmf_listen_opts opts_local = {}; 793 794 /* local version of opts should have defaults set here */ 795 opts_local.ana_state = SPDK_NVME_ANA_OPTIMIZED_STATE; 796 nvmf_listen_opts_copy(opts, &opts_local, opts_size); 797 } 798 799 int 800 spdk_nvmf_tgt_listen_ext(struct spdk_nvmf_tgt *tgt, const struct spdk_nvme_transport_id *trid, 801 struct spdk_nvmf_listen_opts *opts) 802 { 803 struct spdk_nvmf_transport *transport; 804 int rc; 805 struct spdk_nvmf_listen_opts opts_local = {}; 806 807 if (!opts) { 808 SPDK_ERRLOG("opts should not be NULL\n"); 809 return -EINVAL; 810 } 811 812 if (!opts->opts_size) { 813 SPDK_ERRLOG("The opts_size in opts structure should not be zero\n"); 814 return -EINVAL; 815 } 816 817 transport = spdk_nvmf_tgt_get_transport(tgt, trid->trstring); 818 if (!transport) { 819 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 820 trid->trstring); 821 return -EINVAL; 822 } 823 824 nvmf_listen_opts_copy(&opts_local, opts, opts->opts_size); 825 rc = spdk_nvmf_transport_listen(transport, trid, &opts_local); 826 if (rc < 0) { 827 SPDK_ERRLOG("Unable to listen on address '%s'\n", trid->traddr); 828 } 829 830 return rc; 831 } 832 833 int 834 spdk_nvmf_tgt_stop_listen(struct spdk_nvmf_tgt *tgt, 835 struct spdk_nvme_transport_id *trid) 836 { 837 struct spdk_nvmf_transport *transport; 838 int rc; 839 840 transport = spdk_nvmf_tgt_get_transport(tgt, trid->trstring); 841 if (!transport) { 842 SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n", 843 trid->trstring); 844 return -EINVAL; 845 } 846 847 rc = spdk_nvmf_transport_stop_listen(transport, trid); 848 if (rc < 0) { 849 SPDK_ERRLOG("Failed to stop listening on address '%s'\n", trid->traddr); 850 return rc; 851 } 852 return 0; 853 } 854 855 struct spdk_nvmf_tgt_add_transport_ctx { 856 struct spdk_nvmf_tgt *tgt; 857 struct spdk_nvmf_transport *transport; 858 spdk_nvmf_tgt_add_transport_done_fn cb_fn; 859 void *cb_arg; 860 int status; 861 }; 862 863 static void 864 _nvmf_tgt_remove_transport_done(struct spdk_io_channel_iter *i, int status) 865 { 866 struct spdk_nvmf_tgt_add_transport_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 867 868 ctx->cb_fn(ctx->cb_arg, ctx->status); 869 free(ctx); 870 } 871 872 static void 873 _nvmf_tgt_remove_transport(struct spdk_io_channel_iter *i) 874 { 875 struct spdk_nvmf_tgt_add_transport_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 876 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 877 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 878 struct spdk_nvmf_transport_poll_group *tgroup, *tmp; 879 880 TAILQ_FOREACH_SAFE(tgroup, &group->tgroups, link, tmp) { 881 if (tgroup->transport == ctx->transport) { 882 TAILQ_REMOVE(&group->tgroups, tgroup, link); 883 nvmf_transport_poll_group_destroy(tgroup); 884 } 885 } 886 887 spdk_for_each_channel_continue(i, 0); 888 } 889 890 static void 891 _nvmf_tgt_add_transport_done(struct spdk_io_channel_iter *i, int status) 892 { 893 struct spdk_nvmf_tgt_add_transport_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 894 895 if (status) { 896 ctx->status = status; 897 spdk_for_each_channel(ctx->tgt, 898 _nvmf_tgt_remove_transport, 899 ctx, 900 _nvmf_tgt_remove_transport_done); 901 return; 902 } 903 904 ctx->transport->tgt = ctx->tgt; 905 TAILQ_INSERT_TAIL(&ctx->tgt->transports, ctx->transport, link); 906 ctx->cb_fn(ctx->cb_arg, status); 907 free(ctx); 908 } 909 910 static void 911 _nvmf_tgt_add_transport(struct spdk_io_channel_iter *i) 912 { 913 struct spdk_nvmf_tgt_add_transport_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 914 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 915 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 916 int rc; 917 918 rc = nvmf_poll_group_add_transport(group, ctx->transport); 919 spdk_for_each_channel_continue(i, rc); 920 } 921 922 void 923 spdk_nvmf_tgt_add_transport(struct spdk_nvmf_tgt *tgt, 924 struct spdk_nvmf_transport *transport, 925 spdk_nvmf_tgt_add_transport_done_fn cb_fn, 926 void *cb_arg) 927 { 928 struct spdk_nvmf_tgt_add_transport_ctx *ctx; 929 930 SPDK_DTRACE_PROBE2_TICKS(nvmf_tgt_add_transport, transport, tgt->name); 931 932 if (spdk_nvmf_tgt_get_transport(tgt, transport->ops->name)) { 933 cb_fn(cb_arg, -EEXIST); 934 return; /* transport already created */ 935 } 936 937 ctx = calloc(1, sizeof(*ctx)); 938 if (!ctx) { 939 cb_fn(cb_arg, -ENOMEM); 940 return; 941 } 942 943 ctx->tgt = tgt; 944 ctx->transport = transport; 945 ctx->cb_fn = cb_fn; 946 ctx->cb_arg = cb_arg; 947 948 spdk_for_each_channel(tgt, 949 _nvmf_tgt_add_transport, 950 ctx, 951 _nvmf_tgt_add_transport_done); 952 } 953 954 struct nvmf_tgt_pause_ctx { 955 struct spdk_nvmf_tgt *tgt; 956 spdk_nvmf_tgt_pause_polling_cb_fn cb_fn; 957 void *cb_arg; 958 }; 959 960 static void 961 _nvmf_tgt_pause_polling_done(struct spdk_io_channel_iter *i, int status) 962 { 963 struct nvmf_tgt_pause_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 964 965 ctx->tgt->state = NVMF_TGT_PAUSED; 966 967 ctx->cb_fn(ctx->cb_arg, status); 968 free(ctx); 969 } 970 971 static void 972 _nvmf_tgt_pause_polling(struct spdk_io_channel_iter *i) 973 { 974 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 975 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 976 977 spdk_poller_unregister(&group->poller); 978 979 spdk_for_each_channel_continue(i, 0); 980 } 981 982 int 983 spdk_nvmf_tgt_pause_polling(struct spdk_nvmf_tgt *tgt, spdk_nvmf_tgt_pause_polling_cb_fn cb_fn, 984 void *cb_arg) 985 { 986 struct nvmf_tgt_pause_ctx *ctx; 987 988 SPDK_DTRACE_PROBE2_TICKS(nvmf_tgt_pause_polling, tgt, tgt->name); 989 990 switch (tgt->state) { 991 case NVMF_TGT_PAUSING: 992 case NVMF_TGT_RESUMING: 993 return -EBUSY; 994 case NVMF_TGT_RUNNING: 995 break; 996 default: 997 return -EINVAL; 998 } 999 1000 ctx = calloc(1, sizeof(*ctx)); 1001 if (!ctx) { 1002 return -ENOMEM; 1003 } 1004 1005 1006 tgt->state = NVMF_TGT_PAUSING; 1007 1008 ctx->tgt = tgt; 1009 ctx->cb_fn = cb_fn; 1010 ctx->cb_arg = cb_arg; 1011 1012 spdk_for_each_channel(tgt, 1013 _nvmf_tgt_pause_polling, 1014 ctx, 1015 _nvmf_tgt_pause_polling_done); 1016 return 0; 1017 } 1018 1019 static void 1020 _nvmf_tgt_resume_polling_done(struct spdk_io_channel_iter *i, int status) 1021 { 1022 struct nvmf_tgt_pause_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 1023 1024 ctx->tgt->state = NVMF_TGT_RUNNING; 1025 1026 ctx->cb_fn(ctx->cb_arg, status); 1027 free(ctx); 1028 } 1029 1030 static void 1031 _nvmf_tgt_resume_polling(struct spdk_io_channel_iter *i) 1032 { 1033 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 1034 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 1035 1036 assert(group->poller == NULL); 1037 group->poller = SPDK_POLLER_REGISTER(nvmf_poll_group_poll, group, 0); 1038 1039 spdk_for_each_channel_continue(i, 0); 1040 } 1041 1042 int 1043 spdk_nvmf_tgt_resume_polling(struct spdk_nvmf_tgt *tgt, spdk_nvmf_tgt_resume_polling_cb_fn cb_fn, 1044 void *cb_arg) 1045 { 1046 struct nvmf_tgt_pause_ctx *ctx; 1047 1048 SPDK_DTRACE_PROBE2_TICKS(nvmf_tgt_resume_polling, tgt, tgt->name); 1049 1050 switch (tgt->state) { 1051 case NVMF_TGT_PAUSING: 1052 case NVMF_TGT_RESUMING: 1053 return -EBUSY; 1054 case NVMF_TGT_PAUSED: 1055 break; 1056 default: 1057 return -EINVAL; 1058 } 1059 1060 ctx = calloc(1, sizeof(*ctx)); 1061 if (!ctx) { 1062 return -ENOMEM; 1063 } 1064 1065 tgt->state = NVMF_TGT_RESUMING; 1066 1067 ctx->tgt = tgt; 1068 ctx->cb_fn = cb_fn; 1069 ctx->cb_arg = cb_arg; 1070 1071 spdk_for_each_channel(tgt, 1072 _nvmf_tgt_resume_polling, 1073 ctx, 1074 _nvmf_tgt_resume_polling_done); 1075 return 0; 1076 } 1077 1078 struct spdk_nvmf_subsystem * 1079 spdk_nvmf_tgt_find_subsystem(struct spdk_nvmf_tgt *tgt, const char *subnqn) 1080 { 1081 struct spdk_nvmf_subsystem subsystem; 1082 1083 if (!subnqn) { 1084 return NULL; 1085 } 1086 1087 /* Ensure that subnqn is null terminated */ 1088 if (!memchr(subnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1)) { 1089 SPDK_ERRLOG("Connect SUBNQN is not null terminated\n"); 1090 return NULL; 1091 } 1092 1093 snprintf(subsystem.subnqn, sizeof(subsystem.subnqn), "%s", subnqn); 1094 return RB_FIND(subsystem_tree, &tgt->subsystems, &subsystem); 1095 } 1096 1097 struct spdk_nvmf_transport * 1098 spdk_nvmf_tgt_get_transport(struct spdk_nvmf_tgt *tgt, const char *transport_name) 1099 { 1100 struct spdk_nvmf_transport *transport; 1101 1102 TAILQ_FOREACH(transport, &tgt->transports, link) { 1103 if (!strncasecmp(transport->ops->name, transport_name, SPDK_NVMF_TRSTRING_MAX_LEN)) { 1104 return transport; 1105 } 1106 } 1107 return NULL; 1108 } 1109 1110 struct nvmf_new_qpair_ctx { 1111 struct spdk_nvmf_qpair *qpair; 1112 struct spdk_nvmf_poll_group *group; 1113 }; 1114 1115 static void 1116 _nvmf_poll_group_add(void *_ctx) 1117 { 1118 struct nvmf_new_qpair_ctx *ctx = _ctx; 1119 struct spdk_nvmf_qpair *qpair = ctx->qpair; 1120 struct spdk_nvmf_poll_group *group = ctx->group; 1121 1122 free(_ctx); 1123 1124 if (spdk_nvmf_poll_group_add(group, qpair) != 0) { 1125 SPDK_ERRLOG("Unable to add the qpair to a poll group.\n"); 1126 spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 1127 } 1128 } 1129 1130 void 1131 spdk_nvmf_tgt_new_qpair(struct spdk_nvmf_tgt *tgt, struct spdk_nvmf_qpair *qpair) 1132 { 1133 struct spdk_nvmf_poll_group *group; 1134 struct nvmf_new_qpair_ctx *ctx; 1135 1136 group = spdk_nvmf_get_optimal_poll_group(qpair); 1137 if (group == NULL) { 1138 if (tgt->next_poll_group == NULL) { 1139 tgt->next_poll_group = TAILQ_FIRST(&tgt->poll_groups); 1140 if (tgt->next_poll_group == NULL) { 1141 SPDK_ERRLOG("No poll groups exist.\n"); 1142 spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 1143 return; 1144 } 1145 } 1146 group = tgt->next_poll_group; 1147 tgt->next_poll_group = TAILQ_NEXT(group, link); 1148 } 1149 1150 ctx = calloc(1, sizeof(*ctx)); 1151 if (!ctx) { 1152 SPDK_ERRLOG("Unable to send message to poll group.\n"); 1153 spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 1154 return; 1155 } 1156 1157 ctx->qpair = qpair; 1158 ctx->group = group; 1159 1160 pthread_mutex_lock(&group->mutex); 1161 group->current_unassociated_qpairs++; 1162 pthread_mutex_unlock(&group->mutex); 1163 1164 spdk_thread_send_msg(group->thread, _nvmf_poll_group_add, ctx); 1165 } 1166 1167 struct spdk_nvmf_poll_group * 1168 spdk_nvmf_poll_group_create(struct spdk_nvmf_tgt *tgt) 1169 { 1170 struct spdk_io_channel *ch; 1171 1172 ch = spdk_get_io_channel(tgt); 1173 if (!ch) { 1174 SPDK_ERRLOG("Unable to get I/O channel for target\n"); 1175 return NULL; 1176 } 1177 1178 return spdk_io_channel_get_ctx(ch); 1179 } 1180 1181 void 1182 spdk_nvmf_poll_group_destroy(struct spdk_nvmf_poll_group *group, 1183 spdk_nvmf_poll_group_destroy_done_fn cb_fn, 1184 void *cb_arg) 1185 { 1186 assert(group->destroy_cb_fn == NULL); 1187 group->destroy_cb_fn = cb_fn; 1188 group->destroy_cb_arg = cb_arg; 1189 1190 /* This function will put the io_channel associated with this poll group */ 1191 nvmf_tgt_destroy_poll_group_qpairs(group); 1192 } 1193 1194 int 1195 spdk_nvmf_poll_group_add(struct spdk_nvmf_poll_group *group, 1196 struct spdk_nvmf_qpair *qpair) 1197 { 1198 int rc = -1; 1199 struct spdk_nvmf_transport_poll_group *tgroup; 1200 1201 TAILQ_INIT(&qpair->outstanding); 1202 qpair->group = group; 1203 qpair->ctrlr = NULL; 1204 qpair->disconnect_started = false; 1205 1206 TAILQ_FOREACH(tgroup, &group->tgroups, link) { 1207 if (tgroup->transport == qpair->transport) { 1208 rc = nvmf_transport_poll_group_add(tgroup, qpair); 1209 break; 1210 } 1211 } 1212 1213 /* We add the qpair to the group only it is successfully added into the tgroup */ 1214 if (rc == 0) { 1215 SPDK_DTRACE_PROBE2_TICKS(nvmf_poll_group_add_qpair, qpair, spdk_thread_get_id(group->thread)); 1216 TAILQ_INSERT_TAIL(&group->qpairs, qpair, link); 1217 nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_ACTIVE); 1218 } 1219 1220 return rc; 1221 } 1222 1223 static void 1224 _nvmf_ctrlr_destruct(void *ctx) 1225 { 1226 struct spdk_nvmf_ctrlr *ctrlr = ctx; 1227 1228 nvmf_ctrlr_destruct(ctrlr); 1229 } 1230 1231 static void 1232 _nvmf_ctrlr_free_from_qpair(void *ctx) 1233 { 1234 struct nvmf_qpair_disconnect_ctx *qpair_ctx = ctx; 1235 struct spdk_nvmf_ctrlr *ctrlr = qpair_ctx->ctrlr; 1236 uint32_t count; 1237 1238 spdk_bit_array_clear(ctrlr->qpair_mask, qpair_ctx->qid); 1239 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 1240 if (count == 0) { 1241 assert(!ctrlr->in_destruct); 1242 SPDK_DEBUGLOG(nvmf, "Last qpair %u, destroy ctrlr 0x%hx\n", qpair_ctx->qid, ctrlr->cntlid); 1243 ctrlr->in_destruct = true; 1244 spdk_thread_send_msg(ctrlr->subsys->thread, _nvmf_ctrlr_destruct, ctrlr); 1245 } 1246 free(qpair_ctx); 1247 } 1248 1249 static void 1250 _nvmf_transport_qpair_fini_complete(void *cb_ctx) 1251 { 1252 struct nvmf_qpair_disconnect_ctx *qpair_ctx = cb_ctx; 1253 struct spdk_nvmf_ctrlr *ctrlr; 1254 /* Store cb args since cb_ctx can be freed in _nvmf_ctrlr_free_from_qpair */ 1255 nvmf_qpair_disconnect_cb cb_fn = qpair_ctx->cb_fn; 1256 void *cb_arg = qpair_ctx->ctx; 1257 struct spdk_thread *cb_thread = qpair_ctx->thread; 1258 1259 ctrlr = qpair_ctx->ctrlr; 1260 SPDK_DEBUGLOG(nvmf, "Finish destroying qid %u\n", qpair_ctx->qid); 1261 1262 if (ctrlr) { 1263 if (qpair_ctx->qid == 0) { 1264 /* Admin qpair is removed, so set the pointer to NULL. 1265 * This operation is safe since we are on ctrlr thread now, admin qpair's thread is the same 1266 * as controller's thread */ 1267 assert(ctrlr->thread == spdk_get_thread()); 1268 ctrlr->admin_qpair = NULL; 1269 } 1270 /* Free qpair id from controller's bit mask and destroy the controller if it is the last qpair */ 1271 if (ctrlr->thread) { 1272 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_free_from_qpair, qpair_ctx); 1273 } else { 1274 _nvmf_ctrlr_free_from_qpair(qpair_ctx); 1275 } 1276 } else { 1277 free(qpair_ctx); 1278 } 1279 1280 if (cb_fn) { 1281 spdk_thread_send_msg(cb_thread, cb_fn, cb_arg); 1282 } 1283 } 1284 1285 void 1286 spdk_nvmf_poll_group_remove(struct spdk_nvmf_qpair *qpair) 1287 { 1288 struct spdk_nvmf_transport_poll_group *tgroup; 1289 int rc; 1290 1291 SPDK_DTRACE_PROBE2_TICKS(nvmf_poll_group_remove_qpair, qpair, 1292 spdk_thread_get_id(qpair->group->thread)); 1293 nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_ERROR); 1294 1295 /* Find the tgroup and remove the qpair from the tgroup */ 1296 TAILQ_FOREACH(tgroup, &qpair->group->tgroups, link) { 1297 if (tgroup->transport == qpair->transport) { 1298 rc = nvmf_transport_poll_group_remove(tgroup, qpair); 1299 if (rc && (rc != ENOTSUP)) { 1300 SPDK_ERRLOG("Cannot remove qpair=%p from transport group=%p\n", 1301 qpair, tgroup); 1302 } 1303 break; 1304 } 1305 } 1306 1307 TAILQ_REMOVE(&qpair->group->qpairs, qpair, link); 1308 qpair->group = NULL; 1309 } 1310 1311 static void 1312 _nvmf_qpair_sgroup_req_clean(struct spdk_nvmf_subsystem_poll_group *sgroup, 1313 const struct spdk_nvmf_qpair *qpair) 1314 { 1315 struct spdk_nvmf_request *req, *tmp; 1316 TAILQ_FOREACH_SAFE(req, &sgroup->queued, link, tmp) { 1317 if (req->qpair == qpair) { 1318 TAILQ_REMOVE(&sgroup->queued, req, link); 1319 if (nvmf_transport_req_free(req)) { 1320 SPDK_ERRLOG("Transport request free error!\n"); 1321 } 1322 } 1323 } 1324 } 1325 1326 static void 1327 _nvmf_qpair_destroy(void *ctx, int status) 1328 { 1329 struct nvmf_qpair_disconnect_ctx *qpair_ctx = ctx; 1330 struct spdk_nvmf_qpair *qpair = qpair_ctx->qpair; 1331 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1332 struct spdk_nvmf_subsystem_poll_group *sgroup; 1333 uint32_t sid; 1334 1335 assert(qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING); 1336 qpair_ctx->qid = qpair->qid; 1337 1338 if (qpair->connect_received) { 1339 if (0 == qpair->qid) { 1340 assert(qpair->group->stat.current_admin_qpairs > 0); 1341 qpair->group->stat.current_admin_qpairs--; 1342 } else { 1343 assert(qpair->group->stat.current_io_qpairs > 0); 1344 qpair->group->stat.current_io_qpairs--; 1345 } 1346 } else { 1347 pthread_mutex_lock(&qpair->group->mutex); 1348 qpair->group->current_unassociated_qpairs--; 1349 pthread_mutex_unlock(&qpair->group->mutex); 1350 } 1351 1352 if (ctrlr) { 1353 sgroup = &qpair->group->sgroups[ctrlr->subsys->id]; 1354 _nvmf_qpair_sgroup_req_clean(sgroup, qpair); 1355 } else { 1356 for (sid = 0; sid < qpair->group->num_sgroups; sid++) { 1357 sgroup = &qpair->group->sgroups[sid]; 1358 assert(sgroup != NULL); 1359 _nvmf_qpair_sgroup_req_clean(sgroup, qpair); 1360 } 1361 } 1362 1363 qpair_ctx->ctrlr = ctrlr; 1364 spdk_nvmf_poll_group_remove(qpair); 1365 nvmf_transport_qpair_fini(qpair, _nvmf_transport_qpair_fini_complete, qpair_ctx); 1366 } 1367 1368 static void 1369 _nvmf_qpair_disconnect_msg(void *ctx) 1370 { 1371 struct nvmf_qpair_disconnect_ctx *qpair_ctx = ctx; 1372 1373 spdk_nvmf_qpair_disconnect(qpair_ctx->qpair, qpair_ctx->cb_fn, qpair_ctx->ctx); 1374 free(ctx); 1375 } 1376 1377 SPDK_LOG_DEPRECATION_REGISTER(spdk_nvmf_qpair_disconnect, "cb_fn and ctx are deprecated", "v24.01", 1378 0); 1379 1380 int 1381 spdk_nvmf_qpair_disconnect(struct spdk_nvmf_qpair *qpair, nvmf_qpair_disconnect_cb cb_fn, void *ctx) 1382 { 1383 struct spdk_nvmf_poll_group *group = qpair->group; 1384 struct nvmf_qpair_disconnect_ctx *qpair_ctx; 1385 1386 if (__atomic_test_and_set(&qpair->disconnect_started, __ATOMIC_RELAXED)) { 1387 return -EINPROGRESS; 1388 } 1389 1390 if (cb_fn || ctx) { 1391 SPDK_LOG_DEPRECATED(spdk_nvmf_qpair_disconnect); 1392 } 1393 1394 /* If we get a qpair in the uninitialized state, we can just destroy it immediately */ 1395 if (qpair->state == SPDK_NVMF_QPAIR_UNINITIALIZED) { 1396 nvmf_transport_qpair_fini(qpair, NULL, NULL); 1397 if (cb_fn) { 1398 cb_fn(ctx); 1399 } 1400 return 0; 1401 } 1402 1403 assert(group != NULL); 1404 if (spdk_get_thread() != group->thread) { 1405 /* clear the atomic so we can set it on the next call on the proper thread. */ 1406 __atomic_clear(&qpair->disconnect_started, __ATOMIC_RELAXED); 1407 qpair_ctx = calloc(1, sizeof(struct nvmf_qpair_disconnect_ctx)); 1408 if (!qpair_ctx) { 1409 SPDK_ERRLOG("Unable to allocate context for nvmf_qpair_disconnect\n"); 1410 return -ENOMEM; 1411 } 1412 qpair_ctx->qpair = qpair; 1413 qpair_ctx->cb_fn = cb_fn; 1414 qpair_ctx->thread = group->thread; 1415 qpair_ctx->ctx = ctx; 1416 spdk_thread_send_msg(group->thread, _nvmf_qpair_disconnect_msg, qpair_ctx); 1417 return 0; 1418 } 1419 1420 SPDK_DTRACE_PROBE2_TICKS(nvmf_qpair_disconnect, qpair, spdk_thread_get_id(group->thread)); 1421 assert(qpair->state == SPDK_NVMF_QPAIR_ACTIVE); 1422 nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_DEACTIVATING); 1423 1424 qpair_ctx = calloc(1, sizeof(struct nvmf_qpair_disconnect_ctx)); 1425 if (!qpair_ctx) { 1426 SPDK_ERRLOG("Unable to allocate context for nvmf_qpair_disconnect\n"); 1427 return -ENOMEM; 1428 } 1429 1430 qpair_ctx->qpair = qpair; 1431 qpair_ctx->cb_fn = cb_fn; 1432 qpair_ctx->thread = group->thread; 1433 qpair_ctx->ctx = ctx; 1434 1435 /* Check for outstanding I/O */ 1436 if (!TAILQ_EMPTY(&qpair->outstanding)) { 1437 SPDK_DTRACE_PROBE2_TICKS(nvmf_poll_group_drain_qpair, qpair, spdk_thread_get_id(group->thread)); 1438 qpair->state_cb = _nvmf_qpair_destroy; 1439 qpair->state_cb_arg = qpair_ctx; 1440 nvmf_qpair_abort_pending_zcopy_reqs(qpair); 1441 nvmf_qpair_free_aer(qpair); 1442 return 0; 1443 } 1444 1445 _nvmf_qpair_destroy(qpair_ctx, 0); 1446 1447 return 0; 1448 } 1449 1450 int 1451 spdk_nvmf_qpair_get_peer_trid(struct spdk_nvmf_qpair *qpair, 1452 struct spdk_nvme_transport_id *trid) 1453 { 1454 memset(trid, 0, sizeof(*trid)); 1455 return nvmf_transport_qpair_get_peer_trid(qpair, trid); 1456 } 1457 1458 int 1459 spdk_nvmf_qpair_get_local_trid(struct spdk_nvmf_qpair *qpair, 1460 struct spdk_nvme_transport_id *trid) 1461 { 1462 memset(trid, 0, sizeof(*trid)); 1463 return nvmf_transport_qpair_get_local_trid(qpair, trid); 1464 } 1465 1466 int 1467 spdk_nvmf_qpair_get_listen_trid(struct spdk_nvmf_qpair *qpair, 1468 struct spdk_nvme_transport_id *trid) 1469 { 1470 memset(trid, 0, sizeof(*trid)); 1471 return nvmf_transport_qpair_get_listen_trid(qpair, trid); 1472 } 1473 1474 static int 1475 poll_group_update_subsystem(struct spdk_nvmf_poll_group *group, 1476 struct spdk_nvmf_subsystem *subsystem) 1477 { 1478 struct spdk_nvmf_subsystem_poll_group *sgroup; 1479 uint32_t new_num_ns, old_num_ns; 1480 uint32_t i, j; 1481 struct spdk_nvmf_ns *ns; 1482 struct spdk_nvmf_registrant *reg, *tmp; 1483 struct spdk_io_channel *ch; 1484 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 1485 struct spdk_nvmf_ctrlr *ctrlr; 1486 bool ns_changed; 1487 1488 /* Make sure our poll group has memory for this subsystem allocated */ 1489 if (subsystem->id >= group->num_sgroups) { 1490 return -ENOMEM; 1491 } 1492 1493 sgroup = &group->sgroups[subsystem->id]; 1494 1495 /* Make sure the array of namespace information is the correct size */ 1496 new_num_ns = subsystem->max_nsid; 1497 old_num_ns = sgroup->num_ns; 1498 1499 ns_changed = false; 1500 1501 if (old_num_ns == 0) { 1502 if (new_num_ns > 0) { 1503 /* First allocation */ 1504 sgroup->ns_info = calloc(new_num_ns, sizeof(struct spdk_nvmf_subsystem_pg_ns_info)); 1505 if (!sgroup->ns_info) { 1506 return -ENOMEM; 1507 } 1508 } 1509 } else if (new_num_ns > old_num_ns) { 1510 void *buf; 1511 1512 /* Make the array larger */ 1513 buf = realloc(sgroup->ns_info, new_num_ns * sizeof(struct spdk_nvmf_subsystem_pg_ns_info)); 1514 if (!buf) { 1515 return -ENOMEM; 1516 } 1517 1518 sgroup->ns_info = buf; 1519 1520 /* Null out the new namespace information slots */ 1521 for (i = old_num_ns; i < new_num_ns; i++) { 1522 memset(&sgroup->ns_info[i], 0, sizeof(struct spdk_nvmf_subsystem_pg_ns_info)); 1523 } 1524 } else if (new_num_ns < old_num_ns) { 1525 void *buf; 1526 1527 /* Free the extra I/O channels */ 1528 for (i = new_num_ns; i < old_num_ns; i++) { 1529 ns_info = &sgroup->ns_info[i]; 1530 1531 if (ns_info->channel) { 1532 spdk_put_io_channel(ns_info->channel); 1533 ns_info->channel = NULL; 1534 } 1535 } 1536 1537 /* Make the array smaller */ 1538 if (new_num_ns > 0) { 1539 buf = realloc(sgroup->ns_info, new_num_ns * sizeof(struct spdk_nvmf_subsystem_pg_ns_info)); 1540 if (!buf) { 1541 return -ENOMEM; 1542 } 1543 sgroup->ns_info = buf; 1544 } else { 1545 free(sgroup->ns_info); 1546 sgroup->ns_info = NULL; 1547 } 1548 } 1549 1550 sgroup->num_ns = new_num_ns; 1551 1552 /* Detect bdevs that were added or removed */ 1553 for (i = 0; i < sgroup->num_ns; i++) { 1554 ns = subsystem->ns[i]; 1555 ns_info = &sgroup->ns_info[i]; 1556 ch = ns_info->channel; 1557 1558 if (ns == NULL && ch == NULL) { 1559 /* Both NULL. Leave empty */ 1560 } else if (ns == NULL && ch != NULL) { 1561 /* There was a channel here, but the namespace is gone. */ 1562 ns_changed = true; 1563 spdk_put_io_channel(ch); 1564 ns_info->channel = NULL; 1565 } else if (ns != NULL && ch == NULL) { 1566 /* A namespace appeared but there is no channel yet */ 1567 ns_changed = true; 1568 ch = spdk_bdev_get_io_channel(ns->desc); 1569 if (ch == NULL) { 1570 SPDK_ERRLOG("Could not allocate I/O channel.\n"); 1571 return -ENOMEM; 1572 } 1573 ns_info->channel = ch; 1574 } else if (spdk_uuid_compare(&ns_info->uuid, spdk_bdev_get_uuid(ns->bdev)) != 0) { 1575 /* A namespace was here before, but was replaced by a new one. */ 1576 ns_changed = true; 1577 spdk_put_io_channel(ns_info->channel); 1578 memset(ns_info, 0, sizeof(*ns_info)); 1579 1580 ch = spdk_bdev_get_io_channel(ns->desc); 1581 if (ch == NULL) { 1582 SPDK_ERRLOG("Could not allocate I/O channel.\n"); 1583 return -ENOMEM; 1584 } 1585 ns_info->channel = ch; 1586 } else if (ns_info->num_blocks != spdk_bdev_get_num_blocks(ns->bdev)) { 1587 /* Namespace is still there but size has changed */ 1588 SPDK_DEBUGLOG(nvmf, "Namespace resized: subsystem_id %u," 1589 " nsid %u, pg %p, old %" PRIu64 ", new %" PRIu64 "\n", 1590 subsystem->id, 1591 ns->nsid, 1592 group, 1593 ns_info->num_blocks, 1594 spdk_bdev_get_num_blocks(ns->bdev)); 1595 ns_changed = true; 1596 } 1597 1598 if (ns == NULL) { 1599 memset(ns_info, 0, sizeof(*ns_info)); 1600 } else { 1601 ns_info->uuid = *spdk_bdev_get_uuid(ns->bdev); 1602 ns_info->num_blocks = spdk_bdev_get_num_blocks(ns->bdev); 1603 ns_info->crkey = ns->crkey; 1604 ns_info->rtype = ns->rtype; 1605 if (ns->holder) { 1606 ns_info->holder_id = ns->holder->hostid; 1607 } 1608 1609 memset(&ns_info->reg_hostid, 0, SPDK_NVMF_MAX_NUM_REGISTRANTS * sizeof(struct spdk_uuid)); 1610 j = 0; 1611 TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) { 1612 if (j >= SPDK_NVMF_MAX_NUM_REGISTRANTS) { 1613 SPDK_ERRLOG("Maximum %u registrants can support.\n", SPDK_NVMF_MAX_NUM_REGISTRANTS); 1614 return -EINVAL; 1615 } 1616 ns_info->reg_hostid[j++] = reg->hostid; 1617 } 1618 } 1619 } 1620 1621 if (ns_changed) { 1622 TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) { 1623 if (ctrlr->thread != spdk_get_thread()) { 1624 continue; 1625 } 1626 /* It is possible that a ctrlr was added but the admin_qpair hasn't been 1627 * assigned yet. 1628 */ 1629 if (!ctrlr->admin_qpair) { 1630 continue; 1631 } 1632 if (ctrlr->admin_qpair->group == group) { 1633 nvmf_ctrlr_async_event_ns_notice(ctrlr); 1634 nvmf_ctrlr_async_event_ana_change_notice(ctrlr); 1635 } 1636 } 1637 } 1638 1639 return 0; 1640 } 1641 1642 int 1643 nvmf_poll_group_update_subsystem(struct spdk_nvmf_poll_group *group, 1644 struct spdk_nvmf_subsystem *subsystem) 1645 { 1646 return poll_group_update_subsystem(group, subsystem); 1647 } 1648 1649 int 1650 nvmf_poll_group_add_subsystem(struct spdk_nvmf_poll_group *group, 1651 struct spdk_nvmf_subsystem *subsystem, 1652 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 1653 { 1654 int rc = 0; 1655 struct spdk_nvmf_subsystem_poll_group *sgroup = &group->sgroups[subsystem->id]; 1656 uint32_t i; 1657 1658 TAILQ_INIT(&sgroup->queued); 1659 1660 rc = poll_group_update_subsystem(group, subsystem); 1661 if (rc) { 1662 nvmf_poll_group_remove_subsystem(group, subsystem, NULL, NULL); 1663 goto fini; 1664 } 1665 1666 sgroup->state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 1667 1668 for (i = 0; i < sgroup->num_ns; i++) { 1669 sgroup->ns_info[i].state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 1670 } 1671 1672 fini: 1673 if (cb_fn) { 1674 cb_fn(cb_arg, rc); 1675 } 1676 1677 SPDK_DTRACE_PROBE2_TICKS(nvmf_poll_group_add_subsystem, spdk_thread_get_id(group->thread), 1678 subsystem->subnqn); 1679 1680 return rc; 1681 } 1682 1683 static void 1684 _nvmf_poll_group_remove_subsystem_cb(void *ctx, int status) 1685 { 1686 struct nvmf_qpair_disconnect_many_ctx *qpair_ctx = ctx; 1687 struct spdk_nvmf_subsystem *subsystem; 1688 struct spdk_nvmf_poll_group *group; 1689 struct spdk_nvmf_subsystem_poll_group *sgroup; 1690 spdk_nvmf_poll_group_mod_done cpl_fn = NULL; 1691 void *cpl_ctx = NULL; 1692 uint32_t nsid; 1693 1694 group = qpair_ctx->group; 1695 subsystem = qpair_ctx->subsystem; 1696 cpl_fn = qpair_ctx->cpl_fn; 1697 cpl_ctx = qpair_ctx->cpl_ctx; 1698 sgroup = &group->sgroups[subsystem->id]; 1699 1700 if (status) { 1701 goto fini; 1702 } 1703 1704 for (nsid = 0; nsid < sgroup->num_ns; nsid++) { 1705 if (sgroup->ns_info[nsid].channel) { 1706 spdk_put_io_channel(sgroup->ns_info[nsid].channel); 1707 sgroup->ns_info[nsid].channel = NULL; 1708 } 1709 } 1710 1711 sgroup->num_ns = 0; 1712 free(sgroup->ns_info); 1713 sgroup->ns_info = NULL; 1714 fini: 1715 free(qpair_ctx); 1716 if (cpl_fn) { 1717 cpl_fn(cpl_ctx, status); 1718 } 1719 } 1720 1721 static void nvmf_poll_group_remove_subsystem_msg(void *ctx); 1722 1723 static void 1724 nvmf_poll_group_remove_subsystem_msg(void *ctx) 1725 { 1726 struct spdk_nvmf_qpair *qpair, *qpair_tmp; 1727 struct spdk_nvmf_subsystem *subsystem; 1728 struct spdk_nvmf_poll_group *group; 1729 struct nvmf_qpair_disconnect_many_ctx *qpair_ctx = ctx; 1730 bool qpairs_found = false; 1731 int rc = 0; 1732 1733 group = qpair_ctx->group; 1734 subsystem = qpair_ctx->subsystem; 1735 1736 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, qpair_tmp) { 1737 if ((qpair->ctrlr != NULL) && (qpair->ctrlr->subsys == subsystem)) { 1738 qpairs_found = true; 1739 rc = spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 1740 if (rc && rc != -EINPROGRESS) { 1741 break; 1742 } 1743 } 1744 } 1745 1746 if (!qpairs_found) { 1747 _nvmf_poll_group_remove_subsystem_cb(ctx, 0); 1748 return; 1749 } 1750 1751 /* Some qpairs are in process of being disconnected. Send a message and try to remove them again */ 1752 spdk_thread_send_msg(spdk_get_thread(), nvmf_poll_group_remove_subsystem_msg, ctx); 1753 } 1754 1755 void 1756 nvmf_poll_group_remove_subsystem(struct spdk_nvmf_poll_group *group, 1757 struct spdk_nvmf_subsystem *subsystem, 1758 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 1759 { 1760 struct spdk_nvmf_subsystem_poll_group *sgroup; 1761 struct nvmf_qpair_disconnect_many_ctx *ctx; 1762 uint32_t i; 1763 1764 SPDK_DTRACE_PROBE3_TICKS(nvmf_poll_group_remove_subsystem, group, spdk_thread_get_id(group->thread), 1765 subsystem->subnqn); 1766 1767 ctx = calloc(1, sizeof(struct nvmf_qpair_disconnect_many_ctx)); 1768 if (!ctx) { 1769 SPDK_ERRLOG("Unable to allocate memory for context to remove poll subsystem\n"); 1770 if (cb_fn) { 1771 cb_fn(cb_arg, -1); 1772 } 1773 return; 1774 } 1775 1776 ctx->group = group; 1777 ctx->subsystem = subsystem; 1778 ctx->cpl_fn = cb_fn; 1779 ctx->cpl_ctx = cb_arg; 1780 1781 sgroup = &group->sgroups[subsystem->id]; 1782 sgroup->state = SPDK_NVMF_SUBSYSTEM_INACTIVE; 1783 1784 for (i = 0; i < sgroup->num_ns; i++) { 1785 sgroup->ns_info[i].state = SPDK_NVMF_SUBSYSTEM_INACTIVE; 1786 } 1787 1788 nvmf_poll_group_remove_subsystem_msg(ctx); 1789 } 1790 1791 void 1792 nvmf_poll_group_pause_subsystem(struct spdk_nvmf_poll_group *group, 1793 struct spdk_nvmf_subsystem *subsystem, 1794 uint32_t nsid, 1795 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 1796 { 1797 struct spdk_nvmf_subsystem_poll_group *sgroup; 1798 struct spdk_nvmf_subsystem_pg_ns_info *ns_info = NULL; 1799 int rc = 0; 1800 uint32_t i; 1801 1802 if (subsystem->id >= group->num_sgroups) { 1803 rc = -1; 1804 goto fini; 1805 } 1806 1807 sgroup = &group->sgroups[subsystem->id]; 1808 if (sgroup->state == SPDK_NVMF_SUBSYSTEM_PAUSED) { 1809 goto fini; 1810 } 1811 sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSING; 1812 1813 if (nsid == SPDK_NVME_GLOBAL_NS_TAG) { 1814 for (i = 0; i < sgroup->num_ns; i++) { 1815 ns_info = &sgroup->ns_info[i]; 1816 ns_info->state = SPDK_NVMF_SUBSYSTEM_PAUSING; 1817 } 1818 } else { 1819 /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */ 1820 if (nsid - 1 < sgroup->num_ns) { 1821 ns_info = &sgroup->ns_info[nsid - 1]; 1822 ns_info->state = SPDK_NVMF_SUBSYSTEM_PAUSING; 1823 } 1824 } 1825 1826 if (sgroup->mgmt_io_outstanding > 0) { 1827 assert(sgroup->cb_fn == NULL); 1828 sgroup->cb_fn = cb_fn; 1829 assert(sgroup->cb_arg == NULL); 1830 sgroup->cb_arg = cb_arg; 1831 return; 1832 } 1833 1834 if (nsid == SPDK_NVME_GLOBAL_NS_TAG) { 1835 for (i = 0; i < sgroup->num_ns; i++) { 1836 ns_info = &sgroup->ns_info[i]; 1837 1838 if (ns_info->io_outstanding > 0) { 1839 assert(sgroup->cb_fn == NULL); 1840 sgroup->cb_fn = cb_fn; 1841 assert(sgroup->cb_arg == NULL); 1842 sgroup->cb_arg = cb_arg; 1843 return; 1844 } 1845 } 1846 } else { 1847 if (ns_info != NULL && ns_info->io_outstanding > 0) { 1848 assert(sgroup->cb_fn == NULL); 1849 sgroup->cb_fn = cb_fn; 1850 assert(sgroup->cb_arg == NULL); 1851 sgroup->cb_arg = cb_arg; 1852 return; 1853 } 1854 } 1855 1856 assert(sgroup->mgmt_io_outstanding == 0); 1857 sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSED; 1858 fini: 1859 if (cb_fn) { 1860 cb_fn(cb_arg, rc); 1861 } 1862 } 1863 1864 void 1865 nvmf_poll_group_resume_subsystem(struct spdk_nvmf_poll_group *group, 1866 struct spdk_nvmf_subsystem *subsystem, 1867 spdk_nvmf_poll_group_mod_done cb_fn, void *cb_arg) 1868 { 1869 struct spdk_nvmf_request *req, *tmp; 1870 struct spdk_nvmf_subsystem_poll_group *sgroup; 1871 int rc = 0; 1872 uint32_t i; 1873 1874 if (subsystem->id >= group->num_sgroups) { 1875 rc = -1; 1876 goto fini; 1877 } 1878 1879 sgroup = &group->sgroups[subsystem->id]; 1880 1881 if (sgroup->state == SPDK_NVMF_SUBSYSTEM_ACTIVE) { 1882 goto fini; 1883 } 1884 1885 rc = poll_group_update_subsystem(group, subsystem); 1886 if (rc) { 1887 goto fini; 1888 } 1889 1890 for (i = 0; i < sgroup->num_ns; i++) { 1891 sgroup->ns_info[i].state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 1892 } 1893 1894 sgroup->state = SPDK_NVMF_SUBSYSTEM_ACTIVE; 1895 1896 /* Release all queued requests */ 1897 TAILQ_FOREACH_SAFE(req, &sgroup->queued, link, tmp) { 1898 TAILQ_REMOVE(&sgroup->queued, req, link); 1899 if (spdk_nvmf_request_using_zcopy(req)) { 1900 spdk_nvmf_request_zcopy_start(req); 1901 } else { 1902 spdk_nvmf_request_exec(req); 1903 } 1904 1905 } 1906 fini: 1907 if (cb_fn) { 1908 cb_fn(cb_arg, rc); 1909 } 1910 } 1911 1912 1913 struct spdk_nvmf_poll_group * 1914 spdk_nvmf_get_optimal_poll_group(struct spdk_nvmf_qpair *qpair) 1915 { 1916 struct spdk_nvmf_transport_poll_group *tgroup; 1917 1918 tgroup = nvmf_transport_get_optimal_poll_group(qpair->transport, qpair); 1919 1920 if (tgroup == NULL) { 1921 return NULL; 1922 } 1923 1924 return tgroup->group; 1925 } 1926 1927 void 1928 spdk_nvmf_poll_group_dump_stat(struct spdk_nvmf_poll_group *group, struct spdk_json_write_ctx *w) 1929 { 1930 struct spdk_nvmf_transport_poll_group *tgroup; 1931 1932 spdk_json_write_object_begin(w); 1933 1934 spdk_json_write_named_string(w, "name", spdk_thread_get_name(spdk_get_thread())); 1935 spdk_json_write_named_uint32(w, "admin_qpairs", group->stat.admin_qpairs); 1936 spdk_json_write_named_uint32(w, "io_qpairs", group->stat.io_qpairs); 1937 spdk_json_write_named_uint32(w, "current_admin_qpairs", group->stat.current_admin_qpairs); 1938 spdk_json_write_named_uint32(w, "current_io_qpairs", group->stat.current_io_qpairs); 1939 spdk_json_write_named_uint64(w, "pending_bdev_io", group->stat.pending_bdev_io); 1940 spdk_json_write_named_uint64(w, "completed_nvme_io", group->stat.completed_nvme_io); 1941 1942 spdk_json_write_named_array_begin(w, "transports"); 1943 1944 TAILQ_FOREACH(tgroup, &group->tgroups, link) { 1945 spdk_json_write_object_begin(w); 1946 /* 1947 * The trtype field intentionally contains a transport name as this is more informative. 1948 * The field has not been renamed for backward compatibility. 1949 */ 1950 spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(tgroup->transport)); 1951 1952 if (tgroup->transport->ops->poll_group_dump_stat) { 1953 tgroup->transport->ops->poll_group_dump_stat(tgroup, w); 1954 } 1955 1956 spdk_json_write_object_end(w); 1957 } 1958 1959 spdk_json_write_array_end(w); 1960 spdk_json_write_object_end(w); 1961 } 1962