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