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