Branch data 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 : 144 : nvmf_valid_ascii_string(const void *buf, size_t size)
51 : : {
52 : 144 : const uint8_t *str = buf;
53 : : size_t i;
54 : :
55 [ + + ]: 2579 : for (i = 0; i < size; i++) {
56 [ + + + + : 2439 : if (str[i] < 0x20 || str[i] > 0x7E) {
+ - - + -
+ - + ]
57 : 4 : return false;
58 : : }
59 : 1514 : }
60 : :
61 : 140 : return true;
62 : 81 : }
63 : :
64 : : bool
65 : 993 : nvmf_nqn_is_valid(const char *nqn)
66 : : {
67 : : size_t len;
68 : 433 : 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 : 993 : enum spdk_nvmf_nqn_domain_states domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
75 : :
76 : : /* Check for length requirements */
77 [ + + ]: 993 : len = strlen(nqn);
78 [ + + ]: 993 : if (len > SPDK_NVMF_NQN_MAX_LEN) {
79 : 4 : SPDK_ERRLOG("Invalid NQN \"%s\": length %zu > max %d\n", nqn, len, SPDK_NVMF_NQN_MAX_LEN);
80 : 4 : 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 [ + + ]: 989 : if (len < SPDK_NVMF_NQN_MIN_LEN) {
85 : 8 : SPDK_ERRLOG("Invalid NQN \"%s\": length %zu < min %d\n", nqn, len, SPDK_NVMF_NQN_MIN_LEN);
86 : 8 : return false;
87 : : }
88 : :
89 : : /* Check for discovery controller nqn */
90 [ + + + + : 981 : if (!strcmp(nqn, SPDK_NVMF_DISCOVERY_NQN)) {
+ + ]
91 : 599 : 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 [ + + + + : 382 : if (!strncmp(nqn, SPDK_NVMF_NQN_UUID_PRE, SPDK_NVMF_NQN_UUID_PRE_LEN)) {
+ - ]
96 [ + + ]: 103 : if (len != SPDK_NVMF_NQN_UUID_PRE_LEN + SPDK_NVMF_UUID_STRING_LEN) {
97 : 8 : SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not the correct length\n", nqn);
98 : 8 : return false;
99 : : }
100 : :
101 [ + + # # ]: 95 : if (spdk_uuid_parse(&uuid_value, &nqn[SPDK_NVMF_NQN_UUID_PRE_LEN])) {
102 : 8 : SPDK_ERRLOG("Invalid NQN \"%s\": uuid is not formatted correctly\n", nqn);
103 : 8 : return false;
104 : : }
105 : 87 : 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 [ + + + + : 279 : 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 [ + - + - : 353 : if (!(isdigit(nqn[4]) && isdigit(nqn[5]) && isdigit(nqn[6]) && isdigit(nqn[7]) &&
+ - + - +
+ + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - -
+ ]
117 [ + - + - : 279 : 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 [ + + ]: 279 : reverse_domain_end = strchr(nqn, ':');
123 [ + - + + ]: 279 : if (reverse_domain_end != NULL && (reverse_domain_end_index = reverse_domain_end - nqn) < len - 1) {
124 : 73 : } else {
125 : 4 : SPDK_ERRLOG("Invalid NQN \"%s\". NQN must contain user specified name with a ':' as a prefix.\n",
126 : : nqn);
127 : 4 : return false;
128 : : }
129 : :
130 : : /* Check for valid reverse domain */
131 : 275 : domain_label_length = 0;
132 [ + + ]: 2464 : for (i = 12; i < reverse_domain_end_index; i++) {
133 [ + + ]: 2213 : if (domain_label_length > SPDK_DOMAIN_LABEL_MAX_LEN) {
134 : 4 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". At least one Label is too long.\n", nqn);
135 : 4 : return false;
136 : : }
137 : :
138 [ + + + + ]: 2209 : switch (domain_state) {
139 : :
140 : 407 : case SPDK_NVMF_DOMAIN_ACCEPT_LETTER: {
141 [ + + + - : 554 : if (isalpha(nqn[i])) {
+ - + - +
- + - ]
142 : 538 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
143 : 538 : domain_label_length++;
144 : 538 : break;
145 : : } else {
146 : 16 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must start with a letter.\n", nqn);
147 : 16 : return false;
148 : : }
149 : : }
150 : :
151 : 12 : case SPDK_NVMF_DOMAIN_ACCEPT_LDH: {
152 [ + + - + : 16 : if (isalpha(nqn[i]) || isdigit(nqn[i])) {
# # # # #
# # # # #
# # # # #
# # # #
# ]
153 : 12 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
154 : 12 : domain_label_length++;
155 : 12 : break;
156 [ + - # # : 4 : } else if (nqn[i] == '-') {
# # ]
157 [ + + ]: 4 : 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 : 4 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
163 : 4 : domain_label_length++;
164 : 4 : 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 : 1208 : case SPDK_NVMF_DOMAIN_ACCEPT_ANY: {
177 [ + + + + : 1639 : if (isalpha(nqn[i]) || isdigit(nqn[i])) {
+ - + - +
- + + + -
+ - + - +
- + - -
+ ]
178 : 1344 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_ANY;
179 : 1344 : domain_label_length++;
180 : 1344 : break;
181 [ + + + - : 295 : } else if (nqn[i] == '-') {
- + ]
182 [ + + ]: 16 : if (i == reverse_domain_end_index - 1) {
183 : 4 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must end with an alphanumeric symbol.\n",
184 : : nqn);
185 : 4 : return false;
186 : : }
187 : 12 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LDH;
188 : 12 : domain_label_length++;
189 : 12 : break;
190 [ + + + - : 279 : } else if (nqn[i] == '.') {
+ - ]
191 : 279 : domain_state = SPDK_NVMF_DOMAIN_ACCEPT_LETTER;
192 : 279 : domain_label_length = 0;
193 : 279 : 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 : 577 : }
202 : :
203 : 251 : i = reverse_domain_end_index + 1;
204 [ + + ]: 2636 : while (i < len) {
205 [ + - + - ]: 2389 : bytes_consumed = utf8_valid(&nqn[i], &nqn[len]);
206 [ + + ]: 2389 : if (bytes_consumed <= 0) {
207 : 4 : SPDK_ERRLOG("Invalid domain name in NQN \"%s\". Label names must contain only valid utf-8.\n", nqn);
208 : 4 : return false;
209 : : }
210 : :
211 : 2385 : i += bytes_consumed;
212 : : }
213 : 247 : return true;
214 : 154 : }
215 : :
216 : : static void subsystem_state_change_on_pg(struct spdk_io_channel_iter *i);
217 : :
218 : : struct spdk_nvmf_subsystem *
219 : 809 : 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 [ - + ]: 809 : 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 [ + + ]: 809 : if (!nvmf_nqn_is_valid(nqn)) {
233 : 44 : SPDK_ERRLOG("Subsystem NQN '%s' is invalid\n", nqn);
234 : 44 : return NULL;
235 : : }
236 : :
237 [ + + - + ]: 765 : if (type == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
238 : 51 : type == SPDK_NVMF_SUBTYPE_DISCOVERY) {
239 [ - + ]: 595 : if (num_ns != 0) {
240 : 0 : SPDK_ERRLOG("Discovery subsystem cannot have namespaces.\n");
241 : 0 : return NULL;
242 : : }
243 [ + + ]: 240 : } else if (num_ns == 0) {
244 : 117 : num_ns = NVMF_SUBSYSTEM_DEFAULT_NAMESPACES;
245 : 12 : }
246 : :
247 : : /* Find a free subsystem id (sid) */
248 [ + - + - ]: 765 : sid = spdk_bit_array_find_first_clear(tgt->subsystem_ids, 0);
249 [ + + ]: 765 : if (sid == UINT32_MAX) {
250 : 0 : SPDK_ERRLOG("No free subsystem IDs are available for subsystem creation\n");
251 : 0 : return NULL;
252 : : }
253 : 765 : subsystem = calloc(1, sizeof(struct spdk_nvmf_subsystem));
254 [ + + ]: 765 : if (subsystem == NULL) {
255 : 0 : SPDK_ERRLOG("Subsystem memory allocation failed\n");
256 : 0 : return NULL;
257 : : }
258 : :
259 [ + - + - ]: 765 : subsystem->thread = spdk_get_thread();
260 [ + - + - ]: 765 : subsystem->state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
261 [ + - + - ]: 765 : subsystem->tgt = tgt;
262 [ + - + - ]: 765 : subsystem->id = sid;
263 [ + - + - ]: 765 : subsystem->subtype = type;
264 [ + - + - ]: 765 : subsystem->max_nsid = num_ns;
265 [ + - + - ]: 765 : subsystem->next_cntlid = 1;
266 [ + - + - ]: 765 : subsystem->min_cntlid = NVMF_MIN_CNTLID;
267 [ + - + - ]: 765 : subsystem->max_cntlid = NVMF_MAX_CNTLID;
268 [ + + ]: 765 : snprintf(subsystem->subnqn, sizeof(subsystem->subnqn), "%s", nqn);
269 [ + + + - ]: 765 : pthread_mutex_init(&subsystem->mutex, NULL);
270 [ + - + - : 765 : TAILQ_INIT(&subsystem->listeners);
+ - + - +
- + - + -
+ - ]
271 [ + - + - : 765 : TAILQ_INIT(&subsystem->hosts);
+ - + - +
- + - + -
+ - ]
272 [ + - + - : 765 : TAILQ_INIT(&subsystem->ctrlrs);
+ - + - +
- + - + -
+ - ]
273 [ + - + - : 765 : TAILQ_INIT(&subsystem->state_changes);
+ - + - +
- + - + -
+ - ]
274 [ + - + - ]: 765 : subsystem->used_listener_ids = spdk_bit_array_create(NVMF_MAX_LISTENERS_PER_SUBSYSTEM);
275 [ + + + - : 765 : 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 [ + + ]: 765 : if (num_ns != 0) {
283 [ + - + - ]: 170 : subsystem->ns = calloc(num_ns, sizeof(struct spdk_nvmf_ns *));
284 [ + + + - : 170 : 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 [ + - + - ]: 170 : subsystem->ana_group = calloc(num_ns, sizeof(uint32_t));
292 [ + + + - : 170 : 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 : 51 : }
301 : :
302 [ + + + - ]: 765 : memset(subsystem->sn, '0', sizeof(subsystem->sn) - 1);
303 [ + - + - : 765 : subsystem->sn[sizeof(subsystem->sn) - 1] = '\0';
+ - + - ]
304 : :
305 [ + + ]: 765 : snprintf(subsystem->mn, sizeof(subsystem->mn), "%s",
306 : : MODEL_NUMBER_DEFAULT);
307 : :
308 [ + - + - ]: 765 : spdk_bit_array_set(tgt->subsystem_ids, sid);
309 [ + - ]: 765 : RB_INSERT(subsystem_tree, &tgt->subsystems, subsystem);
310 : :
311 : 120 : SPDK_DTRACE_PROBE1(nvmf_subsystem_create, subsystem->subnqn);
312 : :
313 : 765 : return subsystem;
314 : 132 : }
315 : :
316 : : static void
317 : 108 : nvmf_host_free(struct spdk_nvmf_host *host)
318 : : {
319 [ # # # # ]: 108 : spdk_keyring_put_key(host->dhchap_key);
320 [ # # # # ]: 108 : spdk_keyring_put_key(host->dhchap_ctrlr_key);
321 : 108 : free(host);
322 : 108 : }
323 : :
324 : : /* Must hold subsystem->mutex while calling this function */
325 : : static void
326 : 108 : nvmf_subsystem_remove_host(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_host *host)
327 : : {
328 [ + + # # : 108 : TAILQ_REMOVE(&subsystem->hosts, host, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ]
329 : 108 : nvmf_host_free(host);
330 : 108 : }
331 : :
332 : : static void
333 : 176 : _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 [ + + + - ]: 176 : if (stop) {
341 [ # # # # : 43 : transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, listener->trid->trstring);
# # # # #
# ]
342 [ + - ]: 43 : if (transport != NULL) {
343 [ # # # # ]: 43 : spdk_nvmf_transport_stop_listen(transport, listener->trid);
344 : 0 : }
345 : 0 : }
346 : :
347 [ + + + - : 189 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
+ - - + #
# # # #
# ]
348 [ + + # # : 13 : if (ctrlr->listener == listener) {
# # ]
349 [ # # # # ]: 11 : ctrlr->listener = NULL;
350 : 0 : }
351 : 0 : }
352 : :
353 [ + + + - : 176 : TAILQ_REMOVE(&subsystem->listeners, listener, link);
+ - - + #
# # # # #
# # # # #
# # # # #
# # + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - ]
354 [ + + + - : 176 : if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
+ - ]
355 [ # # # # : 12 : nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
# # # # ]
356 : 0 : }
357 [ + - + - : 176 : spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL);
+ - + - ]
358 [ + - + - ]: 176 : free(listener->ana_state);
359 [ + - + - : 176 : spdk_bit_array_clear(subsystem->used_listener_ids, listener->id);
+ - + - ]
360 [ + - + - : 176 : free(listener->opts.sock_impl);
+ - ]
361 : 176 : free(listener);
362 : 176 : }
363 : :
364 : : static void
365 : 2 : _nvmf_subsystem_destroy_msg(void *cb_arg)
366 : : {
367 : 2 : struct spdk_nvmf_subsystem *subsystem = cb_arg;
368 : :
369 : 2 : _nvmf_subsystem_destroy(subsystem);
370 : 2 : }
371 : :
372 : : static int
373 : 767 : _nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem)
374 : : {
375 : : struct nvmf_subsystem_state_change_ctx *ctx;
376 : : struct spdk_nvmf_ns *ns;
377 : 767 : nvmf_subsystem_destroy_cb async_destroy_cb = NULL;
378 : 767 : void *async_destroy_cb_arg = NULL;
379 : : int rc;
380 : :
381 [ + + + - : 767 : if (!TAILQ_EMPTY(&subsystem->ctrlrs)) {
+ - - + ]
382 [ - + - + : 2 : SPDK_DEBUGLOG(nvmf, "subsystem %p %s has active controllers\n", subsystem, subsystem->subnqn);
# # # # ]
383 [ # # # # ]: 2 : subsystem->async_destroy = true;
384 [ # # # # ]: 2 : rc = spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_destroy_msg, subsystem);
385 [ - + ]: 2 : if (rc) {
386 : 0 : SPDK_ERRLOG("Failed to send thread msg, rc %d\n", rc);
387 [ # # ]: 0 : assert(0);
388 : : return rc;
389 : : }
390 : 2 : return -EINPROGRESS;
391 : : }
392 : :
393 : 765 : ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
394 [ + + ]: 874 : while (ns != NULL) {
395 : 109 : struct spdk_nvmf_ns *next_ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns);
396 : :
397 [ + - + - : 109 : spdk_nvmf_subsystem_remove_ns(subsystem, ns->opts.nsid);
+ - ]
398 : 109 : ns = next_ns;
399 : : }
400 : :
401 [ + + + - : 765 : 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 [ + - + - ]: 765 : free(subsystem->ns);
411 [ + - + - ]: 765 : free(subsystem->ana_group);
412 : :
413 [ + - + - : 765 : RB_REMOVE(subsystem_tree, &subsystem->tgt->subsystems, subsystem);
+ - ]
414 [ + + + - : 765 : assert(spdk_bit_array_get(subsystem->tgt->subsystem_ids, subsystem->id) == true);
+ - + - +
- + - + -
# # ]
415 [ + - + - : 765 : spdk_bit_array_clear(subsystem->tgt->subsystem_ids, subsystem->id);
+ - + - +
- + - ]
416 : :
417 [ + + + - ]: 765 : pthread_mutex_destroy(&subsystem->mutex);
418 : :
419 [ + - ]: 765 : spdk_bit_array_free(&subsystem->used_listener_ids);
420 : :
421 [ + + + + : 765 : if (subsystem->async_destroy) {
+ - + - ]
422 [ # # # # ]: 1 : async_destroy_cb = subsystem->async_destroy_cb;
423 [ # # # # ]: 1 : async_destroy_cb_arg = subsystem->async_destroy_cb_arg;
424 : 0 : }
425 : :
426 : 765 : free(subsystem);
427 : :
428 [ + + ]: 765 : if (async_destroy_cb) {
429 [ # # # # ]: 1 : async_destroy_cb(async_destroy_cb_arg);
430 : 0 : }
431 : :
432 : 765 : return 0;
433 : 121 : }
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 : 765 : 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 [ + + ]: 765 : if (!subsystem) {
456 : 0 : return -EINVAL;
457 : : }
458 : :
459 : 120 : SPDK_DTRACE_PROBE1(nvmf_subsystem_destroy, subsystem->subnqn);
460 : :
461 [ + + + - : 765 : assert(spdk_get_thread() == subsystem->thread);
+ - # # ]
462 : :
463 [ + + + - : 765 : 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 [ + + + + : 765 : if (subsystem->destroying) {
+ - + - ]
469 : 0 : SPDK_ERRLOG("Subsystem destruction is already started\n");
470 [ # # ]: 0 : assert(0);
471 : : return -EALREADY;
472 : : }
473 : :
474 [ + - + - ]: 765 : subsystem->destroying = true;
475 : :
476 [ + + + + : 765 : SPDK_DEBUGLOG(nvmf, "subsystem is %p %s\n", subsystem, subsystem->subnqn);
+ - # # ]
477 : :
478 : 765 : nvmf_subsystem_remove_all_listeners(subsystem, false);
479 : :
480 [ + + + - ]: 765 : pthread_mutex_lock(&subsystem->mutex);
481 : :
482 [ + + + + : 781 : TAILQ_FOREACH_SAFE(host, &subsystem->hosts, link, host_tmp) {
+ - - + #
# # # # #
- + ]
483 [ + + # # : 32 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
# # ]
484 : 16 : transport = spdk_nvmf_transport_get_next(transport)) {
485 [ + - # # : 16 : if (transport->ops->subsystem_remove_host) {
# # # # ]
486 [ # # # # : 16 : transport->ops->subsystem_remove_host(transport, subsystem, host->nqn);
# # # # #
# # # ]
487 : 0 : }
488 : 0 : }
489 : 16 : nvmf_subsystem_remove_host(subsystem, host);
490 : 0 : }
491 : :
492 [ + + + - ]: 765 : pthread_mutex_unlock(&subsystem->mutex);
493 : :
494 [ + - + - ]: 765 : subsystem->async_destroy_cb = cpl_cb;
495 [ + - + - ]: 765 : subsystem->async_destroy_cb_arg = cpl_cb_arg;
496 : :
497 : 765 : return _nvmf_subsystem_destroy(subsystem);
498 : 121 : }
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 : 3740 : nvmf_subsystem_get_intermediate_state(enum spdk_nvmf_subsystem_state current_state,
505 : : enum spdk_nvmf_subsystem_state requested_state)
506 : : {
507 [ + + + + ]: 3740 : switch (requested_state) {
508 : 611 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
509 : 721 : return SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
510 : 1678 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
511 [ + + ]: 1868 : if (current_state == SPDK_NVMF_SUBSYSTEM_PAUSED) {
512 : 1147 : return SPDK_NVMF_SUBSYSTEM_RESUMING;
513 : : } else {
514 : 721 : return SPDK_NVMF_SUBSYSTEM_ACTIVATING;
515 : : }
516 : 1070 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
517 : 1151 : return SPDK_NVMF_SUBSYSTEM_PAUSING;
518 : 0 : default:
519 [ # # ]: 0 : assert(false);
520 : : return SPDK_NVMF_SUBSYSTEM_NUM_STATES;
521 : : }
522 : 381 : }
523 : :
524 : : static int
525 : 7480 : nvmf_subsystem_set_state(struct spdk_nvmf_subsystem *subsystem,
526 : : enum spdk_nvmf_subsystem_state state)
527 : : {
528 : 2482 : enum spdk_nvmf_subsystem_state actual_old_state, expected_old_state;
529 : : bool exchanged;
530 : :
531 [ + + + + : 7480 : switch (state) {
+ + + + ]
532 : 611 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
533 : 721 : expected_old_state = SPDK_NVMF_SUBSYSTEM_DEACTIVATING;
534 : 721 : break;
535 : 611 : case SPDK_NVMF_SUBSYSTEM_ACTIVATING:
536 : 721 : expected_old_state = SPDK_NVMF_SUBSYSTEM_INACTIVE;
537 : 721 : break;
538 : 1678 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
539 : 1868 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVATING;
540 : 1868 : break;
541 : 1070 : case SPDK_NVMF_SUBSYSTEM_PAUSING:
542 : 1151 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
543 : 1151 : break;
544 : 1070 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
545 : 1151 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSING;
546 : 1151 : break;
547 : 1067 : case SPDK_NVMF_SUBSYSTEM_RESUMING:
548 : 1147 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
549 : 1147 : break;
550 : 611 : case SPDK_NVMF_SUBSYSTEM_DEACTIVATING:
551 : 721 : expected_old_state = SPDK_NVMF_SUBSYSTEM_ACTIVE;
552 : 721 : break;
553 : 0 : default:
554 [ # # ]: 0 : assert(false);
555 : : return -1;
556 : : }
557 : :
558 : 7480 : actual_old_state = expected_old_state;
559 [ + + + + : 7480 : exchanged = __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
+ - ]
560 : : __ATOMIC_RELAXED, __ATOMIC_RELAXED);
561 [ + + + + ]: 7480 : if (spdk_unlikely(exchanged == false)) {
562 [ + + + + ]: 1151 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
563 : 80 : state == SPDK_NVMF_SUBSYSTEM_ACTIVE) {
564 : 1147 : expected_old_state = SPDK_NVMF_SUBSYSTEM_RESUMING;
565 : 80 : }
566 : : /* This is for the case when activating the subsystem fails. */
567 [ - + - - ]: 1151 : 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 [ + + + + ]: 1151 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_RESUMING &&
573 : 80 : 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 [ + + + + ]: 1151 : if (actual_old_state == SPDK_NVMF_SUBSYSTEM_PAUSED &&
578 : 1 : state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING) {
579 : 4 : expected_old_state = SPDK_NVMF_SUBSYSTEM_PAUSED;
580 : 1 : }
581 : 1151 : actual_old_state = expected_old_state;
582 [ + - + - : 1151 : __atomic_compare_exchange_n(&subsystem->state, &actual_old_state, state, false,
+ - ]
583 : : __ATOMIC_RELAXED, __ATOMIC_RELAXED);
584 : 81 : }
585 [ + + # # ]: 7480 : assert(actual_old_state == expected_old_state);
586 : 7480 : 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 : 3744 : _nvmf_subsystem_state_change_complete(void *_ctx)
593 : : {
594 : 3744 : struct nvmf_subsystem_state_change_ctx *next, *ctx = _ctx;
595 [ + - + - ]: 3744 : struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
596 : :
597 [ + + + - ]: 3744 : pthread_mutex_lock(&subsystem->mutex);
598 [ + + + - : 3744 : assert(TAILQ_FIRST(&subsystem->state_changes) == ctx);
+ - + - #
# ]
599 [ + + + - : 3744 : TAILQ_REMOVE(&subsystem->state_changes, ctx, link);
+ - - + #
# # # # #
# # # # #
# # # # #
# # + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - ]
600 [ + - + - : 3744 : next = TAILQ_FIRST(&subsystem->state_changes);
+ - ]
601 [ + + + - ]: 3744 : pthread_mutex_unlock(&subsystem->mutex);
602 : :
603 [ + + + - : 3744 : if (ctx->cb_fn != NULL) {
- + ]
604 [ + - + - : 3618 : ctx->cb_fn(subsystem, ctx->cb_arg, ctx->status);
- + + - +
- + - + -
+ - ]
605 : 375 : }
606 : 3744 : free(ctx);
607 : :
608 [ + + ]: 3744 : if (next != NULL) {
609 : 4 : nvmf_subsystem_do_state_change(next);
610 : 1 : }
611 : 3744 : }
612 : :
613 : : static void
614 : 3744 : nvmf_subsystem_state_change_complete(struct nvmf_subsystem_state_change_ctx *ctx, int status)
615 : : {
616 [ + - + - ]: 3744 : ctx->status = status;
617 [ + - + - ]: 3744 : spdk_thread_exec_msg(ctx->thread, _nvmf_subsystem_state_change_complete, ctx);
618 : 3744 : }
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 : 3740 : subsystem_state_change_done(struct spdk_io_channel_iter *i, int status)
636 : : {
637 : 3740 : struct nvmf_subsystem_state_change_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
638 : : enum spdk_nvmf_subsystem_state intermediate_state;
639 : :
640 : 1726 : SPDK_DTRACE_PROBE4(nvmf_subsystem_change_state_done, ctx->subsystem->subnqn,
641 : : ctx->requested_state, ctx->original_state, status);
642 : :
643 [ + + ]: 3740 : if (status == 0) {
644 [ + - + - : 3740 : status = nvmf_subsystem_set_state(ctx->subsystem, ctx->requested_state);
+ - + - ]
645 [ + + ]: 3740 : if (status) {
646 : 0 : status = -1;
647 : 0 : }
648 : 381 : }
649 : :
650 [ - + ]: 3740 : 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 : 3359 : out:
667 : 3740 : nvmf_subsystem_state_change_complete(ctx, status);
668 : 381 : }
669 : :
670 : : static void
671 : 6124 : subsystem_state_change_continue(void *ctx, int status)
672 : : {
673 : 6124 : struct spdk_io_channel_iter *i = ctx;
674 : : struct nvmf_subsystem_state_change_ctx *_ctx __attribute__((unused));
675 : :
676 : 6124 : _ctx = spdk_io_channel_iter_get_ctx(i);
677 : 2354 : SPDK_DTRACE_PROBE3(nvmf_pg_change_state_done, _ctx->subsystem->subnqn,
678 : : _ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
679 : :
680 : 6124 : spdk_for_each_channel_continue(i, status);
681 : 6124 : }
682 : :
683 : : static void
684 : 6124 : 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 : 6124 : ctx = spdk_io_channel_iter_get_ctx(i);
691 : 6124 : ch = spdk_io_channel_iter_get_channel(i);
692 : 6124 : group = spdk_io_channel_get_ctx(ch);
693 : :
694 : 2354 : SPDK_DTRACE_PROBE3(nvmf_pg_change_state, ctx->subsystem->subnqn,
695 : : ctx->requested_state, spdk_thread_get_id(spdk_get_thread()));
696 [ + + + - : 6124 : switch (ctx->requested_state) {
+ - + + ]
697 : 909 : case SPDK_NVMF_SUBSYSTEM_INACTIVE:
698 [ + - + - ]: 1030 : nvmf_poll_group_remove_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
699 : 1030 : break;
700 : 2863 : case SPDK_NVMF_SUBSYSTEM_ACTIVE:
701 [ + + + - : 3062 : if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_ACTIVATING) {
+ - + - +
+ ]
702 [ + - + - ]: 1030 : nvmf_poll_group_add_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
703 [ + - + - : 2153 : } else if (ctx->subsystem->state == SPDK_NVMF_SUBSYSTEM_RESUMING) {
+ - + - -
+ ]
704 [ + - + - ]: 2032 : nvmf_poll_group_resume_subsystem(group, ctx->subsystem, subsystem_state_change_continue, i);
705 : 78 : }
706 : 3062 : break;
707 : 1954 : case SPDK_NVMF_SUBSYSTEM_PAUSED:
708 [ + - + - : 2032 : nvmf_poll_group_pause_subsystem(group, ctx->subsystem, ctx->nsid, subsystem_state_change_continue,
+ - + - ]
709 : 78 : i);
710 : 2032 : break;
711 : 0 : default:
712 [ # # ]: 0 : assert(false);
713 : : break;
714 : : }
715 : 6124 : }
716 : :
717 : : static void
718 : 3744 : nvmf_subsystem_do_state_change(struct nvmf_subsystem_state_change_ctx *ctx)
719 : : {
720 [ + - + - ]: 3744 : struct spdk_nvmf_subsystem *subsystem = ctx->subsystem;
721 : : enum spdk_nvmf_subsystem_state intermediate_state;
722 : : int rc;
723 : :
724 : 1726 : 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 [ + + + - : 3744 : if (subsystem->state == ctx->requested_state) {
+ - + - -
+ ]
729 : 4 : nvmf_subsystem_state_change_complete(ctx, 0);
730 : 4 : return;
731 : : }
732 : :
733 [ + - + - ]: 4121 : intermediate_state = nvmf_subsystem_get_intermediate_state(subsystem->state,
734 [ + - + - ]: 381 : ctx->requested_state);
735 [ + + # # ]: 3740 : assert(intermediate_state != SPDK_NVMF_SUBSYSTEM_NUM_STATES);
736 : :
737 [ + - + - : 3740 : ctx->original_state = subsystem->state;
+ - + - ]
738 : 3740 : rc = nvmf_subsystem_set_state(subsystem, intermediate_state);
739 [ - + ]: 3740 : if (rc) {
740 : 0 : nvmf_subsystem_state_change_complete(ctx, -1);
741 : 0 : return;
742 : : }
743 : :
744 [ + - + - ]: 3781 : spdk_for_each_channel(subsystem->tgt,
745 : : subsystem_state_change_on_pg,
746 : 381 : ctx,
747 : : subsystem_state_change_done);
748 : 382 : }
749 : :
750 : :
751 : : static int
752 : 3744 : 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 : 3744 : thread = spdk_get_thread();
762 [ + + ]: 3744 : if (thread == NULL) {
763 : 0 : return -EINVAL;
764 : : }
765 : :
766 : 3744 : ctx = calloc(1, sizeof(*ctx));
767 [ + + ]: 3744 : if (!ctx) {
768 : 0 : return -ENOMEM;
769 : : }
770 : :
771 [ + - + - ]: 3744 : ctx->subsystem = subsystem;
772 [ + - + - ]: 3744 : ctx->nsid = nsid;
773 [ + - + - ]: 3744 : ctx->requested_state = requested_state;
774 [ + - + - ]: 3744 : ctx->cb_fn = cb_fn;
775 [ + - + - ]: 3744 : ctx->cb_arg = cb_arg;
776 [ + - + - ]: 3744 : ctx->thread = thread;
777 : :
778 [ + + + - ]: 3744 : pthread_mutex_lock(&subsystem->mutex);
779 [ + - + - : 3744 : TAILQ_INSERT_TAIL(&subsystem->state_changes, ctx, link);
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - ]
780 [ + + + - : 3744 : if (ctx != TAILQ_FIRST(&subsystem->state_changes)) {
+ - - + ]
781 [ - + # # ]: 4 : pthread_mutex_unlock(&subsystem->mutex);
782 : 4 : return 0;
783 : : }
784 [ - + - + ]: 3740 : pthread_mutex_unlock(&subsystem->mutex);
785 : :
786 : 3740 : nvmf_subsystem_do_state_change(ctx);
787 : :
788 : 3740 : return 0;
789 : 382 : }
790 : :
791 : : int
792 : 721 : spdk_nvmf_subsystem_start(struct spdk_nvmf_subsystem *subsystem,
793 : : spdk_nvmf_subsystem_state_change_done cb_fn,
794 : : void *cb_arg)
795 : : {
796 : 721 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
797 : : }
798 : :
799 : : int
800 : 725 : spdk_nvmf_subsystem_stop(struct spdk_nvmf_subsystem *subsystem,
801 : : spdk_nvmf_subsystem_state_change_done cb_fn,
802 : : void *cb_arg)
803 : : {
804 : 725 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_INACTIVE, cb_fn, cb_arg);
805 : : }
806 : :
807 : : int
808 : 1151 : 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 : 1151 : return nvmf_subsystem_state_change(subsystem, nsid, SPDK_NVMF_SUBSYSTEM_PAUSED, cb_fn, cb_arg);
814 : : }
815 : :
816 : : int
817 : 1147 : spdk_nvmf_subsystem_resume(struct spdk_nvmf_subsystem *subsystem,
818 : : spdk_nvmf_subsystem_state_change_done cb_fn,
819 : : void *cb_arg)
820 : : {
821 : 1147 : return nvmf_subsystem_state_change(subsystem, 0, SPDK_NVMF_SUBSYSTEM_ACTIVE, cb_fn, cb_arg);
822 : : }
823 : :
824 : : struct spdk_nvmf_subsystem *
825 : 4211 : spdk_nvmf_subsystem_get_first(struct spdk_nvmf_tgt *tgt)
826 : : {
827 [ + - ]: 4211 : return RB_MIN(subsystem_tree, &tgt->subsystems);
828 : : }
829 : :
830 : : struct spdk_nvmf_subsystem *
831 : 4591 : spdk_nvmf_subsystem_get_next(struct spdk_nvmf_subsystem *subsystem)
832 : : {
833 [ + + ]: 4591 : if (!subsystem) {
834 : 591 : return NULL;
835 : : }
836 : :
837 : 4000 : return RB_NEXT(subsystem_tree, &tgt->subsystems, subsystem);
838 : 585 : }
839 : :
840 : : static int
841 : 8 : nvmf_ns_add_host(struct spdk_nvmf_ns *ns, const char *hostnqn)
842 : : {
843 : : struct spdk_nvmf_host *host;
844 : :
845 : 8 : host = calloc(1, sizeof(*host));
846 [ + + ]: 8 : if (!host) {
847 : 0 : return -ENOMEM;
848 : : }
849 [ - + ]: 8 : snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
850 [ + + # # : 8 : TAILQ_INSERT_HEAD(&ns->hosts, host, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
851 : 8 : return 0;
852 : 2 : }
853 : :
854 : : static void
855 : 8 : nvmf_ns_remove_host(struct spdk_nvmf_ns *ns, struct spdk_nvmf_host *host)
856 : : {
857 [ + + # # : 8 : TAILQ_REMOVE(&ns->hosts, host, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ]
858 : 8 : free(host);
859 : 8 : }
860 : :
861 : : static void
862 : 12 : _async_event_ns_notice(void *_ctrlr)
863 : : {
864 : 12 : struct spdk_nvmf_ctrlr *ctrlr = _ctrlr;
865 : :
866 : 12 : nvmf_ctrlr_async_event_ns_notice(ctrlr);
867 : 12 : }
868 : :
869 : : static void
870 : 12 : send_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr)
871 : : {
872 [ # # # # ]: 12 : spdk_thread_send_msg(ctrlr->thread, _async_event_ns_notice, ctrlr);
873 : 12 : }
874 : :
875 : : static int
876 : 56 : 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 [ - + # # : 56 : 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 [ + + + + ]: 56 : if (hostnqn == NULL || !nvmf_nqn_is_valid(hostnqn)) {
893 : 12 : return -EINVAL;
894 : : }
895 : :
896 [ + + - + : 44 : if (nsid == 0 || nsid > subsystem->max_nsid) {
# # # # ]
897 : 8 : return -EINVAL;
898 : : }
899 : :
900 [ # # # # : 36 : ns = subsystem->ns[nsid - 1];
# # # # ]
901 [ + + ]: 36 : if (!ns) {
902 : 8 : return -ENOENT;
903 : : }
904 : :
905 [ + + + + : 28 : if (ns->always_visible) {
# # # # ]
906 : : /* No individual host control */
907 : 8 : return -EPERM;
908 : : }
909 : :
910 : : /* Save host info to use for any future controllers. */
911 : 20 : host = nvmf_ns_find_host(ns, hostnqn);
912 [ + + + + : 20 : if (visible && host == NULL) {
# # ]
913 : 8 : rc = nvmf_ns_add_host(ns, hostnqn);
914 [ - + ]: 8 : if (rc) {
915 : 0 : return rc;
916 : : }
917 [ + + + + : 14 : } else if (!visible && host != NULL) {
# # ]
918 : 4 : nvmf_ns_remove_host(ns, host);
919 : 1 : }
920 : :
921 : : /* Also apply to existing controllers. */
922 [ + + # # : 60 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
# # # # #
# # # #
# ]
923 [ + + + + : 55 : if (strcmp(hostnqn, ctrlr->hostnqn) ||
+ + + + #
# ]
924 [ # # ]: 20 : nvmf_ctrlr_ns_is_visible(ctrlr, nsid) == visible) {
925 : 28 : continue;
926 : : }
927 [ # # ]: 12 : nvmf_ctrlr_ns_set_visible(ctrlr, nsid, visible);
928 : 12 : send_async_event_ns_notice(ctrlr);
929 : 12 : nvmf_ctrlr_ns_changed(ctrlr, nsid);
930 : 3 : }
931 : :
932 : 20 : return 0;
933 : 14 : }
934 : :
935 : : int
936 : 32 : spdk_nvmf_ns_add_host(struct spdk_nvmf_subsystem *subsystem,
937 : : uint32_t nsid,
938 : : const char *hostnqn,
939 : : uint32_t flags)
940 : : {
941 : 0 : SPDK_DTRACE_PROBE4(spdk_nvmf_ns_add_host,
942 : : subsystem->subnqn,
943 : : nsid,
944 : : hostnqn,
945 : : flags);
946 : 32 : return nvmf_ns_visible(subsystem, nsid, hostnqn, true);
947 : : }
948 : :
949 : : int
950 : 24 : spdk_nvmf_ns_remove_host(struct spdk_nvmf_subsystem *subsystem,
951 : : uint32_t nsid,
952 : : const char *hostnqn,
953 : : uint32_t flags)
954 : : {
955 : 0 : SPDK_DTRACE_PROBE4(spdk_nvmf_ns_remove_host,
956 : : subsystem->subnqn,
957 : : nsid,
958 : : hostnqn,
959 : : flags);
960 : 24 : 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 : 3471 : nvmf_subsystem_find_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
966 : : {
967 : 3471 : struct spdk_nvmf_host *host = NULL;
968 : :
969 [ + + + - : 3474 : TAILQ_FOREACH(host, &subsystem->hosts, link) {
+ - - + #
# # # #
# ]
970 [ + + - + : 1263 : if (strcmp(hostnqn, host->nqn) == 0) {
+ + # # ]
971 : 1260 : return host;
972 : : }
973 : 0 : }
974 : :
975 : 2211 : return NULL;
976 : 1707 : }
977 : :
978 : : int
979 : 112 : 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 [ - + ]: 112 : if (!nvmf_nqn_is_valid(hostnqn)) {
988 : 0 : return -EINVAL;
989 : : }
990 : :
991 [ - + # # ]: 112 : pthread_mutex_lock(&subsystem->mutex);
992 : :
993 [ + + ]: 112 : if (nvmf_subsystem_find_host(subsystem, hostnqn)) {
994 : : /* This subsystem already allows the specified host. */
995 [ - + # # ]: 4 : pthread_mutex_unlock(&subsystem->mutex);
996 : 4 : return -EINVAL;
997 : : }
998 : :
999 : 108 : host = calloc(1, sizeof(*host));
1000 [ + + ]: 108 : if (!host) {
1001 [ # # # # ]: 0 : pthread_mutex_unlock(&subsystem->mutex);
1002 : 0 : return -ENOMEM;
1003 : : }
1004 : :
1005 [ + + # # : 108 : key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
# # # # #
# ]
1006 [ + + ]: 108 : if (key != NULL) {
1007 [ - + ]: 78 : 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 [ # # # # ]: 78 : host->dhchap_key = spdk_key_dup(key);
1014 [ - + # # : 78 : if (host->dhchap_key == NULL) {
# # ]
1015 [ # # # # ]: 0 : pthread_mutex_unlock(&subsystem->mutex);
1016 : 0 : nvmf_host_free(host);
1017 : 0 : return -EINVAL;
1018 : : }
1019 [ + - # # : 78 : key = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
# # # # #
# ]
1020 [ + + ]: 78 : if (key != NULL) {
1021 [ # # # # ]: 56 : host->dhchap_ctrlr_key = spdk_key_dup(key);
1022 [ - + # # : 56 : 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 [ + + - + : 30 : } 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 [ - + ]: 108 : snprintf(host->nqn, sizeof(host->nqn), "%s", hostnqn);
1036 : :
1037 : 94 : SPDK_DTRACE_PROBE2(nvmf_subsystem_add_host, subsystem->subnqn, host->nqn);
1038 : :
1039 [ + + # # : 108 : TAILQ_INSERT_HEAD(&subsystem->hosts, host, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1040 : :
1041 [ + + # # : 108 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
# # # # ]
1042 [ # # # # ]: 92 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn);
1043 : 0 : }
1044 : :
1045 [ + + # # : 203 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
# # ]
1046 : 95 : transport = spdk_nvmf_transport_get_next(transport)) {
1047 [ + + # # : 100 : if (transport->ops->subsystem_add_host) {
# # # # #
# ]
1048 [ # # # # : 199 : rc = transport->ops->subsystem_add_host(transport, subsystem, hostnqn,
# # # # #
# # # ]
1049 [ + - # # : 100 : SPDK_GET_FIELD(opts, params, NULL));
# # # # #
# ]
1050 [ + + ]: 100 : if (rc) {
1051 [ # # # # : 5 : 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 [ - + # # ]: 5 : pthread_mutex_unlock(&subsystem->mutex);
1054 : 5 : spdk_nvmf_subsystem_remove_host(subsystem, hostnqn);
1055 : 5 : return rc;
1056 : : }
1057 : 0 : }
1058 : 0 : }
1059 : :
1060 [ - + # # ]: 103 : pthread_mutex_unlock(&subsystem->mutex);
1061 : :
1062 : 103 : return 0;
1063 : 4 : }
1064 : :
1065 : : int
1066 : 16 : spdk_nvmf_subsystem_add_host(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn,
1067 : : const struct spdk_json_val *params)
1068 : : {
1069 : 16 : struct spdk_nvmf_host_opts opts = {};
1070 : :
1071 : 16 : opts.size = SPDK_SIZEOF(&opts, params);
1072 [ # # ]: 16 : opts.params = params;
1073 : :
1074 : 16 : return spdk_nvmf_subsystem_add_host_ext(subsystem, hostnqn, &opts);
1075 : : }
1076 : :
1077 : : int
1078 : 96 : 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 [ - + # # ]: 96 : pthread_mutex_lock(&subsystem->mutex);
1084 : :
1085 : 96 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1086 [ + + ]: 96 : if (host == NULL) {
1087 [ - + # # ]: 4 : pthread_mutex_unlock(&subsystem->mutex);
1088 : 4 : return -ENOENT;
1089 : : }
1090 : :
1091 : 80 : SPDK_DTRACE_PROBE2(nvmf_subsystem_remove_host, subsystem->subnqn, host->nqn);
1092 : :
1093 : 92 : nvmf_subsystem_remove_host(subsystem, host);
1094 : :
1095 [ + + # # : 92 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
# # # # ]
1096 [ # # # # ]: 84 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, hostnqn);
1097 : 1 : }
1098 : :
1099 [ + + # # : 176 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
# # ]
1100 : 84 : transport = spdk_nvmf_transport_get_next(transport)) {
1101 [ + + # # : 84 : if (transport->ops->subsystem_remove_host) {
# # # # #
# ]
1102 [ # # # # : 80 : transport->ops->subsystem_remove_host(transport, subsystem, hostnqn);
# # # # #
# # # ]
1103 : 0 : }
1104 : 1 : }
1105 : :
1106 [ - + # # ]: 92 : pthread_mutex_unlock(&subsystem->mutex);
1107 : :
1108 : 92 : return 0;
1109 : 4 : }
1110 : :
1111 : : int
1112 : 11 : 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 [ - + ]: 11 : if (!nvmf_auth_is_supported()) {
1119 : 0 : SPDK_ERRLOG("NVMe in-band authentication is unsupported\n");
1120 : 0 : return -EINVAL;
1121 : : }
1122 : :
1123 [ - + # # ]: 11 : pthread_mutex_lock(&subsystem->mutex);
1124 : 11 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1125 [ - + ]: 11 : if (host == NULL) {
1126 [ # # # # ]: 0 : pthread_mutex_unlock(&subsystem->mutex);
1127 : 0 : return -EINVAL;
1128 : : }
1129 : :
1130 [ + - + + : 13 : if (SPDK_GET_FIELD(opts, dhchap_key, host->dhchap_key) == NULL &&
- + # # #
# # # # #
# # # # ]
1131 [ + - # # : 2 : 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 [ + - # # : 11 : key = SPDK_GET_FIELD(opts, dhchap_key, NULL);
# # # # #
# ]
1137 [ + + ]: 11 : if (key != NULL) {
1138 : 9 : key = spdk_key_dup(key);
1139 [ - + ]: 9 : if (key == NULL) {
1140 [ # # # # ]: 0 : pthread_mutex_unlock(&subsystem->mutex);
1141 : 0 : return -EINVAL;
1142 : : }
1143 : 0 : }
1144 [ + - # # : 11 : ckey = SPDK_GET_FIELD(opts, dhchap_ctrlr_key, NULL);
# # # # #
# ]
1145 [ + + ]: 11 : if (ckey != NULL) {
1146 : 8 : ckey = spdk_key_dup(ckey);
1147 [ - + ]: 8 : 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 [ + - # # : 11 : if (SPDK_FIELD_VALID(opts, dhchap_key)) {
# # ]
1154 [ # # # # ]: 11 : spdk_keyring_put_key(host->dhchap_key);
1155 [ # # # # ]: 11 : host->dhchap_key = key;
1156 : 0 : }
1157 [ + - # # : 11 : if (SPDK_FIELD_VALID(opts, dhchap_ctrlr_key)) {
# # ]
1158 [ # # # # ]: 11 : spdk_keyring_put_key(host->dhchap_ctrlr_key);
1159 [ # # # # ]: 11 : host->dhchap_ctrlr_key = ckey;
1160 : 0 : }
1161 [ - + # # ]: 11 : pthread_mutex_unlock(&subsystem->mutex);
1162 : :
1163 : 11 : 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 : 79 : nvmf_subsystem_disconnect_host_fini(struct spdk_io_channel_iter *i, int status)
1175 : : {
1176 : : struct nvmf_subsystem_disconnect_host_ctx *ctx;
1177 : :
1178 : 79 : ctx = spdk_io_channel_iter_get_ctx(i);
1179 : :
1180 [ + - # # : 79 : if (ctx->cb_fn) {
# # ]
1181 [ # # # # : 79 : ctx->cb_fn(ctx->cb_arg, status);
# # # # #
# # # ]
1182 : 0 : }
1183 [ # # # # ]: 79 : free(ctx->hostnqn);
1184 : 79 : free(ctx);
1185 : 79 : }
1186 : :
1187 : : static void
1188 : 82 : 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 : 82 : ctx = spdk_io_channel_iter_get_ctx(i);
1197 : 82 : ch = spdk_io_channel_iter_get_channel(i);
1198 : 82 : group = spdk_io_channel_get_ctx(ch);
1199 : :
1200 [ + + # # : 84 : TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) {
# # # # #
# # # # #
# # ]
1201 [ # # # # ]: 2 : ctrlr = qpair->ctrlr;
1202 : :
1203 [ + - - + : 2 : if (ctrlr == NULL || ctrlr->subsys != ctx->subsystem) {
# # # # #
# # # ]
1204 : 0 : continue;
1205 : : }
1206 : :
1207 [ - + - + : 2 : 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 : 2 : spdk_nvmf_qpair_disconnect(qpair);
1210 : 0 : }
1211 : 0 : }
1212 : 82 : spdk_for_each_channel_continue(i, 0);
1213 : 82 : }
1214 : :
1215 : : int
1216 : 79 : 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 : 79 : ctx = calloc(1, sizeof(struct nvmf_subsystem_disconnect_host_ctx));
1224 [ - + ]: 79 : if (ctx == NULL) {
1225 : 0 : return -ENOMEM;
1226 : : }
1227 : :
1228 [ - + # # : 79 : ctx->hostnqn = strdup(hostnqn);
# # ]
1229 [ - + # # : 79 : if (ctx->hostnqn == NULL) {
# # ]
1230 : 0 : free(ctx);
1231 : 0 : return -ENOMEM;
1232 : : }
1233 : :
1234 [ # # # # ]: 79 : ctx->subsystem = subsystem;
1235 [ # # # # ]: 79 : ctx->cb_fn = cb_fn;
1236 [ # # # # ]: 79 : ctx->cb_arg = cb_arg;
1237 : :
1238 [ # # # # ]: 79 : spdk_for_each_channel(subsystem->tgt, nvmf_subsystem_disconnect_qpairs_by_host, ctx,
1239 : : nvmf_subsystem_disconnect_host_fini);
1240 : :
1241 : 79 : return 0;
1242 : 0 : }
1243 : :
1244 : : int
1245 : 713 : spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem, bool allow_any_host)
1246 : : {
1247 [ + + + + : 713 : if (subsystem->allow_any_host == allow_any_host) {
+ - + - -
+ ]
1248 : 29 : return 0;
1249 : : }
1250 : :
1251 [ + + + - ]: 684 : pthread_mutex_lock(&subsystem->mutex);
1252 [ + - + - : 684 : subsystem->allow_any_host = allow_any_host;
+ - ]
1253 [ + + + - : 684 : if (!TAILQ_EMPTY(&subsystem->listeners)) {
+ - - + ]
1254 [ # # # # ]: 0 : spdk_nvmf_send_discovery_log_notice(subsystem->tgt, NULL);
1255 : 0 : }
1256 [ + + + - ]: 684 : pthread_mutex_unlock(&subsystem->mutex);
1257 : :
1258 : 684 : return 0;
1259 : 108 : }
1260 : :
1261 : : bool
1262 : 407 : 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 : 407 : sub = (struct spdk_nvmf_subsystem *)subsystem;
1271 : :
1272 [ + + + - ]: 407 : pthread_mutex_lock(&sub->mutex);
1273 [ + + + - : 407 : allow_any_host = sub->allow_any_host;
+ - ]
1274 [ + + + - ]: 407 : pthread_mutex_unlock(&sub->mutex);
1275 : :
1276 [ + - ]: 407 : return allow_any_host;
1277 : : }
1278 : :
1279 : : bool
1280 : 2714 : spdk_nvmf_subsystem_host_allowed(struct spdk_nvmf_subsystem *subsystem, const char *hostnqn)
1281 : : {
1282 : : bool allowed;
1283 : :
1284 [ + + ]: 2714 : if (!hostnqn) {
1285 : 0 : return false;
1286 : : }
1287 : :
1288 [ + + + - ]: 2714 : pthread_mutex_lock(&subsystem->mutex);
1289 : :
1290 [ + + + + : 2714 : if (subsystem->allow_any_host) {
+ - + - ]
1291 [ - + - + ]: 2311 : pthread_mutex_unlock(&subsystem->mutex);
1292 : 2311 : return true;
1293 : : }
1294 : :
1295 : 403 : allowed = nvmf_subsystem_find_host(subsystem, hostnqn) != NULL;
1296 [ - + # # ]: 403 : pthread_mutex_unlock(&subsystem->mutex);
1297 : :
1298 [ # # ]: 403 : return allowed;
1299 : 1724 : }
1300 : :
1301 : : bool
1302 : 2420 : 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 [ + + + - ]: 2420 : pthread_mutex_lock(&subsystem->mutex);
1308 : 2420 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1309 [ + + + + : 2420 : status = host != NULL && host->dhchap_key != NULL;
# # ]
1310 [ + + + - ]: 2420 : pthread_mutex_unlock(&subsystem->mutex);
1311 : :
1312 [ + - ]: 2420 : return status;
1313 : : }
1314 : :
1315 : : struct spdk_key *
1316 : 429 : 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 : 429 : struct spdk_key *key = NULL;
1321 : :
1322 [ - + # # ]: 429 : pthread_mutex_lock(&subsystem->mutex);
1323 : 429 : host = nvmf_subsystem_find_host(subsystem, hostnqn);
1324 [ + - ]: 429 : if (host != NULL) {
1325 [ + + - ]: 429 : switch (type) {
1326 : 247 : case NVMF_AUTH_KEY_HOST:
1327 [ # # # # ]: 247 : key = host->dhchap_key;
1328 : 247 : break;
1329 : 182 : case NVMF_AUTH_KEY_CTRLR:
1330 [ # # # # ]: 182 : key = host->dhchap_ctrlr_key;
1331 : 182 : break;
1332 : : }
1333 [ + + ]: 429 : if (key != NULL) {
1334 : 427 : key = spdk_key_dup(key);
1335 : 0 : }
1336 : 0 : }
1337 [ - + # # ]: 429 : pthread_mutex_unlock(&subsystem->mutex);
1338 : :
1339 : 429 : return key;
1340 : : }
1341 : :
1342 : : struct spdk_nvmf_host *
1343 : 258 : spdk_nvmf_subsystem_get_first_host(struct spdk_nvmf_subsystem *subsystem)
1344 : : {
1345 [ # # # # : 258 : return TAILQ_FIRST(&subsystem->hosts);
# # ]
1346 : : }
1347 : :
1348 : :
1349 : : struct spdk_nvmf_host *
1350 : 2 : spdk_nvmf_subsystem_get_next_host(struct spdk_nvmf_subsystem *subsystem,
1351 : : struct spdk_nvmf_host *prev_host)
1352 : : {
1353 [ # # # # : 2 : 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 : 200 : spdk_nvmf_referral_host_allowed(struct spdk_nvmf_referral *referral, const char *hostnqn)
1467 : : {
1468 : : bool allowed;
1469 : :
1470 [ + + ]: 200 : if (!hostnqn) {
1471 : 0 : return false;
1472 : : }
1473 : :
1474 [ - + # # ]: 200 : pthread_mutex_lock(&referral->mutex);
1475 : :
1476 [ + + + - : 200 : if (referral->allow_any_host) {
# # # # ]
1477 [ - + # # ]: 200 : pthread_mutex_unlock(&referral->mutex);
1478 : 200 : 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 : 2 : spdk_nvmf_host_get_nqn(const struct spdk_nvmf_host *host)
1503 : : {
1504 [ # # ]: 2 : return host->nqn;
1505 : : }
1506 : :
1507 : : struct spdk_nvmf_subsystem_listener *
1508 : 1594 : 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 [ + + + - : 1735 : TAILQ_FOREACH(listener, &subsystem->listeners, link) {
+ - + + #
# # # #
# ]
1514 [ + + + - : 1411 : if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
- + ]
1515 : 1270 : return listener;
1516 : : }
1517 : 15 : }
1518 : :
1519 : 324 : return NULL;
1520 : 970 : }
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 : 176 : _nvmf_subsystem_add_listener_done(void *ctx, int status)
1530 : : {
1531 : 176 : struct spdk_nvmf_subsystem_listener *listener = ctx;
1532 : :
1533 [ - + ]: 176 : if (status) {
1534 [ # # # # : 0 : listener->cb_fn(listener->cb_arg, status);
# # # # #
# # # ]
1535 : 0 : free(listener);
1536 : 0 : return;
1537 : : }
1538 : :
1539 [ + + + - : 176 : TAILQ_INSERT_HEAD(&listener->subsystem->listeners, listener, link);
+ - + - +
- + - + -
+ - - + #
# # # # #
# # # # #
# # # # #
# # # # +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - ]
1540 : :
1541 [ + + + - : 176 : if (spdk_nvmf_subsystem_is_discovery(listener->subsystem)) {
+ - ]
1542 [ # # # # : 12 : status = nvmf_tgt_update_mdns_prr(listener->subsystem->tgt);
# # # # ]
1543 [ - + ]: 12 : 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 [ + - + - : 176 : spdk_nvmf_send_discovery_log_notice(listener->subsystem->tgt, NULL);
+ - + - ]
1552 [ + - + - : 176 : listener->cb_fn(listener->cb_arg, status);
- + + - +
- + - ]
1553 : 46 : }
1554 : :
1555 : : void
1556 : 325 : spdk_nvmf_subsystem_listener_opts_init(struct spdk_nvmf_listener_opts *opts, size_t size)
1557 : : {
1558 [ + + ]: 325 : if (opts == NULL) {
1559 : 0 : SPDK_ERRLOG("opts should not be NULL\n");
1560 [ # # ]: 0 : assert(false);
1561 : : return;
1562 : : }
1563 [ + + ]: 325 : if (size == 0) {
1564 : 0 : SPDK_ERRLOG("size should not be zero\n");
1565 [ # # ]: 0 : assert(false);
1566 : : return;
1567 : : }
1568 : :
1569 [ + + ]: 325 : memset(opts, 0, size);
1570 [ + - + - ]: 325 : 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 [ + + + - : 325 : SET_FIELD(secure_channel, false);
+ - ]
1581 [ + + + - : 325 : SET_FIELD(ana_state, SPDK_NVME_ANA_OPTIMIZED_STATE);
+ - ]
1582 [ + + + - : 325 : SET_FIELD(sock_impl, NULL);
+ - ]
1583 : :
1584 : : #undef FIELD_OK
1585 : : #undef SET_FIELD
1586 : 85 : }
1587 : :
1588 : : static int
1589 : 148 : listener_opts_copy(struct spdk_nvmf_listener_opts *src, struct spdk_nvmf_listener_opts *dst)
1590 : : {
1591 [ + + + - : 148 : 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 [ + + ]: 148 : memset(dst, 0, sizeof(*dst));
1598 [ + - + - : 148 : 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 [ + - + + : 148 : SET_FIELD(secure_channel);
- + + - +
- + - + -
+ - ]
1609 [ + - + - : 148 : SET_FIELD(ana_state);
- + + - +
- + - +
- ]
1610 [ + - + - : 148 : 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 : 148 : return 0;
1619 : : }
1620 : :
1621 : : static void
1622 : 176 : _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 : 176 : int rc = 0;
1633 : :
1634 [ + + # # ]: 176 : assert(cb_fn != NULL);
1635 : :
1636 [ + + + - : 215 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
+ - + - ]
1637 [ + + + - ]: 148 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1638 [ # # # # ]: 0 : cb_fn(cb_arg, -EAGAIN);
1639 : 0 : return;
1640 : : }
1641 : :
1642 [ - + ]: 176 : 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 [ + - + - : 176 : transport = spdk_nvmf_tgt_get_transport(subsystem->tgt, trid->trstring);
+ - ]
1649 [ + + ]: 176 : 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 : 176 : tr_listener = nvmf_transport_find_listener(transport, trid);
1657 [ + + ]: 176 : 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 : 176 : listener = calloc(1, sizeof(*listener));
1664 [ + + ]: 176 : if (!listener) {
1665 [ # # # # ]: 0 : cb_fn(cb_arg, -ENOMEM);
1666 : 0 : return;
1667 : : }
1668 : :
1669 [ + - + - : 176 : listener->trid = &tr_listener->trid;
+ - ]
1670 [ + - + - ]: 176 : listener->transport = transport;
1671 [ + - + - ]: 176 : listener->cb_fn = cb_fn;
1672 [ + - + - ]: 176 : listener->cb_arg = cb_arg;
1673 [ + - + - ]: 176 : listener->subsystem = subsystem;
1674 [ + - + - : 176 : listener->ana_state = calloc(subsystem->max_nsid, sizeof(enum spdk_nvme_ana_state));
+ - + - ]
1675 [ + + + - : 176 : if (!listener->ana_state) {
+ - ]
1676 : 0 : free(listener);
1677 [ # # # # ]: 0 : cb_fn(cb_arg, -ENOMEM);
1678 : 0 : return;
1679 : : }
1680 : :
1681 [ + - ]: 176 : spdk_nvmf_subsystem_listener_opts_init(&listener->opts, sizeof(listener->opts));
1682 [ + + ]: 176 : if (opts != NULL) {
1683 [ + - ]: 148 : rc = listener_opts_copy(opts, &listener->opts);
1684 [ - + ]: 148 : 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 : 39 : }
1692 : :
1693 [ + - + - ]: 176 : id = spdk_bit_array_find_first_clear(subsystem->used_listener_ids, 0);
1694 [ + + ]: 176 : 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 [ + - + - ]: 176 : spdk_bit_array_set(subsystem->used_listener_ids, id);
1704 [ + - + - ]: 176 : listener->id = id;
1705 : :
1706 [ + + + - : 5036 : for (i = 0; i < subsystem->max_nsid; i++) {
+ + ]
1707 [ + - + - : 4860 : listener->ana_state[i] = listener->opts.ana_state;
+ - + - +
- + - +
- ]
1708 : 1472 : }
1709 : :
1710 [ + + + - : 176 : if (transport->ops->listen_associate != NULL) {
+ - + - +
+ ]
1711 [ + - + - : 25 : rc = transport->ops->listen_associate(transport, subsystem, trid);
+ - + - -
+ + - ]
1712 : 14 : }
1713 : :
1714 : 75 : SPDK_DTRACE_PROBE4(nvmf_subsystem_add_listener, subsystem->subnqn, listener->trid->trtype,
1715 : : listener->trid->traddr, listener->trid->trsvcid);
1716 : :
1717 : 176 : _nvmf_subsystem_add_listener_done(listener, rc);
1718 : 46 : }
1719 : :
1720 : : void
1721 : 28 : 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 : 28 : _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, NULL);
1727 : 28 : }
1728 : :
1729 : : void
1730 : 148 : 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 : 148 : _nvmf_subsystem_add_listener(subsystem, trid, cb_fn, cb_arg, opts);
1736 : 148 : }
1737 : :
1738 : : int
1739 : 13 : 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 [ + - # # : 13 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
# # # # ]
1745 [ - + # # ]: 13 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1746 : 0 : return -EAGAIN;
1747 : : }
1748 : :
1749 : 13 : listener = nvmf_subsystem_find_listener(subsystem, trid);
1750 [ - + ]: 13 : if (listener == NULL) {
1751 : 0 : return -ENOENT;
1752 : : }
1753 : :
1754 : 9 : SPDK_DTRACE_PROBE4(nvmf_subsystem_remove_listener, subsystem->subnqn, listener->trid->trtype,
1755 : : listener->trid->traddr, listener->trid->trsvcid);
1756 : :
1757 : 13 : _nvmf_subsystem_remove_listener(subsystem, listener, false);
1758 : :
1759 : 13 : return 0;
1760 : 0 : }
1761 : :
1762 : : void
1763 : 808 : 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 [ + + + + : 971 : TAILQ_FOREACH_SAFE(listener, &subsystem->listeners, link, listener_tmp) {
+ - + + +
- + - + -
+ + ]
1769 [ + - ]: 163 : _nvmf_subsystem_remove_listener(subsystem, listener, stop);
1770 : 46 : }
1771 : 808 : }
1772 : :
1773 : : bool
1774 : 2420 : 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 [ + + + - : 2471 : TAILQ_FOREACH(listener, &subsystem->listeners, link) {
+ - + - #
# # # #
# ]
1780 [ + + + - : 2467 : if (spdk_nvme_transport_id_compare(listener->trid, trid) == 0) {
- + ]
1781 : 2416 : return true;
1782 : : }
1783 : 0 : }
1784 : :
1785 [ - + + - : 4 : if (!strcmp(subsystem->subnqn, SPDK_NVMF_DISCOVERY_NQN)) {
# # # # ]
1786 [ # # # # : 4 : 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 : 4 : return true;
1792 : : }
1793 : :
1794 : 0 : return false;
1795 : 1693 : }
1796 : :
1797 : : struct spdk_nvmf_subsystem_listener *
1798 : 1324 : spdk_nvmf_subsystem_get_first_listener(struct spdk_nvmf_subsystem *subsystem)
1799 : : {
1800 [ + - + - : 1324 : return TAILQ_FIRST(&subsystem->listeners);
+ - ]
1801 : : }
1802 : :
1803 : : struct spdk_nvmf_subsystem_listener *
1804 : 1084 : spdk_nvmf_subsystem_get_next_listener(struct spdk_nvmf_subsystem *subsystem,
1805 : : struct spdk_nvmf_subsystem_listener *prev_listener)
1806 : : {
1807 [ + - + - : 1084 : return TAILQ_NEXT(prev_listener, link);
+ - ]
1808 : : }
1809 : :
1810 : : const struct spdk_nvme_transport_id *
1811 : 259 : spdk_nvmf_subsystem_listener_get_trid(struct spdk_nvmf_subsystem_listener *listener)
1812 : : {
1813 [ + - + - ]: 259 : 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 : 313 : nvmf_subsystem_ns_changed(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
1887 : : {
1888 : : struct spdk_nvmf_ctrlr *ctrlr;
1889 : :
1890 [ + + + - : 347 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
+ - + - #
# # # #
# ]
1891 [ + + ]: 34 : if (nvmf_ctrlr_ns_is_visible(ctrlr, nsid)) {
1892 : 30 : nvmf_ctrlr_ns_changed(ctrlr, nsid);
1893 : 3 : }
1894 : 4 : }
1895 : 313 : }
1896 : :
1897 : : static uint32_t nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns);
1898 : :
1899 : : int
1900 : 156 : 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 [ + + + - : 156 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
- + # # ]
1908 [ - + # # ]: 31 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
1909 [ # # ]: 0 : assert(false);
1910 : : return -1;
1911 : : }
1912 : :
1913 [ + - + + : 156 : if (nsid == 0 || nsid > subsystem->max_nsid) {
+ - - + ]
1914 : 0 : return -1;
1915 : : }
1916 : :
1917 [ + - + - : 156 : ns = subsystem->ns[nsid - 1];
+ - + - ]
1918 [ + + ]: 156 : if (!ns) {
1919 : 0 : return -1;
1920 : : }
1921 : :
1922 [ + - + - : 156 : subsystem->ns[nsid - 1] = NULL;
+ - + - ]
1923 : :
1924 [ + + + - : 156 : assert(ns->anagrpid - 1 < subsystem->max_nsid);
+ - + - +
- # # ]
1925 [ + + + - : 156 : assert(subsystem->ana_group[ns->anagrpid - 1] > 0);
+ - + - +
- + - + -
# # ]
1926 : :
1927 [ + - + - : 156 : subsystem->ana_group[ns->anagrpid - 1]--;
+ - + - +
- ]
1928 : :
1929 [ + + + + : 160 : TAILQ_FOREACH_SAFE(host, &ns->hosts, link, tmp) {
+ - - + #
# # # # #
- + ]
1930 : 4 : nvmf_ns_remove_host(ns, host);
1931 : 1 : }
1932 : :
1933 [ + - + - ]: 156 : free(ns->ptpl_file);
1934 : 156 : nvmf_ns_reservation_clear_all_registrants(ns);
1935 [ + - + - ]: 156 : spdk_bdev_module_release_bdev(ns->bdev);
1936 [ + - + - ]: 156 : spdk_bdev_close(ns->desc);
1937 : 156 : free(ns);
1938 : :
1939 [ + + + + : 156 : if (subsystem->fdp_supported && !spdk_nvmf_subsystem_get_first_ns(subsystem)) {
+ - - + #
# ]
1940 [ # # # # ]: 4 : subsystem->fdp_supported = false;
1941 [ + + - + : 4 : SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u doesn't have FDP capability.\n",
# # # # #
# ]
1942 : : subsystem->id);
1943 : 1 : }
1944 : :
1945 [ + + + - : 292 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
+ + ]
1946 : 136 : transport = spdk_nvmf_transport_get_next(transport)) {
1947 [ + + + - : 136 : if (transport->ops->subsystem_remove_ns) {
+ - + - +
- ]
1948 [ # # # # : 0 : transport->ops->subsystem_remove_ns(transport, subsystem, nsid);
# # # # #
# # # ]
1949 : 0 : }
1950 : 39 : }
1951 : :
1952 : 156 : nvmf_subsystem_ns_changed(subsystem, nsid);
1953 : :
1954 [ + + + - : 180 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
+ - - + #
# # # #
# ]
1955 : 24 : nvmf_ctrlr_ns_set_visible(ctrlr, nsid, false);
1956 : 3 : }
1957 : :
1958 : 156 : return 0;
1959 : 44 : }
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 : 11 : _nvmf_ns_hot_remove(struct spdk_nvmf_subsystem *subsystem,
1969 : : void *cb_arg, int status)
1970 : : {
1971 : 11 : struct subsystem_ns_change_ctx *ctx = cb_arg;
1972 : : int rc;
1973 : :
1974 [ # # # # ]: 11 : rc = spdk_nvmf_subsystem_remove_ns(subsystem, ctx->nsid);
1975 [ - + ]: 11 : 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 : 11 : rc = spdk_nvmf_subsystem_resume(subsystem, NULL, NULL);
1980 [ - + ]: 11 : if (rc != 0) {
1981 [ # # # # ]: 0 : SPDK_ERRLOG("Failed to resume NVME-oF subsystem with id: %u\n", subsystem->id);
1982 : 0 : }
1983 : :
1984 : 11 : free(ctx);
1985 : 11 : }
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 : 0 : 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 : 11 : nvmf_ns_hot_remove(void *remove_ctx)
2009 : : {
2010 : 11 : 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 : 11 : ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
2018 [ + + ]: 11 : if (!ns_ctx) {
2019 : 0 : SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
2020 : 0 : return;
2021 : : }
2022 : :
2023 [ # # # # : 11 : ns_ctx->subsystem = ns->subsystem;
# # # # ]
2024 [ # # # # : 11 : ns_ctx->nsid = ns->opts.nsid;
# # # # #
# ]
2025 [ # # # # ]: 11 : ns_ctx->cb_fn = _nvmf_ns_hot_remove;
2026 : :
2027 [ # # # # : 11 : rc = spdk_nvmf_subsystem_pause(ns->subsystem, ns_ctx->nsid, _nvmf_ns_hot_remove, ns_ctx);
# # # # ]
2028 [ + + ]: 11 : 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 : 5 : _nvmf_ns_resize(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status)
2041 : : {
2042 : 5 : struct subsystem_ns_change_ctx *ctx = cb_arg;
2043 : :
2044 [ # # # # ]: 5 : nvmf_subsystem_ns_changed(subsystem, ctx->nsid);
2045 [ - + ]: 5 : 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 : 5 : free(ctx);
2050 : 5 : }
2051 : :
2052 : : static void
2053 : 5 : nvmf_ns_resize(void *event_ctx)
2054 : : {
2055 : 5 : 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 : 5 : ns_ctx = calloc(1, sizeof(struct subsystem_ns_change_ctx));
2063 [ + + ]: 5 : if (!ns_ctx) {
2064 : 0 : SPDK_ERRLOG("Unable to allocate context to process namespace removal!\n");
2065 : 0 : return;
2066 : : }
2067 : :
2068 [ # # # # : 5 : ns_ctx->subsystem = ns->subsystem;
# # # # ]
2069 [ # # # # : 5 : ns_ctx->nsid = ns->opts.nsid;
# # # # #
# ]
2070 [ # # # # ]: 5 : 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 [ # # # # ]: 5 : rc = spdk_nvmf_subsystem_pause(ns->subsystem, 0, _nvmf_ns_resize, ns_ctx);
2076 [ + + ]: 5 : 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 : 16 : nvmf_ns_event(enum spdk_bdev_event_type type,
2089 : : struct spdk_bdev *bdev,
2090 : : void *event_ctx)
2091 : : {
2092 [ + + - + : 16 : 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 [ + + + ]: 16 : switch (type) {
2099 : 10 : case SPDK_BDEV_EVENT_REMOVE:
2100 : 11 : nvmf_ns_hot_remove(event_ctx);
2101 : 11 : break;
2102 : 4 : case SPDK_BDEV_EVENT_RESIZE:
2103 : 5 : nvmf_ns_resize(event_ctx);
2104 : 5 : break;
2105 : 0 : default:
2106 : 0 : SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type);
2107 : 0 : break;
2108 : : }
2109 : 16 : }
2110 : :
2111 : : void
2112 : 1260 : spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size)
2113 : : {
2114 [ + + ]: 1260 : if (!opts) {
2115 : 0 : SPDK_ERRLOG("opts should not be NULL.\n");
2116 : 0 : return;
2117 : : }
2118 : :
2119 [ + + ]: 1260 : if (!opts_size) {
2120 : 0 : SPDK_ERRLOG("opts_size should not be zero.\n");
2121 : 0 : return;
2122 : : }
2123 : :
2124 [ + + ]: 1260 : memset(opts, 0, opts_size);
2125 [ + - + - ]: 1260 : 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 [ + + + - : 1260 : SET_FIELD(nsid, 0);
+ - ]
2137 [ + + ]: 1260 : if (FIELD_OK(nguid)) {
2138 [ + + + - ]: 1260 : memset(opts->nguid, 0, sizeof(opts->nguid));
2139 : 91 : }
2140 [ + + ]: 1260 : if (FIELD_OK(eui64)) {
2141 [ + + + - ]: 1260 : memset(opts->eui64, 0, sizeof(opts->eui64));
2142 : 91 : }
2143 [ + + ]: 1260 : if (FIELD_OK(uuid)) {
2144 [ + - ]: 1260 : spdk_uuid_set_null(&opts->uuid);
2145 : 91 : }
2146 [ + + + - : 1260 : SET_FIELD(anagrpid, 0);
+ - ]
2147 [ + + + - : 1260 : SET_FIELD(transport_specific, NULL);
+ - ]
2148 [ + + + - : 1260 : SET_FIELD(hide_metadata, false);
+ - ]
2149 : :
2150 : : #undef FIELD_OK
2151 : : #undef SET_FIELD
2152 : 91 : }
2153 : :
2154 : : static void
2155 : 628 : 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 [ + + + - : 628 : SET_FIELD(nsid);
- + + - +
- + - +
- ]
2168 [ + + + - : 628 : if (FIELD_OK(nguid)) {
- + ]
2169 [ + - + - : 628 : memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid));
+ - + - ]
2170 : 45 : }
2171 [ + + + - : 628 : if (FIELD_OK(eui64)) {
- + ]
2172 [ + - + - : 628 : memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64));
+ - + - ]
2173 : 45 : }
2174 [ + + + - : 628 : if (FIELD_OK(uuid)) {
- + ]
2175 [ + - + - ]: 628 : spdk_uuid_copy(&opts->uuid, &user_opts->uuid);
2176 : 45 : }
2177 [ + + + - : 628 : SET_FIELD(anagrpid);
- + + - +
- + - +
- ]
2178 [ + + + + : 628 : SET_FIELD(no_auto_visible);
- + + - +
- + - + -
+ - ]
2179 [ + + + - : 628 : SET_FIELD(transport_specific);
- + + - +
- + - +
- ]
2180 [ + + + + : 628 : SET_FIELD(hide_metadata);
- + + - +
- + - + -
+ - ]
2181 : :
2182 [ + - + - : 628 : 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 : 628 : }
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 : 94 : nvmf_subsystem_zone_append_supported(struct spdk_nvmf_subsystem *subsystem)
2207 : : {
2208 : : struct spdk_nvmf_ns *ns;
2209 : :
2210 [ # # ]: 94 : for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
2211 [ + + ]: 113 : ns != NULL;
2212 : 19 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
2213 [ - + - - : 19 : 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 : 94 : return false;
2220 : 0 : }
2221 : :
2222 : : uint32_t
2223 : 632 : 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 : 54 : struct spdk_nvmf_ns_opts opts;
2229 : 632 : struct spdk_bdev_open_opts open_opts = {};
2230 : : struct spdk_nvmf_ns *ns, *first_ns;
2231 : : struct spdk_nvmf_ctrlr *ctrlr;
2232 : 632 : 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 [ + + + - : 671 : if (!(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
+ - + - ]
2238 [ + + + - ]: 604 : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED)) {
2239 : 0 : return 0;
2240 : : }
2241 : :
2242 : 632 : spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts));
2243 [ + + ]: 632 : if (user_opts) {
2244 : 628 : nvmf_ns_opts_copy(&opts, user_opts, opts_size);
2245 : 45 : }
2246 : :
2247 [ + + ]: 632 : if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) {
2248 : 4 : SPDK_ERRLOG("Invalid NSID %" PRIu32 "\n", opts.nsid);
2249 : 4 : return 0;
2250 : : }
2251 : :
2252 [ + + ]: 628 : 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 [ + + # # : 100 : for (opts.nsid = 1; opts.nsid <= subsystem->max_nsid; opts.nsid++) {
# # ]
2259 [ + + ]: 100 : if (_nvmf_subsystem_get_ns(subsystem, opts.nsid) == NULL) {
2260 : 85 : break;
2261 : : }
2262 : 0 : }
2263 [ - + # # : 85 : 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 [ + + + - : 628 : if (opts.nsid > subsystem->max_nsid) {
- + ]
2270 : 0 : SPDK_ERRLOG("NSID greater than maximum not allowed\n");
2271 : 0 : return 0;
2272 : : }
2273 : :
2274 [ + + ]: 628 : if (_nvmf_subsystem_get_ns(subsystem, opts.nsid)) {
2275 : 471 : SPDK_ERRLOG("Requested NSID %" PRIu32 " already in use\n", opts.nsid);
2276 : 471 : return 0;
2277 : : }
2278 : :
2279 [ + + ]: 157 : if (opts.anagrpid == 0) {
2280 : 157 : opts.anagrpid = opts.nsid;
2281 : 44 : }
2282 : :
2283 [ + + + - : 157 : 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 : 157 : ns = calloc(1, sizeof(*ns));
2289 [ + + ]: 157 : if (ns == NULL) {
2290 : 0 : SPDK_ERRLOG("Namespace allocation failed\n");
2291 : 0 : return 0;
2292 : : }
2293 : :
2294 [ + - + - : 157 : TAILQ_INIT(&ns->hosts);
+ - + - +
- + - + -
+ - ]
2295 [ + + + - : 157 : ns->always_visible = !opts.no_auto_visible;
+ - ]
2296 [ + + + - : 162 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
+ - - + #
# # # #
# ]
2297 [ - + # # : 5 : nvmf_ctrlr_ns_set_visible(ctrlr, opts.nsid, ns->always_visible);
# # ]
2298 : 0 : }
2299 : :
2300 : 157 : spdk_bdev_open_opts_init(&open_opts, sizeof(open_opts));
2301 [ + + + - ]: 157 : open_opts.hide_metadata = opts.hide_metadata;
2302 : :
2303 [ + - ]: 157 : rc = spdk_bdev_open_ext_v2(bdev_name, true, nvmf_ns_event, ns, &open_opts, &ns->desc);
2304 [ + + ]: 157 : if (rc != 0) {
2305 [ # # ]: 1 : SPDK_ERRLOG("Subsystem %s: bdev %s cannot be opened, error=%d\n",
2306 : : subsystem->subnqn, bdev_name, rc);
2307 : 1 : free(ns);
2308 : 1 : return 0;
2309 : : }
2310 : :
2311 [ + - + - : 156 : ns->bdev = spdk_bdev_desc_get_bdev(ns->desc);
+ - + - ]
2312 : :
2313 [ + + + - : 156 : if (spdk_bdev_desc_get_md_size(ns->desc) != 0) {
+ - ]
2314 [ - + # # : 10 : 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 [ - + # # : 10 : 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 [ + - + - : 156 : rc = spdk_bdev_module_claim_bdev(ns->bdev, ns->desc, &ns_bdev_module);
+ - + - ]
2332 [ - + ]: 156 : if (rc != 0) {
2333 [ # # # # ]: 0 : spdk_bdev_close(ns->desc);
2334 : 0 : free(ns);
2335 : 0 : return 0;
2336 : : }
2337 : :
2338 [ + - + - : 156 : ns->passthru_nsid = spdk_bdev_get_nvme_nsid(ns->bdev);
+ - + - ]
2339 [ + + + + : 156 : 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 [ + - + - : 156 : ns->zcopy = spdk_bdev_io_type_supported(ns->bdev, SPDK_BDEV_IO_TYPE_ZCOPY);
+ - + - ]
2346 : :
2347 [ + + ]: 156 : if (spdk_uuid_is_null(&opts.uuid)) {
2348 [ # # # # ]: 93 : 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 [ + + ]: 156 : if (spdk_mem_all_zero(opts.nguid, sizeof(opts.nguid))) {
2353 : : SPDK_STATIC_ASSERT(sizeof(opts.nguid) == sizeof(opts.uuid), "size mismatch");
2354 [ # # # # : 97 : memcpy(opts.nguid, spdk_bdev_get_uuid(ns->bdev), sizeof(opts.nguid));
# # # # ]
2355 : 5 : }
2356 : :
2357 [ + + + - : 156 : 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 : 156 : first_ns = spdk_nvmf_subsystem_get_first_ns(subsystem);
2377 [ + + ]: 156 : if (!first_ns) {
2378 [ + + + - : 136 : if (spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
+ - ]
2379 [ + + - + : 4 : SPDK_DEBUGLOG(nvmf, "Subsystem with id: %u has FDP capability.\n",
# # # # #
# ]
2380 : : subsystem->id);
2381 [ # # # # ]: 4 : subsystem->fdp_supported = true;
2382 : 1 : }
2383 : 43 : } else {
2384 [ + - + - : 21 : if (spdk_bdev_get_nvme_ctratt(first_ns->bdev).bits.fdps !=
# # ]
2385 [ + + # # ]: 20 : spdk_bdev_get_nvme_ctratt(ns->bdev).bits.fdps) {
2386 [ + - # # : 4 : 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 : 4 : goto err;
2389 : : }
2390 : : }
2391 : :
2392 [ + - ]: 152 : ns->opts = opts;
2393 [ + - + - ]: 152 : ns->subsystem = subsystem;
2394 [ + - + - : 152 : subsystem->ns[opts.nsid - 1] = ns;
+ - + - ]
2395 [ + - + - ]: 152 : ns->nsid = opts.nsid;
2396 [ + - + - ]: 152 : ns->anagrpid = opts.anagrpid;
2397 [ + - + - : 152 : subsystem->ana_group[ns->anagrpid - 1]++;
+ - + - +
- ]
2398 [ + - + - : 152 : TAILQ_INIT(&ns->registrants);
+ - + - +
- + - + -
+ - ]
2399 [ + + ]: 152 : 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 [ + + ]: 152 : if (nvmf_ns_is_ptpl_capable(ns)) {
2408 : 4 : rc = nvmf_ns_reservation_load(ns, &info);
2409 [ - + ]: 4 : if (rc) {
2410 : 0 : SPDK_ERRLOG("Subsystem load reservation failed\n");
2411 : 0 : goto err;
2412 : : }
2413 : :
2414 : 4 : rc = nvmf_ns_reservation_restore(ns, &info);
2415 [ + + ]: 4 : if (rc) {
2416 : 0 : SPDK_ERRLOG("Subsystem restore reservation failed\n");
2417 : 0 : goto err;
2418 : : }
2419 : 1 : }
2420 : :
2421 [ + + + - : 288 : for (transport = spdk_nvmf_transport_get_first(subsystem->tgt); transport;
+ + ]
2422 : 136 : transport = spdk_nvmf_transport_get_next(transport)) {
2423 [ + + + - : 136 : 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 : 39 : }
2432 : :
2433 : : /* JSON value obj is freed before sending the response. Set NULL to prevent usage of dangling pointer. */
2434 [ + - + - : 152 : ns->opts.transport_specific = NULL;
+ - ]
2435 : :
2436 [ + + + + : 152 : 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 : 152 : nvmf_subsystem_ns_changed(subsystem, opts.nsid);
2442 : :
2443 : 62 : SPDK_DTRACE_PROBE2(nvmf_subsystem_add_ns, subsystem->subnqn, ns->nsid);
2444 : :
2445 : 152 : return opts.nsid;
2446 : 3 : err:
2447 [ # # # # : 4 : subsystem->ns[opts.nsid - 1] = NULL;
# # # # ]
2448 [ # # # # ]: 4 : spdk_bdev_module_release_bdev(ns->bdev);
2449 [ # # # # ]: 4 : spdk_bdev_close(ns->desc);
2450 [ # # # # ]: 4 : free(ns->ptpl_file);
2451 : 4 : free(ns);
2452 : :
2453 : 4 : return 0;
2454 : 46 : }
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 : 10229 : nvmf_subsystem_get_next_allocated_nsid(struct spdk_nvmf_subsystem *subsystem,
2499 : : uint32_t prev_nsid)
2500 : : {
2501 : : uint32_t nsid;
2502 : :
2503 [ + + + - : 10229 : if (prev_nsid >= subsystem->max_nsid) {
+ + ]
2504 : 661 : return 0;
2505 : : }
2506 : :
2507 [ + + + - : 186176 : for (nsid = prev_nsid + 1; nsid <= subsystem->max_nsid; nsid++) {
+ + ]
2508 [ + + + - : 180922 : if (subsystem->ns[nsid - 1]) {
+ - + - +
+ ]
2509 : 4314 : return nsid;
2510 : : }
2511 : 109646 : }
2512 : :
2513 : 5254 : return 0;
2514 : 6831 : }
2515 : :
2516 : : struct spdk_nvmf_ns *
2517 : 5988 : spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem)
2518 : : {
2519 : : uint32_t first_nsid;
2520 : :
2521 : 5988 : first_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, 0);
2522 : 5988 : return _nvmf_subsystem_get_ns(subsystem, first_nsid);
2523 : : }
2524 : :
2525 : : struct spdk_nvmf_ns *
2526 : 4241 : 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 [ + - + - : 4241 : next_nsid = nvmf_subsystem_get_next_allocated_nsid(subsystem, prev_ns->opts.nsid);
+ - ]
2532 : 4241 : 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 : 107 : spdk_nvmf_ns_get_id(const struct spdk_nvmf_ns *ns)
2543 : : {
2544 [ # # # # : 107 : return ns->opts.nsid;
# # ]
2545 : : }
2546 : :
2547 : : struct spdk_bdev *
2548 : 203 : spdk_nvmf_ns_get_bdev(struct spdk_nvmf_ns *ns)
2549 : : {
2550 [ # # # # ]: 203 : return ns->bdev;
2551 : : }
2552 : :
2553 : : void
2554 : 107 : spdk_nvmf_ns_get_opts(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_ns_opts *opts,
2555 : : size_t opts_size)
2556 : : {
2557 [ - + ]: 107 : memset(opts, 0, opts_size);
2558 [ - + - + : 107 : memcpy(opts, &ns->opts, spdk_min(sizeof(ns->opts), opts_size));
# # # # ]
2559 : 107 : }
2560 : :
2561 : : const char *
2562 : 1277 : spdk_nvmf_subsystem_get_sn(const struct spdk_nvmf_subsystem *subsystem)
2563 : : {
2564 [ + - ]: 1277 : return subsystem->sn;
2565 : : }
2566 : :
2567 : : int
2568 : 103 : spdk_nvmf_subsystem_set_sn(struct spdk_nvmf_subsystem *subsystem, const char *sn)
2569 : : {
2570 : : size_t len, max_len;
2571 : :
2572 : 103 : max_len = sizeof(subsystem->sn) - 1;
2573 [ + + ]: 103 : len = strlen(sn);
2574 [ + + ]: 103 : if (len > max_len) {
2575 [ + + - + : 4 : SPDK_DEBUGLOG(nvmf, "Invalid sn \"%s\": length %zu > max %zu\n",
# # ]
2576 : : sn, len, max_len);
2577 : 4 : return -1;
2578 : : }
2579 : :
2580 [ + + ]: 99 : if (!nvmf_valid_ascii_string(sn, len)) {
2581 [ + + - + : 4 : SPDK_DEBUGLOG(nvmf, "Non-ASCII sn\n");
# # ]
2582 [ + + - + : 4 : SPDK_LOGDUMP(nvmf, "sn", sn, len);
# # ]
2583 : 4 : return -1;
2584 : : }
2585 : :
2586 [ + - ]: 95 : snprintf(subsystem->sn, sizeof(subsystem->sn), "%s", sn);
2587 : :
2588 : 95 : return 0;
2589 : 43 : }
2590 : :
2591 : : const char *
2592 : 1277 : spdk_nvmf_subsystem_get_mn(const struct spdk_nvmf_subsystem *subsystem)
2593 : : {
2594 [ + - ]: 1277 : return subsystem->mn;
2595 : : }
2596 : :
2597 : : int
2598 : 45 : spdk_nvmf_subsystem_set_mn(struct spdk_nvmf_subsystem *subsystem, const char *mn)
2599 : : {
2600 : : size_t len, max_len;
2601 : :
2602 [ + + ]: 45 : if (mn == NULL) {
2603 : 0 : mn = MODEL_NUMBER_DEFAULT;
2604 : 0 : }
2605 : 45 : max_len = sizeof(subsystem->mn) - 1;
2606 [ + + ]: 45 : len = strlen(mn);
2607 [ - + ]: 45 : 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 [ + + ]: 45 : 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 [ + - ]: 45 : snprintf(subsystem->mn, sizeof(subsystem->mn), "%s", mn);
2620 : :
2621 : 45 : return 0;
2622 : 39 : }
2623 : :
2624 : : const char *
2625 : 2830 : spdk_nvmf_subsystem_get_nqn(const struct spdk_nvmf_subsystem *subsystem)
2626 : : {
2627 [ + - ]: 2830 : 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 : 609 : spdk_nvmf_subsystem_get_type(struct spdk_nvmf_subsystem *subsystem)
2641 : : {
2642 [ + - + - ]: 609 : 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 : 122 : spdk_nvmf_subsystem_set_cntlid_range(struct spdk_nvmf_subsystem *subsystem,
2653 : : uint16_t min_cntlid, uint16_t max_cntlid)
2654 : : {
2655 [ + + + - : 122 : if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
- + ]
2656 : 0 : return -EAGAIN;
2657 : : }
2658 : :
2659 [ - + ]: 122 : if (min_cntlid > max_cntlid) {
2660 : 0 : return -EINVAL;
2661 : : }
2662 : : /* The spec reserves cntlid values in the range FFF0h to FFFFh. */
2663 [ + - + - : 161 : if (min_cntlid < NVMF_MIN_CNTLID || min_cntlid > NVMF_MAX_CNTLID ||
+ + ]
2664 [ + + ]: 122 : max_cntlid < NVMF_MIN_CNTLID || max_cntlid > NVMF_MAX_CNTLID) {
2665 : 0 : return -EINVAL;
2666 : : }
2667 [ + - + - ]: 122 : subsystem->min_cntlid = min_cntlid;
2668 [ + - + - ]: 122 : subsystem->max_cntlid = max_cntlid;
2669 [ + - + + : 122 : if (subsystem->next_cntlid < min_cntlid || subsystem->next_cntlid > max_cntlid) {
+ - + - +
- - + ]
2670 [ # # # # ]: 0 : subsystem->next_cntlid = min_cntlid;
2671 : 0 : }
2672 : :
2673 : 122 : return 0;
2674 : 39 : }
2675 : :
2676 : : uint16_t
2677 : 1227 : 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 [ + - + - : 1227 : for (count = 0; count < subsystem->max_cntlid - subsystem->min_cntlid + 1; count++) {
+ - + - +
- + - #
# ]
2687 [ + - + - ]: 1227 : cntlid = subsystem->next_cntlid;
2688 [ + - ]: 1227 : subsystem->next_cntlid++;
2689 : :
2690 [ + + + - : 1227 : 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 [ + - ]: 1227 : if (nvmf_subsystem_get_ctrlr(subsystem, cntlid) == NULL) {
2696 : : /* Found unused cntlid */
2697 : 1227 : return cntlid;
2698 : : }
2699 : 0 : }
2700 : :
2701 : : /* All valid cntlid values are in use. */
2702 : 0 : return 0xFFFF;
2703 : 886 : }
2704 : :
2705 : : int
2706 : 1227 : nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ctrlr *ctrlr)
2707 : : {
2708 : :
2709 [ + + + + : 1227 : if (ctrlr->dynamic_ctrlr) {
+ - + + ]
2710 [ + - + - ]: 1131 : ctrlr->cntlid = nvmf_subsystem_gen_cntlid(subsystem);
2711 [ + + + - : 1131 : 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 [ + + + - : 898 : } 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 [ + - + - : 1227 : TAILQ_INSERT_TAIL(&subsystem->ctrlrs, ctrlr, link);
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - ]
2722 : :
2723 : 278 : SPDK_DTRACE_PROBE3(nvmf_subsystem_add_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
2724 : :
2725 : 1227 : return 0;
2726 : 886 : }
2727 : :
2728 : : void
2729 : 1227 : nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem,
2730 : : struct spdk_nvmf_ctrlr *ctrlr)
2731 : : {
2732 : 278 : SPDK_DTRACE_PROBE3(nvmf_subsystem_remove_ctrlr, subsystem->subnqn, ctrlr, ctrlr->hostnqn);
2733 : :
2734 [ + + + - : 1227 : assert(spdk_get_thread() == subsystem->thread);
+ - # # ]
2735 [ + + + - : 1227 : assert(subsystem == ctrlr->subsys);
+ - # # ]
2736 [ + + + + : 1227 : SPDK_DEBUGLOG(nvmf, "remove ctrlr %p id 0x%x from subsys %p %s\n", ctrlr, ctrlr->cntlid, subsystem,
+ - # # #
# # # ]
2737 : : subsystem->subnqn);
2738 [ + + + - : 1227 : TAILQ_REMOVE(&subsystem->ctrlrs, ctrlr, link);
+ - - + #
# # # # #
# # # # #
# # # # #
# # + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - ]
2739 : 1227 : }
2740 : :
2741 : : struct spdk_nvmf_ctrlr *
2742 : 5068 : nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem, uint16_t cntlid)
2743 : : {
2744 : : struct spdk_nvmf_ctrlr *ctrlr;
2745 : :
2746 [ + + + - : 5136 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
+ - + + #
# # # #
# ]
2747 [ + + + - : 3813 : if (ctrlr->cntlid == cntlid) {
- + ]
2748 : 3745 : return ctrlr;
2749 : : }
2750 : 0 : }
2751 : :
2752 : 1323 : return NULL;
2753 : 3879 : }
2754 : :
2755 : : uint32_t
2756 : 166 : spdk_nvmf_subsystem_get_max_namespaces(const struct spdk_nvmf_subsystem *subsystem)
2757 : : {
2758 [ # # # # ]: 166 : return subsystem->max_nsid;
2759 : : }
2760 : :
2761 : : uint16_t
2762 : 166 : spdk_nvmf_subsystem_get_min_cntlid(const struct spdk_nvmf_subsystem *subsystem)
2763 : : {
2764 [ # # # # ]: 166 : return subsystem->min_cntlid;
2765 : : }
2766 : :
2767 : : uint16_t
2768 : 166 : spdk_nvmf_subsystem_get_max_cntlid(const struct spdk_nvmf_subsystem *subsystem)
2769 : : {
2770 [ # # # # ]: 166 : 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 : 16 : nvmf_decode_ns_pr_reg(const struct spdk_json_val *val, void *out)
2799 : : {
2800 : 16 : struct _nvmf_ns_registrant *reg = out;
2801 : :
2802 : 20 : 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 : 16 : nvmf_decode_ns_pr_regs(const struct spdk_json_val *val, void *out)
2808 : : {
2809 : 16 : struct _nvmf_ns_registrants *regs = out;
2810 : :
2811 [ # # ]: 20 : 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 : 20 : nvmf_ns_reservation_load_json(const struct spdk_nvmf_ns *ns,
2827 : : struct spdk_nvmf_reservation_info *info)
2828 : : {
2829 : 15 : size_t json_size;
2830 : : ssize_t values_cnt, rc;
2831 : 20 : void *json = NULL, *end;
2832 : 20 : struct spdk_json_val *values = NULL;
2833 : 20 : struct _nvmf_ns_reservation res = {};
2834 [ # # # # ]: 20 : const char *file = ns->ptpl_file;
2835 : : uint32_t i;
2836 : :
2837 : : /* It's not an error if the file does not exist */
2838 [ - + - + ]: 20 : 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 : 20 : json = spdk_posix_file_load_from_name(file, &json_size);
2845 [ - + ]: 20 : if (!json) {
2846 : 0 : SPDK_ERRLOG("Load persist file %s failed\n", file);
2847 : 0 : return -ENOMEM;
2848 : : }
2849 : :
2850 : 20 : rc = spdk_json_parse(json, json_size, NULL, 0, &end, 0);
2851 [ + + ]: 20 : if (rc < 0) {
2852 : 4 : SPDK_NOTICELOG("Parsing JSON configuration failed (%zd)\n", rc);
2853 : 4 : goto exit;
2854 : : }
2855 : :
2856 : 16 : values_cnt = rc;
2857 : 16 : values = calloc(values_cnt, sizeof(struct spdk_json_val));
2858 [ + + ]: 16 : if (values == NULL) {
2859 : 0 : goto exit;
2860 : : }
2861 : :
2862 : 16 : rc = spdk_json_parse(json, json_size, values, values_cnt, &end, 0);
2863 [ - + ]: 16 : 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 [ - + ]: 16 : 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 [ - + # # : 16 : 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 : 16 : rc = 0;
2884 [ - + # # : 16 : info->ptpl_activated = res.ptpl_activated;
# # ]
2885 [ # # # # : 16 : info->rtype = res.rtype;
# # ]
2886 [ # # # # : 16 : info->crkey = res.crkey;
# # ]
2887 [ - + # # ]: 16 : snprintf(info->bdev_uuid, sizeof(info->bdev_uuid), "%s", res.bdev_uuid);
2888 [ - + # # ]: 16 : snprintf(info->holder_uuid, sizeof(info->holder_uuid), "%s", res.holder_uuid);
2889 [ # # # # : 16 : info->num_regs = res.regs.num_regs;
# # # # ]
2890 [ + + # # : 32 : for (i = 0; i < res.regs.num_regs; i++) {
# # ]
2891 [ # # # # : 16 : info->registrants[i].rkey = res.regs.reg[i].rkey;
# # # # #
# # # # #
# # ]
2892 [ - + # # : 20 : snprintf(info->registrants[i].host_uuid, sizeof(info->registrants[i].host_uuid), "%s",
# # ]
2893 [ # # # # : 12 : res.regs.reg[i].host_uuid);
# # # # ]
2894 : 8 : }
2895 : :
2896 : 15 : exit:
2897 : 20 : free(json);
2898 : 20 : free(values);
2899 [ # # ]: 20 : free(res.bdev_uuid);
2900 [ # # ]: 20 : free(res.holder_uuid);
2901 [ + + # # : 36 : for (i = 0; i < res.regs.num_regs; i++) {
# # ]
2902 [ # # # # : 16 : free(res.regs.reg[i].host_uuid);
# # # # ]
2903 : 4 : }
2904 : :
2905 : 20 : return rc;
2906 : 5 : }
2907 : :
2908 : : static bool nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns);
2909 : :
2910 : : static int
2911 : 20 : nvmf_ns_reservation_restore(struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
2912 : : {
2913 : : uint32_t i;
2914 : 20 : struct spdk_nvmf_registrant *reg, *holder = NULL;
2915 : 15 : struct spdk_uuid bdev_uuid, holder_uuid;
2916 : 20 : bool rkey_flag = false;
2917 : :
2918 [ + + - + : 20 : 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 [ + - - + : 20 : 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 [ + + # # : 56 : for (i = 0; i < info->num_regs; i++) {
# # ]
2928 [ + + # # : 36 : if (info->crkey == info->registrants[i].rkey) {
# # # # #
# # # #
# ]
2929 : 12 : rkey_flag = true;
2930 : 3 : }
2931 : 9 : }
2932 [ + + + + : 20 : if (!rkey_flag && info->crkey != 0) {
# # # # #
# ]
2933 : 4 : return -EINVAL;
2934 : : }
2935 : :
2936 [ # # ]: 16 : spdk_uuid_parse(&bdev_uuid, info->bdev_uuid);
2937 [ + + # # : 16 : if (spdk_uuid_compare(&bdev_uuid, spdk_bdev_get_uuid(ns->bdev))) {
# # ]
2938 : 4 : SPDK_ERRLOG("Existing bdev UUID is not same with configuration file\n");
2939 : 4 : return -EINVAL;
2940 : : }
2941 : :
2942 [ # # # # : 12 : ns->crkey = info->crkey;
# # # # ]
2943 [ # # # # : 12 : ns->rtype = info->rtype;
# # # # ]
2944 [ # # # # : 12 : ns->ptpl_activated = info->ptpl_activated;
# # # # ]
2945 [ # # ]: 12 : spdk_uuid_parse(&holder_uuid, info->holder_uuid);
2946 : :
2947 [ + + - + : 12 : SPDK_DEBUGLOG(nvmf, "Bdev UUID %s\n", info->bdev_uuid);
# # # # ]
2948 [ + + # # : 12 : if (info->rtype) {
# # ]
2949 [ + + - + : 8 : SPDK_DEBUGLOG(nvmf, "Holder UUID %s, RTYPE %u, RKEY 0x%"PRIx64"\n",
# # # # #
# # # # #
# # ]
2950 : : info->holder_uuid, info->rtype, info->crkey);
2951 : 2 : }
2952 : :
2953 [ + + # # : 32 : for (i = 0; i < info->num_regs; i++) {
# # ]
2954 : 20 : reg = calloc(1, sizeof(*reg));
2955 [ + + ]: 20 : if (!reg) {
2956 : 0 : return -ENOMEM;
2957 : : }
2958 [ # # # # : 20 : spdk_uuid_parse(®->hostid, info->registrants[i].host_uuid);
# # # # ]
2959 [ # # # # : 20 : reg->rkey = info->registrants[i].rkey;
# # # # #
# # # ]
2960 [ # # # # : 20 : TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
2961 [ + + + + : 20 : if (info->crkey != 0 && !spdk_uuid_compare(&holder_uuid, ®->hostid)) {
# # # # #
# ]
2962 : 8 : holder = reg;
2963 : 2 : }
2964 [ + + - + : 20 : 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 [ + + ]: 12 : if (nvmf_ns_reservation_all_registrants_type(ns)) {
2969 [ # # # # : 4 : ns->holder = TAILQ_FIRST(&ns->registrants);
# # # # #
# ]
2970 : 1 : } else {
2971 [ # # # # ]: 8 : ns->holder = holder;
2972 : : }
2973 : :
2974 : 12 : return 0;
2975 : 5 : }
2976 : :
2977 : : static int
2978 : 20 : nvmf_ns_json_write_cb(void *cb_ctx, const void *data, size_t size)
2979 : : {
2980 : 20 : char *file = cb_ctx;
2981 : : size_t rc;
2982 : : FILE *fd;
2983 : :
2984 : 20 : fd = fopen(file, "w");
2985 [ - + ]: 20 : if (!fd) {
2986 : 0 : SPDK_ERRLOG("Can't open file %s for write\n", file);
2987 : 0 : return -ENOENT;
2988 : : }
2989 [ - + - + ]: 20 : rc = fwrite(data, 1, size, fd);
2990 [ - + ]: 20 : fclose(fd);
2991 : :
2992 [ + - ]: 20 : return rc == size ? 0 : -1;
2993 : 5 : }
2994 : :
2995 : : static int
2996 : 20 : nvmf_ns_reservation_update_json(const struct spdk_nvmf_ns *ns,
2997 : : const struct spdk_nvmf_reservation_info *info)
2998 : : {
2999 [ # # # # ]: 20 : const char *file = ns->ptpl_file;
3000 : : struct spdk_json_write_ctx *w;
3001 : : uint32_t i;
3002 : 20 : int rc = 0;
3003 : :
3004 : 20 : w = spdk_json_write_begin(nvmf_ns_json_write_cb, (void *)file, 0);
3005 [ + + ]: 20 : if (w == NULL) {
3006 : 0 : return -ENOMEM;
3007 : : }
3008 : : /* clear the configuration file */
3009 [ + + # # : 20 : if (!info->ptpl_activated) {
# # ]
3010 : 4 : goto exit;
3011 : : }
3012 : :
3013 : 16 : spdk_json_write_object_begin(w);
3014 [ # # # # ]: 16 : spdk_json_write_named_bool(w, "ptpl", info->ptpl_activated);
3015 [ # # # # ]: 16 : spdk_json_write_named_uint32(w, "rtype", info->rtype);
3016 [ # # # # ]: 16 : spdk_json_write_named_uint64(w, "crkey", info->crkey);
3017 [ # # ]: 16 : spdk_json_write_named_string(w, "bdev_uuid", info->bdev_uuid);
3018 [ # # ]: 16 : spdk_json_write_named_string(w, "holder_uuid", info->holder_uuid);
3019 : :
3020 : 16 : spdk_json_write_named_array_begin(w, "registrants");
3021 [ + + # # : 32 : for (i = 0; i < info->num_regs; i++) {
# # ]
3022 : 16 : spdk_json_write_object_begin(w);
3023 [ # # # # : 16 : spdk_json_write_named_uint64(w, "rkey", info->registrants[i].rkey);
# # # # ]
3024 [ # # # # : 16 : spdk_json_write_named_string(w, "host_uuid", info->registrants[i].host_uuid);
# # ]
3025 : 16 : spdk_json_write_object_end(w);
3026 : 4 : }
3027 : 16 : spdk_json_write_array_end(w);
3028 : 16 : spdk_json_write_object_end(w);
3029 : :
3030 : 15 : exit:
3031 : 20 : rc = spdk_json_write_end(w);
3032 : 20 : return rc;
3033 : 5 : }
3034 : :
3035 : : static int
3036 : 28 : nvmf_ns_update_reservation_info(struct spdk_nvmf_ns *ns)
3037 : : {
3038 : 21 : struct spdk_nvmf_reservation_info info;
3039 : : struct spdk_nvmf_registrant *reg, *tmp;
3040 : 28 : uint32_t i = 0;
3041 : :
3042 [ + + # # ]: 28 : assert(ns != NULL);
3043 : :
3044 [ + - - + : 28 : if (!ns->bdev || !nvmf_ns_is_ptpl_capable(ns)) {
# # # # ]
3045 : 0 : return 0;
3046 : : }
3047 : :
3048 [ - + ]: 28 : memset(&info, 0, sizeof(info));
3049 [ # # # # ]: 28 : spdk_uuid_fmt_lower(info.bdev_uuid, sizeof(info.bdev_uuid), spdk_bdev_get_uuid(ns->bdev));
3050 : :
3051 [ + + # # : 28 : if (ns->rtype) {
# # ]
3052 [ # # # # : 8 : info.rtype = ns->rtype;
# # ]
3053 [ # # # # ]: 8 : info.crkey = ns->crkey;
3054 [ + + ]: 8 : if (!nvmf_ns_reservation_all_registrants_type(ns)) {
3055 [ - + # # : 8 : assert(ns->holder != NULL);
# # # # ]
3056 [ # # # # : 8 : spdk_uuid_fmt_lower(info.holder_uuid, sizeof(info.holder_uuid), &ns->holder->hostid);
# # ]
3057 : 2 : }
3058 : 2 : }
3059 : :
3060 [ + + + + : 56 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
# # # # #
# # # # #
# # ]
3061 [ # # # # ]: 35 : spdk_uuid_fmt_lower(info.registrants[i].host_uuid, sizeof(info.registrants[i].host_uuid),
3062 [ # # ]: 28 : ®->hostid);
3063 [ # # # # : 28 : info.registrants[i++].rkey = reg->rkey;
# # # # #
# ]
3064 : 7 : }
3065 : :
3066 : 28 : info.num_regs = i;
3067 [ - + # # : 28 : info.ptpl_activated = ns->ptpl_activated;
# # ]
3068 : :
3069 : 28 : return nvmf_ns_reservation_update(ns, &info);
3070 : 7 : }
3071 : :
3072 : : static struct spdk_nvmf_registrant *
3073 : 440 : 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 [ + + + + : 764 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
# # # # #
# # # # #
# # ]
3079 [ + + # # ]: 604 : if (!spdk_uuid_compare(®->hostid, uuid)) {
3080 : 280 : return reg;
3081 : : }
3082 : 81 : }
3083 : :
3084 : 160 : return NULL;
3085 : 110 : }
3086 : :
3087 : : /* Generate reservation notice log to registered HostID controllers */
3088 : : static void
3089 : 40 : 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 [ + + ]: 100 : for (i = 0; i < num_hostid; i++) {
3099 [ + + # # : 300 : TAILQ_FOREACH(ctrlr, &subsystem->ctrlrs, link) {
# # # # #
# # # #
# ]
3100 [ + + # # : 240 : if (!spdk_uuid_compare(&ctrlr->hostid, &hostid_list[i])) {
# # ]
3101 : 88 : nvmf_ctrlr_reservation_notice_log(ctrlr, ns, type);
3102 : 22 : }
3103 : 60 : }
3104 : 15 : }
3105 : 40 : }
3106 : :
3107 : : /* Get all registrants' hostid other than the controller who issued the command */
3108 : : static uint32_t
3109 : 64 : 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 : 64 : uint32_t num_hostid = 0;
3116 : :
3117 [ + + + + : 220 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
# # # # #
# # # # #
# # ]
3118 [ + + # # ]: 156 : if (spdk_uuid_compare(®->hostid, current_hostid)) {
3119 [ + + ]: 92 : if (num_hostid == max_num_hostid) {
3120 [ # # ]: 0 : assert(false);
3121 : : return max_num_hostid;
3122 : : }
3123 [ # # # # ]: 92 : hostid_list[num_hostid++] = reg->hostid;
3124 : 23 : }
3125 : 39 : }
3126 : :
3127 : 64 : 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 : 12 : 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 : 9 : struct spdk_uuid temp_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3141 : 12 : uint32_t i, j, num_hostid = 0;
3142 : : bool found;
3143 : :
3144 [ + + ]: 12 : if (!remaining_num_hostid) {
3145 : 4 : return old_num_hostid;
3146 : : }
3147 : :
3148 [ + + ]: 24 : for (i = 0; i < old_num_hostid; i++) {
3149 : 16 : found = false;
3150 [ + + ]: 24 : for (j = 0; j < remaining_num_hostid; j++) {
3151 [ + + # # : 16 : if (!spdk_uuid_compare(&old_hostid_list[i], &remaining_hostid_list[j])) {
# # ]
3152 : 8 : found = true;
3153 : 8 : break;
3154 : : }
3155 : 2 : }
3156 [ + + # # ]: 16 : if (!found) {
3157 [ # # # # : 8 : spdk_uuid_copy(&temp_hostid_list[num_hostid++], &old_hostid_list[i]);
# # ]
3158 : 2 : }
3159 : 4 : }
3160 : :
3161 [ + + ]: 8 : if (num_hostid) {
3162 [ - + - + ]: 8 : memcpy(old_hostid_list, temp_hostid_list, sizeof(struct spdk_uuid) * num_hostid);
3163 : 2 : }
3164 : :
3165 : 8 : return num_hostid;
3166 : 3 : }
3167 : :
3168 : : /* current reservation type is all registrants or not */
3169 : : static bool
3170 : 216 : nvmf_ns_reservation_all_registrants_type(struct spdk_nvmf_ns *ns)
3171 : : {
3172 [ + + # # : 360 : return (ns->rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS ||
# # ]
3173 [ - + # # ]: 192 : ns->rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS);
3174 : : }
3175 : :
3176 : : /* current registrant is reservation holder or not */
3177 : : static bool
3178 : 104 : nvmf_ns_reservation_registrant_is_holder(struct spdk_nvmf_ns *ns,
3179 : : struct spdk_nvmf_registrant *reg)
3180 : : {
3181 [ + + ]: 104 : if (!reg) {
3182 : 0 : return false;
3183 : : }
3184 : :
3185 [ + + ]: 104 : if (nvmf_ns_reservation_all_registrants_type(ns)) {
3186 : 8 : return true;
3187 : : }
3188 : :
3189 [ # # # # ]: 96 : return (ns->holder == reg);
3190 : 26 : }
3191 : :
3192 : : static int
3193 : 116 : 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 : 116 : reg = calloc(1, sizeof(*reg));
3200 [ - + ]: 116 : if (!reg) {
3201 : 0 : return -ENOMEM;
3202 : : }
3203 : :
3204 [ # # # # ]: 116 : reg->rkey = nrkey;
3205 : : /* set hostid for the registrant */
3206 [ # # # # ]: 116 : spdk_uuid_copy(®->hostid, &ctrlr->hostid);
3207 [ # # # # : 116 : TAILQ_INSERT_TAIL(&ns->registrants, reg, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
3208 [ # # ]: 116 : ns->gen++;
3209 : :
3210 : 116 : return 0;
3211 : 29 : }
3212 : :
3213 : : static void
3214 : 44 : nvmf_ns_reservation_release_reservation(struct spdk_nvmf_ns *ns)
3215 : : {
3216 [ # # # # ]: 44 : ns->rtype = 0;
3217 [ # # # # ]: 44 : ns->crkey = 0;
3218 [ # # # # ]: 44 : ns->holder = NULL;
3219 : 44 : }
3220 : :
3221 : : /* release the reservation if the last registrant was removed */
3222 : : static void
3223 : 76 : 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 [ + + # # : 76 : if (!ns->holder) {
# # ]
3230 [ + + # # : 28 : assert(ns->rtype == 0);
# # # # ]
3231 : 28 : return;
3232 : : }
3233 : :
3234 [ # # # # : 48 : next_reg = TAILQ_FIRST(&ns->registrants);
# # ]
3235 [ + + + + ]: 48 : if (next_reg && nvmf_ns_reservation_all_registrants_type(ns)) {
3236 : : /* the next valid registrant is the new holder now */
3237 [ # # # # ]: 8 : ns->holder = next_reg;
3238 [ + + ]: 42 : } else if (nvmf_ns_reservation_registrant_is_holder(ns, reg)) {
3239 : : /* release the reservation */
3240 : 28 : nvmf_ns_reservation_release_reservation(ns);
3241 : 7 : }
3242 : 19 : }
3243 : :
3244 : : static void
3245 : 76 : nvmf_ns_reservation_remove_registrant(struct spdk_nvmf_ns *ns,
3246 : : struct spdk_nvmf_registrant *reg)
3247 : : {
3248 [ + + # # : 76 : TAILQ_REMOVE(&ns->registrants, reg, link);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ]
3249 : 76 : nvmf_ns_reservation_check_release_on_remove_registrant(ns, reg);
3250 : 76 : free(reg);
3251 [ # # ]: 76 : ns->gen++;
3252 : 76 : 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 : 4 : 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 : 4 : uint32_t count = 0;
3277 : :
3278 [ + + + + : 12 : TAILQ_FOREACH_SAFE(reg_tmp, &ns->registrants, link, reg_tmp2) {
# # # # #
# # # # #
# # ]
3279 [ + + ]: 8 : if (reg_tmp != reg) {
3280 : 4 : nvmf_ns_reservation_remove_registrant(ns, reg_tmp);
3281 : 4 : count++;
3282 : 1 : }
3283 : 2 : }
3284 : 4 : return count;
3285 : : }
3286 : :
3287 : : static uint32_t
3288 : 172 : nvmf_ns_reservation_clear_all_registrants(struct spdk_nvmf_ns *ns)
3289 : : {
3290 : : struct spdk_nvmf_registrant *reg, *reg_tmp;
3291 : 172 : uint32_t count = 0;
3292 : :
3293 [ + + + + : 216 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, reg_tmp) {
+ - + - #
# # # # #
+ - ]
3294 : 44 : nvmf_ns_reservation_remove_registrant(ns, reg);
3295 : 44 : count++;
3296 : 11 : }
3297 : 172 : return count;
3298 : : }
3299 : :
3300 : : static void
3301 : 48 : 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 [ # # # # ]: 48 : ns->rtype = rtype;
3306 [ # # # # ]: 48 : ns->crkey = rkey;
3307 [ + + # # : 48 : assert(ns->holder == NULL);
# # # # ]
3308 [ # # # # ]: 48 : ns->holder = holder;
3309 : 48 : }
3310 : :
3311 : : static bool
3312 : 180 : nvmf_ns_reservation_register(struct spdk_nvmf_ns *ns,
3313 : : struct spdk_nvmf_ctrlr *ctrlr,
3314 : : struct spdk_nvmf_request *req)
3315 : : {
3316 : 180 : struct spdk_nvme_reservation_register_data key = { 0 };
3317 [ # # # # : 180 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
# # ]
3318 : : uint8_t rrega, iekey, cptpl, rtype;
3319 : : struct spdk_nvmf_registrant *reg;
3320 : 180 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3321 : 180 : bool update_sgroup = false;
3322 : 135 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3323 : 180 : uint32_t num_hostid = 0;
3324 : : int rc;
3325 : :
3326 [ # # # # : 180 : rrega = cmd->cdw10_bits.resv_register.rrega;
# # # # ]
3327 [ # # # # : 180 : iekey = cmd->cdw10_bits.resv_register.iekey;
# # # # ]
3328 [ # # # # : 180 : cptpl = cmd->cdw10_bits.resv_register.cptpl;
# # # # ]
3329 : :
3330 [ + - + + : 180 : if (req->iovcnt > 0 && req->length >= sizeof(key)) {
# # # # #
# # # ]
3331 : 135 : struct spdk_iov_xfer ix;
3332 [ # # # # : 180 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
# # ]
3333 : 180 : 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 [ + + - + : 180 : 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 [ + + ]: 180 : if (cptpl == SPDK_NVME_RESERVE_PTPL_CLEAR_POWER_ON) {
3345 : : /* True to OFF state, and need to be updated in the configuration file */
3346 [ + + + - : 4 : if (ns->ptpl_activated) {
# # # # ]
3347 [ # # # # ]: 4 : ns->ptpl_activated = 0;
3348 : 4 : update_sgroup = true;
3349 : 1 : }
3350 [ + + ]: 177 : } else if (cptpl == SPDK_NVME_RESERVE_PTPL_PERSIST_POWER_LOSS) {
3351 [ + + ]: 16 : if (!nvmf_ns_is_ptpl_capable(ns)) {
3352 : 4 : status = SPDK_NVME_SC_INVALID_FIELD;
3353 : 4 : goto exit;
3354 [ + + + - : 12 : } else if (ns->ptpl_activated == 0) {
# # # # ]
3355 [ # # # # ]: 12 : ns->ptpl_activated = 1;
3356 : 12 : update_sgroup = true;
3357 : 3 : }
3358 : 3 : }
3359 : :
3360 : : /* current Host Identifier has registrant or not */
3361 [ # # ]: 176 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3362 : :
3363 [ + + + + ]: 176 : switch (rrega) {
3364 : 108 : case SPDK_NVME_RESERVE_REGISTER_KEY:
3365 [ + + ]: 144 : if (!reg) {
3366 : : /* register new controller */
3367 [ + + # # ]: 108 : 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 [ # # ]: 108 : rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
3373 [ + + ]: 108 : if (rc < 0) {
3374 : 0 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3375 : 0 : goto exit;
3376 : : }
3377 : 108 : update_sgroup = true;
3378 : 27 : } else {
3379 : : /* register with same key is not an error */
3380 [ + + # # : 36 : if (reg->rkey != key.nrkey) {
# # # # ]
3381 [ # # # # ]: 32 : SPDK_ERRLOG("The same host already register a "
3382 : : "key with 0x%"PRIx64"\n",
3383 : : reg->rkey);
3384 : 32 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3385 : 32 : goto exit;
3386 : : }
3387 : : }
3388 : 112 : break;
3389 : 12 : case SPDK_NVME_RESERVE_UNREGISTER_KEY:
3390 [ + - + + : 16 : 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 [ # # # # ]: 16 : rtype = ns->rtype;
3398 : 20 : num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
3399 : : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3400 [ # # ]: 4 : &ctrlr->hostid);
3401 : :
3402 : 16 : nvmf_ns_reservation_remove_registrant(ns, reg);
3403 : :
3404 [ + + + - : 16 : if (!ns->rtype && num_hostid && (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_REG_ONLY ||
+ + - + #
# # # ]
3405 : 1 : rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY)) {
3406 [ # # # # ]: 5 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3407 : 1 : hostid_list,
3408 : 1 : num_hostid,
3409 : : SPDK_NVME_RESERVATION_RELEASED);
3410 : 1 : }
3411 : 16 : update_sgroup = true;
3412 : 16 : break;
3413 : 12 : case SPDK_NVME_RESERVE_REPLACE_KEY:
3414 [ + + # # ]: 16 : 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 [ + + ]: 16 : if (reg) {
3421 [ + + + + : 8 : 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 [ - + # # : 8 : if (reg->rkey == key.nrkey) {
# # # # ]
3428 : 0 : goto exit;
3429 : : }
3430 [ # # # # : 8 : reg->rkey = key.nrkey;
# # ]
3431 [ + + ]: 10 : } else if (iekey) { /* No registrant but IEKEY is set */
3432 : : /* new registrant */
3433 [ # # ]: 4 : rc = nvmf_ns_reservation_add_registrant(ns, ctrlr, key.nrkey);
3434 [ + + ]: 4 : if (rc < 0) {
3435 : 0 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3436 : 0 : goto exit;
3437 : : }
3438 : 1 : } else { /* No registrant */
3439 : 4 : SPDK_ERRLOG("No registrant\n");
3440 : 4 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
3441 : 4 : goto exit;
3442 : :
3443 : : }
3444 : 12 : update_sgroup = true;
3445 : 12 : break;
3446 : 0 : default:
3447 : 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3448 : 0 : goto exit;
3449 : 35 : }
3450 : :
3451 : 135 : exit:
3452 [ # # # # : 180 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
# # # # #
# # # ]
3453 [ # # # # : 180 : req->rsp->nvme_cpl.status.sc = status;
# # # # #
# # # ]
3454 [ # # ]: 180 : return update_sgroup;
3455 : : }
3456 : :
3457 : : static bool
3458 : 52 : nvmf_ns_reservation_acquire(struct spdk_nvmf_ns *ns,
3459 : : struct spdk_nvmf_ctrlr *ctrlr,
3460 : : struct spdk_nvmf_request *req)
3461 : : {
3462 : 52 : struct spdk_nvme_reservation_acquire_data key = { 0 };
3463 [ # # # # : 52 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
# # ]
3464 : : uint8_t racqa, iekey, rtype;
3465 : : struct spdk_nvmf_registrant *reg;
3466 : 52 : bool all_regs = false;
3467 : 52 : uint32_t count = 0;
3468 : 52 : bool update_sgroup = true;
3469 : 39 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3470 : 52 : uint32_t num_hostid = 0;
3471 : 39 : struct spdk_uuid new_hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3472 : 52 : uint32_t new_num_hostid = 0;
3473 : 52 : bool reservation_released = false;
3474 : 52 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3475 : :
3476 [ # # # # : 52 : racqa = cmd->cdw10_bits.resv_acquire.racqa;
# # # # ]
3477 [ # # # # : 52 : iekey = cmd->cdw10_bits.resv_acquire.iekey;
# # # # ]
3478 [ # # # # : 52 : rtype = cmd->cdw10_bits.resv_acquire.rtype;
# # # # ]
3479 : :
3480 [ + - + + : 52 : if (req->iovcnt > 0 && req->length >= sizeof(key)) {
# # # # #
# ]
3481 : 39 : struct spdk_iov_xfer ix;
3482 [ # # # # : 52 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
# # ]
3483 : 52 : 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 [ + + - + : 52 : 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 [ + - - + ]: 52 : 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 [ # # ]: 52 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3502 : : /* must be registrant and CRKEY must match */
3503 [ + - - + : 52 : 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 : 52 : all_regs = nvmf_ns_reservation_all_registrants_type(ns);
3512 : :
3513 [ + + + ]: 52 : switch (racqa) {
3514 : 30 : case SPDK_NVME_RESERVE_ACQUIRE:
3515 : : /* it's not an error for the holder to acquire same reservation type again */
3516 [ - + - - : 40 : if (nvmf_ns_reservation_registrant_is_holder(ns, reg) && ns->rtype == rtype) {
# # # # ]
3517 : : /* do nothing */
3518 : 0 : update_sgroup = false;
3519 [ + + # # : 40 : } else if (ns->holder == NULL) {
# # ]
3520 : : /* first time to acquire the reservation */
3521 : 40 : 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 : 40 : break;
3529 : 9 : case SPDK_NVME_RESERVE_PREEMPT:
3530 : : /* no reservation holder */
3531 [ + + # # : 12 : if (!ns->holder) {
# # ]
3532 : : /* unregister with PRKEY */
3533 [ # # ]: 0 : nvmf_ns_reservation_remove_registrants_by_key(ns, key.prkey);
3534 : 0 : break;
3535 : : }
3536 : 15 : 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 [ + + # # ]: 12 : if (!all_regs) {
3542 : : /* preempt itself */
3543 [ - + # # ]: 8 : 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 [ + - # # : 8 : if (ns->crkey == key.prkey) {
# # # # ]
3551 [ # # # # ]: 8 : nvmf_ns_reservation_remove_registrant(ns, ns->holder);
3552 : 8 : nvmf_ns_reservation_acquire_reservation(ns, key.crkey, rtype, reg);
3553 : 8 : 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 [ + + # # ]: 4 : if (key.prkey == 0) {
3566 : 4 : nvmf_ns_reservation_remove_all_other_registrants(ns, reg);
3567 [ - + # # : 4 : 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 : 12 : break;
3579 : 0 : default:
3580 : 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3581 : 0 : update_sgroup = false;
3582 : 0 : break;
3583 : 13 : }
3584 : :
3585 : 39 : exit:
3586 [ + - + + ]: 52 : if (update_sgroup && racqa == SPDK_NVME_RESERVE_PREEMPT) {
3587 : 15 : 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 : 15 : 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 [ + + ]: 12 : if (num_hostid) {
3598 [ # # # # ]: 15 : 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 [ + + + + : 12 : if (reservation_released && new_num_hostid) {
# # ]
3609 [ # # # # ]: 10 : 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 [ # # # # : 52 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
# # # # #
# # # ]
3617 [ # # # # : 52 : req->rsp->nvme_cpl.status.sc = status;
# # # # #
# # # ]
3618 [ # # ]: 52 : return update_sgroup;
3619 : : }
3620 : :
3621 : : static bool
3622 : 24 : nvmf_ns_reservation_release(struct spdk_nvmf_ns *ns,
3623 : : struct spdk_nvmf_ctrlr *ctrlr,
3624 : : struct spdk_nvmf_request *req)
3625 : : {
3626 [ # # # # : 24 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
# # ]
3627 : : uint8_t rrela, iekey, rtype;
3628 : : struct spdk_nvmf_registrant *reg;
3629 : 24 : uint64_t crkey = 0;
3630 : 24 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3631 : 24 : bool update_sgroup = true;
3632 : 18 : struct spdk_uuid hostid_list[SPDK_NVMF_MAX_NUM_REGISTRANTS];
3633 : 24 : uint32_t num_hostid = 0;
3634 : :
3635 [ # # # # : 24 : rrela = cmd->cdw10_bits.resv_release.rrela;
# # # # ]
3636 [ # # # # : 24 : iekey = cmd->cdw10_bits.resv_release.iekey;
# # # # ]
3637 [ # # # # : 24 : rtype = cmd->cdw10_bits.resv_release.rtype;
# # # # ]
3638 : :
3639 [ + - + + : 24 : if (req->iovcnt > 0 && req->length >= sizeof(crkey)) {
# # # # #
# # # ]
3640 : 18 : struct spdk_iov_xfer ix;
3641 [ # # # # : 24 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
# # ]
3642 : 24 : 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 [ + + - + : 24 : SPDK_DEBUGLOG(nvmf, "RELEASE: RRELA %u, IEKEY %u, RTYPE %u, "
# # ]
3650 : : "CRKEY 0x%"PRIx64"\n", rrela, iekey, rtype, crkey);
3651 : :
3652 [ - + ]: 24 : 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 [ # # ]: 24 : reg = nvmf_ns_reservation_get_registrant(ns, &ctrlr->hostid);
3660 [ + - - + : 24 : 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 : 30 : num_hostid = nvmf_ns_reservation_get_all_other_hostid(ns, hostid_list,
3669 : : SPDK_NVMF_MAX_NUM_REGISTRANTS,
3670 [ # # ]: 6 : &ctrlr->hostid);
3671 : :
3672 [ + + + ]: 24 : switch (rrela) {
3673 : 12 : case SPDK_NVME_RESERVE_RELEASE:
3674 [ + + # # : 16 : if (!ns->holder) {
# # ]
3675 [ # # # # : 0 : SPDK_DEBUGLOG(nvmf, "RELEASE: no holder\n");
# # ]
3676 : 0 : update_sgroup = false;
3677 : 0 : goto exit;
3678 : : }
3679 [ - + # # : 16 : 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 [ + + ]: 16 : 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 [ # # # # ]: 16 : rtype = ns->rtype;
3692 : 16 : nvmf_ns_reservation_release_reservation(ns);
3693 : :
3694 [ + + + + : 16 : if (num_hostid && rtype != SPDK_NVME_RESERVE_WRITE_EXCLUSIVE &&
+ - ]
3695 : 2 : rtype != SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) {
3696 [ # # # # ]: 10 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3697 : 2 : hostid_list,
3698 : 2 : num_hostid,
3699 : : SPDK_NVME_RESERVATION_RELEASED);
3700 : 2 : }
3701 : 16 : break;
3702 : 6 : case SPDK_NVME_RESERVE_CLEAR:
3703 : 8 : nvmf_ns_reservation_clear_all_registrants(ns);
3704 [ + + ]: 8 : if (num_hostid) {
3705 [ # # # # ]: 10 : nvmf_subsystem_gen_ctrlr_notification(ns->subsystem, ns,
3706 : 2 : hostid_list,
3707 : 2 : num_hostid,
3708 : : SPDK_NVME_RESERVATION_PREEMPTED);
3709 : 2 : }
3710 : 8 : break;
3711 : 0 : default:
3712 : 0 : status = SPDK_NVME_SC_INVALID_FIELD;
3713 : 0 : update_sgroup = false;
3714 : 0 : goto exit;
3715 : 6 : }
3716 : :
3717 : 18 : exit:
3718 [ # # # # : 24 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
# # # # #
# # # ]
3719 [ # # # # : 24 : req->rsp->nvme_cpl.status.sc = status;
# # # # #
# # # ]
3720 [ # # ]: 24 : return update_sgroup;
3721 : : }
3722 : :
3723 : : static void
3724 : 12 : nvmf_ns_reservation_report(struct spdk_nvmf_ns *ns,
3725 : : struct spdk_nvmf_ctrlr *ctrlr,
3726 : : struct spdk_nvmf_request *req)
3727 : : {
3728 [ # # # # : 12 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
# # ]
3729 : : struct spdk_nvmf_registrant *reg, *tmp;
3730 : 12 : struct spdk_nvme_reservation_status_extended_data status_data = { 0 };
3731 : 9 : struct spdk_iov_xfer ix;
3732 : : uint32_t transfer_len;
3733 : 12 : uint32_t regctl = 0;
3734 : 12 : uint8_t status = SPDK_NVME_SC_SUCCESS;
3735 : :
3736 [ + + # # : 12 : 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 [ + + # # : 12 : if (!cmd->cdw11_bits.resv_report.eds) {
# # # # #
# ]
3744 : 4 : SPDK_ERRLOG("NVMeoF uses extended controller data structure, "
3745 : : "please set EDS bit in cdw11 and try again\n");
3746 : 4 : status = SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT;
3747 : 4 : goto exit;
3748 : : }
3749 : :
3750 : : /* Number of Dwords of the Reservation Status data structure to transfer */
3751 [ # # # # : 8 : transfer_len = (cmd->cdw10 + 1) * sizeof(uint32_t);
# # ]
3752 : :
3753 [ + + ]: 8 : if (transfer_len < sizeof(struct spdk_nvme_reservation_status_extended_data)) {
3754 : 4 : status = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
3755 : 4 : goto exit;
3756 : : }
3757 : :
3758 [ # # # # : 4 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
# # ]
3759 : :
3760 [ # # # # ]: 4 : status_data.data.gen = ns->gen;
3761 [ # # # # : 4 : status_data.data.rtype = ns->rtype;
# # ]
3762 [ - + # # : 4 : status_data.data.ptpls = ns->ptpl_activated;
# # # # ]
3763 : :
3764 [ + + + + : 12 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
# # # # #
# # # # #
# # ]
3765 : 8 : 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 [ # # ]: 4 : status_data.data.regctl = regctl;
3776 : :
3777 : 4 : spdk_iov_xfer_from_buf(&ix, &status_data, sizeof(status_data));
3778 : :
3779 [ + + + + : 12 : TAILQ_FOREACH_SAFE(reg, &ns->registrants, link, tmp) {
# # # # #
# # # # #
# # ]
3780 : 8 : struct spdk_nvme_registered_ctrlr_extended_data ctrlr_data = { 0 };
3781 : :
3782 : : /* Set to 0xffffh for dynamic controller */
3783 : 8 : ctrlr_data.cntlid = 0xffff;
3784 [ # # # # ]: 8 : ctrlr_data.rcsts.status = (ns->holder == reg) ? true : false;
3785 [ # # # # ]: 8 : ctrlr_data.rkey = reg->rkey;
3786 [ # # ]: 8 : spdk_uuid_copy((struct spdk_uuid *)ctrlr_data.hostid, ®->hostid);
3787 : :
3788 : 8 : spdk_iov_xfer_from_buf(&ix, &ctrlr_data, sizeof(ctrlr_data));
3789 : 3 : }
3790 : :
3791 : 9 : exit:
3792 [ # # # # : 12 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
# # # # #
# # # ]
3793 [ # # # # : 12 : req->rsp->nvme_cpl.status.sc = status;
# # # # #
# # # ]
3794 : 12 : 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 : 0 : case SPDK_NVME_OPC_RESERVATION_REGISTER:
3832 : 0 : update_sgroup = nvmf_ns_reservation_register(ns, ctrlr, req);
3833 : 0 : break;
3834 : 0 : case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
3835 : 0 : update_sgroup = nvmf_ns_reservation_acquire(ns, ctrlr, req);
3836 : 0 : break;
3837 : 0 : case SPDK_NVME_OPC_RESERVATION_RELEASE:
3838 : 0 : update_sgroup = nvmf_ns_reservation_release(ns, ctrlr, req);
3839 : 0 : break;
3840 : 0 : case SPDK_NVME_OPC_RESERVATION_REPORT:
3841 : 0 : nvmf_ns_reservation_report(ns, ctrlr, req);
3842 : 0 : break;
3843 : 0 : 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 : 1247 : nvmf_ns_is_ptpl_capable_json(const struct spdk_nvmf_ns *ns)
3865 : : {
3866 [ + - + - ]: 1247 : 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 : 1263 : nvmf_ns_is_ptpl_capable(const struct spdk_nvmf_ns *ns)
3877 : : {
3878 [ - + + - ]: 1263 : return g_reservation_ops.is_ptpl_capable(ns);
3879 : : }
3880 : :
3881 : : static int
3882 : 28 : nvmf_ns_reservation_update(const struct spdk_nvmf_ns *ns,
3883 : : const struct spdk_nvmf_reservation_info *info)
3884 : : {
3885 [ # # # # : 28 : return g_reservation_ops.update(ns, info);
# # ]
3886 : : }
3887 : :
3888 : : static int
3889 : 24 : nvmf_ns_reservation_load(const struct spdk_nvmf_ns *ns, struct spdk_nvmf_reservation_info *info)
3890 : : {
3891 [ # # # # : 24 : return g_reservation_ops.load(ns, info);
# # ]
3892 : : }
3893 : :
3894 : : void
3895 : 4 : spdk_nvmf_set_custom_ns_reservation_ops(const struct spdk_nvmf_ns_reservation_ops *ops)
3896 : : {
3897 : 4 : g_reservation_ops = *ops;
3898 : 4 : }
3899 : :
3900 : : int
3901 : 122 : spdk_nvmf_subsystem_set_ana_reporting(struct spdk_nvmf_subsystem *subsystem,
3902 : : bool ana_reporting)
3903 : : {
3904 [ + + + - : 122 : if (subsystem->state != SPDK_NVMF_SUBSYSTEM_INACTIVE) {
+ - ]
3905 : 0 : return -EAGAIN;
3906 : : }
3907 : :
3908 [ + - + - : 122 : subsystem->flags.ana_reporting = ana_reporting;
+ - ]
3909 : :
3910 : 122 : return 0;
3911 : 39 : }
3912 : :
3913 : : bool
3914 : 129 : spdk_nvmf_subsystem_get_ana_reporting(struct spdk_nvmf_subsystem *subsystem)
3915 : : {
3916 [ # # # # ]: 129 : 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 : 41 : subsystem_listener_update_done(struct spdk_io_channel_iter *i, int status)
3928 : : {
3929 : 41 : struct subsystem_listener_update_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
3930 : :
3931 [ + - # # : 41 : if (ctx->cb_fn) {
# # ]
3932 [ # # # # : 41 : ctx->cb_fn(ctx->cb_arg, status);
# # # # #
# # # ]
3933 : 0 : }
3934 : 41 : free(ctx);
3935 : 41 : }
3936 : :
3937 : : static void
3938 : 102 : subsystem_listener_update_on_pg(struct spdk_io_channel_iter *i)
3939 : : {
3940 : 102 : 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 [ # # # # ]: 102 : listener = ctx->listener;
3946 : 102 : group = spdk_io_channel_get_ctx(spdk_io_channel_iter_get_channel(i));
3947 : :
3948 [ + + # # : 304 : TAILQ_FOREACH(ctrlr, &listener->subsystem->ctrlrs, link) {
# # # # #
# # # # #
# # # # ]
3949 [ + + # # : 202 : if (ctrlr->thread != spdk_get_thread()) {
# # ]
3950 : 121 : continue;
3951 : : }
3952 : :
3953 [ + - + - : 81 : if (ctrlr->admin_qpair && ctrlr->admin_qpair->group == group && ctrlr->listener == listener) {
+ + # # #
# # # # #
# # # # #
# # # ]
3954 : 40 : nvmf_ctrlr_async_event_ana_change_notice(ctrlr);
3955 : 0 : }
3956 : 0 : }
3957 : :
3958 : 102 : spdk_for_each_channel_continue(i, 0);
3959 : 102 : }
3960 : :
3961 : : void
3962 : 41 : 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 [ - + # # ]: 41 : assert(cb_fn != NULL);
3972 [ + - - + : 41 : assert(subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE ||
# # # # #
# # # #
# ]
3973 : : subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED);
3974 : :
3975 [ - + # # : 41 : 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 [ + + + + : 41 : 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 [ - + # # : 41 : 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 : 41 : listener = nvmf_subsystem_find_listener(subsystem, trid);
3999 [ - + ]: 41 : if (!listener) {
4000 : 0 : SPDK_ERRLOG("Unable to find listener.\n");
4001 [ # # # # ]: 0 : cb_fn(cb_arg, -EINVAL);
4002 : 0 : return;
4003 : : }
4004 : :
4005 [ - + - - : 41 : if (anagrpid != 0 && listener->ana_state[anagrpid - 1] == ana_state) {
# # # # #
# # # ]
4006 [ # # # # ]: 0 : cb_fn(cb_arg, 0);
4007 : 0 : return;
4008 : : }
4009 : :
4010 : 41 : ctx = calloc(1, sizeof(*ctx));
4011 [ - + ]: 41 : if (!ctx) {
4012 : 0 : SPDK_ERRLOG("Unable to allocate context\n");
4013 [ # # # # ]: 0 : cb_fn(cb_arg, -ENOMEM);
4014 : 0 : return;
4015 : : }
4016 : :
4017 [ + + # # : 423 : for (i = 1; i <= subsystem->max_nsid; i++) {
# # ]
4018 [ - + - - ]: 382 : if (anagrpid == 0 || i == anagrpid) {
4019 [ # # # # : 382 : listener->ana_state[i - 1] = ana_state;
# # # # ]
4020 : 0 : }
4021 : 0 : }
4022 [ # # ]: 41 : listener->ana_state_change_count++;
4023 : :
4024 [ # # # # ]: 41 : ctx->listener = listener;
4025 [ # # # # ]: 41 : ctx->cb_fn = cb_fn;
4026 [ # # # # ]: 41 : ctx->cb_arg = cb_arg;
4027 : :
4028 [ # # # # ]: 41 : 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 : 33332 : spdk_nvmf_subsystem_is_discovery(struct spdk_nvmf_subsystem *subsystem)
4066 : : {
4067 [ + + + - : 65903 : return subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY_CURRENT ||
- + ]
4068 [ + + + - ]: 32585 : 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 : : }
|