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