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