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