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