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