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