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