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