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