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