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