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