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