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