Line data Source code
1 : /* SPDX-License-Identifier: BSD-3-Clause
2 : * Copyright (C) 2016 Intel Corporation. All rights reserved.
3 : * Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
4 : * Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 : */
6 :
7 : #include "spdk/stdinc.h"
8 :
9 : #include "nvmf_internal.h"
10 : #include "transport.h"
11 :
12 : #include "spdk/assert.h"
13 : #include "spdk/likely.h"
14 : #include "spdk/string.h"
15 : #include "spdk/trace.h"
16 : #include "spdk/nvmf_spec.h"
17 : #include "spdk/uuid.h"
18 : #include "spdk/json.h"
19 : #include "spdk/file.h"
20 : #include "spdk/bit_array.h"
21 : #include "spdk/bdev.h"
22 :
23 : #define __SPDK_BDEV_MODULE_ONLY
24 : #include "spdk/bdev_module.h"
25 : #include "spdk/log.h"
26 : #include "spdk_internal/utf.h"
27 : #include "spdk_internal/usdt.h"
28 :
29 : #define MODEL_NUMBER_DEFAULT "SPDK bdev Controller"
30 : #define NVMF_SUBSYSTEM_DEFAULT_NAMESPACES 32
31 :
32 : /*
33 : * States for parsing valid domains in NQNs according to RFC 1034
34 : */
35 : enum spdk_nvmf_nqn_domain_states {
36 : /* First character of a domain must be a letter */
37 : SPDK_NVMF_DOMAIN_ACCEPT_LETTER = 0,
38 :
39 : /* Subsequent characters can be any of letter, digit, or hyphen */
40 : SPDK_NVMF_DOMAIN_ACCEPT_LDH = 1,
41 :
42 : /* A domain label must end with either a letter or digit */
43 : SPDK_NVMF_DOMAIN_ACCEPT_ANY = 2
44 : };
45 :
46 : static int _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem);
47 :
48 : /* Returns true if is a valid ASCII string as defined by the NVMe spec */
49 : static bool
50 3 : nvmf_valid_ascii_string(const void *buf, size_t size)
51 : {
52 3 : const uint8_t *str = buf;
53 : size_t i;
54 :
55 35 : for (i = 0; i < size; i++) {
56 33 : if (str[i] < 0x20 || str[i] > 0x7E) {
57 1 : return false;
58 : }
59 32 : }
60 :
61 2 : return true;
62 3 : }
63 :
64 : bool
65 46 : nvmf_nqn_is_valid(const char *nqn)
66 : {
67 : size_t len;
68 : struct spdk_uuid uuid_value;
69 : uint32_t i;
70 : int bytes_consumed;
71 : uint32_t domain_label_length;
72 : char *reverse_domain_end;
73 : uint32_t reverse_domain_end_index;
74 46 : enum spdk_nvmf_nqn_domain_states domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
75 :
76 : /* Check for length requirements */
77 46 : len = strlen(nqn);
78 46 : if (len > SPDK_NVMF_NQN_MAX_LEN) {
79 1 : SPDK_ERRLOG("Invalid NQN \"%s\": length %zu > max %d\n", nqn, len, SPDK_NVMF_NQN_MAX_LEN);
80 1 : return false;
81 : }
82 :
83 : /* The nqn must be at least as long as SPDK_NVMF_NQN_MIN_LEN to contain the necessary prefix. */
84 45 : if (len < SPDK_NVMF_NQN_MIN_LEN) {
85 2 : SPDK_ERRLOG("Invalid NQN \"%s\": length %zu < min %d\n", nqn, len, SPDK_NVMF_NQN_MIN_LEN);
86 2 : return false;
87 : }
88 :
89 : /* Check for discovery controller nqn */
90 43 : if (!strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN)) {
91 2 : return true;
92 : }
93 :
94 : /* Check for equality with the generic nqn structure of the form "nqn.2014-08.org.nvmexpress:uuid:11111111-2222-3333-4444-555555555555" */
95 41 : if (!strncmp(nqn, SPDK_NVMF_NQN_UUID_PRE, SPDK_NVMF_NQN_UUID_PRE_LEN)) {
96 6 : if (len != SPDK_NVMF_NQN_UUID_PRE_LEN + SPDK_NVMF_UUID_STRING_LEN) {
97 2 : SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not the correct length\n", nqn);
98 2 : return false;
99 : }
100 :
101 4 : if (spdk_uuid_parse(&uuid_value, &nqn[SPDK_NVMF_NQN_UUID_PRE_LEN])) {
102 2 : SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not formatted correctly\n", nqn);
103 2 : return false;
104 : }
105 2 : return true;
106 : }
107 :
108 : /* If the nqn does not match the uuid structure, the next several checks validate the form "nqn.yyyy-mm.reverse.domain:user-string" */
109 :
110 35 : if (strncmp(nqn, "nqn.", 4) != 0) {
111 0 : SPDK_ERRLOG("Invalid NQN \"%s\": NQN must begin with \"nqn.\".\n", nqn);
112 0 : return false;
113 : }
114 :
115 : /* Check for yyyy-mm. */
116 70 : if (!(isdigit(nqn[4]) && isdigit(nqn[5]) && isdigit(nqn[6]) && isdigit(nqn[7]) &&
117 35 : nqn[8] == '-' && isdigit(nqn[9]) && isdigit(nqn[10]) && nqn[11] == '.')) {
118 0 : SPDK_ERRLOG("Invalid date code in NQN \"%s\"\n", nqn);
119 0 : return false;
120 : }
121 :
122 35 : reverse_domain_end = strchr(nqn, ':');
123 35 : if (reverse_domain_end != NULL && (reverse_domain_end_index = reverse_domain_end - nqn) < len - 1) {
124 34 : } else {
125 1 : SPDK_ERRLOG("Invalid NQN \"%s\". NQN must contain user specified name with a ':' as a prefix.\n",
126 : nqn);
127 1 : return false;
128 : }
129 :
130 : /* Check for valid reverse domain */
131 34 : domain_label_length = 0;
132 338 : for (i = 12; i < reverse_domain_end_index; i++) {
133 310 : if (domain_label_length > SPDK_DOMAIN_LABEL_MAX_LEN) {
134 1 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". At least one Label is too long.\n", nqn);
135 1 : return false;
136 : }
137 :
138 309 : switch (domain_state) {
139 :
140 : case SPDK_NVMF_DOMAIN_ACCEPT_LETTER: {
141 69 : if (isalpha(nqn[i])) {
142 65 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
143 65 : domain_label_length++;
144 65 : break;
145 : } else {
146 4 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must start with a letter.\n", nqn);
147 4 : return false;
148 : }
149 : }
150 :
151 : case SPDK_NVMF_DOMAIN_ACCEPT_LDH: {
152 4 : if (isalpha(nqn[i]) || isdigit(nqn[i])) {
153 3 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
154 3 : domain_label_length++;
155 3 : break;
156 1 : } else if (nqn[i] == '-') {
157 1 : if (i == reverse_domain_end_index - 1) {
158 0 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
159 : nqn);
160 0 : return false;
161 : }
162 1 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
163 1 : domain_label_length++;
164 1 : break;
165 0 : } else if (nqn[i] == '.') {
166 0 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
167 : nqn);
168 0 : return false;
169 : } else {
170 0 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n",
171 : nqn);
172 0 : return false;
173 : }
174 : }
175 :
176 : case SPDK_NVMF_DOMAIN_ACCEPT_ANY: {
177 236 : if (isalpha(nqn[i]) || isdigit(nqn[i])) {
178 197 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
179 197 : domain_label_length++;
180 197 : break;
181 39 : } else if (nqn[i] == '-') {
182 4 : if (i == reverse_domain_end_index - 1) {
183 1 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
184 : nqn);
185 1 : return false;
186 : }
187 3 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
188 3 : domain_label_length++;
189 3 : break;
190 35 : } else if (nqn[i] == '.') {
191 35 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
192 35 : domain_label_length = 0;
193 35 : break;
194 : } else {
195 0 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only [a-z,A-Z,0-9,'-','.'].\n",
196 : nqn);
197 0 : return false;
198 : }
199 : }
200 : }
201 304 : }
202 :
203 28 : i = reverse_domain_end_index + 1;
204 414 : while (i < len) {
205 387 : bytes_consumed = utf8_valid(&nqn[i], &nqn[len]);
206 387 : if (bytes_consumed <= 0) {
207 1 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only valid utf-8.\n", nqn);
208 1 : return false;
209 : }
210 :
211 386 : i += bytes_consumed;
212 : }
213 27 : return true;
214 46 : }
215 :
216 : static void subsystem_state_change_on_pg(struct spdk_io_channel_iter *i);
217 :
218 : struct spdk_nvmf_subsystem *
219 24 : spdk_nvmf_subsystem_create(struct spdk_nvmf_tgt *tgt,
220 : const char *nqn,
221 : enum spdk_nvmf_subtype type,
222 : uint32_t num_ns)
223 : {
224 : struct spdk_nvmf_subsystem *subsystem;
225 : uint32_t sid;
226 :
227 24 : if (spdk_nvmf_tgt_find_subsystem(tgt, nqn)) {
228 0 : SPDK_ERRLOG("Subsystem NQN '%s' already exists\n", nqn);
229 0 : return NULL;
230 : }
231 :
232 24 : if (!nvmf_nqn_is_valid(nqn)) {
233 11 : SPDK_ERRLOG("Subsystem NQN '%s' is invalid\n", nqn);
234 11 : return NULL;
235 : }
236 :
237 13 : if (type == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
238 12 : type == SPDK_NVMF_SUBTYPE_DISCOVERY) {
239 1 : if (num_ns != 0) {
240 0 : SPDK_ERRLOG("Discovery subsystem cannot have namespaces.\n");
241 0 : return NULL;
242 : }
243 13 : } else if (num_ns == 0) {
244 12 : num_ns = NVMF_SUBSYSTEM_DEFAULT_NAMESPACES;
245 12 : }
246 :
247 : /* Find a free subsystem id (sid) */
248 13 : sid = spdk_bit_array_find_first_clear(tgt->subsystem_ids, 0);
249 13 : if (sid == UINT32_MAX) {
250 0 : SPDK_ERRLOG("No free subsystem IDs are available for subsystem creation\n");
251 0 : return NULL;
252 : }
253 13 : subsystem = calloc(1, sizeof(struct spdk_nvmf_subsystem));
254 13 : if (subsystem == NULL) {
255 0 : SPDK_ERRLOG("Subsystem memory allocation failed\n");
256 0 : return NULL;
257 : }
258 :
259 13 : subsystem->thread = spdk_get_thread();
260 13 : subsystem->state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
261 13 : subsystem->tgt = tgt;
262 13 : subsystem->id = sid;
263 13 : subsystem->subtype = type;
264 13 : subsystem->max_nsid = num_ns;
265 13 : subsystem->next_cntlid = 1;
266 13 : subsystem->min_cntlid = NVMF_MIN_CNTLID;
267 13 : subsystem->max_cntlid = NVMF_MAX_CNTLID;
268 13 : snprintf(subsystem->subnqn, sizeof(subsystem->subnqn), "%s", nqn);
269 13 : pthread_mutex_init(&subsystem->mutex, NULL);
270 13 : TAILQ_INIT(&subsystem->listeners);
271 13 : TAILQ_INIT(&subsystem->hosts);
272 13 : TAILQ_INIT(&subsystem->ctrlrs);
273 13 : TAILQ_INIT(&subsystem->state_changes);
274 13 : subsystem->used_listener_ids = spdk_bit_array_create(NVMF_MAX_LISTENERS_PER_SUBSYSTEM);
275 13 : if (subsystem->used_listener_ids == NULL) {
276 0 : pthread_mutex_destroy(&subsystem->mutex);
277 0 : free(subsystem);
278 0 : SPDK_ERRLOG("Listener id array memory allocation failed\n");
279 0 : return NULL;
280 : }
281 :
282 13 : if (num_ns != 0) {
283 12 : subsystem->ns = calloc(num_ns, sizeof(struct spdk_nvmf_ns *));
284 12 : if (subsystem->ns == NULL) {
285 0 : SPDK_ERRLOG("Namespace memory allocation failed\n");
286 0 : pthread_mutex_destroy(&subsystem->mutex);
287 0 : spdk_bit_array_free(&subsystem->used_listener_ids);
288 0 : free(subsystem);
289 0 : return NULL;
290 : }
291 12 : subsystem->ana_group = calloc(num_ns, sizeof(uint32_t));
292 12 : if (subsystem->ana_group == NULL) {
293 0 : SPDK_ERRLOG("ANA group memory allocation failed\n");
294 0 : pthread_mutex_destroy(&subsystem->mutex);
295 0 : free(subsystem->ns);
296 0 : spdk_bit_array_free(&subsystem->used_listener_ids);
297 0 : free(subsystem);
298 0 : return NULL;
299 : }
300 12 : }
301 :
302 13 : memset(subsystem->sn, '0', sizeof(subsystem->sn) - 1);
303 13 : subsystem->sn[sizeof(subsystem->sn) - 1] = '\0';
304 :
305 13 : snprintf(subsystem->mn, sizeof(subsystem->mn), "%s",
306 : MODEL_NUMBER_DEFAULT);
307 :
308 13 : spdk_bit_array_set(tgt->subsystem_ids, sid);
309 13 : RB_INSERT(subsystem_tree, &tgt->subsystems, subsystem);
310 :
311 : SPDK_DTRACE_PROBE1(nvmf_subsystem_create, subsystem->subnqn);
312 :
313 13 : return subsystem;
314 24 : }
315 :
316 : static void
317 3 : nvmf_host_free(struct spdk_nvmf_host *host)
318 : {
319 3 : spdk_keyring_put_key(host->dhchap_key);
320 3 : spdk_keyring_put_key(host->dhchap_ctrlr_key);
321 3 : free(host);
322 3 : }
323 :
324 : /* Must hold subsystem->mutex while calling this function */
325 : static void
326 3 : nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *host)
327 : {
328 3 : TAILQ_REMOVE(&subsystem->hosts, host, link);
329 3 : nvmf_host_free(host);
330 3 : }
331 :
332 : static void
333 7 : _nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem,
334 : struct spdk_nvmf_subsystem_listener *listener,
335 : bool stop)
336 : {
337 : struct spdk_nvmf_transport *transport;
338 : struct spdk_nvmf_ctrlr *ctrlr;
339 :
340 7 : if (stop) {
341 0 : transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, listener->trid->trstring);
342 0 : if (transport != NULL) {
343 0 : spdk_nvmf_transport_stop_listen(transport, listener->trid);
344 0 : }
345 0 : }
346 :
347 7 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
348 0 : if (ctrlr->listener == listener) {
349 0 : ctrlr->listener = NULL;
350 0 : }
351 0 : }
352 :
353 7 : TAILQ_REMOVE(&subsystem->listeners, listener, link);
354 7 : if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
355 0 : nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
356 0 : }
357 7 : spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL);
358 7 : free(listener->ana_state);
359 7 : spdk_bit_array_clear(subsystem->used_listener_ids, listener->id);
360 7 : free(listener->opts.sock_impl);
361 7 : free(listener);
362 7 : }
363 :
364 : static void
365 0 : _nvmf_subsystem_destroy_msg(void *cb_arg)
366 : {
367 0 : struct spdk_nvmf_subsystem *subsystem = cb_arg;
368 :
369 0 : _nvmf_subsystem_destroy(subsystem);
370 0 : }
371 :
372 : static int
373 13 : _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem)
374 : {
375 : struct nvmf_subsystem_state_change_ctx *ctx;
376 : struct spdk_nvmf_ns *ns;
377 13 : nvmf_subsystem_destroy_cb async_destroy_cb = NULL;
378 13 : void *async_destroy_cb_arg = NULL;
379 : int rc;
380 :
381 13 : if (!TAILQ_EMPTY(&subsystem->ctrlrs)) {
382 0 : SPDK_DEBUGLOG(nvmf, "subsystem %p %s has active controllers\n", subsystem, subsystem->subnqn);
383 0 : subsystem->async_destroy = true;
384 0 : rc = spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_destroy_msg, subsystem);
385 0 : if (rc) {
386 0 : SPDK_ERRLOG("Failed to send thread msg, rc %d\n", rc);
387 0 : assert(0);
388 : return rc;
389 : }
390 0 : return -EINPROGRESS;
391 : }
392 :
393 13 : ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
394 13 : while (ns != NULL) {
395 0 : struct spdk_nvmf_ns *next_ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns);
396 :
397 0 : spdk_nvmf_subsystem_remove_ns(subsystem, ns->opts.nsid);
398 0 : ns = next_ns;
399 : }
400 :
401 13 : while ((ctx = TAILQ_FIRST(&subsystem->state_changes))) {
402 0 : SPDK_WARNLOG("subsystem %s has pending state change requests\n", subsystem->subnqn);
403 0 : TAILQ_REMOVE(&subsystem->state_changes, ctx, link);
404 0 : if (ctx->cb_fn != NULL) {
405 0 : ctx->cb_fn(subsystem, ctx->cb_arg, -ECANCELED);
406 0 : }
407 0 : free(ctx);
408 : }
409 :
410 13 : free(subsystem->ns);
411 13 : free(subsystem->ana_group);
412 :
413 13 : RB_REMOVE(subsystem_tree, &subsystem->tgt->subsystems, subsystem);
414 13 : assert(spdk_bit_array_get(subsystem->tgt->subsystem_ids, subsystem->id) == true);
415 13 : spdk_bit_array_clear(subsystem->tgt->subsystem_ids, subsystem->id);
416 :
417 13 : pthread_mutex_destroy(&subsystem->mutex);
418 :
419 13 : spdk_bit_array_free(&subsystem->used_listener_ids);
420 :
421 13 : if (subsystem->async_destroy) {
422 0 : async_destroy_cb = subsystem->async_destroy_cb;
423 0 : async_destroy_cb_arg = subsystem->async_destroy_cb_arg;
424 0 : }
425 :
426 13 : free(subsystem);
427 :
428 13 : if (async_destroy_cb) {
429 0 : async_destroy_cb(async_destroy_cb_arg);
430 0 : }
431 :
432 13 : return 0;
433 13 : }
434 :
435 : static struct spdk_nvmf_ns *
436 0 : _nvmf_subsystem_get_first_zoned_ns(struct spdk_nvmf_subsystem *subsystem)
437 : {
438 0 : struct spdk_nvmf_ns *ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
439 0 : while (ns != NULL) {
440 0 : if (ns->csi == SPDK_NVME_CSI_ZNS) {
441 0 : return ns;
442 : }
443 0 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns);
444 : }
445 0 : return NULL;
446 0 : }
447 :
448 : int
449 13 : spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem, nvmf_subsystem_destroy_cb cpl_cb,
450 : void *cpl_cb_arg)
451 : {
452 : struct spdk_nvmf_host *host, *host_tmp;
453 : struct spdk_nvmf_transport *transport;
454 :
455 13 : if (!subsystem) {
456 0 : return -EINVAL;
457 : }
458 :
459 : SPDK_DTRACE_PROBE1(nvmf_subsystem_destroy, subsystem->subnqn);
460 :
461 13 : assert(spdk_get_thread() == subsystem->thread);
462 :
463 13 : if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
464 0 : SPDK_ERRLOG("Subsystem can only be destroyed in inactive state, %s state %d\n",
465 : subsystem->subnqn, subsystem->state);
466 0 : return -EAGAIN;
467 : }
468 13 : if (subsystem->destroying) {
469 0 : SPDK_ERRLOG("Subsystem destruction is already started\n");
470 0 : assert(0);
471 : return -EALREADY;
472 : }
473 :
474 13 : subsystem->destroying = true;
475 :
476 13 : SPDK_DEBUGLOG(nvmf, "subsystem is %p %s\n", subsystem, subsystem->subnqn);
477 :
478 13 : nvmf_subsystem_remove_all_listeners(subsystem, false);
479 :
480 13 : pthread_mutex_lock(&subsystem->mutex);
481 :
482 13 : TAILQ_FOREACH_SAFE(host, &subsystem->hosts, link, host_tmp) {
483 0 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
484 0 : transport = spdk_nvmf_transport_get_next(transport)) {
485 0 : if (transport->ops->subsystem_remove_host) {
486 0 : transport->ops->subsystem_remove_host(transport, subsystem, host->nqn);
487 0 : }
488 0 : }
489 0 : nvmf_subsystem_remove_host(subsystem, host);
490 0 : }
491 :
492 13 : pthread_mutex_unlock(&subsystem->mutex);
493 :
494 13 : subsystem->async_destroy_cb = cpl_cb;
495 13 : subsystem->async_destroy_cb_arg = cpl_cb_arg;
496 :
497 13 : return _nvmf_subsystem_destroy(subsystem);
498 13 : }
499 :
500 : /* we have to use the typedef in the function declaration to appease astyle. */
501 : typedef enum spdk_nvmf_subsystem_state spdk_nvmf_subsystem_state_t;
502 :
503 : static spdk_nvmf_subsystem_state_t
504 9 : nvmf_subsystem_get_intermediate_state(enum spdk_nvmf_subsystem_state current_state,
505 : enum spdk_nvmf_subsystem_state requested_state)
506 : {
507 9 : switch (requested_state) {
508 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
509 2 : return SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
510 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
511 4 : if (current_state == SPDK_NVMF_SUBSYSTEM_PAUSED) {
512 2 : return SPDK_NVMF_SUBSYSTEM_RESUMING;
513 : } else {
514 2 : return SPDK_NVMF_SUBSYSTEM_ACTIVATING;
515 : }
516 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
517 3 : return SPDK_NVMF_SUBSYSTEM_PAUSING;
518 : default:
519 0 : assert(false);
520 : return SPDK_NVMF_SUBSYSTEM_NUM_STATES;
521 : }
522 9 : }
523 :
524 : static int
525 18 : nvmf_subsystem_set_state(struct spdk_nvmf_subsystem *subsystem,
526 : enum spdk_nvmf_subsystem_state state)
527 : {
528 : enum spdk_nvmf_subsystem_state actual_old_state, expected_old_state;
529 : bool exchanged;
530 :
531 18 : switch (state) {
532 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
533 2 : expected_old_state = SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
534 2 : break;
535 : case SPDK_NVMF_SUBSYSTEM_ACTIVATING:
536 2 : expected_old_state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
537 2 : break;
538 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
539 4 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING;
540 4 : break;
541 : case SPDK_NVMF_SUBSYSTEM_PAUSING:
542 3 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
543 3 : break;
544 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
545 3 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSING;
546 3 : break;
547 : case SPDK_NVMF_SUBSYSTEM_RESUMING:
548 2 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
549 2 : break;
550 : case SPDK_NVMF_SUBSYSTEM_DEACTIVATING:
551 2 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
552 2 : break;
553 : default:
554 0 : assert(false);
555 : return -1;
556 : }
557 :
558 18 : actual_old_state = expected_old_state;
559 18 : exchanged = __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
560 : __ATOMIC_RELAXED, __ATOMIC_RELAXED);
561 18 : if (spdk_unlikely(exchanged == false)) {
562 3 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
563 2 : state == SPDK_NVMF_SUBSYSTEM_ACTIVE) {
564 2 : expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING;
565 2 : }
566 : /* This is for the case when activating the subsystem fails. */
567 3 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_ACTIVATING &&
568 0 : state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) {
569 0 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING;
570 0 : }
571 : /* This is for the case when resuming the subsystem fails. */
572 3 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
573 2 : state == SPDK_NVMF_SUBSYSTEM_PAUSING) {
574 0 : expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING;
575 0 : }
576 : /* This is for the case when stopping paused subsystem */
577 3 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_PAUSED &&
578 1 : state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) {
579 1 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
580 1 : }
581 3 : actual_old_state = expected_old_state;
582 3 : __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
583 : __ATOMIC_RELAXED, __ATOMIC_RELAXED);
584 3 : }
585 18 : assert(actual_old_state == expected_old_state);
586 18 : return actual_old_state - expected_old_state;
587 : }
588 :
589 : static void nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx);
590 :
591 : static void
592 10 : _nvmf_subsystem_state_change_complete(void *_ctx)
593 : {
594 10 : struct nvmf_subsystem_state_change_ctx *next, *ctx = _ctx;
595 10 : struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
596 :
597 10 : pthread_mutex_lock(&subsystem->mutex);
598 10 : assert(TAILQ_FIRST(&subsystem->state_changes) == ctx);
599 10 : TAILQ_REMOVE(&subsystem->state_changes, ctx, link);
600 10 : next = TAILQ_FIRST(&subsystem->state_changes);
601 10 : pthread_mutex_unlock(&subsystem->mutex);
602 :
603 10 : if (ctx->cb_fn != NULL) {
604 3 : ctx->cb_fn(subsystem, ctx->cb_arg, ctx->status);
605 3 : }
606 10 : free(ctx);
607 :
608 10 : if (next != NULL) {
609 1 : nvmf_subsystem_do_state_change(next);
610 1 : }
611 10 : }
612 :
613 : static void
614 10 : nvmf_subsystem_state_change_complete(struct nvmf_subsystem_state_change_ctx *ctx, int status)
615 : {
616 10 : ctx->status = status;
617 10 : spdk_thread_exec_msg(ctx->thread, _nvmf_subsystem_state_change_complete, ctx);
618 10 : }
619 :
620 : static void
621 0 : subsystem_state_change_revert_done(struct spdk_io_channel_iter *i, int status)
622 : {
623 0 : struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
624 :
625 : /* Nothing to be done here if the state setting fails, we are just screwed. */
626 0 : if (nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state)) {
627 0 : SPDK_ERRLOG("Unable to revert the subsystem state after operation failure.\n");
628 0 : }
629 :
630 : /* return a failure here. This function only exists in an error path. */
631 0 : nvmf_subsystem_state_change_complete(ctx, -1);
632 0 : }
633 :
634 : static void
635 9 : subsystem_state_change_done(struct spdk_io_channel_iter *i, int status)
636 : {
637 9 : struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
638 : enum spdk_nvmf_subsystem_state intermediate_state;
639 :
640 : SPDK_DTRACE_PROBE4(nvmf_subsystem_change_state_done, ctx->subsystem->subnqn,
641 : ctx->requested_state, ctx->original_state, status);
642 :
643 9 : if (status == 0) {
644 9 : status = nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state);
645 9 : if (status) {
646 0 : status = -1;
647 0 : }
648 9 : }
649 :
650 9 : if (status) {
651 0 : intermediate_state = nvmf_subsystem_get_intermediate_state(ctx->requested_state,
652 0 : ctx->original_state);
653 0 : assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES);
654 :
655 0 : if (nvmf_subsystem_set_state(ctx->subsystem, intermediate_state)) {
656 0 : goto out;
657 : }
658 0 : ctx->requested_state = ctx->original_state;
659 0 : spdk_for_each_channel(ctx->subsystem->tgt,
660 : subsystem_state_change_on_pg,
661 0 : ctx,
662 : subsystem_state_change_revert_done);
663 0 : return;
664 : }
665 :
666 : out:
667 9 : nvmf_subsystem_state_change_complete(ctx, status);
668 9 : }
669 :
670 : static void
671 0 : subsystem_state_change_continue(void *ctx, int status)
672 : {
673 0 : struct spdk_io_channel_iter *i = ctx;
674 : struct nvmf_subsystem_state_change_ctx *_ctx __attribute__((unused));
675 :
676 0 : _ctx = spdk_io_channel_iter_get_ctx(i);
677 : SPDK_DTRACE_PROBE3(nvmf_pg_change_state_done, _ctx->subsystem->subnqn,
678 : _ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
679 :
680 0 : spdk_for_each_channel_continue(i, status);
681 0 : }
682 :
683 : static void
684 0 : subsystem_state_change_on_pg(struct spdk_io_channel_iter *i)
685 : {
686 : struct nvmf_subsystem_state_change_ctx *ctx;
687 : struct spdk_io_channel *ch;
688 : struct spdk_nvmf_poll_group *group;
689 :
690 0 : ctx = spdk_io_channel_iter_get_ctx(i);
691 0 : ch = spdk_io_channel_iter_get_channel(i);
692 0 : group = spdk_io_channel_get_ctx(ch);
693 :
694 : SPDK_DTRACE_PROBE3(nvmf_pg_change_state, ctx->subsystem->subnqn,
695 : ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
696 0 : switch (ctx->requested_state) {
697 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
698 0 : nvmf_poll_group_remove_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
699 0 : break;
700 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
701 0 : if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_ACTIVATING) {
702 0 : nvmf_poll_group_add_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
703 0 : } else if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_RESUMING) {
704 0 : nvmf_poll_group_resume_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
705 0 : }
706 0 : break;
707 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
708 0 : nvmf_poll_group_pause_subsystem(group, ctx->subsystem, ctx->nsid, subsystem_state_change_continue,
709 0 : i);
710 0 : break;
711 : default:
712 0 : assert(false);
713 : break;
714 : }
715 0 : }
716 :
717 : static void
718 10 : nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx)
719 : {
720 10 : struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
721 : enum spdk_nvmf_subsystem_state intermediate_state;
722 : int rc;
723 :
724 : SPDK_DTRACE_PROBE3(nvmf_subsystem_change_state, subsystem->subnqn,
725 : ctx->requested_state, subsystem->state);
726 :
727 : /* If we are already in the requested state, just call the callback immediately. */
728 10 : if (subsystem->state == ctx->requested_state) {
729 1 : nvmf_subsystem_state_change_complete(ctx, 0);
730 1 : return;
731 : }
732 :
733 18 : intermediate_state = nvmf_subsystem_get_intermediate_state(subsystem->state,
734 9 : ctx->requested_state);
735 9 : assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES);
736 :
737 9 : ctx->original_state = subsystem->state;
738 9 : rc = nvmf_subsystem_set_state(subsystem, intermediate_state);
739 9 : if (rc) {
740 0 : nvmf_subsystem_state_change_complete(ctx, -1);
741 0 : return;
742 : }
743 :
744 18 : spdk_for_each_channel(subsystem->tgt,
745 : subsystem_state_change_on_pg,
746 9 : ctx,
747 : subsystem_state_change_done);
748 10 : }
749 :
750 :
751 : static int
752 10 : nvmf_subsystem_state_change(struct spdk_nvmf_subsystem *subsystem,
753 : uint32_t nsid,
754 : enum spdk_nvmf_subsystem_state requested_state,
755 : spdk_nvmf_subsystem_state_change_done cb_fn,
756 : void *cb_arg)
757 : {
758 : struct nvmf_subsystem_state_change_ctx *ctx;
759 : struct spdk_thread *thread;
760 :
761 10 : thread = spdk_get_thread();
762 10 : if (thread == NULL) {
763 0 : return -EINVAL;
764 : }
765 :
766 10 : ctx = calloc(1, sizeof(*ctx));
767 10 : if (!ctx) {
768 0 : return -ENOMEM;
769 : }
770 :
771 10 : ctx->subsystem = subsystem;
772 10 : ctx->nsid = nsid;
773 10 : ctx->requested_state = requested_state;
774 10 : ctx->cb_fn = cb_fn;
775 10 : ctx->cb_arg = cb_arg;
776 10 : ctx->thread = thread;
777 :
778 10 : pthread_mutex_lock(&subsystem->mutex);
779 10 : TAILQ_INSERT_TAIL(&subsystem->state_changes, ctx, link);
780 10 : if (ctx != TAILQ_FIRST(&subsystem->state_changes)) {
781 1 : pthread_mutex_unlock(&subsystem->mutex);
782 1 : return 0;
783 : }
784 9 : pthread_mutex_unlock(&subsystem->mutex);
785 :
786 9 : nvmf_subsystem_do_state_change(ctx);
787 :
788 9 : return 0;
789 10 : }
790 :
791 : int
792 2 : spdk_nvmf_subsystem_start(struct spdk_nvmf_subsystem *subsystem,
793 : spdk_nvmf_subsystem_state_change_done cb_fn,
794 : void *cb_arg)
795 : {
796 2 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
797 : }
798 :
799 : int
800 3 : spdk_nvmf_subsystem_stop(struct spdk_nvmf_subsystem *subsystem,
801 : spdk_nvmf_subsystem_state_change_done cb_fn,
802 : void *cb_arg)
803 : {
804 3 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_INACTIVE, cb_fn, cb_arg);
805 : }
806 :
807 : int
808 3 : spdk_nvmf_subsystem_pause(struct spdk_nvmf_subsystem *subsystem,
809 : uint32_t nsid,
810 : spdk_nvmf_subsystem_state_change_done cb_fn,
811 : void *cb_arg)
812 : {
813 3 : return nvmf_subsystem_state_change(subsystem, nsid, SPDK_NVMF_SUBSYSTEM_PAUSED, cb_fn, cb_arg);
814 : }
815 :
816 : int
817 2 : spdk_nvmf_subsystem_resume(struct spdk_nvmf_subsystem *subsystem,
818 : spdk_nvmf_subsystem_state_change_done cb_fn,
819 : void *cb_arg)
820 : {
821 2 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
822 : }
823 :
824 : struct spdk_nvmf_subsystem *
825 33 : spdk_nvmf_subsystem_get_first(struct spdk_nvmf_tgt *tgt)
826 : {
827 33 : return RB_MIN(subsystem_tree, &tgt->subsystems);
828 : }
829 :
830 : struct spdk_nvmf_subsystem *
831 32 : spdk_nvmf_subsystem_get_next(struct spdk_nvmf_subsystem *subsystem)
832 : {
833 32 : if (!subsystem) {
834 0 : return NULL;
835 : }
836 :
837 32 : return RB_NEXT(subsystem_tree, &tgt->subsystems, subsystem);
838 32 : }
839 :
840 : static int
841 2 : nvmf_ns_add_host(struct spdk_nvmf_ns *ns, const char *hostnqn)
842 : {
843 : struct spdk_nvmf_host *host;
844 :
845 2 : host = calloc(1, sizeof(*host));
846 2 : if (!host) {
847 0 : return -ENOMEM;
848 : }
849 2 : snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
850 2 : TAILQ_INSERT_HEAD(&ns->hosts, host, link);
851 2 : return 0;
852 2 : }
853 :
854 : static void
855 2 : nvmf_ns_remove_host(struct spdk_nvmf_ns *ns, struct spdk_nvmf_host *host)
856 : {
857 2 : TAILQ_REMOVE(&ns->hosts, host, link);
858 2 : free(host);
859 2 : }
860 :
861 : static void
862 3 : _async_event_ns_notice(void *_ctrlr)
863 : {
864 3 : struct spdk_nvmf_ctrlr *ctrlr = _ctrlr;
865 :
866 3 : nvmf_ctrlr_async_event_ns_notice(ctrlr);
867 3 : }
868 :
869 : static void
870 3 : send_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr)
871 : {
872 3 : spdk_thread_send_msg(ctrlr->thread, _async_event_ns_notice, ctrlr);
873 3 : }
874 :
875 : static int
876 14 : nvmf_ns_visible(struct spdk_nvmf_subsystem *subsystem,
877 : uint32_t nsid,
878 : const char *hostnqn,
879 : bool visible)
880 : {
881 : struct spdk_nvmf_ns *ns;
882 : struct spdk_nvmf_ctrlr *ctrlr;
883 : struct spdk_nvmf_host *host;
884 : int rc;
885 :
886 14 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
887 0 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
888 0 : assert(false);
889 : return -1;
890 : }
891 :
892 14 : if (hostnqn == NULL || !nvmf_nqn_is_valid(hostnqn)) {
893 3 : return -EINVAL;
894 : }
895 :
896 11 : if (nsid == 0 || nsid > subsystem->max_nsid) {
897 2 : return -EINVAL;
898 : }
899 :
900 9 : ns = subsystem->ns[nsid - 1];
901 9 : if (!ns) {
902 2 : return -ENOENT;
903 : }
904 :
905 7 : if (ns->always_visible) {
906 : /* No individual host control */
907 2 : return -EPERM;
908 : }
909 :
910 : /* Save host info to use for any future controllers. */
911 5 : host = nvmf_ns_find_host(ns, hostnqn);
912 5 : if (visible && host == NULL) {
913 2 : rc = nvmf_ns_add_host(ns, hostnqn);
914 2 : if (rc) {
915 0 : return rc;
916 : }
917 5 : } else if (!visible && host != NULL) {
918 1 : nvmf_ns_remove_host(ns, host);
919 1 : }
920 :
921 : /* Also apply to existing controllers. */
922 15 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
923 10 : if (strcmp(hostnqn, ctrlr->hostnqn) ||
924 5 : nvmf_ctrlr_ns_is_visible(ctrlr, nsid) == visible) {
925 7 : continue;
926 : }
927 3 : nvmf_ctrlr_ns_set_visible(ctrlr, nsid, visible);
928 3 : send_async_event_ns_notice(ctrlr);
929 3 : nvmf_ctrlr_ns_changed(ctrlr, nsid);
930 3 : }
931 :
932 5 : return 0;
933 14 : }
934 :
935 : int
936 8 : spdk_nvmf_ns_add_host(struct spdk_nvmf_subsystem *subsystem,
937 : uint32_t nsid,
938 : const char *hostnqn,
939 : uint32_t flags)
940 : {
941 : SPDK_DTRACE_PROBE4(spdk_nvmf_ns_add_host,
942 : subsystem->subnqn,
943 : nsid,
944 : hostnqn,
945 : flags);
946 8 : return nvmf_ns_visible(subsystem, nsid, hostnqn, true);
947 : }
948 :
949 : int
950 6 : spdk_nvmf_ns_remove_host(struct spdk_nvmf_subsystem *subsystem,
951 : uint32_t nsid,
952 : const char *hostnqn,
953 : uint32_t flags)
954 : {
955 : SPDK_DTRACE_PROBE4(spdk_nvmf_ns_remove_host,
956 : subsystem->subnqn,
957 : nsid,
958 : hostnqn,
959 : flags);
960 6 : return nvmf_ns_visible(subsystem, nsid, hostnqn, false);
961 : }
962 :
963 : /* Must hold subsystem->mutex while calling this function */
964 : static struct spdk_nvmf_host *
965 14 : nvmf_subsystem_find_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
966 : {
967 14 : struct spdk_nvmf_host *host = NULL;
968 :
969 14 : TAILQ_FOREACH(host, &subsystem->hosts, link) {
970 9 : if (strcmp(hostnqn, host->nqn) == 0) {
971 9 : return host;
972 : }
973 0 : }
974 :
975 5 : return NULL;
976 14 : }
977 :
978 : int
979 4 : spdk_nvmf_subsystem_add_host_ext(struct spdk_nvmf_subsystem *subsystem,
980 : const char *hostnqn, struct spdk_nvmf_host_opts *opts)
981 : {
982 : struct spdk_nvmf_host *host;
983 : struct spdk_nvmf_transport *transport;
984 : struct spdk_key *key;
985 : int rc;
986 :
987 4 : if (!nvmf_nqn_is_valid(hostnqn)) {
988 0 : return -EINVAL;
989 : }
990 :
991 4 : pthread_mutex_lock(&subsystem->mutex);
992 :
993 4 : if (nvmf_subsystem_find_host(subsystem, hostnqn)) {
994 : /* This subsystem already allows the specified host. */
995 1 : pthread_mutex_unlock(&subsystem->mutex);
996 1 : return -EINVAL;
997 : }
998 :
999 3 : host = calloc(1, sizeof(*host));
1000 3 : if (!host) {
1001 0 : pthread_mutex_unlock(&subsystem->mutex);
1002 0 : return -ENOMEM;
1003 : }
1004 :
1005 3 : key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
1006 3 : if (key != NULL) {
1007 0 : if (!nvmf_auth_is_supported()) {
1008 0 : SPDK_ERRLOG("NVMe in-band authentication is unsupported\n");
1009 0 : pthread_mutex_unlock(&subsystem->mutex);
1010 0 : nvmf_host_free(host);
1011 0 : return -EINVAL;
1012 : }
1013 0 : host->dhchap_key = spdk_key_dup(key);
1014 0 : if (host->dhchap_key == NULL) {
1015 0 : pthread_mutex_unlock(&subsystem->mutex);
1016 0 : nvmf_host_free(host);
1017 0 : return -EINVAL;
1018 : }
1019 0 : key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
1020 0 : if (key != NULL) {
1021 0 : host->dhchap_ctrlr_key = spdk_key_dup(key);
1022 0 : if (host->dhchap_ctrlr_key == NULL) {
1023 0 : pthread_mutex_unlock(&subsystem->mutex);
1024 0 : nvmf_host_free(host);
1025 0 : return -EINVAL;
1026 : }
1027 0 : }
1028 3 : } else if (SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL) != NULL) {
1029 0 : SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n");
1030 0 : pthread_mutex_unlock(&subsystem->mutex);
1031 0 : nvmf_host_free(host);
1032 0 : return -EINVAL;
1033 : }
1034 :
1035 3 : snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
1036 :
1037 : SPDK_DTRACE_PROBE2(nvmf_subsystem_add_host, subsystem->subnqn, host->nqn);
1038 :
1039 3 : TAILQ_INSERT_HEAD(&subsystem->hosts, host, link);
1040 :
1041 3 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
1042 0 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn);
1043 0 : }
1044 :
1045 3 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
1046 0 : transport = spdk_nvmf_transport_get_next(transport)) {
1047 1 : if (transport->ops->subsystem_add_host) {
1048 2 : rc = transport->ops->subsystem_add_host(transport, subsystem, hostnqn,
1049 1 : SPDK_GET_FIELD(opts, params, NULL));
1050 1 : if (rc) {
1051 1 : SPDK_ERRLOG("Unable to add host to %s transport\n", transport->ops->name);
1052 : /* Remove this host from all transports we've managed to add it to. */
1053 1 : pthread_mutex_unlock(&subsystem->mutex);
1054 1 : spdk_nvmf_subsystem_remove_host(subsystem, hostnqn);
1055 1 : return rc;
1056 : }
1057 0 : }
1058 0 : }
1059 :
1060 2 : pthread_mutex_unlock(&subsystem->mutex);
1061 :
1062 2 : return 0;
1063 4 : }
1064 :
1065 : int
1066 4 : spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
1067 : const struct spdk_json_val *params)
1068 : {
1069 4 : struct spdk_nvmf_host_opts opts = {};
1070 :
1071 4 : opts.size = SPDK_SIZEOF(&opts, params);
1072 4 : opts.params = params;
1073 :
1074 4 : return spdk_nvmf_subsystem_add_host_ext(subsystem, hostnqn, &opts);
1075 : }
1076 :
1077 : int
1078 4 : spdk_nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
1079 : {
1080 : struct spdk_nvmf_host *host;
1081 : struct spdk_nvmf_transport *transport;
1082 :
1083 4 : pthread_mutex_lock(&subsystem->mutex);
1084 :
1085 4 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1086 4 : if (host == NULL) {
1087 1 : pthread_mutex_unlock(&subsystem->mutex);
1088 1 : return -ENOENT;
1089 : }
1090 :
1091 : SPDK_DTRACE_PROBE2(nvmf_subsystem_remove_host, subsystem->subnqn, host->nqn);
1092 :
1093 3 : nvmf_subsystem_remove_host(subsystem, host);
1094 :
1095 3 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
1096 1 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn);
1097 1 : }
1098 :
1099 4 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
1100 1 : transport = spdk_nvmf_transport_get_next(transport)) {
1101 1 : if (transport->ops->subsystem_remove_host) {
1102 0 : transport->ops->subsystem_remove_host(transport, subsystem, hostnqn);
1103 0 : }
1104 1 : }
1105 :
1106 3 : pthread_mutex_unlock(&subsystem->mutex);
1107 :
1108 3 : return 0;
1109 4 : }
1110 :
1111 : int
1112 0 : spdk_nvmf_subsystem_set_keys(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
1113 : struct spdk_nvmf_subsystem_key_opts *opts)
1114 : {
1115 : struct spdk_nvmf_host *host;
1116 : struct spdk_key *key, *ckey;
1117 :
1118 0 : if (!nvmf_auth_is_supported()) {
1119 0 : SPDK_ERRLOG("NVMe in-band authentication is unsupported\n");
1120 0 : return -EINVAL;
1121 : }
1122 :
1123 0 : pthread_mutex_lock(&subsystem->mutex);
1124 0 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1125 0 : if (host == NULL) {
1126 0 : pthread_mutex_unlock(&subsystem->mutex);
1127 0 : return -EINVAL;
1128 : }
1129 :
1130 0 : if (SPDK_GET_FIELD(opts, dhchap_key, host->dhchap_key) == NULL &&
1131 0 : SPDK_GET_FIELD(opts, dhchap_ctrlr_key, host->dhchap_ctrlr_key) != NULL) {
1132 0 : SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n");
1133 0 : pthread_mutex_unlock(&subsystem->mutex);
1134 0 : return -EINVAL;
1135 : }
1136 0 : key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
1137 0 : if (key != NULL) {
1138 0 : key = spdk_key_dup(key);
1139 0 : if (key == NULL) {
1140 0 : pthread_mutex_unlock(&subsystem->mutex);
1141 0 : return -EINVAL;
1142 : }
1143 0 : }
1144 0 : ckey = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
1145 0 : if (ckey != NULL) {
1146 0 : ckey = spdk_key_dup(ckey);
1147 0 : if (ckey == NULL) {
1148 0 : pthread_mutex_unlock(&subsystem->mutex);
1149 0 : spdk_keyring_put_key(key);
1150 0 : return -EINVAL;
1151 : }
1152 0 : }
1153 0 : if (SPDK_FIELD_VALID(opts, dhchap_key)) {
1154 0 : spdk_keyring_put_key(host->dhchap_key);
1155 0 : host->dhchap_key = key;
1156 0 : }
1157 0 : if (SPDK_FIELD_VALID(opts, dhchap_ctrlr_key)) {
1158 0 : spdk_keyring_put_key(host->dhchap_ctrlr_key);
1159 0 : host->dhchap_ctrlr_key = ckey;
1160 0 : }
1161 0 : pthread_mutex_unlock(&subsystem->mutex);
1162 :
1163 0 : return 0;
1164 0 : }
1165 :
1166 : struct nvmf_subsystem_disconnect_host_ctx {
1167 : struct spdk_nvmf_subsystem *subsystem;
1168 : char *hostnqn;
1169 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn;
1170 : void *cb_arg;
1171 : };
1172 :
1173 : static void
1174 0 : nvmf_subsystem_disconnect_host_fini(struct spdk_io_channel_iter *i, int status)
1175 : {
1176 : struct nvmf_subsystem_disconnect_host_ctx *ctx;
1177 :
1178 0 : ctx = spdk_io_channel_iter_get_ctx(i);
1179 :
1180 0 : if (ctx->cb_fn) {
1181 0 : ctx->cb_fn(ctx->cb_arg, status);
1182 0 : }
1183 0 : free(ctx->hostnqn);
1184 0 : free(ctx);
1185 0 : }
1186 :
1187 : static void
1188 0 : nvmf_subsystem_disconnect_qpairs_by_host(struct spdk_io_channel_iter *i)
1189 : {
1190 : struct nvmf_subsystem_disconnect_host_ctx *ctx;
1191 : struct spdk_nvmf_poll_group *group;
1192 : struct spdk_io_channel *ch;
1193 : struct spdk_nvmf_qpair *qpair, *tmp_qpair;
1194 : struct spdk_nvmf_ctrlr *ctrlr;
1195 :
1196 0 : ctx = spdk_io_channel_iter_get_ctx(i);
1197 0 : ch = spdk_io_channel_iter_get_channel(i);
1198 0 : group = spdk_io_channel_get_ctx(ch);
1199 :
1200 0 : TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) {
1201 0 : ctrlr = qpair->ctrlr;
1202 :
1203 0 : if (ctrlr == NULL || ctrlr->subsys != ctx->subsystem) {
1204 0 : continue;
1205 : }
1206 :
1207 0 : if (strncmp(ctrlr->hostnqn, ctx->hostnqn, sizeof(ctrlr->hostnqn)) == 0) {
1208 : /* Right now this does not wait for the queue pairs to actually disconnect. */
1209 0 : spdk_nvmf_qpair_disconnect(qpair);
1210 0 : }
1211 0 : }
1212 0 : spdk_for_each_channel_continue(i, 0);
1213 0 : }
1214 :
1215 : int
1216 0 : spdk_nvmf_subsystem_disconnect_host(struct spdk_nvmf_subsystem *subsystem,
1217 : const char *hostnqn,
1218 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
1219 : void *cb_arg)
1220 : {
1221 : struct nvmf_subsystem_disconnect_host_ctx *ctx;
1222 :
1223 0 : ctx = calloc(1, sizeof(struct nvmf_subsystem_disconnect_host_ctx));
1224 0 : if (ctx == NULL) {
1225 0 : return -ENOMEM;
1226 : }
1227 :
1228 0 : ctx->hostnqn = strdup(hostnqn);
1229 0 : if (ctx->hostnqn == NULL) {
1230 0 : free(ctx);
1231 0 : return -ENOMEM;
1232 : }
1233 :
1234 0 : ctx->subsystem = subsystem;
1235 0 : ctx->cb_fn = cb_fn;
1236 0 : ctx->cb_arg = cb_arg;
1237 :
1238 0 : spdk_for_each_channel(subsystem->tgt, nvmf_subsystem_disconnect_qpairs_by_host, ctx,
1239 : nvmf_subsystem_disconnect_host_fini);
1240 :
1241 0 : return 0;
1242 0 : }
1243 :
1244 : int
1245 0 : spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem, bool allow_any_host)
1246 : {
1247 0 : if (subsystem->allow_any_host == allow_any_host) {
1248 0 : return 0;
1249 : }
1250 :
1251 0 : pthread_mutex_lock(&subsystem->mutex);
1252 0 : subsystem->allow_any_host = allow_any_host;
1253 0 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
1254 0 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, NULL);
1255 0 : }
1256 0 : pthread_mutex_unlock(&subsystem->mutex);
1257 :
1258 0 : return 0;
1259 0 : }
1260 :
1261 : bool
1262 0 : spdk_nvmf_subsystem_get_allow_any_host(const struct spdk_nvmf_subsystem *subsystem)
1263 : {
1264 : bool allow_any_host;
1265 : struct spdk_nvmf_subsystem *sub;
1266 :
1267 : /* Technically, taking the mutex modifies data in the subsystem. But the const
1268 : * is still important to convey that this doesn't mutate any other data. Cast
1269 : * it away to work around this. */
1270 0 : sub = (struct spdk_nvmf_subsystem *)subsystem;
1271 :
1272 0 : pthread_mutex_lock(&sub->mutex);
1273 0 : allow_any_host = sub->allow_any_host;
1274 0 : pthread_mutex_unlock(&sub->mutex);
1275 :
1276 0 : return allow_any_host;
1277 : }
1278 :
1279 : bool
1280 31 : spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
1281 : {
1282 : bool allowed;
1283 :
1284 31 : if (!hostnqn) {
1285 0 : return false;
1286 : }
1287 :
1288 31 : pthread_mutex_lock(&subsystem->mutex);
1289 :
1290 31 : if (subsystem->allow_any_host) {
1291 25 : pthread_mutex_unlock(&subsystem->mutex);
1292 25 : return true;
1293 : }
1294 :
1295 6 : allowed = nvmf_subsystem_find_host(subsystem, hostnqn) != NULL;
1296 6 : pthread_mutex_unlock(&subsystem->mutex);
1297 :
1298 6 : return allowed;
1299 31 : }
1300 :
1301 : bool
1302 0 : nvmf_subsystem_host_auth_required(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
1303 : {
1304 : struct spdk_nvmf_host *host;
1305 : bool status;
1306 :
1307 0 : pthread_mutex_lock(&subsystem->mutex);
1308 0 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1309 0 : status = host != NULL && host->dhchap_key != NULL;
1310 0 : pthread_mutex_unlock(&subsystem->mutex);
1311 :
1312 0 : return status;
1313 : }
1314 :
1315 : struct spdk_key *
1316 0 : nvmf_subsystem_get_dhchap_key(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
1317 : enum nvmf_auth_key_type type)
1318 : {
1319 : struct spdk_nvmf_host *host;
1320 0 : struct spdk_key *key = NULL;
1321 :
1322 0 : pthread_mutex_lock(&subsystem->mutex);
1323 0 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1324 0 : if (host != NULL) {
1325 0 : switch (type) {
1326 : case NVMF_AUTH_KEY_HOST:
1327 0 : key = host->dhchap_key;
1328 0 : break;
1329 : case NVMF_AUTH_KEY_CTRLR:
1330 0 : key = host->dhchap_ctrlr_key;
1331 0 : break;
1332 : }
1333 0 : if (key != NULL) {
1334 0 : key = spdk_key_dup(key);
1335 0 : }
1336 0 : }
1337 0 : pthread_mutex_unlock(&subsystem->mutex);
1338 :
1339 0 : return key;
1340 : }
1341 :
1342 : struct spdk_nvmf_host *
1343 0 : spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem)
1344 : {
1345 0 : return TAILQ_FIRST(&subsystem->hosts);
1346 : }
1347 :
1348 :
1349 : struct spdk_nvmf_host *
1350 0 : spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem,
1351 : struct spdk_nvmf_host *prev_host)
1352 : {
1353 0 : return TAILQ_NEXT(prev_host, link);
1354 : }
1355 :
1356 : /* Must hold subsystem->mutex while calling this function */
1357 : static struct spdk_nvmf_host *
1358 0 : nvmf_referral_find_host(struct spdk_nvmf_referral *referral, const char *hostnqn)
1359 : {
1360 0 : struct spdk_nvmf_host *host = NULL;
1361 :
1362 0 : TAILQ_FOREACH(host, &referral->hosts, link) {
1363 0 : if (strcmp(hostnqn, host->nqn) == 0) {
1364 0 : return host;
1365 : }
1366 0 : }
1367 :
1368 0 : return NULL;
1369 0 : }
1370 :
1371 : int
1372 0 : spdk_nvmf_discovery_referral_add_host(struct spdk_nvmf_referral *referral,
1373 : const char *hostnqn, struct spdk_nvmf_host_opts *opts)
1374 : {
1375 : struct spdk_nvmf_host *host;
1376 : struct spdk_key *key;
1377 :
1378 0 : if (!nvmf_nqn_is_valid(hostnqn)) {
1379 0 : return -EINVAL;
1380 : }
1381 :
1382 0 : pthread_mutex_lock(&referral->mutex);
1383 :
1384 0 : if (nvmf_referral_find_host(referral, hostnqn)) {
1385 : /* This referral already allows the specified host. */
1386 0 : pthread_mutex_unlock(&referral->mutex);
1387 0 : return -EINVAL;
1388 : }
1389 :
1390 0 : host = calloc(1, sizeof(*host));
1391 0 : if (!host) {
1392 0 : pthread_mutex_unlock(&referral->mutex);
1393 0 : return -ENOMEM;
1394 : }
1395 :
1396 0 : key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
1397 0 : if (key != NULL) {
1398 0 : if (!nvmf_auth_is_supported()) {
1399 0 : SPDK_ERRLOG("NVMe in-band authentication is unsupported\n");
1400 0 : pthread_mutex_unlock(&referral->mutex);
1401 0 : nvmf_host_free(host);
1402 0 : return -EINVAL;
1403 : }
1404 0 : host->dhchap_key = spdk_key_dup(key);
1405 0 : if (host->dhchap_key == NULL) {
1406 0 : pthread_mutex_unlock(&referral->mutex);
1407 0 : nvmf_host_free(host);
1408 0 : return -EINVAL;
1409 : }
1410 0 : key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
1411 0 : if (key != NULL) {
1412 0 : host->dhchap_ctrlr_key = spdk_key_dup(key);
1413 0 : if (host->dhchap_ctrlr_key == NULL) {
1414 0 : pthread_mutex_unlock(&referral->mutex);
1415 0 : nvmf_host_free(host);
1416 0 : return -EINVAL;
1417 : }
1418 0 : }
1419 0 : } else if (SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL) != NULL) {
1420 0 : SPDK_ERRLOG("DH-HMAC-CHAP controller key requires host key to be set\n");
1421 0 : pthread_mutex_unlock(&referral->mutex);
1422 0 : nvmf_host_free(host);
1423 0 : return -EINVAL;
1424 : }
1425 :
1426 0 : snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
1427 :
1428 0 : TAILQ_INSERT_HEAD(&referral->hosts, host, link);
1429 :
1430 0 : pthread_mutex_unlock(&referral->mutex);
1431 :
1432 0 : return 0;
1433 0 : }
1434 :
1435 : int
1436 0 : spdk_nvmf_discovery_referral_remove_host(struct spdk_nvmf_referral *referral, const char *hostnqn)
1437 : {
1438 : struct spdk_nvmf_host *host;
1439 :
1440 0 : host = nvmf_referral_find_host(referral, hostnqn);
1441 0 : if (host != NULL) {
1442 0 : TAILQ_REMOVE(&referral->hosts, host, link);
1443 0 : nvmf_host_free(host);
1444 0 : }
1445 :
1446 0 : return 0;
1447 : }
1448 :
1449 : bool
1450 0 : spdk_nvmf_referral_get_allow_any_host(const struct spdk_nvmf_referral *referral)
1451 : {
1452 : bool allow_any_host;
1453 : struct spdk_nvmf_referral *ref;
1454 :
1455 : /* Technically, taking the mutex modifies data in the referral. But the const
1456 : * is still important to convey that this doesn't mutate any other data. Cast
1457 : * it away to work around this. */
1458 0 : ref = (struct spdk_nvmf_referral *)referral;
1459 :
1460 0 : allow_any_host = ref->allow_any_host;
1461 :
1462 0 : return allow_any_host;
1463 : }
1464 :
1465 : bool
1466 50 : spdk_nvmf_referral_host_allowed(struct spdk_nvmf_referral *referral, const char *hostnqn)
1467 : {
1468 : bool allowed;
1469 :
1470 50 : if (!hostnqn) {
1471 0 : return false;
1472 : }
1473 :
1474 50 : pthread_mutex_lock(&referral->mutex);
1475 :
1476 50 : if (referral->allow_any_host) {
1477 50 : pthread_mutex_unlock(&referral->mutex);
1478 50 : return true;
1479 : }
1480 :
1481 0 : allowed = nvmf_referral_find_host(referral, hostnqn) != NULL;
1482 0 : pthread_mutex_unlock(&referral->mutex);
1483 :
1484 0 : return allowed;
1485 50 : }
1486 :
1487 : struct spdk_nvmf_host *
1488 0 : spdk_nvmf_referral_get_first_host(struct spdk_nvmf_referral *referral)
1489 : {
1490 0 : return TAILQ_FIRST(&referral->hosts);
1491 : }
1492 :
1493 :
1494 : struct spdk_nvmf_host *
1495 0 : spdk_nvmf_referral_get_next_host(struct spdk_nvmf_referral *referral,
1496 : struct spdk_nvmf_host *prev_host)
1497 : {
1498 0 : return TAILQ_NEXT(prev_host, link);
1499 : }
1500 :
1501 : const char *
1502 0 : spdk_nvmf_host_get_nqn(const struct spdk_nvmf_host *host)
1503 : {
1504 0 : return host->nqn;
1505 : }
1506 :
1507 : struct spdk_nvmf_subsystem_listener *
1508 7 : nvmf_subsystem_find_listener(struct spdk_nvmf_subsystem *subsystem,
1509 : const struct spdk_nvme_transport_id *trid)
1510 : {
1511 : struct spdk_nvmf_subsystem_listener *listener;
1512 :
1513 22 : TAILQ_FOREACH(listener, &subsystem->listeners, link) {
1514 15 : if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
1515 0 : return listener;
1516 : }
1517 15 : }
1518 :
1519 7 : return NULL;
1520 7 : }
1521 :
1522 : /**
1523 : * Function to be called once the target is listening.
1524 : *
1525 : * \param ctx Context argument passed to this function.
1526 : * \param status 0 if it completed successfully, or negative errno if it failed.
1527 : */
1528 : static void
1529 7 : _nvmf_subsystem_add_listener_done(void *ctx, int status)
1530 : {
1531 7 : struct spdk_nvmf_subsystem_listener *listener = ctx;
1532 :
1533 7 : if (status) {
1534 0 : listener->cb_fn(listener->cb_arg, status);
1535 0 : free(listener);
1536 0 : return;
1537 : }
1538 :
1539 7 : TAILQ_INSERT_HEAD(&listener->subsystem->listeners, listener, link);
1540 :
1541 7 : if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
1542 0 : status = nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
1543 0 : if (status) {
1544 0 : TAILQ_REMOVE(&listener->subsystem->listeners, listener, link);
1545 0 : listener->cb_fn(listener->cb_arg, status);
1546 0 : free(listener);
1547 0 : return;
1548 : }
1549 0 : }
1550 :
1551 7 : spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL);
1552 7 : listener->cb_fn(listener->cb_arg, status);
1553 7 : }
1554 :
1555 : void
1556 7 : spdk_nvmf_subsystem_listener_opts_init(struct spdk_nvmf_listener_opts *opts, size_t size)
1557 : {
1558 7 : if (opts == NULL) {
1559 0 : SPDK_ERRLOG("opts should not be NULL\n");
1560 0 : assert(false);
1561 : return;
1562 : }
1563 7 : if (size == 0) {
1564 0 : SPDK_ERRLOG("size should not be zero\n");
1565 0 : assert(false);
1566 : return;
1567 : }
1568 :
1569 7 : memset(opts, 0, size);
1570 7 : opts->opts_size = size;
1571 :
1572 : #define FIELD_OK(field) \
1573 : offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(opts->field) <= size
1574 :
1575 : #define SET_FIELD(field, value) \
1576 : if (FIELD_OK(field)) { \
1577 : opts->field = value; \
1578 : } \
1579 :
1580 7 : SET_FIELD(secure_channel, false);
1581 7 : SET_FIELD(ana_state, SPDK_NVME_ANA_OPTIMIZED_STATE);
1582 7 : SET_FIELD(sock_impl, NULL);
1583 :
1584 : #undef FIELD_OK
1585 : #undef SET_FIELD
1586 7 : }
1587 :
1588 : static int
1589 0 : listener_opts_copy(struct spdk_nvmf_listener_opts *src, struct spdk_nvmf_listener_opts *dst)
1590 : {
1591 0 : if (src->opts_size == 0) {
1592 0 : SPDK_ERRLOG("source structure size should not be zero\n");
1593 0 : assert(false);
1594 : return -EINVAL;
1595 : }
1596 :
1597 0 : memset(dst, 0, sizeof(*dst));
1598 0 : dst->opts_size = src->opts_size;
1599 :
1600 : #define FIELD_OK(field) \
1601 : offsetof(struct spdk_nvmf_listener_opts, field) + sizeof(src->field) <= src->opts_size
1602 :
1603 : #define SET_FIELD(field) \
1604 : if (FIELD_OK(field)) { \
1605 : dst->field = src->field; \
1606 : } \
1607 :
1608 0 : SET_FIELD(secure_channel);
1609 0 : SET_FIELD(ana_state);
1610 0 : SET_FIELD(sock_impl);
1611 : /* We should not remove this statement, but need to update the assert statement
1612 : * if we add a new field, and also add a corresponding SET_FIELD statement. */
1613 : SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_listener_opts) == 24, "Incorrect size");
1614 :
1615 : #undef SET_FIELD
1616 : #undef FIELD_OK
1617 :
1618 0 : return 0;
1619 : }
1620 :
1621 : static void
1622 7 : _nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem,
1623 : struct spdk_nvme_transport_id *trid,
1624 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
1625 : void *cb_arg, struct spdk_nvmf_listener_opts *opts)
1626 : {
1627 : struct spdk_nvmf_transport *transport;
1628 : struct spdk_nvmf_subsystem_listener *listener;
1629 : struct spdk_nvmf_listener *tr_listener;
1630 : uint32_t i;
1631 : uint32_t id;
1632 7 : int rc = 0;
1633 :
1634 7 : assert(cb_fn != NULL);
1635 :
1636 7 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
1637 0 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1638 0 : cb_fn(cb_arg, -EAGAIN);
1639 0 : return;
1640 : }
1641 :
1642 7 : if (nvmf_subsystem_find_listener(subsystem, trid)) {
1643 : /* Listener already exists in this subsystem */
1644 0 : cb_fn(cb_arg, 0);
1645 0 : return;
1646 : }
1647 :
1648 7 : transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, trid->trstring);
1649 7 : if (!transport) {
1650 0 : SPDK_ERRLOG("Unable to find %s transport. The transport must be created first also make sure it is properly registered.\n",
1651 : trid->trstring);
1652 0 : cb_fn(cb_arg, -EINVAL);
1653 0 : return;
1654 : }
1655 :
1656 7 : tr_listener = nvmf_transport_find_listener(transport, trid);
1657 7 : if (!tr_listener) {
1658 0 : SPDK_ERRLOG("Cannot find transport listener for %s\n", trid->traddr);
1659 0 : cb_fn(cb_arg, -EINVAL);
1660 0 : return;
1661 : }
1662 :
1663 7 : listener = calloc(1, sizeof(*listener));
1664 7 : if (!listener) {
1665 0 : cb_fn(cb_arg, -ENOMEM);
1666 0 : return;
1667 : }
1668 :
1669 7 : listener->trid = &tr_listener->trid;
1670 7 : listener->transport = transport;
1671 7 : listener->cb_fn = cb_fn;
1672 7 : listener->cb_arg = cb_arg;
1673 7 : listener->subsystem = subsystem;
1674 7 : listener->ana_state = calloc(subsystem->max_nsid, sizeof(enum spdk_nvme_ana_state));
1675 7 : if (!listener->ana_state) {
1676 0 : free(listener);
1677 0 : cb_fn(cb_arg, -ENOMEM);
1678 0 : return;
1679 : }
1680 :
1681 7 : spdk_nvmf_subsystem_listener_opts_init(&listener->opts, sizeof(listener->opts));
1682 7 : if (opts != NULL) {
1683 0 : rc = listener_opts_copy(opts, &listener->opts);
1684 0 : if (rc) {
1685 0 : SPDK_ERRLOG("Unable to copy listener options\n");
1686 0 : free(listener->ana_state);
1687 0 : free(listener);
1688 0 : cb_fn(cb_arg, -EINVAL);
1689 0 : return;
1690 : }
1691 0 : }
1692 :
1693 7 : id = spdk_bit_array_find_first_clear(subsystem->used_listener_ids, 0);
1694 7 : if (id == UINT32_MAX) {
1695 0 : SPDK_ERRLOG("Cannot add any more listeners\n");
1696 0 : free(listener->ana_state);
1697 0 : free(listener->opts.sock_impl);
1698 0 : free(listener);
1699 0 : cb_fn(cb_arg, -EINVAL);
1700 0 : return;
1701 : }
1702 :
1703 7 : spdk_bit_array_set(subsystem->used_listener_ids, id);
1704 7 : listener->id = id;
1705 :
1706 231 : for (i = 0; i < subsystem->max_nsid; i++) {
1707 224 : listener->ana_state[i] = listener->opts.ana_state;
1708 224 : }
1709 :
1710 7 : if (transport->ops->listen_associate != NULL) {
1711 0 : rc = transport->ops->listen_associate(transport, subsystem, trid);
1712 0 : }
1713 :
1714 : SPDK_DTRACE_PROBE4(nvmf_subsystem_add_listener, subsystem->subnqn, listener->trid->trtype,
1715 : listener->trid->traddr, listener->trid->trsvcid);
1716 :
1717 7 : _nvmf_subsystem_add_listener_done(listener, rc);
1718 7 : }
1719 :
1720 : void
1721 7 : spdk_nvmf_subsystem_add_listener(struct spdk_nvmf_subsystem *subsystem,
1722 : struct spdk_nvme_transport_id *trid,
1723 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
1724 : void *cb_arg)
1725 : {
1726 7 : _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, NULL);
1727 7 : }
1728 :
1729 : void
1730 0 : spdk_nvmf_subsystem_add_listener_ext(struct spdk_nvmf_subsystem *subsystem,
1731 : struct spdk_nvme_transport_id *trid,
1732 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
1733 : void *cb_arg, struct spdk_nvmf_listener_opts *opts)
1734 : {
1735 0 : _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, opts);
1736 0 : }
1737 :
1738 : int
1739 0 : spdk_nvmf_subsystem_remove_listener(struct spdk_nvmf_subsystem *subsystem,
1740 : const struct spdk_nvme_transport_id *trid)
1741 : {
1742 : struct spdk_nvmf_subsystem_listener *listener;
1743 :
1744 0 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
1745 0 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1746 0 : return -EAGAIN;
1747 : }
1748 :
1749 0 : listener = nvmf_subsystem_find_listener(subsystem, trid);
1750 0 : if (listener == NULL) {
1751 0 : return -ENOENT;
1752 : }
1753 :
1754 : SPDK_DTRACE_PROBE4(nvmf_subsystem_remove_listener, subsystem->subnqn, listener->trid->trtype,
1755 : listener->trid->traddr, listener->trid->trsvcid);
1756 :
1757 0 : _nvmf_subsystem_remove_listener(subsystem, listener, false);
1758 :
1759 0 : return 0;
1760 0 : }
1761 :
1762 : void
1763 13 : nvmf_subsystem_remove_all_listeners(struct spdk_nvmf_subsystem *subsystem,
1764 : bool stop)
1765 : {
1766 : struct spdk_nvmf_subsystem_listener *listener, *listener_tmp;
1767 :
1768 20 : TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) {
1769 7 : _nvmf_subsystem_remove_listener(subsystem, listener, stop);
1770 7 : }
1771 13 : }
1772 :
1773 : bool
1774 0 : spdk_nvmf_subsystem_listener_allowed(struct spdk_nvmf_subsystem *subsystem,
1775 : const struct spdk_nvme_transport_id *trid)
1776 : {
1777 : struct spdk_nvmf_subsystem_listener *listener;
1778 :
1779 0 : TAILQ_FOREACH(listener, &subsystem->listeners, link) {
1780 0 : if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
1781 0 : return true;
1782 : }
1783 0 : }
1784 :
1785 0 : if (!strcmp(subsystem->subnqn, SPDK_NVMF_DISCOVERY_NQN)) {
1786 0 : SPDK_WARNLOG("Allowing connection to discovery subsystem on %s/%s/%s, "
1787 : "even though this listener was not added to the discovery "
1788 : "subsystem. This behavior is deprecated and will be removed "
1789 : "in a future release.\n",
1790 : spdk_nvme_transport_id_trtype_str(trid->trtype), trid->traddr, trid->trsvcid);
1791 0 : return true;
1792 : }
1793 :
1794 0 : return false;
1795 0 : }
1796 :
1797 : struct spdk_nvmf_subsystem_listener *
1798 30 : spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem)
1799 : {
1800 30 : return TAILQ_FIRST(&subsystem->listeners);
1801 : }
1802 :
1803 : struct spdk_nvmf_subsystem_listener *
1804 155 : spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem,
1805 : struct spdk_nvmf_subsystem_listener *prev_listener)
1806 : {
1807 155 : return TAILQ_NEXT(prev_listener, link);
1808 : }
1809 :
1810 : const struct spdk_nvme_transport_id *
1811 0 : spdk_nvmf_subsystem_listener_get_trid(struct spdk_nvmf_subsystem_listener *listener)
1812 : {
1813 0 : return listener->trid;
1814 : }
1815 :
1816 : void
1817 0 : spdk_nvmf_subsystem_allow_any_listener(struct spdk_nvmf_subsystem *subsystem,
1818 : bool allow_any_listener)
1819 : {
1820 0 : subsystem->flags.allow_any_listener = allow_any_listener;
1821 0 : }
1822 :
1823 : bool
1824 0 : spdk_nvmf_subsystem_any_listener_allowed(struct spdk_nvmf_subsystem *subsystem)
1825 : {
1826 0 : return subsystem->flags.allow_any_listener;
1827 : }
1828 :
1829 : struct subsystem_update_ns_ctx {
1830 : struct spdk_nvmf_subsystem *subsystem;
1831 :
1832 : spdk_nvmf_subsystem_state_change_done cb_fn;
1833 : void *cb_arg;
1834 : };
1835 :
1836 : static void
1837 0 : subsystem_update_ns_done(struct spdk_io_channel_iter *i, int status)
1838 : {
1839 0 : struct subsystem_update_ns_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
1840 :
1841 0 : if (ctx->cb_fn) {
1842 0 : ctx->cb_fn(ctx->subsystem, ctx->cb_arg, status);
1843 0 : }
1844 0 : free(ctx);
1845 0 : }
1846 :
1847 : static void
1848 0 : subsystem_update_ns_on_pg(struct spdk_io_channel_iter *i)
1849 : {
1850 : int rc;
1851 : struct subsystem_update_ns_ctx *ctx;
1852 : struct spdk_nvmf_poll_group *group;
1853 : struct spdk_nvmf_subsystem *subsystem;
1854 :
1855 0 : ctx = spdk_io_channel_iter_get_ctx(i);
1856 0 : group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i));
1857 0 : subsystem = ctx->subsystem;
1858 :
1859 0 : rc = nvmf_poll_group_update_subsystem(group, subsystem);
1860 0 : spdk_for_each_channel_continue(i, rc);
1861 0 : }
1862 :
1863 : static int
1864 0 : nvmf_subsystem_update_ns(struct spdk_nvmf_subsystem *subsystem,
1865 : spdk_nvmf_subsystem_state_change_done cb_fn, void *cb_arg)
1866 : {
1867 : struct subsystem_update_ns_ctx *ctx;
1868 :
1869 0 : ctx = calloc(1, sizeof(*ctx));
1870 0 : if (ctx == NULL) {
1871 0 : SPDK_ERRLOG("Can't alloc subsystem poll group update context\n");
1872 0 : return -ENOMEM;
1873 : }
1874 0 : ctx->subsystem = subsystem;
1875 0 : ctx->cb_fn = cb_fn;
1876 0 : ctx->cb_arg = cb_arg;
1877 :
1878 0 : spdk_for_each_channel(subsystem->tgt,
1879 : subsystem_update_ns_on_pg,
1880 0 : ctx,
1881 : subsystem_update_ns_done);
1882 0 : return 0;
1883 0 : }
1884 :
1885 : static void
1886 10 : nvmf_subsystem_ns_changed(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
1887 : {
1888 : struct spdk_nvmf_ctrlr *ctrlr;
1889 :
1890 14 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
1891 4 : if (nvmf_ctrlr_ns_is_visible(ctrlr, nsid)) {
1892 3 : nvmf_ctrlr_ns_changed(ctrlr, nsid);
1893 3 : }
1894 4 : }
1895 10 : }
1896 :
1897 : static uint32_t nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns);
1898 :
1899 : int
1900 5 : spdk_nvmf_subsystem_remove_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
1901 : {
1902 : struct spdk_nvmf_transport *transport;
1903 : struct spdk_nvmf_ns *ns;
1904 : struct spdk_nvmf_host *host, *tmp;
1905 : struct spdk_nvmf_ctrlr *ctrlr;
1906 :
1907 5 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
1908 1 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1909 0 : assert(false);
1910 : return -1;
1911 : }
1912 :
1913 5 : if (nsid == 0 || nsid > subsystem->max_nsid) {
1914 0 : return -1;
1915 : }
1916 :
1917 5 : ns = subsystem->ns[nsid - 1];
1918 5 : if (!ns) {
1919 0 : return -1;
1920 : }
1921 :
1922 5 : subsystem->ns[nsid - 1] = NULL;
1923 :
1924 5 : assert(ns->anagrpid - 1 < subsystem->max_nsid);
1925 5 : assert(subsystem->ana_group[ns->anagrpid - 1] > 0);
1926 :
1927 5 : subsystem->ana_group[ns->anagrpid - 1]--;
1928 :
1929 6 : TAILQ_FOREACH_SAFE(host, &ns->hosts, link, tmp) {
1930 1 : nvmf_ns_remove_host(ns, host);
1931 1 : }
1932 :
1933 5 : free(ns->ptpl_file);
1934 5 : nvmf_ns_reservation_clear_all_registrants(ns);
1935 5 : spdk_bdev_module_release_bdev(ns->bdev);
1936 5 : spdk_bdev_close(ns->desc);
1937 5 : free(ns);
1938 :
1939 5 : if (subsystem->fdp_supported && !spdk_nvmf_subsystem_get_first_ns(subsystem)) {
1940 1 : subsystem->fdp_supported = false;
1941 1 : SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u doesn't have FDP capability.\n",
1942 : subsystem->id);
1943 1 : }
1944 :
1945 5 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
1946 0 : transport = spdk_nvmf_transport_get_next(transport)) {
1947 0 : if (transport->ops->subsystem_remove_ns) {
1948 0 : transport->ops->subsystem_remove_ns(transport, subsystem, nsid);
1949 0 : }
1950 0 : }
1951 :
1952 5 : nvmf_subsystem_ns_changed(subsystem, nsid);
1953 :
1954 8 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
1955 3 : nvmf_ctrlr_ns_set_visible(ctrlr, nsid, false);
1956 3 : }
1957 :
1958 5 : return 0;
1959 5 : }
1960 :
1961 : struct subsystem_ns_change_ctx {
1962 : struct spdk_nvmf_subsystem *subsystem;
1963 : spdk_nvmf_subsystem_state_change_done cb_fn;
1964 : uint32_t nsid;
1965 : };
1966 :
1967 : static void
1968 1 : _nvmf_ns_hot_remove(struct spdk_nvmf_subsystem *subsystem,
1969 : void *cb_arg, int status)
1970 : {
1971 1 : struct subsystem_ns_change_ctx *ctx = cb_arg;
1972 : int rc;
1973 :
1974 1 : rc = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid);
1975 1 : if (rc != 0) {
1976 0 : SPDK_ERRLOG("Failed to make changes to NVME-oF subsystem with id: %u\n", subsystem->id);
1977 0 : }
1978 :
1979 1 : rc = spdk_nvmf_subsystem_resume(subsystem, NULL, NULL);
1980 1 : if (rc != 0) {
1981 0 : SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id);
1982 0 : }
1983 :
1984 1 : free(ctx);
1985 1 : }
1986 :
1987 : static void
1988 0 : nvmf_ns_change_msg(void *ns_ctx)
1989 : {
1990 0 : struct subsystem_ns_change_ctx *ctx = ns_ctx;
1991 : int rc;
1992 :
1993 : SPDK_DTRACE_PROBE2(nvmf_ns_change, ctx->nsid, ctx->subsystem->subnqn);
1994 :
1995 0 : rc = spdk_nvmf_subsystem_pause(ctx->subsystem, ctx->nsid, ctx->cb_fn, ctx);
1996 0 : if (rc) {
1997 0 : if (rc == -EBUSY) {
1998 : /* Try again, this is not a permanent situation. */
1999 0 : spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ctx);
2000 0 : } else {
2001 0 : free(ctx);
2002 0 : SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n");
2003 : }
2004 0 : }
2005 0 : }
2006 :
2007 : static void
2008 1 : nvmf_ns_hot_remove(void *remove_ctx)
2009 : {
2010 1 : struct spdk_nvmf_ns *ns = remove_ctx;
2011 : struct subsystem_ns_change_ctx *ns_ctx;
2012 : int rc;
2013 :
2014 : /* We have to allocate a new context because this op
2015 : * is asynchronous and we could lose the ns in the middle.
2016 : */
2017 1 : ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
2018 1 : if (!ns_ctx) {
2019 0 : SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
2020 0 : return;
2021 : }
2022 :
2023 1 : ns_ctx->subsystem = ns->subsystem;
2024 1 : ns_ctx->nsid = ns->opts.nsid;
2025 1 : ns_ctx->cb_fn = _nvmf_ns_hot_remove;
2026 :
2027 1 : rc = spdk_nvmf_subsystem_pause(ns->subsystem, ns_ctx->nsid, _nvmf_ns_hot_remove, ns_ctx);
2028 1 : if (rc) {
2029 0 : if (rc == -EBUSY) {
2030 : /* Try again, this is not a permanent situation. */
2031 0 : spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx);
2032 0 : } else {
2033 0 : SPDK_ERRLOG("Unable to pause subsystem to process namespace removal!\n");
2034 0 : free(ns_ctx);
2035 : }
2036 0 : }
2037 1 : }
2038 :
2039 : static void
2040 1 : _nvmf_ns_resize(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status)
2041 : {
2042 1 : struct subsystem_ns_change_ctx *ctx = cb_arg;
2043 :
2044 1 : nvmf_subsystem_ns_changed(subsystem, ctx->nsid);
2045 1 : if (spdk_nvmf_subsystem_resume(subsystem, NULL, NULL) != 0) {
2046 0 : SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id);
2047 0 : }
2048 :
2049 1 : free(ctx);
2050 1 : }
2051 :
2052 : static void
2053 1 : nvmf_ns_resize(void *event_ctx)
2054 : {
2055 1 : struct spdk_nvmf_ns *ns = event_ctx;
2056 : struct subsystem_ns_change_ctx *ns_ctx;
2057 : int rc;
2058 :
2059 : /* We have to allocate a new context because this op
2060 : * is asynchronous and we could lose the ns in the middle.
2061 : */
2062 1 : ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
2063 1 : if (!ns_ctx) {
2064 0 : SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
2065 0 : return;
2066 : }
2067 :
2068 1 : ns_ctx->subsystem = ns->subsystem;
2069 1 : ns_ctx->nsid = ns->opts.nsid;
2070 1 : ns_ctx->cb_fn = _nvmf_ns_resize;
2071 :
2072 : /* Specify 0 for the nsid here, because we do not need to pause the namespace.
2073 : * Namespaces can only be resized bigger, so there is no need to quiesce I/O.
2074 : */
2075 1 : rc = spdk_nvmf_subsystem_pause(ns->subsystem, 0, _nvmf_ns_resize, ns_ctx);
2076 1 : if (rc) {
2077 0 : if (rc == -EBUSY) {
2078 : /* Try again, this is not a permanent situation. */
2079 0 : spdk_thread_send_msg(spdk_get_thread(), nvmf_ns_change_msg, ns_ctx);
2080 0 : } else {
2081 0 : SPDK_ERRLOG("Unable to pause subsystem to process namespace resize!\n");
2082 0 : free(ns_ctx);
2083 : }
2084 0 : }
2085 1 : }
2086 :
2087 : static void
2088 2 : nvmf_ns_event(enum spdk_bdev_event_type type,
2089 : struct spdk_bdev *bdev,
2090 : void *event_ctx)
2091 : {
2092 2 : SPDK_DEBUGLOG(nvmf, "Bdev event: type %d, name %s, subsystem_id %d, ns_id %d\n",
2093 : type,
2094 : spdk_bdev_get_name(bdev),
2095 : ((struct spdk_nvmf_ns *)event_ctx)->subsystem->id,
2096 : ((struct spdk_nvmf_ns *)event_ctx)->nsid);
2097 :
2098 2 : switch (type) {
2099 : case SPDK_BDEV_EVENT_REMOVE:
2100 1 : nvmf_ns_hot_remove(event_ctx);
2101 1 : break;
2102 : case SPDK_BDEV_EVENT_RESIZE:
2103 1 : nvmf_ns_resize(event_ctx);
2104 1 : break;
2105 : default:
2106 0 : SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type);
2107 0 : break;
2108 : }
2109 2 : }
2110 :
2111 : void
2112 13 : spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size)
2113 : {
2114 13 : if (!opts) {
2115 0 : SPDK_ERRLOG("opts should not be NULL.\n");
2116 0 : return;
2117 : }
2118 :
2119 13 : if (!opts_size) {
2120 0 : SPDK_ERRLOG("opts_size should not be zero.\n");
2121 0 : return;
2122 : }
2123 :
2124 13 : memset(opts, 0, opts_size);
2125 13 : opts->opts_size = opts_size;
2126 :
2127 : #define FIELD_OK(field) \
2128 : offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= opts_size
2129 :
2130 : #define SET_FIELD(field, value) \
2131 : if (FIELD_OK(field)) { \
2132 : opts->field = value; \
2133 : } \
2134 :
2135 : /* All current fields are set to 0 by default. */
2136 13 : SET_FIELD(nsid, 0);
2137 13 : if (FIELD_OK(nguid)) {
2138 13 : memset(opts->nguid, 0, sizeof(opts->nguid));
2139 13 : }
2140 13 : if (FIELD_OK(eui64)) {
2141 13 : memset(opts->eui64, 0, sizeof(opts->eui64));
2142 13 : }
2143 13 : if (FIELD_OK(uuid)) {
2144 13 : spdk_uuid_set_null(&opts->uuid);
2145 13 : }
2146 13 : SET_FIELD(anagrpid, 0);
2147 13 : SET_FIELD(transport_specific, NULL);
2148 13 : SET_FIELD(hide_metadata, false);
2149 :
2150 : #undef FIELD_OK
2151 : #undef SET_FIELD
2152 13 : }
2153 :
2154 : static void
2155 6 : nvmf_ns_opts_copy(struct spdk_nvmf_ns_opts *opts,
2156 : const struct spdk_nvmf_ns_opts *user_opts,
2157 : size_t opts_size)
2158 : {
2159 : #define FIELD_OK(field) \
2160 : offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= user_opts->opts_size
2161 :
2162 : #define SET_FIELD(field) \
2163 : if (FIELD_OK(field)) { \
2164 : opts->field = user_opts->field; \
2165 : } \
2166 :
2167 6 : SET_FIELD(nsid);
2168 6 : if (FIELD_OK(nguid)) {
2169 6 : memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid));
2170 6 : }
2171 6 : if (FIELD_OK(eui64)) {
2172 6 : memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64));
2173 6 : }
2174 6 : if (FIELD_OK(uuid)) {
2175 6 : spdk_uuid_copy(&opts->uuid, &user_opts->uuid);
2176 6 : }
2177 6 : SET_FIELD(anagrpid);
2178 6 : SET_FIELD(no_auto_visible);
2179 6 : SET_FIELD(transport_specific);
2180 6 : SET_FIELD(hide_metadata);
2181 :
2182 6 : opts->opts_size = user_opts->opts_size;
2183 :
2184 : /* We should not remove this statement, but need to update the assert statement
2185 : * if we add a new field, and also add a corresponding SET_FIELD statement.
2186 : */
2187 : SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ns_opts) == 73, "Incorrect size");
2188 :
2189 : #undef FIELD_OK
2190 : #undef SET_FIELD
2191 6 : }
2192 :
2193 : /* Dummy bdev module used to to claim bdevs. */
2194 : static struct spdk_bdev_module ns_bdev_module = {
2195 : .name = "NVMe-oF Target",
2196 : };
2197 :
2198 : static int nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns,
2199 : const struct spdk_nvmf_reservation_info *info);
2200 : static int nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns,
2201 : struct spdk_nvmf_reservation_info *info);
2202 : static int nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns,
2203 : struct spdk_nvmf_reservation_info *info);
2204 :
2205 : bool
2206 0 : nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem)
2207 : {
2208 : struct spdk_nvmf_ns *ns;
2209 :
2210 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
2211 0 : ns != NULL;
2212 0 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
2213 0 : if (spdk_bdev_is_zoned(ns->bdev) &&
2214 0 : spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZONE_APPEND)) {
2215 0 : return true;
2216 : }
2217 0 : }
2218 :
2219 0 : return false;
2220 0 : }
2221 :
2222 : uint32_t
2223 7 : spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem, const char *bdev_name,
2224 : const struct spdk_nvmf_ns_opts *user_opts, size_t opts_size,
2225 : const char *ptpl_file)
2226 : {
2227 : struct spdk_nvmf_transport *transport;
2228 : struct spdk_nvmf_ns_opts opts;
2229 7 : struct spdk_bdev_open_opts open_opts = {};
2230 : struct spdk_nvmf_ns *ns, *first_ns;
2231 : struct spdk_nvmf_ctrlr *ctrlr;
2232 7 : struct spdk_nvmf_reservation_info info = {0};
2233 : int rc;
2234 : bool zone_append_supported;
2235 : uint64_t max_zone_append_size_kib;
2236 :
2237 7 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
2238 0 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
2239 0 : return 0;
2240 : }
2241 :
2242 7 : spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts));
2243 7 : if (user_opts) {
2244 6 : nvmf_ns_opts_copy(&opts, user_opts, opts_size);
2245 6 : }
2246 :
2247 7 : if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) {
2248 1 : SPDK_ERRLOG("Invalid NSID %" PRIu32 "\n", opts.nsid);
2249 1 : return 0;
2250 : }
2251 :
2252 6 : if (opts.nsid == 0) {
2253 : /*
2254 : * NSID not specified - find a free index.
2255 : *
2256 : * If no free slots are found, return error.
2257 : */
2258 2 : for (opts.nsid = 1; opts.nsid <= subsystem->max_nsid; opts.nsid++) {
2259 2 : if (_nvmf_subsystem_get_ns(subsystem, opts.nsid) == NULL) {
2260 2 : break;
2261 : }
2262 0 : }
2263 2 : if (opts.nsid > subsystem->max_nsid) {
2264 0 : SPDK_ERRLOG("No free namespace slot available in the subsystem\n");
2265 0 : return 0;
2266 : }
2267 2 : }
2268 :
2269 6 : if (opts.nsid > subsystem->max_nsid) {
2270 0 : SPDK_ERRLOG("NSID greater than maximum not allowed\n");
2271 0 : return 0;
2272 : }
2273 :
2274 6 : if (_nvmf_subsystem_get_ns(subsystem, opts.nsid)) {
2275 1 : SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", opts.nsid);
2276 1 : return 0;
2277 : }
2278 :
2279 5 : if (opts.anagrpid == 0) {
2280 5 : opts.anagrpid = opts.nsid;
2281 5 : }
2282 :
2283 5 : if (opts.anagrpid > subsystem->max_nsid) {
2284 0 : SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n");
2285 0 : return 0;
2286 : }
2287 :
2288 5 : ns = calloc(1, sizeof(*ns));
2289 5 : if (ns == NULL) {
2290 0 : SPDK_ERRLOG("Namespace allocation failed\n");
2291 0 : return 0;
2292 : }
2293 :
2294 5 : TAILQ_INIT(&ns->hosts);
2295 5 : ns->always_visible = !opts.no_auto_visible;
2296 5 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
2297 0 : nvmf_ctrlr_ns_set_visible(ctrlr, opts.nsid, ns->always_visible);
2298 0 : }
2299 :
2300 5 : spdk_bdev_open_opts_init(&open_opts, sizeof(open_opts));
2301 5 : open_opts.hide_metadata = opts.hide_metadata;
2302 :
2303 5 : rc = spdk_bdev_open_ext_v2(bdev_name, true, nvmf_ns_event, ns, &open_opts, &ns->desc);
2304 5 : if (rc != 0) {
2305 0 : SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n",
2306 : subsystem->subnqn, bdev_name, rc);
2307 0 : free(ns);
2308 0 : return 0;
2309 : }
2310 :
2311 5 : ns->bdev = spdk_bdev_desc_get_bdev(ns->desc);
2312 :
2313 5 : if (spdk_bdev_desc_get_md_size(ns->desc) != 0) {
2314 0 : if (!spdk_bdev_desc_is_md_interleaved(ns->desc)) {
2315 0 : SPDK_ERRLOG("Can't attach bdev with separate metadata.\n");
2316 0 : spdk_bdev_close(ns->desc);
2317 0 : free(ns);
2318 0 : return 0;
2319 : }
2320 :
2321 0 : if (spdk_bdev_desc_get_md_size(ns->desc) > SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE) {
2322 0 : SPDK_ERRLOG("Maximum supported interleaved md size %u, current md size %u\n",
2323 : SPDK_BDEV_MAX_INTERLEAVED_MD_SIZE,
2324 : spdk_bdev_desc_get_md_size(ns->desc));
2325 0 : spdk_bdev_close(ns->desc);
2326 0 : free(ns);
2327 0 : return 0;
2328 : }
2329 0 : }
2330 :
2331 5 : rc = spdk_bdev_module_claim_bdev(ns->bdev, ns->desc, &ns_bdev_module);
2332 5 : if (rc != 0) {
2333 0 : spdk_bdev_close(ns->desc);
2334 0 : free(ns);
2335 0 : return 0;
2336 : }
2337 :
2338 5 : ns->passthru_nsid = spdk_bdev_get_nvme_nsid(ns->bdev);
2339 5 : if (subsystem->passthrough && ns->passthru_nsid == 0) {
2340 0 : SPDK_ERRLOG("Only bdev_nvme namespaces can be added to a passthrough subsystem.\n");
2341 0 : goto err;
2342 : }
2343 :
2344 : /* Cache the zcopy capability of the bdev device */
2345 5 : ns->zcopy = spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZCOPY);
2346 :
2347 5 : if (spdk_uuid_is_null(&opts.uuid)) {
2348 5 : opts.uuid = *spdk_bdev_get_uuid(ns->bdev);
2349 5 : }
2350 :
2351 : /* if nguid descriptor is supported by bdev module (nvme) then uuid = nguid */
2352 5 : if (spdk_mem_all_zero(opts.nguid, sizeof(opts.nguid))) {
2353 : SPDK_STATIC_ASSERT(sizeof(opts.nguid) == sizeof(opts.uuid), "size mismatch");
2354 5 : memcpy(opts.nguid, spdk_bdev_get_uuid(ns->bdev), sizeof(opts.nguid));
2355 5 : }
2356 :
2357 5 : if (spdk_bdev_is_zoned(ns->bdev)) {
2358 0 : SPDK_DEBUGLOG(nvmf, "The added namespace is backed by a zoned block device.\n");
2359 0 : ns->csi = SPDK_NVME_CSI_ZNS;
2360 :
2361 0 : zone_append_supported = spdk_bdev_io_type_supported(ns->bdev,
2362 : SPDK_BDEV_IO_TYPE_ZONE_APPEND);
2363 0 : max_zone_append_size_kib = spdk_bdev_get_max_zone_append_size(ns->bdev) *
2364 0 : spdk_bdev_desc_get_block_size(ns->desc);
2365 :
2366 0 : if (_nvmf_subsystem_get_first_zoned_ns(subsystem) != NULL &&
2367 0 : (nvmf_subsystem_zone_append_supported(subsystem) != zone_append_supported ||
2368 0 : subsystem->max_zone_append_size_kib != max_zone_append_size_kib)) {
2369 0 : SPDK_ERRLOG("Namespaces with different zone append support or different zone append size are not allowed.\n");
2370 0 : goto err;
2371 : }
2372 :
2373 0 : subsystem->max_zone_append_size_kib = max_zone_append_size_kib;
2374 0 : }
2375 :
2376 5 : first_ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
2377 5 : if (!first_ns) {
2378 4 : if (spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
2379 1 : SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u has FDP capability.\n",
2380 : subsystem->id);
2381 1 : subsystem->fdp_supported = true;
2382 1 : }
2383 4 : } else {
2384 2 : if (spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps !=
2385 1 : spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
2386 1 : SPDK_ERRLOG("Subsystem with id: %u can%s FDP namespace.\n", subsystem->id,
2387 : spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps ? " only add" : "not add");
2388 1 : goto err;
2389 : }
2390 : }
2391 :
2392 4 : ns->opts = opts;
2393 4 : ns->subsystem = subsystem;
2394 4 : subsystem->ns[opts.nsid - 1] = ns;
2395 4 : ns->nsid = opts.nsid;
2396 4 : ns->anagrpid = opts.anagrpid;
2397 4 : subsystem->ana_group[ns->anagrpid - 1]++;
2398 4 : TAILQ_INIT(&ns->registrants);
2399 4 : if (ptpl_file) {
2400 0 : ns->ptpl_file = strdup(ptpl_file);
2401 0 : if (!ns->ptpl_file) {
2402 0 : SPDK_ERRLOG("Namespace ns->ptpl_file allocation failed\n");
2403 0 : goto err;
2404 : }
2405 0 : }
2406 :
2407 4 : if (nvmf_ns_is_ptpl_capable(ns)) {
2408 1 : rc = nvmf_ns_reservation_load(ns, &info);
2409 1 : if (rc) {
2410 0 : SPDK_ERRLOG("Subsystem load reservation failed\n");
2411 0 : goto err;
2412 : }
2413 :
2414 1 : rc = nvmf_ns_reservation_restore(ns, &info);
2415 1 : if (rc) {
2416 0 : SPDK_ERRLOG("Subsystem restore reservation failed\n");
2417 0 : goto err;
2418 : }
2419 1 : }
2420 :
2421 4 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
2422 0 : transport = spdk_nvmf_transport_get_next(transport)) {
2423 0 : if (transport->ops->subsystem_add_ns) {
2424 0 : rc = transport->ops->subsystem_add_ns(transport, subsystem, ns);
2425 0 : if (rc) {
2426 0 : SPDK_ERRLOG("Namespace attachment is not allowed by %s transport\n", transport->ops->name);
2427 0 : nvmf_ns_reservation_clear_all_registrants(ns);
2428 0 : goto err;
2429 : }
2430 0 : }
2431 0 : }
2432 :
2433 : /* JSON value obj is freed before sending the response. Set NULL to prevent usage of dangling pointer. */
2434 4 : ns->opts.transport_specific = NULL;
2435 :
2436 4 : SPDK_DEBUGLOG(nvmf, "Subsystem %s: bdev %s assigned nsid %" PRIu32 "\n",
2437 : spdk_nvmf_subsystem_get_nqn(subsystem),
2438 : bdev_name,
2439 : opts.nsid);
2440 :
2441 4 : nvmf_subsystem_ns_changed(subsystem, opts.nsid);
2442 :
2443 : SPDK_DTRACE_PROBE2(nvmf_subsystem_add_ns, subsystem->subnqn, ns->nsid);
2444 :
2445 4 : return opts.nsid;
2446 : err:
2447 1 : subsystem->ns[opts.nsid - 1] = NULL;
2448 1 : spdk_bdev_module_release_bdev(ns->bdev);
2449 1 : spdk_bdev_close(ns->desc);
2450 1 : free(ns->ptpl_file);
2451 1 : free(ns);
2452 :
2453 1 : return 0;
2454 7 : }
2455 :
2456 : int
2457 0 : spdk_nvmf_subsystem_set_ns_ana_group(struct spdk_nvmf_subsystem *subsystem,
2458 : uint32_t nsid, uint32_t anagrpid)
2459 : {
2460 : struct spdk_nvmf_ns *ns;
2461 :
2462 0 : if (anagrpid > subsystem->max_nsid) {
2463 0 : SPDK_ERRLOG("ANAGRPID greater than maximum NSID not allowed\n");
2464 0 : return -1;
2465 : }
2466 :
2467 0 : if (anagrpid == 0) {
2468 0 : SPDK_ERRLOG("Zero is not allowed to ANAGRPID\n");
2469 0 : return -1;
2470 : }
2471 :
2472 0 : if (nsid == 0 || nsid > subsystem->max_nsid) {
2473 0 : return -1;
2474 : }
2475 :
2476 0 : ns = subsystem->ns[nsid - 1];
2477 0 : if (!ns) {
2478 0 : return -1;
2479 : }
2480 :
2481 0 : assert(ns->anagrpid - 1 < subsystem->max_nsid);
2482 :
2483 0 : assert(subsystem->ana_group[ns->anagrpid - 1] > 0);
2484 :
2485 0 : subsystem->ana_group[ns->anagrpid - 1]--;
2486 :
2487 0 : subsystem->ana_group[anagrpid - 1]++;
2488 :
2489 0 : ns->anagrpid = anagrpid;
2490 0 : ns->opts.anagrpid = anagrpid;
2491 :
2492 0 : nvmf_subsystem_ns_changed(subsystem, nsid);
2493 :
2494 0 : return 0;
2495 0 : }
2496 :
2497 : static uint32_t
2498 19 : nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem,
2499 : uint32_t prev_nsid)
2500 : {
2501 : uint32_t nsid;
2502 :
2503 19 : if (prev_nsid >= subsystem->max_nsid) {
2504 1 : return 0;
2505 : }
2506 :
2507 4504 : for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) {
2508 4487 : if (subsystem->ns[nsid - 1]) {
2509 1 : return nsid;
2510 : }
2511 4486 : }
2512 :
2513 17 : return 0;
2514 19 : }
2515 :
2516 : struct spdk_nvmf_ns *
2517 19 : spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem)
2518 : {
2519 : uint32_t first_nsid;
2520 :
2521 19 : first_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, 0);
2522 19 : return _nvmf_subsystem_get_ns(subsystem, first_nsid);
2523 : }
2524 :
2525 : struct spdk_nvmf_ns *
2526 0 : spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem,
2527 : struct spdk_nvmf_ns *prev_ns)
2528 : {
2529 : uint32_t next_nsid;
2530 :
2531 0 : next_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->opts.nsid);
2532 0 : return _nvmf_subsystem_get_ns(subsystem, next_nsid);
2533 : }
2534 :
2535 : struct spdk_nvmf_ns *
2536 0 : spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
2537 : {
2538 0 : return _nvmf_subsystem_get_ns(subsystem, nsid);
2539 : }
2540 :
2541 : uint32_t
2542 0 : spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns)
2543 : {
2544 0 : return ns->opts.nsid;
2545 : }
2546 :
2547 : struct spdk_bdev *
2548 0 : spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns)
2549 : {
2550 0 : return ns->bdev;
2551 : }
2552 :
2553 : void
2554 0 : spdk_nvmf_ns_get_opts(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_ns_opts *opts,
2555 : size_t opts_size)
2556 : {
2557 0 : memset(opts, 0, opts_size);
2558 0 : memcpy(opts, &ns->opts, spdk_min(sizeof(ns->opts), opts_size));
2559 0 : }
2560 :
2561 : const char *
2562 0 : spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem)
2563 : {
2564 0 : return subsystem->sn;
2565 : }
2566 :
2567 : int
2568 4 : spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn)
2569 : {
2570 : size_t len, max_len;
2571 :
2572 4 : max_len = sizeof(subsystem->sn) - 1;
2573 4 : len = strlen(sn);
2574 4 : if (len > max_len) {
2575 1 : SPDK_DEBUGLOG(nvmf, "Invalid sn \"%s\": length %zu > max %zu\n",
2576 : sn, len, max_len);
2577 1 : return -1;
2578 : }
2579 :
2580 3 : if (!nvmf_valid_ascii_string(sn, len)) {
2581 1 : SPDK_DEBUGLOG(nvmf, "Non-ASCII sn\n");
2582 1 : SPDK_LOGDUMP(nvmf, "sn", sn, len);
2583 1 : return -1;
2584 : }
2585 :
2586 2 : snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn);
2587 :
2588 2 : return 0;
2589 4 : }
2590 :
2591 : const char *
2592 0 : spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem)
2593 : {
2594 0 : return subsystem->mn;
2595 : }
2596 :
2597 : int
2598 0 : spdk_nvmf_subsystem_set_mn(struct spdk_nvmf_subsystem *subsystem, const char *mn)
2599 : {
2600 : size_t len, max_len;
2601 :
2602 0 : if (mn == NULL) {
2603 0 : mn = MODEL_NUMBER_DEFAULT;
2604 0 : }
2605 0 : max_len = sizeof(subsystem->mn) - 1;
2606 0 : len = strlen(mn);
2607 0 : if (len > max_len) {
2608 0 : SPDK_DEBUGLOG(nvmf, "Invalid mn \"%s\": length %zu > max %zu\n",
2609 : mn, len, max_len);
2610 0 : return -1;
2611 : }
2612 :
2613 0 : if (!nvmf_valid_ascii_string(mn, len)) {
2614 0 : SPDK_DEBUGLOG(nvmf, "Non-ASCII mn\n");
2615 0 : SPDK_LOGDUMP(nvmf, "mn", mn, len);
2616 0 : return -1;
2617 : }
2618 :
2619 0 : snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", mn);
2620 :
2621 0 : return 0;
2622 0 : }
2623 :
2624 : const char *
2625 0 : spdk_nvmf_subsystem_get_nqn(const struct spdk_nvmf_subsystem *subsystem)
2626 : {
2627 0 : return subsystem->subnqn;
2628 : }
2629 :
2630 : const char *
2631 0 : spdk_nvmf_referral_get_nqn(const struct spdk_nvmf_referral *referral)
2632 : {
2633 0 : return referral->trid.subnqn;
2634 : }
2635 :
2636 : /* We have to use the typedef in the function declaration to appease astyle. */
2637 : typedef enum spdk_nvmf_subtype spdk_nvmf_subtype_t;
2638 :
2639 : spdk_nvmf_subtype_t
2640 0 : spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem)
2641 : {
2642 0 : return subsystem->subtype;
2643 : }
2644 :
2645 : uint32_t
2646 0 : spdk_nvmf_subsystem_get_max_nsid(struct spdk_nvmf_subsystem *subsystem)
2647 : {
2648 0 : return subsystem->max_nsid;
2649 : }
2650 :
2651 : int
2652 0 : spdk_nvmf_subsystem_set_cntlid_range(struct spdk_nvmf_subsystem *subsystem,
2653 : uint16_t min_cntlid, uint16_t max_cntlid)
2654 : {
2655 0 : if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
2656 0 : return -EAGAIN;
2657 : }
2658 :
2659 0 : if (min_cntlid > max_cntlid) {
2660 0 : return -EINVAL;
2661 : }
2662 : /* The spec reserves cntlid values in the range FFF0h to FFFFh. */
2663 0 : if (min_cntlid < NVMF_MIN_CNTLID || min_cntlid > NVMF_MAX_CNTLID ||
2664 0 : max_cntlid < NVMF_MIN_CNTLID || max_cntlid > NVMF_MAX_CNTLID) {
2665 0 : return -EINVAL;
2666 : }
2667 0 : subsystem->min_cntlid = min_cntlid;
2668 0 : subsystem->max_cntlid = max_cntlid;
2669 0 : if (subsystem->next_cntlid < min_cntlid || subsystem->next_cntlid > max_cntlid) {
2670 0 : subsystem->next_cntlid = min_cntlid;
2671 0 : }
2672 :
2673 0 : return 0;
2674 0 : }
2675 :
2676 : uint16_t
2677 1 : nvmf_subsystem_gen_cntlid(struct spdk_nvmf_subsystem *subsystem)
2678 : {
2679 : int count;
2680 : uint16_t cntlid;
2681 :
2682 : /*
2683 : * In the worst case, we might have to try all CNTLID values between min_cntlid and max_cntlid
2684 : * before we find one that is unused (or find that all values are in use).
2685 : */
2686 1 : for (count = 0; count < subsystem->max_cntlid - subsystem->min_cntlid + 1; count++) {
2687 1 : cntlid = subsystem->next_cntlid;
2688 1 : subsystem->next_cntlid++;
2689 :
2690 1 : if (subsystem->next_cntlid > subsystem->max_cntlid) {
2691 0 : subsystem->next_cntlid = subsystem->min_cntlid;
2692 0 : }
2693 :
2694 : /* Check if a controller with this cntlid currently exists. */
2695 1 : if (nvmf_subsystem_get_ctrlr(subsystem, cntlid) == NULL) {
2696 : /* Found unused cntlid */
2697 1 : return cntlid;
2698 : }
2699 0 : }
2700 :
2701 : /* All valid cntlid values are in use. */
2702 0 : return 0xFFFF;
2703 1 : }
2704 :
2705 : int
2706 1 : nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr)
2707 : {
2708 :
2709 1 : if (ctrlr->dynamic_ctrlr) {
2710 1 : ctrlr->cntlid = nvmf_subsystem_gen_cntlid(subsystem);
2711 1 : if (ctrlr->cntlid == 0xFFFF) {
2712 : /* Unable to get a cntlid */
2713 0 : SPDK_ERRLOG("Reached max simultaneous ctrlrs\n");
2714 0 : return -EBUSY;
2715 : }
2716 1 : } else if (nvmf_subsystem_get_ctrlr(subsystem, ctrlr->cntlid) != NULL) {
2717 0 : SPDK_ERRLOG("Ctrlr with cntlid %u already exist\n", ctrlr->cntlid);
2718 0 : return -EEXIST;
2719 : }
2720 :
2721 1 : TAILQ_INSERT_TAIL(&subsystem->ctrlrs, ctrlr, link);
2722 :
2723 : SPDK_DTRACE_PROBE3(nvmf_subsystem_add_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
2724 :
2725 1 : return 0;
2726 1 : }
2727 :
2728 : void
2729 1 : nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem,
2730 : struct spdk_nvmf_ctrlr *ctrlr)
2731 : {
2732 : SPDK_DTRACE_PROBE3(nvmf_subsystem_remove_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
2733 :
2734 1 : assert(spdk_get_thread() == subsystem->thread);
2735 1 : assert(subsystem == ctrlr->subsys);
2736 1 : SPDK_DEBUGLOG(nvmf, "remove ctrlr %p id 0x%x from subsys %p %s\n", ctrlr, ctrlr->cntlid, subsystem,
2737 : subsystem->subnqn);
2738 1 : TAILQ_REMOVE(&subsystem->ctrlrs, ctrlr, link);
2739 1 : }
2740 :
2741 : struct spdk_nvmf_ctrlr *
2742 2 : nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid)
2743 : {
2744 : struct spdk_nvmf_ctrlr *ctrlr;
2745 :
2746 2 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
2747 1 : if (ctrlr->cntlid == cntlid) {
2748 1 : return ctrlr;
2749 : }
2750 0 : }
2751 :
2752 1 : return NULL;
2753 2 : }
2754 :
2755 : uint32_t
2756 0 : spdk_nvmf_subsystem_get_max_namespaces(const struct spdk_nvmf_subsystem *subsystem)
2757 : {
2758 0 : return subsystem->max_nsid;
2759 : }
2760 :
2761 : uint16_t
2762 0 : spdk_nvmf_subsystem_get_min_cntlid(const struct spdk_nvmf_subsystem *subsystem)
2763 : {
2764 0 : return subsystem->min_cntlid;
2765 : }
2766 :
2767 : uint16_t
2768 0 : spdk_nvmf_subsystem_get_max_cntlid(const struct spdk_nvmf_subsystem *subsystem)
2769 : {
2770 0 : return subsystem->max_cntlid;
2771 : }
2772 :
2773 : struct _nvmf_ns_registrant {
2774 : uint64_t rkey;
2775 : char *host_uuid;
2776 : };
2777 :
2778 : struct _nvmf_ns_registrants {
2779 : size_t num_regs;
2780 : struct _nvmf_ns_registrant reg[SPDK_NVMF_MAX_NUM_REGISTRANTS];
2781 : };
2782 :
2783 : struct _nvmf_ns_reservation {
2784 : bool ptpl_activated;
2785 : enum spdk_nvme_reservation_type rtype;
2786 : uint64_t crkey;
2787 : char *bdev_uuid;
2788 : char *holder_uuid;
2789 : struct _nvmf_ns_registrants regs;
2790 : };
2791 :
2792 : static const struct spdk_json_object_decoder nvmf_ns_pr_reg_decoders[] = {
2793 : {"rkey", offsetof(struct _nvmf_ns_registrant, rkey), spdk_json_decode_uint64},
2794 : {"host_uuid", offsetof(struct _nvmf_ns_registrant, host_uuid), spdk_json_decode_string},
2795 : };
2796 :
2797 : static int
2798 4 : nvmf_decode_ns_pr_reg(const struct spdk_json_val *val, void *out)
2799 : {
2800 4 : struct _nvmf_ns_registrant *reg = out;
2801 :
2802 8 : return spdk_json_decode_object(val, nvmf_ns_pr_reg_decoders,
2803 4 : SPDK_COUNTOF(nvmf_ns_pr_reg_decoders), reg);
2804 : }
2805 :
2806 : static int
2807 4 : nvmf_decode_ns_pr_regs(const struct spdk_json_val *val, void *out)
2808 : {
2809 4 : struct _nvmf_ns_registrants *regs = out;
2810 :
2811 8 : return spdk_json_decode_array(val, nvmf_decode_ns_pr_reg, regs->reg,
2812 4 : SPDK_NVMF_MAX_NUM_REGISTRANTS, ®s->num_regs,
2813 : sizeof(struct _nvmf_ns_registrant));
2814 : }
2815 :
2816 : static const struct spdk_json_object_decoder nvmf_ns_pr_decoders[] = {
2817 : {"ptpl", offsetof(struct _nvmf_ns_reservation, ptpl_activated), spdk_json_decode_bool, true},
2818 : {"rtype", offsetof(struct _nvmf_ns_reservation, rtype), spdk_json_decode_uint32, true},
2819 : {"crkey", offsetof(struct _nvmf_ns_reservation, crkey), spdk_json_decode_uint64, true},
2820 : {"bdev_uuid", offsetof(struct _nvmf_ns_reservation, bdev_uuid), spdk_json_decode_string},
2821 : {"holder_uuid", offsetof(struct _nvmf_ns_reservation, holder_uuid), spdk_json_decode_string, true},
2822 : {"registrants", offsetof(struct _nvmf_ns_reservation, regs), nvmf_decode_ns_pr_regs},
2823 : };
2824 :
2825 : static int
2826 5 : nvmf_ns_reservation_load_json(const struct spdk_nvmf_ns *ns,
2827 : struct spdk_nvmf_reservation_info *info)
2828 : {
2829 : size_t json_size;
2830 : ssize_t values_cnt, rc;
2831 5 : void *json = NULL, *end;
2832 5 : struct spdk_json_val *values = NULL;
2833 5 : struct _nvmf_ns_reservation res = {};
2834 5 : const char *file = ns->ptpl_file;
2835 : uint32_t i;
2836 :
2837 : /* It's not an error if the file does not exist */
2838 5 : if (access(file, F_OK) != 0) {
2839 0 : SPDK_DEBUGLOG(nvmf, "File %s does not exist\n", file);
2840 0 : return 0;
2841 : }
2842 :
2843 : /* Load all persist file contents into a local buffer */
2844 5 : json = spdk_posix_file_load_from_name(file, &json_size);
2845 5 : if (!json) {
2846 0 : SPDK_ERRLOG("Load persist file %s failed\n", file);
2847 0 : return -ENOMEM;
2848 : }
2849 :
2850 5 : rc = spdk_json_parse(json, json_size, NULL, 0, &end, 0);
2851 5 : if (rc < 0) {
2852 1 : SPDK_NOTICELOG("Parsing JSON configuration failed (%zd)\n", rc);
2853 1 : goto exit;
2854 : }
2855 :
2856 4 : values_cnt = rc;
2857 4 : values = calloc(values_cnt, sizeof(struct spdk_json_val));
2858 4 : if (values == NULL) {
2859 0 : goto exit;
2860 : }
2861 :
2862 4 : rc = spdk_json_parse(json, json_size, values, values_cnt, &end, 0);
2863 4 : if (rc != values_cnt) {
2864 0 : SPDK_ERRLOG("Parsing JSON configuration failed (%zd)\n", rc);
2865 0 : goto exit;
2866 : }
2867 :
2868 : /* Decode json */
2869 4 : if (spdk_json_decode_object(values, nvmf_ns_pr_decoders,
2870 : SPDK_COUNTOF(nvmf_ns_pr_decoders),
2871 : &res)) {
2872 0 : SPDK_ERRLOG("Invalid objects in the persist file %s\n", file);
2873 0 : rc = -EINVAL;
2874 0 : goto exit;
2875 : }
2876 :
2877 4 : if (res.regs.num_regs > SPDK_NVMF_MAX_NUM_REGISTRANTS) {
2878 0 : SPDK_ERRLOG("Can only support up to %u registrants\n", SPDK_NVMF_MAX_NUM_REGISTRANTS);
2879 0 : rc = -ERANGE;
2880 0 : goto exit;
2881 : }
2882 :
2883 4 : rc = 0;
2884 4 : info->ptpl_activated = res.ptpl_activated;
2885 4 : info->rtype = res.rtype;
2886 4 : info->crkey = res.crkey;
2887 4 : snprintf(info->bdev_uuid, sizeof(info->bdev_uuid), "%s", res.bdev_uuid);
2888 4 : snprintf(info->holder_uuid, sizeof(info->holder_uuid), "%s", res.holder_uuid);
2889 4 : info->num_regs = res.regs.num_regs;
2890 8 : for (i = 0; i < res.regs.num_regs; i++) {
2891 4 : info->registrants[i].rkey = res.regs.reg[i].rkey;
2892 8 : snprintf(info->registrants[i].host_uuid, sizeof(info->registrants[i].host_uuid), "%s",
2893 4 : res.regs.reg[i].host_uuid);
2894 8 : }
2895 :
2896 : exit:
2897 5 : free(json);
2898 5 : free(values);
2899 5 : free(res.bdev_uuid);
2900 5 : free(res.holder_uuid);
2901 9 : for (i = 0; i < res.regs.num_regs; i++) {
2902 4 : free(res.regs.reg[i].host_uuid);
2903 4 : }
2904 :
2905 5 : return rc;
2906 5 : }
2907 :
2908 : static bool nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns);
2909 :
2910 : static int
2911 5 : nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
2912 : {
2913 : uint32_t i;
2914 5 : struct spdk_nvmf_registrant *reg, *holder = NULL;
2915 : struct spdk_uuid bdev_uuid, holder_uuid;
2916 5 : bool rkey_flag = false;
2917 :
2918 5 : SPDK_DEBUGLOG(nvmf, "NSID %u, PTPL %u, Number of registrants %u\n",
2919 : ns->nsid, info->ptpl_activated, info->num_regs);
2920 :
2921 : /* it's not an error */
2922 5 : if (!info->ptpl_activated || !info->num_regs) {
2923 0 : return 0;
2924 : }
2925 :
2926 : /* Check info->crkey exist or not in info->registrants[i].rkey */
2927 14 : for (i = 0; i < info->num_regs; i++) {
2928 9 : if (info->crkey == info->registrants[i].rkey) {
2929 3 : rkey_flag = true;
2930 3 : }
2931 9 : }
2932 5 : if (!rkey_flag && info->crkey != 0) {
2933 1 : return -EINVAL;
2934 : }
2935 :
2936 4 : spdk_uuid_parse(&bdev_uuid, info->bdev_uuid);
2937 4 : if (spdk_uuid_compare(&bdev_uuid, spdk_bdev_get_uuid(ns->bdev))) {
2938 1 : SPDK_ERRLOG("Existing bdev UUID is not same with configuration file\n");
2939 1 : return -EINVAL;
2940 : }
2941 :
2942 3 : ns->crkey = info->crkey;
2943 3 : ns->rtype = info->rtype;
2944 3 : ns->ptpl_activated = info->ptpl_activated;
2945 3 : spdk_uuid_parse(&holder_uuid, info->holder_uuid);
2946 :
2947 3 : SPDK_DEBUGLOG(nvmf, "Bdev UUID %s\n", info->bdev_uuid);
2948 3 : if (info->rtype) {
2949 2 : SPDK_DEBUGLOG(nvmf, "Holder UUID %s, RTYPE %u, RKEY 0x%"PRIx64"\n",
2950 : info->holder_uuid, info->rtype, info->crkey);
2951 2 : }
2952 :
2953 8 : for (i = 0; i < info->num_regs; i++) {
2954 5 : reg = calloc(1, sizeof(*reg));
2955 5 : if (!reg) {
2956 0 : return -ENOMEM;
2957 : }
2958 5 : spdk_uuid_parse(®->hostid, info->registrants[i].host_uuid);
2959 5 : reg->rkey = info->registrants[i].rkey;
2960 5 : TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
2961 5 : if (info->crkey != 0 && !spdk_uuid_compare(&holder_uuid, ®->hostid)) {
2962 2 : holder = reg;
2963 2 : }
2964 5 : SPDK_DEBUGLOG(nvmf, "Registrant RKEY 0x%"PRIx64", Host UUID %s\n",
2965 : info->registrants[i].rkey, info->registrants[i].host_uuid);
2966 5 : }
2967 :
2968 3 : if (nvmf_ns_reservation_all_registrants_type(ns)) {
2969 1 : ns->holder = TAILQ_FIRST(&ns->registrants);
2970 1 : } else {
2971 2 : ns->holder = holder;
2972 : }
2973 :
2974 3 : return 0;
2975 5 : }
2976 :
2977 : static int
2978 5 : nvmf_ns_json_write_cb(void *cb_ctx, const void *data, size_t size)
2979 : {
2980 5 : char *file = cb_ctx;
2981 : size_t rc;
2982 : FILE *fd;
2983 :
2984 5 : fd = fopen(file, "w");
2985 5 : if (!fd) {
2986 0 : SPDK_ERRLOG("Can't open file %s for write\n", file);
2987 0 : return -ENOENT;
2988 : }
2989 5 : rc = fwrite(data, 1, size, fd);
2990 5 : fclose(fd);
2991 :
2992 5 : return rc == size ? 0 : -1;
2993 5 : }
2994 :
2995 : static int
2996 5 : nvmf_ns_reservation_update_json(const struct spdk_nvmf_ns *ns,
2997 : const struct spdk_nvmf_reservation_info *info)
2998 : {
2999 5 : const char *file = ns->ptpl_file;
3000 : struct spdk_json_write_ctx *w;
3001 : uint32_t i;
3002 5 : int rc = 0;
3003 :
3004 5 : w = spdk_json_write_begin(nvmf_ns_json_write_cb, (void *)file, 0);
3005 5 : if (w == NULL) {
3006 0 : return -ENOMEM;
3007 : }
3008 : /* clear the configuration file */
3009 5 : if (!info->ptpl_activated) {
3010 1 : goto exit;
3011 : }
3012 :
3013 4 : spdk_json_write_object_begin(w);
3014 4 : spdk_json_write_named_bool(w, "ptpl", info->ptpl_activated);
3015 4 : spdk_json_write_named_uint32(w, "rtype", info->rtype);
3016 4 : spdk_json_write_named_uint64(w, "crkey", info->crkey);
3017 4 : spdk_json_write_named_string(w, "bdev_uuid", info->bdev_uuid);
3018 4 : spdk_json_write_named_string(w, "holder_uuid", info->holder_uuid);
3019 :
3020 4 : spdk_json_write_named_array_begin(w, "registrants");
3021 8 : for (i = 0; i < info->num_regs; i++) {
3022 4 : spdk_json_write_object_begin(w);
3023 4 : spdk_json_write_named_uint64(w, "rkey", info->registrants[i].rkey);
3024 4 : spdk_json_write_named_string(w, "host_uuid", info->registrants[i].host_uuid);
3025 4 : spdk_json_write_object_end(w);
3026 4 : }
3027 4 : spdk_json_write_array_end(w);
3028 4 : spdk_json_write_object_end(w);
3029 :
3030 : exit:
3031 5 : rc = spdk_json_write_end(w);
3032 5 : return rc;
3033 5 : }
3034 :
3035 : static int
3036 7 : nvmf_ns_update_reservation_info(struct spdk_nvmf_ns *ns)
3037 : {
3038 : struct spdk_nvmf_reservation_info info;
3039 : struct spdk_nvmf_registrant *reg, *tmp;
3040 7 : uint32_t i = 0;
3041 :
3042 7 : assert(ns != NULL);
3043 :
3044 7 : if (!ns->bdev || !nvmf_ns_is_ptpl_capable(ns)) {
3045 0 : return 0;
3046 : }
3047 :
3048 7 : memset(&info, 0, sizeof(info));
3049 7 : spdk_uuid_fmt_lower(info.bdev_uuid, sizeof(info.bdev_uuid), spdk_bdev_get_uuid(ns->bdev));
3050 :
3051 7 : if (ns->rtype) {
3052 2 : info.rtype = ns->rtype;
3053 2 : info.crkey = ns->crkey;
3054 2 : if (!nvmf_ns_reservation_all_registrants_type(ns)) {
3055 2 : assert(ns->holder != NULL);
3056 2 : spdk_uuid_fmt_lower(info.holder_uuid, sizeof(info.holder_uuid), &ns->holder->hostid);
3057 2 : }
3058 2 : }
3059 :
3060 14 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3061 14 : spdk_uuid_fmt_lower(info.registrants[i].host_uuid, sizeof(info.registrants[i].host_uuid),
3062 7 : ®->hostid);
3063 7 : info.registrants[i++].rkey = reg->rkey;
3064 7 : }
3065 :
3066 7 : info.num_regs = i;
3067 7 : info.ptpl_activated = ns->ptpl_activated;
3068 :
3069 7 : return nvmf_ns_reservation_update(ns, &info);
3070 7 : }
3071 :
3072 : static struct spdk_nvmf_registrant *
3073 110 : nvmf_ns_reservation_get_registrant(struct spdk_nvmf_ns *ns,
3074 : struct spdk_uuid *uuid)
3075 : {
3076 : struct spdk_nvmf_registrant *reg, *tmp;
3077 :
3078 191 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3079 151 : if (!spdk_uuid_compare(®->hostid, uuid)) {
3080 70 : return reg;
3081 : }
3082 81 : }
3083 :
3084 40 : return NULL;
3085 110 : }
3086 :
3087 : /* Generate reservation notice log to registered HostID controllers */
3088 : static void
3089 10 : nvmf_subsystem_gen_ctrlr_notification(struct spdk_nvmf_subsystem *subsystem,
3090 : struct spdk_nvmf_ns *ns,
3091 : struct spdk_uuid *hostid_list,
3092 : uint32_t num_hostid,
3093 : enum spdk_nvme_reservation_notification_log_page_type type)
3094 : {
3095 : struct spdk_nvmf_ctrlr *ctrlr;
3096 : uint32_t i;
3097 :
3098 25 : for (i = 0; i < num_hostid; i++) {
3099 75 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
3100 60 : if (!spdk_uuid_compare(&ctrlr->hostid, &hostid_list[i])) {
3101 22 : nvmf_ctrlr_reservation_notice_log(ctrlr, ns, type);
3102 22 : }
3103 60 : }
3104 15 : }
3105 10 : }
3106 :
3107 : /* Get all registrants' hostid other than the controller who issued the command */
3108 : static uint32_t
3109 16 : nvmf_ns_reservation_get_all_other_hostid(struct spdk_nvmf_ns *ns,
3110 : struct spdk_uuid *hostid_list,
3111 : uint32_t max_num_hostid,
3112 : struct spdk_uuid *current_hostid)
3113 : {
3114 : struct spdk_nvmf_registrant *reg, *tmp;
3115 16 : uint32_t num_hostid = 0;
3116 :
3117 55 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3118 39 : if (spdk_uuid_compare(®->hostid, current_hostid)) {
3119 23 : if (num_hostid == max_num_hostid) {
3120 0 : assert(false);
3121 : return max_num_hostid;
3122 : }
3123 23 : hostid_list[num_hostid++] = reg->hostid;
3124 23 : }
3125 39 : }
3126 :
3127 16 : return num_hostid;
3128 : }
3129 :
3130 : /* Calculate the unregistered HostID list according to list
3131 : * prior to execute preempt command and list after executing
3132 : * preempt command.
3133 : */
3134 : static uint32_t
3135 3 : nvmf_ns_reservation_get_unregistered_hostid(struct spdk_uuid *old_hostid_list,
3136 : uint32_t old_num_hostid,
3137 : struct spdk_uuid *remaining_hostid_list,
3138 : uint32_t remaining_num_hostid)
3139 : {
3140 : struct spdk_uuid temp_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3141 3 : uint32_t i, j, num_hostid = 0;
3142 : bool found;
3143 :
3144 3 : if (!remaining_num_hostid) {
3145 1 : return old_num_hostid;
3146 : }
3147 :
3148 6 : for (i = 0; i < old_num_hostid; i++) {
3149 4 : found = false;
3150 6 : for (j = 0; j < remaining_num_hostid; j++) {
3151 4 : if (!spdk_uuid_compare(&old_hostid_list[i], &remaining_hostid_list[j])) {
3152 2 : found = true;
3153 2 : break;
3154 : }
3155 2 : }
3156 4 : if (!found) {
3157 2 : spdk_uuid_copy(&temp_hostid_list[num_hostid++], &old_hostid_list[i]);
3158 2 : }
3159 4 : }
3160 :
3161 2 : if (num_hostid) {
3162 2 : memcpy(old_hostid_list, temp_hostid_list, sizeof(struct spdk_uuid) * num_hostid);
3163 2 : }
3164 :
3165 2 : return num_hostid;
3166 3 : }
3167 :
3168 : /* current reservation type is all registrants or not */
3169 : static bool
3170 54 : nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns)
3171 : {
3172 54 : return (ns->rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS ||
3173 48 : ns->rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS);
3174 : }
3175 :
3176 : /* current registrant is reservation holder or not */
3177 : static bool
3178 26 : nvmf_ns_reservation_registrant_is_holder(struct spdk_nvmf_ns *ns,
3179 : struct spdk_nvmf_registrant *reg)
3180 : {
3181 26 : if (!reg) {
3182 0 : return false;
3183 : }
3184 :
3185 26 : if (nvmf_ns_reservation_all_registrants_type(ns)) {
3186 2 : return true;
3187 : }
3188 :
3189 24 : return (ns->holder == reg);
3190 26 : }
3191 :
3192 : static int
3193 29 : nvmf_ns_reservation_add_registrant(struct spdk_nvmf_ns *ns,
3194 : struct spdk_nvmf_ctrlr *ctrlr,
3195 : uint64_t nrkey)
3196 : {
3197 : struct spdk_nvmf_registrant *reg;
3198 :
3199 29 : reg = calloc(1, sizeof(*reg));
3200 29 : if (!reg) {
3201 0 : return -ENOMEM;
3202 : }
3203 :
3204 29 : reg->rkey = nrkey;
3205 : /* set hostid for the registrant */
3206 29 : spdk_uuid_copy(®->hostid, &ctrlr->hostid);
3207 29 : TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
3208 29 : ns->gen++;
3209 :
3210 29 : return 0;
3211 29 : }
3212 :
3213 : static void
3214 11 : nvmf_ns_reservation_release_reservation(struct spdk_nvmf_ns *ns)
3215 : {
3216 11 : ns->rtype = 0;
3217 11 : ns->crkey = 0;
3218 11 : ns->holder = NULL;
3219 11 : }
3220 :
3221 : /* release the reservation if the last registrant was removed */
3222 : static void
3223 19 : nvmf_ns_reservation_check_release_on_remove_registrant(struct spdk_nvmf_ns *ns,
3224 : struct spdk_nvmf_registrant *reg)
3225 : {
3226 : struct spdk_nvmf_registrant *next_reg;
3227 :
3228 : /* no reservation holder */
3229 19 : if (!ns->holder) {
3230 7 : assert(ns->rtype == 0);
3231 7 : return;
3232 : }
3233 :
3234 12 : next_reg = TAILQ_FIRST(&ns->registrants);
3235 12 : if (next_reg && nvmf_ns_reservation_all_registrants_type(ns)) {
3236 : /* the next valid registrant is the new holder now */
3237 2 : ns->holder = next_reg;
3238 12 : } else if (nvmf_ns_reservation_registrant_is_holder(ns, reg)) {
3239 : /* release the reservation */
3240 7 : nvmf_ns_reservation_release_reservation(ns);
3241 7 : }
3242 19 : }
3243 :
3244 : static void
3245 19 : nvmf_ns_reservation_remove_registrant(struct spdk_nvmf_ns *ns,
3246 : struct spdk_nvmf_registrant *reg)
3247 : {
3248 19 : TAILQ_REMOVE(&ns->registrants, reg, link);
3249 19 : nvmf_ns_reservation_check_release_on_remove_registrant(ns, reg);
3250 19 : free(reg);
3251 19 : ns->gen++;
3252 19 : return;
3253 : }
3254 :
3255 : static uint32_t
3256 0 : nvmf_ns_reservation_remove_registrants_by_key(struct spdk_nvmf_ns *ns,
3257 : uint64_t rkey)
3258 : {
3259 : struct spdk_nvmf_registrant *reg, *tmp;
3260 0 : uint32_t count = 0;
3261 :
3262 0 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3263 0 : if (reg->rkey == rkey) {
3264 0 : nvmf_ns_reservation_remove_registrant(ns, reg);
3265 0 : count++;
3266 0 : }
3267 0 : }
3268 0 : return count;
3269 : }
3270 :
3271 : static uint32_t
3272 1 : nvmf_ns_reservation_remove_all_other_registrants(struct spdk_nvmf_ns *ns,
3273 : struct spdk_nvmf_registrant *reg)
3274 : {
3275 : struct spdk_nvmf_registrant *reg_tmp, *reg_tmp2;
3276 1 : uint32_t count = 0;
3277 :
3278 3 : TAILQ_FOREACH_SAFE(reg_tmp, &ns->registrants, link, reg_tmp2) {
3279 2 : if (reg_tmp != reg) {
3280 1 : nvmf_ns_reservation_remove_registrant(ns, reg_tmp);
3281 1 : count++;
3282 1 : }
3283 2 : }
3284 1 : return count;
3285 : }
3286 :
3287 : static uint32_t
3288 9 : nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns)
3289 : {
3290 : struct spdk_nvmf_registrant *reg, *reg_tmp;
3291 9 : uint32_t count = 0;
3292 :
3293 20 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, reg_tmp) {
3294 11 : nvmf_ns_reservation_remove_registrant(ns, reg);
3295 11 : count++;
3296 11 : }
3297 9 : return count;
3298 : }
3299 :
3300 : static void
3301 12 : nvmf_ns_reservation_acquire_reservation(struct spdk_nvmf_ns *ns, uint64_t rkey,
3302 : enum spdk_nvme_reservation_type rtype,
3303 : struct spdk_nvmf_registrant *holder)
3304 : {
3305 12 : ns->rtype = rtype;
3306 12 : ns->crkey = rkey;
3307 12 : assert(ns->holder == NULL);
3308 12 : ns->holder = holder;
3309 12 : }
3310 :
3311 : static bool
3312 45 : nvmf_ns_reservation_register(struct spdk_nvmf_ns *ns,
3313 : struct spdk_nvmf_ctrlr *ctrlr,
3314 : struct spdk_nvmf_request *req)
3315 : {
3316 45 : struct spdk_nvme_reservation_register_data key = { 0 };
3317 45 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3318 : uint8_t rrega, iekey, cptpl, rtype;
3319 : struct spdk_nvmf_registrant *reg;
3320 45 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3321 45 : bool update_sgroup = false;
3322 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3323 45 : uint32_t num_hostid = 0;
3324 : int rc;
3325 :
3326 45 : rrega = cmd->cdw10_bits.resv_register.rrega;
3327 45 : iekey = cmd->cdw10_bits.resv_register.iekey;
3328 45 : cptpl = cmd->cdw10_bits.resv_register.cptpl;
3329 :
3330 45 : if (req->iovcnt > 0 && req->length >= sizeof(key)) {
3331 : struct spdk_iov_xfer ix;
3332 45 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
3333 45 : spdk_iov_xfer_to_buf(&ix, &key, sizeof(key));
3334 45 : } else {
3335 0 : SPDK_ERRLOG("No key provided. Failing request.\n");
3336 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3337 0 : goto exit;
3338 : }
3339 :
3340 45 : SPDK_DEBUGLOG(nvmf, "REGISTER: RREGA %u, IEKEY %u, CPTPL %u, "
3341 : "NRKEY 0x%"PRIx64", NRKEY 0x%"PRIx64"\n",
3342 : rrega, iekey, cptpl, key.crkey, key.nrkey);
3343 :
3344 45 : if (cptpl == SPDK_NVME_RESERVE_PTPL_CLEAR_POWER_ON) {
3345 : /* True to OFF state, and need to be updated in the configuration file */
3346 1 : if (ns->ptpl_activated) {
3347 1 : ns->ptpl_activated = 0;
3348 1 : update_sgroup = true;
3349 1 : }
3350 45 : } else if (cptpl == SPDK_NVME_RESERVE_PTPL_PERSIST_POWER_LOSS) {
3351 4 : if (!nvmf_ns_is_ptpl_capable(ns)) {
3352 1 : status = SPDK_NVME_SC_INVALID_FIELD;
3353 1 : goto exit;
3354 3 : } else if (ns->ptpl_activated == 0) {
3355 3 : ns->ptpl_activated = 1;
3356 3 : update_sgroup = true;
3357 3 : }
3358 3 : }
3359 :
3360 : /* current Host Identifier has registrant or not */
3361 44 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3362 :
3363 44 : switch (rrega) {
3364 : case SPDK_NVME_RESERVE_REGISTER_KEY:
3365 36 : if (!reg) {
3366 : /* register new controller */
3367 27 : if (key.nrkey == 0) {
3368 0 : SPDK_ERRLOG("Can't register zeroed new key\n");
3369 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3370 0 : goto exit;
3371 : }
3372 27 : rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
3373 27 : if (rc < 0) {
3374 0 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3375 0 : goto exit;
3376 : }
3377 27 : update_sgroup = true;
3378 27 : } else {
3379 : /* register with same key is not an error */
3380 9 : if (reg->rkey != key.nrkey) {
3381 8 : SPDK_ERRLOG("The same host already register a "
3382 : "key with 0x%"PRIx64"\n",
3383 : reg->rkey);
3384 8 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3385 8 : goto exit;
3386 : }
3387 : }
3388 28 : break;
3389 : case SPDK_NVME_RESERVE_UNREGISTER_KEY:
3390 4 : if (!reg || (!iekey && reg->rkey != key.crkey)) {
3391 0 : SPDK_ERRLOG("No registrant or current key doesn't match "
3392 : "with existing registrant key\n");
3393 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3394 0 : goto exit;
3395 : }
3396 :
3397 4 : rtype = ns->rtype;
3398 8 : num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
3399 : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3400 4 : &ctrlr->hostid);
3401 :
3402 4 : nvmf_ns_reservation_remove_registrant(ns, reg);
3403 :
3404 4 : if (!ns->rtype && num_hostid && (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_REG_ONLY ||
3405 1 : rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY)) {
3406 2 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3407 1 : hostid_list,
3408 1 : num_hostid,
3409 : SPDK_NVME_RESERVATION_RELEASED);
3410 1 : }
3411 4 : update_sgroup = true;
3412 4 : break;
3413 : case SPDK_NVME_RESERVE_REPLACE_KEY:
3414 4 : if (key.nrkey == 0) {
3415 0 : SPDK_ERRLOG("Can't register zeroed new key\n");
3416 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3417 0 : goto exit;
3418 : }
3419 : /* Registrant exists */
3420 4 : if (reg) {
3421 2 : if (!iekey && reg->rkey != key.crkey) {
3422 0 : SPDK_ERRLOG("Current key doesn't match "
3423 : "existing registrant key\n");
3424 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3425 0 : goto exit;
3426 : }
3427 2 : if (reg->rkey == key.nrkey) {
3428 0 : goto exit;
3429 : }
3430 2 : reg->rkey = key.nrkey;
3431 4 : } else if (iekey) { /* No registrant but IEKEY is set */
3432 : /* new registrant */
3433 1 : rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
3434 1 : if (rc < 0) {
3435 0 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3436 0 : goto exit;
3437 : }
3438 1 : } else { /* No registrant */
3439 1 : SPDK_ERRLOG("No registrant\n");
3440 1 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3441 1 : goto exit;
3442 :
3443 : }
3444 3 : update_sgroup = true;
3445 3 : break;
3446 : default:
3447 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3448 0 : goto exit;
3449 35 : }
3450 :
3451 : exit:
3452 45 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3453 45 : req->rsp->nvme_cpl.status.sc = status;
3454 45 : return update_sgroup;
3455 : }
3456 :
3457 : static bool
3458 13 : nvmf_ns_reservation_acquire(struct spdk_nvmf_ns *ns,
3459 : struct spdk_nvmf_ctrlr *ctrlr,
3460 : struct spdk_nvmf_request *req)
3461 : {
3462 13 : struct spdk_nvme_reservation_acquire_data key = { 0 };
3463 13 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3464 : uint8_t racqa, iekey, rtype;
3465 : struct spdk_nvmf_registrant *reg;
3466 13 : bool all_regs = false;
3467 13 : uint32_t count = 0;
3468 13 : bool update_sgroup = true;
3469 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3470 13 : uint32_t num_hostid = 0;
3471 : struct spdk_uuid new_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3472 13 : uint32_t new_num_hostid = 0;
3473 13 : bool reservation_released = false;
3474 13 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3475 :
3476 13 : racqa = cmd->cdw10_bits.resv_acquire.racqa;
3477 13 : iekey = cmd->cdw10_bits.resv_acquire.iekey;
3478 13 : rtype = cmd->cdw10_bits.resv_acquire.rtype;
3479 :
3480 13 : if (req->iovcnt > 0 && req->length >= sizeof(key)) {
3481 : struct spdk_iov_xfer ix;
3482 13 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
3483 13 : spdk_iov_xfer_to_buf(&ix, &key, sizeof(key));
3484 13 : } else {
3485 0 : SPDK_ERRLOG("No key provided. Failing request.\n");
3486 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3487 0 : goto exit;
3488 : }
3489 :
3490 13 : SPDK_DEBUGLOG(nvmf, "ACQUIRE: RACQA %u, IEKEY %u, RTYPE %u, "
3491 : "NRKEY 0x%"PRIx64", PRKEY 0x%"PRIx64"\n",
3492 : racqa, iekey, rtype, key.crkey, key.prkey);
3493 :
3494 13 : if (iekey || rtype > SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) {
3495 0 : SPDK_ERRLOG("Ignore existing key field set to 1\n");
3496 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3497 0 : update_sgroup = false;
3498 0 : goto exit;
3499 : }
3500 :
3501 13 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3502 : /* must be registrant and CRKEY must match */
3503 13 : if (!reg || reg->rkey != key.crkey) {
3504 0 : SPDK_ERRLOG("No registrant or current key doesn't match "
3505 : "with existing registrant key\n");
3506 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3507 0 : update_sgroup = false;
3508 0 : goto exit;
3509 : }
3510 :
3511 13 : all_regs = nvmf_ns_reservation_all_registrants_type(ns);
3512 :
3513 13 : switch (racqa) {
3514 : case SPDK_NVME_RESERVE_ACQUIRE:
3515 : /* it's not an error for the holder to acquire same reservation type again */
3516 10 : if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && ns->rtype == rtype) {
3517 : /* do nothing */
3518 0 : update_sgroup = false;
3519 10 : } else if (ns->holder == NULL) {
3520 : /* first time to acquire the reservation */
3521 10 : nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg);
3522 10 : } else {
3523 0 : SPDK_ERRLOG("Invalid rtype or current registrant is not holder\n");
3524 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3525 0 : update_sgroup = false;
3526 0 : goto exit;
3527 : }
3528 10 : break;
3529 : case SPDK_NVME_RESERVE_PREEMPT:
3530 : /* no reservation holder */
3531 3 : if (!ns->holder) {
3532 : /* unregister with PRKEY */
3533 0 : nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
3534 0 : break;
3535 : }
3536 6 : num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
3537 : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3538 3 : &ctrlr->hostid);
3539 :
3540 : /* only 1 reservation holder and reservation key is valid */
3541 3 : if (!all_regs) {
3542 : /* preempt itself */
3543 2 : if (nvmf_ns_reservation_registrant_is_holder(ns, reg) &&
3544 0 : ns->crkey == key.prkey) {
3545 0 : ns->rtype = rtype;
3546 0 : reservation_released = true;
3547 0 : break;
3548 : }
3549 :
3550 2 : if (ns->crkey == key.prkey) {
3551 2 : nvmf_ns_reservation_remove_registrant(ns, ns->holder);
3552 2 : nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg);
3553 2 : reservation_released = true;
3554 2 : } else if (key.prkey != 0) {
3555 0 : nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
3556 0 : } else {
3557 : /* PRKEY is zero */
3558 0 : SPDK_ERRLOG("Current PRKEY is zero\n");
3559 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3560 0 : update_sgroup = false;
3561 0 : goto exit;
3562 : }
3563 2 : } else {
3564 : /* release all other registrants except for the current one */
3565 1 : if (key.prkey == 0) {
3566 1 : nvmf_ns_reservation_remove_all_other_registrants(ns, reg);
3567 1 : assert(ns->holder == reg);
3568 1 : } else {
3569 0 : count = nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
3570 0 : if (count == 0) {
3571 0 : SPDK_ERRLOG("PRKEY doesn't match any registrant\n");
3572 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3573 0 : update_sgroup = false;
3574 0 : goto exit;
3575 : }
3576 : }
3577 : }
3578 3 : break;
3579 : default:
3580 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3581 0 : update_sgroup = false;
3582 0 : break;
3583 13 : }
3584 :
3585 : exit:
3586 13 : if (update_sgroup && racqa == SPDK_NVME_RESERVE_PREEMPT) {
3587 6 : new_num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, new_hostid_list,
3588 : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3589 3 : &ctrlr->hostid);
3590 : /* Preempt notification occurs on the unregistered controllers
3591 : * other than the controller who issued the command.
3592 : */
3593 6 : num_hostid = nvmf_ns_reservation_get_unregistered_hostid(hostid_list,
3594 3 : num_hostid,
3595 3 : new_hostid_list,
3596 3 : new_num_hostid);
3597 3 : if (num_hostid) {
3598 6 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3599 3 : hostid_list,
3600 3 : num_hostid,
3601 : SPDK_NVME_REGISTRATION_PREEMPTED);
3602 :
3603 3 : }
3604 : /* Reservation released notification occurs on the
3605 : * controllers which are the remaining registrants other than
3606 : * the controller who issued the command.
3607 : */
3608 3 : if (reservation_released && new_num_hostid) {
3609 4 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3610 2 : new_hostid_list,
3611 2 : new_num_hostid,
3612 : SPDK_NVME_RESERVATION_RELEASED);
3613 :
3614 2 : }
3615 3 : }
3616 13 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3617 13 : req->rsp->nvme_cpl.status.sc = status;
3618 13 : return update_sgroup;
3619 : }
3620 :
3621 : static bool
3622 6 : nvmf_ns_reservation_release(struct spdk_nvmf_ns *ns,
3623 : struct spdk_nvmf_ctrlr *ctrlr,
3624 : struct spdk_nvmf_request *req)
3625 : {
3626 6 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3627 : uint8_t rrela, iekey, rtype;
3628 : struct spdk_nvmf_registrant *reg;
3629 6 : uint64_t crkey = 0;
3630 6 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3631 6 : bool update_sgroup = true;
3632 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3633 6 : uint32_t num_hostid = 0;
3634 :
3635 6 : rrela = cmd->cdw10_bits.resv_release.rrela;
3636 6 : iekey = cmd->cdw10_bits.resv_release.iekey;
3637 6 : rtype = cmd->cdw10_bits.resv_release.rtype;
3638 :
3639 6 : if (req->iovcnt > 0 && req->length >= sizeof(crkey)) {
3640 : struct spdk_iov_xfer ix;
3641 6 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
3642 6 : spdk_iov_xfer_to_buf(&ix, &crkey, sizeof(crkey));
3643 6 : } else {
3644 0 : SPDK_ERRLOG("No key provided. Failing request.\n");
3645 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3646 0 : goto exit;
3647 : }
3648 :
3649 6 : SPDK_DEBUGLOG(nvmf, "RELEASE: RRELA %u, IEKEY %u, RTYPE %u, "
3650 : "CRKEY 0x%"PRIx64"\n", rrela, iekey, rtype, crkey);
3651 :
3652 6 : if (iekey) {
3653 0 : SPDK_ERRLOG("Ignore existing key field set to 1\n");
3654 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3655 0 : update_sgroup = false;
3656 0 : goto exit;
3657 : }
3658 :
3659 6 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3660 6 : if (!reg || reg->rkey != crkey) {
3661 0 : SPDK_ERRLOG("No registrant or current key doesn't match "
3662 : "with existing registrant key\n");
3663 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3664 0 : update_sgroup = false;
3665 0 : goto exit;
3666 : }
3667 :
3668 12 : num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
3669 : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3670 6 : &ctrlr->hostid);
3671 :
3672 6 : switch (rrela) {
3673 : case SPDK_NVME_RESERVE_RELEASE:
3674 4 : if (!ns->holder) {
3675 0 : SPDK_DEBUGLOG(nvmf, "RELEASE: no holder\n");
3676 0 : update_sgroup = false;
3677 0 : goto exit;
3678 : }
3679 4 : if (ns->rtype != rtype) {
3680 0 : SPDK_ERRLOG("Type doesn't match\n");
3681 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3682 0 : update_sgroup = false;
3683 0 : goto exit;
3684 : }
3685 4 : if (!nvmf_ns_reservation_registrant_is_holder(ns, reg)) {
3686 : /* not the reservation holder, this isn't an error */
3687 0 : update_sgroup = false;
3688 0 : goto exit;
3689 : }
3690 :
3691 4 : rtype = ns->rtype;
3692 4 : nvmf_ns_reservation_release_reservation(ns);
3693 :
3694 4 : if (num_hostid && rtype != SPDK_NVME_RESERVE_WRITE_EXCLUSIVE &&
3695 2 : rtype != SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) {
3696 4 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3697 2 : hostid_list,
3698 2 : num_hostid,
3699 : SPDK_NVME_RESERVATION_RELEASED);
3700 2 : }
3701 4 : break;
3702 : case SPDK_NVME_RESERVE_CLEAR:
3703 2 : nvmf_ns_reservation_clear_all_registrants(ns);
3704 2 : if (num_hostid) {
3705 4 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3706 2 : hostid_list,
3707 2 : num_hostid,
3708 : SPDK_NVME_RESERVATION_PREEMPTED);
3709 2 : }
3710 2 : break;
3711 : default:
3712 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3713 0 : update_sgroup = false;
3714 0 : goto exit;
3715 6 : }
3716 :
3717 : exit:
3718 6 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3719 6 : req->rsp->nvme_cpl.status.sc = status;
3720 6 : return update_sgroup;
3721 : }
3722 :
3723 : static void
3724 3 : nvmf_ns_reservation_report(struct spdk_nvmf_ns *ns,
3725 : struct spdk_nvmf_ctrlr *ctrlr,
3726 : struct spdk_nvmf_request *req)
3727 : {
3728 3 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3729 : struct spdk_nvmf_registrant *reg, *tmp;
3730 3 : struct spdk_nvme_reservation_status_extended_data status_data = { 0 };
3731 : struct spdk_iov_xfer ix;
3732 : uint32_t transfer_len;
3733 3 : uint32_t regctl = 0;
3734 3 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3735 :
3736 3 : if (req->iovcnt == 0) {
3737 0 : SPDK_ERRLOG("No data transfer specified for request. "
3738 : " Unable to transfer back response.\n");
3739 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3740 0 : goto exit;
3741 : }
3742 :
3743 3 : if (!cmd->cdw11_bits.resv_report.eds) {
3744 1 : SPDK_ERRLOG("NVMeoF uses extended controller data structure, "
3745 : "please set EDS bit in cdw11 and try again\n");
3746 1 : status = SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT;
3747 1 : goto exit;
3748 : }
3749 :
3750 : /* Number of Dwords of the Reservation Status data structure to transfer */
3751 2 : transfer_len = (cmd->cdw10 + 1) * sizeof(uint32_t);
3752 :
3753 2 : if (transfer_len < sizeof(struct spdk_nvme_reservation_status_extended_data)) {
3754 1 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3755 1 : goto exit;
3756 : }
3757 :
3758 1 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
3759 :
3760 1 : status_data.data.gen = ns->gen;
3761 1 : status_data.data.rtype = ns->rtype;
3762 1 : status_data.data.ptpls = ns->ptpl_activated;
3763 :
3764 3 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3765 2 : regctl++;
3766 2 : }
3767 :
3768 : /*
3769 : * We report the number of registrants as per the spec here, even if
3770 : * the iov isn't big enough to contain them all. In that case, the
3771 : * spdk_iov_xfer_from_buf() won't actually copy any of the remaining
3772 : * data; as it keeps track of the iov cursor itself, it's simplest to
3773 : * just walk the entire list anyway.
3774 : */
3775 1 : status_data.data.regctl = regctl;
3776 :
3777 1 : spdk_iov_xfer_from_buf(&ix, &status_data, sizeof(status_data));
3778 :
3779 3 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
3780 2 : struct spdk_nvme_registered_ctrlr_extended_data ctrlr_data = { 0 };
3781 :
3782 : /* Set to 0xffffh for dynamic controller */
3783 2 : ctrlr_data.cntlid = 0xffff;
3784 2 : ctrlr_data.rcsts.status = (ns->holder == reg) ? true : false;
3785 2 : ctrlr_data.rkey = reg->rkey;
3786 2 : spdk_uuid_copy((struct spdk_uuid *)ctrlr_data.hostid, ®->hostid);
3787 :
3788 2 : spdk_iov_xfer_from_buf(&ix, &ctrlr_data, sizeof(ctrlr_data));
3789 3 : }
3790 :
3791 : exit:
3792 3 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3793 3 : req->rsp->nvme_cpl.status.sc = status;
3794 3 : return;
3795 : }
3796 :
3797 : static void
3798 0 : nvmf_ns_reservation_complete(void *ctx)
3799 : {
3800 0 : struct spdk_nvmf_request *req = ctx;
3801 :
3802 0 : spdk_nvmf_request_complete(req);
3803 0 : }
3804 :
3805 : static void
3806 0 : _nvmf_ns_reservation_update_done(struct spdk_nvmf_subsystem *subsystem,
3807 : void *cb_arg, int status)
3808 : {
3809 0 : struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)cb_arg;
3810 0 : struct spdk_nvmf_poll_group *group = req->qpair->group;
3811 :
3812 0 : spdk_thread_send_msg(group->thread, nvmf_ns_reservation_complete, req);
3813 0 : }
3814 :
3815 : void
3816 0 : nvmf_ns_reservation_request(void *ctx)
3817 : {
3818 0 : struct spdk_nvmf_request *req = (struct spdk_nvmf_request *)ctx;
3819 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3820 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3821 : uint32_t nsid;
3822 : struct spdk_nvmf_ns *ns;
3823 0 : bool update_sgroup = false;
3824 0 : int status = 0;
3825 :
3826 0 : nsid = cmd->nsid;
3827 0 : ns = _nvmf_subsystem_get_ns(ctrlr->subsys, nsid);
3828 0 : assert(ns != NULL);
3829 :
3830 0 : switch (cmd->opc) {
3831 : case SPDK_NVME_OPC_RESERVATION_REGISTER:
3832 0 : update_sgroup = nvmf_ns_reservation_register(ns, ctrlr, req);
3833 0 : break;
3834 : case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
3835 0 : update_sgroup = nvmf_ns_reservation_acquire(ns, ctrlr, req);
3836 0 : break;
3837 : case SPDK_NVME_OPC_RESERVATION_RELEASE:
3838 0 : update_sgroup = nvmf_ns_reservation_release(ns, ctrlr, req);
3839 0 : break;
3840 : case SPDK_NVME_OPC_RESERVATION_REPORT:
3841 0 : nvmf_ns_reservation_report(ns, ctrlr, req);
3842 0 : break;
3843 : default:
3844 0 : break;
3845 : }
3846 :
3847 : /* update reservation information to subsystem's poll group */
3848 0 : if (update_sgroup) {
3849 0 : if (ns->ptpl_activated || cmd->opc == SPDK_NVME_OPC_RESERVATION_REGISTER) {
3850 0 : if (nvmf_ns_update_reservation_info(ns) != 0) {
3851 0 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3852 0 : }
3853 0 : }
3854 0 : status = nvmf_subsystem_update_ns(ctrlr->subsys, _nvmf_ns_reservation_update_done, req);
3855 0 : if (status == 0) {
3856 0 : return;
3857 : }
3858 0 : }
3859 :
3860 0 : _nvmf_ns_reservation_update_done(ctrlr->subsys, req, status);
3861 0 : }
3862 :
3863 : static bool
3864 11 : nvmf_ns_is_ptpl_capable_json(const struct spdk_nvmf_ns *ns)
3865 : {
3866 11 : return ns->ptpl_file != NULL;
3867 : }
3868 :
3869 : static struct spdk_nvmf_ns_reservation_ops g_reservation_ops = {
3870 : .is_ptpl_capable = nvmf_ns_is_ptpl_capable_json,
3871 : .update = nvmf_ns_reservation_update_json,
3872 : .load = nvmf_ns_reservation_load_json,
3873 : };
3874 :
3875 : bool
3876 15 : nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns)
3877 : {
3878 15 : return g_reservation_ops.is_ptpl_capable(ns);
3879 : }
3880 :
3881 : static int
3882 7 : nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns,
3883 : const struct spdk_nvmf_reservation_info *info)
3884 : {
3885 7 : return g_reservation_ops.update(ns, info);
3886 : }
3887 :
3888 : static int
3889 6 : nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
3890 : {
3891 6 : return g_reservation_ops.load(ns, info);
3892 : }
3893 :
3894 : void
3895 1 : spdk_nvmf_set_custom_ns_reservation_ops(const struct spdk_nvmf_ns_reservation_ops *ops)
3896 : {
3897 1 : g_reservation_ops = *ops;
3898 1 : }
3899 :
3900 : int
3901 0 : spdk_nvmf_subsystem_set_ana_reporting(struct spdk_nvmf_subsystem *subsystem,
3902 : bool ana_reporting)
3903 : {
3904 0 : if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
3905 0 : return -EAGAIN;
3906 : }
3907 :
3908 0 : subsystem->flags.ana_reporting = ana_reporting;
3909 :
3910 0 : return 0;
3911 0 : }
3912 :
3913 : bool
3914 0 : spdk_nvmf_subsystem_get_ana_reporting(struct spdk_nvmf_subsystem *subsystem)
3915 : {
3916 0 : return subsystem->flags.ana_reporting;
3917 : }
3918 :
3919 : struct subsystem_listener_update_ctx {
3920 : struct spdk_nvmf_subsystem_listener *listener;
3921 :
3922 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn;
3923 : void *cb_arg;
3924 : };
3925 :
3926 : static void
3927 0 : subsystem_listener_update_done(struct spdk_io_channel_iter *i, int status)
3928 : {
3929 0 : struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
3930 :
3931 0 : if (ctx->cb_fn) {
3932 0 : ctx->cb_fn(ctx->cb_arg, status);
3933 0 : }
3934 0 : free(ctx);
3935 0 : }
3936 :
3937 : static void
3938 0 : subsystem_listener_update_on_pg(struct spdk_io_channel_iter *i)
3939 : {
3940 0 : struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
3941 : struct spdk_nvmf_subsystem_listener *listener;
3942 : struct spdk_nvmf_poll_group *group;
3943 : struct spdk_nvmf_ctrlr *ctrlr;
3944 :
3945 0 : listener = ctx->listener;
3946 0 : group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i));
3947 :
3948 0 : TAILQ_FOREACH(ctrlr, &listener->subsystem->ctrlrs, link) {
3949 0 : if (ctrlr->thread != spdk_get_thread()) {
3950 0 : continue;
3951 : }
3952 :
3953 0 : if (ctrlr->admin_qpair && ctrlr->admin_qpair->group == group && ctrlr->listener == listener) {
3954 0 : nvmf_ctrlr_async_event_ana_change_notice(ctrlr);
3955 0 : }
3956 0 : }
3957 :
3958 0 : spdk_for_each_channel_continue(i, 0);
3959 0 : }
3960 :
3961 : void
3962 0 : spdk_nvmf_subsystem_set_ana_state(struct spdk_nvmf_subsystem *subsystem,
3963 : const struct spdk_nvme_transport_id *trid,
3964 : enum spdk_nvme_ana_state ana_state, uint32_t anagrpid,
3965 : spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn, void *cb_arg)
3966 : {
3967 : struct spdk_nvmf_subsystem_listener *listener;
3968 : struct subsystem_listener_update_ctx *ctx;
3969 : uint32_t i;
3970 :
3971 0 : assert(cb_fn != NULL);
3972 0 : assert(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
3973 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED);
3974 :
3975 0 : if (!subsystem->flags.ana_reporting) {
3976 0 : SPDK_ERRLOG("ANA reporting is disabled\n");
3977 0 : cb_fn(cb_arg, -EINVAL);
3978 0 : return;
3979 : }
3980 :
3981 : /* ANA Change state is not used, ANA Persistent Loss state
3982 : * is not supported yet.
3983 : */
3984 0 : if (!(ana_state == SPDK_NVME_ANA_OPTIMIZED_STATE ||
3985 0 : ana_state == SPDK_NVME_ANA_NON_OPTIMIZED_STATE ||
3986 0 : ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE)) {
3987 0 : SPDK_ERRLOG("ANA state %d is not supported\n", ana_state);
3988 0 : cb_fn(cb_arg, -ENOTSUP);
3989 0 : return;
3990 : }
3991 :
3992 0 : if (anagrpid > subsystem->max_nsid) {
3993 0 : SPDK_ERRLOG("ANA group ID %" PRIu32 " is more than maximum\n", anagrpid);
3994 0 : cb_fn(cb_arg, -EINVAL);
3995 0 : return;
3996 : }
3997 :
3998 0 : listener = nvmf_subsystem_find_listener(subsystem, trid);
3999 0 : if (!listener) {
4000 0 : SPDK_ERRLOG("Unable to find listener.\n");
4001 0 : cb_fn(cb_arg, -EINVAL);
4002 0 : return;
4003 : }
4004 :
4005 0 : if (anagrpid != 0 && listener->ana_state[anagrpid - 1] == ana_state) {
4006 0 : cb_fn(cb_arg, 0);
4007 0 : return;
4008 : }
4009 :
4010 0 : ctx = calloc(1, sizeof(*ctx));
4011 0 : if (!ctx) {
4012 0 : SPDK_ERRLOG("Unable to allocate context\n");
4013 0 : cb_fn(cb_arg, -ENOMEM);
4014 0 : return;
4015 : }
4016 :
4017 0 : for (i = 1; i <= subsystem->max_nsid; i++) {
4018 0 : if (anagrpid == 0 || i == anagrpid) {
4019 0 : listener->ana_state[i - 1] = ana_state;
4020 0 : }
4021 0 : }
4022 0 : listener->ana_state_change_count++;
4023 :
4024 0 : ctx->listener = listener;
4025 0 : ctx->cb_fn = cb_fn;
4026 0 : ctx->cb_arg = cb_arg;
4027 :
4028 0 : spdk_for_each_channel(subsystem->tgt,
4029 : subsystem_listener_update_on_pg,
4030 0 : ctx,
4031 : subsystem_listener_update_done);
4032 0 : }
4033 :
4034 : int
4035 0 : spdk_nvmf_subsystem_get_ana_state(struct spdk_nvmf_subsystem *subsystem,
4036 : const struct spdk_nvme_transport_id *trid,
4037 : uint32_t anagrpid,
4038 : enum spdk_nvme_ana_state *ana_state)
4039 : {
4040 0 : assert(ana_state != NULL);
4041 :
4042 : struct spdk_nvmf_subsystem_listener *listener;
4043 :
4044 0 : if (!subsystem->flags.ana_reporting) {
4045 0 : SPDK_ERRLOG("ANA reporting is disabled\n");
4046 0 : return -EINVAL;
4047 : }
4048 :
4049 0 : if (anagrpid <= 0 || anagrpid > subsystem->max_nsid) {
4050 0 : SPDK_ERRLOG("ANA group ID %" PRIu32 " is invalid\n", anagrpid);
4051 0 : return -EINVAL;
4052 : }
4053 :
4054 0 : listener = nvmf_subsystem_find_listener(subsystem, trid);
4055 0 : if (!listener) {
4056 0 : SPDK_ERRLOG("Unable to find listener.\n");
4057 0 : return -EINVAL;
4058 : }
4059 :
4060 0 : *ana_state = listener->ana_state[anagrpid - 1];
4061 0 : return 0;
4062 0 : }
4063 :
4064 : bool
4065 14 : spdk_nvmf_subsystem_is_discovery(struct spdk_nvmf_subsystem *subsystem)
4066 : {
4067 14 : return subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
4068 14 : subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY;
4069 : }
4070 :
4071 : bool
4072 0 : nvmf_nqn_is_discovery(const char *nqn)
4073 : {
4074 0 : return strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN) == 0;
4075 : }
|