Line data Source code
1 : /* SPDX-License-Identifier: BSD-3-Clause
2 : * Copyright (C) 2017 Intel Corporation. All rights reserved.
3 : * Copyright (c) 2019, 2020 Mellanox Technologies LTD. All rights reserved.
4 : * Copyright (c) 2021, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 : * Copyright (c) 2024 Samsung Electronics Co., Ltd. All rights reserved.
6 : */
7 :
8 : #include "spdk/stdinc.h"
9 :
10 : #include "nvmf_internal.h"
11 : #include "transport.h"
12 :
13 : #include "spdk/bdev.h"
14 : #include "spdk/bdev_zone.h"
15 : #include "spdk/bit_array.h"
16 : #include "spdk/endian.h"
17 : #include "spdk/thread.h"
18 : #include "spdk/nvme_spec.h"
19 : #include "spdk/nvmf_cmd.h"
20 : #include "spdk/string.h"
21 : #include "spdk/util.h"
22 : #include "spdk/version.h"
23 : #include "spdk/log.h"
24 : #include "spdk_internal/usdt.h"
25 :
26 : #define MIN_KEEP_ALIVE_TIMEOUT_IN_MS 10000
27 : #define NVMF_DISC_KATO_IN_MS 120000
28 : #define KAS_TIME_UNIT_IN_MS 100
29 : #define KAS_DEFAULT_VALUE (MIN_KEEP_ALIVE_TIMEOUT_IN_MS / KAS_TIME_UNIT_IN_MS)
30 :
31 : #define NVMF_CC_RESET_SHN_TIMEOUT_IN_MS 10000
32 :
33 : #define NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + 5000)
34 :
35 : #define DUPLICATE_QID_RETRY_US 1000
36 :
37 : /*
38 : * Report the SPDK version as the firmware revision.
39 : * SPDK_VERSION_STRING won't fit into FR (only 8 bytes), so try to fit the most important parts.
40 : */
41 : #define FW_VERSION SPDK_VERSION_MAJOR_STRING SPDK_VERSION_MINOR_STRING SPDK_VERSION_PATCH_STRING
42 :
43 : #define ANA_TRANSITION_TIME_IN_SEC 10
44 :
45 : #define NVMF_ABORT_COMMAND_LIMIT 3
46 :
47 : /*
48 : * Support for custom admin command handlers
49 : */
50 : struct spdk_nvmf_custom_admin_cmd {
51 : spdk_nvmf_custom_cmd_hdlr hdlr;
52 : uint32_t nsid; /* nsid to forward */
53 : };
54 :
55 : static struct spdk_nvmf_custom_admin_cmd g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_MAX_OPC + 1];
56 :
57 : static void _nvmf_request_complete(void *ctx);
58 : int nvmf_passthru_admin_cmd_for_ctrlr(struct spdk_nvmf_request *req, struct spdk_nvmf_ctrlr *ctrlr);
59 :
60 : static inline void
61 13 : nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp,
62 : uint8_t iattr, uint16_t ipo)
63 : {
64 13 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
65 13 : rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
66 13 : rsp->status_code_specific.invalid.iattr = iattr;
67 13 : rsp->status_code_specific.invalid.ipo = ipo;
68 13 : }
69 :
70 : #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \
71 : nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field))
72 : #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \
73 : nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field))
74 :
75 :
76 : static void
77 4 : nvmf_ctrlr_stop_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr)
78 : {
79 4 : if (!ctrlr) {
80 0 : SPDK_ERRLOG("Controller is NULL\n");
81 0 : return;
82 : }
83 :
84 4 : if (ctrlr->keep_alive_poller == NULL) {
85 0 : return;
86 : }
87 :
88 4 : SPDK_DEBUGLOG(nvmf, "Stop keep alive poller\n");
89 4 : spdk_poller_unregister(&ctrlr->keep_alive_poller);
90 : }
91 :
92 : static void
93 1 : nvmf_ctrlr_stop_association_timer(struct spdk_nvmf_ctrlr *ctrlr)
94 : {
95 1 : if (!ctrlr) {
96 0 : SPDK_ERRLOG("Controller is NULL\n");
97 0 : assert(false);
98 : return;
99 : }
100 :
101 1 : if (ctrlr->association_timer == NULL) {
102 1 : return;
103 : }
104 :
105 0 : SPDK_DEBUGLOG(nvmf, "Stop association timer\n");
106 0 : spdk_poller_unregister(&ctrlr->association_timer);
107 : }
108 :
109 : static void
110 0 : nvmf_ctrlr_disconnect_qpairs_done(struct spdk_io_channel_iter *i, int status)
111 : {
112 0 : if (status == 0) {
113 0 : SPDK_DEBUGLOG(nvmf, "ctrlr disconnect qpairs complete successfully\n");
114 : } else {
115 0 : SPDK_ERRLOG("Fail to disconnect ctrlr qpairs\n");
116 : }
117 0 : }
118 :
119 : static int
120 0 : _nvmf_ctrlr_disconnect_qpairs_on_pg(struct spdk_io_channel_iter *i, bool include_admin)
121 : {
122 0 : int rc = 0;
123 : struct spdk_nvmf_ctrlr *ctrlr;
124 : struct spdk_nvmf_qpair *qpair, *temp_qpair;
125 : struct spdk_io_channel *ch;
126 : struct spdk_nvmf_poll_group *group;
127 :
128 0 : ctrlr = spdk_io_channel_iter_get_ctx(i);
129 0 : ch = spdk_io_channel_iter_get_channel(i);
130 0 : group = spdk_io_channel_get_ctx(ch);
131 :
132 0 : TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, temp_qpair) {
133 0 : if (qpair->ctrlr == ctrlr && (include_admin || !nvmf_qpair_is_admin_queue(qpair))) {
134 0 : rc = spdk_nvmf_qpair_disconnect(qpair);
135 0 : if (rc) {
136 0 : if (rc == -EINPROGRESS) {
137 0 : rc = 0;
138 : } else {
139 0 : SPDK_ERRLOG("Qpair disconnect failed\n");
140 0 : return rc;
141 : }
142 : }
143 : }
144 : }
145 :
146 0 : return rc;
147 : }
148 :
149 : static void
150 0 : nvmf_ctrlr_disconnect_qpairs_on_pg(struct spdk_io_channel_iter *i)
151 : {
152 0 : spdk_for_each_channel_continue(i, _nvmf_ctrlr_disconnect_qpairs_on_pg(i, true));
153 0 : }
154 :
155 : static void
156 0 : nvmf_ctrlr_disconnect_io_qpairs_on_pg(struct spdk_io_channel_iter *i)
157 : {
158 0 : spdk_for_each_channel_continue(i, _nvmf_ctrlr_disconnect_qpairs_on_pg(i, false));
159 0 : }
160 :
161 : static int
162 0 : nvmf_ctrlr_keep_alive_poll(void *ctx)
163 : {
164 : uint64_t keep_alive_timeout_tick;
165 0 : uint64_t now = spdk_get_ticks();
166 0 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
167 :
168 0 : if (ctrlr->in_destruct) {
169 0 : nvmf_ctrlr_stop_keep_alive_timer(ctrlr);
170 0 : return SPDK_POLLER_IDLE;
171 : }
172 :
173 0 : SPDK_DEBUGLOG(nvmf, "Polling ctrlr keep alive timeout\n");
174 :
175 : /* If the Keep alive feature is in use and the timer expires */
176 0 : keep_alive_timeout_tick = ctrlr->last_keep_alive_tick +
177 0 : ctrlr->feat.keep_alive_timer.bits.kato * spdk_get_ticks_hz() / UINT64_C(1000);
178 0 : if (now > keep_alive_timeout_tick) {
179 0 : SPDK_NOTICELOG("Disconnecting host %s from subsystem %s due to keep alive timeout.\n",
180 : ctrlr->hostnqn, ctrlr->subsys->subnqn);
181 : /* set the Controller Fatal Status bit to '1' */
182 0 : if (ctrlr->vcprop.csts.bits.cfs == 0) {
183 0 : nvmf_ctrlr_set_fatal_status(ctrlr);
184 :
185 : /*
186 : * disconnect qpairs, terminate Transport connection
187 : * destroy ctrlr, break the host to controller association
188 : * disconnect qpairs with qpair->ctrlr == ctrlr
189 : */
190 0 : spdk_for_each_channel(ctrlr->subsys->tgt,
191 : nvmf_ctrlr_disconnect_qpairs_on_pg,
192 : ctrlr,
193 : nvmf_ctrlr_disconnect_qpairs_done);
194 0 : return SPDK_POLLER_BUSY;
195 : }
196 : }
197 :
198 0 : return SPDK_POLLER_IDLE;
199 : }
200 :
201 : static void
202 5 : nvmf_ctrlr_start_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr)
203 : {
204 5 : if (!ctrlr) {
205 0 : SPDK_ERRLOG("Controller is NULL\n");
206 0 : return;
207 : }
208 :
209 : /* if cleared to 0 then the Keep Alive Timer is disabled */
210 5 : if (ctrlr->feat.keep_alive_timer.bits.kato != 0) {
211 :
212 4 : ctrlr->last_keep_alive_tick = spdk_get_ticks();
213 :
214 4 : SPDK_DEBUGLOG(nvmf, "Ctrlr add keep alive poller\n");
215 4 : ctrlr->keep_alive_poller = SPDK_POLLER_REGISTER(nvmf_ctrlr_keep_alive_poll, ctrlr,
216 : ctrlr->feat.keep_alive_timer.bits.kato * 1000);
217 : }
218 : }
219 :
220 : static void
221 14 : nvmf_qpair_set_ctrlr(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_ctrlr *ctrlr)
222 : {
223 14 : if (qpair->ctrlr != NULL) {
224 : /* Admin queues will call this function twice. */
225 6 : assert(qpair->ctrlr == ctrlr);
226 6 : return;
227 : }
228 :
229 8 : qpair->ctrlr = ctrlr;
230 8 : spdk_trace_owner_append_description(qpair->trace_id,
231 8 : spdk_nvmf_subsystem_get_nqn(ctrlr->subsys));
232 : }
233 :
234 : static int _retry_qid_check(void *ctx);
235 :
236 : static void
237 7 : nvmf_ctrlr_send_connect_rsp(void *ctx)
238 : {
239 7 : struct spdk_nvmf_request *req = ctx;
240 7 : struct spdk_nvmf_qpair *qpair = req->qpair;
241 7 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
242 7 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
243 : int rc;
244 :
245 : /* The qpair might have been disconnected in the meantime */
246 7 : assert(qpair->state == SPDK_NVMF_QPAIR_CONNECTING ||
247 : qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING);
248 7 : if (qpair->state == SPDK_NVMF_QPAIR_CONNECTING) {
249 7 : if (nvmf_subsystem_host_auth_required(ctrlr->subsys, ctrlr->hostnqn)) {
250 0 : rc = nvmf_qpair_auth_init(qpair);
251 0 : if (rc != 0) {
252 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
253 0 : rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
254 0 : spdk_nvmf_request_complete(req);
255 0 : spdk_nvmf_qpair_disconnect(qpair);
256 0 : return;
257 : }
258 0 : rsp->status_code_specific.success.authreq.atr = 1;
259 0 : nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_AUTHENTICATING);
260 : } else {
261 7 : nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_ENABLED);
262 : }
263 : }
264 :
265 7 : SPDK_DEBUGLOG(nvmf, "connect capsule response: cntlid = 0x%04x\n", ctrlr->cntlid);
266 :
267 7 : assert(spdk_get_thread() == qpair->group->thread);
268 7 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
269 7 : rsp->status_code_specific.success.cntlid = ctrlr->cntlid;
270 7 : spdk_nvmf_request_complete(req);
271 : }
272 :
273 : static void
274 10 : nvmf_ctrlr_add_qpair(struct spdk_nvmf_qpair *qpair,
275 : struct spdk_nvmf_ctrlr *ctrlr,
276 : struct spdk_nvmf_request *req)
277 : {
278 10 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
279 :
280 10 : if (!ctrlr->admin_qpair) {
281 0 : SPDK_ERRLOG("Inactive admin qpair\n");
282 0 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
283 0 : rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
284 0 : qpair->connect_req = NULL;
285 0 : qpair->ctrlr = NULL;
286 0 : spdk_nvmf_request_complete(req);
287 0 : return;
288 : }
289 :
290 10 : assert(ctrlr->admin_qpair->group->thread == spdk_get_thread());
291 :
292 10 : if (spdk_bit_array_get(ctrlr->qpair_mask, qpair->qid)) {
293 3 : if (qpair->connect_req != NULL) {
294 1 : SPDK_ERRLOG("Got I/O connect with duplicate QID %u (cntlid:%u)\n",
295 : qpair->qid, ctrlr->cntlid);
296 1 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
297 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
298 1 : qpair->connect_req = NULL;
299 1 : qpair->ctrlr = NULL;
300 1 : spdk_nvmf_request_complete(req);
301 : } else {
302 2 : SPDK_WARNLOG("Duplicate QID detected (cntlid:%u, qid:%u), re-check in %dus\n",
303 : ctrlr->cntlid, qpair->qid, DUPLICATE_QID_RETRY_US);
304 2 : qpair->connect_req = req;
305 : /* Set qpair->ctrlr here so that we'll have it when the poller expires. */
306 2 : nvmf_qpair_set_ctrlr(qpair, ctrlr);
307 2 : req->poller = SPDK_POLLER_REGISTER(_retry_qid_check, qpair,
308 : DUPLICATE_QID_RETRY_US);
309 : }
310 3 : return;
311 : }
312 :
313 : SPDK_DTRACE_PROBE4_TICKS(nvmf_ctrlr_add_qpair, qpair, qpair->qid, ctrlr->subsys->subnqn,
314 : ctrlr->hostnqn);
315 7 : nvmf_qpair_set_ctrlr(qpair, ctrlr);
316 7 : spdk_bit_array_set(ctrlr->qpair_mask, qpair->qid);
317 7 : SPDK_DEBUGLOG(nvmf, "qpair_mask set, qid %u\n", qpair->qid);
318 :
319 7 : spdk_thread_send_msg(qpair->group->thread, nvmf_ctrlr_send_connect_rsp, req);
320 : }
321 :
322 : static int
323 2 : _retry_qid_check(void *ctx)
324 : {
325 2 : struct spdk_nvmf_qpair *qpair = ctx;
326 2 : struct spdk_nvmf_request *req = qpair->connect_req;
327 2 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
328 :
329 2 : spdk_poller_unregister(&req->poller);
330 2 : SPDK_WARNLOG("Retrying adding qpair, qid:%d\n", qpair->qid);
331 2 : nvmf_ctrlr_add_qpair(qpair, ctrlr, req);
332 2 : return SPDK_POLLER_BUSY;
333 : }
334 :
335 : static void
336 5 : _nvmf_ctrlr_add_admin_qpair(void *ctx)
337 : {
338 5 : struct spdk_nvmf_request *req = ctx;
339 5 : struct spdk_nvmf_qpair *qpair = req->qpair;
340 5 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
341 :
342 5 : ctrlr->admin_qpair = qpair;
343 5 : ctrlr->association_timeout = qpair->transport->opts.association_timeout;
344 5 : nvmf_ctrlr_start_keep_alive_timer(ctrlr);
345 5 : nvmf_ctrlr_add_qpair(qpair, ctrlr, req);
346 5 : }
347 :
348 : static void
349 5 : _nvmf_subsystem_add_ctrlr(void *ctx)
350 : {
351 5 : struct spdk_nvmf_request *req = ctx;
352 5 : struct spdk_nvmf_qpair *qpair = req->qpair;
353 5 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
354 5 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
355 :
356 5 : if (nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) {
357 0 : SPDK_ERRLOG("Unable to add controller to subsystem\n");
358 0 : spdk_bit_array_free(&ctrlr->qpair_mask);
359 0 : free(ctrlr);
360 0 : qpair->ctrlr = NULL;
361 0 : rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
362 0 : spdk_nvmf_request_complete(req);
363 0 : return;
364 : }
365 :
366 5 : spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_admin_qpair, req);
367 : }
368 :
369 : static void
370 6 : nvmf_ctrlr_cdata_init(struct spdk_nvmf_transport *transport, struct spdk_nvmf_subsystem *subsystem,
371 : struct spdk_nvmf_ctrlr_data *cdata)
372 : {
373 6 : cdata->aerl = SPDK_NVMF_MAX_ASYNC_EVENTS - 1;
374 6 : cdata->kas = KAS_DEFAULT_VALUE;
375 6 : cdata->vid = SPDK_PCI_VID_INTEL;
376 6 : cdata->ssvid = SPDK_PCI_VID_INTEL;
377 : /* INTEL OUI */
378 6 : cdata->ieee[0] = 0xe4;
379 6 : cdata->ieee[1] = 0xd2;
380 6 : cdata->ieee[2] = 0x5c;
381 6 : cdata->oncs.compare = 1;
382 6 : cdata->oncs.dsm = 1;
383 6 : cdata->oncs.write_zeroes = 1;
384 6 : cdata->oncs.reservations = 1;
385 6 : cdata->oncs.copy = 1;
386 6 : cdata->fuses.compare_and_write = 1;
387 6 : cdata->sgls.supported = 1;
388 6 : cdata->sgls.keyed_sgl = 1;
389 6 : cdata->sgls.sgl_offset = 1;
390 6 : cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16;
391 6 : cdata->nvmf_specific.ioccsz += transport->opts.in_capsule_data_size / 16;
392 6 : cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16;
393 6 : cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */
394 6 : cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC;
395 6 : cdata->nvmf_specific.msdbd = 1;
396 :
397 6 : if (transport->ops->cdata_init) {
398 0 : transport->ops->cdata_init(transport, subsystem, cdata);
399 : }
400 6 : }
401 :
402 : static bool
403 5 : nvmf_subsystem_has_zns_iocs(struct spdk_nvmf_subsystem *subsystem)
404 : {
405 : struct spdk_nvmf_ns *ns;
406 : uint32_t i;
407 :
408 9 : for (i = 0; i < subsystem->max_nsid; i++) {
409 4 : ns = subsystem->ns[i];
410 4 : if (ns && ns->bdev && spdk_bdev_is_zoned(ns->bdev)) {
411 0 : return true;
412 : }
413 : }
414 5 : return false;
415 : }
416 :
417 : static void
418 9 : nvmf_ctrlr_init_visible_ns(struct spdk_nvmf_ctrlr *ctrlr)
419 : {
420 9 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
421 : struct spdk_nvmf_ns *ns;
422 :
423 17 : for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL;
424 8 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
425 8 : if (ns->always_visible || nvmf_ns_find_host(ns, ctrlr->hostnqn) != NULL) {
426 3 : spdk_bit_array_set(ctrlr->visible_ns, ns->nsid - 1);
427 : }
428 : }
429 9 : }
430 :
431 : static struct spdk_nvmf_ctrlr *
432 5 : nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem,
433 : struct spdk_nvmf_request *req,
434 : struct spdk_nvmf_fabric_connect_cmd *connect_cmd,
435 : struct spdk_nvmf_fabric_connect_data *connect_data)
436 : {
437 : struct spdk_nvmf_ctrlr *ctrlr;
438 5 : struct spdk_nvmf_transport *transport = req->qpair->transport;
439 5 : struct spdk_nvme_transport_id listen_trid = {};
440 5 : bool subsys_has_multi_iocs = false;
441 :
442 5 : ctrlr = calloc(1, sizeof(*ctrlr));
443 5 : if (ctrlr == NULL) {
444 0 : SPDK_ERRLOG("Memory allocation failed\n");
445 0 : return NULL;
446 : }
447 :
448 5 : if (spdk_nvme_trtype_is_fabrics(transport->ops->type)) {
449 5 : ctrlr->dynamic_ctrlr = true;
450 : } else {
451 0 : ctrlr->cntlid = connect_data->cntlid;
452 : }
453 :
454 : SPDK_DTRACE_PROBE3_TICKS(nvmf_ctrlr_create, ctrlr, subsystem->subnqn,
455 : spdk_thread_get_id(req->qpair->group->thread));
456 :
457 5 : STAILQ_INIT(&ctrlr->async_events);
458 5 : TAILQ_INIT(&ctrlr->log_head);
459 5 : ctrlr->subsys = subsystem;
460 5 : ctrlr->thread = req->qpair->group->thread;
461 5 : ctrlr->disconnect_in_progress = false;
462 :
463 5 : ctrlr->qpair_mask = spdk_bit_array_create(transport->opts.max_qpairs_per_ctrlr);
464 5 : if (!ctrlr->qpair_mask) {
465 0 : SPDK_ERRLOG("Failed to allocate controller qpair mask\n");
466 0 : goto err_qpair_mask;
467 : }
468 :
469 5 : nvmf_ctrlr_cdata_init(transport, subsystem, &ctrlr->cdata);
470 :
471 : /*
472 : * KAS: This field indicates the granularity of the Keep Alive Timer in 100ms units.
473 : * If this field is cleared to 0h, then Keep Alive is not supported.
474 : */
475 5 : if (ctrlr->cdata.kas) {
476 5 : ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up(connect_cmd->kato,
477 : KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) *
478 : KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS;
479 : }
480 :
481 5 : ctrlr->feat.async_event_configuration.bits.ns_attr_notice = 1;
482 5 : if (ctrlr->subsys->flags.ana_reporting) {
483 0 : ctrlr->feat.async_event_configuration.bits.ana_change_notice = 1;
484 : }
485 5 : ctrlr->feat.volatile_write_cache.bits.wce = 1;
486 : /* Coalescing Disable */
487 5 : ctrlr->feat.interrupt_vector_configuration.bits.cd = 1;
488 :
489 5 : if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) {
490 : /*
491 : * If keep-alive timeout is not set, discovery controllers use some
492 : * arbitrary high value in order to cleanup stale discovery sessions
493 : *
494 : * From the 1.0a nvme-of spec:
495 : * "The Keep Alive command is reserved for
496 : * Discovery controllers. A transport may specify a
497 : * fixed Discovery controller activity timeout value
498 : * (e.g., 2 minutes). If no commands are received
499 : * by a Discovery controller within that time
500 : * period, the controller may perform the
501 : * actions for Keep Alive Timer expiration".
502 : *
503 : * From the 1.1 nvme-of spec:
504 : * "A host requests an explicit persistent connection
505 : * to a Discovery controller and Asynchronous Event Notifications from
506 : * the Discovery controller on that persistent connection by specifying
507 : * a non-zero Keep Alive Timer value in the Connect command."
508 : *
509 : * In case non-zero KATO is used, we enable discovery_log_change_notice
510 : * otherwise we disable it and use default discovery controller KATO.
511 : * KATO is in millisecond.
512 : */
513 2 : if (ctrlr->feat.keep_alive_timer.bits.kato == 0) {
514 1 : ctrlr->feat.keep_alive_timer.bits.kato = NVMF_DISC_KATO_IN_MS;
515 1 : ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice = 0;
516 : } else {
517 1 : ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice = 1;
518 : }
519 : }
520 :
521 : /* Subtract 1 for admin queue, 1 for 0's based */
522 5 : ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 -
523 : 1;
524 5 : ctrlr->feat.number_of_queues.bits.nsqr = transport->opts.max_qpairs_per_ctrlr - 1 -
525 : 1;
526 :
527 5 : spdk_uuid_copy(&ctrlr->hostid, (struct spdk_uuid *)connect_data->hostid);
528 5 : memcpy(ctrlr->hostnqn, connect_data->hostnqn, SPDK_NVMF_NQN_MAX_LEN);
529 :
530 5 : ctrlr->visible_ns = spdk_bit_array_create(subsystem->max_nsid);
531 5 : if (!ctrlr->visible_ns) {
532 0 : SPDK_ERRLOG("Failed to allocate visible namespace array\n");
533 0 : goto err_visible_ns;
534 : }
535 5 : nvmf_ctrlr_init_visible_ns(ctrlr);
536 :
537 5 : ctrlr->vcprop.cap.raw = 0;
538 5 : ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */
539 5 : ctrlr->vcprop.cap.bits.mqes = transport->opts.max_queue_depth -
540 : 1; /* max queue depth */
541 5 : ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */
542 : /* ready timeout - 500 msec units */
543 5 : ctrlr->vcprop.cap.bits.to = NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS / 500;
544 5 : ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */
545 5 : subsys_has_multi_iocs = nvmf_subsystem_has_zns_iocs(subsystem);
546 5 : if (subsys_has_multi_iocs) {
547 0 : ctrlr->vcprop.cap.bits.css =
548 : SPDK_NVME_CAP_CSS_IOCS; /* One or more I/O command sets supported */
549 : } else {
550 5 : ctrlr->vcprop.cap.bits.css = SPDK_NVME_CAP_CSS_NVM; /* NVM command set */
551 : }
552 :
553 5 : ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */
554 5 : ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */
555 :
556 : /* Version Supported: 1.3 */
557 5 : ctrlr->vcprop.vs.bits.mjr = 1;
558 5 : ctrlr->vcprop.vs.bits.mnr = 3;
559 5 : ctrlr->vcprop.vs.bits.ter = 0;
560 :
561 5 : ctrlr->vcprop.cc.raw = 0;
562 5 : ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */
563 5 : if (subsys_has_multi_iocs) {
564 0 : ctrlr->vcprop.cc.bits.css =
565 : SPDK_NVME_CC_CSS_IOCS; /* All supported I/O Command Sets */
566 : }
567 :
568 5 : ctrlr->vcprop.csts.raw = 0;
569 5 : ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */
570 :
571 5 : SPDK_DEBUGLOG(nvmf, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw);
572 5 : SPDK_DEBUGLOG(nvmf, "vs 0x%x\n", ctrlr->vcprop.vs.raw);
573 5 : SPDK_DEBUGLOG(nvmf, "cc 0x%x\n", ctrlr->vcprop.cc.raw);
574 5 : SPDK_DEBUGLOG(nvmf, "csts 0x%x\n", ctrlr->vcprop.csts.raw);
575 :
576 5 : ctrlr->dif_insert_or_strip = transport->opts.dif_insert_or_strip;
577 :
578 5 : if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_NVME) {
579 3 : if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &listen_trid) != 0) {
580 0 : SPDK_ERRLOG("Could not get listener transport ID\n");
581 0 : goto err_listener;
582 : }
583 :
584 3 : ctrlr->listener = nvmf_subsystem_find_listener(ctrlr->subsys, &listen_trid);
585 3 : if (!ctrlr->listener) {
586 0 : SPDK_ERRLOG("Listener was not found\n");
587 0 : goto err_listener;
588 : }
589 : }
590 :
591 5 : nvmf_qpair_set_ctrlr(req->qpair, ctrlr);
592 5 : spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_add_ctrlr, req);
593 :
594 5 : return ctrlr;
595 0 : err_listener:
596 0 : spdk_bit_array_free(&ctrlr->visible_ns);
597 0 : err_visible_ns:
598 0 : spdk_bit_array_free(&ctrlr->qpair_mask);
599 0 : err_qpair_mask:
600 0 : free(ctrlr);
601 0 : return NULL;
602 : }
603 :
604 : static void
605 1 : _nvmf_ctrlr_destruct(void *ctx)
606 : {
607 1 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
608 : struct spdk_nvmf_reservation_log *log, *log_tmp;
609 : struct spdk_nvmf_async_event_completion *event, *event_tmp;
610 :
611 : SPDK_DTRACE_PROBE3_TICKS(nvmf_ctrlr_destruct, ctrlr, ctrlr->subsys->subnqn,
612 : spdk_thread_get_id(ctrlr->thread));
613 :
614 1 : assert(spdk_get_thread() == ctrlr->thread);
615 1 : assert(ctrlr->in_destruct);
616 :
617 1 : SPDK_DEBUGLOG(nvmf, "Destroy ctrlr 0x%hx\n", ctrlr->cntlid);
618 1 : if (ctrlr->disconnect_in_progress) {
619 0 : SPDK_ERRLOG("freeing ctrlr with disconnect in progress\n");
620 0 : spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_destruct, ctrlr);
621 0 : return;
622 : }
623 :
624 1 : nvmf_ctrlr_stop_keep_alive_timer(ctrlr);
625 1 : nvmf_ctrlr_stop_association_timer(ctrlr);
626 1 : spdk_bit_array_free(&ctrlr->qpair_mask);
627 :
628 1 : TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) {
629 0 : TAILQ_REMOVE(&ctrlr->log_head, log, link);
630 0 : free(log);
631 : }
632 1 : STAILQ_FOREACH_SAFE(event, &ctrlr->async_events, link, event_tmp) {
633 0 : STAILQ_REMOVE(&ctrlr->async_events, event, spdk_nvmf_async_event_completion, link);
634 0 : free(event);
635 : }
636 1 : spdk_bit_array_free(&ctrlr->visible_ns);
637 1 : free(ctrlr);
638 : }
639 :
640 : void
641 1 : nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr)
642 : {
643 1 : nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr);
644 :
645 1 : spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_destruct, ctrlr);
646 1 : }
647 :
648 : static void
649 8 : nvmf_ctrlr_add_io_qpair(void *ctx)
650 : {
651 8 : struct spdk_nvmf_request *req = ctx;
652 8 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
653 8 : struct spdk_nvmf_qpair *qpair = req->qpair;
654 8 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
655 8 : struct spdk_nvmf_qpair *admin_qpair = ctrlr->admin_qpair;
656 8 : struct spdk_nvmf_poll_group *admin_qpair_group = NULL;
657 8 : enum spdk_nvmf_qpair_state admin_qpair_state = SPDK_NVMF_QPAIR_UNINITIALIZED;
658 8 : bool admin_qpair_active = false;
659 :
660 : SPDK_DTRACE_PROBE4_TICKS(nvmf_ctrlr_add_io_qpair, ctrlr, req->qpair, req->qpair->qid,
661 : spdk_thread_get_id(ctrlr->thread));
662 :
663 : /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect.
664 : * For error case, the value should be NULL. So set it to NULL at first.
665 : */
666 8 : qpair->ctrlr = NULL;
667 :
668 : /* Make sure the controller is not being destroyed. */
669 8 : if (ctrlr->in_destruct) {
670 0 : SPDK_ERRLOG("Got I/O connect while ctrlr was being destroyed.\n");
671 0 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
672 0 : goto end;
673 : }
674 :
675 8 : if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) {
676 1 : SPDK_ERRLOG("I/O connect not allowed on discovery controller\n");
677 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
678 1 : goto end;
679 : }
680 :
681 7 : if (!ctrlr->vcprop.cc.bits.en) {
682 1 : SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n");
683 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
684 1 : goto end;
685 : }
686 :
687 6 : if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) {
688 1 : SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n",
689 : ctrlr->vcprop.cc.bits.iosqes);
690 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
691 1 : goto end;
692 : }
693 :
694 5 : if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) {
695 1 : SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n",
696 : ctrlr->vcprop.cc.bits.iocqes);
697 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
698 1 : goto end;
699 : }
700 :
701 : /* There is a chance that admin qpair was destroyed. This is an issue that was observed only with ESX initiators */
702 4 : if (admin_qpair) {
703 4 : admin_qpair_active = spdk_nvmf_qpair_is_active(admin_qpair);
704 4 : admin_qpair_group = admin_qpair->group;
705 4 : admin_qpair_state = admin_qpair->state;
706 : }
707 :
708 4 : if (!admin_qpair_active || admin_qpair_group == NULL) {
709 : /* There is a chance that admin qpair was destroyed or is being destroyed at this moment due to e.g.
710 : * expired keep alive timer. Part of the qpair destruction process is change of qpair's
711 : * state to DEACTIVATING and removing it from poll group */
712 0 : SPDK_ERRLOG("Inactive admin qpair (state %d, group %p)\n", admin_qpair_state, admin_qpair_group);
713 0 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
714 0 : goto end;
715 : }
716 :
717 : /* check if we would exceed ctrlr connection limit */
718 4 : if (qpair->qid >= spdk_bit_array_capacity(ctrlr->qpair_mask)) {
719 1 : SPDK_ERRLOG("Requested QID %u but Max QID is %u\n",
720 : qpair->qid, spdk_bit_array_capacity(ctrlr->qpair_mask) - 1);
721 1 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
722 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER;
723 1 : goto end;
724 : }
725 :
726 3 : nvmf_ctrlr_add_qpair(qpair, ctrlr, req);
727 3 : return;
728 5 : end:
729 5 : spdk_nvmf_request_complete(req);
730 : }
731 :
732 : static void
733 11 : _nvmf_ctrlr_add_io_qpair(void *ctx)
734 : {
735 11 : struct spdk_nvmf_request *req = ctx;
736 11 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
737 : struct spdk_nvmf_fabric_connect_data *data;
738 : struct spdk_nvmf_ctrlr *ctrlr;
739 11 : struct spdk_nvmf_qpair *qpair = req->qpair;
740 : struct spdk_nvmf_qpair *admin_qpair;
741 11 : struct spdk_nvmf_tgt *tgt = qpair->transport->tgt;
742 : struct spdk_nvmf_subsystem *subsystem;
743 11 : struct spdk_nvme_transport_id listen_trid = {};
744 : const struct spdk_nvmf_subsystem_listener *listener;
745 11 : struct spdk_nvmf_poll_group *admin_qpair_group = NULL;
746 11 : enum spdk_nvmf_qpair_state admin_qpair_state = SPDK_NVMF_QPAIR_UNINITIALIZED;
747 11 : bool admin_qpair_active = false;
748 :
749 11 : assert(req->iovcnt == 1);
750 :
751 11 : data = req->iov[0].iov_base;
752 :
753 11 : SPDK_DEBUGLOG(nvmf, "Connect I/O Queue for controller id 0x%x\n", data->cntlid);
754 :
755 11 : subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn);
756 : /* We already checked this in spdk_nvmf_ctrlr_connect */
757 11 : assert(subsystem != NULL);
758 :
759 11 : ctrlr = nvmf_subsystem_get_ctrlr(subsystem, data->cntlid);
760 11 : if (ctrlr == NULL) {
761 1 : SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid);
762 1 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid);
763 1 : spdk_nvmf_request_complete(req);
764 1 : return;
765 : }
766 :
767 : /* fail before passing a message to the controller thread. */
768 10 : if (ctrlr->in_destruct) {
769 0 : SPDK_ERRLOG("Got I/O connect while ctrlr was being destroyed.\n");
770 0 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
771 0 : spdk_nvmf_request_complete(req);
772 0 : return;
773 : }
774 :
775 : /* If ANA reporting is enabled, check if I/O connect is on the same listener. */
776 10 : if (subsystem->flags.ana_reporting) {
777 0 : if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &listen_trid) != 0) {
778 0 : SPDK_ERRLOG("Could not get listener transport ID\n");
779 0 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
780 0 : spdk_nvmf_request_complete(req);
781 0 : return;
782 : }
783 :
784 0 : listener = nvmf_subsystem_find_listener(subsystem, &listen_trid);
785 0 : if (listener != ctrlr->listener) {
786 0 : SPDK_ERRLOG("I/O connect is on a listener different from admin connect\n");
787 0 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
788 0 : spdk_nvmf_request_complete(req);
789 0 : return;
790 : }
791 : }
792 :
793 10 : admin_qpair = ctrlr->admin_qpair;
794 :
795 : /* There is a chance that admin qpair was destroyed. This is an issue that was observed only with ESX initiators */
796 10 : if (admin_qpair) {
797 9 : admin_qpair_active = spdk_nvmf_qpair_is_active(admin_qpair);
798 9 : admin_qpair_group = admin_qpair->group;
799 9 : admin_qpair_state = admin_qpair->state;
800 : }
801 :
802 10 : if (!admin_qpair_active || admin_qpair_group == NULL) {
803 : /* There is a chance that admin qpair was destroyed or is being destroyed at this moment due to e.g.
804 : * expired keep alive timer. Part of the qpair destruction process is change of qpair's
805 : * state to DEACTIVATING and removing it from poll group */
806 2 : SPDK_ERRLOG("Inactive admin qpair (state %d, group %p)\n", admin_qpair_state, admin_qpair_group);
807 2 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid);
808 2 : spdk_nvmf_request_complete(req);
809 2 : return;
810 : }
811 8 : qpair->ctrlr = ctrlr;
812 8 : spdk_thread_send_msg(admin_qpair_group->thread, nvmf_ctrlr_add_io_qpair, req);
813 : }
814 :
815 : static bool
816 21 : nvmf_qpair_access_allowed(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_subsystem *subsystem,
817 : const char *hostnqn)
818 : {
819 21 : struct spdk_nvme_transport_id listen_trid = {};
820 :
821 21 : if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) {
822 1 : SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subsystem->subnqn, hostnqn);
823 1 : return false;
824 : }
825 :
826 20 : if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid)) {
827 0 : SPDK_ERRLOG("Subsystem '%s' is unable to enforce access control due to an internal error.\n",
828 : subsystem->subnqn);
829 0 : return false;
830 : }
831 :
832 20 : if (!spdk_nvmf_subsystem_listener_allowed(subsystem, &listen_trid)) {
833 0 : SPDK_ERRLOG("Subsystem '%s' does not allow host '%s' to connect at this address.\n",
834 : subsystem->subnqn, hostnqn);
835 0 : return false;
836 : }
837 :
838 20 : return true;
839 : }
840 :
841 : static int
842 20 : _nvmf_ctrlr_connect(struct spdk_nvmf_request *req)
843 : {
844 20 : struct spdk_nvmf_fabric_connect_data *data = req->iov[0].iov_base;
845 20 : struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd;
846 20 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
847 20 : struct spdk_nvmf_qpair *qpair = req->qpair;
848 20 : struct spdk_nvmf_transport *transport = qpair->transport;
849 : struct spdk_nvmf_ctrlr *ctrlr;
850 : struct spdk_nvmf_subsystem *subsystem;
851 :
852 20 : SPDK_DEBUGLOG(nvmf, "recfmt 0x%x qid %u sqsize %u\n",
853 : cmd->recfmt, cmd->qid, cmd->sqsize);
854 :
855 20 : SPDK_DEBUGLOG(nvmf, "Connect data:\n");
856 20 : SPDK_DEBUGLOG(nvmf, " cntlid: 0x%04x\n", data->cntlid);
857 20 : SPDK_DEBUGLOG(nvmf, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n",
858 : ntohl(*(uint32_t *)&data->hostid[0]),
859 : ntohs(*(uint16_t *)&data->hostid[4]),
860 : ntohs(*(uint16_t *)&data->hostid[6]),
861 : data->hostid[8],
862 : data->hostid[9],
863 : ntohs(*(uint16_t *)&data->hostid[10]),
864 : ntohl(*(uint32_t *)&data->hostid[12]));
865 20 : SPDK_DEBUGLOG(nvmf, " subnqn: \"%s\"\n", data->subnqn);
866 20 : SPDK_DEBUGLOG(nvmf, " hostnqn: \"%s\"\n", data->hostnqn);
867 :
868 20 : subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn);
869 20 : if (!subsystem) {
870 0 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn);
871 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
872 : }
873 :
874 20 : if (cmd->recfmt != 0) {
875 1 : SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt);
876 1 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
877 1 : rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT;
878 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
879 : }
880 :
881 : /*
882 : * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and
883 : * strictly less than max_aq_depth (admin queues) or max_queue_depth (io queues).
884 : */
885 19 : if (cmd->sqsize == 0) {
886 1 : SPDK_ERRLOG("Invalid SQSIZE = 0\n");
887 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize);
888 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
889 : }
890 :
891 18 : if (cmd->qid == 0) {
892 6 : if (cmd->sqsize >= transport->opts.max_aq_depth) {
893 1 : SPDK_ERRLOG("Invalid SQSIZE for admin queue %u (min 1, max %u)\n",
894 : cmd->sqsize, transport->opts.max_aq_depth - 1);
895 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize);
896 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
897 : }
898 12 : } else if (cmd->sqsize >= transport->opts.max_queue_depth) {
899 1 : SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n",
900 : cmd->sqsize, transport->opts.max_queue_depth - 1);
901 1 : SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize);
902 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
903 : }
904 :
905 16 : qpair->sq_head_max = cmd->sqsize;
906 16 : qpair->qid = cmd->qid;
907 16 : qpair->connect_received = true;
908 :
909 16 : pthread_mutex_lock(&qpair->group->mutex);
910 16 : qpair->group->current_unassociated_qpairs--;
911 16 : pthread_mutex_unlock(&qpair->group->mutex);
912 :
913 16 : if (0 == qpair->qid) {
914 5 : qpair->group->stat.admin_qpairs++;
915 5 : qpair->group->stat.current_admin_qpairs++;
916 : } else {
917 11 : qpair->group->stat.io_qpairs++;
918 11 : qpair->group->stat.current_io_qpairs++;
919 : }
920 :
921 16 : if (cmd->qid == 0) {
922 5 : SPDK_DEBUGLOG(nvmf, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid);
923 :
924 5 : if (spdk_nvme_trtype_is_fabrics(transport->ops->type) && data->cntlid != 0xFFFF) {
925 : /* This NVMf target only supports dynamic mode. */
926 1 : SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid);
927 1 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid);
928 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
929 : }
930 :
931 : /* Establish a new ctrlr */
932 4 : ctrlr = nvmf_ctrlr_create(subsystem, req, cmd, data);
933 4 : if (!ctrlr) {
934 0 : SPDK_ERRLOG("nvmf_ctrlr_create() failed\n");
935 0 : rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
936 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
937 : } else {
938 4 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
939 : }
940 : } else {
941 11 : spdk_thread_send_msg(subsystem->thread, _nvmf_ctrlr_add_io_qpair, req);
942 11 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
943 : }
944 : }
945 :
946 : static struct spdk_nvmf_subsystem_poll_group *
947 9 : nvmf_subsystem_pg_from_connect_cmd(struct spdk_nvmf_request *req)
948 : {
949 : struct spdk_nvmf_fabric_connect_data *data;
950 : struct spdk_nvmf_subsystem *subsystem;
951 : struct spdk_nvmf_tgt *tgt;
952 :
953 9 : assert(nvmf_request_is_fabric_connect(req));
954 9 : assert(req->qpair->ctrlr == NULL);
955 9 : assert(req->iovcnt == 1);
956 :
957 9 : data = req->iov[0].iov_base;
958 9 : tgt = req->qpair->transport->tgt;
959 :
960 9 : subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn);
961 9 : if (subsystem == NULL) {
962 0 : return NULL;
963 : }
964 :
965 9 : return &req->qpair->group->sgroups[subsystem->id];
966 : }
967 :
968 : int
969 0 : spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req)
970 : {
971 0 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
972 : struct spdk_nvmf_subsystem_poll_group *sgroup;
973 0 : struct spdk_nvmf_qpair *qpair = req->qpair;
974 : enum spdk_nvmf_request_exec_status status;
975 :
976 0 : if (req->iovcnt > 1) {
977 0 : SPDK_ERRLOG("Connect command invalid iovcnt: %d\n", req->iovcnt);
978 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
979 0 : status = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
980 0 : goto out;
981 : }
982 :
983 0 : sgroup = nvmf_subsystem_pg_from_connect_cmd(req);
984 0 : if (!sgroup) {
985 0 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn);
986 0 : status = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
987 0 : goto out;
988 : }
989 :
990 0 : sgroup->mgmt_io_outstanding++;
991 0 : TAILQ_INSERT_TAIL(&qpair->outstanding, req, link);
992 :
993 0 : status = _nvmf_ctrlr_connect(req);
994 :
995 0 : out:
996 0 : if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) {
997 0 : _nvmf_request_complete(req);
998 : }
999 :
1000 0 : return status;
1001 : }
1002 :
1003 : static int
1004 24 : nvmf_ctrlr_cmd_connect(struct spdk_nvmf_request *req)
1005 : {
1006 24 : struct spdk_nvmf_fabric_connect_data *data = req->iov[0].iov_base;
1007 24 : struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp;
1008 24 : struct spdk_nvmf_transport *transport = req->qpair->transport;
1009 : struct spdk_nvmf_subsystem *subsystem;
1010 :
1011 24 : if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) {
1012 1 : SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length);
1013 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1014 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1015 : }
1016 :
1017 23 : if (req->iovcnt > 1) {
1018 0 : SPDK_ERRLOG("Connect command invalid iovcnt: %d\n", req->iovcnt);
1019 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1020 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1021 : }
1022 :
1023 23 : subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn);
1024 23 : if (!subsystem) {
1025 1 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn);
1026 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1027 : }
1028 :
1029 22 : if ((subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE) ||
1030 22 : (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSING) ||
1031 22 : (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED) ||
1032 22 : (subsystem->state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING)) {
1033 : struct spdk_nvmf_subsystem_poll_group *sgroup;
1034 :
1035 : /* Subsystem is not ready to handle a connect. Decrement
1036 : * the mgmt_io_outstanding to avoid the subsystem waiting
1037 : * for this command to complete before unpausing. Queued
1038 : * requests get retried when subsystem resumes.
1039 : */
1040 0 : sgroup = nvmf_subsystem_pg_from_connect_cmd(req);
1041 0 : assert(sgroup != NULL);
1042 0 : sgroup->mgmt_io_outstanding--;
1043 0 : TAILQ_REMOVE(&req->qpair->outstanding, req, link);
1044 0 : TAILQ_INSERT_TAIL(&sgroup->queued, req, link);
1045 0 : SPDK_DEBUGLOG(nvmf, "Subsystem '%s' is not ready for connect, retrying...\n", subsystem->subnqn);
1046 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
1047 : }
1048 :
1049 : /* Ensure that hostnqn is null terminated */
1050 22 : if (!memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1)) {
1051 1 : SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n");
1052 1 : SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn);
1053 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1054 : }
1055 :
1056 21 : if (!nvmf_qpair_access_allowed(req->qpair, subsystem, data->hostnqn)) {
1057 1 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1058 1 : rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST;
1059 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1060 : }
1061 :
1062 20 : return _nvmf_ctrlr_connect(req);
1063 : }
1064 :
1065 : static int
1066 0 : nvmf_ctrlr_association_remove(void *ctx)
1067 : {
1068 0 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
1069 : int rc;
1070 :
1071 0 : nvmf_ctrlr_stop_association_timer(ctrlr);
1072 :
1073 0 : if (ctrlr->in_destruct) {
1074 0 : return SPDK_POLLER_IDLE;
1075 : }
1076 0 : SPDK_DEBUGLOG(nvmf, "Disconnecting host from subsystem %s due to association timeout.\n",
1077 : ctrlr->subsys->subnqn);
1078 :
1079 0 : if (ctrlr->admin_qpair) {
1080 0 : rc = spdk_nvmf_qpair_disconnect(ctrlr->admin_qpair);
1081 0 : if (rc < 0 && rc != -EINPROGRESS) {
1082 0 : SPDK_ERRLOG("Fail to disconnect admin ctrlr qpair\n");
1083 0 : assert(false);
1084 : }
1085 : }
1086 :
1087 0 : return SPDK_POLLER_BUSY;
1088 : }
1089 :
1090 : static int
1091 0 : _nvmf_ctrlr_cc_reset_shn_done(void *ctx)
1092 : {
1093 0 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
1094 0 : uint64_t now = spdk_get_ticks();
1095 : uint32_t count;
1096 :
1097 0 : if (ctrlr->cc_timer) {
1098 0 : spdk_poller_unregister(&ctrlr->cc_timer);
1099 : }
1100 :
1101 0 : count = spdk_bit_array_count_set(ctrlr->qpair_mask);
1102 0 : SPDK_DEBUGLOG(nvmf, "ctrlr %p active queue count %u\n", ctrlr, count);
1103 :
1104 0 : if (count > 1) {
1105 0 : if (now < ctrlr->cc_timeout_tsc) {
1106 : /* restart cc timer */
1107 0 : ctrlr->cc_timer = SPDK_POLLER_REGISTER(_nvmf_ctrlr_cc_reset_shn_done, ctrlr, 100 * 1000);
1108 0 : return SPDK_POLLER_IDLE;
1109 : } else {
1110 : /* controller fatal status */
1111 0 : SPDK_WARNLOG("IO timeout, ctrlr %p is in fatal status\n", ctrlr);
1112 0 : nvmf_ctrlr_set_fatal_status(ctrlr);
1113 : }
1114 : }
1115 :
1116 0 : spdk_poller_unregister(&ctrlr->cc_timeout_timer);
1117 :
1118 0 : if (ctrlr->disconnect_is_shn) {
1119 0 : ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE;
1120 0 : ctrlr->disconnect_is_shn = false;
1121 : } else {
1122 : /* Only a subset of the registers are cleared out on a reset */
1123 0 : ctrlr->vcprop.cc.raw = 0;
1124 0 : ctrlr->vcprop.csts.raw = 0;
1125 : }
1126 :
1127 : /* After CC.EN transitions to 0 (due to shutdown or reset), the association
1128 : * between the host and controller shall be preserved for at least 2 minutes */
1129 0 : if (ctrlr->association_timer) {
1130 0 : SPDK_DEBUGLOG(nvmf, "Association timer already set\n");
1131 0 : nvmf_ctrlr_stop_association_timer(ctrlr);
1132 : }
1133 0 : if (ctrlr->association_timeout) {
1134 0 : ctrlr->association_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_association_remove, ctrlr,
1135 : ctrlr->association_timeout * 1000);
1136 : }
1137 0 : ctrlr->disconnect_in_progress = false;
1138 0 : return SPDK_POLLER_BUSY;
1139 : }
1140 :
1141 : static void
1142 0 : nvmf_ctrlr_cc_reset_shn_done(struct spdk_io_channel_iter *i, int status)
1143 : {
1144 0 : struct spdk_nvmf_ctrlr *ctrlr = spdk_io_channel_iter_get_ctx(i);
1145 :
1146 0 : if (status < 0) {
1147 0 : SPDK_ERRLOG("Fail to disconnect io ctrlr qpairs\n");
1148 0 : assert(false);
1149 : }
1150 :
1151 0 : _nvmf_ctrlr_cc_reset_shn_done((void *)ctrlr);
1152 0 : }
1153 :
1154 : static void
1155 0 : nvmf_bdev_complete_reset(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
1156 : {
1157 0 : SPDK_NOTICELOG("Resetting bdev done with %s\n", success ? "success" : "failure");
1158 :
1159 0 : spdk_bdev_free_io(bdev_io);
1160 0 : }
1161 :
1162 :
1163 : static int
1164 0 : nvmf_ctrlr_cc_timeout(void *ctx)
1165 : {
1166 0 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
1167 : struct spdk_nvmf_poll_group *group;
1168 : struct spdk_nvmf_ns *ns;
1169 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
1170 :
1171 0 : spdk_poller_unregister(&ctrlr->cc_timeout_timer);
1172 0 : SPDK_DEBUGLOG(nvmf, "Ctrlr %p reset or shutdown timeout\n", ctrlr);
1173 :
1174 0 : if (!ctrlr->admin_qpair) {
1175 0 : SPDK_NOTICELOG("Ctrlr %p admin qpair disconnected\n", ctrlr);
1176 0 : return SPDK_POLLER_IDLE;
1177 : }
1178 :
1179 0 : group = ctrlr->admin_qpair->group;
1180 0 : assert(group != NULL && group->sgroups != NULL);
1181 :
1182 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL;
1183 0 : ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) {
1184 0 : if (ns->bdev == NULL) {
1185 0 : continue;
1186 : }
1187 0 : ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[ns->opts.nsid - 1];
1188 0 : SPDK_NOTICELOG("Ctrlr %p resetting NSID %u\n", ctrlr, ns->opts.nsid);
1189 0 : spdk_bdev_reset(ns->desc, ns_info->channel, nvmf_bdev_complete_reset, NULL);
1190 : }
1191 :
1192 0 : return SPDK_POLLER_BUSY;
1193 : }
1194 :
1195 : const struct spdk_nvmf_registers *
1196 0 : spdk_nvmf_ctrlr_get_regs(struct spdk_nvmf_ctrlr *ctrlr)
1197 : {
1198 0 : return &ctrlr->vcprop;
1199 : }
1200 :
1201 : void
1202 0 : nvmf_ctrlr_set_fatal_status(struct spdk_nvmf_ctrlr *ctrlr)
1203 : {
1204 0 : ctrlr->vcprop.csts.bits.cfs = 1;
1205 0 : }
1206 :
1207 : static uint64_t
1208 0 : nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr)
1209 : {
1210 0 : return ctrlr->vcprop.cap.raw;
1211 : }
1212 :
1213 : static uint64_t
1214 0 : nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr)
1215 : {
1216 0 : return ctrlr->vcprop.vs.raw;
1217 : }
1218 :
1219 : static uint64_t
1220 1 : nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr)
1221 : {
1222 1 : return ctrlr->vcprop.cc.raw;
1223 : }
1224 :
1225 : static bool
1226 1 : nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1227 : {
1228 : union spdk_nvme_cc_register cc, diff;
1229 : uint32_t cc_timeout_ms;
1230 :
1231 1 : cc.raw = value;
1232 :
1233 1 : SPDK_DEBUGLOG(nvmf, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw);
1234 1 : SPDK_DEBUGLOG(nvmf, "new CC: 0x%08x\n", cc.raw);
1235 :
1236 : /*
1237 : * Calculate which bits changed between the current and new CC.
1238 : * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed.
1239 : */
1240 1 : diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw;
1241 :
1242 1 : if (diff.bits.en) {
1243 0 : if (cc.bits.en) {
1244 0 : SPDK_DEBUGLOG(nvmf, "Property Set CC Enable!\n");
1245 0 : nvmf_ctrlr_stop_association_timer(ctrlr);
1246 :
1247 0 : ctrlr->vcprop.cc.bits.en = 1;
1248 0 : ctrlr->vcprop.csts.bits.rdy = 1;
1249 : } else {
1250 0 : SPDK_DEBUGLOG(nvmf, "Property Set CC Disable!\n");
1251 0 : if (ctrlr->disconnect_in_progress) {
1252 0 : SPDK_DEBUGLOG(nvmf, "Disconnect in progress\n");
1253 0 : return true;
1254 : }
1255 :
1256 0 : ctrlr->cc_timeout_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_cc_timeout, ctrlr,
1257 : NVMF_CC_RESET_SHN_TIMEOUT_IN_MS * 1000);
1258 : /* Make sure cc_timeout_ms is between cc_timeout_timer and Host reset/shutdown timeout */
1259 0 : cc_timeout_ms = (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS) / 2;
1260 0 : ctrlr->cc_timeout_tsc = spdk_get_ticks() + cc_timeout_ms * spdk_get_ticks_hz() / (uint64_t)1000;
1261 :
1262 0 : ctrlr->vcprop.cc.bits.en = 0;
1263 0 : ctrlr->disconnect_in_progress = true;
1264 0 : ctrlr->disconnect_is_shn = false;
1265 0 : spdk_for_each_channel(ctrlr->subsys->tgt,
1266 : nvmf_ctrlr_disconnect_io_qpairs_on_pg,
1267 : ctrlr,
1268 : nvmf_ctrlr_cc_reset_shn_done);
1269 : }
1270 0 : diff.bits.en = 0;
1271 : }
1272 :
1273 1 : if (diff.bits.shn) {
1274 0 : if (cc.bits.shn == SPDK_NVME_SHN_NORMAL ||
1275 0 : cc.bits.shn == SPDK_NVME_SHN_ABRUPT) {
1276 0 : SPDK_DEBUGLOG(nvmf, "Property Set CC Shutdown %u%ub!\n",
1277 : cc.bits.shn >> 1, cc.bits.shn & 1);
1278 0 : if (ctrlr->disconnect_in_progress) {
1279 0 : SPDK_DEBUGLOG(nvmf, "Disconnect in progress\n");
1280 0 : return true;
1281 : }
1282 :
1283 0 : ctrlr->cc_timeout_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_cc_timeout, ctrlr,
1284 : NVMF_CC_RESET_SHN_TIMEOUT_IN_MS * 1000);
1285 : /* Make sure cc_timeout_ms is between cc_timeout_timer and Host reset/shutdown timeout */
1286 0 : cc_timeout_ms = (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS) / 2;
1287 0 : ctrlr->cc_timeout_tsc = spdk_get_ticks() + cc_timeout_ms * spdk_get_ticks_hz() / (uint64_t)1000;
1288 :
1289 0 : ctrlr->vcprop.cc.bits.shn = cc.bits.shn;
1290 0 : ctrlr->disconnect_in_progress = true;
1291 0 : ctrlr->disconnect_is_shn = true;
1292 0 : spdk_for_each_channel(ctrlr->subsys->tgt,
1293 : nvmf_ctrlr_disconnect_io_qpairs_on_pg,
1294 : ctrlr,
1295 : nvmf_ctrlr_cc_reset_shn_done);
1296 :
1297 : /* From the time a shutdown is initiated the controller shall disable
1298 : * Keep Alive timer */
1299 0 : nvmf_ctrlr_stop_keep_alive_timer(ctrlr);
1300 0 : } else if (cc.bits.shn == 0) {
1301 0 : ctrlr->vcprop.cc.bits.shn = 0;
1302 : } else {
1303 0 : SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n",
1304 : cc.bits.shn >> 1, cc.bits.shn & 1);
1305 0 : return false;
1306 : }
1307 0 : diff.bits.shn = 0;
1308 : }
1309 :
1310 1 : if (diff.bits.iosqes) {
1311 0 : SPDK_DEBUGLOG(nvmf, "Prop Set IOSQES = %u (%u bytes)\n",
1312 : cc.bits.iosqes, 1u << cc.bits.iosqes);
1313 0 : ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes;
1314 0 : diff.bits.iosqes = 0;
1315 : }
1316 :
1317 1 : if (diff.bits.iocqes) {
1318 0 : SPDK_DEBUGLOG(nvmf, "Prop Set IOCQES = %u (%u bytes)\n",
1319 : cc.bits.iocqes, 1u << cc.bits.iocqes);
1320 0 : ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes;
1321 0 : diff.bits.iocqes = 0;
1322 : }
1323 :
1324 1 : if (diff.bits.ams) {
1325 0 : SPDK_ERRLOG("Arbitration Mechanism Selected (AMS) 0x%x not supported!\n", cc.bits.ams);
1326 0 : return false;
1327 : }
1328 :
1329 1 : if (diff.bits.mps) {
1330 0 : SPDK_ERRLOG("Memory Page Size (MPS) %u KiB not supported!\n", (1 << (2 + cc.bits.mps)));
1331 0 : return false;
1332 : }
1333 :
1334 1 : if (diff.bits.css) {
1335 0 : if (cc.bits.css > SPDK_NVME_CC_CSS_IOCS) {
1336 0 : SPDK_ERRLOG("I/O Command Set Selected (CSS) 0x%x not supported!\n", cc.bits.css);
1337 0 : return false;
1338 : }
1339 0 : diff.bits.css = 0;
1340 : }
1341 :
1342 1 : if (diff.raw != 0) {
1343 : /* Print an error message, but don't fail the command in this case.
1344 : * If we did want to fail in this case, we'd need to ensure we acted
1345 : * on no other bits or the initiator gets confused. */
1346 0 : SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw);
1347 : }
1348 :
1349 1 : return true;
1350 : }
1351 :
1352 : static uint64_t
1353 0 : nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr)
1354 : {
1355 0 : return ctrlr->vcprop.csts.raw;
1356 : }
1357 :
1358 : static uint64_t
1359 0 : nvmf_prop_get_aqa(struct spdk_nvmf_ctrlr *ctrlr)
1360 : {
1361 0 : return ctrlr->vcprop.aqa.raw;
1362 : }
1363 :
1364 : static bool
1365 0 : nvmf_prop_set_aqa(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1366 : {
1367 : union spdk_nvme_aqa_register aqa;
1368 :
1369 0 : aqa.raw = value;
1370 :
1371 : /*
1372 : * We don't need to explicitly check for maximum size, as the fields are
1373 : * limited to 12 bits (4096).
1374 : */
1375 0 : if (aqa.bits.asqs < SPDK_NVME_ADMIN_QUEUE_MIN_ENTRIES - 1 ||
1376 0 : aqa.bits.acqs < SPDK_NVME_ADMIN_QUEUE_MIN_ENTRIES - 1 ||
1377 0 : aqa.bits.reserved1 != 0 || aqa.bits.reserved2 != 0) {
1378 0 : return false;
1379 : }
1380 :
1381 0 : ctrlr->vcprop.aqa.raw = value;
1382 :
1383 0 : return true;
1384 : }
1385 :
1386 : static uint64_t
1387 1 : nvmf_prop_get_asq(struct spdk_nvmf_ctrlr *ctrlr)
1388 : {
1389 1 : return ctrlr->vcprop.asq;
1390 : }
1391 :
1392 : static bool
1393 1 : nvmf_prop_set_asq_lower(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1394 : {
1395 1 : ctrlr->vcprop.asq = (ctrlr->vcprop.asq & (0xFFFFFFFFULL << 32ULL)) | value;
1396 :
1397 1 : return true;
1398 : }
1399 :
1400 : static bool
1401 0 : nvmf_prop_set_asq_upper(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1402 : {
1403 0 : ctrlr->vcprop.asq = (ctrlr->vcprop.asq & 0xFFFFFFFFULL) | ((uint64_t)value << 32ULL);
1404 :
1405 0 : return true;
1406 : }
1407 :
1408 : static uint64_t
1409 0 : nvmf_prop_get_acq(struct spdk_nvmf_ctrlr *ctrlr)
1410 : {
1411 0 : return ctrlr->vcprop.acq;
1412 : }
1413 :
1414 : static bool
1415 0 : nvmf_prop_set_acq_lower(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1416 : {
1417 0 : ctrlr->vcprop.acq = (ctrlr->vcprop.acq & (0xFFFFFFFFULL << 32ULL)) | value;
1418 :
1419 0 : return true;
1420 : }
1421 :
1422 : static bool
1423 0 : nvmf_prop_set_acq_upper(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value)
1424 : {
1425 0 : ctrlr->vcprop.acq = (ctrlr->vcprop.acq & 0xFFFFFFFFULL) | ((uint64_t)value << 32ULL);
1426 :
1427 0 : return true;
1428 : }
1429 :
1430 : struct nvmf_prop {
1431 : uint32_t ofst;
1432 : uint8_t size;
1433 : char name[11];
1434 : uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr);
1435 : bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value);
1436 : bool (*set_upper_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value);
1437 : };
1438 :
1439 : #define PROP(field, size, get_cb, set_cb, set_upper_cb) \
1440 : { \
1441 : offsetof(struct spdk_nvme_registers, field), \
1442 : size, \
1443 : #field, \
1444 : get_cb, set_cb, set_upper_cb \
1445 : }
1446 :
1447 : static const struct nvmf_prop nvmf_props[] = {
1448 : PROP(cap, 8, nvmf_prop_get_cap, NULL, NULL),
1449 : PROP(vs, 4, nvmf_prop_get_vs, NULL, NULL),
1450 : PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc, NULL),
1451 : PROP(csts, 4, nvmf_prop_get_csts, NULL, NULL),
1452 : PROP(aqa, 4, nvmf_prop_get_aqa, nvmf_prop_set_aqa, NULL),
1453 : PROP(asq, 8, nvmf_prop_get_asq, nvmf_prop_set_asq_lower, nvmf_prop_set_asq_upper),
1454 : PROP(acq, 8, nvmf_prop_get_acq, nvmf_prop_set_acq_lower, nvmf_prop_set_acq_upper),
1455 : };
1456 :
1457 : static const struct nvmf_prop *
1458 6 : find_prop(uint32_t ofst, uint8_t size)
1459 : {
1460 : size_t i;
1461 :
1462 28 : for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) {
1463 27 : const struct nvmf_prop *prop = &nvmf_props[i];
1464 :
1465 27 : if ((ofst >= prop->ofst) && (ofst + size <= prop->ofst + prop->size)) {
1466 5 : return prop;
1467 : }
1468 : }
1469 :
1470 1 : return NULL;
1471 : }
1472 :
1473 : static int
1474 3 : nvmf_property_get(struct spdk_nvmf_request *req)
1475 : {
1476 3 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1477 3 : struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd;
1478 3 : struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp;
1479 : const struct nvmf_prop *prop;
1480 : uint8_t size;
1481 :
1482 3 : response->status.sc = 0;
1483 3 : response->value.u64 = 0;
1484 :
1485 3 : SPDK_DEBUGLOG(nvmf, "size %d, offset 0x%x\n",
1486 : cmd->attrib.size, cmd->ofst);
1487 :
1488 3 : switch (cmd->attrib.size) {
1489 3 : case SPDK_NVMF_PROP_SIZE_4:
1490 3 : size = 4;
1491 3 : break;
1492 0 : case SPDK_NVMF_PROP_SIZE_8:
1493 0 : size = 8;
1494 0 : break;
1495 0 : default:
1496 0 : SPDK_DEBUGLOG(nvmf, "Invalid size value %d\n", cmd->attrib.size);
1497 0 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1498 0 : response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
1499 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1500 : }
1501 :
1502 3 : prop = find_prop(cmd->ofst, size);
1503 3 : if (prop == NULL || prop->get_cb == NULL) {
1504 1 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1505 1 : response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
1506 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1507 : }
1508 :
1509 2 : SPDK_DEBUGLOG(nvmf, "name: %s\n", prop->name);
1510 :
1511 2 : response->value.u64 = prop->get_cb(ctrlr);
1512 :
1513 2 : if (size != prop->size) {
1514 : /* The size must be 4 and the prop->size is 8. Figure out which part of the property to read. */
1515 1 : assert(size == 4);
1516 1 : assert(prop->size == 8);
1517 :
1518 1 : if (cmd->ofst == prop->ofst) {
1519 : /* Keep bottom 4 bytes only */
1520 1 : response->value.u64 &= 0xFFFFFFFF;
1521 : } else {
1522 : /* Keep top 4 bytes only */
1523 0 : response->value.u64 >>= 32;
1524 : }
1525 : }
1526 :
1527 2 : SPDK_DEBUGLOG(nvmf, "response value: 0x%" PRIx64 "\n", response->value.u64);
1528 :
1529 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1530 : }
1531 :
1532 : static int
1533 3 : nvmf_property_set(struct spdk_nvmf_request *req)
1534 : {
1535 3 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1536 3 : struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd;
1537 3 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1538 : const struct nvmf_prop *prop;
1539 : uint64_t value;
1540 : uint8_t size;
1541 : bool ret;
1542 :
1543 3 : SPDK_DEBUGLOG(nvmf, "size %d, offset 0x%x, value 0x%" PRIx64 "\n",
1544 : cmd->attrib.size, cmd->ofst, cmd->value.u64);
1545 :
1546 3 : switch (cmd->attrib.size) {
1547 3 : case SPDK_NVMF_PROP_SIZE_4:
1548 3 : size = 4;
1549 3 : break;
1550 0 : case SPDK_NVMF_PROP_SIZE_8:
1551 0 : size = 8;
1552 0 : break;
1553 0 : default:
1554 0 : SPDK_DEBUGLOG(nvmf, "Invalid size value %d\n", cmd->attrib.size);
1555 0 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1556 0 : response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
1557 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1558 : }
1559 :
1560 3 : prop = find_prop(cmd->ofst, size);
1561 3 : if (prop == NULL || prop->set_cb == NULL) {
1562 1 : SPDK_INFOLOG(nvmf, "Invalid offset 0x%x\n", cmd->ofst);
1563 1 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1564 1 : response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
1565 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1566 : }
1567 :
1568 2 : SPDK_DEBUGLOG(nvmf, "name: %s\n", prop->name);
1569 :
1570 2 : value = cmd->value.u64;
1571 :
1572 2 : if (prop->size == 4) {
1573 1 : ret = prop->set_cb(ctrlr, (uint32_t)value);
1574 1 : } else if (size != prop->size) {
1575 : /* The size must be 4 and the prop->size is 8. Figure out which part of the property to write. */
1576 1 : assert(size == 4);
1577 1 : assert(prop->size == 8);
1578 :
1579 1 : if (cmd->ofst == prop->ofst) {
1580 1 : ret = prop->set_cb(ctrlr, (uint32_t)value);
1581 : } else {
1582 0 : ret = prop->set_upper_cb(ctrlr, (uint32_t)value);
1583 : }
1584 : } else {
1585 0 : ret = prop->set_cb(ctrlr, (uint32_t)value);
1586 0 : if (ret) {
1587 0 : ret = prop->set_upper_cb(ctrlr, (uint32_t)(value >> 32));
1588 : }
1589 : }
1590 :
1591 2 : if (!ret) {
1592 0 : SPDK_ERRLOG("prop set_cb failed\n");
1593 0 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1594 0 : response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM;
1595 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1596 : }
1597 :
1598 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1599 : }
1600 :
1601 : static int
1602 0 : nvmf_ctrlr_set_features_arbitration(struct spdk_nvmf_request *req)
1603 : {
1604 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1605 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1606 :
1607 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Arbitration (cdw11 = 0x%0x)\n", cmd->cdw11);
1608 :
1609 0 : ctrlr->feat.arbitration.raw = cmd->cdw11;
1610 0 : ctrlr->feat.arbitration.bits.reserved = 0;
1611 :
1612 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1613 : }
1614 :
1615 : static int
1616 0 : nvmf_ctrlr_set_features_power_management(struct spdk_nvmf_request *req)
1617 : {
1618 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1619 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1620 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1621 :
1622 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Power Management (cdw11 = 0x%0x)\n", cmd->cdw11);
1623 :
1624 : /* Only PS = 0 is allowed, since we report NPSS = 0 */
1625 0 : if (cmd->cdw11_bits.feat_power_management.bits.ps != 0) {
1626 0 : SPDK_ERRLOG("Invalid power state %u\n", cmd->cdw11_bits.feat_power_management.bits.ps);
1627 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
1628 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1629 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1630 : }
1631 :
1632 0 : ctrlr->feat.power_management.raw = cmd->cdw11;
1633 0 : ctrlr->feat.power_management.bits.reserved = 0;
1634 :
1635 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1636 : }
1637 :
1638 : static bool
1639 5 : temp_threshold_opts_valid(const union spdk_nvme_feat_temperature_threshold *opts)
1640 : {
1641 : /*
1642 : * Valid TMPSEL values:
1643 : * 0000b - 1000b: temperature sensors
1644 : * 1111b: set all implemented temperature sensors
1645 : */
1646 5 : if (opts->bits.tmpsel >= 9 && opts->bits.tmpsel != 15) {
1647 : /* 1001b - 1110b: reserved */
1648 2 : SPDK_ERRLOG("Invalid TMPSEL %u\n", opts->bits.tmpsel);
1649 2 : return false;
1650 : }
1651 :
1652 : /*
1653 : * Valid THSEL values:
1654 : * 00b: over temperature threshold
1655 : * 01b: under temperature threshold
1656 : */
1657 3 : if (opts->bits.thsel > 1) {
1658 : /* 10b - 11b: reserved */
1659 1 : SPDK_ERRLOG("Invalid THSEL %u\n", opts->bits.thsel);
1660 1 : return false;
1661 : }
1662 :
1663 2 : return true;
1664 : }
1665 :
1666 : static int
1667 3 : nvmf_ctrlr_set_features_temperature_threshold(struct spdk_nvmf_request *req)
1668 : {
1669 3 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1670 3 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1671 :
1672 3 : SPDK_DEBUGLOG(nvmf, "Set Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11);
1673 :
1674 3 : if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) {
1675 2 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
1676 2 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1677 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1678 : }
1679 :
1680 : /* TODO: no sensors implemented - ignore new values */
1681 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1682 : }
1683 :
1684 : static int
1685 2 : nvmf_ctrlr_get_features_temperature_threshold(struct spdk_nvmf_request *req)
1686 : {
1687 2 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1688 2 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1689 :
1690 2 : SPDK_DEBUGLOG(nvmf, "Get Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11);
1691 :
1692 2 : if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) {
1693 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
1694 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1695 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1696 : }
1697 :
1698 : /* TODO: no sensors implemented - return 0 for all thresholds */
1699 1 : rsp->cdw0 = 0;
1700 :
1701 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1702 : }
1703 :
1704 : static int
1705 0 : nvmf_ctrlr_get_features_interrupt_vector_configuration(struct spdk_nvmf_request *req)
1706 : {
1707 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1708 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1709 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1710 0 : union spdk_nvme_feat_interrupt_vector_configuration iv_conf = {};
1711 :
1712 0 : SPDK_DEBUGLOG(nvmf, "Get Features - Interrupt Vector Configuration (cdw11 = 0x%0x)\n", cmd->cdw11);
1713 :
1714 0 : iv_conf.bits.iv = cmd->cdw11_bits.feat_interrupt_vector_configuration.bits.iv;
1715 0 : iv_conf.bits.cd = ctrlr->feat.interrupt_vector_configuration.bits.cd;
1716 0 : rsp->cdw0 = iv_conf.raw;
1717 :
1718 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1719 : }
1720 :
1721 : static int
1722 2 : nvmf_ctrlr_set_features_error_recovery(struct spdk_nvmf_request *req)
1723 : {
1724 2 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1725 2 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1726 2 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1727 :
1728 2 : SPDK_DEBUGLOG(nvmf, "Set Features - Error Recovery (cdw11 = 0x%0x)\n", cmd->cdw11);
1729 :
1730 2 : if (cmd->cdw11_bits.feat_error_recovery.bits.dulbe) {
1731 : /*
1732 : * Host is not allowed to set this bit, since we don't advertise it in
1733 : * Identify Namespace.
1734 : */
1735 1 : SPDK_ERRLOG("Host set unsupported DULBE bit\n");
1736 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
1737 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1738 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1739 : }
1740 :
1741 1 : ctrlr->feat.error_recovery.raw = cmd->cdw11;
1742 1 : ctrlr->feat.error_recovery.bits.reserved = 0;
1743 :
1744 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1745 : }
1746 :
1747 : static int
1748 0 : nvmf_ctrlr_set_features_volatile_write_cache(struct spdk_nvmf_request *req)
1749 : {
1750 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1751 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1752 :
1753 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Volatile Write Cache (cdw11 = 0x%0x)\n", cmd->cdw11);
1754 :
1755 0 : ctrlr->feat.volatile_write_cache.raw = cmd->cdw11;
1756 0 : ctrlr->feat.volatile_write_cache.bits.reserved = 0;
1757 :
1758 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Volatile Write Cache %s\n",
1759 : ctrlr->feat.volatile_write_cache.bits.wce ? "Enabled" : "Disabled");
1760 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1761 : }
1762 :
1763 : static int
1764 0 : nvmf_ctrlr_set_features_write_atomicity(struct spdk_nvmf_request *req)
1765 : {
1766 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1767 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1768 :
1769 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Write Atomicity (cdw11 = 0x%0x)\n", cmd->cdw11);
1770 :
1771 0 : ctrlr->feat.write_atomicity.raw = cmd->cdw11;
1772 0 : ctrlr->feat.write_atomicity.bits.reserved = 0;
1773 :
1774 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1775 : }
1776 :
1777 : static int
1778 0 : nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req)
1779 : {
1780 0 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1781 :
1782 0 : SPDK_ERRLOG("Set Features - Host Identifier not allowed\n");
1783 0 : response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR;
1784 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1785 : }
1786 :
1787 : static int
1788 0 : nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req)
1789 : {
1790 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1791 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1792 0 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1793 0 : struct spdk_iov_xfer ix;
1794 :
1795 0 : SPDK_DEBUGLOG(nvmf, "Get Features - Host Identifier\n");
1796 :
1797 0 : if (!cmd->cdw11_bits.feat_host_identifier.bits.exhid) {
1798 : /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */
1799 0 : SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n");
1800 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1801 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1802 : }
1803 :
1804 0 : if (req->iovcnt < 1 || req->length < sizeof(ctrlr->hostid)) {
1805 0 : SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n");
1806 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1807 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1808 : }
1809 :
1810 0 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
1811 0 : spdk_iov_xfer_from_buf(&ix, &ctrlr->hostid, sizeof(ctrlr->hostid));
1812 :
1813 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1814 : }
1815 :
1816 : static int
1817 0 : nvmf_ctrlr_get_features_reservation_notification_mask(struct spdk_nvmf_request *req)
1818 : {
1819 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1820 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1821 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1822 : struct spdk_nvmf_ns *ns;
1823 :
1824 0 : SPDK_DEBUGLOG(nvmf, "get Features - Reservation Notification Mask\n");
1825 :
1826 0 : if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) {
1827 0 : SPDK_ERRLOG("get Features - Invalid Namespace ID\n");
1828 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1829 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1830 : }
1831 :
1832 0 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
1833 0 : if (ns == NULL) {
1834 0 : SPDK_ERRLOG("get Features - Invalid Namespace ID\n");
1835 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1836 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1837 : }
1838 0 : rsp->cdw0 = ns->mask;
1839 :
1840 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1841 : }
1842 :
1843 : static int
1844 0 : nvmf_ctrlr_set_features_reservation_notification_mask(struct spdk_nvmf_request *req)
1845 : {
1846 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1847 0 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
1848 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1849 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
1850 : struct spdk_nvmf_ns *ns;
1851 :
1852 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Reservation Notification Mask\n");
1853 :
1854 0 : if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) {
1855 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL;
1856 0 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
1857 0 : ns->mask = cmd->cdw11;
1858 : }
1859 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1860 : }
1861 :
1862 0 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
1863 0 : if (ns == NULL) {
1864 0 : SPDK_ERRLOG("Set Features - Invalid Namespace ID\n");
1865 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1866 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1867 : }
1868 0 : ns->mask = cmd->cdw11;
1869 :
1870 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1871 : }
1872 :
1873 : static int
1874 1 : nvmf_ctrlr_get_features_reservation_persistence(struct spdk_nvmf_request *req)
1875 : {
1876 1 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1877 1 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1878 1 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1879 : struct spdk_nvmf_ns *ns;
1880 :
1881 1 : SPDK_DEBUGLOG(nvmf, "Get Features - Reservation Persistence\n");
1882 :
1883 1 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
1884 : /* NSID with SPDK_NVME_GLOBAL_NS_TAG (=0xffffffff) also included */
1885 1 : if (ns == NULL) {
1886 0 : SPDK_ERRLOG("Get Features - Invalid Namespace ID\n");
1887 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1888 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1889 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1890 : }
1891 :
1892 1 : response->cdw0 = ns->ptpl_activated;
1893 :
1894 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1895 1 : response->status.sc = SPDK_NVME_SC_SUCCESS;
1896 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1897 : }
1898 :
1899 : static int
1900 1 : nvmf_ctrlr_set_features_reservation_persistence(struct spdk_nvmf_request *req)
1901 : {
1902 1 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1903 1 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
1904 1 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1905 : struct spdk_nvmf_ns *ns;
1906 : bool ptpl;
1907 :
1908 1 : SPDK_DEBUGLOG(nvmf, "Set Features - Reservation Persistence\n");
1909 :
1910 1 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
1911 1 : ptpl = cmd->cdw11_bits.feat_rsv_persistence.bits.ptpl;
1912 :
1913 1 : if (cmd->nsid != SPDK_NVME_GLOBAL_NS_TAG && ns && nvmf_ns_is_ptpl_capable(ns)) {
1914 1 : ns->ptpl_activated = ptpl;
1915 0 : } else if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) {
1916 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns;
1917 0 : ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) {
1918 0 : if (nvmf_ns_is_ptpl_capable(ns)) {
1919 0 : ns->ptpl_activated = ptpl;
1920 : }
1921 : }
1922 : } else {
1923 0 : SPDK_ERRLOG("Set Features - Invalid Namespace ID or Reservation Configuration\n");
1924 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1925 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1926 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1927 : }
1928 :
1929 : /* TODO: Feature not changeable for now */
1930 1 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
1931 1 : response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE;
1932 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1933 : }
1934 :
1935 : static int
1936 3 : nvmf_ctrlr_get_features_host_behavior_support(struct spdk_nvmf_request *req)
1937 : {
1938 3 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1939 3 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1940 3 : struct spdk_nvme_host_behavior host_behavior = {};
1941 3 : struct spdk_iov_xfer ix;
1942 :
1943 3 : SPDK_DEBUGLOG(nvmf, "Get Features - Host Behavior Support\n");
1944 :
1945 3 : if (req->iovcnt < 1 || req->length < sizeof(struct spdk_nvme_host_behavior)) {
1946 2 : SPDK_ERRLOG("invalid data buffer for Host Behavior Support\n");
1947 2 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1948 2 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1949 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1950 : }
1951 :
1952 1 : host_behavior.acre = ctrlr->acre_enabled;
1953 1 : host_behavior.lbafee = ctrlr->lbafee_enabled;
1954 :
1955 1 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
1956 1 : spdk_iov_xfer_from_buf(&ix, &host_behavior, sizeof(host_behavior));
1957 :
1958 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1959 : }
1960 :
1961 : static int
1962 6 : nvmf_ctrlr_set_features_host_behavior_support(struct spdk_nvmf_request *req)
1963 : {
1964 6 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
1965 6 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
1966 : struct spdk_nvme_host_behavior *host_behavior;
1967 :
1968 6 : SPDK_DEBUGLOG(nvmf, "Set Features - Host Behavior Support\n");
1969 6 : if (req->iovcnt != 1) {
1970 1 : SPDK_ERRLOG("Host Behavior Support invalid iovcnt: %d\n", req->iovcnt);
1971 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1972 1 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1973 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1974 : }
1975 5 : if (req->iov[0].iov_len != sizeof(struct spdk_nvme_host_behavior)) {
1976 1 : SPDK_ERRLOG("Host Behavior Support invalid iov_len: %zd\n", req->iov[0].iov_len);
1977 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1978 1 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1979 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1980 : }
1981 :
1982 4 : host_behavior = (struct spdk_nvme_host_behavior *)req->iov[0].iov_base;
1983 4 : if (host_behavior->acre == 0) {
1984 1 : ctrlr->acre_enabled = false;
1985 3 : } else if (host_behavior->acre == 1) {
1986 1 : ctrlr->acre_enabled = true;
1987 : } else {
1988 2 : SPDK_ERRLOG("Host Behavior Support invalid acre: 0x%02x\n", host_behavior->acre);
1989 2 : response->status.sct = SPDK_NVME_SCT_GENERIC;
1990 2 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
1991 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
1992 : }
1993 2 : if (host_behavior->lbafee == 0) {
1994 1 : ctrlr->lbafee_enabled = false;
1995 1 : } else if (host_behavior->lbafee == 1) {
1996 1 : ctrlr->lbafee_enabled = true;
1997 : } else {
1998 0 : SPDK_ERRLOG("Host Behavior Support invalid acre: 0x%02x\n", host_behavior->lbafee);
1999 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2000 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2001 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2002 : }
2003 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2004 : }
2005 :
2006 : static int
2007 0 : nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req)
2008 : {
2009 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
2010 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
2011 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
2012 :
2013 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11);
2014 :
2015 : /*
2016 : * if attempts to disable keep alive by setting kato to 0h
2017 : * a status value of keep alive invalid shall be returned
2018 : */
2019 0 : if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato == 0) {
2020 0 : rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID;
2021 0 : } else if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato < MIN_KEEP_ALIVE_TIMEOUT_IN_MS) {
2022 0 : ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT_IN_MS;
2023 : } else {
2024 : /* round up to milliseconds */
2025 0 : ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up(
2026 0 : cmd->cdw11_bits.feat_keep_alive_timer.bits.kato,
2027 : KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) *
2028 : KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS;
2029 : }
2030 :
2031 : /*
2032 : * if change the keep alive timeout value successfully
2033 : * update the keep alive poller.
2034 : */
2035 0 : if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato != 0) {
2036 0 : if (ctrlr->keep_alive_poller != NULL) {
2037 0 : spdk_poller_unregister(&ctrlr->keep_alive_poller);
2038 : }
2039 0 : ctrlr->keep_alive_poller = SPDK_POLLER_REGISTER(nvmf_ctrlr_keep_alive_poll, ctrlr,
2040 : ctrlr->feat.keep_alive_timer.bits.kato * 1000);
2041 : }
2042 :
2043 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer set to %u ms\n",
2044 : ctrlr->feat.keep_alive_timer.bits.kato);
2045 :
2046 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2047 : }
2048 :
2049 : static int
2050 0 : nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req)
2051 : {
2052 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
2053 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
2054 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
2055 : uint32_t count;
2056 :
2057 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Number of Queues, cdw11 0x%x\n",
2058 : req->cmd->nvme_cmd.cdw11);
2059 :
2060 0 : if (cmd->cdw11_bits.feat_num_of_queues.bits.ncqr == UINT16_MAX ||
2061 0 : cmd->cdw11_bits.feat_num_of_queues.bits.nsqr == UINT16_MAX) {
2062 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2063 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2064 : }
2065 :
2066 0 : count = spdk_bit_array_count_set(ctrlr->qpair_mask);
2067 : /* verify that the controller is ready to process commands */
2068 0 : if (count > 1) {
2069 0 : SPDK_DEBUGLOG(nvmf, "Queue pairs already active!\n");
2070 0 : rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR;
2071 : } else {
2072 : /*
2073 : * Ignore the value requested by the host -
2074 : * always return the pre-configured value based on max_qpairs_allowed.
2075 : */
2076 0 : rsp->cdw0 = ctrlr->feat.number_of_queues.raw;
2077 : }
2078 :
2079 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2080 : }
2081 :
2082 : SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ctrlr) == 4928,
2083 : "Please check migration fields that need to be added or not");
2084 :
2085 : static void
2086 0 : nvmf_ctrlr_migr_data_copy(struct spdk_nvmf_ctrlr_migr_data *data,
2087 : const struct spdk_nvmf_ctrlr_migr_data *data_src, size_t data_size)
2088 : {
2089 0 : assert(data);
2090 0 : assert(data_src);
2091 0 : assert(data_size);
2092 :
2093 0 : memcpy(&data->regs, &data_src->regs, spdk_min(data->regs_size, data_src->regs_size));
2094 0 : memcpy(&data->feat, &data_src->feat, spdk_min(data->feat_size, data_src->feat_size));
2095 :
2096 : #define SET_FIELD(field) \
2097 : if (offsetof(struct spdk_nvmf_ctrlr_migr_data, field) + sizeof(data->field) <= data_size) { \
2098 : data->field = data_src->field; \
2099 : } \
2100 :
2101 0 : SET_FIELD(cntlid);
2102 0 : SET_FIELD(acre);
2103 0 : SET_FIELD(num_aer_cids);
2104 0 : SET_FIELD(num_async_events);
2105 0 : SET_FIELD(notice_aen_mask);
2106 : #undef SET_FIELD
2107 :
2108 : #define SET_ARRAY(arr) \
2109 : if (offsetof(struct spdk_nvmf_ctrlr_migr_data, arr) + sizeof(data->arr) <= data_size) { \
2110 : memcpy(&data->arr, &data_src->arr, sizeof(data->arr)); \
2111 : } \
2112 :
2113 0 : SET_ARRAY(async_events);
2114 0 : SET_ARRAY(aer_cids);
2115 : #undef SET_ARRAY
2116 0 : }
2117 :
2118 : int
2119 0 : spdk_nvmf_ctrlr_save_migr_data(struct spdk_nvmf_ctrlr *ctrlr,
2120 : struct spdk_nvmf_ctrlr_migr_data *data)
2121 : {
2122 : struct spdk_nvmf_async_event_completion *event, *event_tmp;
2123 : uint32_t i;
2124 0 : struct spdk_nvmf_ctrlr_migr_data data_local = {
2125 : .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused),
2126 : .regs_size = sizeof(struct spdk_nvmf_registers),
2127 : .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat)
2128 : };
2129 :
2130 0 : assert(data->data_size <= sizeof(data_local));
2131 0 : assert(spdk_get_thread() == ctrlr->thread);
2132 :
2133 0 : memcpy(&data_local.regs, &ctrlr->vcprop, sizeof(struct spdk_nvmf_registers));
2134 0 : memcpy(&data_local.feat, &ctrlr->feat, sizeof(struct spdk_nvmf_ctrlr_feat));
2135 :
2136 0 : data_local.cntlid = ctrlr->cntlid;
2137 0 : data_local.acre = ctrlr->acre_enabled;
2138 0 : data_local.num_aer_cids = ctrlr->nr_aer_reqs;
2139 :
2140 0 : STAILQ_FOREACH_SAFE(event, &ctrlr->async_events, link, event_tmp) {
2141 0 : if (data_local.num_async_events + 1 > SPDK_NVMF_MIGR_MAX_PENDING_AERS) {
2142 0 : SPDK_ERRLOG("ctrlr %p has too many pending AERs\n", ctrlr);
2143 0 : break;
2144 : }
2145 :
2146 0 : data_local.async_events[data_local.num_async_events++].raw = event->event.raw;
2147 : }
2148 :
2149 0 : for (i = 0; i < ctrlr->nr_aer_reqs; i++) {
2150 0 : struct spdk_nvmf_request *req = ctrlr->aer_req[i];
2151 0 : data_local.aer_cids[i] = req->cmd->nvme_cmd.cid;
2152 : }
2153 0 : data_local.notice_aen_mask = ctrlr->notice_aen_mask;
2154 :
2155 0 : nvmf_ctrlr_migr_data_copy(data, &data_local, spdk_min(data->data_size, data_local.data_size));
2156 0 : return 0;
2157 : }
2158 :
2159 : int
2160 0 : spdk_nvmf_ctrlr_restore_migr_data(struct spdk_nvmf_ctrlr *ctrlr,
2161 : const struct spdk_nvmf_ctrlr_migr_data *data)
2162 : {
2163 : uint32_t i;
2164 0 : struct spdk_nvmf_ctrlr_migr_data data_local = {
2165 : .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused),
2166 : .regs_size = sizeof(struct spdk_nvmf_registers),
2167 : .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat)
2168 : };
2169 :
2170 0 : assert(data->data_size <= sizeof(data_local));
2171 0 : assert(spdk_get_thread() == ctrlr->thread);
2172 :
2173 : /* local version of data should have defaults set before copy */
2174 0 : nvmf_ctrlr_migr_data_copy(&data_local, data, spdk_min(data->data_size, data_local.data_size));
2175 0 : memcpy(&ctrlr->vcprop, &data_local.regs, sizeof(struct spdk_nvmf_registers));
2176 0 : memcpy(&ctrlr->feat, &data_local.feat, sizeof(struct spdk_nvmf_ctrlr_feat));
2177 :
2178 0 : ctrlr->cntlid = data_local.cntlid;
2179 0 : ctrlr->acre_enabled = data_local.acre;
2180 :
2181 0 : for (i = 0; i < data_local.num_async_events; i++) {
2182 : struct spdk_nvmf_async_event_completion *event;
2183 :
2184 0 : event = calloc(1, sizeof(*event));
2185 0 : if (!event) {
2186 0 : return -ENOMEM;
2187 : }
2188 :
2189 0 : event->event.raw = data_local.async_events[i].raw;
2190 0 : STAILQ_INSERT_TAIL(&ctrlr->async_events, event, link);
2191 : }
2192 0 : ctrlr->notice_aen_mask = data_local.notice_aen_mask;
2193 :
2194 0 : return 0;
2195 : }
2196 :
2197 : static int
2198 0 : nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req)
2199 : {
2200 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
2201 0 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
2202 :
2203 0 : SPDK_DEBUGLOG(nvmf, "Set Features - Async Event Configuration, cdw11 0x%08x\n",
2204 : cmd->cdw11);
2205 0 : ctrlr->feat.async_event_configuration.raw = cmd->cdw11;
2206 0 : ctrlr->feat.async_event_configuration.bits.reserved1 = 0;
2207 0 : ctrlr->feat.async_event_configuration.bits.reserved2 = 0;
2208 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2209 : }
2210 :
2211 : static int
2212 10 : nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req)
2213 : {
2214 10 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
2215 10 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
2216 : struct spdk_nvmf_async_event_completion *pending_event;
2217 :
2218 10 : SPDK_DEBUGLOG(nvmf, "Async Event Request\n");
2219 :
2220 : /* Four asynchronous events are supported for now */
2221 10 : if (ctrlr->nr_aer_reqs >= SPDK_NVMF_MAX_ASYNC_EVENTS) {
2222 1 : SPDK_DEBUGLOG(nvmf, "AERL exceeded\n");
2223 1 : rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
2224 1 : rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED;
2225 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2226 : }
2227 :
2228 9 : if (!STAILQ_EMPTY(&ctrlr->async_events)) {
2229 4 : pending_event = STAILQ_FIRST(&ctrlr->async_events);
2230 4 : rsp->cdw0 = pending_event->event.raw;
2231 4 : STAILQ_REMOVE(&ctrlr->async_events, pending_event, spdk_nvmf_async_event_completion, link);
2232 4 : free(pending_event);
2233 4 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2234 : }
2235 :
2236 5 : ctrlr->aer_req[ctrlr->nr_aer_reqs++] = req;
2237 5 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
2238 : }
2239 :
2240 : static void
2241 0 : nvmf_get_firmware_slot_log_page(struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length)
2242 : {
2243 0 : struct spdk_nvme_firmware_page fw_page;
2244 : size_t copy_len;
2245 0 : struct spdk_iov_xfer ix;
2246 :
2247 0 : spdk_iov_xfer_init(&ix, iovs, iovcnt);
2248 :
2249 0 : memset(&fw_page, 0, sizeof(fw_page));
2250 0 : fw_page.afi.active_slot = 1;
2251 0 : fw_page.afi.next_reset_slot = 0;
2252 0 : spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' ');
2253 :
2254 0 : if (offset < sizeof(fw_page)) {
2255 0 : copy_len = spdk_min(sizeof(fw_page) - offset, length);
2256 0 : if (copy_len > 0) {
2257 0 : spdk_iov_xfer_from_buf(&ix, (const char *)&fw_page + offset, copy_len);
2258 : }
2259 : }
2260 0 : }
2261 :
2262 : /*
2263 : * Asynchronous Event Mask Bit
2264 : */
2265 : enum spdk_nvme_async_event_mask_bit {
2266 : /* Mask Namespace Change Notification */
2267 : SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT = 0,
2268 : /* Mask Asymmetric Namespace Access Change Notification */
2269 : SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT = 1,
2270 : /* Mask Discovery Log Change Notification */
2271 : SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT = 2,
2272 : /* Mask Reservation Log Page Available Notification */
2273 : SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT = 3,
2274 : /* Mask Error Event */
2275 : SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT = 4,
2276 : /* 4 - 63 Reserved */
2277 : };
2278 :
2279 : static inline void
2280 20 : nvmf_ctrlr_unmask_aen(struct spdk_nvmf_ctrlr *ctrlr,
2281 : enum spdk_nvme_async_event_mask_bit mask)
2282 : {
2283 20 : ctrlr->notice_aen_mask &= ~(1 << mask);
2284 20 : }
2285 :
2286 : static inline bool
2287 11 : nvmf_ctrlr_mask_aen(struct spdk_nvmf_ctrlr *ctrlr,
2288 : enum spdk_nvme_async_event_mask_bit mask)
2289 : {
2290 11 : if (ctrlr->notice_aen_mask & (1 << mask)) {
2291 5 : return false;
2292 : } else {
2293 6 : ctrlr->notice_aen_mask |= (1 << mask);
2294 6 : return true;
2295 : }
2296 : }
2297 :
2298 : /* we have to use the typedef in the function declaration to appease astyle. */
2299 : typedef enum spdk_nvme_ana_state spdk_nvme_ana_state_t;
2300 :
2301 : static inline spdk_nvme_ana_state_t
2302 36 : nvmf_ctrlr_get_ana_state(struct spdk_nvmf_ctrlr *ctrlr, uint32_t anagrpid)
2303 : {
2304 36 : if (!ctrlr->subsys->flags.ana_reporting) {
2305 36 : return SPDK_NVME_ANA_OPTIMIZED_STATE;
2306 : }
2307 :
2308 0 : if (spdk_unlikely(ctrlr->listener == NULL)) {
2309 0 : return SPDK_NVME_ANA_INACCESSIBLE_STATE;
2310 : }
2311 :
2312 0 : assert(anagrpid - 1 < ctrlr->subsys->max_nsid);
2313 0 : return ctrlr->listener->ana_state[anagrpid - 1];
2314 : }
2315 :
2316 : static spdk_nvme_ana_state_t
2317 8 : nvmf_ctrlr_get_ana_state_from_nsid(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid)
2318 : {
2319 : struct spdk_nvmf_ns *ns;
2320 :
2321 : /* We do not have NVM subsystem specific ANA state. Hence if NSID is either
2322 : * SPDK_NVMF_GLOBAL_NS_TAG, invalid, or for inactive namespace, return
2323 : * the optimized state.
2324 : */
2325 8 : ns = nvmf_ctrlr_get_ns(ctrlr, nsid);
2326 8 : if (ns == NULL) {
2327 0 : return SPDK_NVME_ANA_OPTIMIZED_STATE;
2328 : }
2329 :
2330 8 : return nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid);
2331 : }
2332 :
2333 : static void
2334 1 : nvmf_get_error_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt,
2335 : uint64_t offset, uint32_t length, uint32_t rae)
2336 : {
2337 1 : if (!rae) {
2338 1 : nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT);
2339 : }
2340 :
2341 : /* TODO: actually fill out log page data */
2342 1 : }
2343 :
2344 : static void
2345 17 : nvmf_get_ana_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt,
2346 : uint64_t offset, uint32_t length, uint32_t rae)
2347 : {
2348 17 : struct spdk_nvme_ana_page ana_hdr;
2349 17 : struct spdk_nvme_ana_group_descriptor ana_desc;
2350 : size_t copy_len, copied_len;
2351 17 : uint32_t num_anagrp = 0, anagrpid;
2352 : struct spdk_nvmf_ns *ns;
2353 17 : struct spdk_iov_xfer ix;
2354 :
2355 17 : spdk_iov_xfer_init(&ix, iovs, iovcnt);
2356 :
2357 17 : if (length == 0) {
2358 0 : goto done;
2359 : }
2360 :
2361 17 : if (offset >= sizeof(ana_hdr)) {
2362 13 : offset -= sizeof(ana_hdr);
2363 : } else {
2364 20 : for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) {
2365 16 : if (ctrlr->subsys->ana_group[anagrpid - 1] > 0) {
2366 10 : num_anagrp++;
2367 : }
2368 : }
2369 :
2370 4 : memset(&ana_hdr, 0, sizeof(ana_hdr));
2371 :
2372 4 : ana_hdr.num_ana_group_desc = num_anagrp;
2373 : /* TODO: Support Change Count. */
2374 4 : ana_hdr.change_count = 0;
2375 :
2376 4 : copy_len = spdk_min(sizeof(ana_hdr) - offset, length);
2377 4 : copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_hdr + offset, copy_len);
2378 4 : assert(copied_len == copy_len);
2379 4 : length -= copied_len;
2380 4 : offset = 0;
2381 : }
2382 :
2383 17 : if (length == 0) {
2384 2 : goto done;
2385 : }
2386 :
2387 37 : for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) {
2388 37 : if (ctrlr->subsys->ana_group[anagrpid - 1] == 0) {
2389 7 : continue;
2390 : }
2391 :
2392 30 : if (offset >= sizeof(ana_desc)) {
2393 12 : offset -= sizeof(ana_desc);
2394 : } else {
2395 18 : memset(&ana_desc, 0, sizeof(ana_desc));
2396 :
2397 18 : ana_desc.ana_group_id = anagrpid;
2398 18 : ana_desc.num_of_nsid = ctrlr->subsys->ana_group[anagrpid - 1];
2399 18 : ana_desc.ana_state = nvmf_ctrlr_get_ana_state(ctrlr, anagrpid);
2400 :
2401 18 : copy_len = spdk_min(sizeof(ana_desc) - offset, length);
2402 18 : copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_desc + offset,
2403 : copy_len);
2404 18 : assert(copied_len == copy_len);
2405 18 : length -= copied_len;
2406 18 : offset = 0;
2407 :
2408 18 : if (length == 0) {
2409 10 : goto done;
2410 : }
2411 : }
2412 :
2413 : /* TODO: Revisit here about O(n^2) cost if we have subsystem with
2414 : * many namespaces in the future.
2415 : */
2416 86 : for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL;
2417 66 : ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) {
2418 71 : if (ns->anagrpid != anagrpid) {
2419 39 : continue;
2420 : }
2421 :
2422 32 : if (offset >= sizeof(uint32_t)) {
2423 16 : offset -= sizeof(uint32_t);
2424 16 : continue;
2425 : }
2426 :
2427 16 : copy_len = spdk_min(sizeof(uint32_t) - offset, length);
2428 16 : copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ns->nsid + offset,
2429 : copy_len);
2430 16 : assert(copied_len == copy_len);
2431 16 : length -= copied_len;
2432 16 : offset = 0;
2433 :
2434 16 : if (length == 0) {
2435 5 : goto done;
2436 : }
2437 : }
2438 : }
2439 :
2440 17 : done:
2441 17 : if (!rae) {
2442 17 : nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT);
2443 : }
2444 17 : }
2445 :
2446 : void
2447 0 : nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid)
2448 : {
2449 0 : uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list);
2450 : uint16_t i;
2451 0 : bool found = false;
2452 :
2453 0 : for (i = 0; i < ctrlr->changed_ns_list_count; i++) {
2454 0 : if (ctrlr->changed_ns_list.ns_list[i] == nsid) {
2455 : /* nsid is already in the list */
2456 0 : found = true;
2457 0 : break;
2458 : }
2459 : }
2460 :
2461 0 : if (!found) {
2462 0 : if (ctrlr->changed_ns_list_count == max_changes) {
2463 : /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */
2464 0 : ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu;
2465 0 : for (i = 1; i < max_changes; i++) {
2466 0 : ctrlr->changed_ns_list.ns_list[i] = 0;
2467 : }
2468 : } else {
2469 0 : ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid;
2470 : }
2471 : }
2472 0 : }
2473 :
2474 : static void
2475 2 : nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr,
2476 : struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae)
2477 : {
2478 : size_t copy_length;
2479 2 : struct spdk_iov_xfer ix;
2480 :
2481 2 : spdk_iov_xfer_init(&ix, iovs, iovcnt);
2482 :
2483 2 : if (offset < sizeof(ctrlr->changed_ns_list)) {
2484 2 : copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset);
2485 2 : if (copy_length) {
2486 2 : spdk_iov_xfer_from_buf(&ix, (char *)&ctrlr->changed_ns_list + offset, copy_length);
2487 : }
2488 : }
2489 :
2490 : /* Clear log page each time it is read */
2491 2 : ctrlr->changed_ns_list_count = 0;
2492 2 : memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list));
2493 :
2494 2 : if (!rae) {
2495 1 : nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT);
2496 : }
2497 2 : }
2498 :
2499 : /* The structure can be modified if we provide support for other commands in future */
2500 : static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = {
2501 : .admin_cmds_supported = {
2502 : /* CSUPP, LBCC, NCC, NIC, CCC, CSE */
2503 : /* Get Log Page */
2504 : [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0},
2505 : /* Identify */
2506 : [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0},
2507 : /* Abort */
2508 : [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0},
2509 : /* Set Features */
2510 : [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0},
2511 : /* Get Features */
2512 : [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0},
2513 : /* Async Event Request */
2514 : [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0},
2515 : /* Keep Alive */
2516 : [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0},
2517 : },
2518 : .io_cmds_supported = {
2519 : /* FLUSH */
2520 : [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0},
2521 : /* WRITE */
2522 : [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0},
2523 : /* READ */
2524 : [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0},
2525 : /* WRITE ZEROES */
2526 : [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0},
2527 : /* DATASET MANAGEMENT */
2528 : [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0},
2529 : /* COMPARE */
2530 : [SPDK_NVME_OPC_COMPARE] = {1, 0, 0, 0, 0, 0, 0, 0},
2531 : /* ZONE MANAGEMENT SEND */
2532 : [SPDK_NVME_OPC_ZONE_MGMT_SEND] = {1, 1, 0, 0, 0, 0, 0, 0},
2533 : /* ZONE MANAGEMENT RECEIVE */
2534 : [SPDK_NVME_OPC_ZONE_MGMT_RECV] = {1, 0, 0, 0, 0, 0, 0, 0},
2535 : /* ZONE APPEND */
2536 : [SPDK_NVME_OPC_ZONE_APPEND] = {1, 1, 0, 0, 0, 0, 0, 0},
2537 : /* COPY */
2538 : [SPDK_NVME_OPC_COPY] = {1, 1, 0, 0, 0, 0, 0, 0},
2539 : },
2540 : };
2541 :
2542 : static void
2543 0 : nvmf_get_cmds_and_effects_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt,
2544 : uint64_t offset, uint32_t length)
2545 : {
2546 0 : uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page);
2547 0 : size_t copy_len = 0;
2548 0 : struct spdk_nvme_cmds_and_effect_log_page cmds_and_effect_log_page = g_cmds_and_effect_log_page;
2549 0 : struct spdk_nvme_cmds_and_effect_entry zero = {};
2550 0 : struct spdk_iov_xfer ix;
2551 :
2552 0 : if (!ctrlr->cdata.oncs.write_zeroes || !nvmf_ctrlr_write_zeroes_supported(ctrlr)) {
2553 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_WRITE_ZEROES] = zero;
2554 : }
2555 0 : if (!ctrlr->cdata.oncs.dsm || !nvmf_ctrlr_dsm_supported(ctrlr)) {
2556 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_DATASET_MANAGEMENT] = zero;
2557 : }
2558 0 : if (!ctrlr->cdata.oncs.compare) {
2559 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COMPARE] = zero;
2560 : }
2561 0 : if (!nvmf_subsystem_has_zns_iocs(ctrlr->subsys)) {
2562 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_SEND] = zero;
2563 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_RECV] = zero;
2564 : }
2565 0 : if (!nvmf_subsystem_zone_append_supported(ctrlr->subsys)) {
2566 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_APPEND] = zero;
2567 : }
2568 0 : if (!ctrlr->cdata.oncs.copy) {
2569 0 : cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COPY] = zero;
2570 : }
2571 :
2572 0 : spdk_iov_xfer_init(&ix, iovs, iovcnt);
2573 0 : if (offset < page_size) {
2574 0 : copy_len = spdk_min(page_size - offset, length);
2575 0 : spdk_iov_xfer_from_buf(&ix, (char *)(&cmds_and_effect_log_page) + offset, copy_len);
2576 : }
2577 0 : }
2578 :
2579 : static void
2580 1 : nvmf_get_reservation_notification_log_page(struct spdk_nvmf_ctrlr *ctrlr,
2581 : struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae)
2582 : {
2583 : uint32_t unit_log_len, avail_log_len, next_pos, copy_len;
2584 : struct spdk_nvmf_reservation_log *log, *log_tmp;
2585 1 : struct spdk_iov_xfer ix;
2586 :
2587 1 : spdk_iov_xfer_init(&ix, iovs, iovcnt);
2588 :
2589 1 : unit_log_len = sizeof(struct spdk_nvme_reservation_notification_log);
2590 : /* No available log, return zeroed log pages */
2591 1 : if (!ctrlr->num_avail_log_pages) {
2592 0 : return;
2593 : }
2594 :
2595 1 : avail_log_len = ctrlr->num_avail_log_pages * unit_log_len;
2596 1 : if (offset >= avail_log_len) {
2597 0 : return;
2598 : }
2599 :
2600 1 : next_pos = 0;
2601 3 : TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) {
2602 3 : TAILQ_REMOVE(&ctrlr->log_head, log, link);
2603 3 : ctrlr->num_avail_log_pages--;
2604 :
2605 3 : next_pos += unit_log_len;
2606 3 : if (next_pos > offset) {
2607 3 : copy_len = spdk_min(next_pos - offset, length);
2608 3 : spdk_iov_xfer_from_buf(&ix, &log->log, copy_len);
2609 3 : length -= copy_len;
2610 3 : offset += copy_len;
2611 : }
2612 3 : free(log);
2613 :
2614 3 : if (length == 0) {
2615 1 : break;
2616 : }
2617 : }
2618 :
2619 1 : if (!rae) {
2620 1 : nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT);
2621 : }
2622 1 : return;
2623 : }
2624 :
2625 : static int
2626 6 : nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req)
2627 : {
2628 6 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
2629 6 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
2630 6 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
2631 6 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
2632 6 : struct spdk_nvme_transport_id cmd_source_trid;
2633 : uint64_t offset, len;
2634 : uint32_t rae, numdl, numdu;
2635 : uint8_t lid;
2636 :
2637 6 : if (req->iovcnt < 1) {
2638 1 : SPDK_DEBUGLOG(nvmf, "get log command with no buffer\n");
2639 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2640 1 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2641 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2642 : }
2643 :
2644 5 : offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32);
2645 5 : if (offset & 3) {
2646 1 : SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset);
2647 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2648 1 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2649 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2650 : }
2651 :
2652 4 : rae = cmd->cdw10_bits.get_log_page.rae;
2653 4 : numdl = cmd->cdw10_bits.get_log_page.numdl;
2654 4 : numdu = cmd->cdw11_bits.get_log_page.numdu;
2655 4 : len = ((numdu << 16) + numdl + (uint64_t)1) * 4;
2656 4 : if (len > req->length) {
2657 0 : SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n",
2658 : len, req->length);
2659 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2660 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2661 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2662 : }
2663 :
2664 4 : lid = cmd->cdw10_bits.get_log_page.lid;
2665 4 : SPDK_DEBUGLOG(nvmf, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 " rae=%u\n",
2666 : lid, offset, len, rae);
2667 :
2668 4 : if (spdk_nvmf_subsystem_is_discovery(subsystem)) {
2669 0 : switch (lid) {
2670 0 : case SPDK_NVME_LOG_DISCOVERY:
2671 0 : if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &cmd_source_trid)) {
2672 0 : SPDK_ERRLOG("Failed to get LOG_DISCOVERY source trid\n");
2673 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2674 0 : response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
2675 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2676 : }
2677 0 : nvmf_get_discovery_log_page(subsystem->tgt, ctrlr->hostnqn, req->iov, req->iovcnt,
2678 : offset, len, &cmd_source_trid);
2679 0 : if (!rae) {
2680 0 : nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT);
2681 : }
2682 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2683 0 : default:
2684 0 : goto invalid_log_page;
2685 : }
2686 : } else {
2687 4 : if (offset > len) {
2688 0 : SPDK_ERRLOG("Get log page: offset (%" PRIu64 ") > len (%" PRIu64 ")\n",
2689 : offset, len);
2690 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2691 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2692 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2693 : }
2694 :
2695 4 : switch (lid) {
2696 1 : case SPDK_NVME_LOG_ERROR:
2697 1 : nvmf_get_error_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae);
2698 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2699 0 : case SPDK_NVME_LOG_HEALTH_INFORMATION:
2700 : /* TODO: actually fill out log page data */
2701 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2702 0 : case SPDK_NVME_LOG_FIRMWARE_SLOT:
2703 0 : nvmf_get_firmware_slot_log_page(req->iov, req->iovcnt, offset, len);
2704 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2705 0 : case SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS:
2706 0 : if (subsystem->flags.ana_reporting) {
2707 0 : nvmf_get_ana_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae);
2708 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2709 : } else {
2710 0 : goto invalid_log_page;
2711 : }
2712 0 : case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG:
2713 0 : nvmf_get_cmds_and_effects_log_page(ctrlr, req->iov, req->iovcnt, offset, len);
2714 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2715 2 : case SPDK_NVME_LOG_CHANGED_NS_LIST:
2716 2 : nvmf_get_changed_ns_list_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae);
2717 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2718 0 : case SPDK_NVME_LOG_RESERVATION_NOTIFICATION:
2719 0 : nvmf_get_reservation_notification_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae);
2720 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2721 1 : default:
2722 1 : goto invalid_log_page;
2723 : }
2724 : }
2725 :
2726 1 : invalid_log_page:
2727 1 : SPDK_INFOLOG(nvmf, "Unsupported Get Log Page 0x%02X\n", lid);
2728 1 : response->status.sct = SPDK_NVME_SCT_GENERIC;
2729 1 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
2730 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2731 : }
2732 :
2733 : static struct spdk_nvmf_ns *
2734 11 : _nvmf_ctrlr_get_ns_safe(struct spdk_nvmf_ctrlr *ctrlr,
2735 : uint32_t nsid,
2736 : struct spdk_nvme_cpl *rsp)
2737 : {
2738 : struct spdk_nvmf_ns *ns;
2739 11 : if (nsid == 0 || nsid > ctrlr->subsys->max_nsid) {
2740 5 : SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", nsid);
2741 5 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
2742 5 : rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
2743 5 : return NULL;
2744 : }
2745 :
2746 6 : ns = nvmf_ctrlr_get_ns(ctrlr, nsid);
2747 6 : if (ns == NULL || ns->bdev == NULL) {
2748 : /*
2749 : * Inactive namespaces should return a zero filled data structure.
2750 : * The data buffer is already zeroed by nvmf_ctrlr_process_admin_cmd(),
2751 : * so we can just return early here.
2752 : */
2753 2 : SPDK_DEBUGLOG(nvmf, "Identify Namespace for inactive NSID %u\n", nsid);
2754 2 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
2755 2 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
2756 2 : return NULL;
2757 : }
2758 4 : return ns;
2759 : }
2760 :
2761 : int
2762 7 : spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr,
2763 : struct spdk_nvme_cmd *cmd,
2764 : struct spdk_nvme_cpl *rsp,
2765 : struct spdk_nvme_ns_data *nsdata)
2766 : {
2767 7 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
2768 : struct spdk_nvmf_ns *ns;
2769 : uint32_t max_num_blocks, format_index;
2770 : enum spdk_nvme_ana_state ana_state;
2771 :
2772 7 : ns = _nvmf_ctrlr_get_ns_safe(ctrlr, cmd->nsid, rsp);
2773 7 : if (ns == NULL) {
2774 5 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2775 : }
2776 :
2777 2 : nvmf_bdev_ctrlr_identify_ns(ns, nsdata, ctrlr->dif_insert_or_strip);
2778 :
2779 2 : assert(ctrlr->admin_qpair);
2780 :
2781 2 : format_index = spdk_nvme_ns_get_format_index(nsdata);
2782 :
2783 : /* Due to bug in the Linux kernel NVMe driver we have to set noiob no larger than mdts */
2784 2 : max_num_blocks = ctrlr->admin_qpair->transport->opts.max_io_size /
2785 2 : (1U << nsdata->lbaf[format_index].lbads);
2786 2 : if (nsdata->noiob > max_num_blocks) {
2787 0 : nsdata->noiob = max_num_blocks;
2788 : }
2789 :
2790 : /* Set NOWS equal to Controller MDTS */
2791 2 : if (nsdata->nsfeat.optperf) {
2792 0 : nsdata->nows = max_num_blocks - 1;
2793 : }
2794 :
2795 2 : if (subsystem->flags.ana_reporting) {
2796 0 : assert(ns->anagrpid - 1 < subsystem->max_nsid);
2797 0 : nsdata->anagrpid = ns->anagrpid;
2798 :
2799 0 : ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid);
2800 0 : if (ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE ||
2801 : ana_state == SPDK_NVME_ANA_PERSISTENT_LOSS_STATE) {
2802 0 : nsdata->nuse = 0;
2803 : }
2804 : }
2805 :
2806 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2807 : }
2808 :
2809 : static void
2810 3 : nvmf_ctrlr_populate_oacs(struct spdk_nvmf_ctrlr *ctrlr,
2811 : struct spdk_nvme_ctrlr_data *cdata)
2812 : {
2813 3 : cdata->oacs = ctrlr->cdata.oacs;
2814 :
2815 3 : cdata->oacs.virtualization_management =
2816 3 : g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT].hdlr != NULL;
2817 6 : cdata->oacs.nvme_mi = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_SEND].hdlr != NULL
2818 3 : && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_RECEIVE].hdlr != NULL;
2819 6 : cdata->oacs.directives = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_SEND].hdlr != NULL
2820 3 : && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_RECEIVE].hdlr != NULL;
2821 3 : cdata->oacs.device_self_test =
2822 3 : g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DEVICE_SELF_TEST].hdlr != NULL;
2823 6 : cdata->oacs.ns_manage = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_MANAGEMENT].hdlr != NULL
2824 3 : && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_ATTACHMENT].hdlr != NULL;
2825 6 : cdata->oacs.firmware = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD].hdlr !=
2826 : NULL
2827 3 : && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_COMMIT].hdlr != NULL;
2828 3 : cdata->oacs.format =
2829 3 : g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FORMAT_NVM].hdlr != NULL;
2830 6 : cdata->oacs.security = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_SEND].hdlr != NULL
2831 3 : && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_RECEIVE].hdlr != NULL;
2832 3 : cdata->oacs.get_lba_status = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_GET_LBA_STATUS].hdlr !=
2833 : NULL;
2834 3 : }
2835 :
2836 : int
2837 3 : spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata)
2838 : {
2839 3 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
2840 : struct spdk_nvmf_transport *transport;
2841 :
2842 : /*
2843 : * Common fields for discovery and NVM subsystems
2844 : */
2845 3 : assert(ctrlr->admin_qpair);
2846 3 : transport = ctrlr->admin_qpair->transport;
2847 3 : spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' ');
2848 3 : assert((transport->opts.max_io_size % 4096) == 0);
2849 3 : cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096);
2850 3 : cdata->cntlid = ctrlr->cntlid;
2851 3 : cdata->ver = ctrlr->vcprop.vs;
2852 3 : cdata->aerl = ctrlr->cdata.aerl;
2853 3 : cdata->lpa.edlp = 1;
2854 3 : cdata->elpe = 127;
2855 3 : cdata->maxcmd = transport->opts.max_queue_depth;
2856 3 : cdata->sgls = ctrlr->cdata.sgls;
2857 3 : cdata->fuses = ctrlr->cdata.fuses;
2858 3 : cdata->acwu = 0; /* ACWU is 0-based. */
2859 3 : if (subsystem->flags.ana_reporting) {
2860 0 : cdata->mnan = subsystem->max_nsid;
2861 : }
2862 3 : spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0');
2863 :
2864 3 : SPDK_DEBUGLOG(nvmf, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd);
2865 3 : SPDK_DEBUGLOG(nvmf, "sgls data: 0x%x\n", from_le32(&cdata->sgls));
2866 :
2867 :
2868 3 : if (spdk_nvmf_subsystem_is_discovery(subsystem)) {
2869 : /*
2870 : * NVM Discovery subsystem fields
2871 : */
2872 0 : cdata->oaes.discovery_log_change_notices = 1;
2873 0 : cdata->cntrltype = SPDK_NVME_CTRLR_DISCOVERY;
2874 : } else {
2875 3 : cdata->vid = ctrlr->cdata.vid;
2876 3 : cdata->ssvid = ctrlr->cdata.ssvid;
2877 3 : cdata->ieee[0] = ctrlr->cdata.ieee[0];
2878 3 : cdata->ieee[1] = ctrlr->cdata.ieee[1];
2879 3 : cdata->ieee[2] = ctrlr->cdata.ieee[2];
2880 :
2881 : /*
2882 : * NVM subsystem fields (reserved for discovery subsystems)
2883 : */
2884 3 : spdk_strcpy_pad(cdata->mn, spdk_nvmf_subsystem_get_mn(subsystem), sizeof(cdata->mn), ' ');
2885 3 : spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' ');
2886 3 : cdata->kas = ctrlr->cdata.kas;
2887 :
2888 3 : cdata->rab = 6;
2889 3 : cdata->cmic.multi_port = 1;
2890 3 : cdata->cmic.multi_ctrlr = 1;
2891 3 : cdata->oaes.ns_attribute_notices = 1;
2892 3 : cdata->ctratt.bits.host_id_exhid_supported = 1;
2893 3 : cdata->ctratt.bits.fdps = ctrlr->subsys->fdp_supported;
2894 3 : cdata->cntrltype = SPDK_NVME_CTRLR_IO;
2895 : /* We do not have any actual limitation to the number of abort commands.
2896 : * We follow the recommendation by the NVMe specification.
2897 : */
2898 3 : cdata->acl = NVMF_ABORT_COMMAND_LIMIT;
2899 3 : cdata->frmw.slot1_ro = 1;
2900 3 : cdata->frmw.num_slots = 1;
2901 :
2902 3 : cdata->lpa.celp = 1; /* Command Effects log page supported */
2903 :
2904 3 : cdata->sqes.min = 6;
2905 3 : cdata->sqes.max = 6;
2906 3 : cdata->cqes.min = 4;
2907 3 : cdata->cqes.max = 4;
2908 3 : cdata->nn = subsystem->max_nsid;
2909 3 : cdata->vwc.present = 1;
2910 3 : cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED;
2911 :
2912 3 : cdata->nvmf_specific = ctrlr->cdata.nvmf_specific;
2913 :
2914 3 : cdata->oncs.compare = ctrlr->cdata.oncs.compare;
2915 3 : cdata->oncs.dsm = ctrlr->cdata.oncs.dsm && nvmf_ctrlr_dsm_supported(ctrlr);
2916 6 : cdata->oncs.write_zeroes = ctrlr->cdata.oncs.write_zeroes &&
2917 3 : nvmf_ctrlr_write_zeroes_supported(ctrlr);
2918 3 : cdata->oncs.reservations = ctrlr->cdata.oncs.reservations;
2919 3 : cdata->oncs.copy = ctrlr->cdata.oncs.copy;
2920 3 : cdata->ocfs.copy_format0 = cdata->oncs.copy;
2921 3 : if (subsystem->flags.ana_reporting) {
2922 : /* Asymmetric Namespace Access Reporting is supported. */
2923 0 : cdata->cmic.ana_reporting = 1;
2924 0 : cdata->oaes.ana_change_notices = 1;
2925 :
2926 0 : cdata->anatt = ANA_TRANSITION_TIME_IN_SEC;
2927 : /* ANA Change state is not used, and ANA Persistent Loss state
2928 : * is not supported for now.
2929 : */
2930 0 : cdata->anacap.ana_optimized_state = 1;
2931 0 : cdata->anacap.ana_non_optimized_state = 1;
2932 0 : cdata->anacap.ana_inaccessible_state = 1;
2933 : /* ANAGRPID does not change while namespace is attached to controller */
2934 0 : cdata->anacap.no_change_anagrpid = 1;
2935 0 : cdata->anagrpmax = subsystem->max_nsid;
2936 0 : cdata->nanagrpid = subsystem->max_nsid;
2937 : }
2938 :
2939 3 : nvmf_ctrlr_populate_oacs(ctrlr, cdata);
2940 :
2941 3 : assert(subsystem->tgt != NULL);
2942 3 : cdata->crdt[0] = subsystem->tgt->crdt[0];
2943 3 : cdata->crdt[1] = subsystem->tgt->crdt[1];
2944 3 : cdata->crdt[2] = subsystem->tgt->crdt[2];
2945 :
2946 3 : SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ioccsz 0x%x\n",
2947 : cdata->nvmf_specific.ioccsz);
2948 3 : SPDK_DEBUGLOG(nvmf, "ext ctrlr data: iorcsz 0x%x\n",
2949 : cdata->nvmf_specific.iorcsz);
2950 3 : SPDK_DEBUGLOG(nvmf, "ext ctrlr data: icdoff 0x%x\n",
2951 : cdata->nvmf_specific.icdoff);
2952 3 : SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ctrattr 0x%x\n",
2953 : *(uint8_t *)&cdata->nvmf_specific.ctrattr);
2954 3 : SPDK_DEBUGLOG(nvmf, "ext ctrlr data: msdbd 0x%x\n",
2955 : cdata->nvmf_specific.msdbd);
2956 : }
2957 :
2958 3 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2959 : }
2960 :
2961 : static int
2962 1 : nvmf_ns_identify_iocs_zns(struct spdk_nvmf_ns *ns,
2963 : struct spdk_nvme_cmd *cmd,
2964 : struct spdk_nvme_cpl *rsp,
2965 : struct spdk_nvme_zns_ns_data *nsdata_zns)
2966 : {
2967 1 : nsdata_zns->zoc.variable_zone_capacity = 0;
2968 1 : nsdata_zns->zoc.zone_active_excursions = 0;
2969 1 : nsdata_zns->ozcs.read_across_zone_boundaries = 1;
2970 : /* Underflowing the zero based mar and mor bdev helper results in the correct
2971 : value of FFFFFFFFh. */
2972 1 : nsdata_zns->mar = spdk_bdev_get_max_active_zones(ns->bdev) - 1;
2973 1 : nsdata_zns->mor = spdk_bdev_get_max_open_zones(ns->bdev) - 1;
2974 1 : nsdata_zns->rrl = 0;
2975 1 : nsdata_zns->frl = 0;
2976 1 : nsdata_zns->lbafe[0].zsze = spdk_bdev_get_zone_size(ns->bdev);
2977 :
2978 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
2979 1 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
2980 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2981 : }
2982 :
2983 : int
2984 4 : spdk_nvmf_ns_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr,
2985 : struct spdk_nvme_cmd *cmd,
2986 : struct spdk_nvme_cpl *rsp,
2987 : void *nsdata,
2988 : size_t nsdata_size)
2989 : {
2990 4 : uint8_t csi = cmd->cdw11_bits.identify.csi;
2991 4 : struct spdk_nvmf_ns *ns = _nvmf_ctrlr_get_ns_safe(ctrlr, cmd->nsid, rsp);
2992 :
2993 4 : memset(nsdata, 0, nsdata_size);
2994 :
2995 4 : if (ns == NULL) {
2996 2 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
2997 2 : rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
2998 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
2999 : }
3000 :
3001 2 : switch (csi) {
3002 1 : case SPDK_NVME_CSI_ZNS:
3003 1 : return nvmf_ns_identify_iocs_zns(ns, cmd, rsp, nsdata);
3004 1 : default:
3005 1 : break;
3006 : }
3007 :
3008 1 : SPDK_DEBUGLOG(nvmf,
3009 : "Returning zero filled struct for the iocs specific ns "
3010 : "identify command and CSI 0x%02x\n",
3011 : csi);
3012 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3013 1 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3014 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3015 : }
3016 :
3017 : static int
3018 1 : nvmf_ctrlr_identify_iocs_nvm(struct spdk_nvmf_ctrlr *ctrlr,
3019 : struct spdk_nvme_cmd *cmd,
3020 : struct spdk_nvme_cpl *rsp,
3021 : struct spdk_nvme_nvm_ctrlr_data *cdata_nvm)
3022 : {
3023 : /* The unit of max_write_zeroes_size_kib is KiB.
3024 : * The unit of wzsl is the minimum memory page size(2 ^ (12 + CAP.MPSMIN) bytes)
3025 : * and is reported as a power of two (2^n).
3026 : */
3027 2 : cdata_nvm->wzsl = spdk_u64log2(ctrlr->subsys->max_write_zeroes_size_kib >>
3028 1 : (2 + ctrlr->vcprop.cap.bits.mpsmin));
3029 :
3030 : /* The unit of max_discard_size_kib is KiB.
3031 : * The dmrsl indicates the maximum number of logical blocks for
3032 : * dataset management command.
3033 : */
3034 1 : cdata_nvm->dmrsl = ctrlr->subsys->max_discard_size_kib << 1;
3035 1 : cdata_nvm->dmrl = 1;
3036 :
3037 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3038 1 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3039 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3040 : }
3041 :
3042 : static int
3043 4 : nvmf_ctrlr_identify_iocs_zns(struct spdk_nvmf_ctrlr *ctrlr,
3044 : struct spdk_nvme_cmd *cmd,
3045 : struct spdk_nvme_cpl *rsp,
3046 : struct spdk_nvme_zns_ctrlr_data *cdata_zns)
3047 : {
3048 : /* The unit of max_zone_append_size_kib is KiB.
3049 : The unit of zasl is the minimum memory page size
3050 : (2 ^ (12 + CAP.MPSMIN) KiB)
3051 : and is reported as a power of two (2^n). */
3052 8 : cdata_zns->zasl = spdk_u64log2(ctrlr->subsys->max_zone_append_size_kib >>
3053 4 : (12 + ctrlr->vcprop.cap.bits.mpsmin));
3054 :
3055 4 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3056 4 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3057 4 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3058 : }
3059 :
3060 : int
3061 5 : spdk_nvmf_ctrlr_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr,
3062 : struct spdk_nvme_cmd *cmd,
3063 : struct spdk_nvme_cpl *rsp,
3064 : void *cdata,
3065 : size_t cdata_size)
3066 : {
3067 5 : uint8_t csi = cmd->cdw11_bits.identify.csi;
3068 :
3069 5 : memset(cdata, 0, cdata_size);
3070 :
3071 5 : switch (csi) {
3072 1 : case SPDK_NVME_CSI_NVM:
3073 1 : return nvmf_ctrlr_identify_iocs_nvm(ctrlr, cmd, rsp, cdata);
3074 4 : case SPDK_NVME_CSI_ZNS:
3075 4 : return nvmf_ctrlr_identify_iocs_zns(ctrlr, cmd, rsp, cdata);
3076 0 : default:
3077 0 : break;
3078 : }
3079 :
3080 0 : SPDK_DEBUGLOG(nvmf,
3081 : "Returning zero filled struct for the iocs specific ctrlr "
3082 : "identify command and CSI 0x%02x\n",
3083 : csi);
3084 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3085 0 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3086 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3087 : }
3088 :
3089 : static int
3090 0 : nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_ctrlr *ctrlr,
3091 : struct spdk_nvme_cmd *cmd,
3092 : struct spdk_nvme_cpl *rsp,
3093 : struct spdk_nvme_ns_list *ns_list)
3094 : {
3095 0 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
3096 : struct spdk_nvmf_ns *ns;
3097 0 : uint32_t count = 0;
3098 :
3099 0 : if (cmd->nsid >= 0xfffffffeUL) {
3100 0 : SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid);
3101 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
3102 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3103 : }
3104 :
3105 0 : memset(ns_list, 0, sizeof(*ns_list));
3106 :
3107 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL;
3108 0 : ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) {
3109 0 : if (ns->opts.nsid <= cmd->nsid || !nvmf_ctrlr_ns_is_visible(ctrlr, ns->opts.nsid)) {
3110 0 : continue;
3111 : }
3112 :
3113 0 : ns_list->ns_list[count++] = ns->opts.nsid;
3114 0 : if (count == SPDK_COUNTOF(ns_list->ns_list)) {
3115 0 : break;
3116 : }
3117 : }
3118 :
3119 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3120 : }
3121 :
3122 : static void
3123 7 : _add_ns_id_desc(void **buf_ptr, size_t *buf_remain,
3124 : enum spdk_nvme_nidt type,
3125 : const void *data, size_t data_size)
3126 : {
3127 : struct spdk_nvme_ns_id_desc *desc;
3128 7 : size_t desc_size = sizeof(*desc) + data_size;
3129 :
3130 : /*
3131 : * These should never fail in practice, since all valid NS ID descriptors
3132 : * should be defined so that they fit in the available 4096-byte buffer.
3133 : */
3134 7 : assert(data_size > 0);
3135 7 : assert(data_size <= UINT8_MAX);
3136 7 : assert(desc_size < *buf_remain);
3137 7 : if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) {
3138 0 : return;
3139 : }
3140 :
3141 7 : desc = *buf_ptr;
3142 7 : desc->nidt = type;
3143 7 : desc->nidl = data_size;
3144 7 : memcpy(desc->nid, data, data_size);
3145 :
3146 7 : *buf_ptr += desc_size;
3147 7 : *buf_remain -= desc_size;
3148 : }
3149 :
3150 : static int
3151 7 : nvmf_ctrlr_identify_ns_id_descriptor_list(
3152 : struct spdk_nvmf_ctrlr *ctrlr,
3153 : struct spdk_nvme_cmd *cmd,
3154 : struct spdk_nvme_cpl *rsp,
3155 : void *id_desc_list, size_t id_desc_list_size)
3156 : {
3157 : struct spdk_nvmf_ns *ns;
3158 7 : size_t buf_remain = id_desc_list_size;
3159 7 : void *buf_ptr = id_desc_list;
3160 :
3161 7 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
3162 7 : if (ns == NULL || ns->bdev == NULL) {
3163 2 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3164 2 : rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
3165 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3166 : }
3167 :
3168 : #define ADD_ID_DESC(type, data, size) \
3169 : do { \
3170 : if (!spdk_mem_all_zero(data, size)) { \
3171 : _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \
3172 : } \
3173 : } while (0)
3174 :
3175 5 : ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64));
3176 5 : ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid));
3177 5 : ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid));
3178 5 : ADD_ID_DESC(SPDK_NVME_NIDT_CSI, &ns->csi, sizeof(uint8_t));
3179 :
3180 : /*
3181 : * The list is automatically 0-terminated, both in the temporary buffer
3182 : * used by nvmf_ctrlr_identify(), and the eventual iov destination -
3183 : * controller to host buffers in admin commands always get zeroed in
3184 : * nvmf_ctrlr_process_admin_cmd().
3185 : */
3186 :
3187 : #undef ADD_ID_DESC
3188 :
3189 5 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3190 : }
3191 :
3192 : static int
3193 0 : nvmf_ctrlr_identify_iocs(struct spdk_nvmf_ctrlr *ctrlr,
3194 : struct spdk_nvme_cmd *cmd,
3195 : struct spdk_nvme_cpl *rsp,
3196 : void *cdata, size_t cdata_size)
3197 : {
3198 : struct spdk_nvme_iocs_vector *vector;
3199 : struct spdk_nvmf_ns *ns;
3200 :
3201 0 : if (cdata_size < sizeof(struct spdk_nvme_iocs_vector)) {
3202 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3203 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3204 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3205 : }
3206 :
3207 : /* For now we only support this command sent to the current
3208 : * controller.
3209 : */
3210 0 : if (cmd->cdw10_bits.identify.cntid != 0xFFFF &&
3211 0 : cmd->cdw10_bits.identify.cntid != ctrlr->cntlid) {
3212 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3213 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3214 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3215 : }
3216 0 : memset(cdata, 0, cdata_size);
3217 :
3218 0 : vector = cdata;
3219 0 : vector->nvm = 1;
3220 0 : for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL;
3221 0 : ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) {
3222 0 : if (ns->bdev == NULL) {
3223 0 : continue;
3224 : }
3225 0 : if (spdk_bdev_is_zoned(ns->bdev)) {
3226 0 : vector->zns = 1;
3227 : }
3228 : }
3229 :
3230 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3231 0 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3232 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3233 : }
3234 :
3235 : static int
3236 7 : nvmf_ctrlr_identify(struct spdk_nvmf_request *req)
3237 : {
3238 : uint8_t cns;
3239 7 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3240 7 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3241 7 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
3242 7 : struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys;
3243 7 : int ret = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3244 7 : char tmpbuf[SPDK_NVME_IDENTIFY_BUFLEN] = "";
3245 7 : struct spdk_iov_xfer ix;
3246 :
3247 7 : if (req->iovcnt < 1 || req->length < SPDK_NVME_IDENTIFY_BUFLEN) {
3248 0 : SPDK_DEBUGLOG(nvmf, "identify command with invalid buffer\n");
3249 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3250 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3251 0 : return ret;
3252 : }
3253 :
3254 7 : cns = cmd->cdw10_bits.identify.cns;
3255 :
3256 7 : if (spdk_nvmf_subsystem_is_discovery(subsystem) &&
3257 : cns != SPDK_NVME_IDENTIFY_CTRLR) {
3258 : /* Discovery controllers only support Identify Controller */
3259 0 : goto invalid_cns;
3260 : }
3261 :
3262 : /*
3263 : * We must use a temporary buffer: it's entirely possible the out buffer
3264 : * is split across more than one IOV.
3265 : */
3266 7 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
3267 :
3268 7 : SPDK_DEBUGLOG(nvmf, "Received identify command with CNS 0x%02x\n", cns);
3269 :
3270 7 : switch (cns) {
3271 0 : case SPDK_NVME_IDENTIFY_NS:
3272 0 : ret = spdk_nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, (void *)&tmpbuf);
3273 0 : break;
3274 0 : case SPDK_NVME_IDENTIFY_CTRLR:
3275 0 : ret = spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, (void *)&tmpbuf);
3276 0 : break;
3277 0 : case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST:
3278 0 : ret = nvmf_ctrlr_identify_active_ns_list(ctrlr, cmd, rsp, (void *)&tmpbuf);
3279 0 : break;
3280 7 : case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST:
3281 7 : ret = nvmf_ctrlr_identify_ns_id_descriptor_list(ctrlr, cmd, rsp,
3282 7 : tmpbuf, req->length);
3283 7 : break;
3284 0 : case SPDK_NVME_IDENTIFY_NS_IOCS:
3285 0 : ret = spdk_nvmf_ns_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length);
3286 0 : break;
3287 0 : case SPDK_NVME_IDENTIFY_CTRLR_IOCS:
3288 0 : ret = spdk_nvmf_ctrlr_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length);
3289 0 : break;
3290 0 : case SPDK_NVME_IDENTIFY_IOCS:
3291 0 : ret = nvmf_ctrlr_identify_iocs(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length);
3292 0 : break;
3293 0 : default:
3294 0 : goto invalid_cns;
3295 : }
3296 :
3297 7 : if (ret == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) {
3298 7 : spdk_iov_xfer_from_buf(&ix, tmpbuf, sizeof(tmpbuf));
3299 : }
3300 :
3301 7 : return ret;
3302 :
3303 0 : invalid_cns:
3304 0 : SPDK_DEBUGLOG(nvmf, "Identify command with unsupported CNS 0x%02x\n", cns);
3305 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3306 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3307 0 : return ret;
3308 : }
3309 :
3310 : static bool
3311 2 : nvmf_qpair_abort_aer(struct spdk_nvmf_qpair *qpair, uint16_t cid)
3312 : {
3313 2 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
3314 : struct spdk_nvmf_request *req;
3315 : int i;
3316 :
3317 2 : if (!nvmf_qpair_is_admin_queue(qpair)) {
3318 0 : return false;
3319 : }
3320 :
3321 2 : assert(spdk_get_thread() == ctrlr->thread);
3322 :
3323 6 : for (i = 0; i < ctrlr->nr_aer_reqs; i++) {
3324 6 : if (ctrlr->aer_req[i]->cmd->nvme_cmd.cid == cid) {
3325 2 : SPDK_DEBUGLOG(nvmf, "Aborting AER request\n");
3326 2 : req = ctrlr->aer_req[i];
3327 2 : ctrlr->aer_req[i] = NULL;
3328 2 : ctrlr->nr_aer_reqs--;
3329 :
3330 : /* Move the last req to the aborting position for making aer_reqs
3331 : * in continuous
3332 : */
3333 2 : if (i < ctrlr->nr_aer_reqs) {
3334 1 : ctrlr->aer_req[i] = ctrlr->aer_req[ctrlr->nr_aer_reqs];
3335 1 : ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL;
3336 : }
3337 :
3338 2 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3339 2 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST;
3340 2 : _nvmf_request_complete(req);
3341 2 : return true;
3342 : }
3343 : }
3344 :
3345 0 : return false;
3346 : }
3347 :
3348 : void
3349 0 : nvmf_qpair_abort_pending_zcopy_reqs(struct spdk_nvmf_qpair *qpair)
3350 : {
3351 : struct spdk_nvmf_request *req, *tmp;
3352 :
3353 0 : TAILQ_FOREACH_SAFE(req, &qpair->outstanding, link, tmp) {
3354 0 : if (req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE) {
3355 : /* Zero-copy requests are kept on the outstanding queue from the moment
3356 : * zcopy_start is sent until a zcopy_end callback is received. Therefore,
3357 : * we can't remove them from the outstanding queue here, but need to rely on
3358 : * the transport to do a zcopy_end to release their buffers and, in turn,
3359 : * remove them from the queue.
3360 : */
3361 0 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3362 0 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST;
3363 0 : nvmf_transport_req_free(req);
3364 : }
3365 : }
3366 0 : }
3367 :
3368 : static void
3369 0 : nvmf_qpair_abort_request(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_request *req)
3370 : {
3371 0 : uint16_t cid = req->cmd->nvme_cmd.cdw10_bits.abort.cid;
3372 :
3373 0 : if (nvmf_qpair_abort_aer(qpair, cid)) {
3374 0 : SPDK_DEBUGLOG(nvmf, "abort ctrlr=%p sqid=%u cid=%u successful\n",
3375 : qpair->ctrlr, qpair->qid, cid);
3376 0 : req->rsp->nvme_cpl.cdw0 &= ~1U; /* Command successfully aborted */
3377 :
3378 0 : spdk_nvmf_request_complete(req);
3379 0 : return;
3380 : }
3381 :
3382 0 : nvmf_transport_qpair_abort_request(qpair, req);
3383 : }
3384 :
3385 : static void
3386 0 : nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status)
3387 : {
3388 0 : struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i);
3389 :
3390 0 : if (status == 0) {
3391 : /* There was no qpair whose ID matches SQID of the abort command.
3392 : * Hence call _nvmf_request_complete() here.
3393 : */
3394 0 : _nvmf_request_complete(req);
3395 : }
3396 0 : }
3397 :
3398 : static void
3399 0 : nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i)
3400 : {
3401 0 : struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i);
3402 0 : struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
3403 0 : struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch);
3404 0 : uint16_t sqid = req->cmd->nvme_cmd.cdw10_bits.abort.sqid;
3405 : struct spdk_nvmf_qpair *qpair;
3406 :
3407 0 : TAILQ_FOREACH(qpair, &group->qpairs, link) {
3408 0 : if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) {
3409 : /* Found the qpair */
3410 :
3411 0 : nvmf_qpair_abort_request(qpair, req);
3412 :
3413 : /* Return -1 for the status so the iteration across threads stops. */
3414 0 : spdk_for_each_channel_continue(i, -1);
3415 0 : return;
3416 : }
3417 : }
3418 :
3419 0 : spdk_for_each_channel_continue(i, 0);
3420 : }
3421 :
3422 : static int
3423 0 : nvmf_ctrlr_abort(struct spdk_nvmf_request *req)
3424 : {
3425 0 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
3426 :
3427 0 : rsp->cdw0 = 1U; /* Command not aborted */
3428 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
3429 0 : rsp->status.sc = SPDK_NVME_SC_SUCCESS;
3430 :
3431 : /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */
3432 0 : spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt,
3433 : nvmf_ctrlr_abort_on_pg,
3434 : req,
3435 : nvmf_ctrlr_abort_done
3436 : );
3437 :
3438 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
3439 : }
3440 :
3441 : int
3442 0 : nvmf_ctrlr_abort_request(struct spdk_nvmf_request *req)
3443 : {
3444 0 : struct spdk_nvmf_request *req_to_abort = req->req_to_abort;
3445 0 : struct spdk_bdev *bdev;
3446 0 : struct spdk_bdev_desc *desc;
3447 0 : struct spdk_io_channel *ch;
3448 : int rc;
3449 :
3450 0 : assert(req_to_abort != NULL);
3451 :
3452 0 : if (g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr &&
3453 0 : nvmf_qpair_is_admin_queue(req_to_abort->qpair)) {
3454 0 : return g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr(req);
3455 : }
3456 :
3457 0 : rc = spdk_nvmf_request_get_bdev(req_to_abort->cmd->nvme_cmd.nsid, req_to_abort,
3458 : &bdev, &desc, &ch);
3459 0 : if (rc != 0) {
3460 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3461 : }
3462 :
3463 0 : return spdk_nvmf_bdev_ctrlr_abort_cmd(bdev, desc, ch, req, req_to_abort);
3464 : }
3465 :
3466 : static int
3467 1 : get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0)
3468 : {
3469 1 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
3470 :
3471 1 : rsp->cdw0 = cdw0;
3472 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3473 : }
3474 :
3475 : /* we have to use the typedef in the function declaration to appease astyle. */
3476 : typedef enum spdk_nvme_path_status_code spdk_nvme_path_status_code_t;
3477 :
3478 : static spdk_nvme_path_status_code_t
3479 0 : _nvme_ana_state_to_path_status(enum spdk_nvme_ana_state ana_state)
3480 : {
3481 0 : switch (ana_state) {
3482 0 : case SPDK_NVME_ANA_INACCESSIBLE_STATE:
3483 0 : return SPDK_NVME_SC_ASYMMETRIC_ACCESS_INACCESSIBLE;
3484 0 : case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE:
3485 0 : return SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS;
3486 0 : case SPDK_NVME_ANA_CHANGE_STATE:
3487 0 : return SPDK_NVME_SC_ASYMMETRIC_ACCESS_TRANSITION;
3488 0 : default:
3489 0 : return SPDK_NVME_SC_INTERNAL_PATH_ERROR;
3490 : }
3491 : }
3492 :
3493 : static int
3494 3 : nvmf_ctrlr_get_features(struct spdk_nvmf_request *req)
3495 : {
3496 : uint8_t feature;
3497 3 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3498 3 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3499 3 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
3500 : enum spdk_nvme_ana_state ana_state;
3501 :
3502 3 : feature = cmd->cdw10_bits.get_features.fid;
3503 :
3504 3 : if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) {
3505 : /*
3506 : * Features supported by Discovery controller
3507 : */
3508 0 : switch (feature) {
3509 0 : case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER:
3510 0 : return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw);
3511 0 : case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION:
3512 0 : return get_features_generic(req, ctrlr->feat.async_event_configuration.raw);
3513 0 : default:
3514 0 : SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature);
3515 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3516 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3517 : }
3518 : }
3519 : /*
3520 : * Process Get Features command for non-discovery controller
3521 : */
3522 3 : ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid);
3523 3 : switch (ana_state) {
3524 0 : case SPDK_NVME_ANA_INACCESSIBLE_STATE:
3525 : case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE:
3526 : case SPDK_NVME_ANA_CHANGE_STATE:
3527 0 : switch (feature) {
3528 0 : case SPDK_NVME_FEAT_ERROR_RECOVERY:
3529 : case SPDK_NVME_FEAT_WRITE_ATOMICITY:
3530 : case SPDK_NVME_FEAT_HOST_RESERVE_MASK:
3531 : case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST:
3532 0 : response->status.sct = SPDK_NVME_SCT_PATH;
3533 0 : response->status.sc = _nvme_ana_state_to_path_status(ana_state);
3534 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3535 0 : default:
3536 0 : break;
3537 : }
3538 0 : break;
3539 3 : default:
3540 3 : break;
3541 : }
3542 :
3543 3 : switch (feature) {
3544 0 : case SPDK_NVME_FEAT_ARBITRATION:
3545 0 : return get_features_generic(req, ctrlr->feat.arbitration.raw);
3546 0 : case SPDK_NVME_FEAT_POWER_MANAGEMENT:
3547 0 : return get_features_generic(req, ctrlr->feat.power_management.raw);
3548 2 : case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD:
3549 2 : return nvmf_ctrlr_get_features_temperature_threshold(req);
3550 1 : case SPDK_NVME_FEAT_ERROR_RECOVERY:
3551 1 : return get_features_generic(req, ctrlr->feat.error_recovery.raw);
3552 0 : case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE:
3553 0 : return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw);
3554 0 : case SPDK_NVME_FEAT_NUMBER_OF_QUEUES:
3555 0 : return get_features_generic(req, ctrlr->feat.number_of_queues.raw);
3556 0 : case SPDK_NVME_FEAT_INTERRUPT_COALESCING:
3557 0 : return get_features_generic(req, ctrlr->feat.interrupt_coalescing.raw);
3558 0 : case SPDK_NVME_FEAT_INTERRUPT_VECTOR_CONFIGURATION:
3559 0 : return nvmf_ctrlr_get_features_interrupt_vector_configuration(req);
3560 0 : case SPDK_NVME_FEAT_WRITE_ATOMICITY:
3561 0 : return get_features_generic(req, ctrlr->feat.write_atomicity.raw);
3562 0 : case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION:
3563 0 : return get_features_generic(req, ctrlr->feat.async_event_configuration.raw);
3564 0 : case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER:
3565 0 : return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw);
3566 0 : case SPDK_NVME_FEAT_HOST_IDENTIFIER:
3567 0 : return nvmf_ctrlr_get_features_host_identifier(req);
3568 0 : case SPDK_NVME_FEAT_HOST_RESERVE_MASK:
3569 0 : return nvmf_ctrlr_get_features_reservation_notification_mask(req);
3570 0 : case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST:
3571 0 : return nvmf_ctrlr_get_features_reservation_persistence(req);
3572 0 : case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT:
3573 0 : return nvmf_ctrlr_get_features_host_behavior_support(req);
3574 0 : default:
3575 0 : SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature);
3576 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3577 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3578 : }
3579 : }
3580 :
3581 : static int
3582 5 : nvmf_ctrlr_set_features(struct spdk_nvmf_request *req)
3583 : {
3584 : uint8_t feature, save;
3585 5 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3586 5 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3587 5 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
3588 : enum spdk_nvme_ana_state ana_state;
3589 : /*
3590 : * Features are not saveable by the controller as indicated by
3591 : * ONCS field of the Identify Controller data.
3592 : * */
3593 5 : save = cmd->cdw10_bits.set_features.sv;
3594 5 : if (save) {
3595 0 : response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE;
3596 0 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
3597 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3598 : }
3599 :
3600 5 : feature = cmd->cdw10_bits.set_features.fid;
3601 :
3602 5 : if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) {
3603 : /*
3604 : * Features supported by Discovery controller
3605 : */
3606 0 : switch (feature) {
3607 0 : case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER:
3608 0 : return nvmf_ctrlr_set_features_keep_alive_timer(req);
3609 0 : case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION:
3610 0 : return nvmf_ctrlr_set_features_async_event_configuration(req);
3611 0 : default:
3612 0 : SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature);
3613 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3614 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3615 : }
3616 : }
3617 : /*
3618 : * Process Set Features command for non-discovery controller
3619 : */
3620 5 : ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid);
3621 5 : switch (ana_state) {
3622 0 : case SPDK_NVME_ANA_INACCESSIBLE_STATE:
3623 : case SPDK_NVME_ANA_CHANGE_STATE:
3624 0 : if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) {
3625 0 : response->status.sct = SPDK_NVME_SCT_PATH;
3626 0 : response->status.sc = _nvme_ana_state_to_path_status(ana_state);
3627 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3628 : } else {
3629 0 : switch (feature) {
3630 0 : case SPDK_NVME_FEAT_ERROR_RECOVERY:
3631 : case SPDK_NVME_FEAT_WRITE_ATOMICITY:
3632 : case SPDK_NVME_FEAT_HOST_RESERVE_MASK:
3633 : case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST:
3634 0 : response->status.sct = SPDK_NVME_SCT_PATH;
3635 0 : response->status.sc = _nvme_ana_state_to_path_status(ana_state);
3636 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3637 0 : default:
3638 0 : break;
3639 : }
3640 : }
3641 0 : break;
3642 0 : case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE:
3643 0 : response->status.sct = SPDK_NVME_SCT_PATH;
3644 0 : response->status.sc = SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS;
3645 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3646 5 : default:
3647 5 : break;
3648 : }
3649 :
3650 5 : switch (feature) {
3651 0 : case SPDK_NVME_FEAT_ARBITRATION:
3652 0 : return nvmf_ctrlr_set_features_arbitration(req);
3653 0 : case SPDK_NVME_FEAT_POWER_MANAGEMENT:
3654 0 : return nvmf_ctrlr_set_features_power_management(req);
3655 3 : case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD:
3656 3 : return nvmf_ctrlr_set_features_temperature_threshold(req);
3657 2 : case SPDK_NVME_FEAT_ERROR_RECOVERY:
3658 2 : return nvmf_ctrlr_set_features_error_recovery(req);
3659 0 : case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE:
3660 0 : return nvmf_ctrlr_set_features_volatile_write_cache(req);
3661 0 : case SPDK_NVME_FEAT_NUMBER_OF_QUEUES:
3662 0 : return nvmf_ctrlr_set_features_number_of_queues(req);
3663 0 : case SPDK_NVME_FEAT_INTERRUPT_COALESCING:
3664 0 : response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
3665 0 : response->status.sc = SPDK_NVME_SC_FEATURE_NOT_CHANGEABLE;
3666 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3667 0 : case SPDK_NVME_FEAT_WRITE_ATOMICITY:
3668 0 : return nvmf_ctrlr_set_features_write_atomicity(req);
3669 0 : case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION:
3670 0 : return nvmf_ctrlr_set_features_async_event_configuration(req);
3671 0 : case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER:
3672 0 : return nvmf_ctrlr_set_features_keep_alive_timer(req);
3673 0 : case SPDK_NVME_FEAT_HOST_IDENTIFIER:
3674 0 : return nvmf_ctrlr_set_features_host_identifier(req);
3675 0 : case SPDK_NVME_FEAT_HOST_RESERVE_MASK:
3676 0 : return nvmf_ctrlr_set_features_reservation_notification_mask(req);
3677 0 : case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST:
3678 0 : return nvmf_ctrlr_set_features_reservation_persistence(req);
3679 0 : case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT:
3680 0 : return nvmf_ctrlr_set_features_host_behavior_support(req);
3681 0 : default:
3682 0 : SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature);
3683 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3684 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3685 : }
3686 : }
3687 :
3688 : static int
3689 0 : nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req)
3690 : {
3691 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3692 :
3693 0 : SPDK_DEBUGLOG(nvmf, "Keep Alive\n");
3694 : /*
3695 : * To handle keep alive just clear or reset the
3696 : * ctrlr based keep alive duration counter.
3697 : * When added, a separate timer based process
3698 : * will monitor if the time since last recorded
3699 : * keep alive has exceeded the max duration and
3700 : * take appropriate action.
3701 : */
3702 0 : ctrlr->last_keep_alive_tick = spdk_get_ticks();
3703 :
3704 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3705 : }
3706 :
3707 : int
3708 18 : nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req)
3709 : {
3710 18 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
3711 18 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
3712 18 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
3713 : struct spdk_nvmf_subsystem_poll_group *sgroup;
3714 : int rc;
3715 :
3716 18 : assert(ctrlr != NULL);
3717 18 : if (cmd->opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST) {
3718 : /* We do not want to treat AERs as outstanding commands,
3719 : * so decrement mgmt_io_outstanding here to offset
3720 : * the increment that happened prior to this call.
3721 : */
3722 10 : sgroup = &req->qpair->group->sgroups[ctrlr->subsys->id];
3723 10 : assert(sgroup != NULL);
3724 10 : sgroup->mgmt_io_outstanding--;
3725 : }
3726 :
3727 18 : assert(spdk_get_thread() == ctrlr->thread);
3728 :
3729 18 : if (cmd->fuse != 0) {
3730 : /* Fused admin commands are not supported. */
3731 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
3732 0 : response->status.sc = SPDK_NVME_SC_INVALID_FIELD;
3733 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3734 : }
3735 :
3736 18 : if (ctrlr->vcprop.cc.bits.en != 1) {
3737 0 : SPDK_ERRLOG("Admin command sent to disabled controller\n");
3738 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
3739 0 : response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR;
3740 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3741 : }
3742 :
3743 18 : if (req->iovcnt && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) {
3744 7 : spdk_iov_memset(req->iov, req->iovcnt, 0);
3745 : }
3746 :
3747 18 : if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) {
3748 : /* Discovery controllers only support these admin OPS. */
3749 0 : switch (cmd->opc) {
3750 0 : case SPDK_NVME_OPC_IDENTIFY:
3751 : case SPDK_NVME_OPC_GET_LOG_PAGE:
3752 : case SPDK_NVME_OPC_KEEP_ALIVE:
3753 : case SPDK_NVME_OPC_SET_FEATURES:
3754 : case SPDK_NVME_OPC_GET_FEATURES:
3755 : case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST:
3756 0 : break;
3757 0 : default:
3758 0 : goto invalid_opcode;
3759 : }
3760 : }
3761 :
3762 : /* Call a custom adm cmd handler if set. Aborts are handled in a different path (see nvmf_passthru_admin_cmd) */
3763 18 : if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr && cmd->opc != SPDK_NVME_OPC_ABORT) {
3764 1 : rc = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr(req);
3765 1 : if (rc >= SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) {
3766 : /* The handler took care of this command */
3767 1 : return rc;
3768 : }
3769 : }
3770 :
3771 17 : switch (cmd->opc) {
3772 0 : case SPDK_NVME_OPC_GET_LOG_PAGE:
3773 0 : return nvmf_ctrlr_get_log_page(req);
3774 7 : case SPDK_NVME_OPC_IDENTIFY:
3775 7 : return nvmf_ctrlr_identify(req);
3776 0 : case SPDK_NVME_OPC_ABORT:
3777 0 : return nvmf_ctrlr_abort(req);
3778 0 : case SPDK_NVME_OPC_GET_FEATURES:
3779 0 : return nvmf_ctrlr_get_features(req);
3780 0 : case SPDK_NVME_OPC_SET_FEATURES:
3781 0 : return nvmf_ctrlr_set_features(req);
3782 10 : case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST:
3783 10 : return nvmf_ctrlr_async_event_request(req);
3784 0 : case SPDK_NVME_OPC_KEEP_ALIVE:
3785 0 : return nvmf_ctrlr_keep_alive(req);
3786 :
3787 0 : case SPDK_NVME_OPC_CREATE_IO_SQ:
3788 : case SPDK_NVME_OPC_CREATE_IO_CQ:
3789 : case SPDK_NVME_OPC_DELETE_IO_SQ:
3790 : case SPDK_NVME_OPC_DELETE_IO_CQ:
3791 : /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */
3792 0 : goto invalid_opcode;
3793 :
3794 0 : default:
3795 0 : goto invalid_opcode;
3796 : }
3797 :
3798 0 : invalid_opcode:
3799 0 : SPDK_INFOLOG(nvmf, "Unsupported admin opcode 0x%x\n", cmd->opc);
3800 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
3801 0 : response->status.sc = SPDK_NVME_SC_INVALID_OPCODE;
3802 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3803 : }
3804 :
3805 : static int
3806 0 : nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req)
3807 : {
3808 0 : struct spdk_nvmf_qpair *qpair = req->qpair;
3809 : struct spdk_nvmf_capsule_cmd *cap_hdr;
3810 :
3811 0 : cap_hdr = &req->cmd->nvmf_cmd;
3812 :
3813 0 : if (qpair->ctrlr == NULL) {
3814 : /* No ctrlr established yet; the only valid command is Connect */
3815 0 : assert(cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT);
3816 0 : return nvmf_ctrlr_cmd_connect(req);
3817 0 : } else if (nvmf_qpair_is_admin_queue(qpair)) {
3818 : /*
3819 : * Controller session is established, and this is an admin queue.
3820 : * Disallow Connect and allow other fabrics commands.
3821 : */
3822 0 : switch (cap_hdr->fctype) {
3823 0 : case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET:
3824 0 : return nvmf_property_set(req);
3825 0 : case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET:
3826 0 : return nvmf_property_get(req);
3827 0 : case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND:
3828 : case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV:
3829 0 : return nvmf_auth_request_exec(req);
3830 0 : default:
3831 0 : SPDK_DEBUGLOG(nvmf, "unknown fctype 0x%02x\n",
3832 : cap_hdr->fctype);
3833 0 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3834 0 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE;
3835 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3836 : }
3837 : } else {
3838 : /*
3839 : * Controller session is established, and this is an I/O queue.
3840 : * Disallow everything besides authentication commands.
3841 : */
3842 0 : switch (cap_hdr->fctype) {
3843 0 : case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND:
3844 : case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV:
3845 0 : return nvmf_auth_request_exec(req);
3846 0 : default:
3847 0 : SPDK_DEBUGLOG(nvmf, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype);
3848 0 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
3849 0 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE;
3850 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
3851 : }
3852 : }
3853 : }
3854 :
3855 : static inline void
3856 5 : nvmf_ctrlr_queue_pending_async_event(struct spdk_nvmf_ctrlr *ctrlr,
3857 : union spdk_nvme_async_event_completion *event)
3858 : {
3859 : struct spdk_nvmf_async_event_completion *nvmf_event;
3860 :
3861 5 : nvmf_event = calloc(1, sizeof(*nvmf_event));
3862 5 : if (!nvmf_event) {
3863 0 : SPDK_ERRLOG("Alloc nvmf event failed, ignore the event\n");
3864 0 : return;
3865 : }
3866 5 : nvmf_event->event.raw = event->raw;
3867 5 : STAILQ_INSERT_TAIL(&ctrlr->async_events, nvmf_event, link);
3868 : }
3869 :
3870 : static inline int
3871 6 : nvmf_ctrlr_async_event_notification(struct spdk_nvmf_ctrlr *ctrlr,
3872 : union spdk_nvme_async_event_completion *event)
3873 : {
3874 : struct spdk_nvmf_request *req;
3875 : struct spdk_nvme_cpl *rsp;
3876 :
3877 6 : assert(spdk_get_thread() == ctrlr->thread);
3878 :
3879 : /* If there is no outstanding AER request, queue the event. Then
3880 : * if an AER is later submitted, this event can be sent as a
3881 : * response.
3882 : */
3883 6 : if (ctrlr->nr_aer_reqs == 0) {
3884 5 : nvmf_ctrlr_queue_pending_async_event(ctrlr, event);
3885 5 : return 0;
3886 : }
3887 :
3888 1 : req = ctrlr->aer_req[--ctrlr->nr_aer_reqs];
3889 1 : rsp = &req->rsp->nvme_cpl;
3890 :
3891 1 : rsp->cdw0 = event->raw;
3892 :
3893 1 : _nvmf_request_complete(req);
3894 1 : ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL;
3895 :
3896 1 : return 0;
3897 : }
3898 :
3899 : int
3900 6 : nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr)
3901 : {
3902 6 : union spdk_nvme_async_event_completion event = {0};
3903 :
3904 : /* Users may disable the event notification */
3905 6 : if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) {
3906 0 : return 0;
3907 : }
3908 :
3909 6 : if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT)) {
3910 3 : return 0;
3911 : }
3912 :
3913 3 : event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE;
3914 3 : event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED;
3915 3 : event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST;
3916 :
3917 3 : return nvmf_ctrlr_async_event_notification(ctrlr, &event);
3918 : }
3919 :
3920 : int
3921 1 : nvmf_ctrlr_async_event_ana_change_notice(struct spdk_nvmf_ctrlr *ctrlr)
3922 : {
3923 1 : union spdk_nvme_async_event_completion event = {0};
3924 :
3925 : /* Users may disable the event notification */
3926 1 : if (!ctrlr->feat.async_event_configuration.bits.ana_change_notice) {
3927 0 : return 0;
3928 : }
3929 :
3930 1 : if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT)) {
3931 0 : return 0;
3932 : }
3933 :
3934 1 : event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE;
3935 1 : event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_ANA_CHANGE;
3936 1 : event.bits.log_page_identifier = SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS;
3937 :
3938 1 : return nvmf_ctrlr_async_event_notification(ctrlr, &event);
3939 : }
3940 :
3941 : void
3942 3 : nvmf_ctrlr_async_event_reservation_notification(struct spdk_nvmf_ctrlr *ctrlr)
3943 : {
3944 3 : union spdk_nvme_async_event_completion event = {0};
3945 :
3946 3 : if (!ctrlr->num_avail_log_pages) {
3947 0 : return;
3948 : }
3949 :
3950 3 : if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT)) {
3951 2 : return;
3952 : }
3953 :
3954 1 : event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_IO;
3955 1 : event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL;
3956 1 : event.bits.log_page_identifier = SPDK_NVME_LOG_RESERVATION_NOTIFICATION;
3957 :
3958 1 : nvmf_ctrlr_async_event_notification(ctrlr, &event);
3959 : }
3960 :
3961 : void
3962 1 : nvmf_ctrlr_async_event_discovery_log_change_notice(void *ctx)
3963 : {
3964 1 : union spdk_nvme_async_event_completion event = {0};
3965 1 : struct spdk_nvmf_ctrlr *ctrlr = ctx;
3966 :
3967 : /* Users may disable the event notification manually or
3968 : * it may not be enabled due to keep alive timeout
3969 : * not being set in connect command to discovery controller.
3970 : */
3971 1 : if (!ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice) {
3972 0 : return;
3973 : }
3974 :
3975 1 : if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT)) {
3976 0 : return;
3977 : }
3978 :
3979 1 : event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE;
3980 1 : event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE;
3981 1 : event.bits.log_page_identifier = SPDK_NVME_LOG_DISCOVERY;
3982 :
3983 1 : nvmf_ctrlr_async_event_notification(ctrlr, &event);
3984 : }
3985 :
3986 : int
3987 0 : spdk_nvmf_ctrlr_async_event_error_event(struct spdk_nvmf_ctrlr *ctrlr,
3988 : enum spdk_nvme_async_event_info_error info)
3989 : {
3990 0 : union spdk_nvme_async_event_completion event;
3991 :
3992 0 : if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT)) {
3993 0 : return 0;
3994 : }
3995 :
3996 0 : if (info > SPDK_NVME_ASYNC_EVENT_FW_IMAGE_LOAD) {
3997 0 : return 0;
3998 : }
3999 :
4000 0 : event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_ERROR;
4001 0 : event.bits.log_page_identifier = SPDK_NVME_LOG_ERROR;
4002 0 : event.bits.async_event_info = info;
4003 :
4004 0 : return nvmf_ctrlr_async_event_notification(ctrlr, &event);
4005 : }
4006 :
4007 : void
4008 0 : nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair)
4009 : {
4010 0 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
4011 : int i;
4012 :
4013 0 : if (ctrlr == NULL || !nvmf_qpair_is_admin_queue(qpair)) {
4014 0 : return;
4015 : }
4016 :
4017 0 : assert(spdk_get_thread() == ctrlr->thread);
4018 :
4019 0 : for (i = 0; i < ctrlr->nr_aer_reqs; i++) {
4020 0 : spdk_nvmf_request_free(ctrlr->aer_req[i]);
4021 0 : ctrlr->aer_req[i] = NULL;
4022 : }
4023 :
4024 0 : ctrlr->nr_aer_reqs = 0;
4025 : }
4026 :
4027 : void
4028 0 : spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr)
4029 : {
4030 : struct spdk_nvmf_request *req;
4031 : int i;
4032 :
4033 0 : assert(spdk_get_thread() == ctrlr->thread);
4034 :
4035 0 : if (!ctrlr->nr_aer_reqs) {
4036 0 : return;
4037 : }
4038 :
4039 0 : for (i = 0; i < ctrlr->nr_aer_reqs; i++) {
4040 0 : req = ctrlr->aer_req[i];
4041 :
4042 0 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
4043 0 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST;
4044 0 : _nvmf_request_complete(req);
4045 :
4046 0 : ctrlr->aer_req[i] = NULL;
4047 : }
4048 :
4049 0 : ctrlr->nr_aer_reqs = 0;
4050 : }
4051 :
4052 : static void
4053 3 : _nvmf_ctrlr_add_reservation_log(void *ctx)
4054 : {
4055 3 : struct spdk_nvmf_reservation_log *log = (struct spdk_nvmf_reservation_log *)ctx;
4056 3 : struct spdk_nvmf_ctrlr *ctrlr = log->ctrlr;
4057 :
4058 3 : ctrlr->log_page_count++;
4059 :
4060 : /* Maximum number of queued log pages is 255 */
4061 3 : if (ctrlr->num_avail_log_pages == 0xff) {
4062 : struct spdk_nvmf_reservation_log *entry;
4063 0 : entry = TAILQ_LAST(&ctrlr->log_head, log_page_head);
4064 0 : entry->log.log_page_count = ctrlr->log_page_count;
4065 0 : free(log);
4066 0 : return;
4067 : }
4068 :
4069 3 : log->log.log_page_count = ctrlr->log_page_count;
4070 3 : log->log.num_avail_log_pages = ctrlr->num_avail_log_pages++;
4071 3 : TAILQ_INSERT_TAIL(&ctrlr->log_head, log, link);
4072 :
4073 3 : nvmf_ctrlr_async_event_reservation_notification(ctrlr);
4074 : }
4075 :
4076 : void
4077 6 : nvmf_ctrlr_reservation_notice_log(struct spdk_nvmf_ctrlr *ctrlr,
4078 : struct spdk_nvmf_ns *ns,
4079 : enum spdk_nvme_reservation_notification_log_page_type type)
4080 : {
4081 : struct spdk_nvmf_reservation_log *log;
4082 :
4083 6 : switch (type) {
4084 0 : case SPDK_NVME_RESERVATION_LOG_PAGE_EMPTY:
4085 0 : return;
4086 2 : case SPDK_NVME_REGISTRATION_PREEMPTED:
4087 2 : if (ns->mask & SPDK_NVME_REGISTRATION_PREEMPTED_MASK) {
4088 1 : return;
4089 : }
4090 1 : break;
4091 2 : case SPDK_NVME_RESERVATION_RELEASED:
4092 2 : if (ns->mask & SPDK_NVME_RESERVATION_RELEASED_MASK) {
4093 1 : return;
4094 : }
4095 1 : break;
4096 2 : case SPDK_NVME_RESERVATION_PREEMPTED:
4097 2 : if (ns->mask & SPDK_NVME_RESERVATION_PREEMPTED_MASK) {
4098 1 : return;
4099 : }
4100 1 : break;
4101 0 : default:
4102 0 : return;
4103 : }
4104 :
4105 3 : log = calloc(1, sizeof(*log));
4106 3 : if (!log) {
4107 0 : SPDK_ERRLOG("Alloc log page failed, ignore the log\n");
4108 0 : return;
4109 : }
4110 3 : log->ctrlr = ctrlr;
4111 3 : log->log.type = type;
4112 3 : log->log.nsid = ns->nsid;
4113 :
4114 3 : spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_reservation_log, log);
4115 : }
4116 :
4117 : /* Check from subsystem poll group's namespace information data structure */
4118 : static bool
4119 28 : nvmf_ns_info_ctrlr_is_registrant(struct spdk_nvmf_subsystem_pg_ns_info *ns_info,
4120 : struct spdk_nvmf_ctrlr *ctrlr)
4121 : {
4122 : uint32_t i;
4123 :
4124 205 : for (i = 0; i < SPDK_NVMF_MAX_NUM_REGISTRANTS; i++) {
4125 195 : if (!spdk_uuid_compare(&ns_info->reg_hostid[i], &ctrlr->hostid)) {
4126 18 : return true;
4127 : }
4128 : }
4129 :
4130 10 : return false;
4131 : }
4132 :
4133 : /*
4134 : * Check the NVMe command is permitted or not for current controller(Host).
4135 : */
4136 : static int
4137 38 : nvmf_ns_reservation_request_check(struct spdk_nvmf_subsystem_pg_ns_info *ns_info,
4138 : struct spdk_nvmf_ctrlr *ctrlr,
4139 : struct spdk_nvmf_request *req)
4140 : {
4141 38 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
4142 38 : enum spdk_nvme_reservation_type rtype = ns_info->rtype;
4143 38 : uint8_t status = SPDK_NVME_SC_SUCCESS;
4144 : uint8_t racqa;
4145 : bool is_registrant;
4146 :
4147 : /* No valid reservation */
4148 38 : if (!rtype) {
4149 10 : return 0;
4150 : }
4151 :
4152 28 : is_registrant = nvmf_ns_info_ctrlr_is_registrant(ns_info, ctrlr);
4153 : /* All registrants type and current ctrlr is a valid registrant */
4154 28 : if ((rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS ||
4155 9 : rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && is_registrant) {
4156 5 : return 0;
4157 23 : } else if (!spdk_uuid_compare(&ns_info->holder_id, &ctrlr->hostid)) {
4158 4 : return 0;
4159 : }
4160 :
4161 : /* Non-holder for current controller */
4162 19 : switch (cmd->opc) {
4163 9 : case SPDK_NVME_OPC_READ:
4164 : case SPDK_NVME_OPC_COMPARE:
4165 9 : if (rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) {
4166 1 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4167 1 : goto exit;
4168 : }
4169 8 : if ((rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY ||
4170 2 : rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && !is_registrant) {
4171 2 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4172 : }
4173 8 : break;
4174 9 : case SPDK_NVME_OPC_FLUSH:
4175 : case SPDK_NVME_OPC_WRITE:
4176 : case SPDK_NVME_OPC_WRITE_UNCORRECTABLE:
4177 : case SPDK_NVME_OPC_WRITE_ZEROES:
4178 : case SPDK_NVME_OPC_DATASET_MANAGEMENT:
4179 9 : if (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE ||
4180 : rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) {
4181 3 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4182 3 : goto exit;
4183 : }
4184 6 : if (!is_registrant) {
4185 4 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4186 : }
4187 6 : break;
4188 0 : case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
4189 0 : racqa = cmd->cdw10_bits.resv_acquire.racqa;
4190 0 : if (racqa == SPDK_NVME_RESERVE_ACQUIRE) {
4191 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4192 0 : goto exit;
4193 : }
4194 0 : if (!is_registrant) {
4195 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4196 : }
4197 0 : break;
4198 1 : case SPDK_NVME_OPC_RESERVATION_RELEASE:
4199 1 : if (!is_registrant) {
4200 0 : status = SPDK_NVME_SC_RESERVATION_CONFLICT;
4201 : }
4202 1 : break;
4203 0 : default:
4204 0 : break;
4205 : }
4206 :
4207 19 : exit:
4208 19 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
4209 19 : req->rsp->nvme_cpl.status.sc = status;
4210 19 : if (status == SPDK_NVME_SC_RESERVATION_CONFLICT) {
4211 10 : return -EPERM;
4212 : }
4213 :
4214 9 : return 0;
4215 : }
4216 :
4217 : static int
4218 6 : nvmf_ctrlr_process_io_fused_cmd(struct spdk_nvmf_request *req, struct spdk_bdev *bdev,
4219 : struct spdk_bdev_desc *desc, struct spdk_io_channel *ch)
4220 : {
4221 6 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
4222 6 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
4223 6 : struct spdk_nvmf_request *first_fused_req = req->qpair->first_fused_req;
4224 : int rc;
4225 :
4226 6 : if (cmd->fuse == SPDK_NVME_CMD_FUSE_FIRST) {
4227 : /* first fused operation (should be compare) */
4228 3 : if (first_fused_req != NULL) {
4229 0 : struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl;
4230 :
4231 0 : SPDK_ERRLOG("Wrong sequence of fused operations\n");
4232 :
4233 : /* abort req->qpair->first_fused_request and continue with new fused command */
4234 0 : fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED;
4235 0 : fused_response->status.sct = SPDK_NVME_SCT_GENERIC;
4236 0 : _nvmf_request_complete(first_fused_req);
4237 3 : } else if (cmd->opc != SPDK_NVME_OPC_COMPARE) {
4238 1 : SPDK_ERRLOG("Wrong op code of fused operations\n");
4239 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
4240 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE;
4241 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4242 : }
4243 :
4244 2 : req->qpair->first_fused_req = req;
4245 2 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
4246 3 : } else if (cmd->fuse == SPDK_NVME_CMD_FUSE_SECOND) {
4247 : /* second fused operation (should be write) */
4248 3 : if (first_fused_req == NULL) {
4249 1 : SPDK_ERRLOG("Wrong sequence of fused operations\n");
4250 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
4251 1 : rsp->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED;
4252 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4253 2 : } else if (cmd->opc != SPDK_NVME_OPC_WRITE) {
4254 1 : struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl;
4255 :
4256 1 : SPDK_ERRLOG("Wrong op code of fused operations\n");
4257 :
4258 : /* abort req->qpair->first_fused_request and fail current command */
4259 1 : fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED;
4260 1 : fused_response->status.sct = SPDK_NVME_SCT_GENERIC;
4261 1 : _nvmf_request_complete(first_fused_req);
4262 :
4263 1 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
4264 1 : rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE;
4265 1 : req->qpair->first_fused_req = NULL;
4266 1 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4267 : }
4268 :
4269 : /* save request of first command to generate response later */
4270 1 : req->first_fused_req = first_fused_req;
4271 1 : req->first_fused = true;
4272 1 : req->qpair->first_fused_req = NULL;
4273 : } else {
4274 0 : SPDK_ERRLOG("Invalid fused command fuse field.\n");
4275 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
4276 0 : rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD;
4277 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4278 : }
4279 :
4280 1 : rc = nvmf_bdev_ctrlr_compare_and_write_cmd(bdev, desc, ch, req->first_fused_req, req);
4281 :
4282 1 : if (rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) {
4283 1 : if (spdk_nvme_cpl_is_error(rsp)) {
4284 0 : struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl;
4285 :
4286 0 : fused_response->status = rsp->status;
4287 0 : rsp->status.sct = SPDK_NVME_SCT_GENERIC;
4288 0 : rsp->status.sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED;
4289 : /* Complete first of fused commands. Second will be completed by upper layer */
4290 0 : _nvmf_request_complete(first_fused_req);
4291 0 : req->first_fused_req = NULL;
4292 0 : req->first_fused = false;
4293 : }
4294 : }
4295 :
4296 1 : return rc;
4297 : }
4298 :
4299 : bool
4300 271 : nvmf_ctrlr_use_zcopy(struct spdk_nvmf_request *req)
4301 : {
4302 271 : struct spdk_nvmf_transport *transport = req->qpair->transport;
4303 : struct spdk_nvmf_ns *ns;
4304 :
4305 271 : assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE);
4306 :
4307 271 : if (!transport->opts.zcopy) {
4308 3 : return false;
4309 : }
4310 :
4311 268 : if (nvmf_qpair_is_admin_queue(req->qpair)) {
4312 : /* Admin queue */
4313 1 : return false;
4314 : }
4315 :
4316 267 : if ((req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_WRITE) &&
4317 262 : (req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_READ)) {
4318 : /* Not a READ or WRITE command */
4319 254 : return false;
4320 : }
4321 :
4322 13 : if (req->cmd->nvme_cmd.fuse != SPDK_NVME_CMD_FUSE_NONE) {
4323 : /* Fused commands dont use zcopy buffers */
4324 1 : return false;
4325 : }
4326 :
4327 12 : ns = nvmf_ctrlr_get_ns(req->qpair->ctrlr, req->cmd->nvme_cmd.nsid);
4328 12 : if (ns == NULL || ns->bdev == NULL || !ns->zcopy) {
4329 2 : return false;
4330 : }
4331 :
4332 10 : req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT;
4333 10 : return true;
4334 : }
4335 :
4336 : void
4337 9 : spdk_nvmf_request_zcopy_start(struct spdk_nvmf_request *req)
4338 : {
4339 9 : assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT);
4340 :
4341 : /* Set iovcnt to be the maximum number of iovs that the ZCOPY can use */
4342 9 : req->iovcnt = NVMF_REQ_MAX_BUFFERS;
4343 :
4344 9 : spdk_nvmf_request_exec(req);
4345 9 : }
4346 :
4347 : void
4348 2 : spdk_nvmf_request_zcopy_end(struct spdk_nvmf_request *req, bool commit)
4349 : {
4350 2 : assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE);
4351 2 : req->zcopy_phase = NVMF_ZCOPY_PHASE_END_PENDING;
4352 :
4353 2 : nvmf_bdev_ctrlr_zcopy_end(req, commit);
4354 2 : }
4355 :
4356 : int
4357 10 : nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req)
4358 : {
4359 : uint32_t nsid;
4360 : struct spdk_nvmf_ns *ns;
4361 : struct spdk_bdev *bdev;
4362 : struct spdk_bdev_desc *desc;
4363 : struct spdk_io_channel *ch;
4364 10 : struct spdk_nvmf_qpair *qpair = req->qpair;
4365 10 : struct spdk_nvmf_poll_group *group = qpair->group;
4366 10 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
4367 10 : struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
4368 10 : struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl;
4369 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
4370 : enum spdk_nvme_ana_state ana_state;
4371 :
4372 : /* pre-set response details for this command */
4373 10 : response->status.sc = SPDK_NVME_SC_SUCCESS;
4374 10 : nsid = cmd->nsid;
4375 :
4376 10 : assert(ctrlr != NULL);
4377 10 : if (spdk_unlikely(ctrlr->vcprop.cc.bits.en != 1)) {
4378 0 : SPDK_ERRLOG("I/O command sent to disabled controller\n");
4379 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
4380 0 : response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR;
4381 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4382 : }
4383 :
4384 10 : ns = nvmf_ctrlr_get_ns(ctrlr, nsid);
4385 10 : if (spdk_unlikely(ns == NULL || ns->bdev == NULL)) {
4386 0 : SPDK_DEBUGLOG(nvmf, "Unsuccessful query for nsid %u\n", cmd->nsid);
4387 0 : response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
4388 0 : response->status.dnr = 1;
4389 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4390 : }
4391 :
4392 10 : ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid);
4393 10 : if (spdk_unlikely(ana_state != SPDK_NVME_ANA_OPTIMIZED_STATE &&
4394 : ana_state != SPDK_NVME_ANA_NON_OPTIMIZED_STATE)) {
4395 0 : SPDK_DEBUGLOG(nvmf, "Fail I/O command due to ANA state %d\n",
4396 : ana_state);
4397 0 : response->status.sct = SPDK_NVME_SCT_PATH;
4398 0 : response->status.sc = _nvme_ana_state_to_path_status(ana_state);
4399 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4400 : }
4401 :
4402 10 : if (spdk_likely(ctrlr->listener != NULL)) {
4403 : SPDK_DTRACE_PROBE3_TICKS(nvmf_request_io_exec_path, req,
4404 : ctrlr->listener->trid->traddr,
4405 : ctrlr->listener->trid->trsvcid);
4406 : }
4407 :
4408 : /* scan-build falsely reporting dereference of null pointer */
4409 10 : assert(group != NULL && group->sgroups != NULL);
4410 10 : ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1];
4411 10 : if (nvmf_ns_reservation_request_check(ns_info, ctrlr, req)) {
4412 0 : SPDK_DEBUGLOG(nvmf, "Reservation Conflict for nsid %u, opcode %u\n",
4413 : cmd->nsid, cmd->opc);
4414 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4415 : }
4416 :
4417 10 : bdev = ns->bdev;
4418 10 : desc = ns->desc;
4419 10 : ch = ns_info->channel;
4420 :
4421 10 : if (spdk_unlikely(cmd->fuse & SPDK_NVME_CMD_FUSE_MASK)) {
4422 6 : return nvmf_ctrlr_process_io_fused_cmd(req, bdev, desc, ch);
4423 4 : } else if (spdk_unlikely(qpair->first_fused_req != NULL)) {
4424 0 : struct spdk_nvme_cpl *fused_response = &qpair->first_fused_req->rsp->nvme_cpl;
4425 :
4426 0 : SPDK_ERRLOG("Second fused cmd expected - failing first one (cntlid:%u, qid:%u, opcode:0x%x)\n",
4427 : ctrlr->cntlid, qpair->qid,
4428 : req->qpair->first_fused_req->cmd->nvmf_cmd.opcode);
4429 :
4430 : /* abort qpair->first_fused_request and continue with new command */
4431 0 : fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED;
4432 0 : fused_response->status.sct = SPDK_NVME_SCT_GENERIC;
4433 0 : _nvmf_request_complete(qpair->first_fused_req);
4434 0 : qpair->first_fused_req = NULL;
4435 : }
4436 :
4437 4 : if (spdk_nvmf_request_using_zcopy(req)) {
4438 4 : assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT);
4439 4 : return nvmf_bdev_ctrlr_zcopy_start(bdev, desc, ch, req);
4440 : } else {
4441 0 : switch (cmd->opc) {
4442 0 : case SPDK_NVME_OPC_READ:
4443 0 : return nvmf_bdev_ctrlr_read_cmd(bdev, desc, ch, req);
4444 0 : case SPDK_NVME_OPC_WRITE:
4445 0 : return nvmf_bdev_ctrlr_write_cmd(bdev, desc, ch, req);
4446 0 : case SPDK_NVME_OPC_FLUSH:
4447 0 : return nvmf_bdev_ctrlr_flush_cmd(bdev, desc, ch, req);
4448 0 : case SPDK_NVME_OPC_COMPARE:
4449 0 : if (spdk_unlikely(!ctrlr->cdata.oncs.compare)) {
4450 0 : goto invalid_opcode;
4451 : }
4452 0 : return nvmf_bdev_ctrlr_compare_cmd(bdev, desc, ch, req);
4453 0 : case SPDK_NVME_OPC_WRITE_ZEROES:
4454 0 : if (spdk_unlikely(!ctrlr->cdata.oncs.write_zeroes)) {
4455 0 : goto invalid_opcode;
4456 : }
4457 0 : return nvmf_bdev_ctrlr_write_zeroes_cmd(bdev, desc, ch, req);
4458 0 : case SPDK_NVME_OPC_DATASET_MANAGEMENT:
4459 0 : if (spdk_unlikely(!ctrlr->cdata.oncs.dsm)) {
4460 0 : goto invalid_opcode;
4461 : }
4462 0 : return nvmf_bdev_ctrlr_dsm_cmd(bdev, desc, ch, req);
4463 0 : case SPDK_NVME_OPC_RESERVATION_REGISTER:
4464 : case SPDK_NVME_OPC_RESERVATION_ACQUIRE:
4465 : case SPDK_NVME_OPC_RESERVATION_RELEASE:
4466 : case SPDK_NVME_OPC_RESERVATION_REPORT:
4467 0 : if (spdk_unlikely(!ctrlr->cdata.oncs.reservations)) {
4468 0 : goto invalid_opcode;
4469 : }
4470 0 : spdk_thread_send_msg(ctrlr->subsys->thread, nvmf_ns_reservation_request, req);
4471 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS;
4472 0 : case SPDK_NVME_OPC_COPY:
4473 0 : if (spdk_unlikely(!ctrlr->cdata.oncs.copy)) {
4474 0 : goto invalid_opcode;
4475 : }
4476 0 : return nvmf_bdev_ctrlr_copy_cmd(bdev, desc, ch, req);
4477 0 : default:
4478 0 : if (spdk_unlikely(qpair->transport->opts.disable_command_passthru)) {
4479 0 : goto invalid_opcode;
4480 : }
4481 0 : return nvmf_bdev_ctrlr_nvme_passthru_io(bdev, desc, ch, req);
4482 : }
4483 : }
4484 0 : invalid_opcode:
4485 0 : SPDK_INFOLOG(nvmf, "Unsupported IO opcode 0x%x\n", cmd->opc);
4486 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
4487 0 : response->status.sc = SPDK_NVME_SC_INVALID_OPCODE;
4488 0 : response->status.dnr = 1;
4489 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4490 : }
4491 :
4492 : static void
4493 40 : nvmf_qpair_request_cleanup(struct spdk_nvmf_qpair *qpair)
4494 : {
4495 40 : if (spdk_unlikely(qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING)) {
4496 2 : assert(qpair->state_cb != NULL);
4497 :
4498 2 : if (TAILQ_EMPTY(&qpair->outstanding)) {
4499 2 : qpair->state_cb(qpair->state_cb_arg, 0);
4500 : }
4501 : }
4502 40 : }
4503 :
4504 : int
4505 0 : spdk_nvmf_request_free(struct spdk_nvmf_request *req)
4506 : {
4507 0 : struct spdk_nvmf_qpair *qpair = req->qpair;
4508 :
4509 0 : TAILQ_REMOVE(&qpair->outstanding, req, link);
4510 0 : if (spdk_unlikely(nvmf_transport_req_free(req))) {
4511 0 : SPDK_ERRLOG("Unable to free transport level request resources.\n");
4512 : }
4513 :
4514 0 : nvmf_qpair_request_cleanup(qpair);
4515 :
4516 0 : return 0;
4517 : }
4518 :
4519 : static void
4520 40 : _nvmf_request_complete(void *ctx)
4521 : {
4522 40 : struct spdk_nvmf_request *req = ctx;
4523 40 : struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
4524 : struct spdk_nvmf_qpair *qpair;
4525 40 : struct spdk_nvmf_subsystem_poll_group *sgroup = NULL;
4526 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
4527 40 : bool is_aer = false;
4528 : uint32_t nsid;
4529 : bool paused;
4530 : uint8_t opcode;
4531 :
4532 40 : rsp->sqid = 0;
4533 40 : rsp->status.p = 0;
4534 40 : rsp->cid = req->cmd->nvme_cmd.cid;
4535 40 : nsid = req->cmd->nvme_cmd.nsid;
4536 40 : opcode = req->cmd->nvmf_cmd.opcode;
4537 :
4538 40 : qpair = req->qpair;
4539 40 : if (spdk_likely(qpair->ctrlr)) {
4540 23 : sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id];
4541 23 : assert(sgroup != NULL);
4542 23 : is_aer = req->cmd->nvme_cmd.opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST;
4543 23 : if (spdk_likely(qpair->qid != 0)) {
4544 16 : qpair->group->stat.completed_nvme_io++;
4545 : }
4546 :
4547 : /*
4548 : * Set the crd value.
4549 : * If the the IO has any error, and dnr (DoNotRetry) is not 1,
4550 : * and ACRE is enabled, we will set the crd to 1 to select the first CRDT.
4551 : */
4552 23 : if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp) &&
4553 : rsp->status.dnr == 0 &&
4554 : qpair->ctrlr->acre_enabled)) {
4555 0 : rsp->status.crd = 1;
4556 : }
4557 17 : } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) {
4558 9 : sgroup = nvmf_subsystem_pg_from_connect_cmd(req);
4559 : }
4560 :
4561 40 : if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) {
4562 0 : spdk_nvme_print_completion(qpair->qid, rsp);
4563 : }
4564 :
4565 40 : switch (req->zcopy_phase) {
4566 30 : case NVMF_ZCOPY_PHASE_NONE:
4567 30 : TAILQ_REMOVE(&qpair->outstanding, req, link);
4568 30 : break;
4569 8 : case NVMF_ZCOPY_PHASE_INIT:
4570 8 : if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp))) {
4571 5 : req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT_FAILED;
4572 5 : TAILQ_REMOVE(&qpair->outstanding, req, link);
4573 : } else {
4574 3 : req->zcopy_phase = NVMF_ZCOPY_PHASE_EXECUTE;
4575 : }
4576 8 : break;
4577 0 : case NVMF_ZCOPY_PHASE_EXECUTE:
4578 0 : break;
4579 2 : case NVMF_ZCOPY_PHASE_END_PENDING:
4580 2 : TAILQ_REMOVE(&qpair->outstanding, req, link);
4581 2 : req->zcopy_phase = NVMF_ZCOPY_PHASE_COMPLETE;
4582 2 : break;
4583 0 : default:
4584 0 : SPDK_ERRLOG("Invalid ZCOPY phase %u\n", req->zcopy_phase);
4585 0 : break;
4586 : }
4587 :
4588 40 : if (spdk_unlikely(nvmf_transport_req_complete(req))) {
4589 0 : SPDK_ERRLOG("Transport request completion error!\n");
4590 : }
4591 :
4592 : /* AER cmd is an exception */
4593 40 : if (spdk_likely(sgroup && !is_aer)) {
4594 30 : if (spdk_unlikely(opcode == SPDK_NVME_OPC_FABRIC ||
4595 : nvmf_qpair_is_admin_queue(qpair))) {
4596 16 : assert(sgroup->mgmt_io_outstanding > 0);
4597 16 : sgroup->mgmt_io_outstanding--;
4598 : } else {
4599 14 : if (req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE ||
4600 9 : req->zcopy_phase == NVMF_ZCOPY_PHASE_COMPLETE ||
4601 7 : req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT_FAILED) {
4602 : /* End of request */
4603 :
4604 : /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */
4605 11 : if (spdk_likely(nsid - 1 < sgroup->num_ns)) {
4606 10 : sgroup->ns_info[nsid - 1].io_outstanding--;
4607 : }
4608 : }
4609 : }
4610 :
4611 30 : if (spdk_unlikely(sgroup->state == SPDK_NVMF_SUBSYSTEM_PAUSING &&
4612 : sgroup->mgmt_io_outstanding == 0)) {
4613 0 : paused = true;
4614 0 : for (nsid = 0; nsid < sgroup->num_ns; nsid++) {
4615 0 : ns_info = &sgroup->ns_info[nsid];
4616 :
4617 0 : if (ns_info->state == SPDK_NVMF_SUBSYSTEM_PAUSING &&
4618 0 : ns_info->io_outstanding > 0) {
4619 0 : paused = false;
4620 0 : break;
4621 : }
4622 : }
4623 :
4624 0 : if (paused) {
4625 0 : sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSED;
4626 0 : sgroup->cb_fn(sgroup->cb_arg, 0);
4627 0 : sgroup->cb_fn = NULL;
4628 0 : sgroup->cb_arg = NULL;
4629 : }
4630 : }
4631 :
4632 : }
4633 :
4634 40 : nvmf_qpair_request_cleanup(qpair);
4635 40 : }
4636 :
4637 : int
4638 18 : spdk_nvmf_request_complete(struct spdk_nvmf_request *req)
4639 : {
4640 18 : struct spdk_nvmf_qpair *qpair = req->qpair;
4641 :
4642 18 : spdk_thread_exec_msg(qpair->group->thread, _nvmf_request_complete, req);
4643 :
4644 18 : return 0;
4645 : }
4646 :
4647 2 : SPDK_LOG_DEPRECATION_REGISTER(nvmf_request_exec_fabrics, "spdk_nvmf_request_exec_fabrics()",
4648 : "v24.09", 1);
4649 : void
4650 0 : spdk_nvmf_request_exec_fabrics(struct spdk_nvmf_request *req)
4651 : {
4652 0 : SPDK_LOG_DEPRECATED(nvmf_request_exec_fabrics);
4653 :
4654 0 : return spdk_nvmf_request_exec(req);
4655 : }
4656 :
4657 : static bool
4658 15 : nvmf_check_subsystem_active(struct spdk_nvmf_request *req)
4659 : {
4660 15 : struct spdk_nvmf_qpair *qpair = req->qpair;
4661 15 : struct spdk_nvmf_subsystem_poll_group *sgroup = NULL;
4662 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
4663 : uint32_t nsid;
4664 :
4665 15 : if (spdk_likely(qpair->ctrlr)) {
4666 14 : sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id];
4667 14 : assert(sgroup != NULL);
4668 1 : } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) {
4669 0 : sgroup = nvmf_subsystem_pg_from_connect_cmd(req);
4670 : }
4671 :
4672 : /* Check if the subsystem is paused (if there is a subsystem) */
4673 15 : if (spdk_unlikely(sgroup == NULL)) {
4674 1 : return true;
4675 : }
4676 :
4677 14 : if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC ||
4678 : nvmf_qpair_is_admin_queue(qpair))) {
4679 0 : if (sgroup->state != SPDK_NVMF_SUBSYSTEM_ACTIVE) {
4680 : /* The subsystem is not currently active. Queue this request. */
4681 0 : TAILQ_INSERT_TAIL(&sgroup->queued, req, link);
4682 0 : return false;
4683 : }
4684 0 : sgroup->mgmt_io_outstanding++;
4685 : } else {
4686 14 : nsid = req->cmd->nvme_cmd.nsid;
4687 :
4688 : /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */
4689 14 : if (spdk_unlikely(nsid - 1 >= sgroup->num_ns)) {
4690 1 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
4691 1 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
4692 1 : req->rsp->nvme_cpl.status.dnr = 1;
4693 1 : TAILQ_INSERT_TAIL(&qpair->outstanding, req, link);
4694 1 : _nvmf_request_complete(req);
4695 1 : return false;
4696 : }
4697 :
4698 13 : ns_info = &sgroup->ns_info[nsid - 1];
4699 13 : if (spdk_unlikely(ns_info->channel == NULL)) {
4700 : /* This can can happen if host sends I/O to a namespace that is
4701 : * in the process of being added, but before the full addition
4702 : * process is complete. Report invalid namespace in that case.
4703 : */
4704 1 : req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC;
4705 1 : req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
4706 1 : req->rsp->nvme_cpl.status.dnr = 1;
4707 1 : TAILQ_INSERT_TAIL(&qpair->outstanding, req, link);
4708 1 : ns_info->io_outstanding++;
4709 1 : _nvmf_request_complete(req);
4710 1 : return false;
4711 : }
4712 :
4713 12 : if (spdk_unlikely(ns_info->state != SPDK_NVMF_SUBSYSTEM_ACTIVE)) {
4714 : /* The namespace is not currently active. Queue this request. */
4715 1 : TAILQ_INSERT_TAIL(&sgroup->queued, req, link);
4716 1 : return false;
4717 : }
4718 :
4719 11 : ns_info->io_outstanding++;
4720 : }
4721 :
4722 11 : return true;
4723 : }
4724 :
4725 : static bool
4726 22 : nvmf_check_qpair_active(struct spdk_nvmf_request *req)
4727 : {
4728 22 : struct spdk_nvmf_qpair *qpair = req->qpair;
4729 : int sc, sct;
4730 :
4731 22 : if (spdk_likely(qpair->state == SPDK_NVMF_QPAIR_ENABLED)) {
4732 11 : return true;
4733 : }
4734 :
4735 11 : sct = SPDK_NVME_SCT_GENERIC;
4736 11 : sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR;
4737 :
4738 11 : switch (qpair->state) {
4739 4 : case SPDK_NVMF_QPAIR_CONNECTING:
4740 4 : if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) {
4741 3 : SPDK_ERRLOG("Received command 0x%x on qid %u before CONNECT\n",
4742 : req->cmd->nvmf_cmd.opcode, qpair->qid);
4743 3 : break;
4744 : }
4745 1 : if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_CONNECT) {
4746 0 : SPDK_ERRLOG("Received fctype 0x%x on qid %u before CONNECT\n",
4747 : req->cmd->nvmf_cmd.fctype, qpair->qid);
4748 0 : break;
4749 : }
4750 1 : return true;
4751 3 : case SPDK_NVMF_QPAIR_AUTHENTICATING:
4752 3 : sct = SPDK_NVME_SCT_COMMAND_SPECIFIC;
4753 3 : sc = SPDK_NVMF_FABRIC_SC_AUTH_REQUIRED;
4754 3 : if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) {
4755 1 : SPDK_ERRLOG("Received command 0x%x on qid %u before authentication\n",
4756 : req->cmd->nvmf_cmd.opcode, qpair->qid);
4757 1 : break;
4758 : }
4759 2 : if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND &&
4760 1 : req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV) {
4761 0 : SPDK_ERRLOG("Received fctype 0x%x on qid %u before authentication\n",
4762 : req->cmd->nvmf_cmd.fctype, qpair->qid);
4763 0 : break;
4764 : }
4765 2 : return true;
4766 4 : default:
4767 4 : SPDK_ERRLOG("Received command 0x%x on qid %u in state %d\n",
4768 : req->cmd->nvmf_cmd.opcode, qpair->qid, qpair->state);
4769 4 : break;
4770 : }
4771 :
4772 8 : req->rsp->nvme_cpl.status.sct = sct;
4773 8 : req->rsp->nvme_cpl.status.sc = sc;
4774 8 : TAILQ_INSERT_TAIL(&qpair->outstanding, req, link);
4775 8 : _nvmf_request_complete(req);
4776 :
4777 8 : return false;
4778 : }
4779 :
4780 : void
4781 15 : spdk_nvmf_request_exec(struct spdk_nvmf_request *req)
4782 : {
4783 15 : struct spdk_nvmf_qpair *qpair = req->qpair;
4784 : enum spdk_nvmf_request_exec_status status;
4785 :
4786 15 : if (spdk_unlikely(!nvmf_check_subsystem_active(req))) {
4787 3 : return;
4788 : }
4789 12 : if (spdk_unlikely(!nvmf_check_qpair_active(req))) {
4790 2 : return;
4791 : }
4792 :
4793 10 : if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) {
4794 0 : spdk_nvme_print_command(qpair->qid, &req->cmd->nvme_cmd);
4795 : }
4796 :
4797 : /* Place the request on the outstanding list so we can keep track of it */
4798 10 : TAILQ_INSERT_TAIL(&qpair->outstanding, req, link);
4799 :
4800 10 : if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) {
4801 0 : status = nvmf_ctrlr_process_fabrics_cmd(req);
4802 10 : } else if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) {
4803 0 : status = nvmf_ctrlr_process_admin_cmd(req);
4804 : } else {
4805 10 : status = nvmf_ctrlr_process_io_cmd(req);
4806 : }
4807 :
4808 10 : if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) {
4809 8 : _nvmf_request_complete(req);
4810 : }
4811 : }
4812 :
4813 : static bool
4814 4 : nvmf_ctrlr_get_dif_ctx(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd,
4815 : struct spdk_dif_ctx *dif_ctx)
4816 : {
4817 : struct spdk_nvmf_ns *ns;
4818 : struct spdk_bdev *bdev;
4819 :
4820 4 : if (ctrlr == NULL || cmd == NULL) {
4821 0 : return false;
4822 : }
4823 :
4824 4 : ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid);
4825 4 : if (ns == NULL || ns->bdev == NULL) {
4826 2 : return false;
4827 : }
4828 :
4829 2 : bdev = ns->bdev;
4830 :
4831 2 : switch (cmd->opc) {
4832 1 : case SPDK_NVME_OPC_READ:
4833 : case SPDK_NVME_OPC_WRITE:
4834 : case SPDK_NVME_OPC_COMPARE:
4835 1 : return nvmf_bdev_ctrlr_get_dif_ctx(bdev, cmd, dif_ctx);
4836 1 : default:
4837 1 : break;
4838 : }
4839 :
4840 1 : return false;
4841 : }
4842 :
4843 : bool
4844 12 : spdk_nvmf_request_get_dif_ctx(struct spdk_nvmf_request *req, struct spdk_dif_ctx *dif_ctx)
4845 : {
4846 12 : struct spdk_nvmf_qpair *qpair = req->qpair;
4847 12 : struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr;
4848 :
4849 12 : if (spdk_likely(ctrlr == NULL || !ctrlr->dif_insert_or_strip)) {
4850 5 : return false;
4851 : }
4852 :
4853 7 : if (spdk_unlikely(!spdk_nvmf_qpair_is_active(qpair))) {
4854 1 : return false;
4855 : }
4856 :
4857 6 : if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) {
4858 1 : return false;
4859 : }
4860 :
4861 5 : if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) {
4862 1 : return false;
4863 : }
4864 :
4865 4 : return nvmf_ctrlr_get_dif_ctx(ctrlr, &req->cmd->nvme_cmd, dif_ctx);
4866 : }
4867 :
4868 : void
4869 1 : spdk_nvmf_set_custom_admin_cmd_hdlr(uint8_t opc, spdk_nvmf_custom_cmd_hdlr hdlr)
4870 : {
4871 1 : g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = hdlr;
4872 1 : }
4873 :
4874 : static int
4875 0 : nvmf_passthru_admin_cmd_for_bdev_nsid(struct spdk_nvmf_request *req, uint32_t bdev_nsid)
4876 : {
4877 0 : struct spdk_bdev *bdev;
4878 0 : struct spdk_bdev_desc *desc;
4879 0 : struct spdk_io_channel *ch;
4880 0 : struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req);
4881 : int rc;
4882 :
4883 0 : rc = spdk_nvmf_request_get_bdev(bdev_nsid, req, &bdev, &desc, &ch);
4884 0 : if (rc) {
4885 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
4886 0 : response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
4887 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4888 : }
4889 0 : return spdk_nvmf_bdev_ctrlr_nvme_passthru_admin(bdev, desc, ch, req, NULL);
4890 : }
4891 :
4892 : static int
4893 0 : nvmf_passthru_admin_cmd(struct spdk_nvmf_request *req)
4894 : {
4895 0 : struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req);
4896 : uint32_t bdev_nsid;
4897 :
4898 0 : if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid != 0) {
4899 0 : bdev_nsid = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid;
4900 : } else {
4901 0 : bdev_nsid = cmd->nsid;
4902 : }
4903 :
4904 0 : return nvmf_passthru_admin_cmd_for_bdev_nsid(req, bdev_nsid);
4905 : }
4906 :
4907 : int
4908 0 : nvmf_passthru_admin_cmd_for_ctrlr(struct spdk_nvmf_request *req, struct spdk_nvmf_ctrlr *ctrlr)
4909 : {
4910 0 : struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req);
4911 : struct spdk_nvmf_ns *ns;
4912 :
4913 0 : ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys);
4914 0 : if (ns == NULL) {
4915 : /* Is there a better sc to use here? */
4916 0 : response->status.sct = SPDK_NVME_SCT_GENERIC;
4917 0 : response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT;
4918 0 : return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE;
4919 : }
4920 :
4921 0 : return nvmf_passthru_admin_cmd_for_bdev_nsid(req, ns->nsid);
4922 : }
4923 :
4924 : void
4925 0 : spdk_nvmf_set_passthru_admin_cmd(uint8_t opc, uint32_t forward_nsid)
4926 : {
4927 0 : g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = nvmf_passthru_admin_cmd;
4928 0 : g_nvmf_custom_admin_cmd_hdlrs[opc].nsid = forward_nsid;
4929 0 : }
4930 :
4931 : int
4932 0 : spdk_nvmf_request_get_bdev(uint32_t nsid, struct spdk_nvmf_request *req,
4933 : struct spdk_bdev **bdev, struct spdk_bdev_desc **desc, struct spdk_io_channel **ch)
4934 : {
4935 0 : struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr;
4936 : struct spdk_nvmf_ns *ns;
4937 0 : struct spdk_nvmf_poll_group *group = req->qpair->group;
4938 : struct spdk_nvmf_subsystem_pg_ns_info *ns_info;
4939 :
4940 0 : *bdev = NULL;
4941 0 : *desc = NULL;
4942 0 : *ch = NULL;
4943 :
4944 0 : ns = nvmf_ctrlr_get_ns(ctrlr, nsid);
4945 0 : if (ns == NULL || ns->bdev == NULL) {
4946 0 : return -EINVAL;
4947 : }
4948 :
4949 0 : assert(group != NULL && group->sgroups != NULL);
4950 0 : ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1];
4951 0 : *bdev = ns->bdev;
4952 0 : *desc = ns->desc;
4953 0 : *ch = ns_info->channel;
4954 :
4955 0 : return 0;
4956 : }
4957 :
4958 0 : struct spdk_nvmf_ctrlr *spdk_nvmf_request_get_ctrlr(struct spdk_nvmf_request *req)
4959 : {
4960 0 : return req->qpair->ctrlr;
4961 : }
4962 :
4963 0 : struct spdk_nvme_cmd *spdk_nvmf_request_get_cmd(struct spdk_nvmf_request *req)
4964 : {
4965 0 : return &req->cmd->nvme_cmd;
4966 : }
4967 :
4968 0 : struct spdk_nvme_cpl *spdk_nvmf_request_get_response(struct spdk_nvmf_request *req)
4969 : {
4970 0 : return &req->rsp->nvme_cpl;
4971 : }
4972 :
4973 0 : struct spdk_nvmf_subsystem *spdk_nvmf_request_get_subsystem(struct spdk_nvmf_request *req)
4974 : {
4975 0 : return req->qpair->ctrlr->subsys;
4976 : }
4977 :
4978 : size_t
4979 0 : spdk_nvmf_request_copy_from_buf(struct spdk_nvmf_request *req,
4980 : void *buf, size_t buflen)
4981 : {
4982 0 : struct spdk_iov_xfer ix;
4983 :
4984 0 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
4985 0 : return spdk_iov_xfer_from_buf(&ix, buf, buflen);
4986 : }
4987 :
4988 : size_t
4989 0 : spdk_nvmf_request_copy_to_buf(struct spdk_nvmf_request *req,
4990 : void *buf, size_t buflen)
4991 : {
4992 0 : struct spdk_iov_xfer ix;
4993 :
4994 0 : spdk_iov_xfer_init(&ix, req->iov, req->iovcnt);
4995 0 : return spdk_iov_xfer_to_buf(&ix, buf, buflen);
4996 : }
4997 :
4998 0 : struct spdk_nvmf_subsystem *spdk_nvmf_ctrlr_get_subsystem(struct spdk_nvmf_ctrlr *ctrlr)
4999 : {
5000 0 : return ctrlr->subsys;
5001 : }
5002 :
5003 : uint16_t
5004 0 : spdk_nvmf_ctrlr_get_id(struct spdk_nvmf_ctrlr *ctrlr)
5005 : {
5006 0 : return ctrlr->cntlid;
5007 : }
5008 :
5009 0 : struct spdk_nvmf_request *spdk_nvmf_request_get_req_to_abort(struct spdk_nvmf_request *req)
5010 : {
5011 0 : return req->req_to_abort;
5012 : }
|