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