1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. All rights reserved. 5 * Copyright (c) 2019 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_internal/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 /* 63 * Support for custom admin command handlers 64 */ 65 struct spdk_nvmf_custom_admin_cmd { 66 spdk_nvmf_custom_cmd_hdlr hdlr; 67 uint32_t nsid; /* nsid to forward */ 68 }; 69 70 static struct spdk_nvmf_custom_admin_cmd g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_MAX_OPC + 1]; 71 72 static inline void 73 spdk_nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp, 74 uint8_t iattr, uint16_t ipo) 75 { 76 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 77 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 78 rsp->status_code_specific.invalid.iattr = iattr; 79 rsp->status_code_specific.invalid.ipo = ipo; 80 } 81 82 #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \ 83 spdk_nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field)) 84 #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \ 85 spdk_nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field)) 86 87 static void 88 spdk_nvmf_ctrlr_stop_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr) 89 { 90 if (!ctrlr) { 91 SPDK_ERRLOG("Controller is NULL\n"); 92 return; 93 } 94 95 if (ctrlr->keep_alive_poller == NULL) { 96 return; 97 } 98 99 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Stop keep alive poller\n"); 100 spdk_poller_unregister(&ctrlr->keep_alive_poller); 101 } 102 103 static void 104 spdk_nvmf_ctrlr_disconnect_qpairs_done(struct spdk_io_channel_iter *i, int status) 105 { 106 if (status == 0) { 107 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ctrlr disconnect qpairs complete successfully\n"); 108 } else { 109 SPDK_ERRLOG("Fail to disconnect ctrlr qpairs\n"); 110 } 111 } 112 113 static void 114 spdk_nvmf_ctrlr_disconnect_qpairs_on_pg(struct spdk_io_channel_iter *i) 115 { 116 int rc = 0; 117 struct spdk_nvmf_ctrlr *ctrlr; 118 struct spdk_nvmf_qpair *qpair, *temp_qpair; 119 struct spdk_io_channel *ch; 120 struct spdk_nvmf_poll_group *group; 121 122 ctrlr = spdk_io_channel_iter_get_ctx(i); 123 ch = spdk_io_channel_iter_get_channel(i); 124 group = spdk_io_channel_get_ctx(ch); 125 126 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, temp_qpair) { 127 if (qpair->ctrlr == ctrlr) { 128 rc = spdk_nvmf_qpair_disconnect(qpair, NULL, NULL); 129 if (rc) { 130 SPDK_ERRLOG("Qpair disconnect failed\n"); 131 goto next_channel; 132 } 133 } 134 } 135 136 next_channel: 137 spdk_for_each_channel_continue(i, rc); 138 } 139 140 static int 141 spdk_nvmf_ctrlr_keep_alive_poll(void *ctx) 142 { 143 uint64_t keep_alive_timeout_tick; 144 uint64_t now = spdk_get_ticks(); 145 struct spdk_nvmf_ctrlr *ctrlr = ctx; 146 147 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Polling ctrlr keep alive timeout\n"); 148 149 /* If the Keep alive feature is in use and the timer expires */ 150 keep_alive_timeout_tick = ctrlr->last_keep_alive_tick + 151 ctrlr->feat.keep_alive_timer.bits.kato * spdk_get_ticks_hz() / UINT64_C(1000); 152 if (now > keep_alive_timeout_tick) { 153 SPDK_NOTICELOG("Disconnecting host from subsystem %s due to keep alive timeout.\n", 154 ctrlr->subsys->subnqn); 155 /* set the Controller Fatal Status bit to '1' */ 156 if (ctrlr->vcprop.csts.bits.cfs == 0) { 157 ctrlr->vcprop.csts.bits.cfs = 1; 158 159 /* 160 * disconnect qpairs, terminate Transport connection 161 * destroy ctrlr, break the host to controller association 162 * disconnect qpairs with qpair->ctrlr == ctrlr 163 */ 164 spdk_for_each_channel(ctrlr->subsys->tgt, 165 spdk_nvmf_ctrlr_disconnect_qpairs_on_pg, 166 ctrlr, 167 spdk_nvmf_ctrlr_disconnect_qpairs_done); 168 } 169 } 170 171 return 1; 172 } 173 174 static void 175 spdk_nvmf_ctrlr_start_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr) 176 { 177 if (!ctrlr) { 178 SPDK_ERRLOG("Controller is NULL\n"); 179 return; 180 } 181 182 /* if cleared to 0 then the Keep Alive Timer is disabled */ 183 if (ctrlr->feat.keep_alive_timer.bits.kato != 0) { 184 185 ctrlr->last_keep_alive_tick = spdk_get_ticks(); 186 187 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Ctrlr add keep alive poller\n"); 188 ctrlr->keep_alive_poller = spdk_poller_register(spdk_nvmf_ctrlr_keep_alive_poll, ctrlr, 189 ctrlr->feat.keep_alive_timer.bits.kato * 1000); 190 } 191 } 192 193 static void 194 ctrlr_add_qpair_and_update_rsp(struct spdk_nvmf_qpair *qpair, 195 struct spdk_nvmf_ctrlr *ctrlr, 196 struct spdk_nvmf_fabric_connect_rsp *rsp) 197 { 198 assert(ctrlr->admin_qpair->group->thread == spdk_get_thread()); 199 200 /* check if we would exceed ctrlr connection limit */ 201 if (qpair->qid >= spdk_bit_array_capacity(ctrlr->qpair_mask)) { 202 SPDK_ERRLOG("Requested QID %u but Max QID is %u\n", 203 qpair->qid, spdk_bit_array_capacity(ctrlr->qpair_mask) - 1); 204 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 205 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 206 return; 207 } 208 209 if (spdk_bit_array_get(ctrlr->qpair_mask, qpair->qid)) { 210 SPDK_ERRLOG("Got I/O connect with duplicate QID %u\n", qpair->qid); 211 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 212 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 213 return; 214 } 215 216 qpair->ctrlr = ctrlr; 217 spdk_bit_array_set(ctrlr->qpair_mask, qpair->qid); 218 219 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 220 rsp->status_code_specific.success.cntlid = ctrlr->cntlid; 221 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "connect capsule response: cntlid = 0x%04x\n", 222 rsp->status_code_specific.success.cntlid); 223 } 224 225 static void 226 _spdk_nvmf_request_complete(void *ctx) 227 { 228 struct spdk_nvmf_request *req = ctx; 229 230 spdk_nvmf_request_complete(req); 231 } 232 233 static void 234 _spdk_nvmf_ctrlr_add_admin_qpair(void *ctx) 235 { 236 struct spdk_nvmf_request *req = ctx; 237 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 238 struct spdk_nvmf_qpair *qpair = req->qpair; 239 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 240 241 ctrlr->admin_qpair = qpair; 242 spdk_nvmf_ctrlr_start_keep_alive_timer(ctrlr); 243 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 244 spdk_nvmf_request_complete(req); 245 } 246 247 static void 248 _spdk_nvmf_subsystem_add_ctrlr(void *ctx) 249 { 250 struct spdk_nvmf_request *req = ctx; 251 struct spdk_nvmf_qpair *qpair = req->qpair; 252 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 253 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 254 255 if (spdk_nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) { 256 SPDK_ERRLOG("Unable to add controller to subsystem\n"); 257 spdk_bit_array_free(&ctrlr->qpair_mask); 258 free(ctrlr); 259 qpair->ctrlr = NULL; 260 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 261 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 262 return; 263 } 264 265 spdk_thread_send_msg(ctrlr->thread, _spdk_nvmf_ctrlr_add_admin_qpair, req); 266 } 267 268 static struct spdk_nvmf_ctrlr * 269 spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 270 struct spdk_nvmf_request *req, 271 struct spdk_nvmf_fabric_connect_cmd *connect_cmd, 272 struct spdk_nvmf_fabric_connect_data *connect_data) 273 { 274 struct spdk_nvmf_ctrlr *ctrlr; 275 struct spdk_nvmf_transport *transport; 276 277 ctrlr = calloc(1, sizeof(*ctrlr)); 278 if (ctrlr == NULL) { 279 SPDK_ERRLOG("Memory allocation failed\n"); 280 return NULL; 281 } 282 283 TAILQ_INIT(&ctrlr->log_head); 284 ctrlr->subsys = subsystem; 285 ctrlr->thread = req->qpair->group->thread; 286 287 transport = req->qpair->transport; 288 ctrlr->qpair_mask = spdk_bit_array_create(transport->opts.max_qpairs_per_ctrlr); 289 if (!ctrlr->qpair_mask) { 290 SPDK_ERRLOG("Failed to allocate controller qpair mask\n"); 291 free(ctrlr); 292 return NULL; 293 } 294 295 /* 296 * KAS: this field indicates the granularity of the Keep Alive Timer in 100ms units 297 * keep-alive timeout in milliseconds 298 */ 299 ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up(connect_cmd->kato, 300 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) * 301 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS; 302 ctrlr->feat.async_event_configuration.bits.ns_attr_notice = 1; 303 ctrlr->feat.volatile_write_cache.bits.wce = 1; 304 305 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 306 /* 307 * If keep-alive timeout is not set, discovery controllers use some 308 * arbitrary high value in order to cleanup stale discovery sessions 309 * 310 * From the 1.0a nvme-of spec: 311 * "The Keep Alive command is reserved for 312 * Discovery controllers. A transport may specify a 313 * fixed Discovery controller activity timeout value 314 * (e.g., 2 minutes). If no commands are received 315 * by a Discovery controller within that time 316 * period, the controller may perform the 317 * actions for Keep Alive Timer expiration". 318 * kato is in millisecond. 319 */ 320 if (ctrlr->feat.keep_alive_timer.bits.kato == 0) { 321 ctrlr->feat.keep_alive_timer.bits.kato = NVMF_DISC_KATO_IN_MS; 322 } 323 } 324 325 /* Subtract 1 for admin queue, 1 for 0's based */ 326 ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 - 327 1; 328 ctrlr->feat.number_of_queues.bits.nsqr = transport->opts.max_qpairs_per_ctrlr - 1 - 329 1; 330 331 spdk_uuid_copy(&ctrlr->hostid, (struct spdk_uuid *)connect_data->hostid); 332 memcpy(ctrlr->hostnqn, connect_data->hostnqn, sizeof(ctrlr->hostnqn)); 333 334 ctrlr->vcprop.cap.raw = 0; 335 ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */ 336 ctrlr->vcprop.cap.bits.mqes = transport->opts.max_queue_depth - 337 1; /* max queue depth */ 338 ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */ 339 ctrlr->vcprop.cap.bits.to = 1; /* ready timeout - 500 msec units */ 340 ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */ 341 ctrlr->vcprop.cap.bits.css = SPDK_NVME_CAP_CSS_NVM; /* NVM command set */ 342 ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */ 343 ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */ 344 345 /* Version Supported: 1.3 */ 346 ctrlr->vcprop.vs.bits.mjr = 1; 347 ctrlr->vcprop.vs.bits.mnr = 3; 348 ctrlr->vcprop.vs.bits.ter = 0; 349 350 ctrlr->vcprop.cc.raw = 0; 351 ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */ 352 353 ctrlr->vcprop.csts.raw = 0; 354 ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */ 355 356 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw); 357 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "vs 0x%x\n", ctrlr->vcprop.vs.raw); 358 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cc 0x%x\n", ctrlr->vcprop.cc.raw); 359 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "csts 0x%x\n", ctrlr->vcprop.csts.raw); 360 361 ctrlr->dif_insert_or_strip = transport->opts.dif_insert_or_strip; 362 363 req->qpair->ctrlr = ctrlr; 364 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_subsystem_add_ctrlr, req); 365 366 return ctrlr; 367 } 368 369 static void 370 _spdk_nvmf_ctrlr_destruct(void *ctx) 371 { 372 struct spdk_nvmf_ctrlr *ctrlr = ctx; 373 struct spdk_nvmf_reservation_log *log, *log_tmp; 374 375 spdk_nvmf_ctrlr_stop_keep_alive_timer(ctrlr); 376 377 TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) { 378 TAILQ_REMOVE(&ctrlr->log_head, log, link); 379 free(log); 380 } 381 free(ctrlr); 382 } 383 384 void 385 spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 386 { 387 spdk_nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr); 388 389 spdk_thread_send_msg(ctrlr->thread, _spdk_nvmf_ctrlr_destruct, ctrlr); 390 } 391 392 static void 393 spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 394 { 395 struct spdk_nvmf_request *req = ctx; 396 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 397 struct spdk_nvmf_qpair *qpair = req->qpair; 398 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 399 400 /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect. 401 * For error case, the value should be NULL. So set it to NULL at first. 402 */ 403 qpair->ctrlr = NULL; 404 405 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 406 SPDK_ERRLOG("I/O connect not allowed on discovery controller\n"); 407 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 408 goto end; 409 } 410 411 if (!ctrlr->vcprop.cc.bits.en) { 412 SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n"); 413 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 414 goto end; 415 } 416 417 if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) { 418 SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n", 419 ctrlr->vcprop.cc.bits.iosqes); 420 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 421 goto end; 422 } 423 424 if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) { 425 SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n", 426 ctrlr->vcprop.cc.bits.iocqes); 427 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 428 goto end; 429 } 430 431 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 432 end: 433 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 434 } 435 436 static void 437 _spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 438 { 439 struct spdk_nvmf_request *req = ctx; 440 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 441 struct spdk_nvmf_fabric_connect_data *data = req->data; 442 struct spdk_nvmf_ctrlr *ctrlr; 443 struct spdk_nvmf_qpair *qpair = req->qpair; 444 struct spdk_nvmf_qpair *admin_qpair; 445 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 446 struct spdk_nvmf_subsystem *subsystem; 447 448 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect I/O Queue for controller id 0x%x\n", data->cntlid); 449 450 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 451 /* We already checked this in spdk_nvmf_ctrlr_connect */ 452 assert(subsystem != NULL); 453 454 ctrlr = spdk_nvmf_subsystem_get_ctrlr(subsystem, data->cntlid); 455 if (ctrlr == NULL) { 456 SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid); 457 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 458 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 459 return; 460 } 461 462 admin_qpair = ctrlr->admin_qpair; 463 qpair->ctrlr = ctrlr; 464 spdk_thread_send_msg(admin_qpair->group->thread, spdk_nvmf_ctrlr_add_io_qpair, req); 465 } 466 467 static bool 468 spdk_nvmf_qpair_access_allowed(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_subsystem *subsystem, 469 const char *hostnqn) 470 { 471 struct spdk_nvme_transport_id listen_trid = {}; 472 473 if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) { 474 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subsystem->subnqn, hostnqn); 475 return false; 476 } 477 478 if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid)) { 479 SPDK_ERRLOG("Subsystem '%s' is unable to enforce access control due to an internal error.\n", 480 subsystem->subnqn); 481 return false; 482 } 483 484 if (!spdk_nvmf_subsystem_listener_allowed(subsystem, &listen_trid)) { 485 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s' to connect at this address.\n", 486 subsystem->subnqn, hostnqn); 487 return false; 488 } 489 490 return true; 491 } 492 493 static int 494 _spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 495 { 496 struct spdk_nvmf_fabric_connect_data *data = req->data; 497 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 498 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 499 struct spdk_nvmf_qpair *qpair = req->qpair; 500 struct spdk_nvmf_transport *transport = qpair->transport; 501 struct spdk_nvmf_ctrlr *ctrlr; 502 struct spdk_nvmf_subsystem *subsystem; 503 504 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "recfmt 0x%x qid %u sqsize %u\n", 505 cmd->recfmt, cmd->qid, cmd->sqsize); 506 507 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect data:\n"); 508 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " cntlid: 0x%04x\n", data->cntlid); 509 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n", 510 ntohl(*(uint32_t *)&data->hostid[0]), 511 ntohs(*(uint16_t *)&data->hostid[4]), 512 ntohs(*(uint16_t *)&data->hostid[6]), 513 data->hostid[8], 514 data->hostid[9], 515 ntohs(*(uint16_t *)&data->hostid[10]), 516 ntohl(*(uint32_t *)&data->hostid[12])); 517 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " subnqn: \"%s\"\n", data->subnqn); 518 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostnqn: \"%s\"\n", data->hostnqn); 519 520 subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn); 521 if (!subsystem) { 522 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 523 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 524 } 525 526 if (cmd->recfmt != 0) { 527 SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt); 528 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 529 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT; 530 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 531 } 532 533 /* 534 * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and 535 * strictly less than max_aq_depth (admin queues) or max_queue_depth (io queues). 536 */ 537 if (cmd->sqsize == 0) { 538 SPDK_ERRLOG("Invalid SQSIZE = 0\n"); 539 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 540 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 541 } 542 543 if (cmd->qid == 0) { 544 if (cmd->sqsize >= transport->opts.max_aq_depth) { 545 SPDK_ERRLOG("Invalid SQSIZE for admin queue %u (min 1, max %u)\n", 546 cmd->sqsize, transport->opts.max_aq_depth - 1); 547 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 548 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 549 } 550 } else if (cmd->sqsize >= transport->opts.max_queue_depth) { 551 SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n", 552 cmd->sqsize, transport->opts.max_queue_depth - 1); 553 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 554 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 555 } 556 557 qpair->sq_head_max = cmd->sqsize; 558 qpair->qid = cmd->qid; 559 560 if (0 == qpair->qid) { 561 qpair->group->stat.admin_qpairs++; 562 } else { 563 qpair->group->stat.io_qpairs++; 564 } 565 566 if (cmd->qid == 0) { 567 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid); 568 569 if (data->cntlid != 0xFFFF) { 570 /* This NVMf target only supports dynamic mode. */ 571 SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid); 572 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 573 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 574 } 575 576 /* Establish a new ctrlr */ 577 ctrlr = spdk_nvmf_ctrlr_create(subsystem, req, cmd, data); 578 if (!ctrlr) { 579 SPDK_ERRLOG("spdk_nvmf_ctrlr_create() failed\n"); 580 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 581 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 582 } else { 583 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 584 } 585 } else { 586 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_ctrlr_add_io_qpair, req); 587 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 588 } 589 } 590 591 int 592 spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 593 { 594 struct spdk_nvmf_qpair *qpair = req->qpair; 595 596 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 597 598 return _spdk_nvmf_ctrlr_connect(req); 599 } 600 601 static int 602 spdk_nvmf_ctrlr_cmd_connect(struct spdk_nvmf_request *req) 603 { 604 struct spdk_nvmf_fabric_connect_data *data = req->data; 605 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 606 struct spdk_nvmf_transport *transport = req->qpair->transport; 607 struct spdk_nvmf_subsystem *subsystem; 608 609 if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) { 610 SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length); 611 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 612 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 613 } 614 615 subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn); 616 if (!subsystem) { 617 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 618 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 619 } 620 621 if ((subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE) || 622 (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSING) || 623 (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED) || 624 (subsystem->state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING)) { 625 SPDK_ERRLOG("Subsystem '%s' is not ready\n", subsystem->subnqn); 626 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 627 rsp->status.sc = SPDK_NVMF_FABRIC_SC_CONTROLLER_BUSY; 628 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 629 } 630 631 /* Ensure that hostnqn is null terminated */ 632 if (!memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1)) { 633 SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n"); 634 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn); 635 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 636 } 637 638 if (!spdk_nvmf_qpair_access_allowed(req->qpair, subsystem, data->hostnqn)) { 639 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 640 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 641 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 642 } 643 644 return _spdk_nvmf_ctrlr_connect(req); 645 } 646 647 static uint64_t 648 nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr) 649 { 650 return ctrlr->vcprop.cap.raw; 651 } 652 653 static uint64_t 654 nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr) 655 { 656 return ctrlr->vcprop.vs.raw; 657 } 658 659 static uint64_t 660 nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr) 661 { 662 return ctrlr->vcprop.cc.raw; 663 } 664 665 static bool 666 nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 667 { 668 union spdk_nvme_cc_register cc, diff; 669 670 cc.raw = (uint32_t)value; 671 672 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw); 673 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "new CC: 0x%08x\n", cc.raw); 674 675 /* 676 * Calculate which bits changed between the current and new CC. 677 * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed. 678 */ 679 diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw; 680 681 if (diff.bits.en) { 682 if (cc.bits.en) { 683 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Enable!\n"); 684 ctrlr->vcprop.cc.bits.en = 1; 685 ctrlr->vcprop.csts.bits.rdy = 1; 686 } else { 687 SPDK_ERRLOG("CC.EN transition from 1 to 0 (reset) not implemented!\n"); 688 return false; 689 } 690 diff.bits.en = 0; 691 } 692 693 if (diff.bits.shn) { 694 if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || 695 cc.bits.shn == SPDK_NVME_SHN_ABRUPT) { 696 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Shutdown %u%ub!\n", 697 cc.bits.shn >> 1, cc.bits.shn & 1); 698 ctrlr->vcprop.cc.bits.shn = cc.bits.shn; 699 ctrlr->vcprop.cc.bits.en = 0; 700 ctrlr->vcprop.csts.bits.rdy = 0; 701 ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE; 702 } else if (cc.bits.shn == 0) { 703 ctrlr->vcprop.cc.bits.shn = 0; 704 } else { 705 SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n", 706 cc.bits.shn >> 1, cc.bits.shn & 1); 707 return false; 708 } 709 diff.bits.shn = 0; 710 } 711 712 if (diff.bits.iosqes) { 713 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOSQES = %u (%u bytes)\n", 714 cc.bits.iosqes, 1u << cc.bits.iosqes); 715 ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes; 716 diff.bits.iosqes = 0; 717 } 718 719 if (diff.bits.iocqes) { 720 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOCQES = %u (%u bytes)\n", 721 cc.bits.iocqes, 1u << cc.bits.iocqes); 722 ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes; 723 diff.bits.iocqes = 0; 724 } 725 726 if (diff.bits.ams) { 727 SPDK_ERRLOG("Arbitration Mechanism Selected (AMS) 0x%x not supported!\n", cc.bits.ams); 728 return false; 729 } 730 731 if (diff.bits.mps) { 732 SPDK_ERRLOG("Memory Page Size (MPS) %u KiB not supported!\n", (1 << (2 + cc.bits.mps))); 733 return false; 734 } 735 736 if (diff.bits.css) { 737 SPDK_ERRLOG("I/O Command Set Selected (CSS) 0x%x not supported!\n", cc.bits.css); 738 return false; 739 } 740 741 if (diff.raw != 0) { 742 SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw); 743 return false; 744 } 745 746 return true; 747 } 748 749 static uint64_t 750 nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr) 751 { 752 return ctrlr->vcprop.csts.raw; 753 } 754 755 static uint64_t 756 nvmf_prop_get_aqa(struct spdk_nvmf_ctrlr *ctrlr) 757 { 758 return ctrlr->vcprop.aqa.raw; 759 } 760 761 static bool 762 nvmf_prop_set_aqa(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 763 { 764 ctrlr->vcprop.aqa.raw = (uint32_t)value; 765 766 return true; 767 } 768 769 static uint64_t 770 nvmf_prop_get_asq(struct spdk_nvmf_ctrlr *ctrlr) 771 { 772 return ctrlr->vcprop.asq; 773 } 774 775 static bool 776 nvmf_prop_set_asq(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 777 { 778 ctrlr->vcprop.asq = value; 779 780 return true; 781 } 782 783 static uint64_t 784 nvmf_prop_get_acq(struct spdk_nvmf_ctrlr *ctrlr) 785 { 786 return ctrlr->vcprop.acq; 787 } 788 789 static bool 790 nvmf_prop_set_acq(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 791 { 792 ctrlr->vcprop.acq = value; 793 794 return true; 795 } 796 797 struct nvmf_prop { 798 uint32_t ofst; 799 uint8_t size; 800 char name[11]; 801 uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr); 802 bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value); 803 }; 804 805 #define PROP(field, size, get_cb, set_cb) \ 806 { \ 807 offsetof(struct spdk_nvme_registers, field), \ 808 SPDK_NVMF_PROP_SIZE_##size, \ 809 #field, \ 810 get_cb, set_cb \ 811 } 812 813 static const struct nvmf_prop nvmf_props[] = { 814 PROP(cap, 8, nvmf_prop_get_cap, NULL), 815 PROP(vs, 4, nvmf_prop_get_vs, NULL), 816 PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc), 817 PROP(csts, 4, nvmf_prop_get_csts, NULL), 818 PROP(aqa, 4, nvmf_prop_get_aqa, nvmf_prop_set_aqa), 819 PROP(asq, 8, nvmf_prop_get_asq, nvmf_prop_set_asq), 820 PROP(acq, 8, nvmf_prop_get_acq, nvmf_prop_set_acq), 821 }; 822 823 static const struct nvmf_prop * 824 find_prop(uint32_t ofst) 825 { 826 size_t i; 827 828 for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) { 829 const struct nvmf_prop *prop = &nvmf_props[i]; 830 831 if (prop->ofst == ofst) { 832 return prop; 833 } 834 } 835 836 return NULL; 837 } 838 839 static int 840 spdk_nvmf_property_get(struct spdk_nvmf_request *req) 841 { 842 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 843 struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd; 844 struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp; 845 const struct nvmf_prop *prop; 846 847 response->status.sc = 0; 848 response->value.u64 = 0; 849 850 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x\n", 851 cmd->attrib.size, cmd->ofst); 852 853 if (cmd->attrib.size != SPDK_NVMF_PROP_SIZE_4 && 854 cmd->attrib.size != SPDK_NVMF_PROP_SIZE_8) { 855 SPDK_ERRLOG("Invalid size value %d\n", cmd->attrib.size); 856 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 857 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 858 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 859 } 860 861 prop = find_prop(cmd->ofst); 862 if (prop == NULL || prop->get_cb == NULL) { 863 /* Reserved properties return 0 when read */ 864 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 865 } 866 867 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 868 if (cmd->attrib.size != prop->size) { 869 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 870 cmd->ofst, cmd->attrib.size, prop->size); 871 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 872 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 873 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 874 } 875 876 response->value.u64 = prop->get_cb(ctrlr); 877 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "response value: 0x%" PRIx64 "\n", response->value.u64); 878 879 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 880 } 881 882 static int 883 spdk_nvmf_property_set(struct spdk_nvmf_request *req) 884 { 885 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 886 struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd; 887 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 888 const struct nvmf_prop *prop; 889 uint64_t value; 890 891 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x, value 0x%" PRIx64 "\n", 892 cmd->attrib.size, cmd->ofst, cmd->value.u64); 893 894 prop = find_prop(cmd->ofst); 895 if (prop == NULL || prop->set_cb == NULL) { 896 SPDK_ERRLOG("Invalid offset 0x%x\n", cmd->ofst); 897 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 898 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 899 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 900 } 901 902 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 903 if (cmd->attrib.size != prop->size) { 904 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 905 cmd->ofst, cmd->attrib.size, prop->size); 906 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 907 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 908 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 909 } 910 911 value = cmd->value.u64; 912 if (prop->size == SPDK_NVMF_PROP_SIZE_4) { 913 value = (uint32_t)value; 914 } 915 916 if (!prop->set_cb(ctrlr, value)) { 917 SPDK_ERRLOG("prop set_cb failed\n"); 918 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 919 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 920 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 921 } 922 923 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 924 } 925 926 static int 927 spdk_nvmf_ctrlr_set_features_arbitration(struct spdk_nvmf_request *req) 928 { 929 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 930 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 931 932 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Arbitration (cdw11 = 0x%0x)\n", cmd->cdw11); 933 934 ctrlr->feat.arbitration.raw = cmd->cdw11; 935 ctrlr->feat.arbitration.bits.reserved = 0; 936 937 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 938 } 939 940 static int 941 spdk_nvmf_ctrlr_set_features_power_management(struct spdk_nvmf_request *req) 942 { 943 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 944 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 945 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 946 947 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Power Management (cdw11 = 0x%0x)\n", cmd->cdw11); 948 949 /* Only PS = 0 is allowed, since we report NPSS = 0 */ 950 if (cmd->cdw11_bits.feat_power_management.bits.ps != 0) { 951 SPDK_ERRLOG("Invalid power state %u\n", cmd->cdw11_bits.feat_power_management.bits.ps); 952 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 953 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 954 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 955 } 956 957 ctrlr->feat.power_management.raw = cmd->cdw11; 958 ctrlr->feat.power_management.bits.reserved = 0; 959 960 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 961 } 962 963 static bool 964 temp_threshold_opts_valid(const union spdk_nvme_feat_temperature_threshold *opts) 965 { 966 /* 967 * Valid TMPSEL values: 968 * 0000b - 1000b: temperature sensors 969 * 1111b: set all implemented temperature sensors 970 */ 971 if (opts->bits.tmpsel >= 9 && opts->bits.tmpsel != 15) { 972 /* 1001b - 1110b: reserved */ 973 SPDK_ERRLOG("Invalid TMPSEL %u\n", opts->bits.tmpsel); 974 return false; 975 } 976 977 /* 978 * Valid THSEL values: 979 * 00b: over temperature threshold 980 * 01b: under temperature threshold 981 */ 982 if (opts->bits.thsel > 1) { 983 /* 10b - 11b: reserved */ 984 SPDK_ERRLOG("Invalid THSEL %u\n", opts->bits.thsel); 985 return false; 986 } 987 988 return true; 989 } 990 991 static int 992 spdk_nvmf_ctrlr_set_features_temperature_threshold(struct spdk_nvmf_request *req) 993 { 994 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 995 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 996 997 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 998 999 if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) { 1000 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1001 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1002 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1003 } 1004 1005 /* TODO: no sensors implemented - ignore new values */ 1006 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1007 } 1008 1009 static int 1010 spdk_nvmf_ctrlr_get_features_temperature_threshold(struct spdk_nvmf_request *req) 1011 { 1012 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1013 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1014 1015 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 1016 1017 if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) { 1018 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1019 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1020 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1021 } 1022 1023 /* TODO: no sensors implemented - return 0 for all thresholds */ 1024 rsp->cdw0 = 0; 1025 1026 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1027 } 1028 1029 static int 1030 spdk_nvmf_ctrlr_set_features_error_recovery(struct spdk_nvmf_request *req) 1031 { 1032 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1033 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1034 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1035 1036 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Error Recovery (cdw11 = 0x%0x)\n", cmd->cdw11); 1037 1038 if (cmd->cdw11_bits.feat_error_recovery.bits.dulbe) { 1039 /* 1040 * Host is not allowed to set this bit, since we don't advertise it in 1041 * Identify Namespace. 1042 */ 1043 SPDK_ERRLOG("Host set unsupported DULBE bit\n"); 1044 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1045 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1046 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1047 } 1048 1049 ctrlr->feat.error_recovery.raw = cmd->cdw11; 1050 ctrlr->feat.error_recovery.bits.reserved = 0; 1051 1052 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1053 } 1054 1055 static int 1056 spdk_nvmf_ctrlr_set_features_volatile_write_cache(struct spdk_nvmf_request *req) 1057 { 1058 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1059 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1060 1061 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Volatile Write Cache (cdw11 = 0x%0x)\n", cmd->cdw11); 1062 1063 ctrlr->feat.volatile_write_cache.raw = cmd->cdw11; 1064 ctrlr->feat.volatile_write_cache.bits.reserved = 0; 1065 1066 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Volatile Write Cache %s\n", 1067 ctrlr->feat.volatile_write_cache.bits.wce ? "Enabled" : "Disabled"); 1068 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1069 } 1070 1071 static int 1072 spdk_nvmf_ctrlr_set_features_write_atomicity(struct spdk_nvmf_request *req) 1073 { 1074 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1075 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1076 1077 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Write Atomicity (cdw11 = 0x%0x)\n", cmd->cdw11); 1078 1079 ctrlr->feat.write_atomicity.raw = cmd->cdw11; 1080 ctrlr->feat.write_atomicity.bits.reserved = 0; 1081 1082 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1083 } 1084 1085 static int 1086 spdk_nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req) 1087 { 1088 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1089 1090 SPDK_ERRLOG("Set Features - Host Identifier not allowed\n"); 1091 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1092 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1093 } 1094 1095 static int 1096 spdk_nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req) 1097 { 1098 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1099 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1100 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1101 1102 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Host Identifier\n"); 1103 1104 if (!cmd->cdw11_bits.feat_host_identifier.bits.exhid) { 1105 /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */ 1106 SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n"); 1107 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1108 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1109 } 1110 1111 if (req->data == NULL || req->length < sizeof(ctrlr->hostid)) { 1112 SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n"); 1113 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1114 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1115 } 1116 1117 spdk_uuid_copy((struct spdk_uuid *)req->data, &ctrlr->hostid); 1118 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1119 } 1120 1121 static int 1122 spdk_nvmf_ctrlr_get_features_reservation_notification_mask(struct spdk_nvmf_request *req) 1123 { 1124 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1125 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1126 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1127 struct spdk_nvmf_ns *ns; 1128 1129 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "get Features - Reservation Notificaton Mask\n"); 1130 1131 if (cmd->nsid == 0xffffffffu) { 1132 SPDK_ERRLOG("get Features - Invalid Namespace ID\n"); 1133 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1134 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1135 } 1136 1137 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, cmd->nsid); 1138 if (ns == NULL) { 1139 SPDK_ERRLOG("Set Features - Invalid Namespace ID\n"); 1140 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1141 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1142 } 1143 rsp->cdw0 = ns->mask; 1144 1145 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1146 } 1147 1148 static int 1149 spdk_nvmf_ctrlr_set_features_reservation_notification_mask(struct spdk_nvmf_request *req) 1150 { 1151 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1152 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1153 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1154 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1155 struct spdk_nvmf_ns *ns; 1156 1157 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Reservation Notificaton Mask\n"); 1158 1159 if (cmd->nsid == 0xffffffffu) { 1160 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 1161 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 1162 ns->mask = cmd->cdw11; 1163 } 1164 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1165 } 1166 1167 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, cmd->nsid); 1168 if (ns == NULL) { 1169 SPDK_ERRLOG("Set Features - Invalid Namespace ID\n"); 1170 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1171 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1172 } 1173 ns->mask = cmd->cdw11; 1174 1175 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1176 } 1177 1178 static int 1179 spdk_nvmf_ctrlr_get_features_reservation_persistence(struct spdk_nvmf_request *req) 1180 { 1181 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1182 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1183 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1184 struct spdk_nvmf_ns *ns; 1185 1186 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Reservation Persistence\n"); 1187 1188 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, cmd->nsid); 1189 /* NSID with 0xffffffffu also included */ 1190 if (ns == NULL) { 1191 SPDK_ERRLOG("Get Features - Invalid Namespace ID\n"); 1192 response->status.sct = SPDK_NVME_SCT_GENERIC; 1193 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1194 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1195 } 1196 1197 response->cdw0 = ns->ptpl_activated; 1198 1199 response->status.sct = SPDK_NVME_SCT_GENERIC; 1200 response->status.sc = SPDK_NVME_SC_SUCCESS; 1201 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1202 } 1203 1204 static int 1205 spdk_nvmf_ctrlr_set_features_reservation_persistence(struct spdk_nvmf_request *req) 1206 { 1207 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1208 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1209 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1210 struct spdk_nvmf_ns *ns; 1211 bool ptpl; 1212 1213 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Reservation Persistence\n"); 1214 1215 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, cmd->nsid); 1216 ptpl = cmd->cdw11_bits.feat_rsv_persistence.bits.ptpl; 1217 1218 if (cmd->nsid != 0xffffffffu && ns && ns->ptpl_file) { 1219 ns->ptpl_activated = ptpl; 1220 } else if (cmd->nsid == 0xffffffffu) { 1221 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns && ns->ptpl_file; 1222 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 1223 ns->ptpl_activated = ptpl; 1224 } 1225 } else { 1226 SPDK_ERRLOG("Set Features - Invalid Namespace ID or Reservation Configuration\n"); 1227 response->status.sct = SPDK_NVME_SCT_GENERIC; 1228 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1229 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1230 } 1231 1232 /* TODO: Feature not changeable for now */ 1233 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1234 response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE; 1235 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1236 } 1237 1238 static int 1239 spdk_nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 1240 { 1241 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1242 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1243 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1244 1245 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 1246 1247 /* 1248 * if attempts to disable keep alive by setting kato to 0h 1249 * a status value of keep alive invalid shall be returned 1250 */ 1251 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato == 0) { 1252 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 1253 } else if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato < MIN_KEEP_ALIVE_TIMEOUT_IN_MS) { 1254 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT_IN_MS; 1255 } else { 1256 /* round up to milliseconds */ 1257 ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up( 1258 cmd->cdw11_bits.feat_keep_alive_timer.bits.kato, 1259 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) * 1260 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS; 1261 } 1262 1263 /* 1264 * if change the keep alive timeout value successfully 1265 * update the keep alive poller. 1266 */ 1267 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato != 0) { 1268 if (ctrlr->keep_alive_poller != NULL) { 1269 spdk_poller_unregister(&ctrlr->keep_alive_poller); 1270 } 1271 ctrlr->keep_alive_poller = spdk_poller_register(spdk_nvmf_ctrlr_keep_alive_poll, ctrlr, 1272 ctrlr->feat.keep_alive_timer.bits.kato * 1000); 1273 } 1274 1275 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer set to %u ms\n", 1276 ctrlr->feat.keep_alive_timer.bits.kato); 1277 1278 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1279 } 1280 1281 static int 1282 spdk_nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 1283 { 1284 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1285 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1286 uint32_t count; 1287 1288 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Number of Queues, cdw11 0x%x\n", 1289 req->cmd->nvme_cmd.cdw11); 1290 1291 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 1292 /* verify that the controller is ready to process commands */ 1293 if (count > 1) { 1294 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Queue pairs already active!\n"); 1295 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1296 } else { 1297 /* 1298 * Ignore the value requested by the host - 1299 * always return the pre-configured value based on max_qpairs_allowed. 1300 */ 1301 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 1302 } 1303 1304 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1305 } 1306 1307 static int 1308 spdk_nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 1309 { 1310 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1311 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1312 1313 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 1314 cmd->cdw11); 1315 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 1316 ctrlr->feat.async_event_configuration.bits.reserved = 0; 1317 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1318 } 1319 1320 static int 1321 spdk_nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 1322 { 1323 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1324 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1325 struct spdk_nvmf_subsystem_poll_group *sgroup; 1326 1327 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Async Event Request\n"); 1328 1329 /* Only one asynchronous event is supported for now */ 1330 if (ctrlr->aer_req != NULL) { 1331 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "AERL exceeded\n"); 1332 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1333 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 1334 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1335 } 1336 1337 if (ctrlr->notice_event.bits.async_event_type == 1338 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 1339 rsp->cdw0 = ctrlr->notice_event.raw; 1340 ctrlr->notice_event.raw = 0; 1341 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1342 } 1343 1344 if (ctrlr->reservation_event.bits.async_event_type == 1345 SPDK_NVME_ASYNC_EVENT_TYPE_IO) { 1346 rsp->cdw0 = ctrlr->reservation_event.raw; 1347 ctrlr->reservation_event.raw = 0; 1348 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1349 } 1350 1351 /* AER cmd is an exception */ 1352 sgroup = &req->qpair->group->sgroups[ctrlr->subsys->id]; 1353 sgroup->io_outstanding--; 1354 1355 ctrlr->aer_req = req; 1356 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 1357 } 1358 1359 static void 1360 spdk_nvmf_get_firmware_slot_log_page(void *buffer, uint64_t offset, uint32_t length) 1361 { 1362 struct spdk_nvme_firmware_page fw_page; 1363 size_t copy_len; 1364 1365 memset(&fw_page, 0, sizeof(fw_page)); 1366 fw_page.afi.active_slot = 1; 1367 fw_page.afi.next_reset_slot = 0; 1368 spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' '); 1369 1370 if (offset < sizeof(fw_page)) { 1371 copy_len = spdk_min(sizeof(fw_page) - offset, length); 1372 if (copy_len > 0) { 1373 memcpy(buffer, (const char *)&fw_page + offset, copy_len); 1374 } 1375 } 1376 } 1377 1378 void 1379 spdk_nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 1380 { 1381 uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list); 1382 uint16_t i; 1383 bool found = false; 1384 1385 for (i = 0; i < ctrlr->changed_ns_list_count; i++) { 1386 if (ctrlr->changed_ns_list.ns_list[i] == nsid) { 1387 /* nsid is already in the list */ 1388 found = true; 1389 break; 1390 } 1391 } 1392 1393 if (!found) { 1394 if (ctrlr->changed_ns_list_count == max_changes) { 1395 /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */ 1396 ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu; 1397 for (i = 1; i < max_changes; i++) { 1398 ctrlr->changed_ns_list.ns_list[i] = 0; 1399 } 1400 } else { 1401 ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid; 1402 } 1403 } 1404 } 1405 1406 static void 1407 spdk_nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr, 1408 void *buffer, uint64_t offset, uint32_t length) 1409 { 1410 size_t copy_length; 1411 1412 if (offset < sizeof(ctrlr->changed_ns_list)) { 1413 copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset); 1414 if (copy_length) { 1415 memcpy(buffer, (char *)&ctrlr->changed_ns_list + offset, copy_length); 1416 } 1417 } 1418 1419 /* Clear log page each time it is read */ 1420 ctrlr->changed_ns_list_count = 0; 1421 memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list)); 1422 } 1423 1424 /* The structure can be modified if we provide support for other commands in future */ 1425 static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = { 1426 .admin_cmds_supported = { 1427 /* CSUPP, LBCC, NCC, NIC, CCC, CSE */ 1428 /* Get Log Page */ 1429 [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1430 /* Identify */ 1431 [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0}, 1432 /* Abort */ 1433 [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0}, 1434 /* Set Features */ 1435 [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1436 /* Get Features */ 1437 [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1438 /* Async Event Request */ 1439 [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0}, 1440 /* Keep Alive */ 1441 [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1442 }, 1443 .io_cmds_supported = { 1444 /* FLUSH */ 1445 [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0}, 1446 /* WRITE */ 1447 [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0}, 1448 /* READ */ 1449 [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0}, 1450 /* WRITE ZEROES */ 1451 [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0}, 1452 /* DATASET MANAGEMENT */ 1453 [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0}, 1454 /* COMPARE */ 1455 [SPDK_NVME_OPC_COMPARE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1456 }, 1457 }; 1458 1459 static void 1460 spdk_nvmf_get_cmds_and_effects_log_page(void *buffer, 1461 uint64_t offset, uint32_t length) 1462 { 1463 uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page); 1464 size_t copy_len = 0; 1465 size_t zero_len = length; 1466 1467 if (offset < page_size) { 1468 copy_len = spdk_min(page_size - offset, length); 1469 zero_len -= copy_len; 1470 memcpy(buffer, (char *)(&g_cmds_and_effect_log_page) + offset, copy_len); 1471 } 1472 1473 if (zero_len) { 1474 memset((char *)buffer + copy_len, 0, zero_len); 1475 } 1476 } 1477 1478 static void 1479 spdk_nvmf_get_reservation_notification_log_page(struct spdk_nvmf_ctrlr *ctrlr, 1480 void *data, uint64_t offset, uint32_t length) 1481 { 1482 uint32_t unit_log_len, avail_log_len, next_pos, copy_len; 1483 struct spdk_nvmf_reservation_log *log, *log_tmp; 1484 uint8_t *buf = data; 1485 1486 unit_log_len = sizeof(struct spdk_nvme_reservation_notification_log); 1487 /* No available log, return 1 zeroed log page */ 1488 if (!ctrlr->num_avail_log_pages) { 1489 memset(buf, 0, spdk_min(length, unit_log_len)); 1490 return; 1491 } 1492 1493 avail_log_len = ctrlr->num_avail_log_pages * unit_log_len; 1494 if (offset >= avail_log_len) { 1495 return; 1496 } 1497 1498 next_pos = copy_len = 0; 1499 TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) { 1500 TAILQ_REMOVE(&ctrlr->log_head, log, link); 1501 ctrlr->num_avail_log_pages--; 1502 1503 next_pos += unit_log_len; 1504 if (next_pos > offset) { 1505 copy_len = spdk_min(next_pos - offset, length); 1506 memcpy(buf, &log->log, copy_len); 1507 length -= copy_len; 1508 offset += copy_len; 1509 buf += copy_len; 1510 } 1511 free(log); 1512 1513 if (length == 0) { 1514 break; 1515 } 1516 } 1517 return; 1518 } 1519 1520 static int 1521 spdk_nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 1522 { 1523 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1524 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1525 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1526 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1527 uint64_t offset, len; 1528 uint32_t numdl, numdu; 1529 uint8_t lid; 1530 1531 if (req->data == NULL) { 1532 SPDK_ERRLOG("get log command with no buffer\n"); 1533 response->status.sct = SPDK_NVME_SCT_GENERIC; 1534 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1535 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1536 } 1537 1538 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 1539 if (offset & 3) { 1540 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 1541 response->status.sct = SPDK_NVME_SCT_GENERIC; 1542 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1543 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1544 } 1545 1546 numdl = cmd->cdw10_bits.get_log_page.numdl; 1547 numdu = cmd->cdw11_bits.get_log_page.numdu; 1548 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 1549 if (len > req->length) { 1550 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 1551 len, req->length); 1552 response->status.sct = SPDK_NVME_SCT_GENERIC; 1553 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1554 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1555 } 1556 1557 lid = cmd->cdw10_bits.get_log_page.lid; 1558 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 "\n", 1559 lid, offset, len); 1560 1561 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1562 switch (lid) { 1563 case SPDK_NVME_LOG_DISCOVERY: 1564 spdk_nvmf_get_discovery_log_page(subsystem->tgt, ctrlr->hostnqn, req->iov, req->iovcnt, offset, 1565 len); 1566 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1567 default: 1568 goto invalid_log_page; 1569 } 1570 } else { 1571 switch (lid) { 1572 case SPDK_NVME_LOG_ERROR: 1573 case SPDK_NVME_LOG_HEALTH_INFORMATION: 1574 /* TODO: actually fill out log page data */ 1575 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1576 case SPDK_NVME_LOG_FIRMWARE_SLOT: 1577 spdk_nvmf_get_firmware_slot_log_page(req->data, offset, len); 1578 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1579 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 1580 spdk_nvmf_get_cmds_and_effects_log_page(req->data, offset, len); 1581 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1582 case SPDK_NVME_LOG_CHANGED_NS_LIST: 1583 spdk_nvmf_get_changed_ns_list_log_page(ctrlr, req->data, offset, len); 1584 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1585 case SPDK_NVME_LOG_RESERVATION_NOTIFICATION: 1586 spdk_nvmf_get_reservation_notification_log_page(ctrlr, req->data, offset, len); 1587 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1588 default: 1589 goto invalid_log_page; 1590 } 1591 } 1592 1593 invalid_log_page: 1594 SPDK_ERRLOG("Unsupported Get Log Page 0x%02X\n", lid); 1595 response->status.sct = SPDK_NVME_SCT_GENERIC; 1596 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1597 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1598 } 1599 1600 int 1601 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr, 1602 struct spdk_nvme_cmd *cmd, 1603 struct spdk_nvme_cpl *rsp, 1604 struct spdk_nvme_ns_data *nsdata) 1605 { 1606 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1607 struct spdk_nvmf_ns *ns; 1608 uint32_t max_num_blocks; 1609 1610 if (cmd->nsid == 0 || cmd->nsid > subsystem->max_nsid) { 1611 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", cmd->nsid); 1612 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1613 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1614 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1615 } 1616 1617 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1618 if (ns == NULL || ns->bdev == NULL) { 1619 /* 1620 * Inactive namespaces should return a zero filled data structure. 1621 * The data buffer is already zeroed by spdk_nvmf_ctrlr_process_admin_cmd(), 1622 * so we can just return early here. 1623 */ 1624 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Identify Namespace for inactive NSID %u\n", cmd->nsid); 1625 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1626 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1627 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1628 } 1629 1630 spdk_nvmf_bdev_ctrlr_identify_ns(ns, nsdata, ctrlr->dif_insert_or_strip); 1631 1632 /* Due to bug in the Linux kernel NVMe driver we have to set noiob no larger than mdts */ 1633 max_num_blocks = ctrlr->admin_qpair->transport->opts.max_io_size / 1634 (1U << nsdata->lbaf[nsdata->flbas.format].lbads); 1635 if (nsdata->noiob > max_num_blocks) { 1636 nsdata->noiob = max_num_blocks; 1637 } 1638 1639 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1640 } 1641 1642 static void 1643 nvmf_ctrlr_populate_oacs(struct spdk_nvmf_ctrlr *ctrlr, 1644 struct spdk_nvme_ctrlr_data *cdata) 1645 { 1646 cdata->oacs.virtualization_management = 1647 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT].hdlr != NULL; 1648 cdata->oacs.nvme_mi = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_SEND].hdlr != NULL 1649 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_RECEIVE].hdlr != NULL; 1650 cdata->oacs.directives = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_SEND].hdlr != NULL 1651 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_RECEIVE].hdlr != NULL; 1652 cdata->oacs.device_self_test = 1653 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DEVICE_SELF_TEST].hdlr != NULL; 1654 cdata->oacs.ns_manage = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_MANAGEMENT].hdlr != NULL 1655 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_ATTACHMENT].hdlr != NULL; 1656 cdata->oacs.firmware = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD].hdlr != 1657 NULL 1658 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_COMMIT].hdlr != NULL; 1659 cdata->oacs.format = 1660 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FORMAT_NVM].hdlr != NULL; 1661 cdata->oacs.security = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_SEND].hdlr != NULL 1662 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_RECEIVE].hdlr != NULL; 1663 cdata->oacs.get_lba_status = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_GET_LBA_STATUS].hdlr != 1664 NULL; 1665 } 1666 1667 int 1668 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 1669 { 1670 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1671 struct spdk_nvmf_transport *transport = ctrlr->admin_qpair->transport; 1672 1673 /* 1674 * Common fields for discovery and NVM subsystems 1675 */ 1676 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 1677 assert((transport->opts.max_io_size % 4096) == 0); 1678 cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096); 1679 cdata->cntlid = ctrlr->cntlid; 1680 cdata->ver = ctrlr->vcprop.vs; 1681 cdata->lpa.edlp = 1; 1682 cdata->elpe = 127; 1683 cdata->maxcmd = transport->opts.max_queue_depth; 1684 cdata->sgls.supported = 1; 1685 cdata->sgls.keyed_sgl = 1; 1686 cdata->sgls.sgl_offset = 1; 1687 cdata->fuses.compare_and_write = 1; 1688 cdata->acwu = 1; 1689 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 1690 1691 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 1692 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 1693 1694 /* 1695 * NVM subsystem fields (reserved for discovery subsystems) 1696 */ 1697 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_NVME) { 1698 spdk_strcpy_pad(cdata->mn, spdk_nvmf_subsystem_get_mn(subsystem), sizeof(cdata->mn), ' '); 1699 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 1700 cdata->kas = KAS_DEFAULT_VALUE; 1701 1702 cdata->rab = 6; 1703 cdata->cmic.multi_port = 1; 1704 cdata->cmic.multi_host = 1; 1705 cdata->oaes.ns_attribute_notices = 1; 1706 cdata->ctratt.host_id_exhid_supported = 1; 1707 cdata->aerl = 0; 1708 cdata->frmw.slot1_ro = 1; 1709 cdata->frmw.num_slots = 1; 1710 1711 cdata->lpa.celp = 1; /* Command Effects log page supported */ 1712 1713 cdata->sqes.min = 6; 1714 cdata->sqes.max = 6; 1715 cdata->cqes.min = 4; 1716 cdata->cqes.max = 4; 1717 cdata->nn = subsystem->max_nsid; 1718 cdata->vwc.present = 1; 1719 cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED; 1720 1721 cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16; 1722 cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16; 1723 cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */ 1724 cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC; 1725 /* The RDMA transport supports up to SPDK_NVMF_MAX_SGL_ENTRIES descriptors. */ 1726 if (transport->ops->type == SPDK_NVME_TRANSPORT_RDMA) { 1727 cdata->nvmf_specific.msdbd = SPDK_NVMF_MAX_SGL_ENTRIES; 1728 } else { 1729 cdata->nvmf_specific.msdbd = 1; 1730 } 1731 1732 /* TODO: this should be set by the transport */ 1733 /* Disable in-capsule data transfer for RDMA controller when dif_insert_or_strip is enabled 1734 since in-capsule data only works with NVME drives that support SGL memory layout */ 1735 if (!(transport->ops->type == SPDK_NVME_TRANSPORT_RDMA && ctrlr->dif_insert_or_strip)) { 1736 cdata->nvmf_specific.ioccsz += transport->opts.in_capsule_data_size / 16; 1737 } 1738 1739 cdata->oncs.dsm = spdk_nvmf_ctrlr_dsm_supported(ctrlr); 1740 cdata->oncs.write_zeroes = spdk_nvmf_ctrlr_write_zeroes_supported(ctrlr); 1741 cdata->oncs.reservations = 1; 1742 1743 nvmf_ctrlr_populate_oacs(ctrlr, cdata); 1744 1745 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ioccsz 0x%x\n", 1746 cdata->nvmf_specific.ioccsz); 1747 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: iorcsz 0x%x\n", 1748 cdata->nvmf_specific.iorcsz); 1749 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: icdoff 0x%x\n", 1750 cdata->nvmf_specific.icdoff); 1751 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ctrattr 0x%x\n", 1752 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 1753 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: msdbd 0x%x\n", 1754 cdata->nvmf_specific.msdbd); 1755 } 1756 1757 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1758 } 1759 1760 static int 1761 spdk_nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_subsystem *subsystem, 1762 struct spdk_nvme_cmd *cmd, 1763 struct spdk_nvme_cpl *rsp, 1764 struct spdk_nvme_ns_list *ns_list) 1765 { 1766 struct spdk_nvmf_ns *ns; 1767 uint32_t count = 0; 1768 1769 if (cmd->nsid >= 0xfffffffeUL) { 1770 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 1771 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1772 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1773 } 1774 1775 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 1776 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 1777 if (ns->opts.nsid <= cmd->nsid) { 1778 continue; 1779 } 1780 1781 ns_list->ns_list[count++] = ns->opts.nsid; 1782 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 1783 break; 1784 } 1785 } 1786 1787 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1788 } 1789 1790 static void 1791 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 1792 enum spdk_nvme_nidt type, 1793 const void *data, size_t data_size) 1794 { 1795 struct spdk_nvme_ns_id_desc *desc; 1796 size_t desc_size = sizeof(*desc) + data_size; 1797 1798 /* 1799 * These should never fail in practice, since all valid NS ID descriptors 1800 * should be defined so that they fit in the available 4096-byte buffer. 1801 */ 1802 assert(data_size > 0); 1803 assert(data_size <= UINT8_MAX); 1804 assert(desc_size < *buf_remain); 1805 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 1806 return; 1807 } 1808 1809 desc = *buf_ptr; 1810 desc->nidt = type; 1811 desc->nidl = data_size; 1812 memcpy(desc->nid, data, data_size); 1813 1814 *buf_ptr += desc_size; 1815 *buf_remain -= desc_size; 1816 } 1817 1818 static int 1819 spdk_nvmf_ctrlr_identify_ns_id_descriptor_list( 1820 struct spdk_nvmf_subsystem *subsystem, 1821 struct spdk_nvme_cmd *cmd, 1822 struct spdk_nvme_cpl *rsp, 1823 void *id_desc_list, size_t id_desc_list_size) 1824 { 1825 struct spdk_nvmf_ns *ns; 1826 size_t buf_remain = id_desc_list_size; 1827 void *buf_ptr = id_desc_list; 1828 1829 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1830 if (ns == NULL || ns->bdev == NULL) { 1831 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1832 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1833 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1834 } 1835 1836 #define ADD_ID_DESC(type, data, size) \ 1837 do { \ 1838 if (!spdk_mem_all_zero(data, size)) { \ 1839 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 1840 } \ 1841 } while (0) 1842 1843 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 1844 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 1845 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 1846 1847 /* 1848 * The list is automatically 0-terminated because controller to host buffers in 1849 * admin commands always get zeroed in spdk_nvmf_ctrlr_process_admin_cmd(). 1850 */ 1851 1852 #undef ADD_ID_DESC 1853 1854 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1855 } 1856 1857 static int 1858 spdk_nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 1859 { 1860 uint8_t cns; 1861 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1862 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1863 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1864 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1865 1866 if (req->data == NULL || req->length < 4096) { 1867 SPDK_ERRLOG("identify command with invalid buffer\n"); 1868 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1869 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1870 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1871 } 1872 1873 cns = cmd->cdw10_bits.identify.cns; 1874 1875 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY && 1876 cns != SPDK_NVME_IDENTIFY_CTRLR) { 1877 /* Discovery controllers only support Identify Controller */ 1878 goto invalid_cns; 1879 } 1880 1881 switch (cns) { 1882 case SPDK_NVME_IDENTIFY_NS: 1883 return spdk_nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, req->data); 1884 case SPDK_NVME_IDENTIFY_CTRLR: 1885 return spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, req->data); 1886 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 1887 return spdk_nvmf_ctrlr_identify_active_ns_list(subsystem, cmd, rsp, req->data); 1888 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 1889 return spdk_nvmf_ctrlr_identify_ns_id_descriptor_list(subsystem, cmd, rsp, req->data, req->length); 1890 default: 1891 goto invalid_cns; 1892 } 1893 1894 invalid_cns: 1895 SPDK_ERRLOG("Identify command with unsupported CNS 0x%02x\n", cns); 1896 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1897 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1898 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1899 } 1900 1901 1902 static struct spdk_nvmf_request * 1903 spdk_nvmf_qpair_abort(struct spdk_nvmf_qpair *qpair, uint16_t cid) 1904 { 1905 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1906 struct spdk_nvmf_request *req; 1907 1908 if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1909 if (ctrlr->aer_req && ctrlr->aer_req->cmd->nvme_cmd.cid == cid) { 1910 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Aborting AER request\n"); 1911 req = ctrlr->aer_req; 1912 ctrlr->aer_req = NULL; 1913 return req; 1914 } 1915 } 1916 1917 /* TODO: track list of outstanding requests in qpair? */ 1918 return NULL; 1919 } 1920 1921 static void 1922 spdk_nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status) 1923 { 1924 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1925 1926 spdk_nvmf_request_complete(req); 1927 } 1928 1929 static void 1930 spdk_nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i) 1931 { 1932 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1933 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 1934 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 1935 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1936 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1937 uint16_t sqid = cmd->cdw10_bits.abort.sqid; 1938 struct spdk_nvmf_qpair *qpair; 1939 1940 TAILQ_FOREACH(qpair, &group->qpairs, link) { 1941 if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) { 1942 struct spdk_nvmf_request *req_to_abort; 1943 uint16_t cid = cmd->cdw10_bits.abort.cid; 1944 1945 /* Found the qpair */ 1946 1947 req_to_abort = spdk_nvmf_qpair_abort(qpair, cid); 1948 if (req_to_abort == NULL) { 1949 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cid %u not found\n", cid); 1950 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1951 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1952 spdk_for_each_channel_continue(i, -EINVAL); 1953 return; 1954 } 1955 1956 /* Complete the request with aborted status */ 1957 req_to_abort->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1958 req_to_abort->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 1959 spdk_nvmf_request_complete(req_to_abort); 1960 1961 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "abort ctrlr=%p req=%p sqid=%u cid=%u successful\n", 1962 qpair->ctrlr, req_to_abort, sqid, cid); 1963 rsp->cdw0 = 0; /* Command successfully aborted */ 1964 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1965 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1966 /* Return -1 for the status so the iteration across threads stops. */ 1967 spdk_for_each_channel_continue(i, -1); 1968 1969 } 1970 } 1971 1972 spdk_for_each_channel_continue(i, 0); 1973 } 1974 1975 static int 1976 spdk_nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 1977 { 1978 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1979 1980 rsp->cdw0 = 1; /* Command not aborted */ 1981 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1982 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 1983 1984 /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */ 1985 spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt, 1986 spdk_nvmf_ctrlr_abort_on_pg, 1987 req, 1988 spdk_nvmf_ctrlr_abort_done 1989 ); 1990 1991 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 1992 } 1993 1994 static int 1995 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 1996 { 1997 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1998 1999 rsp->cdw0 = cdw0; 2000 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2001 } 2002 2003 static int 2004 spdk_nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 2005 { 2006 uint8_t feature; 2007 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2008 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2009 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2010 2011 feature = cmd->cdw10_bits.get_features.fid; 2012 switch (feature) { 2013 case SPDK_NVME_FEAT_ARBITRATION: 2014 return get_features_generic(req, ctrlr->feat.arbitration.raw); 2015 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 2016 return get_features_generic(req, ctrlr->feat.power_management.raw); 2017 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 2018 return spdk_nvmf_ctrlr_get_features_temperature_threshold(req); 2019 case SPDK_NVME_FEAT_ERROR_RECOVERY: 2020 return get_features_generic(req, ctrlr->feat.error_recovery.raw); 2021 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 2022 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 2023 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 2024 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 2025 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 2026 return get_features_generic(req, ctrlr->feat.write_atomicity.raw); 2027 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 2028 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 2029 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 2030 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 2031 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 2032 return spdk_nvmf_ctrlr_get_features_host_identifier(req); 2033 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 2034 return spdk_nvmf_ctrlr_get_features_reservation_notification_mask(req); 2035 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 2036 return spdk_nvmf_ctrlr_get_features_reservation_persistence(req); 2037 default: 2038 SPDK_ERRLOG("Get Features command with unsupported feature ID 0x%02x\n", feature); 2039 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2040 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2041 } 2042 } 2043 2044 static int 2045 spdk_nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 2046 { 2047 uint8_t feature, save; 2048 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2049 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2050 2051 /* 2052 * Features are not saveable by the controller as indicated by 2053 * ONCS field of the Identify Controller data. 2054 * */ 2055 save = cmd->cdw10_bits.set_features.sv; 2056 if (save) { 2057 response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE; 2058 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 2059 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2060 } 2061 2062 feature = cmd->cdw10_bits.set_features.fid; 2063 switch (feature) { 2064 case SPDK_NVME_FEAT_ARBITRATION: 2065 return spdk_nvmf_ctrlr_set_features_arbitration(req); 2066 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 2067 return spdk_nvmf_ctrlr_set_features_power_management(req); 2068 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 2069 return spdk_nvmf_ctrlr_set_features_temperature_threshold(req); 2070 case SPDK_NVME_FEAT_ERROR_RECOVERY: 2071 return spdk_nvmf_ctrlr_set_features_error_recovery(req); 2072 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 2073 return spdk_nvmf_ctrlr_set_features_volatile_write_cache(req); 2074 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 2075 return spdk_nvmf_ctrlr_set_features_number_of_queues(req); 2076 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 2077 return spdk_nvmf_ctrlr_set_features_write_atomicity(req); 2078 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 2079 return spdk_nvmf_ctrlr_set_features_async_event_configuration(req); 2080 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 2081 return spdk_nvmf_ctrlr_set_features_keep_alive_timer(req); 2082 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 2083 return spdk_nvmf_ctrlr_set_features_host_identifier(req); 2084 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 2085 return spdk_nvmf_ctrlr_set_features_reservation_notification_mask(req); 2086 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 2087 return spdk_nvmf_ctrlr_set_features_reservation_persistence(req); 2088 default: 2089 SPDK_ERRLOG("Set Features command with unsupported feature ID 0x%02x\n", feature); 2090 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2091 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2092 } 2093 } 2094 2095 static int 2096 spdk_nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 2097 { 2098 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2099 2100 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Keep Alive\n"); 2101 /* 2102 * To handle keep alive just clear or reset the 2103 * ctrlr based keep alive duration counter. 2104 * When added, a separate timer based process 2105 * will monitor if the time since last recorded 2106 * keep alive has exceeded the max duration and 2107 * take appropriate action. 2108 */ 2109 ctrlr->last_keep_alive_tick = spdk_get_ticks(); 2110 2111 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2112 } 2113 2114 int 2115 spdk_nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 2116 { 2117 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2118 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2119 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2120 int rc; 2121 2122 if (ctrlr == NULL) { 2123 SPDK_ERRLOG("Admin command sent before CONNECT\n"); 2124 response->status.sct = SPDK_NVME_SCT_GENERIC; 2125 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2126 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2127 } 2128 2129 if (ctrlr->vcprop.cc.bits.en != 1) { 2130 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 2131 response->status.sct = SPDK_NVME_SCT_GENERIC; 2132 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2133 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2134 } 2135 2136 if (req->data && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 2137 memset(req->data, 0, req->length); 2138 } 2139 2140 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 2141 /* Discovery controllers only support Get Log Page, Identify and Keep Alive. */ 2142 switch (cmd->opc) { 2143 case SPDK_NVME_OPC_IDENTIFY: 2144 case SPDK_NVME_OPC_GET_LOG_PAGE: 2145 case SPDK_NVME_OPC_KEEP_ALIVE: 2146 break; 2147 default: 2148 goto invalid_opcode; 2149 } 2150 } 2151 2152 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr) { 2153 rc = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr(req); 2154 if (rc >= SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 2155 /* The handler took care of this commmand */ 2156 return rc; 2157 } 2158 } 2159 2160 switch (cmd->opc) { 2161 case SPDK_NVME_OPC_GET_LOG_PAGE: 2162 return spdk_nvmf_ctrlr_get_log_page(req); 2163 case SPDK_NVME_OPC_IDENTIFY: 2164 return spdk_nvmf_ctrlr_identify(req); 2165 case SPDK_NVME_OPC_ABORT: 2166 return spdk_nvmf_ctrlr_abort(req); 2167 case SPDK_NVME_OPC_GET_FEATURES: 2168 return spdk_nvmf_ctrlr_get_features(req); 2169 case SPDK_NVME_OPC_SET_FEATURES: 2170 return spdk_nvmf_ctrlr_set_features(req); 2171 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 2172 return spdk_nvmf_ctrlr_async_event_request(req); 2173 case SPDK_NVME_OPC_KEEP_ALIVE: 2174 return spdk_nvmf_ctrlr_keep_alive(req); 2175 2176 case SPDK_NVME_OPC_CREATE_IO_SQ: 2177 case SPDK_NVME_OPC_CREATE_IO_CQ: 2178 case SPDK_NVME_OPC_DELETE_IO_SQ: 2179 case SPDK_NVME_OPC_DELETE_IO_CQ: 2180 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 2181 goto invalid_opcode; 2182 2183 default: 2184 goto invalid_opcode; 2185 } 2186 2187 invalid_opcode: 2188 SPDK_ERRLOG("Unsupported admin opcode 0x%x\n", cmd->opc); 2189 response->status.sct = SPDK_NVME_SCT_GENERIC; 2190 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 2191 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2192 } 2193 2194 int 2195 spdk_nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 2196 { 2197 struct spdk_nvmf_qpair *qpair = req->qpair; 2198 struct spdk_nvmf_capsule_cmd *cap_hdr; 2199 2200 cap_hdr = &req->cmd->nvmf_cmd; 2201 2202 if (qpair->ctrlr == NULL) { 2203 /* No ctrlr established yet; the only valid command is Connect */ 2204 if (cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 2205 return spdk_nvmf_ctrlr_cmd_connect(req); 2206 } else { 2207 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Got fctype 0x%x, expected Connect\n", 2208 cap_hdr->fctype); 2209 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 2210 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2211 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2212 } 2213 } else if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 2214 /* 2215 * Controller session is established, and this is an admin queue. 2216 * Disallow Connect and allow other fabrics commands. 2217 */ 2218 switch (cap_hdr->fctype) { 2219 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 2220 return spdk_nvmf_property_set(req); 2221 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 2222 return spdk_nvmf_property_get(req); 2223 default: 2224 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "unknown fctype 0x%02x\n", 2225 cap_hdr->fctype); 2226 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 2227 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 2228 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2229 } 2230 } else { 2231 /* Controller session is established, and this is an I/O queue */ 2232 /* For now, no I/O-specific Fabrics commands are implemented (other than Connect) */ 2233 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 2234 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 2235 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 2236 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2237 } 2238 } 2239 2240 int 2241 spdk_nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 2242 { 2243 struct spdk_nvmf_request *req; 2244 struct spdk_nvme_cpl *rsp; 2245 union spdk_nvme_async_event_completion event = {0}; 2246 2247 /* Users may disable the event notification */ 2248 if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) { 2249 return 0; 2250 } 2251 2252 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 2253 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED; 2254 event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST; 2255 2256 /* If there is no outstanding AER request, queue the event. Then 2257 * if an AER is later submitted, this event can be sent as a 2258 * response. 2259 */ 2260 if (!ctrlr->aer_req) { 2261 if (ctrlr->notice_event.bits.async_event_type == 2262 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 2263 return 0; 2264 } 2265 2266 ctrlr->notice_event.raw = event.raw; 2267 return 0; 2268 } 2269 2270 req = ctrlr->aer_req; 2271 rsp = &req->rsp->nvme_cpl; 2272 2273 rsp->cdw0 = event.raw; 2274 2275 spdk_nvmf_request_complete(req); 2276 ctrlr->aer_req = NULL; 2277 2278 return 0; 2279 } 2280 2281 void 2282 spdk_nvmf_ctrlr_async_event_reservation_notification(struct spdk_nvmf_ctrlr *ctrlr) 2283 { 2284 struct spdk_nvmf_request *req; 2285 struct spdk_nvme_cpl *rsp; 2286 union spdk_nvme_async_event_completion event = {0}; 2287 2288 if (!ctrlr->num_avail_log_pages) { 2289 return; 2290 } 2291 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_IO; 2292 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL; 2293 event.bits.log_page_identifier = SPDK_NVME_LOG_RESERVATION_NOTIFICATION; 2294 2295 /* If there is no outstanding AER request, queue the event. Then 2296 * if an AER is later submitted, this event can be sent as a 2297 * response. 2298 */ 2299 if (!ctrlr->aer_req) { 2300 if (ctrlr->reservation_event.bits.async_event_type == 2301 SPDK_NVME_ASYNC_EVENT_TYPE_IO) { 2302 return; 2303 } 2304 2305 ctrlr->reservation_event.raw = event.raw; 2306 return; 2307 } 2308 2309 req = ctrlr->aer_req; 2310 rsp = &req->rsp->nvme_cpl; 2311 2312 rsp->cdw0 = event.raw; 2313 2314 spdk_nvmf_request_complete(req); 2315 ctrlr->aer_req = NULL; 2316 } 2317 2318 void 2319 spdk_nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair) 2320 { 2321 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 2322 2323 if (!spdk_nvmf_qpair_is_admin_queue(qpair)) { 2324 return; 2325 } 2326 2327 if (ctrlr->aer_req != NULL) { 2328 spdk_nvmf_request_free(ctrlr->aer_req); 2329 ctrlr->aer_req = NULL; 2330 } 2331 } 2332 2333 void 2334 spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr) 2335 { 2336 if (!ctrlr->aer_req) { 2337 return; 2338 } 2339 2340 spdk_nvmf_request_complete(ctrlr->aer_req); 2341 ctrlr->aer_req = NULL; 2342 } 2343 2344 static void 2345 _nvmf_ctrlr_add_reservation_log(void *ctx) 2346 { 2347 struct spdk_nvmf_reservation_log *log = (struct spdk_nvmf_reservation_log *)ctx; 2348 struct spdk_nvmf_ctrlr *ctrlr = log->ctrlr; 2349 2350 ctrlr->log_page_count++; 2351 2352 /* Maximum number of queued log pages is 255 */ 2353 if (ctrlr->num_avail_log_pages == 0xff) { 2354 struct spdk_nvmf_reservation_log *entry; 2355 entry = TAILQ_LAST(&ctrlr->log_head, log_page_head); 2356 entry->log.log_page_count = ctrlr->log_page_count; 2357 free(log); 2358 return; 2359 } 2360 2361 log->log.log_page_count = ctrlr->log_page_count; 2362 log->log.num_avail_log_pages = ctrlr->num_avail_log_pages++; 2363 TAILQ_INSERT_TAIL(&ctrlr->log_head, log, link); 2364 2365 spdk_nvmf_ctrlr_async_event_reservation_notification(ctrlr); 2366 } 2367 2368 void 2369 spdk_nvmf_ctrlr_reservation_notice_log(struct spdk_nvmf_ctrlr *ctrlr, 2370 struct spdk_nvmf_ns *ns, 2371 enum spdk_nvme_reservation_notification_log_page_type type) 2372 { 2373 struct spdk_nvmf_reservation_log *log; 2374 2375 switch (type) { 2376 case SPDK_NVME_RESERVATION_LOG_PAGE_EMPTY: 2377 return; 2378 case SPDK_NVME_REGISTRATION_PREEMPTED: 2379 if (ns->mask & SPDK_NVME_REGISTRATION_PREEMPTED_MASK) { 2380 return; 2381 } 2382 break; 2383 case SPDK_NVME_RESERVATION_RELEASED: 2384 if (ns->mask & SPDK_NVME_RESERVATION_RELEASED_MASK) { 2385 return; 2386 } 2387 break; 2388 case SPDK_NVME_RESERVATION_PREEMPTED: 2389 if (ns->mask & SPDK_NVME_RESERVATION_PREEMPTED_MASK) { 2390 return; 2391 } 2392 break; 2393 default: 2394 return; 2395 } 2396 2397 log = calloc(1, sizeof(*log)); 2398 if (!log) { 2399 SPDK_ERRLOG("Alloc log page failed, ignore the log\n"); 2400 return; 2401 } 2402 log->ctrlr = ctrlr; 2403 log->log.type = type; 2404 log->log.nsid = ns->nsid; 2405 2406 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_reservation_log, log); 2407 } 2408 2409 /* Check from subsystem poll group's namespace information data structure */ 2410 static bool 2411 nvmf_ns_info_ctrlr_is_registrant(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 2412 struct spdk_nvmf_ctrlr *ctrlr) 2413 { 2414 uint32_t i; 2415 2416 for (i = 0; i < SPDK_NVMF_MAX_NUM_REGISTRANTS; i++) { 2417 if (!spdk_uuid_compare(&ns_info->reg_hostid[i], &ctrlr->hostid)) { 2418 return true; 2419 } 2420 } 2421 2422 return false; 2423 } 2424 2425 /* 2426 * Check the NVMe command is permitted or not for current controller(Host). 2427 */ 2428 static int 2429 nvmf_ns_reservation_request_check(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 2430 struct spdk_nvmf_ctrlr *ctrlr, 2431 struct spdk_nvmf_request *req) 2432 { 2433 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2434 enum spdk_nvme_reservation_type rtype = ns_info->rtype; 2435 uint8_t status = SPDK_NVME_SC_SUCCESS; 2436 uint8_t racqa; 2437 bool is_registrant; 2438 2439 /* No valid reservation */ 2440 if (!rtype) { 2441 return 0; 2442 } 2443 2444 is_registrant = nvmf_ns_info_ctrlr_is_registrant(ns_info, ctrlr); 2445 /* All registrants type and current ctrlr is a valid registrant */ 2446 if ((rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS || 2447 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && is_registrant) { 2448 return 0; 2449 } else if (!spdk_uuid_compare(&ns_info->holder_id, &ctrlr->hostid)) { 2450 return 0; 2451 } 2452 2453 /* Non-holder for current controller */ 2454 switch (cmd->opc) { 2455 case SPDK_NVME_OPC_READ: 2456 case SPDK_NVME_OPC_COMPARE: 2457 if (rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 2458 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2459 goto exit; 2460 } 2461 if ((rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY || 2462 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && !is_registrant) { 2463 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2464 } 2465 break; 2466 case SPDK_NVME_OPC_FLUSH: 2467 case SPDK_NVME_OPC_WRITE: 2468 case SPDK_NVME_OPC_WRITE_UNCORRECTABLE: 2469 case SPDK_NVME_OPC_WRITE_ZEROES: 2470 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 2471 if (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE || 2472 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 2473 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2474 goto exit; 2475 } 2476 if (!is_registrant) { 2477 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2478 } 2479 break; 2480 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 2481 racqa = cmd->cdw10_bits.resv_acquire.racqa; 2482 if (racqa == SPDK_NVME_RESERVE_ACQUIRE) { 2483 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2484 goto exit; 2485 } 2486 if (!is_registrant) { 2487 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2488 } 2489 break; 2490 case SPDK_NVME_OPC_RESERVATION_RELEASE: 2491 if (!is_registrant) { 2492 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 2493 } 2494 break; 2495 default: 2496 break; 2497 } 2498 2499 exit: 2500 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 2501 req->rsp->nvme_cpl.status.sc = status; 2502 if (status == SPDK_NVME_SC_RESERVATION_CONFLICT) { 2503 return -EPERM; 2504 } 2505 2506 return 0; 2507 } 2508 2509 static int 2510 spdk_nvmf_ctrlr_process_io_fused_cmd(struct spdk_nvmf_request *req, struct spdk_bdev *bdev, 2511 struct spdk_bdev_desc *desc, struct spdk_io_channel *ch) 2512 { 2513 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2514 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2515 struct spdk_nvmf_request *first_fused_req = req->qpair->first_fused_req; 2516 int rc; 2517 2518 if (cmd->fuse == SPDK_NVME_CMD_FUSE_FIRST) { 2519 /* first fused operation (should be compare) */ 2520 if (first_fused_req != NULL) { 2521 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 2522 2523 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 2524 2525 /* abort req->qpair->first_fused_request and continue with new fused command */ 2526 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 2527 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 2528 spdk_nvmf_request_complete(first_fused_req); 2529 } else if (cmd->opc != SPDK_NVME_OPC_COMPARE) { 2530 SPDK_ERRLOG("Wrong op code of fused operations\n"); 2531 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2532 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 2533 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2534 } 2535 2536 req->qpair->first_fused_req = req; 2537 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 2538 } else if (cmd->fuse == SPDK_NVME_CMD_FUSE_SECOND) { 2539 /* second fused operation (should be write) */ 2540 if (first_fused_req == NULL) { 2541 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 2542 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2543 rsp->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 2544 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2545 } else if (cmd->opc != SPDK_NVME_OPC_WRITE) { 2546 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 2547 2548 SPDK_ERRLOG("Wrong op code of fused operations\n"); 2549 2550 /* abort req->qpair->first_fused_request and fail current command */ 2551 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 2552 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 2553 spdk_nvmf_request_complete(first_fused_req); 2554 2555 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2556 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 2557 req->qpair->first_fused_req = NULL; 2558 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2559 } 2560 2561 /* save request of first command to generate response later */ 2562 req->first_fused_req = first_fused_req; 2563 req->qpair->first_fused_req = NULL; 2564 } else { 2565 SPDK_ERRLOG("Invalid fused command fuse field.\n"); 2566 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2567 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2568 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2569 } 2570 2571 rc = spdk_nvmf_bdev_ctrlr_compare_and_write_cmd(bdev, desc, ch, req->first_fused_req, req); 2572 2573 if (rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 2574 if (spdk_nvme_cpl_is_error(rsp)) { 2575 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 2576 2577 fused_response->status = rsp->status; 2578 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2579 rsp->status.sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 2580 /* Complete first of fused commands. Second will be completed by upper layer */ 2581 spdk_nvmf_request_complete(first_fused_req); 2582 req->first_fused_req = NULL; 2583 } 2584 } 2585 2586 return rc; 2587 } 2588 2589 int 2590 spdk_nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req) 2591 { 2592 uint32_t nsid; 2593 struct spdk_nvmf_ns *ns; 2594 struct spdk_bdev *bdev; 2595 struct spdk_bdev_desc *desc; 2596 struct spdk_io_channel *ch; 2597 struct spdk_nvmf_poll_group *group = req->qpair->group; 2598 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2599 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2600 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2601 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 2602 2603 /* pre-set response details for this command */ 2604 response->status.sc = SPDK_NVME_SC_SUCCESS; 2605 nsid = cmd->nsid; 2606 2607 if (spdk_unlikely(ctrlr == NULL)) { 2608 SPDK_ERRLOG("I/O command sent before CONNECT\n"); 2609 response->status.sct = SPDK_NVME_SCT_GENERIC; 2610 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2611 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2612 } 2613 2614 if (spdk_unlikely(ctrlr->vcprop.cc.bits.en != 1)) { 2615 SPDK_ERRLOG("I/O command sent to disabled controller\n"); 2616 response->status.sct = SPDK_NVME_SCT_GENERIC; 2617 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2618 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2619 } 2620 2621 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, nsid); 2622 if (ns == NULL || ns->bdev == NULL) { 2623 SPDK_ERRLOG("Unsuccessful query for nsid %u\n", cmd->nsid); 2624 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 2625 response->status.dnr = 1; 2626 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2627 } 2628 2629 /* scan-build falsely reporting dereference of null pointer */ 2630 assert(group != NULL && group->sgroups != NULL); 2631 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 2632 if (nvmf_ns_reservation_request_check(ns_info, ctrlr, req)) { 2633 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Reservation Conflict for nsid %u, opcode %u\n", 2634 cmd->nsid, cmd->opc); 2635 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2636 } 2637 2638 bdev = ns->bdev; 2639 desc = ns->desc; 2640 ch = ns_info->channel; 2641 2642 if (spdk_unlikely(cmd->fuse & SPDK_NVME_CMD_FUSE_MASK)) { 2643 return spdk_nvmf_ctrlr_process_io_fused_cmd(req, bdev, desc, ch); 2644 } else if (spdk_unlikely(req->qpair->first_fused_req != NULL)) { 2645 struct spdk_nvme_cpl *fused_response = &req->qpair->first_fused_req->rsp->nvme_cpl; 2646 2647 SPDK_ERRLOG("Expected second of fused commands - failing first of fused commands\n"); 2648 2649 /* abort req->qpair->first_fused_request and continue with new command */ 2650 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 2651 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 2652 spdk_nvmf_request_complete(req->qpair->first_fused_req); 2653 req->qpair->first_fused_req = NULL; 2654 } 2655 2656 switch (cmd->opc) { 2657 case SPDK_NVME_OPC_READ: 2658 return spdk_nvmf_bdev_ctrlr_read_cmd(bdev, desc, ch, req); 2659 case SPDK_NVME_OPC_WRITE: 2660 return spdk_nvmf_bdev_ctrlr_write_cmd(bdev, desc, ch, req); 2661 case SPDK_NVME_OPC_COMPARE: 2662 return spdk_nvmf_bdev_ctrlr_compare_cmd(bdev, desc, ch, req); 2663 case SPDK_NVME_OPC_WRITE_ZEROES: 2664 return spdk_nvmf_bdev_ctrlr_write_zeroes_cmd(bdev, desc, ch, req); 2665 case SPDK_NVME_OPC_FLUSH: 2666 return spdk_nvmf_bdev_ctrlr_flush_cmd(bdev, desc, ch, req); 2667 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 2668 return spdk_nvmf_bdev_ctrlr_dsm_cmd(bdev, desc, ch, req); 2669 case SPDK_NVME_OPC_RESERVATION_REGISTER: 2670 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 2671 case SPDK_NVME_OPC_RESERVATION_RELEASE: 2672 case SPDK_NVME_OPC_RESERVATION_REPORT: 2673 spdk_thread_send_msg(ctrlr->subsys->thread, spdk_nvmf_ns_reservation_request, req); 2674 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 2675 default: 2676 return spdk_nvmf_bdev_ctrlr_nvme_passthru_io(bdev, desc, ch, req); 2677 } 2678 } 2679 2680 static void 2681 spdk_nvmf_qpair_request_cleanup(struct spdk_nvmf_qpair *qpair) 2682 { 2683 if (qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING) { 2684 assert(qpair->state_cb != NULL); 2685 2686 if (TAILQ_EMPTY(&qpair->outstanding)) { 2687 qpair->state_cb(qpair->state_cb_arg, 0); 2688 } 2689 } else { 2690 assert(qpair->state == SPDK_NVMF_QPAIR_ACTIVE); 2691 } 2692 } 2693 2694 int 2695 spdk_nvmf_request_free(struct spdk_nvmf_request *req) 2696 { 2697 struct spdk_nvmf_qpair *qpair = req->qpair; 2698 2699 TAILQ_REMOVE(&qpair->outstanding, req, link); 2700 if (spdk_nvmf_transport_req_free(req)) { 2701 SPDK_ERRLOG("Unable to free transport level request resources.\n"); 2702 } 2703 2704 spdk_nvmf_qpair_request_cleanup(qpair); 2705 2706 return 0; 2707 } 2708 2709 int 2710 spdk_nvmf_request_complete(struct spdk_nvmf_request *req) 2711 { 2712 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2713 struct spdk_nvmf_qpair *qpair; 2714 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 2715 bool is_connect = req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC && 2716 req->cmd->nvmf_cmd.fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT; 2717 2718 rsp->sqid = 0; 2719 rsp->status.p = 0; 2720 rsp->cid = req->cmd->nvme_cmd.cid; 2721 2722 qpair = req->qpair; 2723 if (qpair->ctrlr) { 2724 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 2725 } 2726 2727 SPDK_DEBUGLOG(SPDK_LOG_NVMF, 2728 "cpl: cdw0=0x%08x sct=0x%01x sc=0x%02x cid=0x%04x\n", 2729 rsp->cdw0, rsp->status.sct, rsp->status.sc, rsp->cid); 2730 2731 TAILQ_REMOVE(&qpair->outstanding, req, link); 2732 if (spdk_nvmf_transport_req_complete(req)) { 2733 SPDK_ERRLOG("Transport request completion error!\n"); 2734 } 2735 2736 /* AER cmd and fabric connect are exceptions */ 2737 if (sgroup != NULL && qpair->ctrlr->aer_req != req && !is_connect) { 2738 assert(sgroup->io_outstanding > 0); 2739 sgroup->io_outstanding--; 2740 if (sgroup->state == SPDK_NVMF_SUBSYSTEM_PAUSING && 2741 sgroup->io_outstanding == 0) { 2742 sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSED; 2743 sgroup->cb_fn(sgroup->cb_arg, 0); 2744 } 2745 } 2746 2747 spdk_nvmf_qpair_request_cleanup(qpair); 2748 2749 return 0; 2750 } 2751 2752 static void 2753 nvmf_trace_command(union nvmf_h2c_msg *h2c_msg, bool is_admin_queue) 2754 { 2755 struct spdk_nvmf_capsule_cmd *cap_hdr = &h2c_msg->nvmf_cmd; 2756 struct spdk_nvme_cmd *cmd = &h2c_msg->nvme_cmd; 2757 struct spdk_nvme_sgl_descriptor *sgl = &cmd->dptr.sgl1; 2758 uint8_t opc; 2759 2760 if (cmd->opc == SPDK_NVME_OPC_FABRIC) { 2761 opc = cap_hdr->fctype; 2762 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "%s Fabrics cmd: fctype 0x%02x cid %u\n", 2763 is_admin_queue ? "Admin" : "I/O", 2764 cap_hdr->fctype, cap_hdr->cid); 2765 } else { 2766 opc = cmd->opc; 2767 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "%s cmd: opc 0x%02x fuse %u cid %u nsid %u cdw10 0x%08x\n", 2768 is_admin_queue ? "Admin" : "I/O", 2769 cmd->opc, cmd->fuse, cmd->cid, cmd->nsid, cmd->cdw10); 2770 if (cmd->mptr) { 2771 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "mptr 0x%" PRIx64 "\n", cmd->mptr); 2772 } 2773 if (cmd->psdt != SPDK_NVME_PSDT_SGL_MPTR_CONTIG && 2774 cmd->psdt != SPDK_NVME_PSDT_SGL_MPTR_SGL) { 2775 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "psdt %u\n", cmd->psdt); 2776 } 2777 } 2778 2779 if (spdk_nvme_opc_get_data_transfer(opc) != SPDK_NVME_DATA_NONE) { 2780 if (sgl->generic.type == SPDK_NVME_SGL_TYPE_KEYED_DATA_BLOCK) { 2781 SPDK_DEBUGLOG(SPDK_LOG_NVMF, 2782 "SGL: Keyed%s: addr 0x%" PRIx64 " key 0x%x len 0x%x\n", 2783 sgl->generic.subtype == SPDK_NVME_SGL_SUBTYPE_INVALIDATE_KEY ? " (Inv)" : "", 2784 sgl->address, sgl->keyed.key, sgl->keyed.length); 2785 } else if (sgl->generic.type == SPDK_NVME_SGL_TYPE_DATA_BLOCK) { 2786 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "SGL: Data block: %s 0x%" PRIx64 " len 0x%x\n", 2787 sgl->unkeyed.subtype == SPDK_NVME_SGL_SUBTYPE_OFFSET ? "offs" : "addr", 2788 sgl->address, sgl->unkeyed.length); 2789 } else { 2790 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "SGL type 0x%x subtype 0x%x\n", 2791 sgl->generic.type, sgl->generic.subtype); 2792 } 2793 } 2794 } 2795 2796 static void 2797 _nvmf_request_exec(struct spdk_nvmf_request *req, 2798 struct spdk_nvmf_subsystem_poll_group *sgroup) 2799 { 2800 struct spdk_nvmf_qpair *qpair = req->qpair; 2801 enum spdk_nvmf_request_exec_status status; 2802 2803 nvmf_trace_command(req->cmd, spdk_nvmf_qpair_is_admin_queue(qpair)); 2804 2805 if (sgroup) { 2806 sgroup->io_outstanding++; 2807 } 2808 2809 /* Place the request on the outstanding list so we can keep track of it */ 2810 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 2811 2812 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 2813 status = spdk_nvmf_ctrlr_process_fabrics_cmd(req); 2814 } else if (spdk_unlikely(spdk_nvmf_qpair_is_admin_queue(qpair))) { 2815 status = spdk_nvmf_ctrlr_process_admin_cmd(req); 2816 } else { 2817 status = spdk_nvmf_ctrlr_process_io_cmd(req); 2818 } 2819 2820 if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 2821 spdk_nvmf_request_complete(req); 2822 } 2823 } 2824 2825 void 2826 spdk_nvmf_request_exec_fabrics(struct spdk_nvmf_request *req) 2827 { 2828 struct spdk_nvmf_qpair *qpair = req->qpair; 2829 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 2830 2831 assert(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC); 2832 2833 if (qpair->ctrlr) { 2834 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 2835 } 2836 2837 _nvmf_request_exec(req, sgroup); 2838 } 2839 2840 void 2841 spdk_nvmf_request_exec(struct spdk_nvmf_request *req) 2842 { 2843 struct spdk_nvmf_qpair *qpair = req->qpair; 2844 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 2845 2846 if (qpair->ctrlr) { 2847 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 2848 } 2849 2850 if (qpair->state != SPDK_NVMF_QPAIR_ACTIVE) { 2851 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 2852 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2853 /* Place the request on the outstanding list so we can keep track of it */ 2854 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 2855 /* Still increment io_outstanding because request_complete decrements it */ 2856 if (sgroup != NULL) { 2857 sgroup->io_outstanding++; 2858 } 2859 spdk_nvmf_request_complete(req); 2860 return; 2861 } 2862 2863 /* Check if the subsystem is paused (if there is a subsystem) */ 2864 if (sgroup != NULL) { 2865 if (sgroup->state != SPDK_NVMF_SUBSYSTEM_ACTIVE) { 2866 /* The subsystem is not currently active. Queue this request. */ 2867 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 2868 return; 2869 } 2870 } 2871 2872 _nvmf_request_exec(req, sgroup); 2873 } 2874 2875 static bool 2876 spdk_nvmf_ctrlr_get_dif_ctx(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd, 2877 struct spdk_dif_ctx *dif_ctx) 2878 { 2879 struct spdk_nvmf_ns *ns; 2880 struct spdk_bdev *bdev; 2881 2882 if (ctrlr == NULL || cmd == NULL) { 2883 return false; 2884 } 2885 2886 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, cmd->nsid); 2887 if (ns == NULL || ns->bdev == NULL) { 2888 return false; 2889 } 2890 2891 bdev = ns->bdev; 2892 2893 switch (cmd->opc) { 2894 case SPDK_NVME_OPC_READ: 2895 case SPDK_NVME_OPC_WRITE: 2896 case SPDK_NVME_OPC_COMPARE: 2897 return spdk_nvmf_bdev_ctrlr_get_dif_ctx(bdev, cmd, dif_ctx); 2898 default: 2899 break; 2900 } 2901 2902 return false; 2903 } 2904 2905 bool 2906 spdk_nvmf_request_get_dif_ctx(struct spdk_nvmf_request *req, struct spdk_dif_ctx *dif_ctx) 2907 { 2908 struct spdk_nvmf_qpair *qpair = req->qpair; 2909 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 2910 2911 if (spdk_likely(ctrlr == NULL || !ctrlr->dif_insert_or_strip)) { 2912 return false; 2913 } 2914 2915 if (spdk_unlikely(qpair->state != SPDK_NVMF_QPAIR_ACTIVE)) { 2916 return false; 2917 } 2918 2919 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 2920 return false; 2921 } 2922 2923 if (spdk_unlikely(spdk_nvmf_qpair_is_admin_queue(qpair))) { 2924 return false; 2925 } 2926 2927 return spdk_nvmf_ctrlr_get_dif_ctx(ctrlr, &req->cmd->nvme_cmd, dif_ctx); 2928 } 2929 2930 void 2931 spdk_nvmf_set_custom_admin_cmd_hdlr(uint8_t opc, spdk_nvmf_custom_cmd_hdlr hdlr) 2932 { 2933 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = hdlr; 2934 } 2935 2936 static int 2937 nvmf_passthru_admin_cmd(struct spdk_nvmf_request *req) 2938 { 2939 struct spdk_bdev *bdev; 2940 struct spdk_bdev_desc *desc; 2941 struct spdk_io_channel *ch; 2942 struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req); 2943 struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req); 2944 uint32_t bdev_nsid; 2945 int rc; 2946 2947 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid == 0) { 2948 bdev_nsid = cmd->nsid; 2949 } else { 2950 bdev_nsid = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid; 2951 } 2952 2953 rc = spdk_nvmf_request_get_bdev(bdev_nsid, req, &bdev, &desc, &ch); 2954 if (rc) { 2955 response->status.sct = SPDK_NVME_SCT_GENERIC; 2956 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 2957 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2958 } 2959 return spdk_nvmf_bdev_ctrlr_nvme_passthru_admin(bdev, desc, ch, req, NULL); 2960 } 2961 2962 void 2963 spdk_nvmf_set_passthru_admin_cmd(uint8_t opc, uint32_t forward_nsid) 2964 { 2965 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = nvmf_passthru_admin_cmd; 2966 g_nvmf_custom_admin_cmd_hdlrs[opc].nsid = forward_nsid; 2967 } 2968 2969 int 2970 spdk_nvmf_request_get_bdev(uint32_t nsid, struct spdk_nvmf_request *req, 2971 struct spdk_bdev **bdev, struct spdk_bdev_desc **desc, struct spdk_io_channel **ch) 2972 { 2973 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2974 struct spdk_nvmf_ns *ns; 2975 struct spdk_nvmf_poll_group *group = req->qpair->group; 2976 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 2977 2978 *bdev = NULL; 2979 *desc = NULL; 2980 *ch = NULL; 2981 2982 ns = _spdk_nvmf_subsystem_get_ns(ctrlr->subsys, nsid); 2983 if (ns == NULL || ns->bdev == NULL) { 2984 return -EINVAL; 2985 } 2986 2987 assert(group != NULL && group->sgroups != NULL); 2988 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 2989 *bdev = ns->bdev; 2990 *desc = ns->desc; 2991 *ch = ns_info->channel; 2992 2993 return 0; 2994 } 2995 2996 struct spdk_nvmf_ctrlr *spdk_nvmf_request_get_ctrlr(struct spdk_nvmf_request *req) 2997 { 2998 return req->qpair->ctrlr; 2999 } 3000 3001 struct spdk_nvme_cmd *spdk_nvmf_request_get_cmd(struct spdk_nvmf_request *req) 3002 { 3003 return &req->cmd->nvme_cmd; 3004 } 3005 3006 struct spdk_nvme_cpl *spdk_nvmf_request_get_response(struct spdk_nvmf_request *req) 3007 { 3008 return &req->rsp->nvme_cpl; 3009 } 3010 3011 struct spdk_nvmf_subsystem *spdk_nvmf_request_get_subsystem(struct spdk_nvmf_request *req) 3012 { 3013 return req->qpair->ctrlr->subsys; 3014 } 3015 3016 void spdk_nvmf_request_get_data(struct spdk_nvmf_request *req, void **data, uint32_t *length) 3017 { 3018 *data = req->data; 3019 *length = req->length; 3020 } 3021