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