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