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