1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2017 Intel Corporation. All rights reserved. 3 * Copyright (c) 2019, 2020 Mellanox Technologies LTD. All rights reserved. 4 * Copyright (c) 2021, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 5 * Copyright (c) 2024 Samsung Electronics Co., Ltd. All rights reserved. 6 */ 7 8 #include "spdk/stdinc.h" 9 10 #include "nvmf_internal.h" 11 #include "transport.h" 12 13 #include "spdk/bdev.h" 14 #include "spdk/bdev_zone.h" 15 #include "spdk/bit_array.h" 16 #include "spdk/endian.h" 17 #include "spdk/thread.h" 18 #include "spdk/nvme_spec.h" 19 #include "spdk/nvmf_cmd.h" 20 #include "spdk/string.h" 21 #include "spdk/util.h" 22 #include "spdk/version.h" 23 #include "spdk/log.h" 24 #include "spdk_internal/usdt.h" 25 26 #define MIN_KEEP_ALIVE_TIMEOUT_IN_MS 10000 27 #define NVMF_DISC_KATO_IN_MS 120000 28 #define KAS_TIME_UNIT_IN_MS 100 29 #define KAS_DEFAULT_VALUE (MIN_KEEP_ALIVE_TIMEOUT_IN_MS / KAS_TIME_UNIT_IN_MS) 30 31 #define NVMF_CC_RESET_SHN_TIMEOUT_IN_MS 10000 32 33 #define NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + 5000) 34 35 #define DUPLICATE_QID_RETRY_US 1000 36 37 /* 38 * Report the SPDK version as the firmware revision. 39 * SPDK_VERSION_STRING won't fit into FR (only 8 bytes), so try to fit the most important parts. 40 */ 41 #define FW_VERSION SPDK_VERSION_MAJOR_STRING SPDK_VERSION_MINOR_STRING SPDK_VERSION_PATCH_STRING 42 43 #define ANA_TRANSITION_TIME_IN_SEC 10 44 45 #define NVMF_ABORT_COMMAND_LIMIT 3 46 47 /* 48 * Support for custom admin command handlers 49 */ 50 struct spdk_nvmf_custom_admin_cmd { 51 spdk_nvmf_custom_cmd_hdlr hdlr; 52 uint32_t nsid; /* nsid to forward */ 53 }; 54 55 static struct spdk_nvmf_custom_admin_cmd g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_MAX_OPC + 1]; 56 57 static void _nvmf_request_complete(void *ctx); 58 int nvmf_passthru_admin_cmd_for_ctrlr(struct spdk_nvmf_request *req, struct spdk_nvmf_ctrlr *ctrlr); 59 static int nvmf_passthru_admin_cmd(struct spdk_nvmf_request *req); 60 61 static inline void 62 nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp, 63 uint8_t iattr, uint16_t ipo) 64 { 65 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 66 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 67 rsp->status_code_specific.invalid.iattr = iattr; 68 rsp->status_code_specific.invalid.ipo = ipo; 69 } 70 71 #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \ 72 nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field)) 73 #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \ 74 nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field)) 75 76 77 static void 78 nvmf_ctrlr_stop_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr) 79 { 80 if (!ctrlr) { 81 SPDK_ERRLOG("Controller is NULL\n"); 82 return; 83 } 84 85 if (ctrlr->keep_alive_poller == NULL) { 86 return; 87 } 88 89 SPDK_DEBUGLOG(nvmf, "Stop keep alive poller\n"); 90 spdk_poller_unregister(&ctrlr->keep_alive_poller); 91 } 92 93 static void 94 nvmf_ctrlr_stop_association_timer(struct spdk_nvmf_ctrlr *ctrlr) 95 { 96 if (!ctrlr) { 97 SPDK_ERRLOG("Controller is NULL\n"); 98 assert(false); 99 return; 100 } 101 102 if (ctrlr->association_timer == NULL) { 103 return; 104 } 105 106 SPDK_DEBUGLOG(nvmf, "Stop association timer\n"); 107 spdk_poller_unregister(&ctrlr->association_timer); 108 } 109 110 static void 111 nvmf_ctrlr_disconnect_qpairs_done(struct spdk_io_channel_iter *i, int status) 112 { 113 if (status == 0) { 114 SPDK_DEBUGLOG(nvmf, "ctrlr disconnect qpairs complete successfully\n"); 115 } else { 116 SPDK_ERRLOG("Fail to disconnect ctrlr qpairs\n"); 117 } 118 } 119 120 static int 121 _nvmf_ctrlr_disconnect_qpairs_on_pg(struct spdk_io_channel_iter *i, bool include_admin) 122 { 123 int rc = 0; 124 struct spdk_nvmf_ctrlr *ctrlr; 125 struct spdk_nvmf_qpair *qpair, *temp_qpair; 126 struct spdk_io_channel *ch; 127 struct spdk_nvmf_poll_group *group; 128 129 ctrlr = spdk_io_channel_iter_get_ctx(i); 130 ch = spdk_io_channel_iter_get_channel(i); 131 group = spdk_io_channel_get_ctx(ch); 132 133 TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, temp_qpair) { 134 if (qpair->ctrlr == ctrlr && (include_admin || !nvmf_qpair_is_admin_queue(qpair))) { 135 rc = spdk_nvmf_qpair_disconnect(qpair); 136 if (rc) { 137 if (rc == -EINPROGRESS) { 138 rc = 0; 139 } else { 140 SPDK_ERRLOG("Qpair disconnect failed\n"); 141 return rc; 142 } 143 } 144 } 145 } 146 147 return rc; 148 } 149 150 static void 151 nvmf_ctrlr_disconnect_qpairs_on_pg(struct spdk_io_channel_iter *i) 152 { 153 spdk_for_each_channel_continue(i, _nvmf_ctrlr_disconnect_qpairs_on_pg(i, true)); 154 } 155 156 static void 157 nvmf_ctrlr_disconnect_io_qpairs_on_pg(struct spdk_io_channel_iter *i) 158 { 159 spdk_for_each_channel_continue(i, _nvmf_ctrlr_disconnect_qpairs_on_pg(i, false)); 160 } 161 162 static int 163 nvmf_ctrlr_keep_alive_poll(void *ctx) 164 { 165 uint64_t keep_alive_timeout_tick; 166 uint64_t now = spdk_get_ticks(); 167 struct spdk_nvmf_ctrlr *ctrlr = ctx; 168 169 if (ctrlr->in_destruct) { 170 nvmf_ctrlr_stop_keep_alive_timer(ctrlr); 171 return SPDK_POLLER_IDLE; 172 } 173 174 SPDK_DEBUGLOG(nvmf, "Polling ctrlr keep alive timeout\n"); 175 176 /* If the Keep alive feature is in use and the timer expires */ 177 keep_alive_timeout_tick = ctrlr->last_keep_alive_tick + 178 ctrlr->feat.keep_alive_timer.bits.kato * spdk_get_ticks_hz() / UINT64_C(1000); 179 if (now > keep_alive_timeout_tick) { 180 SPDK_NOTICELOG("Disconnecting host %s from subsystem %s due to keep alive timeout.\n", 181 ctrlr->hostnqn, ctrlr->subsys->subnqn); 182 /* set the Controller Fatal Status bit to '1' */ 183 if (ctrlr->vcprop.csts.bits.cfs == 0) { 184 nvmf_ctrlr_set_fatal_status(ctrlr); 185 186 /* 187 * disconnect qpairs, terminate Transport connection 188 * destroy ctrlr, break the host to controller association 189 * disconnect qpairs with qpair->ctrlr == ctrlr 190 */ 191 spdk_for_each_channel(ctrlr->subsys->tgt, 192 nvmf_ctrlr_disconnect_qpairs_on_pg, 193 ctrlr, 194 nvmf_ctrlr_disconnect_qpairs_done); 195 return SPDK_POLLER_BUSY; 196 } 197 } 198 199 return SPDK_POLLER_IDLE; 200 } 201 202 static void 203 nvmf_ctrlr_start_keep_alive_timer(struct spdk_nvmf_ctrlr *ctrlr) 204 { 205 if (!ctrlr) { 206 SPDK_ERRLOG("Controller is NULL\n"); 207 return; 208 } 209 210 /* if cleared to 0 then the Keep Alive Timer is disabled */ 211 if (ctrlr->feat.keep_alive_timer.bits.kato != 0) { 212 213 ctrlr->last_keep_alive_tick = spdk_get_ticks(); 214 215 SPDK_DEBUGLOG(nvmf, "Ctrlr add keep alive poller\n"); 216 ctrlr->keep_alive_poller = SPDK_POLLER_REGISTER(nvmf_ctrlr_keep_alive_poll, ctrlr, 217 ctrlr->feat.keep_alive_timer.bits.kato * 1000); 218 } 219 } 220 221 static void 222 nvmf_qpair_set_ctrlr(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_ctrlr *ctrlr) 223 { 224 if (qpair->ctrlr != NULL) { 225 /* Admin queues will call this function twice. */ 226 assert(qpair->ctrlr == ctrlr); 227 return; 228 } 229 230 qpair->ctrlr = ctrlr; 231 spdk_trace_owner_append_description(qpair->trace_id, 232 spdk_nvmf_subsystem_get_nqn(ctrlr->subsys)); 233 } 234 235 static int _retry_qid_check(void *ctx); 236 237 static void 238 nvmf_ctrlr_send_connect_rsp(void *ctx) 239 { 240 struct spdk_nvmf_request *req = ctx; 241 struct spdk_nvmf_qpair *qpair = req->qpair; 242 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 243 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 244 int rc; 245 246 /* The qpair might have been disconnected in the meantime */ 247 assert(qpair->state == SPDK_NVMF_QPAIR_CONNECTING || 248 qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING); 249 if (qpair->state == SPDK_NVMF_QPAIR_CONNECTING) { 250 if (nvmf_subsystem_host_auth_required(ctrlr->subsys, ctrlr->hostnqn)) { 251 rc = nvmf_qpair_auth_init(qpair); 252 if (rc != 0) { 253 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 254 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 255 spdk_nvmf_request_complete(req); 256 spdk_nvmf_qpair_disconnect(qpair); 257 return; 258 } 259 rsp->status_code_specific.success.authreq.atr = 1; 260 nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_AUTHENTICATING); 261 } else { 262 nvmf_qpair_set_state(qpair, SPDK_NVMF_QPAIR_ENABLED); 263 } 264 } 265 266 SPDK_DEBUGLOG(nvmf, "connect capsule response: cntlid = 0x%04x\n", ctrlr->cntlid); 267 268 assert(spdk_get_thread() == qpair->group->thread); 269 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 270 rsp->status_code_specific.success.cntlid = ctrlr->cntlid; 271 spdk_nvmf_request_complete(req); 272 } 273 274 static void 275 nvmf_ctrlr_add_qpair(struct spdk_nvmf_qpair *qpair, 276 struct spdk_nvmf_ctrlr *ctrlr, 277 struct spdk_nvmf_request *req) 278 { 279 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 280 281 if (!ctrlr->admin_qpair) { 282 SPDK_ERRLOG("Inactive admin qpair\n"); 283 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 284 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 285 qpair->connect_req = NULL; 286 qpair->ctrlr = NULL; 287 spdk_nvmf_request_complete(req); 288 return; 289 } 290 291 assert(ctrlr->admin_qpair->group->thread == spdk_get_thread()); 292 293 if (spdk_bit_array_get(ctrlr->qpair_mask, qpair->qid)) { 294 if (qpair->connect_req != NULL) { 295 SPDK_ERRLOG("Got I/O connect with duplicate QID %u (cntlid:%u)\n", 296 qpair->qid, ctrlr->cntlid); 297 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 298 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 299 qpair->connect_req = NULL; 300 qpair->ctrlr = NULL; 301 spdk_nvmf_request_complete(req); 302 } else { 303 SPDK_WARNLOG("Duplicate QID detected (cntlid:%u, qid:%u), re-check in %dus\n", 304 ctrlr->cntlid, qpair->qid, DUPLICATE_QID_RETRY_US); 305 qpair->connect_req = req; 306 /* Set qpair->ctrlr here so that we'll have it when the poller expires. */ 307 nvmf_qpair_set_ctrlr(qpair, ctrlr); 308 req->poller = SPDK_POLLER_REGISTER(_retry_qid_check, qpair, 309 DUPLICATE_QID_RETRY_US); 310 } 311 return; 312 } 313 314 qpair->connect_req = NULL; 315 316 SPDK_DTRACE_PROBE4_TICKS(nvmf_ctrlr_add_qpair, qpair, qpair->qid, ctrlr->subsys->subnqn, 317 ctrlr->hostnqn); 318 nvmf_qpair_set_ctrlr(qpair, ctrlr); 319 spdk_bit_array_set(ctrlr->qpair_mask, qpair->qid); 320 SPDK_DEBUGLOG(nvmf, "qpair_mask set, qid %u\n", qpair->qid); 321 322 spdk_thread_send_msg(qpair->group->thread, nvmf_ctrlr_send_connect_rsp, req); 323 } 324 325 static int 326 _retry_qid_check(void *ctx) 327 { 328 struct spdk_nvmf_qpair *qpair = ctx; 329 struct spdk_nvmf_request *req = qpair->connect_req; 330 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 331 332 spdk_poller_unregister(&req->poller); 333 SPDK_WARNLOG("Retrying adding qpair, qid:%d\n", qpair->qid); 334 nvmf_ctrlr_add_qpair(qpair, ctrlr, req); 335 return SPDK_POLLER_BUSY; 336 } 337 338 static void 339 _nvmf_ctrlr_add_admin_qpair(void *ctx) 340 { 341 struct spdk_nvmf_request *req = ctx; 342 struct spdk_nvmf_qpair *qpair = req->qpair; 343 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 344 345 ctrlr->admin_qpair = qpair; 346 ctrlr->association_timeout = qpair->transport->opts.association_timeout; 347 nvmf_ctrlr_start_keep_alive_timer(ctrlr); 348 nvmf_ctrlr_add_qpair(qpair, ctrlr, req); 349 } 350 351 static void 352 _nvmf_subsystem_add_ctrlr(void *ctx) 353 { 354 struct spdk_nvmf_request *req = ctx; 355 struct spdk_nvmf_qpair *qpair = req->qpair; 356 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 357 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 358 359 if (nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) { 360 SPDK_ERRLOG("Unable to add controller to subsystem\n"); 361 spdk_bit_array_free(&ctrlr->qpair_mask); 362 free(ctrlr); 363 qpair->ctrlr = NULL; 364 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 365 spdk_nvmf_request_complete(req); 366 return; 367 } 368 369 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_admin_qpair, req); 370 } 371 372 static void 373 nvmf_ctrlr_cdata_init(struct spdk_nvmf_transport *transport, struct spdk_nvmf_subsystem *subsystem, 374 struct spdk_nvmf_ctrlr_data *cdata) 375 { 376 cdata->aerl = SPDK_NVMF_MAX_ASYNC_EVENTS - 1; 377 cdata->kas = KAS_DEFAULT_VALUE; 378 cdata->vid = SPDK_PCI_VID_INTEL; 379 cdata->ssvid = SPDK_PCI_VID_INTEL; 380 /* INTEL OUI */ 381 cdata->ieee[0] = 0xe4; 382 cdata->ieee[1] = 0xd2; 383 cdata->ieee[2] = 0x5c; 384 cdata->oncs.compare = 1; 385 cdata->oncs.dsm = 1; 386 cdata->oncs.write_zeroes = 1; 387 cdata->oncs.reservations = 1; 388 cdata->oncs.copy = 1; 389 cdata->fuses.compare_and_write = 1; 390 cdata->sgls.supported = 1; 391 cdata->sgls.keyed_sgl = 1; 392 cdata->sgls.sgl_offset = 1; 393 cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16; 394 cdata->nvmf_specific.ioccsz += transport->opts.in_capsule_data_size / 16; 395 cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16; 396 cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */ 397 cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC; 398 cdata->nvmf_specific.msdbd = 1; 399 400 if (transport->ops->cdata_init) { 401 transport->ops->cdata_init(transport, subsystem, cdata); 402 } 403 } 404 405 static bool 406 nvmf_subsystem_has_zns_iocs(struct spdk_nvmf_subsystem *subsystem) 407 { 408 struct spdk_nvmf_ns *ns; 409 uint32_t i; 410 411 for (i = 0; i < subsystem->max_nsid; i++) { 412 ns = subsystem->ns[i]; 413 if (ns && ns->bdev && spdk_bdev_is_zoned(ns->bdev)) { 414 return true; 415 } 416 } 417 return false; 418 } 419 420 static void 421 nvmf_ctrlr_init_visible_ns(struct spdk_nvmf_ctrlr *ctrlr) 422 { 423 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 424 struct spdk_nvmf_ns *ns; 425 426 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 427 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 428 if (ns->always_visible || nvmf_ns_find_host(ns, ctrlr->hostnqn) != NULL) { 429 nvmf_ctrlr_ns_set_visible(ctrlr, ns->nsid, true); 430 } 431 } 432 } 433 434 static struct spdk_nvmf_ctrlr * 435 nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 436 struct spdk_nvmf_request *req, 437 struct spdk_nvmf_fabric_connect_cmd *connect_cmd, 438 struct spdk_nvmf_fabric_connect_data *connect_data) 439 { 440 struct spdk_nvmf_ctrlr *ctrlr; 441 struct spdk_nvmf_transport *transport = req->qpair->transport; 442 struct spdk_nvme_transport_id listen_trid = {}; 443 bool subsys_has_multi_iocs = false; 444 445 ctrlr = calloc(1, sizeof(*ctrlr)); 446 if (ctrlr == NULL) { 447 SPDK_ERRLOG("Memory allocation failed\n"); 448 return NULL; 449 } 450 451 if (spdk_nvme_trtype_is_fabrics(transport->ops->type)) { 452 ctrlr->dynamic_ctrlr = true; 453 } else { 454 ctrlr->cntlid = connect_data->cntlid; 455 } 456 457 SPDK_DTRACE_PROBE3_TICKS(nvmf_ctrlr_create, ctrlr, subsystem->subnqn, 458 spdk_thread_get_id(req->qpair->group->thread)); 459 460 STAILQ_INIT(&ctrlr->async_events); 461 TAILQ_INIT(&ctrlr->log_head); 462 ctrlr->subsys = subsystem; 463 ctrlr->thread = req->qpair->group->thread; 464 ctrlr->disconnect_in_progress = false; 465 466 ctrlr->qpair_mask = spdk_bit_array_create(transport->opts.max_qpairs_per_ctrlr); 467 if (!ctrlr->qpair_mask) { 468 SPDK_ERRLOG("Failed to allocate controller qpair mask\n"); 469 goto err_qpair_mask; 470 } 471 472 nvmf_ctrlr_cdata_init(transport, subsystem, &ctrlr->cdata); 473 474 /* 475 * KAS: This field indicates the granularity of the Keep Alive Timer in 100ms units. 476 * If this field is cleared to 0h, then Keep Alive is not supported. 477 */ 478 if (ctrlr->cdata.kas) { 479 ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up(connect_cmd->kato, 480 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) * 481 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS; 482 } 483 484 ctrlr->feat.async_event_configuration.bits.ns_attr_notice = 1; 485 if (ctrlr->subsys->flags.ana_reporting) { 486 ctrlr->feat.async_event_configuration.bits.ana_change_notice = 1; 487 } 488 ctrlr->feat.volatile_write_cache.bits.wce = 1; 489 /* Coalescing Disable */ 490 ctrlr->feat.interrupt_vector_configuration.bits.cd = 1; 491 492 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 493 /* 494 * If keep-alive timeout is not set, discovery controllers use some 495 * arbitrary high value in order to cleanup stale discovery sessions 496 * 497 * From the 1.0a nvme-of spec: 498 * "The Keep Alive command is reserved for 499 * Discovery controllers. A transport may specify a 500 * fixed Discovery controller activity timeout value 501 * (e.g., 2 minutes). If no commands are received 502 * by a Discovery controller within that time 503 * period, the controller may perform the 504 * actions for Keep Alive Timer expiration". 505 * 506 * From the 1.1 nvme-of spec: 507 * "A host requests an explicit persistent connection 508 * to a Discovery controller and Asynchronous Event Notifications from 509 * the Discovery controller on that persistent connection by specifying 510 * a non-zero Keep Alive Timer value in the Connect command." 511 * 512 * In case non-zero KATO is used, we enable discovery_log_change_notice 513 * otherwise we disable it and use default discovery controller KATO. 514 * KATO is in millisecond. 515 */ 516 if (ctrlr->feat.keep_alive_timer.bits.kato == 0) { 517 ctrlr->feat.keep_alive_timer.bits.kato = NVMF_DISC_KATO_IN_MS; 518 ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice = 0; 519 } else { 520 ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice = 1; 521 } 522 } 523 524 /* Subtract 1 for admin queue, 1 for 0's based */ 525 ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 - 526 1; 527 ctrlr->feat.number_of_queues.bits.nsqr = transport->opts.max_qpairs_per_ctrlr - 1 - 528 1; 529 530 spdk_uuid_copy(&ctrlr->hostid, (struct spdk_uuid *)connect_data->hostid); 531 memcpy(ctrlr->hostnqn, connect_data->hostnqn, SPDK_NVMF_NQN_MAX_LEN); 532 533 ctrlr->visible_ns = spdk_bit_array_create(subsystem->max_nsid); 534 if (!ctrlr->visible_ns) { 535 SPDK_ERRLOG("Failed to allocate visible namespace array\n"); 536 goto err_visible_ns; 537 } 538 nvmf_ctrlr_init_visible_ns(ctrlr); 539 540 ctrlr->vcprop.cap.raw = 0; 541 ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */ 542 ctrlr->vcprop.cap.bits.mqes = transport->opts.max_queue_depth - 543 1; /* max queue depth */ 544 ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */ 545 /* ready timeout - 500 msec units */ 546 ctrlr->vcprop.cap.bits.to = NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS / 500; 547 ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */ 548 subsys_has_multi_iocs = nvmf_subsystem_has_zns_iocs(subsystem); 549 if (subsys_has_multi_iocs) { 550 ctrlr->vcprop.cap.bits.css = 551 SPDK_NVME_CAP_CSS_IOCS; /* One or more I/O command sets supported */ 552 } else { 553 ctrlr->vcprop.cap.bits.css = SPDK_NVME_CAP_CSS_NVM; /* NVM command set */ 554 } 555 556 ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */ 557 ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */ 558 559 /* Version Supported: 1.3 */ 560 ctrlr->vcprop.vs.bits.mjr = 1; 561 ctrlr->vcprop.vs.bits.mnr = 3; 562 ctrlr->vcprop.vs.bits.ter = 0; 563 564 ctrlr->vcprop.cc.raw = 0; 565 ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */ 566 if (subsys_has_multi_iocs) { 567 ctrlr->vcprop.cc.bits.css = 568 SPDK_NVME_CC_CSS_IOCS; /* All supported I/O Command Sets */ 569 } 570 571 ctrlr->vcprop.csts.raw = 0; 572 ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */ 573 574 SPDK_DEBUGLOG(nvmf, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw); 575 SPDK_DEBUGLOG(nvmf, "vs 0x%x\n", ctrlr->vcprop.vs.raw); 576 SPDK_DEBUGLOG(nvmf, "cc 0x%x\n", ctrlr->vcprop.cc.raw); 577 SPDK_DEBUGLOG(nvmf, "csts 0x%x\n", ctrlr->vcprop.csts.raw); 578 579 ctrlr->dif_insert_or_strip = transport->opts.dif_insert_or_strip; 580 581 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_NVME) { 582 if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &listen_trid) != 0) { 583 SPDK_ERRLOG("Could not get listener transport ID\n"); 584 goto err_listener; 585 } 586 587 ctrlr->listener = nvmf_subsystem_find_listener(ctrlr->subsys, &listen_trid); 588 if (!ctrlr->listener) { 589 SPDK_ERRLOG("Listener was not found\n"); 590 goto err_listener; 591 } 592 } 593 594 nvmf_qpair_set_ctrlr(req->qpair, ctrlr); 595 spdk_thread_send_msg(subsystem->thread, _nvmf_subsystem_add_ctrlr, req); 596 597 return ctrlr; 598 err_listener: 599 spdk_bit_array_free(&ctrlr->visible_ns); 600 err_visible_ns: 601 spdk_bit_array_free(&ctrlr->qpair_mask); 602 err_qpair_mask: 603 free(ctrlr); 604 return NULL; 605 } 606 607 static void 608 _nvmf_ctrlr_destruct(void *ctx) 609 { 610 struct spdk_nvmf_ctrlr *ctrlr = ctx; 611 struct spdk_nvmf_reservation_log *log, *log_tmp; 612 struct spdk_nvmf_async_event_completion *event, *event_tmp; 613 614 SPDK_DTRACE_PROBE3_TICKS(nvmf_ctrlr_destruct, ctrlr, ctrlr->subsys->subnqn, 615 spdk_thread_get_id(ctrlr->thread)); 616 617 assert(spdk_get_thread() == ctrlr->thread); 618 assert(ctrlr->in_destruct); 619 620 SPDK_DEBUGLOG(nvmf, "Destroy ctrlr 0x%hx\n", ctrlr->cntlid); 621 if (ctrlr->disconnect_in_progress) { 622 SPDK_ERRLOG("freeing ctrlr with disconnect in progress\n"); 623 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_destruct, ctrlr); 624 return; 625 } 626 627 nvmf_ctrlr_stop_keep_alive_timer(ctrlr); 628 nvmf_ctrlr_stop_association_timer(ctrlr); 629 spdk_bit_array_free(&ctrlr->qpair_mask); 630 631 TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) { 632 TAILQ_REMOVE(&ctrlr->log_head, log, link); 633 free(log); 634 } 635 STAILQ_FOREACH_SAFE(event, &ctrlr->async_events, link, event_tmp) { 636 STAILQ_REMOVE(&ctrlr->async_events, event, spdk_nvmf_async_event_completion, link); 637 free(event); 638 } 639 spdk_bit_array_free(&ctrlr->visible_ns); 640 free(ctrlr); 641 } 642 643 void 644 nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 645 { 646 nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr); 647 648 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_destruct, ctrlr); 649 } 650 651 static void 652 nvmf_ctrlr_add_io_qpair(void *ctx) 653 { 654 struct spdk_nvmf_request *req = ctx; 655 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 656 struct spdk_nvmf_qpair *qpair = req->qpair; 657 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 658 struct spdk_nvmf_qpair *admin_qpair = ctrlr->admin_qpair; 659 struct spdk_nvmf_poll_group *admin_qpair_group = NULL; 660 enum spdk_nvmf_qpair_state admin_qpair_state = SPDK_NVMF_QPAIR_UNINITIALIZED; 661 bool admin_qpair_active = false; 662 663 SPDK_DTRACE_PROBE4_TICKS(nvmf_ctrlr_add_io_qpair, ctrlr, req->qpair, req->qpair->qid, 664 spdk_thread_get_id(ctrlr->thread)); 665 666 /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect. 667 * For error case, the value should be NULL. So set it to NULL at first. 668 */ 669 qpair->ctrlr = NULL; 670 671 /* Make sure the controller is not being destroyed. */ 672 if (ctrlr->in_destruct) { 673 SPDK_ERRLOG("Got I/O connect while ctrlr was being destroyed.\n"); 674 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 675 goto end; 676 } 677 678 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 679 SPDK_ERRLOG("I/O connect not allowed on discovery controller\n"); 680 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 681 goto end; 682 } 683 684 if (!ctrlr->vcprop.cc.bits.en) { 685 SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n"); 686 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 687 goto end; 688 } 689 690 if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) { 691 SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n", 692 ctrlr->vcprop.cc.bits.iosqes); 693 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 694 goto end; 695 } 696 697 if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) { 698 SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n", 699 ctrlr->vcprop.cc.bits.iocqes); 700 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 701 goto end; 702 } 703 704 /* There is a chance that admin qpair was destroyed. This is an issue that was observed only with ESX initiators */ 705 if (admin_qpair) { 706 admin_qpair_active = spdk_nvmf_qpair_is_active(admin_qpair); 707 admin_qpair_group = admin_qpair->group; 708 admin_qpair_state = admin_qpair->state; 709 } 710 711 if (!admin_qpair_active || admin_qpair_group == NULL) { 712 /* There is a chance that admin qpair was destroyed or is being destroyed at this moment due to e.g. 713 * expired keep alive timer. Part of the qpair destruction process is change of qpair's 714 * state to DEACTIVATING and removing it from poll group */ 715 SPDK_ERRLOG("Inactive admin qpair (state %d, group %p)\n", admin_qpair_state, admin_qpair_group); 716 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 717 goto end; 718 } 719 720 /* check if we would exceed ctrlr connection limit */ 721 if (qpair->qid >= spdk_bit_array_capacity(ctrlr->qpair_mask)) { 722 SPDK_ERRLOG("Requested QID %u but Max QID is %u\n", 723 qpair->qid, spdk_bit_array_capacity(ctrlr->qpair_mask) - 1); 724 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 725 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 726 goto end; 727 } 728 729 nvmf_ctrlr_add_qpair(qpair, ctrlr, req); 730 return; 731 end: 732 spdk_nvmf_request_complete(req); 733 } 734 735 static void 736 _nvmf_ctrlr_add_io_qpair(void *ctx) 737 { 738 struct spdk_nvmf_request *req = ctx; 739 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 740 struct spdk_nvmf_fabric_connect_data *data; 741 struct spdk_nvmf_ctrlr *ctrlr; 742 struct spdk_nvmf_qpair *qpair = req->qpair; 743 struct spdk_nvmf_qpair *admin_qpair; 744 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 745 struct spdk_nvmf_subsystem *subsystem; 746 struct spdk_nvme_transport_id listen_trid = {}; 747 const struct spdk_nvmf_subsystem_listener *listener; 748 struct spdk_nvmf_poll_group *admin_qpair_group = NULL; 749 enum spdk_nvmf_qpair_state admin_qpair_state = SPDK_NVMF_QPAIR_UNINITIALIZED; 750 bool admin_qpair_active = false; 751 752 assert(req->iovcnt == 1); 753 754 data = req->iov[0].iov_base; 755 756 SPDK_DEBUGLOG(nvmf, "Connect I/O Queue for controller id 0x%x\n", data->cntlid); 757 758 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 759 /* We already checked this in spdk_nvmf_ctrlr_connect */ 760 assert(subsystem != NULL); 761 762 ctrlr = nvmf_subsystem_get_ctrlr(subsystem, data->cntlid); 763 if (ctrlr == NULL) { 764 SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid); 765 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 766 spdk_nvmf_request_complete(req); 767 return; 768 } 769 770 /* fail before passing a message to the controller thread. */ 771 if (ctrlr->in_destruct) { 772 SPDK_ERRLOG("Got I/O connect while ctrlr was being destroyed.\n"); 773 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 774 spdk_nvmf_request_complete(req); 775 return; 776 } 777 778 /* If ANA reporting is enabled, check if I/O connect is on the same listener. */ 779 if (subsystem->flags.ana_reporting) { 780 if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &listen_trid) != 0) { 781 SPDK_ERRLOG("Could not get listener transport ID\n"); 782 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 783 spdk_nvmf_request_complete(req); 784 return; 785 } 786 787 listener = nvmf_subsystem_find_listener(subsystem, &listen_trid); 788 if (listener != ctrlr->listener) { 789 SPDK_ERRLOG("I/O connect is on a listener different from admin connect\n"); 790 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 791 spdk_nvmf_request_complete(req); 792 return; 793 } 794 } 795 796 admin_qpair = ctrlr->admin_qpair; 797 798 /* There is a chance that admin qpair was destroyed. This is an issue that was observed only with ESX initiators */ 799 if (admin_qpair) { 800 admin_qpair_active = spdk_nvmf_qpair_is_active(admin_qpair); 801 admin_qpair_group = admin_qpair->group; 802 admin_qpair_state = admin_qpair->state; 803 } 804 805 if (!admin_qpair_active || admin_qpair_group == NULL) { 806 /* There is a chance that admin qpair was destroyed or is being destroyed at this moment due to e.g. 807 * expired keep alive timer. Part of the qpair destruction process is change of qpair's 808 * state to DEACTIVATING and removing it from poll group */ 809 SPDK_ERRLOG("Inactive admin qpair (state %d, group %p)\n", admin_qpair_state, admin_qpair_group); 810 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 811 spdk_nvmf_request_complete(req); 812 return; 813 } 814 qpair->ctrlr = ctrlr; 815 spdk_thread_send_msg(admin_qpair_group->thread, nvmf_ctrlr_add_io_qpair, req); 816 } 817 818 static bool 819 nvmf_qpair_access_allowed(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_subsystem *subsystem, 820 const char *hostnqn) 821 { 822 struct spdk_nvme_transport_id listen_trid = {}; 823 824 if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) { 825 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subsystem->subnqn, hostnqn); 826 return false; 827 } 828 829 if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid)) { 830 SPDK_ERRLOG("Subsystem '%s' is unable to enforce access control due to an internal error.\n", 831 subsystem->subnqn); 832 return false; 833 } 834 835 if (!spdk_nvmf_subsystem_listener_allowed(subsystem, &listen_trid)) { 836 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s' to connect at this address.\n", 837 subsystem->subnqn, hostnqn); 838 return false; 839 } 840 841 return true; 842 } 843 844 static int 845 _nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 846 { 847 struct spdk_nvmf_fabric_connect_data *data = req->iov[0].iov_base; 848 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 849 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 850 struct spdk_nvmf_qpair *qpair = req->qpair; 851 struct spdk_nvmf_transport *transport = qpair->transport; 852 struct spdk_nvmf_ctrlr *ctrlr; 853 struct spdk_nvmf_subsystem *subsystem; 854 855 SPDK_DEBUGLOG(nvmf, "recfmt 0x%x qid %u sqsize %u\n", 856 cmd->recfmt, cmd->qid, cmd->sqsize); 857 858 SPDK_DEBUGLOG(nvmf, "Connect data:\n"); 859 SPDK_DEBUGLOG(nvmf, " cntlid: 0x%04x\n", data->cntlid); 860 SPDK_DEBUGLOG(nvmf, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n", 861 ntohl(*(uint32_t *)&data->hostid[0]), 862 ntohs(*(uint16_t *)&data->hostid[4]), 863 ntohs(*(uint16_t *)&data->hostid[6]), 864 data->hostid[8], 865 data->hostid[9], 866 ntohs(*(uint16_t *)&data->hostid[10]), 867 ntohl(*(uint32_t *)&data->hostid[12])); 868 SPDK_DEBUGLOG(nvmf, " subnqn: \"%s\"\n", data->subnqn); 869 SPDK_DEBUGLOG(nvmf, " hostnqn: \"%s\"\n", data->hostnqn); 870 871 subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn); 872 if (!subsystem) { 873 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 874 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 875 } 876 877 if (cmd->recfmt != 0) { 878 SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt); 879 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 880 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT; 881 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 882 } 883 884 /* 885 * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and 886 * strictly less than max_aq_depth (admin queues) or max_queue_depth (io queues). 887 */ 888 if (cmd->sqsize == 0) { 889 SPDK_ERRLOG("Invalid SQSIZE = 0\n"); 890 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 891 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 892 } 893 894 if (cmd->qid == 0) { 895 if (cmd->sqsize >= transport->opts.max_aq_depth) { 896 SPDK_ERRLOG("Invalid SQSIZE for admin queue %u (min 1, max %u)\n", 897 cmd->sqsize, transport->opts.max_aq_depth - 1); 898 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 899 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 900 } 901 } else if (cmd->sqsize >= transport->opts.max_queue_depth) { 902 SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n", 903 cmd->sqsize, transport->opts.max_queue_depth - 1); 904 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 905 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 906 } 907 908 qpair->sq_head_max = cmd->sqsize; 909 qpair->qid = cmd->qid; 910 qpair->connect_received = true; 911 912 pthread_mutex_lock(&qpair->group->mutex); 913 assert(qpair->group->current_unassociated_qpairs > 0); 914 qpair->group->current_unassociated_qpairs--; 915 pthread_mutex_unlock(&qpair->group->mutex); 916 917 if (0 == qpair->qid) { 918 qpair->group->stat.admin_qpairs++; 919 qpair->group->stat.current_admin_qpairs++; 920 } else { 921 qpair->group->stat.io_qpairs++; 922 qpair->group->stat.current_io_qpairs++; 923 } 924 925 if (cmd->qid == 0) { 926 SPDK_DEBUGLOG(nvmf, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid); 927 928 if (spdk_nvme_trtype_is_fabrics(transport->ops->type) && data->cntlid != 0xFFFF) { 929 /* This NVMf target only supports dynamic mode. */ 930 SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid); 931 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 932 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 933 } 934 935 /* Establish a new ctrlr */ 936 ctrlr = nvmf_ctrlr_create(subsystem, req, cmd, data); 937 if (!ctrlr) { 938 SPDK_ERRLOG("nvmf_ctrlr_create() failed\n"); 939 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 940 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 941 } else { 942 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 943 } 944 } else { 945 spdk_thread_send_msg(subsystem->thread, _nvmf_ctrlr_add_io_qpair, req); 946 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 947 } 948 } 949 950 static struct spdk_nvmf_subsystem_poll_group * 951 nvmf_subsystem_pg_from_connect_cmd(struct spdk_nvmf_request *req) 952 { 953 struct spdk_nvmf_fabric_connect_data *data; 954 struct spdk_nvmf_subsystem *subsystem; 955 struct spdk_nvmf_tgt *tgt; 956 957 assert(nvmf_request_is_fabric_connect(req)); 958 assert(req->qpair->ctrlr == NULL); 959 assert(req->iovcnt == 1); 960 961 data = req->iov[0].iov_base; 962 tgt = req->qpair->transport->tgt; 963 964 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 965 if (subsystem == NULL) { 966 return NULL; 967 } 968 969 return &req->qpair->group->sgroups[subsystem->id]; 970 } 971 972 int 973 spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 974 { 975 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 976 struct spdk_nvmf_subsystem_poll_group *sgroup; 977 struct spdk_nvmf_qpair *qpair = req->qpair; 978 enum spdk_nvmf_request_exec_status status; 979 980 if (req->iovcnt > 1) { 981 SPDK_ERRLOG("Connect command invalid iovcnt: %d\n", req->iovcnt); 982 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 983 status = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 984 goto out; 985 } 986 987 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 988 if (!sgroup) { 989 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 990 status = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 991 goto out; 992 } 993 994 sgroup->mgmt_io_outstanding++; 995 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 996 997 status = _nvmf_ctrlr_connect(req); 998 999 out: 1000 if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 1001 _nvmf_request_complete(req); 1002 } 1003 1004 return status; 1005 } 1006 1007 static int 1008 nvmf_ctrlr_cmd_connect(struct spdk_nvmf_request *req) 1009 { 1010 struct spdk_nvmf_fabric_connect_data *data = req->iov[0].iov_base; 1011 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 1012 struct spdk_nvmf_transport *transport = req->qpair->transport; 1013 struct spdk_nvmf_subsystem *subsystem; 1014 1015 if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) { 1016 SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length); 1017 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1018 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1019 } 1020 1021 if (req->iovcnt > 1) { 1022 SPDK_ERRLOG("Connect command invalid iovcnt: %d\n", req->iovcnt); 1023 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1024 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1025 } 1026 1027 subsystem = spdk_nvmf_tgt_find_subsystem(transport->tgt, data->subnqn); 1028 if (!subsystem) { 1029 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 1030 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1031 } 1032 1033 if ((subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE) || 1034 (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSING) || 1035 (subsystem->state == SPDK_NVMF_SUBSYSTEM_PAUSED) || 1036 (subsystem->state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING)) { 1037 struct spdk_nvmf_subsystem_poll_group *sgroup; 1038 1039 /* Subsystem is not ready to handle a connect. Decrement 1040 * the mgmt_io_outstanding to avoid the subsystem waiting 1041 * for this command to complete before unpausing. Queued 1042 * requests get retried when subsystem resumes. 1043 */ 1044 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 1045 assert(sgroup != NULL); 1046 sgroup->mgmt_io_outstanding--; 1047 TAILQ_REMOVE(&req->qpair->outstanding, req, link); 1048 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 1049 SPDK_DEBUGLOG(nvmf, "Subsystem '%s' is not ready for connect, retrying...\n", subsystem->subnqn); 1050 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 1051 } 1052 1053 /* Ensure that hostnqn is null terminated */ 1054 if (!memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1)) { 1055 SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n"); 1056 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn); 1057 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1058 } 1059 1060 if (!nvmf_qpair_access_allowed(req->qpair, subsystem, data->hostnqn)) { 1061 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1062 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 1063 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1064 } 1065 1066 return _nvmf_ctrlr_connect(req); 1067 } 1068 1069 static int 1070 nvmf_ctrlr_association_remove(void *ctx) 1071 { 1072 struct spdk_nvmf_ctrlr *ctrlr = ctx; 1073 int rc; 1074 1075 nvmf_ctrlr_stop_association_timer(ctrlr); 1076 1077 if (ctrlr->in_destruct) { 1078 return SPDK_POLLER_IDLE; 1079 } 1080 SPDK_DEBUGLOG(nvmf, "Disconnecting host from subsystem %s due to association timeout.\n", 1081 ctrlr->subsys->subnqn); 1082 1083 if (ctrlr->admin_qpair) { 1084 rc = spdk_nvmf_qpair_disconnect(ctrlr->admin_qpair); 1085 if (rc < 0 && rc != -EINPROGRESS) { 1086 SPDK_ERRLOG("Fail to disconnect admin ctrlr qpair\n"); 1087 assert(false); 1088 } 1089 } 1090 1091 return SPDK_POLLER_BUSY; 1092 } 1093 1094 static int 1095 _nvmf_ctrlr_cc_reset_shn_done(void *ctx) 1096 { 1097 struct spdk_nvmf_ctrlr *ctrlr = ctx; 1098 uint64_t now = spdk_get_ticks(); 1099 uint32_t count; 1100 1101 if (ctrlr->cc_timer) { 1102 spdk_poller_unregister(&ctrlr->cc_timer); 1103 } 1104 1105 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 1106 SPDK_DEBUGLOG(nvmf, "ctrlr %p active queue count %u\n", ctrlr, count); 1107 1108 if (count > 1) { 1109 if (now < ctrlr->cc_timeout_tsc) { 1110 /* restart cc timer */ 1111 ctrlr->cc_timer = SPDK_POLLER_REGISTER(_nvmf_ctrlr_cc_reset_shn_done, ctrlr, 100 * 1000); 1112 return SPDK_POLLER_IDLE; 1113 } else { 1114 /* controller fatal status */ 1115 SPDK_WARNLOG("IO timeout, ctrlr %p is in fatal status\n", ctrlr); 1116 nvmf_ctrlr_set_fatal_status(ctrlr); 1117 } 1118 } 1119 1120 spdk_poller_unregister(&ctrlr->cc_timeout_timer); 1121 1122 if (ctrlr->disconnect_is_shn) { 1123 ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE; 1124 ctrlr->disconnect_is_shn = false; 1125 } else { 1126 /* Only a subset of the registers are cleared out on a reset */ 1127 ctrlr->vcprop.cc.raw = 0; 1128 ctrlr->vcprop.csts.raw = 0; 1129 } 1130 1131 /* After CC.EN transitions to 0 (due to shutdown or reset), the association 1132 * between the host and controller shall be preserved for at least 2 minutes */ 1133 if (ctrlr->association_timer) { 1134 SPDK_DEBUGLOG(nvmf, "Association timer already set\n"); 1135 nvmf_ctrlr_stop_association_timer(ctrlr); 1136 } 1137 if (ctrlr->association_timeout) { 1138 ctrlr->association_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_association_remove, ctrlr, 1139 ctrlr->association_timeout * 1000); 1140 } 1141 ctrlr->disconnect_in_progress = false; 1142 return SPDK_POLLER_BUSY; 1143 } 1144 1145 static void 1146 nvmf_ctrlr_cc_reset_shn_done(struct spdk_io_channel_iter *i, int status) 1147 { 1148 struct spdk_nvmf_ctrlr *ctrlr = spdk_io_channel_iter_get_ctx(i); 1149 1150 if (status < 0) { 1151 SPDK_ERRLOG("Fail to disconnect io ctrlr qpairs\n"); 1152 assert(false); 1153 } 1154 1155 _nvmf_ctrlr_cc_reset_shn_done((void *)ctrlr); 1156 } 1157 1158 static void 1159 nvmf_bdev_complete_reset(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 1160 { 1161 SPDK_NOTICELOG("Resetting bdev done with %s\n", success ? "success" : "failure"); 1162 1163 spdk_bdev_free_io(bdev_io); 1164 } 1165 1166 1167 static int 1168 nvmf_ctrlr_cc_timeout(void *ctx) 1169 { 1170 struct spdk_nvmf_ctrlr *ctrlr = ctx; 1171 struct spdk_nvmf_poll_group *group; 1172 struct spdk_nvmf_ns *ns; 1173 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 1174 1175 spdk_poller_unregister(&ctrlr->cc_timeout_timer); 1176 SPDK_DEBUGLOG(nvmf, "Ctrlr %p reset or shutdown timeout\n", ctrlr); 1177 1178 if (!ctrlr->admin_qpair) { 1179 SPDK_NOTICELOG("Ctrlr %p admin qpair disconnected\n", ctrlr); 1180 return SPDK_POLLER_IDLE; 1181 } 1182 1183 group = ctrlr->admin_qpair->group; 1184 assert(group != NULL && group->sgroups != NULL); 1185 1186 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL; 1187 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 1188 if (ns->bdev == NULL) { 1189 continue; 1190 } 1191 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[ns->opts.nsid - 1]; 1192 SPDK_NOTICELOG("Ctrlr %p resetting NSID %u\n", ctrlr, ns->opts.nsid); 1193 spdk_bdev_reset(ns->desc, ns_info->channel, nvmf_bdev_complete_reset, NULL); 1194 } 1195 1196 return SPDK_POLLER_BUSY; 1197 } 1198 1199 const struct spdk_nvmf_registers * 1200 spdk_nvmf_ctrlr_get_regs(struct spdk_nvmf_ctrlr *ctrlr) 1201 { 1202 return &ctrlr->vcprop; 1203 } 1204 1205 void 1206 nvmf_ctrlr_set_fatal_status(struct spdk_nvmf_ctrlr *ctrlr) 1207 { 1208 ctrlr->vcprop.csts.bits.cfs = 1; 1209 } 1210 1211 static uint64_t 1212 nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr) 1213 { 1214 return ctrlr->vcprop.cap.raw; 1215 } 1216 1217 static uint64_t 1218 nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr) 1219 { 1220 return ctrlr->vcprop.vs.raw; 1221 } 1222 1223 static uint64_t 1224 nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr) 1225 { 1226 return ctrlr->vcprop.cc.raw; 1227 } 1228 1229 static bool 1230 nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1231 { 1232 union spdk_nvme_cc_register cc, diff; 1233 uint32_t cc_timeout_ms; 1234 1235 cc.raw = value; 1236 1237 SPDK_DEBUGLOG(nvmf, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw); 1238 SPDK_DEBUGLOG(nvmf, "new CC: 0x%08x\n", cc.raw); 1239 1240 /* 1241 * Calculate which bits changed between the current and new CC. 1242 * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed. 1243 */ 1244 diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw; 1245 1246 if (diff.bits.en) { 1247 if (cc.bits.en) { 1248 SPDK_DEBUGLOG(nvmf, "Property Set CC Enable!\n"); 1249 nvmf_ctrlr_stop_association_timer(ctrlr); 1250 1251 ctrlr->vcprop.cc.bits.en = 1; 1252 ctrlr->vcprop.csts.bits.rdy = 1; 1253 } else { 1254 SPDK_DEBUGLOG(nvmf, "Property Set CC Disable!\n"); 1255 if (ctrlr->disconnect_in_progress) { 1256 SPDK_DEBUGLOG(nvmf, "Disconnect in progress\n"); 1257 return true; 1258 } 1259 1260 ctrlr->cc_timeout_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_cc_timeout, ctrlr, 1261 NVMF_CC_RESET_SHN_TIMEOUT_IN_MS * 1000); 1262 /* Make sure cc_timeout_ms is between cc_timeout_timer and Host reset/shutdown timeout */ 1263 cc_timeout_ms = (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS) / 2; 1264 ctrlr->cc_timeout_tsc = spdk_get_ticks() + cc_timeout_ms * spdk_get_ticks_hz() / (uint64_t)1000; 1265 1266 ctrlr->vcprop.cc.bits.en = 0; 1267 ctrlr->disconnect_in_progress = true; 1268 ctrlr->disconnect_is_shn = false; 1269 spdk_for_each_channel(ctrlr->subsys->tgt, 1270 nvmf_ctrlr_disconnect_io_qpairs_on_pg, 1271 ctrlr, 1272 nvmf_ctrlr_cc_reset_shn_done); 1273 } 1274 diff.bits.en = 0; 1275 } 1276 1277 if (diff.bits.shn) { 1278 if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || 1279 cc.bits.shn == SPDK_NVME_SHN_ABRUPT) { 1280 SPDK_DEBUGLOG(nvmf, "Property Set CC Shutdown %u%ub!\n", 1281 cc.bits.shn >> 1, cc.bits.shn & 1); 1282 if (ctrlr->disconnect_in_progress) { 1283 SPDK_DEBUGLOG(nvmf, "Disconnect in progress\n"); 1284 return true; 1285 } 1286 1287 ctrlr->cc_timeout_timer = SPDK_POLLER_REGISTER(nvmf_ctrlr_cc_timeout, ctrlr, 1288 NVMF_CC_RESET_SHN_TIMEOUT_IN_MS * 1000); 1289 /* Make sure cc_timeout_ms is between cc_timeout_timer and Host reset/shutdown timeout */ 1290 cc_timeout_ms = (NVMF_CC_RESET_SHN_TIMEOUT_IN_MS + NVMF_CTRLR_RESET_SHN_TIMEOUT_IN_MS) / 2; 1291 ctrlr->cc_timeout_tsc = spdk_get_ticks() + cc_timeout_ms * spdk_get_ticks_hz() / (uint64_t)1000; 1292 1293 ctrlr->vcprop.cc.bits.shn = cc.bits.shn; 1294 ctrlr->disconnect_in_progress = true; 1295 ctrlr->disconnect_is_shn = true; 1296 spdk_for_each_channel(ctrlr->subsys->tgt, 1297 nvmf_ctrlr_disconnect_io_qpairs_on_pg, 1298 ctrlr, 1299 nvmf_ctrlr_cc_reset_shn_done); 1300 1301 /* From the time a shutdown is initiated the controller shall disable 1302 * Keep Alive timer */ 1303 nvmf_ctrlr_stop_keep_alive_timer(ctrlr); 1304 } else if (cc.bits.shn == 0) { 1305 ctrlr->vcprop.cc.bits.shn = 0; 1306 } else { 1307 SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n", 1308 cc.bits.shn >> 1, cc.bits.shn & 1); 1309 return false; 1310 } 1311 diff.bits.shn = 0; 1312 } 1313 1314 if (diff.bits.iosqes) { 1315 SPDK_DEBUGLOG(nvmf, "Prop Set IOSQES = %u (%u bytes)\n", 1316 cc.bits.iosqes, 1u << cc.bits.iosqes); 1317 ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes; 1318 diff.bits.iosqes = 0; 1319 } 1320 1321 if (diff.bits.iocqes) { 1322 SPDK_DEBUGLOG(nvmf, "Prop Set IOCQES = %u (%u bytes)\n", 1323 cc.bits.iocqes, 1u << cc.bits.iocqes); 1324 ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes; 1325 diff.bits.iocqes = 0; 1326 } 1327 1328 if (diff.bits.ams) { 1329 SPDK_ERRLOG("Arbitration Mechanism Selected (AMS) 0x%x not supported!\n", cc.bits.ams); 1330 return false; 1331 } 1332 1333 if (diff.bits.mps) { 1334 SPDK_ERRLOG("Memory Page Size (MPS) %u KiB not supported!\n", (1 << (2 + cc.bits.mps))); 1335 return false; 1336 } 1337 1338 if (diff.bits.css) { 1339 if (cc.bits.css > SPDK_NVME_CC_CSS_IOCS) { 1340 SPDK_ERRLOG("I/O Command Set Selected (CSS) 0x%x not supported!\n", cc.bits.css); 1341 return false; 1342 } 1343 diff.bits.css = 0; 1344 } 1345 1346 if (diff.raw != 0) { 1347 /* Print an error message, but don't fail the command in this case. 1348 * If we did want to fail in this case, we'd need to ensure we acted 1349 * on no other bits or the initiator gets confused. */ 1350 SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw); 1351 } 1352 1353 return true; 1354 } 1355 1356 static uint64_t 1357 nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr) 1358 { 1359 return ctrlr->vcprop.csts.raw; 1360 } 1361 1362 static uint64_t 1363 nvmf_prop_get_aqa(struct spdk_nvmf_ctrlr *ctrlr) 1364 { 1365 return ctrlr->vcprop.aqa.raw; 1366 } 1367 1368 static bool 1369 nvmf_prop_set_aqa(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1370 { 1371 union spdk_nvme_aqa_register aqa; 1372 1373 aqa.raw = value; 1374 1375 /* 1376 * We don't need to explicitly check for maximum size, as the fields are 1377 * limited to 12 bits (4096). 1378 */ 1379 if (aqa.bits.asqs < SPDK_NVME_ADMIN_QUEUE_MIN_ENTRIES - 1 || 1380 aqa.bits.acqs < SPDK_NVME_ADMIN_QUEUE_MIN_ENTRIES - 1 || 1381 aqa.bits.reserved1 != 0 || aqa.bits.reserved2 != 0) { 1382 return false; 1383 } 1384 1385 ctrlr->vcprop.aqa.raw = value; 1386 1387 return true; 1388 } 1389 1390 static uint64_t 1391 nvmf_prop_get_asq(struct spdk_nvmf_ctrlr *ctrlr) 1392 { 1393 return ctrlr->vcprop.asq; 1394 } 1395 1396 static bool 1397 nvmf_prop_set_asq_lower(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1398 { 1399 ctrlr->vcprop.asq = (ctrlr->vcprop.asq & (0xFFFFFFFFULL << 32ULL)) | value; 1400 1401 return true; 1402 } 1403 1404 static bool 1405 nvmf_prop_set_asq_upper(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1406 { 1407 ctrlr->vcprop.asq = (ctrlr->vcprop.asq & 0xFFFFFFFFULL) | ((uint64_t)value << 32ULL); 1408 1409 return true; 1410 } 1411 1412 static uint64_t 1413 nvmf_prop_get_acq(struct spdk_nvmf_ctrlr *ctrlr) 1414 { 1415 return ctrlr->vcprop.acq; 1416 } 1417 1418 static bool 1419 nvmf_prop_set_acq_lower(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1420 { 1421 ctrlr->vcprop.acq = (ctrlr->vcprop.acq & (0xFFFFFFFFULL << 32ULL)) | value; 1422 1423 return true; 1424 } 1425 1426 static bool 1427 nvmf_prop_set_acq_upper(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value) 1428 { 1429 ctrlr->vcprop.acq = (ctrlr->vcprop.acq & 0xFFFFFFFFULL) | ((uint64_t)value << 32ULL); 1430 1431 return true; 1432 } 1433 1434 struct nvmf_prop { 1435 uint32_t ofst; 1436 uint8_t size; 1437 char name[11]; 1438 uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr); 1439 bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value); 1440 bool (*set_upper_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint32_t value); 1441 }; 1442 1443 #define PROP(field, size, get_cb, set_cb, set_upper_cb) \ 1444 { \ 1445 offsetof(struct spdk_nvme_registers, field), \ 1446 size, \ 1447 #field, \ 1448 get_cb, set_cb, set_upper_cb \ 1449 } 1450 1451 static const struct nvmf_prop nvmf_props[] = { 1452 PROP(cap, 8, nvmf_prop_get_cap, NULL, NULL), 1453 PROP(vs, 4, nvmf_prop_get_vs, NULL, NULL), 1454 PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc, NULL), 1455 PROP(csts, 4, nvmf_prop_get_csts, NULL, NULL), 1456 PROP(aqa, 4, nvmf_prop_get_aqa, nvmf_prop_set_aqa, NULL), 1457 PROP(asq, 8, nvmf_prop_get_asq, nvmf_prop_set_asq_lower, nvmf_prop_set_asq_upper), 1458 PROP(acq, 8, nvmf_prop_get_acq, nvmf_prop_set_acq_lower, nvmf_prop_set_acq_upper), 1459 }; 1460 1461 static const struct nvmf_prop * 1462 find_prop(uint32_t ofst, uint8_t size) 1463 { 1464 size_t i; 1465 1466 for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) { 1467 const struct nvmf_prop *prop = &nvmf_props[i]; 1468 1469 if ((ofst >= prop->ofst) && (ofst + size <= prop->ofst + prop->size)) { 1470 return prop; 1471 } 1472 } 1473 1474 return NULL; 1475 } 1476 1477 static int 1478 nvmf_property_get(struct spdk_nvmf_request *req) 1479 { 1480 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1481 struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd; 1482 struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp; 1483 const struct nvmf_prop *prop; 1484 uint8_t size; 1485 1486 response->status.sc = 0; 1487 response->value.u64 = 0; 1488 1489 SPDK_DEBUGLOG(nvmf, "size %d, offset 0x%x\n", 1490 cmd->attrib.size, cmd->ofst); 1491 1492 switch (cmd->attrib.size) { 1493 case SPDK_NVMF_PROP_SIZE_4: 1494 size = 4; 1495 break; 1496 case SPDK_NVMF_PROP_SIZE_8: 1497 size = 8; 1498 break; 1499 default: 1500 SPDK_DEBUGLOG(nvmf, "Invalid size value %d\n", cmd->attrib.size); 1501 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1502 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 1503 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1504 } 1505 1506 prop = find_prop(cmd->ofst, size); 1507 if (prop == NULL || prop->get_cb == NULL) { 1508 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1509 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 1510 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1511 } 1512 1513 SPDK_DEBUGLOG(nvmf, "name: %s\n", prop->name); 1514 1515 response->value.u64 = prop->get_cb(ctrlr); 1516 1517 if (size != prop->size) { 1518 /* The size must be 4 and the prop->size is 8. Figure out which part of the property to read. */ 1519 assert(size == 4); 1520 assert(prop->size == 8); 1521 1522 if (cmd->ofst == prop->ofst) { 1523 /* Keep bottom 4 bytes only */ 1524 response->value.u64 &= 0xFFFFFFFF; 1525 } else { 1526 /* Keep top 4 bytes only */ 1527 response->value.u64 >>= 32; 1528 } 1529 } 1530 1531 SPDK_DEBUGLOG(nvmf, "response value: 0x%" PRIx64 "\n", response->value.u64); 1532 1533 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1534 } 1535 1536 static int 1537 nvmf_property_set(struct spdk_nvmf_request *req) 1538 { 1539 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1540 struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd; 1541 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1542 const struct nvmf_prop *prop; 1543 uint64_t value; 1544 uint8_t size; 1545 bool ret; 1546 1547 SPDK_DEBUGLOG(nvmf, "size %d, offset 0x%x, value 0x%" PRIx64 "\n", 1548 cmd->attrib.size, cmd->ofst, cmd->value.u64); 1549 1550 switch (cmd->attrib.size) { 1551 case SPDK_NVMF_PROP_SIZE_4: 1552 size = 4; 1553 break; 1554 case SPDK_NVMF_PROP_SIZE_8: 1555 size = 8; 1556 break; 1557 default: 1558 SPDK_DEBUGLOG(nvmf, "Invalid size value %d\n", cmd->attrib.size); 1559 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1560 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 1561 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1562 } 1563 1564 prop = find_prop(cmd->ofst, size); 1565 if (prop == NULL || prop->set_cb == NULL) { 1566 SPDK_INFOLOG(nvmf, "Invalid offset 0x%x\n", cmd->ofst); 1567 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1568 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 1569 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1570 } 1571 1572 SPDK_DEBUGLOG(nvmf, "name: %s\n", prop->name); 1573 1574 value = cmd->value.u64; 1575 1576 if (prop->size == 4) { 1577 ret = prop->set_cb(ctrlr, (uint32_t)value); 1578 } else if (size != prop->size) { 1579 /* The size must be 4 and the prop->size is 8. Figure out which part of the property to write. */ 1580 assert(size == 4); 1581 assert(prop->size == 8); 1582 1583 if (cmd->ofst == prop->ofst) { 1584 ret = prop->set_cb(ctrlr, (uint32_t)value); 1585 } else { 1586 ret = prop->set_upper_cb(ctrlr, (uint32_t)value); 1587 } 1588 } else { 1589 ret = prop->set_cb(ctrlr, (uint32_t)value); 1590 if (ret) { 1591 ret = prop->set_upper_cb(ctrlr, (uint32_t)(value >> 32)); 1592 } 1593 } 1594 1595 if (!ret) { 1596 SPDK_ERRLOG("prop set_cb failed\n"); 1597 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1598 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 1599 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1600 } 1601 1602 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1603 } 1604 1605 static int 1606 nvmf_ctrlr_set_features_arbitration(struct spdk_nvmf_request *req) 1607 { 1608 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1609 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1610 1611 SPDK_DEBUGLOG(nvmf, "Set Features - Arbitration (cdw11 = 0x%0x)\n", cmd->cdw11); 1612 1613 ctrlr->feat.arbitration.raw = cmd->cdw11; 1614 ctrlr->feat.arbitration.bits.reserved = 0; 1615 1616 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1617 } 1618 1619 static int 1620 nvmf_ctrlr_set_features_power_management(struct spdk_nvmf_request *req) 1621 { 1622 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1623 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1624 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1625 1626 SPDK_DEBUGLOG(nvmf, "Set Features - Power Management (cdw11 = 0x%0x)\n", cmd->cdw11); 1627 1628 /* Only PS = 0 is allowed, since we report NPSS = 0 */ 1629 if (cmd->cdw11_bits.feat_power_management.bits.ps != 0) { 1630 SPDK_ERRLOG("Invalid power state %u\n", cmd->cdw11_bits.feat_power_management.bits.ps); 1631 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1632 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1633 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1634 } 1635 1636 ctrlr->feat.power_management.raw = cmd->cdw11; 1637 ctrlr->feat.power_management.bits.reserved = 0; 1638 1639 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1640 } 1641 1642 static bool 1643 temp_threshold_opts_valid(const union spdk_nvme_feat_temperature_threshold *opts) 1644 { 1645 /* 1646 * Valid TMPSEL values: 1647 * 0000b - 1000b: temperature sensors 1648 * 1111b: set all implemented temperature sensors 1649 */ 1650 if (opts->bits.tmpsel >= 9 && opts->bits.tmpsel != 15) { 1651 /* 1001b - 1110b: reserved */ 1652 SPDK_ERRLOG("Invalid TMPSEL %u\n", opts->bits.tmpsel); 1653 return false; 1654 } 1655 1656 /* 1657 * Valid THSEL values: 1658 * 00b: over temperature threshold 1659 * 01b: under temperature threshold 1660 */ 1661 if (opts->bits.thsel > 1) { 1662 /* 10b - 11b: reserved */ 1663 SPDK_ERRLOG("Invalid THSEL %u\n", opts->bits.thsel); 1664 return false; 1665 } 1666 1667 return true; 1668 } 1669 1670 static int 1671 nvmf_ctrlr_set_features_temperature_threshold(struct spdk_nvmf_request *req) 1672 { 1673 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1674 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1675 1676 SPDK_DEBUGLOG(nvmf, "Set Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 1677 1678 if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) { 1679 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1680 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1681 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1682 } 1683 1684 /* TODO: no sensors implemented - ignore new values */ 1685 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1686 } 1687 1688 static int 1689 nvmf_ctrlr_get_features_temperature_threshold(struct spdk_nvmf_request *req) 1690 { 1691 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1692 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1693 1694 SPDK_DEBUGLOG(nvmf, "Get Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 1695 1696 if (!temp_threshold_opts_valid(&cmd->cdw11_bits.feat_temp_threshold)) { 1697 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1698 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1699 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1700 } 1701 1702 /* TODO: no sensors implemented - return 0 for all thresholds */ 1703 rsp->cdw0 = 0; 1704 1705 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1706 } 1707 1708 static int 1709 nvmf_ctrlr_get_features_interrupt_vector_configuration(struct spdk_nvmf_request *req) 1710 { 1711 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1712 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1713 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1714 union spdk_nvme_feat_interrupt_vector_configuration iv_conf = {}; 1715 1716 SPDK_DEBUGLOG(nvmf, "Get Features - Interrupt Vector Configuration (cdw11 = 0x%0x)\n", cmd->cdw11); 1717 1718 iv_conf.bits.iv = cmd->cdw11_bits.feat_interrupt_vector_configuration.bits.iv; 1719 iv_conf.bits.cd = ctrlr->feat.interrupt_vector_configuration.bits.cd; 1720 rsp->cdw0 = iv_conf.raw; 1721 1722 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1723 } 1724 1725 static int 1726 nvmf_ctrlr_set_features_error_recovery(struct spdk_nvmf_request *req) 1727 { 1728 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1729 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1730 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1731 1732 SPDK_DEBUGLOG(nvmf, "Set Features - Error Recovery (cdw11 = 0x%0x)\n", cmd->cdw11); 1733 1734 if (cmd->cdw11_bits.feat_error_recovery.bits.dulbe) { 1735 /* 1736 * Host is not allowed to set this bit, since we don't advertise it in 1737 * Identify Namespace. 1738 */ 1739 SPDK_ERRLOG("Host set unsupported DULBE bit\n"); 1740 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1741 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1742 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1743 } 1744 1745 ctrlr->feat.error_recovery.raw = cmd->cdw11; 1746 ctrlr->feat.error_recovery.bits.reserved = 0; 1747 1748 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1749 } 1750 1751 static int 1752 nvmf_ctrlr_set_features_volatile_write_cache(struct spdk_nvmf_request *req) 1753 { 1754 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1755 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1756 1757 SPDK_DEBUGLOG(nvmf, "Set Features - Volatile Write Cache (cdw11 = 0x%0x)\n", cmd->cdw11); 1758 1759 ctrlr->feat.volatile_write_cache.raw = cmd->cdw11; 1760 ctrlr->feat.volatile_write_cache.bits.reserved = 0; 1761 1762 SPDK_DEBUGLOG(nvmf, "Set Features - Volatile Write Cache %s\n", 1763 ctrlr->feat.volatile_write_cache.bits.wce ? "Enabled" : "Disabled"); 1764 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1765 } 1766 1767 static int 1768 nvmf_ctrlr_set_features_write_atomicity(struct spdk_nvmf_request *req) 1769 { 1770 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1771 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1772 1773 SPDK_DEBUGLOG(nvmf, "Set Features - Write Atomicity (cdw11 = 0x%0x)\n", cmd->cdw11); 1774 1775 ctrlr->feat.write_atomicity.raw = cmd->cdw11; 1776 ctrlr->feat.write_atomicity.bits.reserved = 0; 1777 1778 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1779 } 1780 1781 static int 1782 nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req) 1783 { 1784 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1785 1786 SPDK_ERRLOG("Set Features - Host Identifier not allowed\n"); 1787 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1788 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1789 } 1790 1791 static int 1792 nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req) 1793 { 1794 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1795 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1796 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1797 struct spdk_iov_xfer ix; 1798 1799 SPDK_DEBUGLOG(nvmf, "Get Features - Host Identifier\n"); 1800 1801 if (!cmd->cdw11_bits.feat_host_identifier.bits.exhid) { 1802 /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */ 1803 SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n"); 1804 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1805 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1806 } 1807 1808 if (req->iovcnt < 1 || req->length < sizeof(ctrlr->hostid)) { 1809 SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n"); 1810 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1811 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1812 } 1813 1814 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 1815 spdk_iov_xfer_from_buf(&ix, &ctrlr->hostid, sizeof(ctrlr->hostid)); 1816 1817 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1818 } 1819 1820 static int 1821 nvmf_ctrlr_get_features_reservation_notification_mask(struct spdk_nvmf_request *req) 1822 { 1823 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1824 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1825 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1826 struct spdk_nvmf_ns *ns; 1827 1828 SPDK_DEBUGLOG(nvmf, "get Features - Reservation Notification Mask\n"); 1829 1830 if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) { 1831 SPDK_ERRLOG("get Features - Invalid Namespace ID\n"); 1832 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1833 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1834 } 1835 1836 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 1837 if (ns == NULL) { 1838 SPDK_ERRLOG("get Features - Invalid Namespace ID\n"); 1839 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1840 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1841 } 1842 rsp->cdw0 = ns->mask; 1843 1844 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1845 } 1846 1847 static int 1848 nvmf_ctrlr_set_features_reservation_notification_mask(struct spdk_nvmf_request *req) 1849 { 1850 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1851 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1852 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1853 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1854 struct spdk_nvmf_ns *ns; 1855 1856 SPDK_DEBUGLOG(nvmf, "Set Features - Reservation Notification Mask\n"); 1857 1858 if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) { 1859 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 1860 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 1861 ns->mask = cmd->cdw11; 1862 } 1863 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1864 } 1865 1866 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 1867 if (ns == NULL) { 1868 SPDK_ERRLOG("Set Features - Invalid Namespace ID\n"); 1869 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1870 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1871 } 1872 ns->mask = cmd->cdw11; 1873 1874 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1875 } 1876 1877 static int 1878 nvmf_ctrlr_get_features_reservation_persistence(struct spdk_nvmf_request *req) 1879 { 1880 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1881 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1882 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1883 struct spdk_nvmf_ns *ns; 1884 1885 SPDK_DEBUGLOG(nvmf, "Get Features - Reservation Persistence\n"); 1886 1887 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 1888 /* NSID with SPDK_NVME_GLOBAL_NS_TAG (=0xffffffff) also included */ 1889 if (ns == NULL) { 1890 SPDK_ERRLOG("Get Features - Invalid Namespace ID\n"); 1891 response->status.sct = SPDK_NVME_SCT_GENERIC; 1892 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1893 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1894 } 1895 1896 response->cdw0 = ns->ptpl_activated; 1897 1898 response->status.sct = SPDK_NVME_SCT_GENERIC; 1899 response->status.sc = SPDK_NVME_SC_SUCCESS; 1900 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1901 } 1902 1903 static int 1904 nvmf_ctrlr_set_features_reservation_persistence(struct spdk_nvmf_request *req) 1905 { 1906 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1907 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1908 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1909 struct spdk_nvmf_ns *ns; 1910 bool ptpl; 1911 1912 SPDK_DEBUGLOG(nvmf, "Set Features - Reservation Persistence\n"); 1913 1914 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 1915 ptpl = cmd->cdw11_bits.feat_rsv_persistence.bits.ptpl; 1916 1917 if (cmd->nsid != SPDK_NVME_GLOBAL_NS_TAG && ns && nvmf_ns_is_ptpl_capable(ns)) { 1918 ns->ptpl_activated = ptpl; 1919 } else if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) { 1920 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns; 1921 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 1922 if (nvmf_ns_is_ptpl_capable(ns)) { 1923 ns->ptpl_activated = ptpl; 1924 } 1925 } 1926 } else { 1927 SPDK_ERRLOG("Set Features - Invalid Namespace ID or Reservation Configuration\n"); 1928 response->status.sct = SPDK_NVME_SCT_GENERIC; 1929 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1930 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1931 } 1932 1933 /* TODO: Feature not changeable for now */ 1934 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1935 response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE; 1936 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1937 } 1938 1939 static int 1940 nvmf_ctrlr_get_features_host_behavior_support(struct spdk_nvmf_request *req) 1941 { 1942 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1943 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1944 struct spdk_nvme_host_behavior host_behavior = {}; 1945 struct spdk_iov_xfer ix; 1946 1947 SPDK_DEBUGLOG(nvmf, "Get Features - Host Behavior Support\n"); 1948 1949 if (req->iovcnt < 1 || req->length < sizeof(struct spdk_nvme_host_behavior)) { 1950 SPDK_ERRLOG("invalid data buffer for Host Behavior Support\n"); 1951 response->status.sct = SPDK_NVME_SCT_GENERIC; 1952 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1953 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1954 } 1955 1956 host_behavior.acre = ctrlr->acre_enabled; 1957 host_behavior.lbafee = ctrlr->lbafee_enabled; 1958 1959 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 1960 spdk_iov_xfer_from_buf(&ix, &host_behavior, sizeof(host_behavior)); 1961 1962 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1963 } 1964 1965 static int 1966 nvmf_ctrlr_set_features_host_behavior_support(struct spdk_nvmf_request *req) 1967 { 1968 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1969 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1970 struct spdk_nvme_host_behavior *host_behavior; 1971 1972 SPDK_DEBUGLOG(nvmf, "Set Features - Host Behavior Support\n"); 1973 if (req->iovcnt != 1) { 1974 SPDK_ERRLOG("Host Behavior Support invalid iovcnt: %d\n", req->iovcnt); 1975 response->status.sct = SPDK_NVME_SCT_GENERIC; 1976 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1977 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1978 } 1979 if (req->iov[0].iov_len != sizeof(struct spdk_nvme_host_behavior)) { 1980 SPDK_ERRLOG("Host Behavior Support invalid iov_len: %zd\n", req->iov[0].iov_len); 1981 response->status.sct = SPDK_NVME_SCT_GENERIC; 1982 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1983 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1984 } 1985 1986 host_behavior = (struct spdk_nvme_host_behavior *)req->iov[0].iov_base; 1987 if (host_behavior->acre == 0) { 1988 ctrlr->acre_enabled = false; 1989 } else if (host_behavior->acre == 1) { 1990 ctrlr->acre_enabled = true; 1991 } else { 1992 SPDK_ERRLOG("Host Behavior Support invalid acre: 0x%02x\n", host_behavior->acre); 1993 response->status.sct = SPDK_NVME_SCT_GENERIC; 1994 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1995 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1996 } 1997 if (host_behavior->lbafee == 0) { 1998 ctrlr->lbafee_enabled = false; 1999 } else if (host_behavior->lbafee == 1) { 2000 ctrlr->lbafee_enabled = true; 2001 } else { 2002 SPDK_ERRLOG("Host Behavior Support invalid lbafee: 0x%02x\n", host_behavior->lbafee); 2003 response->status.sct = SPDK_NVME_SCT_GENERIC; 2004 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2005 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2006 } 2007 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2008 } 2009 2010 static int 2011 nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 2012 { 2013 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2014 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2015 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2016 2017 SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 2018 2019 /* 2020 * if attempts to disable keep alive by setting kato to 0h 2021 * a status value of keep alive invalid shall be returned 2022 */ 2023 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato == 0) { 2024 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 2025 } else if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato < MIN_KEEP_ALIVE_TIMEOUT_IN_MS) { 2026 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT_IN_MS; 2027 } else { 2028 /* round up to milliseconds */ 2029 ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up( 2030 cmd->cdw11_bits.feat_keep_alive_timer.bits.kato, 2031 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) * 2032 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS; 2033 } 2034 2035 /* 2036 * if change the keep alive timeout value successfully 2037 * update the keep alive poller. 2038 */ 2039 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato != 0) { 2040 if (ctrlr->keep_alive_poller != NULL) { 2041 spdk_poller_unregister(&ctrlr->keep_alive_poller); 2042 } 2043 ctrlr->keep_alive_poller = SPDK_POLLER_REGISTER(nvmf_ctrlr_keep_alive_poll, ctrlr, 2044 ctrlr->feat.keep_alive_timer.bits.kato * 1000); 2045 } 2046 2047 SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer set to %u ms\n", 2048 ctrlr->feat.keep_alive_timer.bits.kato); 2049 2050 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2051 } 2052 2053 static int 2054 nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 2055 { 2056 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2057 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2058 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2059 uint32_t count; 2060 2061 SPDK_DEBUGLOG(nvmf, "Set Features - Number of Queues, cdw11 0x%x\n", 2062 req->cmd->nvme_cmd.cdw11); 2063 2064 if (cmd->cdw11_bits.feat_num_of_queues.bits.ncqr == UINT16_MAX || 2065 cmd->cdw11_bits.feat_num_of_queues.bits.nsqr == UINT16_MAX) { 2066 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2067 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2068 } 2069 2070 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2071 /* verify that the controller is ready to process commands */ 2072 if (count > 1) { 2073 SPDK_DEBUGLOG(nvmf, "Queue pairs already active!\n"); 2074 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2075 } else { 2076 /* 2077 * Ignore the value requested by the host - 2078 * always return the pre-configured value based on max_qpairs_allowed. 2079 */ 2080 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 2081 } 2082 2083 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2084 } 2085 2086 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ctrlr) == 4928, 2087 "Please check migration fields that need to be added or not"); 2088 2089 static void 2090 nvmf_ctrlr_migr_data_copy(struct spdk_nvmf_ctrlr_migr_data *data, 2091 const struct spdk_nvmf_ctrlr_migr_data *data_src, size_t data_size) 2092 { 2093 assert(data); 2094 assert(data_src); 2095 assert(data_size); 2096 2097 memcpy(&data->regs, &data_src->regs, spdk_min(data->regs_size, data_src->regs_size)); 2098 memcpy(&data->feat, &data_src->feat, spdk_min(data->feat_size, data_src->feat_size)); 2099 2100 #define SET_FIELD(field) \ 2101 if (offsetof(struct spdk_nvmf_ctrlr_migr_data, field) + sizeof(data->field) <= data_size) { \ 2102 data->field = data_src->field; \ 2103 } \ 2104 2105 SET_FIELD(cntlid); 2106 SET_FIELD(acre); 2107 SET_FIELD(num_aer_cids); 2108 SET_FIELD(num_async_events); 2109 SET_FIELD(notice_aen_mask); 2110 #undef SET_FIELD 2111 2112 #define SET_ARRAY(arr) \ 2113 if (offsetof(struct spdk_nvmf_ctrlr_migr_data, arr) + sizeof(data->arr) <= data_size) { \ 2114 memcpy(&data->arr, &data_src->arr, sizeof(data->arr)); \ 2115 } \ 2116 2117 SET_ARRAY(async_events); 2118 SET_ARRAY(aer_cids); 2119 #undef SET_ARRAY 2120 } 2121 2122 int 2123 spdk_nvmf_ctrlr_save_migr_data(struct spdk_nvmf_ctrlr *ctrlr, 2124 struct spdk_nvmf_ctrlr_migr_data *data) 2125 { 2126 struct spdk_nvmf_async_event_completion *event, *event_tmp; 2127 uint32_t i; 2128 struct spdk_nvmf_ctrlr_migr_data data_local = { 2129 .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused), 2130 .regs_size = sizeof(struct spdk_nvmf_registers), 2131 .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat) 2132 }; 2133 2134 assert(data->data_size <= sizeof(data_local)); 2135 assert(spdk_get_thread() == ctrlr->thread); 2136 2137 memcpy(&data_local.regs, &ctrlr->vcprop, sizeof(struct spdk_nvmf_registers)); 2138 memcpy(&data_local.feat, &ctrlr->feat, sizeof(struct spdk_nvmf_ctrlr_feat)); 2139 2140 data_local.cntlid = ctrlr->cntlid; 2141 data_local.acre = ctrlr->acre_enabled; 2142 data_local.num_aer_cids = ctrlr->nr_aer_reqs; 2143 2144 STAILQ_FOREACH_SAFE(event, &ctrlr->async_events, link, event_tmp) { 2145 if (data_local.num_async_events + 1 > SPDK_NVMF_MIGR_MAX_PENDING_AERS) { 2146 SPDK_ERRLOG("ctrlr %p has too many pending AERs\n", ctrlr); 2147 break; 2148 } 2149 2150 data_local.async_events[data_local.num_async_events++].raw = event->event.raw; 2151 } 2152 2153 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 2154 struct spdk_nvmf_request *req = ctrlr->aer_req[i]; 2155 data_local.aer_cids[i] = req->cmd->nvme_cmd.cid; 2156 } 2157 data_local.notice_aen_mask = ctrlr->notice_aen_mask; 2158 2159 nvmf_ctrlr_migr_data_copy(data, &data_local, spdk_min(data->data_size, data_local.data_size)); 2160 return 0; 2161 } 2162 2163 int 2164 spdk_nvmf_ctrlr_restore_migr_data(struct spdk_nvmf_ctrlr *ctrlr, 2165 const struct spdk_nvmf_ctrlr_migr_data *data) 2166 { 2167 uint32_t i; 2168 struct spdk_nvmf_ctrlr_migr_data data_local = { 2169 .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused), 2170 .regs_size = sizeof(struct spdk_nvmf_registers), 2171 .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat) 2172 }; 2173 2174 assert(data->data_size <= sizeof(data_local)); 2175 assert(spdk_get_thread() == ctrlr->thread); 2176 2177 /* local version of data should have defaults set before copy */ 2178 nvmf_ctrlr_migr_data_copy(&data_local, data, spdk_min(data->data_size, data_local.data_size)); 2179 memcpy(&ctrlr->vcprop, &data_local.regs, sizeof(struct spdk_nvmf_registers)); 2180 memcpy(&ctrlr->feat, &data_local.feat, sizeof(struct spdk_nvmf_ctrlr_feat)); 2181 2182 ctrlr->cntlid = data_local.cntlid; 2183 ctrlr->acre_enabled = data_local.acre; 2184 2185 for (i = 0; i < data_local.num_async_events; i++) { 2186 struct spdk_nvmf_async_event_completion *event; 2187 2188 event = calloc(1, sizeof(*event)); 2189 if (!event) { 2190 return -ENOMEM; 2191 } 2192 2193 event->event.raw = data_local.async_events[i].raw; 2194 STAILQ_INSERT_TAIL(&ctrlr->async_events, event, link); 2195 } 2196 ctrlr->notice_aen_mask = data_local.notice_aen_mask; 2197 2198 return 0; 2199 } 2200 2201 static int 2202 nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 2203 { 2204 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2205 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2206 2207 SPDK_DEBUGLOG(nvmf, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 2208 cmd->cdw11); 2209 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 2210 ctrlr->feat.async_event_configuration.bits.reserved1 = 0; 2211 ctrlr->feat.async_event_configuration.bits.reserved2 = 0; 2212 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2213 } 2214 2215 static int 2216 nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 2217 { 2218 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2219 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2220 struct spdk_nvmf_async_event_completion *pending_event; 2221 2222 SPDK_DEBUGLOG(nvmf, "Async Event Request\n"); 2223 2224 /* Four asynchronous events are supported for now */ 2225 if (ctrlr->nr_aer_reqs >= SPDK_NVMF_MAX_ASYNC_EVENTS) { 2226 SPDK_DEBUGLOG(nvmf, "AERL exceeded\n"); 2227 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 2228 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 2229 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2230 } 2231 2232 if (!STAILQ_EMPTY(&ctrlr->async_events)) { 2233 pending_event = STAILQ_FIRST(&ctrlr->async_events); 2234 rsp->cdw0 = pending_event->event.raw; 2235 STAILQ_REMOVE(&ctrlr->async_events, pending_event, spdk_nvmf_async_event_completion, link); 2236 free(pending_event); 2237 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2238 } 2239 2240 ctrlr->aer_req[ctrlr->nr_aer_reqs++] = req; 2241 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 2242 } 2243 2244 static void 2245 nvmf_get_firmware_slot_log_page(struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length) 2246 { 2247 struct spdk_nvme_firmware_page fw_page; 2248 size_t copy_len; 2249 struct spdk_iov_xfer ix; 2250 2251 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2252 2253 memset(&fw_page, 0, sizeof(fw_page)); 2254 fw_page.afi.active_slot = 1; 2255 fw_page.afi.next_reset_slot = 0; 2256 spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' '); 2257 2258 if (offset < sizeof(fw_page)) { 2259 copy_len = spdk_min(sizeof(fw_page) - offset, length); 2260 if (copy_len > 0) { 2261 spdk_iov_xfer_from_buf(&ix, (const char *)&fw_page + offset, copy_len); 2262 } 2263 } 2264 } 2265 2266 /* 2267 * Asynchronous Event Mask Bit 2268 */ 2269 enum spdk_nvme_async_event_mask_bit { 2270 /* Mask Namespace Change Notification */ 2271 SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT = 0, 2272 /* Mask Asymmetric Namespace Access Change Notification */ 2273 SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT = 1, 2274 /* Mask Discovery Log Change Notification */ 2275 SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT = 2, 2276 /* Mask Reservation Log Page Available Notification */ 2277 SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT = 3, 2278 /* Mask Error Event */ 2279 SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT = 4, 2280 /* 4 - 63 Reserved */ 2281 }; 2282 2283 static inline void 2284 nvmf_ctrlr_unmask_aen(struct spdk_nvmf_ctrlr *ctrlr, 2285 enum spdk_nvme_async_event_mask_bit mask) 2286 { 2287 ctrlr->notice_aen_mask &= ~(1 << mask); 2288 } 2289 2290 static inline bool 2291 nvmf_ctrlr_mask_aen(struct spdk_nvmf_ctrlr *ctrlr, 2292 enum spdk_nvme_async_event_mask_bit mask) 2293 { 2294 if (ctrlr->notice_aen_mask & (1 << mask)) { 2295 return false; 2296 } else { 2297 ctrlr->notice_aen_mask |= (1 << mask); 2298 return true; 2299 } 2300 } 2301 2302 /* we have to use the typedef in the function declaration to appease astyle. */ 2303 typedef enum spdk_nvme_ana_state spdk_nvme_ana_state_t; 2304 2305 static inline spdk_nvme_ana_state_t 2306 nvmf_ctrlr_get_ana_state(struct spdk_nvmf_ctrlr *ctrlr, uint32_t anagrpid) 2307 { 2308 if (!ctrlr->subsys->flags.ana_reporting) { 2309 return SPDK_NVME_ANA_OPTIMIZED_STATE; 2310 } 2311 2312 if (spdk_unlikely(ctrlr->listener == NULL)) { 2313 return SPDK_NVME_ANA_INACCESSIBLE_STATE; 2314 } 2315 2316 assert(anagrpid - 1 < ctrlr->subsys->max_nsid); 2317 return ctrlr->listener->ana_state[anagrpid - 1]; 2318 } 2319 2320 static spdk_nvme_ana_state_t 2321 nvmf_ctrlr_get_ana_state_from_nsid(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 2322 { 2323 struct spdk_nvmf_ns *ns; 2324 2325 /* We do not have NVM subsystem specific ANA state. Hence if NSID is either 2326 * SPDK_NVMF_GLOBAL_NS_TAG, invalid, or for inactive namespace, return 2327 * the optimized state. 2328 */ 2329 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 2330 if (ns == NULL) { 2331 return SPDK_NVME_ANA_OPTIMIZED_STATE; 2332 } 2333 2334 return nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 2335 } 2336 2337 static void 2338 nvmf_get_error_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2339 uint64_t offset, uint32_t length, uint32_t rae) 2340 { 2341 if (!rae) { 2342 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT); 2343 } 2344 2345 /* TODO: actually fill out log page data */ 2346 } 2347 2348 static void 2349 nvmf_get_ana_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2350 uint64_t offset, uint32_t length, uint32_t rae, uint32_t rgo) 2351 { 2352 struct spdk_nvme_ana_page ana_hdr; 2353 struct spdk_nvme_ana_group_descriptor ana_desc; 2354 size_t copy_len, copied_len; 2355 uint32_t num_anagrp = 0, anagrpid; 2356 struct spdk_nvmf_ns *ns; 2357 struct spdk_iov_xfer ix; 2358 2359 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2360 2361 if (length == 0) { 2362 goto done; 2363 } 2364 2365 if (offset >= sizeof(ana_hdr)) { 2366 offset -= sizeof(ana_hdr); 2367 } else { 2368 for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) { 2369 if (ctrlr->subsys->ana_group[anagrpid - 1] > 0) { 2370 num_anagrp++; 2371 } 2372 } 2373 2374 memset(&ana_hdr, 0, sizeof(ana_hdr)); 2375 2376 ana_hdr.num_ana_group_desc = num_anagrp; 2377 /* TODO: Support Change Count. */ 2378 ana_hdr.change_count = 0; 2379 2380 copy_len = spdk_min(sizeof(ana_hdr) - offset, length); 2381 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_hdr + offset, copy_len); 2382 assert(copied_len == copy_len); 2383 length -= copied_len; 2384 offset = 0; 2385 } 2386 2387 if (length == 0) { 2388 goto done; 2389 } 2390 2391 for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) { 2392 if (ctrlr->subsys->ana_group[anagrpid - 1] == 0) { 2393 continue; 2394 } 2395 2396 if (offset >= sizeof(ana_desc)) { 2397 offset -= sizeof(ana_desc); 2398 } else { 2399 memset(&ana_desc, 0, sizeof(ana_desc)); 2400 2401 ana_desc.ana_group_id = anagrpid; 2402 if (rgo) { 2403 ana_desc.num_of_nsid = 0; 2404 } else { 2405 ana_desc.num_of_nsid = ctrlr->subsys->ana_group[anagrpid - 1]; 2406 } 2407 ana_desc.ana_state = nvmf_ctrlr_get_ana_state(ctrlr, anagrpid); 2408 2409 copy_len = spdk_min(sizeof(ana_desc) - offset, length); 2410 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_desc + offset, 2411 copy_len); 2412 assert(copied_len == copy_len); 2413 length -= copied_len; 2414 offset = 0; 2415 2416 if (length == 0) { 2417 goto done; 2418 } 2419 } 2420 2421 if (rgo) { 2422 continue; 2423 } 2424 2425 /* TODO: Revisit here about O(n^2) cost if we have subsystem with 2426 * many namespaces in the future. 2427 */ 2428 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL; 2429 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 2430 if (ns->anagrpid != anagrpid) { 2431 continue; 2432 } 2433 2434 if (offset >= sizeof(uint32_t)) { 2435 offset -= sizeof(uint32_t); 2436 continue; 2437 } 2438 2439 copy_len = spdk_min(sizeof(uint32_t) - offset, length); 2440 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ns->nsid + offset, 2441 copy_len); 2442 assert(copied_len == copy_len); 2443 length -= copied_len; 2444 offset = 0; 2445 2446 if (length == 0) { 2447 goto done; 2448 } 2449 } 2450 } 2451 2452 done: 2453 if (!rae) { 2454 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT); 2455 } 2456 } 2457 2458 void 2459 nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 2460 { 2461 uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list); 2462 uint16_t i; 2463 bool found = false; 2464 2465 for (i = 0; i < ctrlr->changed_ns_list_count; i++) { 2466 if (ctrlr->changed_ns_list.ns_list[i] == nsid) { 2467 /* nsid is already in the list */ 2468 found = true; 2469 break; 2470 } 2471 } 2472 2473 if (!found) { 2474 if (ctrlr->changed_ns_list_count == max_changes) { 2475 /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */ 2476 ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu; 2477 for (i = 1; i < max_changes; i++) { 2478 ctrlr->changed_ns_list.ns_list[i] = 0; 2479 } 2480 } else { 2481 ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid; 2482 } 2483 } 2484 } 2485 2486 static void 2487 nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr, 2488 struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae) 2489 { 2490 size_t copy_length; 2491 struct spdk_iov_xfer ix; 2492 2493 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2494 2495 if (offset < sizeof(ctrlr->changed_ns_list)) { 2496 copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset); 2497 if (copy_length) { 2498 spdk_iov_xfer_from_buf(&ix, (char *)&ctrlr->changed_ns_list + offset, copy_length); 2499 } 2500 } 2501 2502 /* Clear log page each time it is read */ 2503 ctrlr->changed_ns_list_count = 0; 2504 memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list)); 2505 2506 if (!rae) { 2507 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT); 2508 } 2509 } 2510 2511 /* The structure can be modified if we provide support for other commands in future */ 2512 static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = { 2513 .admin_cmds_supported = { 2514 /* CSUPP, LBCC, NCC, NIC, CCC, CSE */ 2515 /* Get Log Page */ 2516 [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2517 /* Identify */ 2518 [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0}, 2519 /* Abort */ 2520 [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0}, 2521 /* Set Features */ 2522 [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 2523 /* Get Features */ 2524 [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 2525 /* Async Event Request */ 2526 [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0}, 2527 /* Keep Alive */ 2528 [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2529 }, 2530 .io_cmds_supported = { 2531 /* FLUSH */ 2532 [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0}, 2533 /* WRITE */ 2534 [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0}, 2535 /* READ */ 2536 [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0}, 2537 /* WRITE ZEROES */ 2538 [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0}, 2539 /* DATASET MANAGEMENT */ 2540 [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0}, 2541 /* COMPARE */ 2542 [SPDK_NVME_OPC_COMPARE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2543 /* ZONE MANAGEMENT SEND */ 2544 [SPDK_NVME_OPC_ZONE_MGMT_SEND] = {1, 1, 0, 0, 0, 0, 0, 0}, 2545 /* ZONE MANAGEMENT RECEIVE */ 2546 [SPDK_NVME_OPC_ZONE_MGMT_RECV] = {1, 0, 0, 0, 0, 0, 0, 0}, 2547 /* ZONE APPEND */ 2548 [SPDK_NVME_OPC_ZONE_APPEND] = {1, 1, 0, 0, 0, 0, 0, 0}, 2549 /* COPY */ 2550 [SPDK_NVME_OPC_COPY] = {1, 1, 0, 0, 0, 0, 0, 0}, 2551 }, 2552 }; 2553 2554 static void 2555 nvmf_get_cmds_and_effects_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2556 uint64_t offset, uint32_t length) 2557 { 2558 uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page); 2559 size_t copy_len = 0; 2560 struct spdk_nvme_cmds_and_effect_log_page cmds_and_effect_log_page = g_cmds_and_effect_log_page; 2561 struct spdk_nvme_cmds_and_effect_entry zero = {}; 2562 struct spdk_iov_xfer ix; 2563 2564 if (!ctrlr->cdata.oncs.write_zeroes || !nvmf_ctrlr_write_zeroes_supported(ctrlr)) { 2565 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_WRITE_ZEROES] = zero; 2566 } 2567 if (!ctrlr->cdata.oncs.dsm || !nvmf_ctrlr_dsm_supported(ctrlr)) { 2568 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_DATASET_MANAGEMENT] = zero; 2569 } 2570 if (!ctrlr->cdata.oncs.compare) { 2571 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COMPARE] = zero; 2572 } 2573 if (!nvmf_subsystem_has_zns_iocs(ctrlr->subsys)) { 2574 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_SEND] = zero; 2575 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_RECV] = zero; 2576 } 2577 if (!nvmf_subsystem_zone_append_supported(ctrlr->subsys)) { 2578 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_APPEND] = zero; 2579 } 2580 if (!ctrlr->cdata.oncs.copy) { 2581 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COPY] = zero; 2582 } 2583 2584 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2585 if (offset < page_size) { 2586 copy_len = spdk_min(page_size - offset, length); 2587 spdk_iov_xfer_from_buf(&ix, (char *)(&cmds_and_effect_log_page) + offset, copy_len); 2588 } 2589 } 2590 2591 static void 2592 nvmf_get_reservation_notification_log_page(struct spdk_nvmf_ctrlr *ctrlr, 2593 struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae) 2594 { 2595 uint32_t unit_log_len, avail_log_len, next_pos, copy_len; 2596 struct spdk_nvmf_reservation_log *log, *log_tmp; 2597 struct spdk_iov_xfer ix; 2598 2599 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2600 2601 unit_log_len = sizeof(struct spdk_nvme_reservation_notification_log); 2602 /* No available log, return zeroed log pages */ 2603 if (!ctrlr->num_avail_log_pages) { 2604 return; 2605 } 2606 2607 avail_log_len = ctrlr->num_avail_log_pages * unit_log_len; 2608 if (offset >= avail_log_len) { 2609 return; 2610 } 2611 2612 next_pos = 0; 2613 TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) { 2614 TAILQ_REMOVE(&ctrlr->log_head, log, link); 2615 ctrlr->num_avail_log_pages--; 2616 2617 next_pos += unit_log_len; 2618 if (next_pos > offset) { 2619 copy_len = spdk_min(next_pos - offset, length); 2620 spdk_iov_xfer_from_buf(&ix, &log->log, copy_len); 2621 length -= copy_len; 2622 offset += copy_len; 2623 } 2624 free(log); 2625 2626 if (length == 0) { 2627 break; 2628 } 2629 } 2630 2631 if (!rae) { 2632 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT); 2633 } 2634 return; 2635 } 2636 2637 static int 2638 nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 2639 { 2640 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2641 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2642 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2643 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2644 struct spdk_nvme_transport_id cmd_source_trid; 2645 uint64_t offset, len; 2646 uint32_t rae, numdl, numdu; 2647 uint8_t lid; 2648 2649 if (req->iovcnt < 1) { 2650 SPDK_DEBUGLOG(nvmf, "get log command with no buffer\n"); 2651 response->status.sct = SPDK_NVME_SCT_GENERIC; 2652 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2653 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2654 } 2655 2656 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 2657 if (offset & 3) { 2658 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 2659 response->status.sct = SPDK_NVME_SCT_GENERIC; 2660 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2661 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2662 } 2663 2664 rae = cmd->cdw10_bits.get_log_page.rae; 2665 numdl = cmd->cdw10_bits.get_log_page.numdl; 2666 numdu = cmd->cdw11_bits.get_log_page.numdu; 2667 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 2668 if (len > req->length) { 2669 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 2670 len, req->length); 2671 response->status.sct = SPDK_NVME_SCT_GENERIC; 2672 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2673 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2674 } 2675 2676 lid = cmd->cdw10_bits.get_log_page.lid; 2677 SPDK_DEBUGLOG(nvmf, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 " rae=%u\n", 2678 lid, offset, len, rae); 2679 2680 if (spdk_nvmf_subsystem_is_discovery(subsystem)) { 2681 switch (lid) { 2682 case SPDK_NVME_LOG_DISCOVERY: 2683 if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &cmd_source_trid)) { 2684 SPDK_ERRLOG("Failed to get LOG_DISCOVERY source trid\n"); 2685 response->status.sct = SPDK_NVME_SCT_GENERIC; 2686 response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 2687 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2688 } 2689 nvmf_get_discovery_log_page(subsystem->tgt, ctrlr->hostnqn, req->iov, req->iovcnt, 2690 offset, len, &cmd_source_trid); 2691 if (!rae) { 2692 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT); 2693 } 2694 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2695 default: 2696 goto invalid_log_page; 2697 } 2698 } else { 2699 if (offset > len) { 2700 SPDK_ERRLOG("Get log page: offset (%" PRIu64 ") > len (%" PRIu64 ")\n", 2701 offset, len); 2702 response->status.sct = SPDK_NVME_SCT_GENERIC; 2703 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2704 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2705 } 2706 2707 switch (lid) { 2708 case SPDK_NVME_LOG_ERROR: 2709 nvmf_get_error_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2710 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2711 case SPDK_NVME_LOG_HEALTH_INFORMATION: 2712 /* TODO: actually fill out log page data */ 2713 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2714 case SPDK_NVME_LOG_FIRMWARE_SLOT: 2715 nvmf_get_firmware_slot_log_page(req->iov, req->iovcnt, offset, len); 2716 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2717 case SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS: 2718 if (subsystem->flags.ana_reporting) { 2719 uint32_t rgo = cmd->cdw10_bits.get_log_page.lsp & 1; 2720 nvmf_get_ana_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae, rgo); 2721 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2722 } else { 2723 goto invalid_log_page; 2724 } 2725 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 2726 nvmf_get_cmds_and_effects_log_page(ctrlr, req->iov, req->iovcnt, offset, len); 2727 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2728 case SPDK_NVME_LOG_CHANGED_NS_LIST: 2729 nvmf_get_changed_ns_list_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2730 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2731 case SPDK_NVME_LOG_RESERVATION_NOTIFICATION: 2732 nvmf_get_reservation_notification_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2733 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2734 default: 2735 goto invalid_log_page; 2736 } 2737 } 2738 2739 invalid_log_page: 2740 SPDK_INFOLOG(nvmf, "Unsupported Get Log Page 0x%02X\n", lid); 2741 response->status.sct = SPDK_NVME_SCT_GENERIC; 2742 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2743 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2744 } 2745 2746 static struct spdk_nvmf_ns * 2747 _nvmf_ctrlr_get_ns_safe(struct spdk_nvmf_ctrlr *ctrlr, 2748 uint32_t nsid, 2749 struct spdk_nvme_cpl *rsp) 2750 { 2751 struct spdk_nvmf_ns *ns; 2752 if (nsid == 0 || nsid > ctrlr->subsys->max_nsid) { 2753 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", nsid); 2754 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2755 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 2756 return NULL; 2757 } 2758 2759 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 2760 if (ns == NULL || ns->bdev == NULL) { 2761 /* 2762 * Inactive namespaces should return a zero filled data structure. 2763 * The data buffer is already zeroed by nvmf_ctrlr_process_admin_cmd(), 2764 * so we can just return early here. 2765 */ 2766 SPDK_DEBUGLOG(nvmf, "Identify Namespace for inactive NSID %u\n", nsid); 2767 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2768 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 2769 return NULL; 2770 } 2771 return ns; 2772 } 2773 2774 static void 2775 nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr, 2776 struct spdk_nvme_cmd *cmd, 2777 struct spdk_nvme_cpl *rsp, 2778 struct spdk_nvme_ns_data *nsdata, 2779 uint32_t nsid) 2780 { 2781 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2782 struct spdk_nvmf_ns *ns; 2783 uint32_t max_num_blocks, format_index; 2784 enum spdk_nvme_ana_state ana_state; 2785 2786 ns = _nvmf_ctrlr_get_ns_safe(ctrlr, nsid, rsp); 2787 if (ns == NULL) { 2788 return; 2789 } 2790 2791 nvmf_bdev_ctrlr_identify_ns(ns, nsdata, ctrlr->dif_insert_or_strip); 2792 2793 assert(ctrlr->admin_qpair); 2794 2795 format_index = spdk_nvme_ns_get_format_index(nsdata); 2796 2797 /* Due to bug in the Linux kernel NVMe driver we have to set noiob no larger than mdts */ 2798 max_num_blocks = ctrlr->admin_qpair->transport->opts.max_io_size / 2799 (1U << nsdata->lbaf[format_index].lbads); 2800 if (nsdata->noiob > max_num_blocks) { 2801 nsdata->noiob = max_num_blocks; 2802 } 2803 2804 /* Set NOWS equal to Controller MDTS */ 2805 if (nsdata->nsfeat.optperf) { 2806 nsdata->nows = max_num_blocks - 1; 2807 } 2808 2809 if (subsystem->flags.ana_reporting) { 2810 assert(ns->anagrpid - 1 < subsystem->max_nsid); 2811 nsdata->anagrpid = ns->anagrpid; 2812 2813 ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 2814 if (ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE || 2815 ana_state == SPDK_NVME_ANA_PERSISTENT_LOSS_STATE) { 2816 nsdata->nuse = 0; 2817 } 2818 } 2819 } 2820 2821 int 2822 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr, 2823 struct spdk_nvme_cmd *cmd, 2824 struct spdk_nvme_cpl *rsp, 2825 struct spdk_nvme_ns_data *nsdata) 2826 { 2827 nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, nsdata, cmd->nsid); 2828 2829 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2830 } 2831 2832 static void 2833 identify_ns_passthru_cb(struct spdk_nvmf_request *req) 2834 { 2835 struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req); 2836 struct spdk_nvmf_ctrlr *ctrlr = spdk_nvmf_request_get_ctrlr(req); 2837 struct spdk_nvme_cpl *rsp = spdk_nvmf_request_get_response(req); 2838 struct spdk_nvme_ns_data nvmf_nsdata = {}; 2839 struct spdk_nvme_ns_data nvme_nsdata = {}; 2840 size_t datalen; 2841 2842 /* This is the identify data from the NVMe drive */ 2843 datalen = spdk_nvmf_request_copy_to_buf(req, &nvme_nsdata, 2844 sizeof(nvme_nsdata)); 2845 nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, &nvmf_nsdata, req->orig_nsid); 2846 2847 /* Update fabric's namespace according to SSD's namespace */ 2848 if (nvme_nsdata.nsfeat.optperf) { 2849 nvmf_nsdata.nsfeat.optperf = nvme_nsdata.nsfeat.optperf; 2850 nvmf_nsdata.npwg = nvme_nsdata.npwg; 2851 nvmf_nsdata.npwa = nvme_nsdata.npwa; 2852 nvmf_nsdata.npdg = nvme_nsdata.npdg; 2853 nvmf_nsdata.npda = nvme_nsdata.npda; 2854 nvmf_nsdata.nows = nvme_nsdata.nows; 2855 } 2856 2857 if (nvme_nsdata.nsfeat.ns_atomic_write_unit) { 2858 nvmf_nsdata.nsfeat.ns_atomic_write_unit = nvme_nsdata.nsfeat.ns_atomic_write_unit; 2859 nvmf_nsdata.nawun = nvme_nsdata.nawun; 2860 nvmf_nsdata.nawupf = nvme_nsdata.nawupf; 2861 nvmf_nsdata.nacwu = nvme_nsdata.nacwu; 2862 } 2863 2864 nvmf_nsdata.nabsn = nvme_nsdata.nabsn; 2865 nvmf_nsdata.nabo = nvme_nsdata.nabo; 2866 nvmf_nsdata.nabspf = nvme_nsdata.nabspf; 2867 2868 spdk_nvmf_request_copy_from_buf(req, &nvmf_nsdata, datalen); 2869 } 2870 2871 int 2872 spdk_nvmf_ctrlr_identify_ns_ext(struct spdk_nvmf_request *req) 2873 { 2874 struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req); 2875 struct spdk_nvmf_ctrlr *ctrlr = spdk_nvmf_request_get_ctrlr(req); 2876 struct spdk_nvmf_ns *ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 2877 struct spdk_nvme_cpl *rsp = spdk_nvmf_request_get_response(req); 2878 struct spdk_bdev *bdev; 2879 struct spdk_bdev_desc *desc; 2880 struct spdk_io_channel *ch; 2881 struct spdk_nvme_ns_data nsdata = {}; 2882 struct spdk_iov_xfer ix; 2883 int rc; 2884 2885 nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, &nsdata, cmd->nsid); 2886 2887 rc = spdk_nvmf_request_get_bdev(cmd->nsid, req, &bdev, &desc, &ch); 2888 if (rc) { 2889 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2890 } 2891 2892 if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_NVME_ADMIN)) { 2893 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 2894 spdk_iov_xfer_from_buf(&ix, &nsdata, sizeof(nsdata)); 2895 2896 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2897 } 2898 2899 assert(ns->passthru_nsid != 0); 2900 req->orig_nsid = ns->nsid; 2901 cmd->nsid = ns->passthru_nsid; 2902 2903 return spdk_nvmf_bdev_ctrlr_nvme_passthru_admin(bdev, desc, ch, req, identify_ns_passthru_cb); 2904 } 2905 2906 static void 2907 nvmf_ctrlr_populate_oacs(struct spdk_nvmf_ctrlr *ctrlr, 2908 struct spdk_nvme_ctrlr_data *cdata) 2909 { 2910 cdata->oacs = ctrlr->cdata.oacs; 2911 2912 cdata->oacs.virtualization_management = 2913 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT].hdlr != NULL; 2914 cdata->oacs.nvme_mi = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_SEND].hdlr != NULL 2915 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_RECEIVE].hdlr != NULL; 2916 cdata->oacs.directives = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_SEND].hdlr != NULL 2917 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_RECEIVE].hdlr != NULL; 2918 cdata->oacs.device_self_test = 2919 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DEVICE_SELF_TEST].hdlr != NULL; 2920 cdata->oacs.ns_manage = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_MANAGEMENT].hdlr != NULL 2921 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_ATTACHMENT].hdlr != NULL; 2922 cdata->oacs.firmware = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD].hdlr != 2923 NULL 2924 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_COMMIT].hdlr != NULL; 2925 cdata->oacs.format = 2926 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FORMAT_NVM].hdlr != NULL; 2927 cdata->oacs.security = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_SEND].hdlr != NULL 2928 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_RECEIVE].hdlr != NULL; 2929 cdata->oacs.get_lba_status = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_GET_LBA_STATUS].hdlr != 2930 NULL; 2931 } 2932 2933 int 2934 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 2935 { 2936 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2937 struct spdk_nvmf_transport *transport; 2938 2939 /* 2940 * Common fields for discovery and NVM subsystems 2941 */ 2942 assert(ctrlr->admin_qpair); 2943 transport = ctrlr->admin_qpair->transport; 2944 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 2945 assert((transport->opts.max_io_size % 4096) == 0); 2946 cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096); 2947 cdata->cntlid = ctrlr->cntlid; 2948 cdata->ver = ctrlr->vcprop.vs; 2949 cdata->aerl = ctrlr->cdata.aerl; 2950 cdata->lpa.edlp = 1; 2951 cdata->elpe = 127; 2952 cdata->maxcmd = transport->opts.max_queue_depth; 2953 cdata->sgls = ctrlr->cdata.sgls; 2954 cdata->fuses = ctrlr->cdata.fuses; 2955 cdata->acwu = 0; /* ACWU is 0-based. */ 2956 if (subsystem->flags.ana_reporting) { 2957 cdata->mnan = subsystem->max_nsid; 2958 } 2959 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 2960 2961 SPDK_DEBUGLOG(nvmf, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 2962 SPDK_DEBUGLOG(nvmf, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 2963 2964 2965 if (spdk_nvmf_subsystem_is_discovery(subsystem)) { 2966 /* 2967 * NVM Discovery subsystem fields 2968 */ 2969 cdata->oaes.discovery_log_change_notices = 1; 2970 cdata->cntrltype = SPDK_NVME_CTRLR_DISCOVERY; 2971 } else { 2972 cdata->vid = ctrlr->cdata.vid; 2973 cdata->ssvid = ctrlr->cdata.ssvid; 2974 cdata->ieee[0] = ctrlr->cdata.ieee[0]; 2975 cdata->ieee[1] = ctrlr->cdata.ieee[1]; 2976 cdata->ieee[2] = ctrlr->cdata.ieee[2]; 2977 2978 /* 2979 * NVM subsystem fields (reserved for discovery subsystems) 2980 */ 2981 spdk_strcpy_pad(cdata->mn, spdk_nvmf_subsystem_get_mn(subsystem), sizeof(cdata->mn), ' '); 2982 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 2983 cdata->kas = ctrlr->cdata.kas; 2984 2985 cdata->rab = 6; 2986 cdata->cmic.multi_port = 1; 2987 cdata->cmic.multi_ctrlr = 1; 2988 cdata->oaes.ns_attribute_notices = 1; 2989 cdata->ctratt.bits.host_id_exhid_supported = 1; 2990 cdata->ctratt.bits.fdps = ctrlr->subsys->fdp_supported; 2991 cdata->cntrltype = SPDK_NVME_CTRLR_IO; 2992 /* We do not have any actual limitation to the number of abort commands. 2993 * We follow the recommendation by the NVMe specification. 2994 */ 2995 cdata->acl = NVMF_ABORT_COMMAND_LIMIT; 2996 cdata->frmw.slot1_ro = 1; 2997 cdata->frmw.num_slots = 1; 2998 2999 cdata->lpa.celp = 1; /* Command Effects log page supported */ 3000 3001 cdata->sqes.min = 6; 3002 cdata->sqes.max = 6; 3003 cdata->cqes.min = 4; 3004 cdata->cqes.max = 4; 3005 cdata->nn = subsystem->max_nsid; 3006 cdata->vwc.present = 1; 3007 cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED; 3008 3009 cdata->nvmf_specific = ctrlr->cdata.nvmf_specific; 3010 3011 cdata->oncs.compare = ctrlr->cdata.oncs.compare; 3012 cdata->oncs.dsm = ctrlr->cdata.oncs.dsm && nvmf_ctrlr_dsm_supported(ctrlr); 3013 cdata->oncs.write_zeroes = ctrlr->cdata.oncs.write_zeroes && 3014 nvmf_ctrlr_write_zeroes_supported(ctrlr); 3015 cdata->oncs.reservations = ctrlr->cdata.oncs.reservations; 3016 cdata->oncs.copy = ctrlr->cdata.oncs.copy; 3017 cdata->ocfs.copy_format0 = cdata->oncs.copy; 3018 if (subsystem->flags.ana_reporting) { 3019 /* Asymmetric Namespace Access Reporting is supported. */ 3020 cdata->cmic.ana_reporting = 1; 3021 cdata->oaes.ana_change_notices = 1; 3022 3023 cdata->anatt = ANA_TRANSITION_TIME_IN_SEC; 3024 /* ANA Change state is not used, and ANA Persistent Loss state 3025 * is not supported for now. 3026 */ 3027 cdata->anacap.ana_optimized_state = 1; 3028 cdata->anacap.ana_non_optimized_state = 1; 3029 cdata->anacap.ana_inaccessible_state = 1; 3030 /* ANAGRPID does not change while namespace is attached to controller */ 3031 cdata->anacap.no_change_anagrpid = 1; 3032 cdata->anagrpmax = subsystem->max_nsid; 3033 cdata->nanagrpid = subsystem->max_nsid; 3034 } 3035 3036 nvmf_ctrlr_populate_oacs(ctrlr, cdata); 3037 3038 assert(subsystem->tgt != NULL); 3039 cdata->crdt[0] = subsystem->tgt->crdt[0]; 3040 cdata->crdt[1] = subsystem->tgt->crdt[1]; 3041 cdata->crdt[2] = subsystem->tgt->crdt[2]; 3042 3043 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ioccsz 0x%x\n", 3044 cdata->nvmf_specific.ioccsz); 3045 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: iorcsz 0x%x\n", 3046 cdata->nvmf_specific.iorcsz); 3047 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: icdoff 0x%x\n", 3048 cdata->nvmf_specific.icdoff); 3049 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ctrattr 0x%x\n", 3050 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 3051 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: msdbd 0x%x\n", 3052 cdata->nvmf_specific.msdbd); 3053 } 3054 3055 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3056 } 3057 3058 static int 3059 nvmf_ns_identify_iocs_zns(struct spdk_nvmf_ns *ns, 3060 struct spdk_nvme_cmd *cmd, 3061 struct spdk_nvme_cpl *rsp, 3062 struct spdk_nvme_zns_ns_data *nsdata_zns) 3063 { 3064 nsdata_zns->zoc.variable_zone_capacity = 0; 3065 nsdata_zns->zoc.zone_active_excursions = 0; 3066 nsdata_zns->ozcs.read_across_zone_boundaries = 1; 3067 /* Underflowing the zero based mar and mor bdev helper results in the correct 3068 value of FFFFFFFFh. */ 3069 nsdata_zns->mar = spdk_bdev_get_max_active_zones(ns->bdev) - 1; 3070 nsdata_zns->mor = spdk_bdev_get_max_open_zones(ns->bdev) - 1; 3071 nsdata_zns->rrl = 0; 3072 nsdata_zns->frl = 0; 3073 nsdata_zns->lbafe[0].zsze = spdk_bdev_get_zone_size(ns->bdev); 3074 3075 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3076 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3077 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3078 } 3079 3080 static int 3081 nvmf_ns_identify_iocs_nvm(struct spdk_nvmf_ns *ns, 3082 struct spdk_nvme_cpl *rsp, 3083 struct spdk_nvme_nvm_ns_data *nsdata_nvm) 3084 { 3085 nvmf_bdev_ctrlr_identify_iocs_nvm(ns, nsdata_nvm); 3086 3087 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3088 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3089 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3090 } 3091 3092 int 3093 spdk_nvmf_ns_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr, 3094 struct spdk_nvme_cmd *cmd, 3095 struct spdk_nvme_cpl *rsp, 3096 void *nsdata, 3097 size_t nsdata_size) 3098 { 3099 uint8_t csi = cmd->cdw11_bits.identify.csi; 3100 struct spdk_nvmf_ns *ns = _nvmf_ctrlr_get_ns_safe(ctrlr, cmd->nsid, rsp); 3101 3102 memset(nsdata, 0, nsdata_size); 3103 3104 if (ns == NULL) { 3105 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3106 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 3107 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3108 } 3109 3110 switch (csi) { 3111 case SPDK_NVME_CSI_ZNS: 3112 return nvmf_ns_identify_iocs_zns(ns, cmd, rsp, nsdata); 3113 case SPDK_NVME_CSI_NVM: 3114 if (!ctrlr->dif_insert_or_strip) { 3115 return nvmf_ns_identify_iocs_nvm(ns, rsp, nsdata); 3116 } 3117 break; 3118 default: 3119 break; 3120 } 3121 3122 SPDK_DEBUGLOG(nvmf, 3123 "Returning zero filled struct for the iocs specific ns " 3124 "identify command and CSI 0x%02x\n", 3125 csi); 3126 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3127 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3128 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3129 } 3130 3131 static int 3132 nvmf_ctrlr_identify_iocs_nvm(struct spdk_nvmf_ctrlr *ctrlr, 3133 struct spdk_nvme_cmd *cmd, 3134 struct spdk_nvme_cpl *rsp, 3135 struct spdk_nvme_nvm_ctrlr_data *cdata_nvm) 3136 { 3137 /* The unit of max_write_zeroes_size_kib is KiB. 3138 * The unit of wzsl is the minimum memory page size(2 ^ (12 + CAP.MPSMIN) bytes) 3139 * and is reported as a power of two (2^n). 3140 */ 3141 cdata_nvm->wzsl = spdk_u64log2(ctrlr->subsys->max_write_zeroes_size_kib >> 3142 (2 + ctrlr->vcprop.cap.bits.mpsmin)); 3143 3144 /* The unit of max_discard_size_kib is KiB. 3145 * The dmrsl indicates the maximum number of logical blocks for 3146 * dataset management command. 3147 */ 3148 cdata_nvm->dmrsl = ctrlr->subsys->max_discard_size_kib << 1; 3149 cdata_nvm->dmrl = 1; 3150 3151 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3152 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3153 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3154 } 3155 3156 static int 3157 nvmf_ctrlr_identify_iocs_zns(struct spdk_nvmf_ctrlr *ctrlr, 3158 struct spdk_nvme_cmd *cmd, 3159 struct spdk_nvme_cpl *rsp, 3160 struct spdk_nvme_zns_ctrlr_data *cdata_zns) 3161 { 3162 /* The unit of max_zone_append_size_kib is KiB. 3163 The unit of zasl is the minimum memory page size 3164 (2 ^ (12 + CAP.MPSMIN) KiB) 3165 and is reported as a power of two (2^n). */ 3166 cdata_zns->zasl = spdk_u64log2(ctrlr->subsys->max_zone_append_size_kib >> 3167 (12 + ctrlr->vcprop.cap.bits.mpsmin)); 3168 3169 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3170 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3171 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3172 } 3173 3174 int 3175 spdk_nvmf_ctrlr_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr, 3176 struct spdk_nvme_cmd *cmd, 3177 struct spdk_nvme_cpl *rsp, 3178 void *cdata, 3179 size_t cdata_size) 3180 { 3181 uint8_t csi = cmd->cdw11_bits.identify.csi; 3182 3183 memset(cdata, 0, cdata_size); 3184 3185 switch (csi) { 3186 case SPDK_NVME_CSI_NVM: 3187 return nvmf_ctrlr_identify_iocs_nvm(ctrlr, cmd, rsp, cdata); 3188 case SPDK_NVME_CSI_ZNS: 3189 return nvmf_ctrlr_identify_iocs_zns(ctrlr, cmd, rsp, cdata); 3190 default: 3191 break; 3192 } 3193 3194 SPDK_DEBUGLOG(nvmf, 3195 "Returning zero filled struct for the iocs specific ctrlr " 3196 "identify command and CSI 0x%02x\n", 3197 csi); 3198 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3199 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3200 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3201 } 3202 3203 static int 3204 nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_ctrlr *ctrlr, 3205 struct spdk_nvme_cmd *cmd, 3206 struct spdk_nvme_cpl *rsp, 3207 struct spdk_nvme_ns_list *ns_list) 3208 { 3209 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 3210 struct spdk_nvmf_ns *ns; 3211 uint32_t count = 0; 3212 3213 if (cmd->nsid >= 0xfffffffeUL) { 3214 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 3215 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 3216 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3217 } 3218 3219 memset(ns_list, 0, sizeof(*ns_list)); 3220 3221 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 3222 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 3223 if (ns->opts.nsid <= cmd->nsid || !nvmf_ctrlr_ns_is_visible(ctrlr, ns->opts.nsid)) { 3224 continue; 3225 } 3226 3227 ns_list->ns_list[count++] = ns->opts.nsid; 3228 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 3229 break; 3230 } 3231 } 3232 3233 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3234 } 3235 3236 static void 3237 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 3238 enum spdk_nvme_nidt type, 3239 const void *data, size_t data_size) 3240 { 3241 struct spdk_nvme_ns_id_desc *desc; 3242 size_t desc_size = sizeof(*desc) + data_size; 3243 3244 /* 3245 * These should never fail in practice, since all valid NS ID descriptors 3246 * should be defined so that they fit in the available 4096-byte buffer. 3247 */ 3248 assert(data_size > 0); 3249 assert(data_size <= UINT8_MAX); 3250 assert(desc_size < *buf_remain); 3251 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 3252 return; 3253 } 3254 3255 desc = *buf_ptr; 3256 desc->nidt = type; 3257 desc->nidl = data_size; 3258 memcpy(desc->nid, data, data_size); 3259 3260 *buf_ptr += desc_size; 3261 *buf_remain -= desc_size; 3262 } 3263 3264 static int 3265 nvmf_ctrlr_identify_ns_id_descriptor_list( 3266 struct spdk_nvmf_ctrlr *ctrlr, 3267 struct spdk_nvme_cmd *cmd, 3268 struct spdk_nvme_cpl *rsp, 3269 void *id_desc_list, size_t id_desc_list_size) 3270 { 3271 struct spdk_nvmf_ns *ns; 3272 size_t buf_remain = id_desc_list_size; 3273 void *buf_ptr = id_desc_list; 3274 3275 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 3276 if (ns == NULL || ns->bdev == NULL) { 3277 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3278 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 3279 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3280 } 3281 3282 #define ADD_ID_DESC(type, data, size) \ 3283 do { \ 3284 if (!spdk_mem_all_zero(data, size)) { \ 3285 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 3286 } \ 3287 } while (0) 3288 3289 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 3290 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 3291 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 3292 ADD_ID_DESC(SPDK_NVME_NIDT_CSI, &ns->csi, sizeof(uint8_t)); 3293 3294 /* 3295 * The list is automatically 0-terminated, both in the temporary buffer 3296 * used by nvmf_ctrlr_identify(), and the eventual iov destination - 3297 * controller to host buffers in admin commands always get zeroed in 3298 * nvmf_ctrlr_process_admin_cmd(). 3299 */ 3300 3301 #undef ADD_ID_DESC 3302 3303 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3304 } 3305 3306 static int 3307 nvmf_ctrlr_identify_iocs(struct spdk_nvmf_ctrlr *ctrlr, 3308 struct spdk_nvme_cmd *cmd, 3309 struct spdk_nvme_cpl *rsp, 3310 void *cdata, size_t cdata_size) 3311 { 3312 struct spdk_nvme_iocs_vector *vector; 3313 struct spdk_nvmf_ns *ns; 3314 3315 if (cdata_size < sizeof(struct spdk_nvme_iocs_vector)) { 3316 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3317 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3318 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3319 } 3320 3321 /* For now we only support this command sent to the current 3322 * controller. 3323 */ 3324 if (cmd->cdw10_bits.identify.cntid != 0xFFFF && 3325 cmd->cdw10_bits.identify.cntid != ctrlr->cntlid) { 3326 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3327 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3328 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3329 } 3330 memset(cdata, 0, cdata_size); 3331 3332 vector = cdata; 3333 vector->nvm = 1; 3334 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL; 3335 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 3336 if (ns->bdev == NULL) { 3337 continue; 3338 } 3339 if (spdk_bdev_is_zoned(ns->bdev)) { 3340 vector->zns = 1; 3341 } 3342 } 3343 3344 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3345 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3346 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3347 } 3348 3349 static int 3350 nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 3351 { 3352 uint8_t cns; 3353 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3354 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3355 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3356 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 3357 int ret = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3358 char tmpbuf[SPDK_NVME_IDENTIFY_BUFLEN] = ""; 3359 struct spdk_iov_xfer ix; 3360 3361 if (req->iovcnt < 1 || req->length < SPDK_NVME_IDENTIFY_BUFLEN) { 3362 SPDK_DEBUGLOG(nvmf, "identify command with invalid buffer\n"); 3363 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3364 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3365 return ret; 3366 } 3367 3368 cns = cmd->cdw10_bits.identify.cns; 3369 3370 if (spdk_nvmf_subsystem_is_discovery(subsystem) && 3371 cns != SPDK_NVME_IDENTIFY_CTRLR) { 3372 /* Discovery controllers only support Identify Controller */ 3373 goto invalid_cns; 3374 } 3375 3376 /* 3377 * We must use a temporary buffer: it's entirely possible the out buffer 3378 * is split across more than one IOV. 3379 */ 3380 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3381 3382 SPDK_DEBUGLOG(nvmf, "Received identify command with CNS 0x%02x\n", cns); 3383 3384 switch (cns) { 3385 case SPDK_NVME_IDENTIFY_NS: 3386 /* Function below can be asynchronous & we always need to have the data in request's buffer 3387 * So just return here */ 3388 return spdk_nvmf_ctrlr_identify_ns_ext(req); 3389 case SPDK_NVME_IDENTIFY_CTRLR: 3390 ret = spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, (void *)&tmpbuf); 3391 break; 3392 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 3393 ret = nvmf_ctrlr_identify_active_ns_list(ctrlr, cmd, rsp, (void *)&tmpbuf); 3394 break; 3395 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 3396 ret = nvmf_ctrlr_identify_ns_id_descriptor_list(ctrlr, cmd, rsp, 3397 tmpbuf, req->length); 3398 break; 3399 case SPDK_NVME_IDENTIFY_NS_IOCS: 3400 ret = spdk_nvmf_ns_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3401 break; 3402 case SPDK_NVME_IDENTIFY_CTRLR_IOCS: 3403 ret = spdk_nvmf_ctrlr_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3404 break; 3405 case SPDK_NVME_IDENTIFY_IOCS: 3406 ret = nvmf_ctrlr_identify_iocs(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3407 break; 3408 default: 3409 goto invalid_cns; 3410 } 3411 3412 if (ret == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 3413 spdk_iov_xfer_from_buf(&ix, tmpbuf, sizeof(tmpbuf)); 3414 } 3415 3416 return ret; 3417 3418 invalid_cns: 3419 SPDK_DEBUGLOG(nvmf, "Identify command with unsupported CNS 0x%02x\n", cns); 3420 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3421 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3422 return ret; 3423 } 3424 3425 static bool 3426 nvmf_qpair_abort_aer(struct spdk_nvmf_qpair *qpair, uint16_t cid) 3427 { 3428 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 3429 struct spdk_nvmf_request *req; 3430 int i; 3431 3432 if (!nvmf_qpair_is_admin_queue(qpair)) { 3433 return false; 3434 } 3435 3436 assert(spdk_get_thread() == ctrlr->thread); 3437 3438 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 3439 if (ctrlr->aer_req[i]->cmd->nvme_cmd.cid == cid) { 3440 SPDK_DEBUGLOG(nvmf, "Aborting AER request\n"); 3441 req = ctrlr->aer_req[i]; 3442 ctrlr->aer_req[i] = NULL; 3443 ctrlr->nr_aer_reqs--; 3444 3445 /* Move the last req to the aborting position for making aer_reqs 3446 * in continuous 3447 */ 3448 if (i < ctrlr->nr_aer_reqs) { 3449 ctrlr->aer_req[i] = ctrlr->aer_req[ctrlr->nr_aer_reqs]; 3450 ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL; 3451 } 3452 3453 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3454 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 3455 _nvmf_request_complete(req); 3456 return true; 3457 } 3458 } 3459 3460 return false; 3461 } 3462 3463 void 3464 nvmf_qpair_abort_pending_zcopy_reqs(struct spdk_nvmf_qpair *qpair) 3465 { 3466 struct spdk_nvmf_request *req, *tmp; 3467 3468 TAILQ_FOREACH_SAFE(req, &qpair->outstanding, link, tmp) { 3469 if (req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE) { 3470 /* Zero-copy requests are kept on the outstanding queue from the moment 3471 * zcopy_start is sent until a zcopy_end callback is received. Therefore, 3472 * we can't remove them from the outstanding queue here, but need to rely on 3473 * the transport to do a zcopy_end to release their buffers and, in turn, 3474 * remove them from the queue. 3475 */ 3476 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3477 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 3478 nvmf_transport_req_free(req); 3479 } 3480 } 3481 } 3482 3483 static void 3484 nvmf_qpair_abort_request(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_request *req) 3485 { 3486 uint16_t cid = req->cmd->nvme_cmd.cdw10_bits.abort.cid; 3487 3488 if (nvmf_qpair_abort_aer(qpair, cid)) { 3489 SPDK_DEBUGLOG(nvmf, "abort ctrlr=%p sqid=%u cid=%u successful\n", 3490 qpair->ctrlr, qpair->qid, cid); 3491 req->rsp->nvme_cpl.cdw0 &= ~1U; /* Command successfully aborted */ 3492 3493 spdk_nvmf_request_complete(req); 3494 return; 3495 } 3496 3497 nvmf_transport_qpair_abort_request(qpair, req); 3498 } 3499 3500 static void 3501 nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status) 3502 { 3503 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 3504 3505 if (status == 0) { 3506 /* There was no qpair whose ID matches SQID of the abort command. 3507 * Hence call _nvmf_request_complete() here. 3508 */ 3509 _nvmf_request_complete(req); 3510 } 3511 } 3512 3513 static void 3514 nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i) 3515 { 3516 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 3517 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 3518 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 3519 uint16_t sqid = req->cmd->nvme_cmd.cdw10_bits.abort.sqid; 3520 struct spdk_nvmf_qpair *qpair; 3521 3522 TAILQ_FOREACH(qpair, &group->qpairs, link) { 3523 if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) { 3524 /* Found the qpair */ 3525 3526 nvmf_qpair_abort_request(qpair, req); 3527 3528 /* Return -1 for the status so the iteration across threads stops. */ 3529 spdk_for_each_channel_continue(i, -1); 3530 return; 3531 } 3532 } 3533 3534 spdk_for_each_channel_continue(i, 0); 3535 } 3536 3537 static int 3538 nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 3539 { 3540 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3541 3542 rsp->cdw0 = 1U; /* Command not aborted */ 3543 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3544 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3545 3546 /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */ 3547 spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt, 3548 nvmf_ctrlr_abort_on_pg, 3549 req, 3550 nvmf_ctrlr_abort_done 3551 ); 3552 3553 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 3554 } 3555 3556 int 3557 nvmf_ctrlr_abort_request(struct spdk_nvmf_request *req) 3558 { 3559 struct spdk_nvmf_request *req_to_abort = req->req_to_abort; 3560 struct spdk_bdev *bdev; 3561 struct spdk_bdev_desc *desc; 3562 struct spdk_io_channel *ch; 3563 int rc; 3564 3565 assert(req_to_abort != NULL); 3566 3567 if (g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr && 3568 nvmf_qpair_is_admin_queue(req_to_abort->qpair)) { 3569 return g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr(req); 3570 } 3571 3572 rc = spdk_nvmf_request_get_bdev(req_to_abort->cmd->nvme_cmd.nsid, req_to_abort, 3573 &bdev, &desc, &ch); 3574 if (rc != 0) { 3575 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3576 } 3577 3578 return spdk_nvmf_bdev_ctrlr_abort_cmd(bdev, desc, ch, req, req_to_abort); 3579 } 3580 3581 static int 3582 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 3583 { 3584 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3585 3586 rsp->cdw0 = cdw0; 3587 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3588 } 3589 3590 /* we have to use the typedef in the function declaration to appease astyle. */ 3591 typedef enum spdk_nvme_path_status_code spdk_nvme_path_status_code_t; 3592 3593 static spdk_nvme_path_status_code_t 3594 _nvme_ana_state_to_path_status(enum spdk_nvme_ana_state ana_state) 3595 { 3596 switch (ana_state) { 3597 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3598 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_INACCESSIBLE; 3599 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3600 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS; 3601 case SPDK_NVME_ANA_CHANGE_STATE: 3602 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_TRANSITION; 3603 default: 3604 return SPDK_NVME_SC_INTERNAL_PATH_ERROR; 3605 } 3606 } 3607 3608 static int 3609 nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 3610 { 3611 uint8_t feature; 3612 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3613 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3614 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3615 enum spdk_nvme_ana_state ana_state; 3616 3617 feature = cmd->cdw10_bits.get_features.fid; 3618 3619 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3620 /* 3621 * Features supported by Discovery controller 3622 */ 3623 switch (feature) { 3624 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3625 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 3626 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3627 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 3628 default: 3629 SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature); 3630 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3631 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3632 } 3633 } 3634 /* 3635 * Process Get Features command for non-discovery controller 3636 */ 3637 ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid); 3638 switch (ana_state) { 3639 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3640 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3641 case SPDK_NVME_ANA_CHANGE_STATE: 3642 switch (feature) { 3643 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3644 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3645 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3646 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3647 response->status.sct = SPDK_NVME_SCT_PATH; 3648 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3649 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3650 default: 3651 break; 3652 } 3653 break; 3654 default: 3655 break; 3656 } 3657 3658 switch (feature) { 3659 case SPDK_NVME_FEAT_ARBITRATION: 3660 return get_features_generic(req, ctrlr->feat.arbitration.raw); 3661 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 3662 return get_features_generic(req, ctrlr->feat.power_management.raw); 3663 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 3664 return nvmf_ctrlr_get_features_temperature_threshold(req); 3665 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3666 return get_features_generic(req, ctrlr->feat.error_recovery.raw); 3667 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 3668 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 3669 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 3670 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 3671 case SPDK_NVME_FEAT_INTERRUPT_COALESCING: 3672 return get_features_generic(req, ctrlr->feat.interrupt_coalescing.raw); 3673 case SPDK_NVME_FEAT_INTERRUPT_VECTOR_CONFIGURATION: 3674 return nvmf_ctrlr_get_features_interrupt_vector_configuration(req); 3675 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3676 return get_features_generic(req, ctrlr->feat.write_atomicity.raw); 3677 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3678 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 3679 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3680 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 3681 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 3682 return nvmf_ctrlr_get_features_host_identifier(req); 3683 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3684 return nvmf_ctrlr_get_features_reservation_notification_mask(req); 3685 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3686 return nvmf_ctrlr_get_features_reservation_persistence(req); 3687 case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT: 3688 return nvmf_ctrlr_get_features_host_behavior_support(req); 3689 default: 3690 SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature); 3691 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3692 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3693 } 3694 } 3695 3696 static int 3697 nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 3698 { 3699 uint8_t feature, save; 3700 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3701 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3702 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3703 enum spdk_nvme_ana_state ana_state; 3704 /* 3705 * Features are not saveable by the controller as indicated by 3706 * ONCS field of the Identify Controller data. 3707 * */ 3708 save = cmd->cdw10_bits.set_features.sv; 3709 if (save) { 3710 response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE; 3711 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 3712 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3713 } 3714 3715 feature = cmd->cdw10_bits.set_features.fid; 3716 3717 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3718 /* 3719 * Features supported by Discovery controller 3720 */ 3721 switch (feature) { 3722 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3723 return nvmf_ctrlr_set_features_keep_alive_timer(req); 3724 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3725 return nvmf_ctrlr_set_features_async_event_configuration(req); 3726 default: 3727 SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature); 3728 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3729 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3730 } 3731 } 3732 /* 3733 * Process Set Features command for non-discovery controller 3734 */ 3735 ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid); 3736 switch (ana_state) { 3737 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3738 case SPDK_NVME_ANA_CHANGE_STATE: 3739 if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) { 3740 response->status.sct = SPDK_NVME_SCT_PATH; 3741 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3742 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3743 } else { 3744 switch (feature) { 3745 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3746 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3747 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3748 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3749 response->status.sct = SPDK_NVME_SCT_PATH; 3750 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3751 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3752 default: 3753 break; 3754 } 3755 } 3756 break; 3757 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3758 response->status.sct = SPDK_NVME_SCT_PATH; 3759 response->status.sc = SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS; 3760 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3761 default: 3762 break; 3763 } 3764 3765 switch (feature) { 3766 case SPDK_NVME_FEAT_ARBITRATION: 3767 return nvmf_ctrlr_set_features_arbitration(req); 3768 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 3769 return nvmf_ctrlr_set_features_power_management(req); 3770 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 3771 return nvmf_ctrlr_set_features_temperature_threshold(req); 3772 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3773 return nvmf_ctrlr_set_features_error_recovery(req); 3774 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 3775 return nvmf_ctrlr_set_features_volatile_write_cache(req); 3776 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 3777 return nvmf_ctrlr_set_features_number_of_queues(req); 3778 case SPDK_NVME_FEAT_INTERRUPT_COALESCING: 3779 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 3780 response->status.sc = SPDK_NVME_SC_FEATURE_NOT_CHANGEABLE; 3781 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3782 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3783 return nvmf_ctrlr_set_features_write_atomicity(req); 3784 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3785 return nvmf_ctrlr_set_features_async_event_configuration(req); 3786 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3787 return nvmf_ctrlr_set_features_keep_alive_timer(req); 3788 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 3789 return nvmf_ctrlr_set_features_host_identifier(req); 3790 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3791 return nvmf_ctrlr_set_features_reservation_notification_mask(req); 3792 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3793 return nvmf_ctrlr_set_features_reservation_persistence(req); 3794 case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT: 3795 return nvmf_ctrlr_set_features_host_behavior_support(req); 3796 default: 3797 SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature); 3798 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3799 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3800 } 3801 } 3802 3803 static int 3804 nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 3805 { 3806 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3807 3808 SPDK_DEBUGLOG(nvmf, "Keep Alive\n"); 3809 /* 3810 * To handle keep alive just clear or reset the 3811 * ctrlr based keep alive duration counter. 3812 * When added, a separate timer based process 3813 * will monitor if the time since last recorded 3814 * keep alive has exceeded the max duration and 3815 * take appropriate action. 3816 */ 3817 ctrlr->last_keep_alive_tick = spdk_get_ticks(); 3818 3819 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3820 } 3821 3822 static bool 3823 is_cmd_ctrlr_specific(struct spdk_nvme_cmd *cmd) 3824 { 3825 switch (cmd->opc) { 3826 case SPDK_NVME_OPC_DELETE_IO_SQ: 3827 case SPDK_NVME_OPC_CREATE_IO_SQ: 3828 case SPDK_NVME_OPC_DELETE_IO_CQ: 3829 case SPDK_NVME_OPC_CREATE_IO_CQ: 3830 case SPDK_NVME_OPC_ABORT: 3831 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 3832 case SPDK_NVME_OPC_FIRMWARE_COMMIT: 3833 case SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD: 3834 case SPDK_NVME_OPC_KEEP_ALIVE: 3835 case SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT: 3836 case SPDK_NVME_OPC_NVME_MI_SEND: 3837 case SPDK_NVME_OPC_NVME_MI_RECEIVE: 3838 case SPDK_NVME_OPC_DOORBELL_BUFFER_CONFIG: 3839 case SPDK_NVME_OPC_SANITIZE: 3840 return true; 3841 default: 3842 return false; 3843 } 3844 } 3845 3846 int 3847 nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 3848 { 3849 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3850 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3851 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3852 struct spdk_nvmf_subsystem_poll_group *sgroup; 3853 int rc; 3854 3855 assert(ctrlr != NULL); 3856 if (cmd->opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST) { 3857 /* We do not want to treat AERs as outstanding commands, 3858 * so decrement mgmt_io_outstanding here to offset 3859 * the increment that happened prior to this call. 3860 */ 3861 sgroup = &req->qpair->group->sgroups[ctrlr->subsys->id]; 3862 assert(sgroup != NULL); 3863 sgroup->mgmt_io_outstanding--; 3864 } 3865 3866 assert(spdk_get_thread() == ctrlr->thread); 3867 3868 if (cmd->fuse != 0 || 3869 (is_cmd_ctrlr_specific(cmd) && (cmd->nsid != 0))) { 3870 /* Fused admin commands are not supported. 3871 * Commands with controller scope - should be rejected if NSID is set. 3872 */ 3873 response->status.sct = SPDK_NVME_SCT_GENERIC; 3874 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3875 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3876 } 3877 3878 if (ctrlr->vcprop.cc.bits.en != 1) { 3879 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 3880 response->status.sct = SPDK_NVME_SCT_GENERIC; 3881 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 3882 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3883 } 3884 3885 if (req->iovcnt && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 3886 spdk_iov_memset(req->iov, req->iovcnt, 0); 3887 } 3888 3889 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3890 /* Discovery controllers only support these admin OPS. */ 3891 switch (cmd->opc) { 3892 case SPDK_NVME_OPC_IDENTIFY: 3893 case SPDK_NVME_OPC_GET_LOG_PAGE: 3894 case SPDK_NVME_OPC_KEEP_ALIVE: 3895 case SPDK_NVME_OPC_SET_FEATURES: 3896 case SPDK_NVME_OPC_GET_FEATURES: 3897 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 3898 break; 3899 default: 3900 goto invalid_opcode; 3901 } 3902 } 3903 3904 /* Call a custom adm cmd handler if set. Aborts are handled in a different path (see nvmf_passthru_admin_cmd) */ 3905 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr && cmd->opc != SPDK_NVME_OPC_ABORT) { 3906 rc = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr(req); 3907 if (rc >= SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 3908 /* The handler took care of this command */ 3909 return rc; 3910 } 3911 } 3912 3913 /* We only want to send passthrough admin commands to namespaces. 3914 * However, we don't want to passthrough a command with intended for all namespaces. 3915 */ 3916 if (ctrlr->subsys->passthrough && cmd->nsid && cmd->nsid != SPDK_NVME_GLOBAL_NS_TAG) { 3917 return nvmf_passthru_admin_cmd(req); 3918 } 3919 3920 switch (cmd->opc) { 3921 case SPDK_NVME_OPC_GET_LOG_PAGE: 3922 return nvmf_ctrlr_get_log_page(req); 3923 case SPDK_NVME_OPC_IDENTIFY: 3924 return nvmf_ctrlr_identify(req); 3925 case SPDK_NVME_OPC_ABORT: 3926 return nvmf_ctrlr_abort(req); 3927 case SPDK_NVME_OPC_GET_FEATURES: 3928 return nvmf_ctrlr_get_features(req); 3929 case SPDK_NVME_OPC_SET_FEATURES: 3930 return nvmf_ctrlr_set_features(req); 3931 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 3932 return nvmf_ctrlr_async_event_request(req); 3933 case SPDK_NVME_OPC_KEEP_ALIVE: 3934 return nvmf_ctrlr_keep_alive(req); 3935 3936 case SPDK_NVME_OPC_CREATE_IO_SQ: 3937 case SPDK_NVME_OPC_CREATE_IO_CQ: 3938 case SPDK_NVME_OPC_DELETE_IO_SQ: 3939 case SPDK_NVME_OPC_DELETE_IO_CQ: 3940 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 3941 goto invalid_opcode; 3942 3943 default: 3944 goto invalid_opcode; 3945 } 3946 3947 invalid_opcode: 3948 SPDK_INFOLOG(nvmf, "Unsupported admin opcode 0x%x\n", cmd->opc); 3949 response->status.sct = SPDK_NVME_SCT_GENERIC; 3950 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3951 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3952 } 3953 3954 static int 3955 nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 3956 { 3957 struct spdk_nvmf_qpair *qpair = req->qpair; 3958 struct spdk_nvmf_capsule_cmd *cap_hdr; 3959 3960 cap_hdr = &req->cmd->nvmf_cmd; 3961 3962 if (qpair->ctrlr == NULL) { 3963 /* No ctrlr established yet; the only valid command is Connect */ 3964 assert(cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT); 3965 return nvmf_ctrlr_cmd_connect(req); 3966 } else if (nvmf_qpair_is_admin_queue(qpair)) { 3967 /* 3968 * Controller session is established, and this is an admin queue. 3969 * Disallow Connect and allow other fabrics commands. 3970 */ 3971 switch (cap_hdr->fctype) { 3972 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 3973 return nvmf_property_set(req); 3974 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 3975 return nvmf_property_get(req); 3976 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND: 3977 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV: 3978 return nvmf_auth_request_exec(req); 3979 default: 3980 SPDK_DEBUGLOG(nvmf, "unknown fctype 0x%02x\n", 3981 cap_hdr->fctype); 3982 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3983 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3984 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3985 } 3986 } else { 3987 /* 3988 * Controller session is established, and this is an I/O queue. 3989 * Disallow everything besides authentication commands. 3990 */ 3991 switch (cap_hdr->fctype) { 3992 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND: 3993 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV: 3994 return nvmf_auth_request_exec(req); 3995 default: 3996 SPDK_DEBUGLOG(nvmf, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 3997 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3998 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3999 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4000 } 4001 } 4002 } 4003 4004 static inline void 4005 nvmf_ctrlr_queue_pending_async_event(struct spdk_nvmf_ctrlr *ctrlr, 4006 union spdk_nvme_async_event_completion *event) 4007 { 4008 struct spdk_nvmf_async_event_completion *nvmf_event; 4009 4010 nvmf_event = calloc(1, sizeof(*nvmf_event)); 4011 if (!nvmf_event) { 4012 SPDK_ERRLOG("Alloc nvmf event failed, ignore the event\n"); 4013 return; 4014 } 4015 nvmf_event->event.raw = event->raw; 4016 STAILQ_INSERT_TAIL(&ctrlr->async_events, nvmf_event, link); 4017 } 4018 4019 static inline int 4020 nvmf_ctrlr_async_event_notification(struct spdk_nvmf_ctrlr *ctrlr, 4021 union spdk_nvme_async_event_completion *event) 4022 { 4023 struct spdk_nvmf_request *req; 4024 struct spdk_nvme_cpl *rsp; 4025 4026 assert(spdk_get_thread() == ctrlr->thread); 4027 4028 /* If there is no outstanding AER request, queue the event. Then 4029 * if an AER is later submitted, this event can be sent as a 4030 * response. 4031 */ 4032 if (ctrlr->nr_aer_reqs == 0) { 4033 nvmf_ctrlr_queue_pending_async_event(ctrlr, event); 4034 return 0; 4035 } 4036 4037 req = ctrlr->aer_req[--ctrlr->nr_aer_reqs]; 4038 rsp = &req->rsp->nvme_cpl; 4039 4040 rsp->cdw0 = event->raw; 4041 4042 _nvmf_request_complete(req); 4043 ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL; 4044 4045 return 0; 4046 } 4047 4048 int 4049 nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 4050 { 4051 union spdk_nvme_async_event_completion event = {0}; 4052 4053 /* Users may disable the event notification */ 4054 if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) { 4055 return 0; 4056 } 4057 4058 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT)) { 4059 return 0; 4060 } 4061 4062 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 4063 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED; 4064 event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST; 4065 4066 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 4067 } 4068 4069 int 4070 nvmf_ctrlr_async_event_ana_change_notice(struct spdk_nvmf_ctrlr *ctrlr) 4071 { 4072 union spdk_nvme_async_event_completion event = {0}; 4073 4074 /* Users may disable the event notification */ 4075 if (!ctrlr->feat.async_event_configuration.bits.ana_change_notice) { 4076 return 0; 4077 } 4078 4079 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT)) { 4080 return 0; 4081 } 4082 4083 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 4084 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_ANA_CHANGE; 4085 event.bits.log_page_identifier = SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS; 4086 4087 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 4088 } 4089 4090 void 4091 nvmf_ctrlr_async_event_reservation_notification(struct spdk_nvmf_ctrlr *ctrlr) 4092 { 4093 union spdk_nvme_async_event_completion event = {0}; 4094 4095 if (!ctrlr->num_avail_log_pages) { 4096 return; 4097 } 4098 4099 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT)) { 4100 return; 4101 } 4102 4103 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_IO; 4104 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL; 4105 event.bits.log_page_identifier = SPDK_NVME_LOG_RESERVATION_NOTIFICATION; 4106 4107 nvmf_ctrlr_async_event_notification(ctrlr, &event); 4108 } 4109 4110 void 4111 nvmf_ctrlr_async_event_discovery_log_change_notice(void *ctx) 4112 { 4113 union spdk_nvme_async_event_completion event = {0}; 4114 struct spdk_nvmf_ctrlr *ctrlr = ctx; 4115 4116 /* Users may disable the event notification manually or 4117 * it may not be enabled due to keep alive timeout 4118 * not being set in connect command to discovery controller. 4119 */ 4120 if (!ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice) { 4121 return; 4122 } 4123 4124 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT)) { 4125 return; 4126 } 4127 4128 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 4129 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE; 4130 event.bits.log_page_identifier = SPDK_NVME_LOG_DISCOVERY; 4131 4132 nvmf_ctrlr_async_event_notification(ctrlr, &event); 4133 } 4134 4135 int 4136 spdk_nvmf_ctrlr_async_event_error_event(struct spdk_nvmf_ctrlr *ctrlr, 4137 enum spdk_nvme_async_event_info_error info) 4138 { 4139 union spdk_nvme_async_event_completion event; 4140 4141 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT)) { 4142 return 0; 4143 } 4144 4145 if (info > SPDK_NVME_ASYNC_EVENT_FW_IMAGE_LOAD) { 4146 return 0; 4147 } 4148 4149 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_ERROR; 4150 event.bits.log_page_identifier = SPDK_NVME_LOG_ERROR; 4151 event.bits.async_event_info = info; 4152 4153 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 4154 } 4155 4156 void 4157 nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair) 4158 { 4159 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4160 int i; 4161 4162 if (ctrlr == NULL || !nvmf_qpair_is_admin_queue(qpair)) { 4163 return; 4164 } 4165 4166 assert(spdk_get_thread() == ctrlr->thread); 4167 4168 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 4169 spdk_nvmf_request_free(ctrlr->aer_req[i]); 4170 ctrlr->aer_req[i] = NULL; 4171 } 4172 4173 ctrlr->nr_aer_reqs = 0; 4174 } 4175 4176 void 4177 spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr) 4178 { 4179 struct spdk_nvmf_request *req; 4180 int i; 4181 4182 assert(spdk_get_thread() == ctrlr->thread); 4183 4184 if (!ctrlr->nr_aer_reqs) { 4185 return; 4186 } 4187 4188 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 4189 req = ctrlr->aer_req[i]; 4190 4191 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4192 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 4193 _nvmf_request_complete(req); 4194 4195 ctrlr->aer_req[i] = NULL; 4196 } 4197 4198 ctrlr->nr_aer_reqs = 0; 4199 } 4200 4201 static void 4202 _nvmf_ctrlr_add_reservation_log(void *ctx) 4203 { 4204 struct spdk_nvmf_reservation_log *log = (struct spdk_nvmf_reservation_log *)ctx; 4205 struct spdk_nvmf_ctrlr *ctrlr = log->ctrlr; 4206 4207 ctrlr->log_page_count++; 4208 4209 /* Maximum number of queued log pages is 255 */ 4210 if (ctrlr->num_avail_log_pages == 0xff) { 4211 struct spdk_nvmf_reservation_log *entry; 4212 entry = TAILQ_LAST(&ctrlr->log_head, log_page_head); 4213 entry->log.log_page_count = ctrlr->log_page_count; 4214 free(log); 4215 return; 4216 } 4217 4218 log->log.log_page_count = ctrlr->log_page_count; 4219 log->log.num_avail_log_pages = ctrlr->num_avail_log_pages++; 4220 TAILQ_INSERT_TAIL(&ctrlr->log_head, log, link); 4221 4222 nvmf_ctrlr_async_event_reservation_notification(ctrlr); 4223 } 4224 4225 void 4226 nvmf_ctrlr_reservation_notice_log(struct spdk_nvmf_ctrlr *ctrlr, 4227 struct spdk_nvmf_ns *ns, 4228 enum spdk_nvme_reservation_notification_log_page_type type) 4229 { 4230 struct spdk_nvmf_reservation_log *log; 4231 4232 switch (type) { 4233 case SPDK_NVME_RESERVATION_LOG_PAGE_EMPTY: 4234 return; 4235 case SPDK_NVME_REGISTRATION_PREEMPTED: 4236 if (ns->mask & SPDK_NVME_REGISTRATION_PREEMPTED_MASK) { 4237 return; 4238 } 4239 break; 4240 case SPDK_NVME_RESERVATION_RELEASED: 4241 if (ns->mask & SPDK_NVME_RESERVATION_RELEASED_MASK) { 4242 return; 4243 } 4244 break; 4245 case SPDK_NVME_RESERVATION_PREEMPTED: 4246 if (ns->mask & SPDK_NVME_RESERVATION_PREEMPTED_MASK) { 4247 return; 4248 } 4249 break; 4250 default: 4251 return; 4252 } 4253 4254 log = calloc(1, sizeof(*log)); 4255 if (!log) { 4256 SPDK_ERRLOG("Alloc log page failed, ignore the log\n"); 4257 return; 4258 } 4259 log->ctrlr = ctrlr; 4260 log->log.type = type; 4261 log->log.nsid = ns->nsid; 4262 4263 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_reservation_log, log); 4264 } 4265 4266 /* Check from subsystem poll group's namespace information data structure */ 4267 static bool 4268 nvmf_ns_info_ctrlr_is_registrant(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 4269 struct spdk_nvmf_ctrlr *ctrlr) 4270 { 4271 uint32_t i; 4272 4273 for (i = 0; i < SPDK_NVMF_MAX_NUM_REGISTRANTS; i++) { 4274 if (!spdk_uuid_compare(&ns_info->reg_hostid[i], &ctrlr->hostid)) { 4275 return true; 4276 } 4277 } 4278 4279 return false; 4280 } 4281 4282 /* 4283 * Check the NVMe command is permitted or not for current controller(Host). 4284 */ 4285 static int 4286 nvmf_ns_reservation_request_check(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 4287 struct spdk_nvmf_ctrlr *ctrlr, 4288 struct spdk_nvmf_request *req) 4289 { 4290 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4291 enum spdk_nvme_reservation_type rtype = ns_info->rtype; 4292 uint8_t status = SPDK_NVME_SC_SUCCESS; 4293 uint8_t racqa; 4294 bool is_registrant; 4295 4296 /* No valid reservation */ 4297 if (!rtype) { 4298 return 0; 4299 } 4300 4301 is_registrant = nvmf_ns_info_ctrlr_is_registrant(ns_info, ctrlr); 4302 /* All registrants type and current ctrlr is a valid registrant */ 4303 if ((rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS || 4304 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && is_registrant) { 4305 return 0; 4306 } else if (!spdk_uuid_compare(&ns_info->holder_id, &ctrlr->hostid)) { 4307 return 0; 4308 } 4309 4310 /* Non-holder for current controller */ 4311 switch (cmd->opc) { 4312 case SPDK_NVME_OPC_READ: 4313 case SPDK_NVME_OPC_COMPARE: 4314 if (rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 4315 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4316 goto exit; 4317 } 4318 if ((rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY || 4319 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && !is_registrant) { 4320 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4321 } 4322 break; 4323 case SPDK_NVME_OPC_FLUSH: 4324 case SPDK_NVME_OPC_WRITE: 4325 case SPDK_NVME_OPC_WRITE_UNCORRECTABLE: 4326 case SPDK_NVME_OPC_WRITE_ZEROES: 4327 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 4328 if (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE || 4329 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 4330 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4331 goto exit; 4332 } 4333 if (!is_registrant) { 4334 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4335 } 4336 break; 4337 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 4338 racqa = cmd->cdw10_bits.resv_acquire.racqa; 4339 if (racqa == SPDK_NVME_RESERVE_ACQUIRE) { 4340 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4341 goto exit; 4342 } 4343 if (!is_registrant) { 4344 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4345 } 4346 break; 4347 case SPDK_NVME_OPC_RESERVATION_RELEASE: 4348 if (!is_registrant) { 4349 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4350 } 4351 break; 4352 default: 4353 break; 4354 } 4355 4356 exit: 4357 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4358 req->rsp->nvme_cpl.status.sc = status; 4359 if (status == SPDK_NVME_SC_RESERVATION_CONFLICT) { 4360 return -EPERM; 4361 } 4362 4363 return 0; 4364 } 4365 4366 static int 4367 nvmf_ctrlr_process_io_fused_cmd(struct spdk_nvmf_request *req, struct spdk_bdev *bdev, 4368 struct spdk_bdev_desc *desc, struct spdk_io_channel *ch) 4369 { 4370 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4371 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 4372 struct spdk_nvmf_request *first_fused_req = req->qpair->first_fused_req; 4373 int rc; 4374 4375 if (cmd->fuse == SPDK_NVME_CMD_FUSE_FIRST) { 4376 /* first fused operation (should be compare) */ 4377 if (first_fused_req != NULL) { 4378 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4379 4380 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 4381 4382 /* abort req->qpair->first_fused_request and continue with new fused command */ 4383 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4384 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4385 _nvmf_request_complete(first_fused_req); 4386 } else if (cmd->opc != SPDK_NVME_OPC_COMPARE) { 4387 SPDK_ERRLOG("Wrong op code of fused operations\n"); 4388 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4389 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4390 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4391 } 4392 4393 req->qpair->first_fused_req = req; 4394 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 4395 } else if (cmd->fuse == SPDK_NVME_CMD_FUSE_SECOND) { 4396 /* second fused operation (should be write) */ 4397 if (first_fused_req == NULL) { 4398 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 4399 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4400 rsp->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4401 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4402 } else if (cmd->opc != SPDK_NVME_OPC_WRITE) { 4403 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4404 4405 SPDK_ERRLOG("Wrong op code of fused operations\n"); 4406 4407 /* abort req->qpair->first_fused_request and fail current command */ 4408 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4409 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4410 _nvmf_request_complete(first_fused_req); 4411 4412 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4413 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4414 req->qpair->first_fused_req = NULL; 4415 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4416 } 4417 4418 /* save request of first command to generate response later */ 4419 req->first_fused_req = first_fused_req; 4420 req->first_fused = true; 4421 req->qpair->first_fused_req = NULL; 4422 } else { 4423 SPDK_ERRLOG("Invalid fused command fuse field.\n"); 4424 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4425 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 4426 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4427 } 4428 4429 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(bdev, desc, ch, req->first_fused_req, req); 4430 4431 if (rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 4432 if (spdk_nvme_cpl_is_error(rsp)) { 4433 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4434 4435 fused_response->status = rsp->status; 4436 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4437 rsp->status.sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 4438 /* Complete first of fused commands. Second will be completed by upper layer */ 4439 _nvmf_request_complete(first_fused_req); 4440 req->first_fused_req = NULL; 4441 req->first_fused = false; 4442 } 4443 } 4444 4445 return rc; 4446 } 4447 4448 bool 4449 nvmf_ctrlr_use_zcopy(struct spdk_nvmf_request *req) 4450 { 4451 struct spdk_nvmf_transport *transport = req->qpair->transport; 4452 struct spdk_nvmf_ns *ns; 4453 4454 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE); 4455 4456 if (!transport->opts.zcopy) { 4457 return false; 4458 } 4459 4460 if (nvmf_qpair_is_admin_queue(req->qpair)) { 4461 /* Admin queue */ 4462 return false; 4463 } 4464 4465 if ((req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_WRITE) && 4466 (req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_READ)) { 4467 /* Not a READ or WRITE command */ 4468 return false; 4469 } 4470 4471 if (req->cmd->nvme_cmd.fuse != SPDK_NVME_CMD_FUSE_NONE) { 4472 /* Fused commands dont use zcopy buffers */ 4473 return false; 4474 } 4475 4476 ns = nvmf_ctrlr_get_ns(req->qpair->ctrlr, req->cmd->nvme_cmd.nsid); 4477 if (ns == NULL || ns->bdev == NULL || !ns->zcopy) { 4478 return false; 4479 } 4480 4481 req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT; 4482 return true; 4483 } 4484 4485 void 4486 spdk_nvmf_request_zcopy_start(struct spdk_nvmf_request *req) 4487 { 4488 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT); 4489 4490 /* Set iovcnt to be the maximum number of iovs that the ZCOPY can use */ 4491 req->iovcnt = NVMF_REQ_MAX_BUFFERS; 4492 4493 spdk_nvmf_request_exec(req); 4494 } 4495 4496 void 4497 spdk_nvmf_request_zcopy_end(struct spdk_nvmf_request *req, bool commit) 4498 { 4499 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE); 4500 req->zcopy_phase = NVMF_ZCOPY_PHASE_END_PENDING; 4501 4502 nvmf_bdev_ctrlr_zcopy_end(req, commit); 4503 } 4504 4505 int 4506 nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req) 4507 { 4508 uint32_t nsid; 4509 struct spdk_nvmf_ns *ns; 4510 struct spdk_bdev *bdev; 4511 struct spdk_bdev_desc *desc; 4512 struct spdk_io_channel *ch; 4513 struct spdk_nvmf_qpair *qpair = req->qpair; 4514 struct spdk_nvmf_poll_group *group = qpair->group; 4515 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4516 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4517 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 4518 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4519 enum spdk_nvme_ana_state ana_state; 4520 4521 /* pre-set response details for this command */ 4522 response->status.sc = SPDK_NVME_SC_SUCCESS; 4523 nsid = cmd->nsid; 4524 4525 assert(ctrlr != NULL); 4526 if (spdk_unlikely(ctrlr->vcprop.cc.bits.en != 1)) { 4527 SPDK_ERRLOG("I/O command sent to disabled controller\n"); 4528 response->status.sct = SPDK_NVME_SCT_GENERIC; 4529 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 4530 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4531 } 4532 4533 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 4534 if (spdk_unlikely(ns == NULL || ns->bdev == NULL)) { 4535 SPDK_DEBUGLOG(nvmf, "Unsuccessful query for nsid %u\n", cmd->nsid); 4536 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4537 response->status.dnr = 1; 4538 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4539 } 4540 4541 ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 4542 if (spdk_unlikely(ana_state != SPDK_NVME_ANA_OPTIMIZED_STATE && 4543 ana_state != SPDK_NVME_ANA_NON_OPTIMIZED_STATE)) { 4544 SPDK_DEBUGLOG(nvmf, "Fail I/O command due to ANA state %d\n", 4545 ana_state); 4546 response->status.sct = SPDK_NVME_SCT_PATH; 4547 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 4548 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4549 } 4550 4551 if (spdk_likely(ctrlr->listener != NULL)) { 4552 SPDK_DTRACE_PROBE3_TICKS(nvmf_request_io_exec_path, req, 4553 ctrlr->listener->trid->traddr, 4554 ctrlr->listener->trid->trsvcid); 4555 } 4556 4557 /* scan-build falsely reporting dereference of null pointer */ 4558 assert(group != NULL && group->sgroups != NULL); 4559 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 4560 if (nvmf_ns_reservation_request_check(ns_info, ctrlr, req)) { 4561 SPDK_DEBUGLOG(nvmf, "Reservation Conflict for nsid %u, opcode %u\n", 4562 cmd->nsid, cmd->opc); 4563 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4564 } 4565 4566 bdev = ns->bdev; 4567 desc = ns->desc; 4568 ch = ns_info->channel; 4569 4570 if (spdk_unlikely(cmd->fuse & SPDK_NVME_CMD_FUSE_MASK)) { 4571 return nvmf_ctrlr_process_io_fused_cmd(req, bdev, desc, ch); 4572 } else if (spdk_unlikely(qpair->first_fused_req != NULL)) { 4573 struct spdk_nvme_cpl *fused_response = &qpair->first_fused_req->rsp->nvme_cpl; 4574 4575 SPDK_ERRLOG("Second fused cmd expected - failing first one (cntlid:%u, qid:%u, opcode:0x%x)\n", 4576 ctrlr->cntlid, qpair->qid, 4577 req->qpair->first_fused_req->cmd->nvmf_cmd.opcode); 4578 4579 /* abort qpair->first_fused_request and continue with new command */ 4580 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4581 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4582 _nvmf_request_complete(qpair->first_fused_req); 4583 qpair->first_fused_req = NULL; 4584 } 4585 4586 if (ctrlr->subsys->passthrough) { 4587 assert(ns->passthru_nsid > 0); 4588 req->cmd->nvme_cmd.nsid = ns->passthru_nsid; 4589 4590 return nvmf_bdev_ctrlr_nvme_passthru_io(bdev, desc, ch, req); 4591 } 4592 4593 if (spdk_nvmf_request_using_zcopy(req)) { 4594 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT); 4595 return nvmf_bdev_ctrlr_zcopy_start(bdev, desc, ch, req); 4596 } else { 4597 switch (cmd->opc) { 4598 case SPDK_NVME_OPC_READ: 4599 return nvmf_bdev_ctrlr_read_cmd(bdev, desc, ch, req); 4600 case SPDK_NVME_OPC_WRITE: 4601 return nvmf_bdev_ctrlr_write_cmd(bdev, desc, ch, req); 4602 case SPDK_NVME_OPC_FLUSH: 4603 return nvmf_bdev_ctrlr_flush_cmd(bdev, desc, ch, req); 4604 case SPDK_NVME_OPC_COMPARE: 4605 if (spdk_unlikely(!ctrlr->cdata.oncs.compare)) { 4606 goto invalid_opcode; 4607 } 4608 return nvmf_bdev_ctrlr_compare_cmd(bdev, desc, ch, req); 4609 case SPDK_NVME_OPC_WRITE_ZEROES: 4610 if (spdk_unlikely(!ctrlr->cdata.oncs.write_zeroes)) { 4611 goto invalid_opcode; 4612 } 4613 return nvmf_bdev_ctrlr_write_zeroes_cmd(bdev, desc, ch, req); 4614 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 4615 if (spdk_unlikely(!ctrlr->cdata.oncs.dsm)) { 4616 goto invalid_opcode; 4617 } 4618 return nvmf_bdev_ctrlr_dsm_cmd(bdev, desc, ch, req); 4619 case SPDK_NVME_OPC_RESERVATION_REGISTER: 4620 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 4621 case SPDK_NVME_OPC_RESERVATION_RELEASE: 4622 case SPDK_NVME_OPC_RESERVATION_REPORT: 4623 if (spdk_unlikely(!ctrlr->cdata.oncs.reservations)) { 4624 goto invalid_opcode; 4625 } 4626 spdk_thread_send_msg(ctrlr->subsys->thread, nvmf_ns_reservation_request, req); 4627 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 4628 case SPDK_NVME_OPC_COPY: 4629 if (spdk_unlikely(!ctrlr->cdata.oncs.copy)) { 4630 goto invalid_opcode; 4631 } 4632 return nvmf_bdev_ctrlr_copy_cmd(bdev, desc, ch, req); 4633 default: 4634 if (spdk_unlikely(qpair->transport->opts.disable_command_passthru)) { 4635 goto invalid_opcode; 4636 } 4637 if (ns->passthru_nsid) { 4638 req->cmd->nvme_cmd.nsid = ns->passthru_nsid; 4639 } 4640 return nvmf_bdev_ctrlr_nvme_passthru_io(bdev, desc, ch, req); 4641 } 4642 } 4643 invalid_opcode: 4644 SPDK_INFOLOG(nvmf, "Unsupported IO opcode 0x%x\n", cmd->opc); 4645 response->status.sct = SPDK_NVME_SCT_GENERIC; 4646 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4647 response->status.dnr = 1; 4648 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4649 } 4650 4651 static void 4652 nvmf_qpair_request_cleanup(struct spdk_nvmf_qpair *qpair) 4653 { 4654 if (spdk_unlikely(qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING)) { 4655 assert(qpair->state_cb != NULL); 4656 4657 if (TAILQ_EMPTY(&qpair->outstanding)) { 4658 qpair->state_cb(qpair->state_cb_arg, 0); 4659 } 4660 } 4661 } 4662 4663 int 4664 spdk_nvmf_request_free(struct spdk_nvmf_request *req) 4665 { 4666 struct spdk_nvmf_qpair *qpair = req->qpair; 4667 4668 TAILQ_REMOVE(&qpair->outstanding, req, link); 4669 if (spdk_unlikely(nvmf_transport_req_free(req))) { 4670 SPDK_ERRLOG("Unable to free transport level request resources.\n"); 4671 } 4672 4673 nvmf_qpair_request_cleanup(qpair); 4674 4675 return 0; 4676 } 4677 4678 static void 4679 _nvmf_request_complete(void *ctx) 4680 { 4681 struct spdk_nvmf_request *req = ctx; 4682 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 4683 struct spdk_nvmf_qpair *qpair; 4684 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 4685 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4686 bool is_aer = false; 4687 uint32_t nsid; 4688 bool paused; 4689 uint8_t opcode; 4690 4691 rsp->sqid = 0; 4692 rsp->status.p = 0; 4693 rsp->cid = req->cmd->nvme_cmd.cid; 4694 nsid = req->cmd->nvme_cmd.nsid; 4695 opcode = req->cmd->nvmf_cmd.opcode; 4696 4697 qpair = req->qpair; 4698 if (spdk_likely(qpair->ctrlr)) { 4699 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 4700 assert(sgroup != NULL); 4701 is_aer = req->cmd->nvme_cmd.opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST; 4702 if (spdk_likely(qpair->qid != 0)) { 4703 qpair->group->stat.completed_nvme_io++; 4704 } 4705 4706 /* 4707 * Set the crd value. 4708 * If the the IO has any error, and dnr (DoNotRetry) is not 1, 4709 * and ACRE is enabled, we will set the crd to 1 to select the first CRDT. 4710 */ 4711 if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp) && 4712 rsp->status.dnr == 0 && 4713 qpair->ctrlr->acre_enabled)) { 4714 rsp->status.crd = 1; 4715 } 4716 } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) { 4717 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 4718 } 4719 4720 if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) { 4721 spdk_nvme_print_completion(qpair->qid, rsp); 4722 } 4723 4724 switch (req->zcopy_phase) { 4725 case NVMF_ZCOPY_PHASE_NONE: 4726 TAILQ_REMOVE(&qpair->outstanding, req, link); 4727 break; 4728 case NVMF_ZCOPY_PHASE_INIT: 4729 if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp))) { 4730 req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT_FAILED; 4731 TAILQ_REMOVE(&qpair->outstanding, req, link); 4732 } else { 4733 req->zcopy_phase = NVMF_ZCOPY_PHASE_EXECUTE; 4734 } 4735 break; 4736 case NVMF_ZCOPY_PHASE_EXECUTE: 4737 break; 4738 case NVMF_ZCOPY_PHASE_END_PENDING: 4739 TAILQ_REMOVE(&qpair->outstanding, req, link); 4740 req->zcopy_phase = NVMF_ZCOPY_PHASE_COMPLETE; 4741 break; 4742 default: 4743 SPDK_ERRLOG("Invalid ZCOPY phase %u\n", req->zcopy_phase); 4744 break; 4745 } 4746 4747 if (spdk_unlikely(nvmf_transport_req_complete(req))) { 4748 SPDK_ERRLOG("Transport request completion error!\n"); 4749 } 4750 4751 /* AER cmd is an exception */ 4752 if (spdk_likely(sgroup && !is_aer)) { 4753 if (spdk_unlikely(opcode == SPDK_NVME_OPC_FABRIC || 4754 nvmf_qpair_is_admin_queue(qpair))) { 4755 assert(sgroup->mgmt_io_outstanding > 0); 4756 sgroup->mgmt_io_outstanding--; 4757 } else { 4758 if (req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE || 4759 req->zcopy_phase == NVMF_ZCOPY_PHASE_COMPLETE || 4760 req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT_FAILED) { 4761 /* End of request */ 4762 4763 /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */ 4764 if (spdk_likely(nsid - 1 < sgroup->num_ns)) { 4765 sgroup->ns_info[nsid - 1].io_outstanding--; 4766 } 4767 } 4768 } 4769 4770 if (spdk_unlikely(sgroup->state == SPDK_NVMF_SUBSYSTEM_PAUSING && 4771 sgroup->mgmt_io_outstanding == 0)) { 4772 paused = true; 4773 for (nsid = 0; nsid < sgroup->num_ns; nsid++) { 4774 ns_info = &sgroup->ns_info[nsid]; 4775 4776 if (ns_info->state == SPDK_NVMF_SUBSYSTEM_PAUSING && 4777 ns_info->io_outstanding > 0) { 4778 paused = false; 4779 break; 4780 } 4781 } 4782 4783 if (paused) { 4784 sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSED; 4785 sgroup->cb_fn(sgroup->cb_arg, 0); 4786 sgroup->cb_fn = NULL; 4787 sgroup->cb_arg = NULL; 4788 } 4789 } 4790 4791 } 4792 4793 nvmf_qpair_request_cleanup(qpair); 4794 } 4795 4796 int 4797 spdk_nvmf_request_complete(struct spdk_nvmf_request *req) 4798 { 4799 struct spdk_nvmf_qpair *qpair = req->qpair; 4800 4801 spdk_thread_exec_msg(qpair->group->thread, _nvmf_request_complete, req); 4802 4803 return 0; 4804 } 4805 4806 static bool 4807 nvmf_check_subsystem_active(struct spdk_nvmf_request *req) 4808 { 4809 struct spdk_nvmf_qpair *qpair = req->qpair; 4810 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 4811 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4812 uint32_t nsid; 4813 4814 if (spdk_likely(qpair->ctrlr)) { 4815 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 4816 assert(sgroup != NULL); 4817 } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) { 4818 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 4819 } 4820 4821 /* Check if the subsystem is paused (if there is a subsystem) */ 4822 if (spdk_unlikely(sgroup == NULL)) { 4823 return true; 4824 } 4825 4826 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC || 4827 nvmf_qpair_is_admin_queue(qpair))) { 4828 if (sgroup->state != SPDK_NVMF_SUBSYSTEM_ACTIVE) { 4829 /* The subsystem is not currently active. Queue this request. */ 4830 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 4831 return false; 4832 } 4833 sgroup->mgmt_io_outstanding++; 4834 } else { 4835 nsid = req->cmd->nvme_cmd.nsid; 4836 4837 /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */ 4838 if (spdk_unlikely(nsid - 1 >= sgroup->num_ns)) { 4839 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4840 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4841 req->rsp->nvme_cpl.status.dnr = 1; 4842 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4843 _nvmf_request_complete(req); 4844 return false; 4845 } 4846 4847 ns_info = &sgroup->ns_info[nsid - 1]; 4848 if (spdk_unlikely(ns_info->channel == NULL)) { 4849 /* This can can happen if host sends I/O to a namespace that is 4850 * in the process of being added, but before the full addition 4851 * process is complete. Report invalid namespace in that case. 4852 */ 4853 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4854 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4855 req->rsp->nvme_cpl.status.dnr = 1; 4856 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4857 ns_info->io_outstanding++; 4858 _nvmf_request_complete(req); 4859 return false; 4860 } 4861 4862 if (spdk_unlikely(ns_info->state != SPDK_NVMF_SUBSYSTEM_ACTIVE)) { 4863 /* The namespace is not currently active. Queue this request. */ 4864 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 4865 return false; 4866 } 4867 4868 ns_info->io_outstanding++; 4869 } 4870 4871 return true; 4872 } 4873 4874 static bool 4875 nvmf_check_qpair_active(struct spdk_nvmf_request *req) 4876 { 4877 struct spdk_nvmf_qpair *qpair = req->qpair; 4878 int sc, sct; 4879 4880 if (spdk_likely(qpair->state == SPDK_NVMF_QPAIR_ENABLED)) { 4881 return true; 4882 } 4883 4884 sct = SPDK_NVME_SCT_GENERIC; 4885 sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 4886 4887 switch (qpair->state) { 4888 case SPDK_NVMF_QPAIR_CONNECTING: 4889 if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) { 4890 SPDK_ERRLOG("Received command 0x%x on qid %u before CONNECT\n", 4891 req->cmd->nvmf_cmd.opcode, qpair->qid); 4892 break; 4893 } 4894 if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 4895 SPDK_ERRLOG("Received fctype 0x%x on qid %u before CONNECT\n", 4896 req->cmd->nvmf_cmd.fctype, qpair->qid); 4897 break; 4898 } 4899 return true; 4900 case SPDK_NVMF_QPAIR_AUTHENTICATING: 4901 sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 4902 sc = SPDK_NVMF_FABRIC_SC_AUTH_REQUIRED; 4903 if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) { 4904 SPDK_ERRLOG("Received command 0x%x on qid %u before authentication\n", 4905 req->cmd->nvmf_cmd.opcode, qpair->qid); 4906 break; 4907 } 4908 if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND && 4909 req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV) { 4910 SPDK_ERRLOG("Received fctype 0x%x on qid %u before authentication\n", 4911 req->cmd->nvmf_cmd.fctype, qpair->qid); 4912 break; 4913 } 4914 return true; 4915 default: 4916 SPDK_ERRLOG("Received command 0x%x on qid %u in state %d\n", 4917 req->cmd->nvmf_cmd.opcode, qpair->qid, qpair->state); 4918 break; 4919 } 4920 4921 req->rsp->nvme_cpl.status.sct = sct; 4922 req->rsp->nvme_cpl.status.sc = sc; 4923 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4924 _nvmf_request_complete(req); 4925 4926 return false; 4927 } 4928 4929 void 4930 spdk_nvmf_request_exec(struct spdk_nvmf_request *req) 4931 { 4932 struct spdk_nvmf_qpair *qpair = req->qpair; 4933 enum spdk_nvmf_request_exec_status status; 4934 4935 if (spdk_unlikely(!nvmf_check_subsystem_active(req))) { 4936 return; 4937 } 4938 if (spdk_unlikely(!nvmf_check_qpair_active(req))) { 4939 return; 4940 } 4941 4942 if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) { 4943 spdk_nvme_print_command(qpair->qid, &req->cmd->nvme_cmd); 4944 } 4945 4946 /* Place the request on the outstanding list so we can keep track of it */ 4947 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4948 4949 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 4950 status = nvmf_ctrlr_process_fabrics_cmd(req); 4951 } else if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) { 4952 status = nvmf_ctrlr_process_admin_cmd(req); 4953 } else { 4954 status = nvmf_ctrlr_process_io_cmd(req); 4955 } 4956 4957 if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 4958 _nvmf_request_complete(req); 4959 } 4960 } 4961 4962 static bool 4963 nvmf_ctrlr_get_dif_ctx(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd, 4964 struct spdk_dif_ctx *dif_ctx) 4965 { 4966 struct spdk_nvmf_ns *ns; 4967 struct spdk_bdev_desc *desc; 4968 4969 if (ctrlr == NULL || cmd == NULL) { 4970 return false; 4971 } 4972 4973 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 4974 if (ns == NULL || ns->bdev == NULL) { 4975 return false; 4976 } 4977 4978 desc = ns->desc; 4979 4980 switch (cmd->opc) { 4981 case SPDK_NVME_OPC_READ: 4982 case SPDK_NVME_OPC_WRITE: 4983 case SPDK_NVME_OPC_COMPARE: 4984 return nvmf_bdev_ctrlr_get_dif_ctx(desc, cmd, dif_ctx); 4985 default: 4986 break; 4987 } 4988 4989 return false; 4990 } 4991 4992 bool 4993 spdk_nvmf_request_get_dif_ctx(struct spdk_nvmf_request *req, struct spdk_dif_ctx *dif_ctx) 4994 { 4995 struct spdk_nvmf_qpair *qpair = req->qpair; 4996 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4997 4998 if (spdk_likely(ctrlr == NULL || !ctrlr->dif_insert_or_strip)) { 4999 return false; 5000 } 5001 5002 if (spdk_unlikely(!spdk_nvmf_qpair_is_active(qpair))) { 5003 return false; 5004 } 5005 5006 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 5007 return false; 5008 } 5009 5010 if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) { 5011 return false; 5012 } 5013 5014 return nvmf_ctrlr_get_dif_ctx(ctrlr, &req->cmd->nvme_cmd, dif_ctx); 5015 } 5016 5017 void 5018 spdk_nvmf_set_custom_admin_cmd_hdlr(uint8_t opc, spdk_nvmf_custom_cmd_hdlr hdlr) 5019 { 5020 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = hdlr; 5021 } 5022 5023 static int 5024 nvmf_passthru_admin_cmd_for_bdev_nsid(struct spdk_nvmf_request *req, uint32_t bdev_nsid) 5025 { 5026 struct spdk_bdev *bdev; 5027 struct spdk_bdev_desc *desc; 5028 struct spdk_io_channel *ch; 5029 struct spdk_nvmf_ns *ns; 5030 struct spdk_nvmf_ctrlr *ctrlr; 5031 struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req); 5032 int rc; 5033 5034 rc = spdk_nvmf_request_get_bdev(bdev_nsid, req, &bdev, &desc, &ch); 5035 if (rc) { 5036 response->status.sct = SPDK_NVME_SCT_GENERIC; 5037 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 5038 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 5039 } 5040 5041 ctrlr = req->qpair->ctrlr; 5042 ns = nvmf_ctrlr_get_ns(ctrlr, bdev_nsid); 5043 5044 if (ns->passthru_nsid) { 5045 req->cmd->nvme_cmd.nsid = ns->passthru_nsid; 5046 } 5047 5048 return spdk_nvmf_bdev_ctrlr_nvme_passthru_admin(bdev, desc, ch, req, NULL); 5049 } 5050 5051 static int 5052 nvmf_passthru_admin_cmd(struct spdk_nvmf_request *req) 5053 { 5054 struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req); 5055 uint32_t bdev_nsid; 5056 5057 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid != 0) { 5058 bdev_nsid = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid; 5059 } else { 5060 bdev_nsid = cmd->nsid; 5061 } 5062 5063 return nvmf_passthru_admin_cmd_for_bdev_nsid(req, bdev_nsid); 5064 } 5065 5066 int 5067 nvmf_passthru_admin_cmd_for_ctrlr(struct spdk_nvmf_request *req, struct spdk_nvmf_ctrlr *ctrlr) 5068 { 5069 struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req); 5070 struct spdk_nvmf_ns *ns; 5071 5072 ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); 5073 if (ns == NULL) { 5074 /* Is there a better sc to use here? */ 5075 response->status.sct = SPDK_NVME_SCT_GENERIC; 5076 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 5077 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 5078 } 5079 5080 return nvmf_passthru_admin_cmd_for_bdev_nsid(req, ns->nsid); 5081 } 5082 5083 void 5084 spdk_nvmf_set_passthru_admin_cmd(uint8_t opc, uint32_t forward_nsid) 5085 { 5086 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = nvmf_passthru_admin_cmd; 5087 g_nvmf_custom_admin_cmd_hdlrs[opc].nsid = forward_nsid; 5088 } 5089 5090 int 5091 spdk_nvmf_request_get_bdev(uint32_t nsid, struct spdk_nvmf_request *req, 5092 struct spdk_bdev **bdev, struct spdk_bdev_desc **desc, struct spdk_io_channel **ch) 5093 { 5094 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 5095 struct spdk_nvmf_ns *ns; 5096 struct spdk_nvmf_poll_group *group = req->qpair->group; 5097 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 5098 5099 *bdev = NULL; 5100 *desc = NULL; 5101 *ch = NULL; 5102 5103 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 5104 if (ns == NULL || ns->bdev == NULL) { 5105 return -EINVAL; 5106 } 5107 5108 assert(group != NULL && group->sgroups != NULL); 5109 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 5110 *bdev = ns->bdev; 5111 *desc = ns->desc; 5112 *ch = ns_info->channel; 5113 5114 return 0; 5115 } 5116 5117 struct spdk_nvmf_ctrlr *spdk_nvmf_request_get_ctrlr(struct spdk_nvmf_request *req) 5118 { 5119 return req->qpair->ctrlr; 5120 } 5121 5122 struct spdk_nvme_cmd *spdk_nvmf_request_get_cmd(struct spdk_nvmf_request *req) 5123 { 5124 return &req->cmd->nvme_cmd; 5125 } 5126 5127 struct spdk_nvme_cpl *spdk_nvmf_request_get_response(struct spdk_nvmf_request *req) 5128 { 5129 return &req->rsp->nvme_cpl; 5130 } 5131 5132 struct spdk_nvmf_subsystem *spdk_nvmf_request_get_subsystem(struct spdk_nvmf_request *req) 5133 { 5134 return req->qpair->ctrlr->subsys; 5135 } 5136 5137 size_t 5138 spdk_nvmf_request_copy_from_buf(struct spdk_nvmf_request *req, 5139 void *buf, size_t buflen) 5140 { 5141 struct spdk_iov_xfer ix; 5142 5143 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 5144 return spdk_iov_xfer_from_buf(&ix, buf, buflen); 5145 } 5146 5147 size_t 5148 spdk_nvmf_request_copy_to_buf(struct spdk_nvmf_request *req, 5149 void *buf, size_t buflen) 5150 { 5151 struct spdk_iov_xfer ix; 5152 5153 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 5154 return spdk_iov_xfer_to_buf(&ix, buf, buflen); 5155 } 5156 5157 struct spdk_nvmf_subsystem *spdk_nvmf_ctrlr_get_subsystem(struct spdk_nvmf_ctrlr *ctrlr) 5158 { 5159 return ctrlr->subsys; 5160 } 5161 5162 uint16_t 5163 spdk_nvmf_ctrlr_get_id(struct spdk_nvmf_ctrlr *ctrlr) 5164 { 5165 return ctrlr->cntlid; 5166 } 5167 5168 struct spdk_nvmf_request *spdk_nvmf_request_get_req_to_abort(struct spdk_nvmf_request *req) 5169 { 5170 return req->req_to_abort; 5171 } 5172