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