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 1954 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 1955 spdk_iov_xfer_from_buf(&ix, &host_behavior, sizeof(host_behavior)); 1956 1957 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1958 } 1959 1960 static int 1961 nvmf_ctrlr_set_features_host_behavior_support(struct spdk_nvmf_request *req) 1962 { 1963 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1964 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1965 struct spdk_nvme_host_behavior *host_behavior; 1966 1967 SPDK_DEBUGLOG(nvmf, "Set Features - Host Behavior Support\n"); 1968 if (req->iovcnt != 1) { 1969 SPDK_ERRLOG("Host Behavior Support invalid iovcnt: %d\n", req->iovcnt); 1970 response->status.sct = SPDK_NVME_SCT_GENERIC; 1971 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1972 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1973 } 1974 if (req->iov[0].iov_len != sizeof(struct spdk_nvme_host_behavior)) { 1975 SPDK_ERRLOG("Host Behavior Support invalid iov_len: %zd\n", req->iov[0].iov_len); 1976 response->status.sct = SPDK_NVME_SCT_GENERIC; 1977 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1978 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1979 } 1980 1981 host_behavior = (struct spdk_nvme_host_behavior *)req->iov[0].iov_base; 1982 if (host_behavior->acre == 0) { 1983 ctrlr->acre_enabled = false; 1984 } else if (host_behavior->acre == 1) { 1985 ctrlr->acre_enabled = true; 1986 } else { 1987 SPDK_ERRLOG("Host Behavior Support invalid acre: 0x%02x\n", host_behavior->acre); 1988 response->status.sct = SPDK_NVME_SCT_GENERIC; 1989 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1990 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1991 } 1992 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1993 } 1994 1995 static int 1996 nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 1997 { 1998 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1999 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2000 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2001 2002 SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 2003 2004 /* 2005 * if attempts to disable keep alive by setting kato to 0h 2006 * a status value of keep alive invalid shall be returned 2007 */ 2008 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato == 0) { 2009 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 2010 } else if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato < MIN_KEEP_ALIVE_TIMEOUT_IN_MS) { 2011 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT_IN_MS; 2012 } else { 2013 /* round up to milliseconds */ 2014 ctrlr->feat.keep_alive_timer.bits.kato = spdk_divide_round_up( 2015 cmd->cdw11_bits.feat_keep_alive_timer.bits.kato, 2016 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS) * 2017 KAS_DEFAULT_VALUE * KAS_TIME_UNIT_IN_MS; 2018 } 2019 2020 /* 2021 * if change the keep alive timeout value successfully 2022 * update the keep alive poller. 2023 */ 2024 if (cmd->cdw11_bits.feat_keep_alive_timer.bits.kato != 0) { 2025 if (ctrlr->keep_alive_poller != NULL) { 2026 spdk_poller_unregister(&ctrlr->keep_alive_poller); 2027 } 2028 ctrlr->keep_alive_poller = SPDK_POLLER_REGISTER(nvmf_ctrlr_keep_alive_poll, ctrlr, 2029 ctrlr->feat.keep_alive_timer.bits.kato * 1000); 2030 } 2031 2032 SPDK_DEBUGLOG(nvmf, "Set Features - Keep Alive Timer set to %u ms\n", 2033 ctrlr->feat.keep_alive_timer.bits.kato); 2034 2035 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2036 } 2037 2038 static int 2039 nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 2040 { 2041 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2042 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2043 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2044 uint32_t count; 2045 2046 SPDK_DEBUGLOG(nvmf, "Set Features - Number of Queues, cdw11 0x%x\n", 2047 req->cmd->nvme_cmd.cdw11); 2048 2049 if (cmd->cdw11_bits.feat_num_of_queues.bits.ncqr == UINT16_MAX || 2050 cmd->cdw11_bits.feat_num_of_queues.bits.nsqr == UINT16_MAX) { 2051 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2052 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2053 } 2054 2055 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 2056 /* verify that the controller is ready to process commands */ 2057 if (count > 1) { 2058 SPDK_DEBUGLOG(nvmf, "Queue pairs already active!\n"); 2059 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 2060 } else { 2061 /* 2062 * Ignore the value requested by the host - 2063 * always return the pre-configured value based on max_qpairs_allowed. 2064 */ 2065 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 2066 } 2067 2068 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2069 } 2070 2071 SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ctrlr) == 4928, 2072 "Please check migration fields that need to be added or not"); 2073 2074 static void 2075 nvmf_ctrlr_migr_data_copy(struct spdk_nvmf_ctrlr_migr_data *data, 2076 const struct spdk_nvmf_ctrlr_migr_data *data_src, size_t data_size) 2077 { 2078 assert(data); 2079 assert(data_src); 2080 assert(data_size); 2081 2082 memcpy(&data->regs, &data_src->regs, spdk_min(data->regs_size, data_src->regs_size)); 2083 memcpy(&data->feat, &data_src->feat, spdk_min(data->feat_size, data_src->feat_size)); 2084 2085 #define SET_FIELD(field) \ 2086 if (offsetof(struct spdk_nvmf_ctrlr_migr_data, field) + sizeof(data->field) <= data_size) { \ 2087 data->field = data_src->field; \ 2088 } \ 2089 2090 SET_FIELD(cntlid); 2091 SET_FIELD(acre); 2092 SET_FIELD(num_aer_cids); 2093 SET_FIELD(num_async_events); 2094 SET_FIELD(notice_aen_mask); 2095 #undef SET_FIELD 2096 2097 #define SET_ARRAY(arr) \ 2098 if (offsetof(struct spdk_nvmf_ctrlr_migr_data, arr) + sizeof(data->arr) <= data_size) { \ 2099 memcpy(&data->arr, &data_src->arr, sizeof(data->arr)); \ 2100 } \ 2101 2102 SET_ARRAY(async_events); 2103 SET_ARRAY(aer_cids); 2104 #undef SET_ARRAY 2105 } 2106 2107 int 2108 spdk_nvmf_ctrlr_save_migr_data(struct spdk_nvmf_ctrlr *ctrlr, 2109 struct spdk_nvmf_ctrlr_migr_data *data) 2110 { 2111 struct spdk_nvmf_async_event_completion *event, *event_tmp; 2112 uint32_t i; 2113 struct spdk_nvmf_ctrlr_migr_data data_local = { 2114 .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused), 2115 .regs_size = sizeof(struct spdk_nvmf_registers), 2116 .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat) 2117 }; 2118 2119 assert(data->data_size <= sizeof(data_local)); 2120 assert(spdk_get_thread() == ctrlr->thread); 2121 2122 memcpy(&data_local.regs, &ctrlr->vcprop, sizeof(struct spdk_nvmf_registers)); 2123 memcpy(&data_local.feat, &ctrlr->feat, sizeof(struct spdk_nvmf_ctrlr_feat)); 2124 2125 data_local.cntlid = ctrlr->cntlid; 2126 data_local.acre = ctrlr->acre_enabled; 2127 data_local.num_aer_cids = ctrlr->nr_aer_reqs; 2128 2129 STAILQ_FOREACH_SAFE(event, &ctrlr->async_events, link, event_tmp) { 2130 if (data_local.num_async_events + 1 > SPDK_NVMF_MIGR_MAX_PENDING_AERS) { 2131 SPDK_ERRLOG("ctrlr %p has too many pending AERs\n", ctrlr); 2132 break; 2133 } 2134 2135 data_local.async_events[data_local.num_async_events++].raw = event->event.raw; 2136 } 2137 2138 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 2139 struct spdk_nvmf_request *req = ctrlr->aer_req[i]; 2140 data_local.aer_cids[i] = req->cmd->nvme_cmd.cid; 2141 } 2142 data_local.notice_aen_mask = ctrlr->notice_aen_mask; 2143 2144 nvmf_ctrlr_migr_data_copy(data, &data_local, spdk_min(data->data_size, data_local.data_size)); 2145 return 0; 2146 } 2147 2148 int 2149 spdk_nvmf_ctrlr_restore_migr_data(struct spdk_nvmf_ctrlr *ctrlr, 2150 const struct spdk_nvmf_ctrlr_migr_data *data) 2151 { 2152 uint32_t i; 2153 struct spdk_nvmf_ctrlr_migr_data data_local = { 2154 .data_size = offsetof(struct spdk_nvmf_ctrlr_migr_data, unused), 2155 .regs_size = sizeof(struct spdk_nvmf_registers), 2156 .feat_size = sizeof(struct spdk_nvmf_ctrlr_feat) 2157 }; 2158 2159 assert(data->data_size <= sizeof(data_local)); 2160 assert(spdk_get_thread() == ctrlr->thread); 2161 2162 /* local version of data should have defaults set before copy */ 2163 nvmf_ctrlr_migr_data_copy(&data_local, data, spdk_min(data->data_size, data_local.data_size)); 2164 memcpy(&ctrlr->vcprop, &data_local.regs, sizeof(struct spdk_nvmf_registers)); 2165 memcpy(&ctrlr->feat, &data_local.feat, sizeof(struct spdk_nvmf_ctrlr_feat)); 2166 2167 ctrlr->cntlid = data_local.cntlid; 2168 ctrlr->acre_enabled = data_local.acre; 2169 2170 for (i = 0; i < data_local.num_async_events; i++) { 2171 struct spdk_nvmf_async_event_completion *event; 2172 2173 event = calloc(1, sizeof(*event)); 2174 if (!event) { 2175 return -ENOMEM; 2176 } 2177 2178 event->event.raw = data_local.async_events[i].raw; 2179 STAILQ_INSERT_TAIL(&ctrlr->async_events, event, link); 2180 } 2181 ctrlr->notice_aen_mask = data_local.notice_aen_mask; 2182 2183 return 0; 2184 } 2185 2186 static int 2187 nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 2188 { 2189 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2190 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2191 2192 SPDK_DEBUGLOG(nvmf, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 2193 cmd->cdw11); 2194 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 2195 ctrlr->feat.async_event_configuration.bits.reserved1 = 0; 2196 ctrlr->feat.async_event_configuration.bits.reserved2 = 0; 2197 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2198 } 2199 2200 static int 2201 nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 2202 { 2203 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2204 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 2205 struct spdk_nvmf_async_event_completion *pending_event; 2206 2207 SPDK_DEBUGLOG(nvmf, "Async Event Request\n"); 2208 2209 /* Four asynchronous events are supported for now */ 2210 if (ctrlr->nr_aer_reqs >= SPDK_NVMF_MAX_ASYNC_EVENTS) { 2211 SPDK_DEBUGLOG(nvmf, "AERL exceeded\n"); 2212 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 2213 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 2214 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2215 } 2216 2217 if (!STAILQ_EMPTY(&ctrlr->async_events)) { 2218 pending_event = STAILQ_FIRST(&ctrlr->async_events); 2219 rsp->cdw0 = pending_event->event.raw; 2220 STAILQ_REMOVE(&ctrlr->async_events, pending_event, spdk_nvmf_async_event_completion, link); 2221 free(pending_event); 2222 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2223 } 2224 2225 ctrlr->aer_req[ctrlr->nr_aer_reqs++] = req; 2226 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 2227 } 2228 2229 static void 2230 nvmf_get_firmware_slot_log_page(struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length) 2231 { 2232 struct spdk_nvme_firmware_page fw_page; 2233 size_t copy_len; 2234 struct spdk_iov_xfer ix; 2235 2236 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2237 2238 memset(&fw_page, 0, sizeof(fw_page)); 2239 fw_page.afi.active_slot = 1; 2240 fw_page.afi.next_reset_slot = 0; 2241 spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' '); 2242 2243 if (offset < sizeof(fw_page)) { 2244 copy_len = spdk_min(sizeof(fw_page) - offset, length); 2245 if (copy_len > 0) { 2246 spdk_iov_xfer_from_buf(&ix, (const char *)&fw_page + offset, copy_len); 2247 } 2248 } 2249 } 2250 2251 /* 2252 * Asynchronous Event Mask Bit 2253 */ 2254 enum spdk_nvme_async_event_mask_bit { 2255 /* Mask Namespace Change Notification */ 2256 SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT = 0, 2257 /* Mask Asymmetric Namespace Access Change Notification */ 2258 SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT = 1, 2259 /* Mask Discovery Log Change Notification */ 2260 SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT = 2, 2261 /* Mask Reservation Log Page Available Notification */ 2262 SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT = 3, 2263 /* Mask Error Event */ 2264 SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT = 4, 2265 /* 4 - 63 Reserved */ 2266 }; 2267 2268 static inline void 2269 nvmf_ctrlr_unmask_aen(struct spdk_nvmf_ctrlr *ctrlr, 2270 enum spdk_nvme_async_event_mask_bit mask) 2271 { 2272 ctrlr->notice_aen_mask &= ~(1 << mask); 2273 } 2274 2275 static inline bool 2276 nvmf_ctrlr_mask_aen(struct spdk_nvmf_ctrlr *ctrlr, 2277 enum spdk_nvme_async_event_mask_bit mask) 2278 { 2279 if (ctrlr->notice_aen_mask & (1 << mask)) { 2280 return false; 2281 } else { 2282 ctrlr->notice_aen_mask |= (1 << mask); 2283 return true; 2284 } 2285 } 2286 2287 /* we have to use the typedef in the function declaration to appease astyle. */ 2288 typedef enum spdk_nvme_ana_state spdk_nvme_ana_state_t; 2289 2290 static inline spdk_nvme_ana_state_t 2291 nvmf_ctrlr_get_ana_state(struct spdk_nvmf_ctrlr *ctrlr, uint32_t anagrpid) 2292 { 2293 if (!ctrlr->subsys->flags.ana_reporting) { 2294 return SPDK_NVME_ANA_OPTIMIZED_STATE; 2295 } 2296 2297 if (spdk_unlikely(ctrlr->listener == NULL)) { 2298 return SPDK_NVME_ANA_INACCESSIBLE_STATE; 2299 } 2300 2301 assert(anagrpid - 1 < ctrlr->subsys->max_nsid); 2302 return ctrlr->listener->ana_state[anagrpid - 1]; 2303 } 2304 2305 static spdk_nvme_ana_state_t 2306 nvmf_ctrlr_get_ana_state_from_nsid(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 2307 { 2308 struct spdk_nvmf_ns *ns; 2309 2310 /* We do not have NVM subsystem specific ANA state. Hence if NSID is either 2311 * SPDK_NVMF_GLOBAL_NS_TAG, invalid, or for inactive namespace, return 2312 * the optimized state. 2313 */ 2314 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 2315 if (ns == NULL) { 2316 return SPDK_NVME_ANA_OPTIMIZED_STATE; 2317 } 2318 2319 return nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 2320 } 2321 2322 static void 2323 nvmf_get_error_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2324 uint64_t offset, uint32_t length, uint32_t rae) 2325 { 2326 if (!rae) { 2327 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT); 2328 } 2329 2330 /* TODO: actually fill out log page data */ 2331 } 2332 2333 static void 2334 nvmf_get_ana_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2335 uint64_t offset, uint32_t length, uint32_t rae) 2336 { 2337 struct spdk_nvme_ana_page ana_hdr; 2338 struct spdk_nvme_ana_group_descriptor ana_desc; 2339 size_t copy_len, copied_len; 2340 uint32_t num_anagrp = 0, anagrpid; 2341 struct spdk_nvmf_ns *ns; 2342 struct spdk_iov_xfer ix; 2343 2344 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2345 2346 if (length == 0) { 2347 goto done; 2348 } 2349 2350 if (offset >= sizeof(ana_hdr)) { 2351 offset -= sizeof(ana_hdr); 2352 } else { 2353 for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) { 2354 if (ctrlr->subsys->ana_group[anagrpid - 1] > 0) { 2355 num_anagrp++; 2356 } 2357 } 2358 2359 memset(&ana_hdr, 0, sizeof(ana_hdr)); 2360 2361 ana_hdr.num_ana_group_desc = num_anagrp; 2362 /* TODO: Support Change Count. */ 2363 ana_hdr.change_count = 0; 2364 2365 copy_len = spdk_min(sizeof(ana_hdr) - offset, length); 2366 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_hdr + offset, copy_len); 2367 assert(copied_len == copy_len); 2368 length -= copied_len; 2369 offset = 0; 2370 } 2371 2372 if (length == 0) { 2373 goto done; 2374 } 2375 2376 for (anagrpid = 1; anagrpid <= ctrlr->subsys->max_nsid; anagrpid++) { 2377 if (ctrlr->subsys->ana_group[anagrpid - 1] == 0) { 2378 continue; 2379 } 2380 2381 if (offset >= sizeof(ana_desc)) { 2382 offset -= sizeof(ana_desc); 2383 } else { 2384 memset(&ana_desc, 0, sizeof(ana_desc)); 2385 2386 ana_desc.ana_group_id = anagrpid; 2387 ana_desc.num_of_nsid = ctrlr->subsys->ana_group[anagrpid - 1]; 2388 ana_desc.ana_state = nvmf_ctrlr_get_ana_state(ctrlr, anagrpid); 2389 2390 copy_len = spdk_min(sizeof(ana_desc) - offset, length); 2391 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ana_desc + offset, 2392 copy_len); 2393 assert(copied_len == copy_len); 2394 length -= copied_len; 2395 offset = 0; 2396 2397 if (length == 0) { 2398 goto done; 2399 } 2400 } 2401 2402 /* TODO: Revisit here about O(n^2) cost if we have subsystem with 2403 * many namespaces in the future. 2404 */ 2405 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL; 2406 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 2407 if (ns->anagrpid != anagrpid) { 2408 continue; 2409 } 2410 2411 if (offset >= sizeof(uint32_t)) { 2412 offset -= sizeof(uint32_t); 2413 continue; 2414 } 2415 2416 copy_len = spdk_min(sizeof(uint32_t) - offset, length); 2417 copied_len = spdk_iov_xfer_from_buf(&ix, (const char *)&ns->nsid + offset, 2418 copy_len); 2419 assert(copied_len == copy_len); 2420 length -= copied_len; 2421 offset = 0; 2422 2423 if (length == 0) { 2424 goto done; 2425 } 2426 } 2427 } 2428 2429 done: 2430 if (!rae) { 2431 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT); 2432 } 2433 } 2434 2435 void 2436 nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 2437 { 2438 uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list); 2439 uint16_t i; 2440 bool found = false; 2441 2442 for (i = 0; i < ctrlr->changed_ns_list_count; i++) { 2443 if (ctrlr->changed_ns_list.ns_list[i] == nsid) { 2444 /* nsid is already in the list */ 2445 found = true; 2446 break; 2447 } 2448 } 2449 2450 if (!found) { 2451 if (ctrlr->changed_ns_list_count == max_changes) { 2452 /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */ 2453 ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu; 2454 for (i = 1; i < max_changes; i++) { 2455 ctrlr->changed_ns_list.ns_list[i] = 0; 2456 } 2457 } else { 2458 ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid; 2459 } 2460 } 2461 } 2462 2463 static void 2464 nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr, 2465 struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae) 2466 { 2467 size_t copy_length; 2468 struct spdk_iov_xfer ix; 2469 2470 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2471 2472 if (offset < sizeof(ctrlr->changed_ns_list)) { 2473 copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset); 2474 if (copy_length) { 2475 spdk_iov_xfer_from_buf(&ix, (char *)&ctrlr->changed_ns_list + offset, copy_length); 2476 } 2477 } 2478 2479 /* Clear log page each time it is read */ 2480 ctrlr->changed_ns_list_count = 0; 2481 memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list)); 2482 2483 if (!rae) { 2484 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT); 2485 } 2486 } 2487 2488 /* The structure can be modified if we provide support for other commands in future */ 2489 static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = { 2490 .admin_cmds_supported = { 2491 /* CSUPP, LBCC, NCC, NIC, CCC, CSE */ 2492 /* Get Log Page */ 2493 [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2494 /* Identify */ 2495 [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0}, 2496 /* Abort */ 2497 [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0}, 2498 /* Set Features */ 2499 [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 2500 /* Get Features */ 2501 [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 2502 /* Async Event Request */ 2503 [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0}, 2504 /* Keep Alive */ 2505 [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2506 }, 2507 .io_cmds_supported = { 2508 /* FLUSH */ 2509 [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0}, 2510 /* WRITE */ 2511 [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0}, 2512 /* READ */ 2513 [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0}, 2514 /* WRITE ZEROES */ 2515 [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0}, 2516 /* DATASET MANAGEMENT */ 2517 [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0}, 2518 /* COMPARE */ 2519 [SPDK_NVME_OPC_COMPARE] = {1, 0, 0, 0, 0, 0, 0, 0}, 2520 /* ZONE MANAGEMENT SEND */ 2521 [SPDK_NVME_OPC_ZONE_MGMT_SEND] = {1, 1, 0, 0, 0, 0, 0, 0}, 2522 /* ZONE MANAGEMENT RECEIVE */ 2523 [SPDK_NVME_OPC_ZONE_MGMT_RECV] = {1, 0, 0, 0, 0, 0, 0, 0}, 2524 /* ZONE APPEND */ 2525 [SPDK_NVME_OPC_ZONE_APPEND] = {1, 1, 0, 0, 0, 0, 0, 0}, 2526 /* COPY */ 2527 [SPDK_NVME_OPC_COPY] = {1, 1, 0, 0, 0, 0, 0, 0}, 2528 }, 2529 }; 2530 2531 static void 2532 nvmf_get_cmds_and_effects_log_page(struct spdk_nvmf_ctrlr *ctrlr, struct iovec *iovs, int iovcnt, 2533 uint64_t offset, uint32_t length) 2534 { 2535 uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page); 2536 size_t copy_len = 0; 2537 struct spdk_nvme_cmds_and_effect_log_page cmds_and_effect_log_page = g_cmds_and_effect_log_page; 2538 struct spdk_nvme_cmds_and_effect_entry zero = {}; 2539 struct spdk_iov_xfer ix; 2540 2541 if (!ctrlr->cdata.oncs.write_zeroes || !nvmf_ctrlr_write_zeroes_supported(ctrlr)) { 2542 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_WRITE_ZEROES] = zero; 2543 } 2544 if (!ctrlr->cdata.oncs.dsm || !nvmf_ctrlr_dsm_supported(ctrlr)) { 2545 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_DATASET_MANAGEMENT] = zero; 2546 } 2547 if (!ctrlr->cdata.oncs.compare) { 2548 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COMPARE] = zero; 2549 } 2550 if (!nvmf_subsystem_has_zns_iocs(ctrlr->subsys)) { 2551 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_SEND] = zero; 2552 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_MGMT_RECV] = zero; 2553 } 2554 if (!nvmf_subsystem_zone_append_supported(ctrlr->subsys)) { 2555 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_ZONE_APPEND] = zero; 2556 } 2557 if (!ctrlr->cdata.oncs.copy) { 2558 cmds_and_effect_log_page.io_cmds_supported[SPDK_NVME_OPC_COPY] = zero; 2559 } 2560 2561 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2562 if (offset < page_size) { 2563 copy_len = spdk_min(page_size - offset, length); 2564 spdk_iov_xfer_from_buf(&ix, (char *)(&cmds_and_effect_log_page) + offset, copy_len); 2565 } 2566 } 2567 2568 static void 2569 nvmf_get_reservation_notification_log_page(struct spdk_nvmf_ctrlr *ctrlr, 2570 struct iovec *iovs, int iovcnt, uint64_t offset, uint32_t length, uint32_t rae) 2571 { 2572 uint32_t unit_log_len, avail_log_len, next_pos, copy_len; 2573 struct spdk_nvmf_reservation_log *log, *log_tmp; 2574 struct spdk_iov_xfer ix; 2575 2576 spdk_iov_xfer_init(&ix, iovs, iovcnt); 2577 2578 unit_log_len = sizeof(struct spdk_nvme_reservation_notification_log); 2579 /* No available log, return zeroed log pages */ 2580 if (!ctrlr->num_avail_log_pages) { 2581 return; 2582 } 2583 2584 avail_log_len = ctrlr->num_avail_log_pages * unit_log_len; 2585 if (offset >= avail_log_len) { 2586 return; 2587 } 2588 2589 next_pos = 0; 2590 TAILQ_FOREACH_SAFE(log, &ctrlr->log_head, link, log_tmp) { 2591 TAILQ_REMOVE(&ctrlr->log_head, log, link); 2592 ctrlr->num_avail_log_pages--; 2593 2594 next_pos += unit_log_len; 2595 if (next_pos > offset) { 2596 copy_len = spdk_min(next_pos - offset, length); 2597 spdk_iov_xfer_from_buf(&ix, &log->log, copy_len); 2598 length -= copy_len; 2599 offset += copy_len; 2600 } 2601 free(log); 2602 2603 if (length == 0) { 2604 break; 2605 } 2606 } 2607 2608 if (!rae) { 2609 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT); 2610 } 2611 return; 2612 } 2613 2614 static int 2615 nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 2616 { 2617 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 2618 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2619 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 2620 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 2621 struct spdk_nvme_transport_id cmd_source_trid; 2622 uint64_t offset, len; 2623 uint32_t rae, numdl, numdu; 2624 uint8_t lid; 2625 2626 if (req->iovcnt < 1) { 2627 SPDK_DEBUGLOG(nvmf, "get log command with no buffer\n"); 2628 response->status.sct = SPDK_NVME_SCT_GENERIC; 2629 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2630 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2631 } 2632 2633 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 2634 if (offset & 3) { 2635 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 2636 response->status.sct = SPDK_NVME_SCT_GENERIC; 2637 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2638 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2639 } 2640 2641 rae = cmd->cdw10_bits.get_log_page.rae; 2642 numdl = cmd->cdw10_bits.get_log_page.numdl; 2643 numdu = cmd->cdw11_bits.get_log_page.numdu; 2644 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 2645 if (len > req->length) { 2646 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 2647 len, req->length); 2648 response->status.sct = SPDK_NVME_SCT_GENERIC; 2649 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2650 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2651 } 2652 2653 lid = cmd->cdw10_bits.get_log_page.lid; 2654 SPDK_DEBUGLOG(nvmf, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 " rae=%u\n", 2655 lid, offset, len, rae); 2656 2657 if (spdk_nvmf_subsystem_is_discovery(subsystem)) { 2658 switch (lid) { 2659 case SPDK_NVME_LOG_DISCOVERY: 2660 if (spdk_nvmf_qpair_get_listen_trid(req->qpair, &cmd_source_trid)) { 2661 SPDK_ERRLOG("Failed to get LOG_DISCOVERY source trid\n"); 2662 response->status.sct = SPDK_NVME_SCT_GENERIC; 2663 response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 2664 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2665 } 2666 nvmf_get_discovery_log_page(subsystem->tgt, ctrlr->hostnqn, req->iov, req->iovcnt, 2667 offset, len, &cmd_source_trid); 2668 if (!rae) { 2669 nvmf_ctrlr_unmask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT); 2670 } 2671 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2672 default: 2673 goto invalid_log_page; 2674 } 2675 } else { 2676 if (offset > len) { 2677 SPDK_ERRLOG("Get log page: offset (%" PRIu64 ") > len (%" PRIu64 ")\n", 2678 offset, len); 2679 response->status.sct = SPDK_NVME_SCT_GENERIC; 2680 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2681 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2682 } 2683 2684 switch (lid) { 2685 case SPDK_NVME_LOG_ERROR: 2686 nvmf_get_error_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2687 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2688 case SPDK_NVME_LOG_HEALTH_INFORMATION: 2689 /* TODO: actually fill out log page data */ 2690 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2691 case SPDK_NVME_LOG_FIRMWARE_SLOT: 2692 nvmf_get_firmware_slot_log_page(req->iov, req->iovcnt, offset, len); 2693 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2694 case SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS: 2695 if (subsystem->flags.ana_reporting) { 2696 nvmf_get_ana_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2697 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2698 } else { 2699 goto invalid_log_page; 2700 } 2701 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 2702 nvmf_get_cmds_and_effects_log_page(ctrlr, req->iov, req->iovcnt, offset, len); 2703 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2704 case SPDK_NVME_LOG_CHANGED_NS_LIST: 2705 nvmf_get_changed_ns_list_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2706 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2707 case SPDK_NVME_LOG_RESERVATION_NOTIFICATION: 2708 nvmf_get_reservation_notification_log_page(ctrlr, req->iov, req->iovcnt, offset, len, rae); 2709 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2710 default: 2711 goto invalid_log_page; 2712 } 2713 } 2714 2715 invalid_log_page: 2716 SPDK_INFOLOG(nvmf, "Unsupported Get Log Page 0x%02X\n", lid); 2717 response->status.sct = SPDK_NVME_SCT_GENERIC; 2718 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 2719 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2720 } 2721 2722 static struct spdk_nvmf_ns * 2723 _nvmf_ctrlr_get_ns_safe(struct spdk_nvmf_ctrlr *ctrlr, 2724 uint32_t nsid, 2725 struct spdk_nvme_cpl *rsp) 2726 { 2727 struct spdk_nvmf_ns *ns; 2728 if (nsid == 0 || nsid > ctrlr->subsys->max_nsid) { 2729 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", nsid); 2730 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2731 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 2732 return NULL; 2733 } 2734 2735 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 2736 if (ns == NULL || ns->bdev == NULL) { 2737 /* 2738 * Inactive namespaces should return a zero filled data structure. 2739 * The data buffer is already zeroed by nvmf_ctrlr_process_admin_cmd(), 2740 * so we can just return early here. 2741 */ 2742 SPDK_DEBUGLOG(nvmf, "Identify Namespace for inactive NSID %u\n", nsid); 2743 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2744 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 2745 return NULL; 2746 } 2747 return ns; 2748 } 2749 2750 int 2751 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr, 2752 struct spdk_nvme_cmd *cmd, 2753 struct spdk_nvme_cpl *rsp, 2754 struct spdk_nvme_ns_data *nsdata) 2755 { 2756 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2757 struct spdk_nvmf_ns *ns; 2758 uint32_t max_num_blocks, format_index; 2759 enum spdk_nvme_ana_state ana_state; 2760 2761 ns = _nvmf_ctrlr_get_ns_safe(ctrlr, cmd->nsid, rsp); 2762 if (ns == NULL) { 2763 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2764 } 2765 2766 nvmf_bdev_ctrlr_identify_ns(ns, nsdata, ctrlr->dif_insert_or_strip); 2767 2768 assert(ctrlr->admin_qpair); 2769 2770 format_index = spdk_nvme_ns_get_format_index(nsdata); 2771 2772 /* Due to bug in the Linux kernel NVMe driver we have to set noiob no larger than mdts */ 2773 max_num_blocks = ctrlr->admin_qpair->transport->opts.max_io_size / 2774 (1U << nsdata->lbaf[format_index].lbads); 2775 if (nsdata->noiob > max_num_blocks) { 2776 nsdata->noiob = max_num_blocks; 2777 } 2778 2779 /* Set NOWS equal to Controller MDTS */ 2780 if (nsdata->nsfeat.optperf) { 2781 nsdata->nows = max_num_blocks - 1; 2782 } 2783 2784 if (subsystem->flags.ana_reporting) { 2785 assert(ns->anagrpid - 1 < subsystem->max_nsid); 2786 nsdata->anagrpid = ns->anagrpid; 2787 2788 ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 2789 if (ana_state == SPDK_NVME_ANA_INACCESSIBLE_STATE || 2790 ana_state == SPDK_NVME_ANA_PERSISTENT_LOSS_STATE) { 2791 nsdata->nuse = 0; 2792 } 2793 } 2794 2795 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2796 } 2797 2798 static void 2799 nvmf_ctrlr_populate_oacs(struct spdk_nvmf_ctrlr *ctrlr, 2800 struct spdk_nvme_ctrlr_data *cdata) 2801 { 2802 cdata->oacs = ctrlr->cdata.oacs; 2803 2804 cdata->oacs.virtualization_management = 2805 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT].hdlr != NULL; 2806 cdata->oacs.nvme_mi = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_SEND].hdlr != NULL 2807 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NVME_MI_RECEIVE].hdlr != NULL; 2808 cdata->oacs.directives = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_SEND].hdlr != NULL 2809 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DIRECTIVE_RECEIVE].hdlr != NULL; 2810 cdata->oacs.device_self_test = 2811 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_DEVICE_SELF_TEST].hdlr != NULL; 2812 cdata->oacs.ns_manage = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_MANAGEMENT].hdlr != NULL 2813 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_NS_ATTACHMENT].hdlr != NULL; 2814 cdata->oacs.firmware = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD].hdlr != 2815 NULL 2816 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FIRMWARE_COMMIT].hdlr != NULL; 2817 cdata->oacs.format = 2818 g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_FORMAT_NVM].hdlr != NULL; 2819 cdata->oacs.security = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_SEND].hdlr != NULL 2820 && g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_SECURITY_RECEIVE].hdlr != NULL; 2821 cdata->oacs.get_lba_status = g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_GET_LBA_STATUS].hdlr != 2822 NULL; 2823 } 2824 2825 int 2826 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 2827 { 2828 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 2829 struct spdk_nvmf_transport *transport; 2830 2831 /* 2832 * Common fields for discovery and NVM subsystems 2833 */ 2834 assert(ctrlr->admin_qpair); 2835 transport = ctrlr->admin_qpair->transport; 2836 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 2837 assert((transport->opts.max_io_size % 4096) == 0); 2838 cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096); 2839 cdata->cntlid = ctrlr->cntlid; 2840 cdata->ver = ctrlr->vcprop.vs; 2841 cdata->aerl = ctrlr->cdata.aerl; 2842 cdata->lpa.edlp = 1; 2843 cdata->elpe = 127; 2844 cdata->maxcmd = transport->opts.max_queue_depth; 2845 cdata->sgls = ctrlr->cdata.sgls; 2846 cdata->fuses = ctrlr->cdata.fuses; 2847 cdata->acwu = 0; /* ACWU is 0-based. */ 2848 if (subsystem->flags.ana_reporting) { 2849 cdata->mnan = subsystem->max_nsid; 2850 } 2851 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 2852 2853 SPDK_DEBUGLOG(nvmf, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 2854 SPDK_DEBUGLOG(nvmf, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 2855 2856 2857 if (spdk_nvmf_subsystem_is_discovery(subsystem)) { 2858 /* 2859 * NVM Discovery subsystem fields 2860 */ 2861 cdata->oaes.discovery_log_change_notices = 1; 2862 cdata->cntrltype = SPDK_NVME_CTRLR_DISCOVERY; 2863 } else { 2864 cdata->vid = ctrlr->cdata.vid; 2865 cdata->ssvid = ctrlr->cdata.ssvid; 2866 cdata->ieee[0] = ctrlr->cdata.ieee[0]; 2867 cdata->ieee[1] = ctrlr->cdata.ieee[1]; 2868 cdata->ieee[2] = ctrlr->cdata.ieee[2]; 2869 2870 /* 2871 * NVM subsystem fields (reserved for discovery subsystems) 2872 */ 2873 spdk_strcpy_pad(cdata->mn, spdk_nvmf_subsystem_get_mn(subsystem), sizeof(cdata->mn), ' '); 2874 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 2875 cdata->kas = ctrlr->cdata.kas; 2876 2877 cdata->rab = 6; 2878 cdata->cmic.multi_port = 1; 2879 cdata->cmic.multi_ctrlr = 1; 2880 cdata->oaes.ns_attribute_notices = 1; 2881 cdata->ctratt.bits.host_id_exhid_supported = 1; 2882 cdata->ctratt.bits.fdps = ctrlr->subsys->fdp_supported; 2883 cdata->cntrltype = SPDK_NVME_CTRLR_IO; 2884 /* We do not have any actual limitation to the number of abort commands. 2885 * We follow the recommendation by the NVMe specification. 2886 */ 2887 cdata->acl = NVMF_ABORT_COMMAND_LIMIT; 2888 cdata->frmw.slot1_ro = 1; 2889 cdata->frmw.num_slots = 1; 2890 2891 cdata->lpa.celp = 1; /* Command Effects log page supported */ 2892 2893 cdata->sqes.min = 6; 2894 cdata->sqes.max = 6; 2895 cdata->cqes.min = 4; 2896 cdata->cqes.max = 4; 2897 cdata->nn = subsystem->max_nsid; 2898 cdata->vwc.present = 1; 2899 cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED; 2900 2901 cdata->nvmf_specific = ctrlr->cdata.nvmf_specific; 2902 2903 cdata->oncs.compare = ctrlr->cdata.oncs.compare; 2904 cdata->oncs.dsm = ctrlr->cdata.oncs.dsm && nvmf_ctrlr_dsm_supported(ctrlr); 2905 cdata->oncs.write_zeroes = ctrlr->cdata.oncs.write_zeroes && 2906 nvmf_ctrlr_write_zeroes_supported(ctrlr); 2907 cdata->oncs.reservations = ctrlr->cdata.oncs.reservations; 2908 cdata->oncs.copy = ctrlr->cdata.oncs.copy; 2909 cdata->ocfs.copy_format0 = cdata->oncs.copy; 2910 if (subsystem->flags.ana_reporting) { 2911 /* Asymmetric Namespace Access Reporting is supported. */ 2912 cdata->cmic.ana_reporting = 1; 2913 cdata->oaes.ana_change_notices = 1; 2914 2915 cdata->anatt = ANA_TRANSITION_TIME_IN_SEC; 2916 /* ANA Change state is not used, and ANA Persistent Loss state 2917 * is not supported for now. 2918 */ 2919 cdata->anacap.ana_optimized_state = 1; 2920 cdata->anacap.ana_non_optimized_state = 1; 2921 cdata->anacap.ana_inaccessible_state = 1; 2922 /* ANAGRPID does not change while namespace is attached to controller */ 2923 cdata->anacap.no_change_anagrpid = 1; 2924 cdata->anagrpmax = subsystem->max_nsid; 2925 cdata->nanagrpid = subsystem->max_nsid; 2926 } 2927 2928 nvmf_ctrlr_populate_oacs(ctrlr, cdata); 2929 2930 assert(subsystem->tgt != NULL); 2931 cdata->crdt[0] = subsystem->tgt->crdt[0]; 2932 cdata->crdt[1] = subsystem->tgt->crdt[1]; 2933 cdata->crdt[2] = subsystem->tgt->crdt[2]; 2934 2935 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ioccsz 0x%x\n", 2936 cdata->nvmf_specific.ioccsz); 2937 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: iorcsz 0x%x\n", 2938 cdata->nvmf_specific.iorcsz); 2939 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: icdoff 0x%x\n", 2940 cdata->nvmf_specific.icdoff); 2941 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: ctrattr 0x%x\n", 2942 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 2943 SPDK_DEBUGLOG(nvmf, "ext ctrlr data: msdbd 0x%x\n", 2944 cdata->nvmf_specific.msdbd); 2945 } 2946 2947 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2948 } 2949 2950 static int 2951 nvmf_ns_identify_iocs_zns(struct spdk_nvmf_ns *ns, 2952 struct spdk_nvme_cmd *cmd, 2953 struct spdk_nvme_cpl *rsp, 2954 struct spdk_nvme_zns_ns_data *nsdata_zns) 2955 { 2956 nsdata_zns->zoc.variable_zone_capacity = 0; 2957 nsdata_zns->zoc.zone_active_excursions = 0; 2958 nsdata_zns->ozcs.read_across_zone_boundaries = 1; 2959 /* Underflowing the zero based mar and mor bdev helper results in the correct 2960 value of FFFFFFFFh. */ 2961 nsdata_zns->mar = spdk_bdev_get_max_active_zones(ns->bdev) - 1; 2962 nsdata_zns->mor = spdk_bdev_get_max_open_zones(ns->bdev) - 1; 2963 nsdata_zns->rrl = 0; 2964 nsdata_zns->frl = 0; 2965 nsdata_zns->lbafe[0].zsze = spdk_bdev_get_zone_size(ns->bdev); 2966 2967 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2968 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 2969 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2970 } 2971 2972 int 2973 spdk_nvmf_ns_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr, 2974 struct spdk_nvme_cmd *cmd, 2975 struct spdk_nvme_cpl *rsp, 2976 void *nsdata, 2977 size_t nsdata_size) 2978 { 2979 uint8_t csi = cmd->cdw11_bits.identify.csi; 2980 struct spdk_nvmf_ns *ns = _nvmf_ctrlr_get_ns_safe(ctrlr, cmd->nsid, rsp); 2981 2982 memset(nsdata, 0, nsdata_size); 2983 2984 if (ns == NULL) { 2985 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 2986 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 2987 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 2988 } 2989 2990 switch (csi) { 2991 case SPDK_NVME_CSI_ZNS: 2992 return nvmf_ns_identify_iocs_zns(ns, cmd, rsp, nsdata); 2993 default: 2994 break; 2995 } 2996 2997 SPDK_DEBUGLOG(nvmf, 2998 "Returning zero filled struct for the iocs specific ns " 2999 "identify command and CSI 0x%02x\n", 3000 csi); 3001 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3002 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3003 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3004 } 3005 3006 static int 3007 nvmf_ctrlr_identify_iocs_nvm(struct spdk_nvmf_ctrlr *ctrlr, 3008 struct spdk_nvme_cmd *cmd, 3009 struct spdk_nvme_cpl *rsp, 3010 struct spdk_nvme_nvm_ctrlr_data *cdata_nvm) 3011 { 3012 /* The unit of max_write_zeroes_size_kib is KiB. 3013 * The unit of wzsl is the minimum memory page size(2 ^ (12 + CAP.MPSMIN) bytes) 3014 * and is reported as a power of two (2^n). 3015 */ 3016 cdata_nvm->wzsl = spdk_u64log2(ctrlr->subsys->max_write_zeroes_size_kib >> 3017 (2 + ctrlr->vcprop.cap.bits.mpsmin)); 3018 3019 /* The unit of max_discard_size_kib is KiB. 3020 * The dmrsl indicates the maximum number of logical blocks for 3021 * dataset management command. 3022 */ 3023 cdata_nvm->dmrsl = ctrlr->subsys->max_discard_size_kib << 1; 3024 cdata_nvm->dmrl = 1; 3025 3026 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3027 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3028 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3029 } 3030 3031 static int 3032 nvmf_ctrlr_identify_iocs_zns(struct spdk_nvmf_ctrlr *ctrlr, 3033 struct spdk_nvme_cmd *cmd, 3034 struct spdk_nvme_cpl *rsp, 3035 struct spdk_nvme_zns_ctrlr_data *cdata_zns) 3036 { 3037 /* The unit of max_zone_append_size_kib is KiB. 3038 The unit of zasl is the minimum memory page size 3039 (2 ^ (12 + CAP.MPSMIN) KiB) 3040 and is reported as a power of two (2^n). */ 3041 cdata_zns->zasl = spdk_u64log2(ctrlr->subsys->max_zone_append_size_kib >> 3042 (12 + ctrlr->vcprop.cap.bits.mpsmin)); 3043 3044 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3045 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3046 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3047 } 3048 3049 int 3050 spdk_nvmf_ctrlr_identify_iocs_specific(struct spdk_nvmf_ctrlr *ctrlr, 3051 struct spdk_nvme_cmd *cmd, 3052 struct spdk_nvme_cpl *rsp, 3053 void *cdata, 3054 size_t cdata_size) 3055 { 3056 uint8_t csi = cmd->cdw11_bits.identify.csi; 3057 3058 memset(cdata, 0, cdata_size); 3059 3060 switch (csi) { 3061 case SPDK_NVME_CSI_NVM: 3062 return nvmf_ctrlr_identify_iocs_nvm(ctrlr, cmd, rsp, cdata); 3063 case SPDK_NVME_CSI_ZNS: 3064 return nvmf_ctrlr_identify_iocs_zns(ctrlr, cmd, rsp, cdata); 3065 default: 3066 break; 3067 } 3068 3069 SPDK_DEBUGLOG(nvmf, 3070 "Returning zero filled struct for the iocs specific ctrlr " 3071 "identify command and CSI 0x%02x\n", 3072 csi); 3073 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3074 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3075 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3076 } 3077 3078 static int 3079 nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_ctrlr *ctrlr, 3080 struct spdk_nvme_cmd *cmd, 3081 struct spdk_nvme_cpl *rsp, 3082 struct spdk_nvme_ns_list *ns_list) 3083 { 3084 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 3085 struct spdk_nvmf_ns *ns; 3086 uint32_t count = 0; 3087 3088 if (cmd->nsid >= 0xfffffffeUL) { 3089 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 3090 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 3091 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3092 } 3093 3094 memset(ns_list, 0, sizeof(*ns_list)); 3095 3096 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 3097 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 3098 if (ns->opts.nsid <= cmd->nsid || !nvmf_ctrlr_ns_is_visible(ctrlr, ns->opts.nsid)) { 3099 continue; 3100 } 3101 3102 ns_list->ns_list[count++] = ns->opts.nsid; 3103 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 3104 break; 3105 } 3106 } 3107 3108 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3109 } 3110 3111 static void 3112 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 3113 enum spdk_nvme_nidt type, 3114 const void *data, size_t data_size) 3115 { 3116 struct spdk_nvme_ns_id_desc *desc; 3117 size_t desc_size = sizeof(*desc) + data_size; 3118 3119 /* 3120 * These should never fail in practice, since all valid NS ID descriptors 3121 * should be defined so that they fit in the available 4096-byte buffer. 3122 */ 3123 assert(data_size > 0); 3124 assert(data_size <= UINT8_MAX); 3125 assert(desc_size < *buf_remain); 3126 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 3127 return; 3128 } 3129 3130 desc = *buf_ptr; 3131 desc->nidt = type; 3132 desc->nidl = data_size; 3133 memcpy(desc->nid, data, data_size); 3134 3135 *buf_ptr += desc_size; 3136 *buf_remain -= desc_size; 3137 } 3138 3139 static int 3140 nvmf_ctrlr_identify_ns_id_descriptor_list( 3141 struct spdk_nvmf_ctrlr *ctrlr, 3142 struct spdk_nvme_cmd *cmd, 3143 struct spdk_nvme_cpl *rsp, 3144 void *id_desc_list, size_t id_desc_list_size) 3145 { 3146 struct spdk_nvmf_ns *ns; 3147 size_t buf_remain = id_desc_list_size; 3148 void *buf_ptr = id_desc_list; 3149 3150 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 3151 if (ns == NULL || ns->bdev == NULL) { 3152 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3153 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 3154 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3155 } 3156 3157 #define ADD_ID_DESC(type, data, size) \ 3158 do { \ 3159 if (!spdk_mem_all_zero(data, size)) { \ 3160 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 3161 } \ 3162 } while (0) 3163 3164 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 3165 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 3166 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 3167 ADD_ID_DESC(SPDK_NVME_NIDT_CSI, &ns->csi, sizeof(uint8_t)); 3168 3169 /* 3170 * The list is automatically 0-terminated, both in the temporary buffer 3171 * used by nvmf_ctrlr_identify(), and the eventual iov destination - 3172 * controller to host buffers in admin commands always get zeroed in 3173 * nvmf_ctrlr_process_admin_cmd(). 3174 */ 3175 3176 #undef ADD_ID_DESC 3177 3178 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3179 } 3180 3181 static int 3182 nvmf_ctrlr_identify_iocs(struct spdk_nvmf_ctrlr *ctrlr, 3183 struct spdk_nvme_cmd *cmd, 3184 struct spdk_nvme_cpl *rsp, 3185 void *cdata, size_t cdata_size) 3186 { 3187 struct spdk_nvme_iocs_vector *vector; 3188 struct spdk_nvmf_ns *ns; 3189 3190 if (cdata_size < sizeof(struct spdk_nvme_iocs_vector)) { 3191 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3192 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3193 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3194 } 3195 3196 /* For now we only support this command sent to the current 3197 * controller. 3198 */ 3199 if (cmd->cdw10_bits.identify.cntid != 0xFFFF && 3200 cmd->cdw10_bits.identify.cntid != ctrlr->cntlid) { 3201 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3202 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3203 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3204 } 3205 memset(cdata, 0, cdata_size); 3206 3207 vector = cdata; 3208 vector->nvm = 1; 3209 for (ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); ns != NULL; 3210 ns = spdk_nvmf_subsystem_get_next_ns(ctrlr->subsys, ns)) { 3211 if (ns->bdev == NULL) { 3212 continue; 3213 } 3214 if (spdk_bdev_is_zoned(ns->bdev)) { 3215 vector->zns = 1; 3216 } 3217 } 3218 3219 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3220 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3221 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3222 } 3223 3224 static int 3225 nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 3226 { 3227 uint8_t cns; 3228 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3229 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3230 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3231 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 3232 int ret = SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3233 char tmpbuf[SPDK_NVME_IDENTIFY_BUFLEN] = ""; 3234 struct spdk_iov_xfer ix; 3235 3236 if (req->iovcnt < 1 || req->length < SPDK_NVME_IDENTIFY_BUFLEN) { 3237 SPDK_DEBUGLOG(nvmf, "identify command with invalid buffer\n"); 3238 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3239 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3240 return ret; 3241 } 3242 3243 cns = cmd->cdw10_bits.identify.cns; 3244 3245 if (spdk_nvmf_subsystem_is_discovery(subsystem) && 3246 cns != SPDK_NVME_IDENTIFY_CTRLR) { 3247 /* Discovery controllers only support Identify Controller */ 3248 goto invalid_cns; 3249 } 3250 3251 /* 3252 * We must use a temporary buffer: it's entirely possible the out buffer 3253 * is split across more than one IOV. 3254 */ 3255 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 3256 3257 SPDK_DEBUGLOG(nvmf, "Received identify command with CNS 0x%02x\n", cns); 3258 3259 switch (cns) { 3260 case SPDK_NVME_IDENTIFY_NS: 3261 ret = spdk_nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, (void *)&tmpbuf); 3262 break; 3263 case SPDK_NVME_IDENTIFY_CTRLR: 3264 ret = spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, (void *)&tmpbuf); 3265 break; 3266 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 3267 ret = nvmf_ctrlr_identify_active_ns_list(ctrlr, cmd, rsp, (void *)&tmpbuf); 3268 break; 3269 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 3270 ret = nvmf_ctrlr_identify_ns_id_descriptor_list(ctrlr, cmd, rsp, 3271 tmpbuf, req->length); 3272 break; 3273 case SPDK_NVME_IDENTIFY_NS_IOCS: 3274 ret = spdk_nvmf_ns_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3275 break; 3276 case SPDK_NVME_IDENTIFY_CTRLR_IOCS: 3277 ret = spdk_nvmf_ctrlr_identify_iocs_specific(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3278 break; 3279 case SPDK_NVME_IDENTIFY_IOCS: 3280 ret = nvmf_ctrlr_identify_iocs(ctrlr, cmd, rsp, (void *)&tmpbuf, req->length); 3281 break; 3282 default: 3283 goto invalid_cns; 3284 } 3285 3286 if (ret == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 3287 spdk_iov_xfer_from_buf(&ix, tmpbuf, sizeof(tmpbuf)); 3288 } 3289 3290 return ret; 3291 3292 invalid_cns: 3293 SPDK_DEBUGLOG(nvmf, "Identify command with unsupported CNS 0x%02x\n", cns); 3294 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3295 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3296 return ret; 3297 } 3298 3299 static bool 3300 nvmf_qpair_abort_aer(struct spdk_nvmf_qpair *qpair, uint16_t cid) 3301 { 3302 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 3303 struct spdk_nvmf_request *req; 3304 int i; 3305 3306 if (!nvmf_qpair_is_admin_queue(qpair)) { 3307 return false; 3308 } 3309 3310 assert(spdk_get_thread() == ctrlr->thread); 3311 3312 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 3313 if (ctrlr->aer_req[i]->cmd->nvme_cmd.cid == cid) { 3314 SPDK_DEBUGLOG(nvmf, "Aborting AER request\n"); 3315 req = ctrlr->aer_req[i]; 3316 ctrlr->aer_req[i] = NULL; 3317 ctrlr->nr_aer_reqs--; 3318 3319 /* Move the last req to the aborting position for making aer_reqs 3320 * in continuous 3321 */ 3322 if (i < ctrlr->nr_aer_reqs) { 3323 ctrlr->aer_req[i] = ctrlr->aer_req[ctrlr->nr_aer_reqs]; 3324 ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL; 3325 } 3326 3327 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3328 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 3329 _nvmf_request_complete(req); 3330 return true; 3331 } 3332 } 3333 3334 return false; 3335 } 3336 3337 void 3338 nvmf_qpair_abort_pending_zcopy_reqs(struct spdk_nvmf_qpair *qpair) 3339 { 3340 struct spdk_nvmf_request *req, *tmp; 3341 3342 TAILQ_FOREACH_SAFE(req, &qpair->outstanding, link, tmp) { 3343 if (req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE) { 3344 /* Zero-copy requests are kept on the outstanding queue from the moment 3345 * zcopy_start is sent until a zcopy_end callback is received. Therefore, 3346 * we can't remove them from the outstanding queue here, but need to rely on 3347 * the transport to do a zcopy_end to release their buffers and, in turn, 3348 * remove them from the queue. 3349 */ 3350 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3351 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 3352 nvmf_transport_req_free(req); 3353 } 3354 } 3355 } 3356 3357 static void 3358 nvmf_qpair_abort_request(struct spdk_nvmf_qpair *qpair, struct spdk_nvmf_request *req) 3359 { 3360 uint16_t cid = req->cmd->nvme_cmd.cdw10_bits.abort.cid; 3361 3362 if (nvmf_qpair_abort_aer(qpair, cid)) { 3363 SPDK_DEBUGLOG(nvmf, "abort ctrlr=%p sqid=%u cid=%u successful\n", 3364 qpair->ctrlr, qpair->qid, cid); 3365 req->rsp->nvme_cpl.cdw0 &= ~1U; /* Command successfully aborted */ 3366 3367 spdk_nvmf_request_complete(req); 3368 return; 3369 } 3370 3371 nvmf_transport_qpair_abort_request(qpair, req); 3372 } 3373 3374 static void 3375 nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status) 3376 { 3377 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 3378 3379 if (status == 0) { 3380 /* There was no qpair whose ID matches SQID of the abort command. 3381 * Hence call _nvmf_request_complete() here. 3382 */ 3383 _nvmf_request_complete(req); 3384 } 3385 } 3386 3387 static void 3388 nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i) 3389 { 3390 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 3391 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 3392 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 3393 uint16_t sqid = req->cmd->nvme_cmd.cdw10_bits.abort.sqid; 3394 struct spdk_nvmf_qpair *qpair; 3395 3396 TAILQ_FOREACH(qpair, &group->qpairs, link) { 3397 if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) { 3398 /* Found the qpair */ 3399 3400 nvmf_qpair_abort_request(qpair, req); 3401 3402 /* Return -1 for the status so the iteration across threads stops. */ 3403 spdk_for_each_channel_continue(i, -1); 3404 return; 3405 } 3406 } 3407 3408 spdk_for_each_channel_continue(i, 0); 3409 } 3410 3411 static int 3412 nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 3413 { 3414 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3415 3416 rsp->cdw0 = 1U; /* Command not aborted */ 3417 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 3418 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 3419 3420 /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */ 3421 spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt, 3422 nvmf_ctrlr_abort_on_pg, 3423 req, 3424 nvmf_ctrlr_abort_done 3425 ); 3426 3427 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 3428 } 3429 3430 int 3431 nvmf_ctrlr_abort_request(struct spdk_nvmf_request *req) 3432 { 3433 struct spdk_nvmf_request *req_to_abort = req->req_to_abort; 3434 struct spdk_bdev *bdev; 3435 struct spdk_bdev_desc *desc; 3436 struct spdk_io_channel *ch; 3437 int rc; 3438 3439 assert(req_to_abort != NULL); 3440 3441 if (g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr && 3442 nvmf_qpair_is_admin_queue(req_to_abort->qpair)) { 3443 return g_nvmf_custom_admin_cmd_hdlrs[SPDK_NVME_OPC_ABORT].hdlr(req); 3444 } 3445 3446 rc = spdk_nvmf_request_get_bdev(req_to_abort->cmd->nvme_cmd.nsid, req_to_abort, 3447 &bdev, &desc, &ch); 3448 if (rc != 0) { 3449 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3450 } 3451 3452 return spdk_nvmf_bdev_ctrlr_abort_cmd(bdev, desc, ch, req, req_to_abort); 3453 } 3454 3455 static int 3456 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 3457 { 3458 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 3459 3460 rsp->cdw0 = cdw0; 3461 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3462 } 3463 3464 /* we have to use the typedef in the function declaration to appease astyle. */ 3465 typedef enum spdk_nvme_path_status_code spdk_nvme_path_status_code_t; 3466 3467 static spdk_nvme_path_status_code_t 3468 _nvme_ana_state_to_path_status(enum spdk_nvme_ana_state ana_state) 3469 { 3470 switch (ana_state) { 3471 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3472 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_INACCESSIBLE; 3473 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3474 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS; 3475 case SPDK_NVME_ANA_CHANGE_STATE: 3476 return SPDK_NVME_SC_ASYMMETRIC_ACCESS_TRANSITION; 3477 default: 3478 return SPDK_NVME_SC_INTERNAL_PATH_ERROR; 3479 } 3480 } 3481 3482 static int 3483 nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 3484 { 3485 uint8_t feature; 3486 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3487 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3488 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3489 enum spdk_nvme_ana_state ana_state; 3490 3491 feature = cmd->cdw10_bits.get_features.fid; 3492 3493 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3494 /* 3495 * Features supported by Discovery controller 3496 */ 3497 switch (feature) { 3498 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3499 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 3500 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3501 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 3502 default: 3503 SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature); 3504 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3505 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3506 } 3507 } 3508 /* 3509 * Process Get Features command for non-discovery controller 3510 */ 3511 ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid); 3512 switch (ana_state) { 3513 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3514 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3515 case SPDK_NVME_ANA_CHANGE_STATE: 3516 switch (feature) { 3517 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3518 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3519 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3520 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3521 response->status.sct = SPDK_NVME_SCT_PATH; 3522 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3523 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3524 default: 3525 break; 3526 } 3527 break; 3528 default: 3529 break; 3530 } 3531 3532 switch (feature) { 3533 case SPDK_NVME_FEAT_ARBITRATION: 3534 return get_features_generic(req, ctrlr->feat.arbitration.raw); 3535 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 3536 return get_features_generic(req, ctrlr->feat.power_management.raw); 3537 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 3538 return nvmf_ctrlr_get_features_temperature_threshold(req); 3539 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3540 return get_features_generic(req, ctrlr->feat.error_recovery.raw); 3541 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 3542 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 3543 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 3544 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 3545 case SPDK_NVME_FEAT_INTERRUPT_COALESCING: 3546 return get_features_generic(req, ctrlr->feat.interrupt_coalescing.raw); 3547 case SPDK_NVME_FEAT_INTERRUPT_VECTOR_CONFIGURATION: 3548 return nvmf_ctrlr_get_features_interrupt_vector_configuration(req); 3549 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3550 return get_features_generic(req, ctrlr->feat.write_atomicity.raw); 3551 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3552 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 3553 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3554 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 3555 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 3556 return nvmf_ctrlr_get_features_host_identifier(req); 3557 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3558 return nvmf_ctrlr_get_features_reservation_notification_mask(req); 3559 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3560 return nvmf_ctrlr_get_features_reservation_persistence(req); 3561 case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT: 3562 return nvmf_ctrlr_get_features_host_behavior_support(req); 3563 default: 3564 SPDK_INFOLOG(nvmf, "Get Features command with unsupported feature ID 0x%02x\n", feature); 3565 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3566 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3567 } 3568 } 3569 3570 static int 3571 nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 3572 { 3573 uint8_t feature, save; 3574 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3575 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3576 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3577 enum spdk_nvme_ana_state ana_state; 3578 /* 3579 * Features are not saveable by the controller as indicated by 3580 * ONCS field of the Identify Controller data. 3581 * */ 3582 save = cmd->cdw10_bits.set_features.sv; 3583 if (save) { 3584 response->status.sc = SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE; 3585 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 3586 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3587 } 3588 3589 feature = cmd->cdw10_bits.set_features.fid; 3590 3591 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3592 /* 3593 * Features supported by Discovery controller 3594 */ 3595 switch (feature) { 3596 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3597 return nvmf_ctrlr_set_features_keep_alive_timer(req); 3598 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3599 return nvmf_ctrlr_set_features_async_event_configuration(req); 3600 default: 3601 SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature); 3602 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3603 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3604 } 3605 } 3606 /* 3607 * Process Set Features command for non-discovery controller 3608 */ 3609 ana_state = nvmf_ctrlr_get_ana_state_from_nsid(ctrlr, cmd->nsid); 3610 switch (ana_state) { 3611 case SPDK_NVME_ANA_INACCESSIBLE_STATE: 3612 case SPDK_NVME_ANA_CHANGE_STATE: 3613 if (cmd->nsid == SPDK_NVME_GLOBAL_NS_TAG) { 3614 response->status.sct = SPDK_NVME_SCT_PATH; 3615 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3616 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3617 } else { 3618 switch (feature) { 3619 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3620 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3621 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3622 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3623 response->status.sct = SPDK_NVME_SCT_PATH; 3624 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 3625 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3626 default: 3627 break; 3628 } 3629 } 3630 break; 3631 case SPDK_NVME_ANA_PERSISTENT_LOSS_STATE: 3632 response->status.sct = SPDK_NVME_SCT_PATH; 3633 response->status.sc = SPDK_NVME_SC_ASYMMETRIC_ACCESS_PERSISTENT_LOSS; 3634 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3635 default: 3636 break; 3637 } 3638 3639 switch (feature) { 3640 case SPDK_NVME_FEAT_ARBITRATION: 3641 return nvmf_ctrlr_set_features_arbitration(req); 3642 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 3643 return nvmf_ctrlr_set_features_power_management(req); 3644 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 3645 return nvmf_ctrlr_set_features_temperature_threshold(req); 3646 case SPDK_NVME_FEAT_ERROR_RECOVERY: 3647 return nvmf_ctrlr_set_features_error_recovery(req); 3648 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 3649 return nvmf_ctrlr_set_features_volatile_write_cache(req); 3650 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 3651 return nvmf_ctrlr_set_features_number_of_queues(req); 3652 case SPDK_NVME_FEAT_INTERRUPT_COALESCING: 3653 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 3654 response->status.sc = SPDK_NVME_SC_FEATURE_NOT_CHANGEABLE; 3655 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3656 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 3657 return nvmf_ctrlr_set_features_write_atomicity(req); 3658 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 3659 return nvmf_ctrlr_set_features_async_event_configuration(req); 3660 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 3661 return nvmf_ctrlr_set_features_keep_alive_timer(req); 3662 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 3663 return nvmf_ctrlr_set_features_host_identifier(req); 3664 case SPDK_NVME_FEAT_HOST_RESERVE_MASK: 3665 return nvmf_ctrlr_set_features_reservation_notification_mask(req); 3666 case SPDK_NVME_FEAT_HOST_RESERVE_PERSIST: 3667 return nvmf_ctrlr_set_features_reservation_persistence(req); 3668 case SPDK_NVME_FEAT_HOST_BEHAVIOR_SUPPORT: 3669 return nvmf_ctrlr_set_features_host_behavior_support(req); 3670 default: 3671 SPDK_INFOLOG(nvmf, "Set Features command with unsupported feature ID 0x%02x\n", feature); 3672 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3673 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3674 } 3675 } 3676 3677 static int 3678 nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 3679 { 3680 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3681 3682 SPDK_DEBUGLOG(nvmf, "Keep Alive\n"); 3683 /* 3684 * To handle keep alive just clear or reset the 3685 * ctrlr based keep alive duration counter. 3686 * When added, a separate timer based process 3687 * will monitor if the time since last recorded 3688 * keep alive has exceeded the max duration and 3689 * take appropriate action. 3690 */ 3691 ctrlr->last_keep_alive_tick = spdk_get_ticks(); 3692 3693 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3694 } 3695 3696 int 3697 nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 3698 { 3699 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 3700 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 3701 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 3702 struct spdk_nvmf_subsystem_poll_group *sgroup; 3703 int rc; 3704 3705 assert(ctrlr != NULL); 3706 if (cmd->opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST) { 3707 /* We do not want to treat AERs as outstanding commands, 3708 * so decrement mgmt_io_outstanding here to offset 3709 * the increment that happened prior to this call. 3710 */ 3711 sgroup = &req->qpair->group->sgroups[ctrlr->subsys->id]; 3712 assert(sgroup != NULL); 3713 sgroup->mgmt_io_outstanding--; 3714 } 3715 3716 assert(spdk_get_thread() == ctrlr->thread); 3717 3718 if (cmd->fuse != 0) { 3719 /* Fused admin commands are not supported. */ 3720 response->status.sct = SPDK_NVME_SCT_GENERIC; 3721 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 3722 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3723 } 3724 3725 if (ctrlr->vcprop.cc.bits.en != 1) { 3726 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 3727 response->status.sct = SPDK_NVME_SCT_GENERIC; 3728 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 3729 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3730 } 3731 3732 if (req->iovcnt && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 3733 spdk_iov_memset(req->iov, req->iovcnt, 0); 3734 } 3735 3736 if (spdk_nvmf_subsystem_is_discovery(ctrlr->subsys)) { 3737 /* Discovery controllers only support these admin OPS. */ 3738 switch (cmd->opc) { 3739 case SPDK_NVME_OPC_IDENTIFY: 3740 case SPDK_NVME_OPC_GET_LOG_PAGE: 3741 case SPDK_NVME_OPC_KEEP_ALIVE: 3742 case SPDK_NVME_OPC_SET_FEATURES: 3743 case SPDK_NVME_OPC_GET_FEATURES: 3744 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 3745 break; 3746 default: 3747 goto invalid_opcode; 3748 } 3749 } 3750 3751 /* Call a custom adm cmd handler if set. Aborts are handled in a different path (see nvmf_passthru_admin_cmd) */ 3752 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr && cmd->opc != SPDK_NVME_OPC_ABORT) { 3753 rc = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].hdlr(req); 3754 if (rc >= SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 3755 /* The handler took care of this command */ 3756 return rc; 3757 } 3758 } 3759 3760 switch (cmd->opc) { 3761 case SPDK_NVME_OPC_GET_LOG_PAGE: 3762 return nvmf_ctrlr_get_log_page(req); 3763 case SPDK_NVME_OPC_IDENTIFY: 3764 return nvmf_ctrlr_identify(req); 3765 case SPDK_NVME_OPC_ABORT: 3766 return nvmf_ctrlr_abort(req); 3767 case SPDK_NVME_OPC_GET_FEATURES: 3768 return nvmf_ctrlr_get_features(req); 3769 case SPDK_NVME_OPC_SET_FEATURES: 3770 return nvmf_ctrlr_set_features(req); 3771 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 3772 return nvmf_ctrlr_async_event_request(req); 3773 case SPDK_NVME_OPC_KEEP_ALIVE: 3774 return nvmf_ctrlr_keep_alive(req); 3775 3776 case SPDK_NVME_OPC_CREATE_IO_SQ: 3777 case SPDK_NVME_OPC_CREATE_IO_CQ: 3778 case SPDK_NVME_OPC_DELETE_IO_SQ: 3779 case SPDK_NVME_OPC_DELETE_IO_CQ: 3780 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 3781 goto invalid_opcode; 3782 3783 default: 3784 goto invalid_opcode; 3785 } 3786 3787 invalid_opcode: 3788 SPDK_INFOLOG(nvmf, "Unsupported admin opcode 0x%x\n", cmd->opc); 3789 response->status.sct = SPDK_NVME_SCT_GENERIC; 3790 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3791 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3792 } 3793 3794 static int 3795 nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 3796 { 3797 struct spdk_nvmf_qpair *qpair = req->qpair; 3798 struct spdk_nvmf_capsule_cmd *cap_hdr; 3799 3800 cap_hdr = &req->cmd->nvmf_cmd; 3801 3802 if (qpair->ctrlr == NULL) { 3803 /* No ctrlr established yet; the only valid command is Connect */ 3804 assert(cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT); 3805 return nvmf_ctrlr_cmd_connect(req); 3806 } else if (nvmf_qpair_is_admin_queue(qpair)) { 3807 /* 3808 * Controller session is established, and this is an admin queue. 3809 * Disallow Connect and allow other fabrics commands. 3810 */ 3811 switch (cap_hdr->fctype) { 3812 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 3813 return nvmf_property_set(req); 3814 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 3815 return nvmf_property_get(req); 3816 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND: 3817 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV: 3818 return nvmf_auth_request_exec(req); 3819 default: 3820 SPDK_DEBUGLOG(nvmf, "unknown fctype 0x%02x\n", 3821 cap_hdr->fctype); 3822 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3823 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3824 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3825 } 3826 } else { 3827 /* 3828 * Controller session is established, and this is an I/O queue. 3829 * Disallow everything besides authentication commands. 3830 */ 3831 switch (cap_hdr->fctype) { 3832 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND: 3833 case SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV: 3834 return nvmf_auth_request_exec(req); 3835 default: 3836 SPDK_DEBUGLOG(nvmf, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 3837 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 3838 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 3839 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 3840 } 3841 } 3842 } 3843 3844 static inline void 3845 nvmf_ctrlr_queue_pending_async_event(struct spdk_nvmf_ctrlr *ctrlr, 3846 union spdk_nvme_async_event_completion *event) 3847 { 3848 struct spdk_nvmf_async_event_completion *nvmf_event; 3849 3850 nvmf_event = calloc(1, sizeof(*nvmf_event)); 3851 if (!nvmf_event) { 3852 SPDK_ERRLOG("Alloc nvmf event failed, ignore the event\n"); 3853 return; 3854 } 3855 nvmf_event->event.raw = event->raw; 3856 STAILQ_INSERT_TAIL(&ctrlr->async_events, nvmf_event, link); 3857 } 3858 3859 static inline int 3860 nvmf_ctrlr_async_event_notification(struct spdk_nvmf_ctrlr *ctrlr, 3861 union spdk_nvme_async_event_completion *event) 3862 { 3863 struct spdk_nvmf_request *req; 3864 struct spdk_nvme_cpl *rsp; 3865 3866 assert(spdk_get_thread() == ctrlr->thread); 3867 3868 /* If there is no outstanding AER request, queue the event. Then 3869 * if an AER is later submitted, this event can be sent as a 3870 * response. 3871 */ 3872 if (ctrlr->nr_aer_reqs == 0) { 3873 nvmf_ctrlr_queue_pending_async_event(ctrlr, event); 3874 return 0; 3875 } 3876 3877 req = ctrlr->aer_req[--ctrlr->nr_aer_reqs]; 3878 rsp = &req->rsp->nvme_cpl; 3879 3880 rsp->cdw0 = event->raw; 3881 3882 _nvmf_request_complete(req); 3883 ctrlr->aer_req[ctrlr->nr_aer_reqs] = NULL; 3884 3885 return 0; 3886 } 3887 3888 int 3889 nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 3890 { 3891 union spdk_nvme_async_event_completion event = {0}; 3892 3893 /* Users may disable the event notification */ 3894 if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) { 3895 return 0; 3896 } 3897 3898 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGE_MASK_BIT)) { 3899 return 0; 3900 } 3901 3902 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 3903 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED; 3904 event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST; 3905 3906 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 3907 } 3908 3909 int 3910 nvmf_ctrlr_async_event_ana_change_notice(struct spdk_nvmf_ctrlr *ctrlr) 3911 { 3912 union spdk_nvme_async_event_completion event = {0}; 3913 3914 /* Users may disable the event notification */ 3915 if (!ctrlr->feat.async_event_configuration.bits.ana_change_notice) { 3916 return 0; 3917 } 3918 3919 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ANA_CHANGE_MASK_BIT)) { 3920 return 0; 3921 } 3922 3923 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 3924 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_ANA_CHANGE; 3925 event.bits.log_page_identifier = SPDK_NVME_LOG_ASYMMETRIC_NAMESPACE_ACCESS; 3926 3927 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 3928 } 3929 3930 void 3931 nvmf_ctrlr_async_event_reservation_notification(struct spdk_nvmf_ctrlr *ctrlr) 3932 { 3933 union spdk_nvme_async_event_completion event = {0}; 3934 3935 if (!ctrlr->num_avail_log_pages) { 3936 return; 3937 } 3938 3939 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL_MASK_BIT)) { 3940 return; 3941 } 3942 3943 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_IO; 3944 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_RESERVATION_LOG_AVAIL; 3945 event.bits.log_page_identifier = SPDK_NVME_LOG_RESERVATION_NOTIFICATION; 3946 3947 nvmf_ctrlr_async_event_notification(ctrlr, &event); 3948 } 3949 3950 void 3951 nvmf_ctrlr_async_event_discovery_log_change_notice(void *ctx) 3952 { 3953 union spdk_nvme_async_event_completion event = {0}; 3954 struct spdk_nvmf_ctrlr *ctrlr = ctx; 3955 3956 /* Users may disable the event notification manually or 3957 * it may not be enabled due to keep alive timeout 3958 * not being set in connect command to discovery controller. 3959 */ 3960 if (!ctrlr->feat.async_event_configuration.bits.discovery_log_change_notice) { 3961 return; 3962 } 3963 3964 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE_MASK_BIT)) { 3965 return; 3966 } 3967 3968 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 3969 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_DISCOVERY_LOG_CHANGE; 3970 event.bits.log_page_identifier = SPDK_NVME_LOG_DISCOVERY; 3971 3972 nvmf_ctrlr_async_event_notification(ctrlr, &event); 3973 } 3974 3975 int 3976 spdk_nvmf_ctrlr_async_event_error_event(struct spdk_nvmf_ctrlr *ctrlr, 3977 enum spdk_nvme_async_event_info_error info) 3978 { 3979 union spdk_nvme_async_event_completion event; 3980 3981 if (!nvmf_ctrlr_mask_aen(ctrlr, SPDK_NVME_ASYNC_EVENT_ERROR_MASK_BIT)) { 3982 return 0; 3983 } 3984 3985 if (info > SPDK_NVME_ASYNC_EVENT_FW_IMAGE_LOAD) { 3986 return 0; 3987 } 3988 3989 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_ERROR; 3990 event.bits.log_page_identifier = SPDK_NVME_LOG_ERROR; 3991 event.bits.async_event_info = info; 3992 3993 return nvmf_ctrlr_async_event_notification(ctrlr, &event); 3994 } 3995 3996 void 3997 nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair) 3998 { 3999 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4000 int i; 4001 4002 if (ctrlr == NULL || !nvmf_qpair_is_admin_queue(qpair)) { 4003 return; 4004 } 4005 4006 assert(spdk_get_thread() == ctrlr->thread); 4007 4008 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 4009 spdk_nvmf_request_free(ctrlr->aer_req[i]); 4010 ctrlr->aer_req[i] = NULL; 4011 } 4012 4013 ctrlr->nr_aer_reqs = 0; 4014 } 4015 4016 void 4017 spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr) 4018 { 4019 struct spdk_nvmf_request *req; 4020 int i; 4021 4022 assert(spdk_get_thread() == ctrlr->thread); 4023 4024 if (!ctrlr->nr_aer_reqs) { 4025 return; 4026 } 4027 4028 for (i = 0; i < ctrlr->nr_aer_reqs; i++) { 4029 req = ctrlr->aer_req[i]; 4030 4031 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4032 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 4033 _nvmf_request_complete(req); 4034 4035 ctrlr->aer_req[i] = NULL; 4036 } 4037 4038 ctrlr->nr_aer_reqs = 0; 4039 } 4040 4041 static void 4042 _nvmf_ctrlr_add_reservation_log(void *ctx) 4043 { 4044 struct spdk_nvmf_reservation_log *log = (struct spdk_nvmf_reservation_log *)ctx; 4045 struct spdk_nvmf_ctrlr *ctrlr = log->ctrlr; 4046 4047 ctrlr->log_page_count++; 4048 4049 /* Maximum number of queued log pages is 255 */ 4050 if (ctrlr->num_avail_log_pages == 0xff) { 4051 struct spdk_nvmf_reservation_log *entry; 4052 entry = TAILQ_LAST(&ctrlr->log_head, log_page_head); 4053 entry->log.log_page_count = ctrlr->log_page_count; 4054 free(log); 4055 return; 4056 } 4057 4058 log->log.log_page_count = ctrlr->log_page_count; 4059 log->log.num_avail_log_pages = ctrlr->num_avail_log_pages++; 4060 TAILQ_INSERT_TAIL(&ctrlr->log_head, log, link); 4061 4062 nvmf_ctrlr_async_event_reservation_notification(ctrlr); 4063 } 4064 4065 void 4066 nvmf_ctrlr_reservation_notice_log(struct spdk_nvmf_ctrlr *ctrlr, 4067 struct spdk_nvmf_ns *ns, 4068 enum spdk_nvme_reservation_notification_log_page_type type) 4069 { 4070 struct spdk_nvmf_reservation_log *log; 4071 4072 switch (type) { 4073 case SPDK_NVME_RESERVATION_LOG_PAGE_EMPTY: 4074 return; 4075 case SPDK_NVME_REGISTRATION_PREEMPTED: 4076 if (ns->mask & SPDK_NVME_REGISTRATION_PREEMPTED_MASK) { 4077 return; 4078 } 4079 break; 4080 case SPDK_NVME_RESERVATION_RELEASED: 4081 if (ns->mask & SPDK_NVME_RESERVATION_RELEASED_MASK) { 4082 return; 4083 } 4084 break; 4085 case SPDK_NVME_RESERVATION_PREEMPTED: 4086 if (ns->mask & SPDK_NVME_RESERVATION_PREEMPTED_MASK) { 4087 return; 4088 } 4089 break; 4090 default: 4091 return; 4092 } 4093 4094 log = calloc(1, sizeof(*log)); 4095 if (!log) { 4096 SPDK_ERRLOG("Alloc log page failed, ignore the log\n"); 4097 return; 4098 } 4099 log->ctrlr = ctrlr; 4100 log->log.type = type; 4101 log->log.nsid = ns->nsid; 4102 4103 spdk_thread_send_msg(ctrlr->thread, _nvmf_ctrlr_add_reservation_log, log); 4104 } 4105 4106 /* Check from subsystem poll group's namespace information data structure */ 4107 static bool 4108 nvmf_ns_info_ctrlr_is_registrant(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 4109 struct spdk_nvmf_ctrlr *ctrlr) 4110 { 4111 uint32_t i; 4112 4113 for (i = 0; i < SPDK_NVMF_MAX_NUM_REGISTRANTS; i++) { 4114 if (!spdk_uuid_compare(&ns_info->reg_hostid[i], &ctrlr->hostid)) { 4115 return true; 4116 } 4117 } 4118 4119 return false; 4120 } 4121 4122 /* 4123 * Check the NVMe command is permitted or not for current controller(Host). 4124 */ 4125 static int 4126 nvmf_ns_reservation_request_check(struct spdk_nvmf_subsystem_pg_ns_info *ns_info, 4127 struct spdk_nvmf_ctrlr *ctrlr, 4128 struct spdk_nvmf_request *req) 4129 { 4130 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4131 enum spdk_nvme_reservation_type rtype = ns_info->rtype; 4132 uint8_t status = SPDK_NVME_SC_SUCCESS; 4133 uint8_t racqa; 4134 bool is_registrant; 4135 4136 /* No valid reservation */ 4137 if (!rtype) { 4138 return 0; 4139 } 4140 4141 is_registrant = nvmf_ns_info_ctrlr_is_registrant(ns_info, ctrlr); 4142 /* All registrants type and current ctrlr is a valid registrant */ 4143 if ((rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE_ALL_REGS || 4144 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && is_registrant) { 4145 return 0; 4146 } else if (!spdk_uuid_compare(&ns_info->holder_id, &ctrlr->hostid)) { 4147 return 0; 4148 } 4149 4150 /* Non-holder for current controller */ 4151 switch (cmd->opc) { 4152 case SPDK_NVME_OPC_READ: 4153 case SPDK_NVME_OPC_COMPARE: 4154 if (rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 4155 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4156 goto exit; 4157 } 4158 if ((rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_REG_ONLY || 4159 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS_ALL_REGS) && !is_registrant) { 4160 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4161 } 4162 break; 4163 case SPDK_NVME_OPC_FLUSH: 4164 case SPDK_NVME_OPC_WRITE: 4165 case SPDK_NVME_OPC_WRITE_UNCORRECTABLE: 4166 case SPDK_NVME_OPC_WRITE_ZEROES: 4167 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 4168 if (rtype == SPDK_NVME_RESERVE_WRITE_EXCLUSIVE || 4169 rtype == SPDK_NVME_RESERVE_EXCLUSIVE_ACCESS) { 4170 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4171 goto exit; 4172 } 4173 if (!is_registrant) { 4174 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4175 } 4176 break; 4177 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 4178 racqa = cmd->cdw10_bits.resv_acquire.racqa; 4179 if (racqa == SPDK_NVME_RESERVE_ACQUIRE) { 4180 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4181 goto exit; 4182 } 4183 if (!is_registrant) { 4184 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4185 } 4186 break; 4187 case SPDK_NVME_OPC_RESERVATION_RELEASE: 4188 if (!is_registrant) { 4189 status = SPDK_NVME_SC_RESERVATION_CONFLICT; 4190 } 4191 break; 4192 default: 4193 break; 4194 } 4195 4196 exit: 4197 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4198 req->rsp->nvme_cpl.status.sc = status; 4199 if (status == SPDK_NVME_SC_RESERVATION_CONFLICT) { 4200 return -EPERM; 4201 } 4202 4203 return 0; 4204 } 4205 4206 static int 4207 nvmf_ctrlr_process_io_fused_cmd(struct spdk_nvmf_request *req, struct spdk_bdev *bdev, 4208 struct spdk_bdev_desc *desc, struct spdk_io_channel *ch) 4209 { 4210 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4211 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 4212 struct spdk_nvmf_request *first_fused_req = req->qpair->first_fused_req; 4213 int rc; 4214 4215 if (cmd->fuse == SPDK_NVME_CMD_FUSE_FIRST) { 4216 /* first fused operation (should be compare) */ 4217 if (first_fused_req != NULL) { 4218 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4219 4220 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 4221 4222 /* abort req->qpair->first_fused_request and continue with new fused command */ 4223 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4224 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4225 _nvmf_request_complete(first_fused_req); 4226 } else if (cmd->opc != SPDK_NVME_OPC_COMPARE) { 4227 SPDK_ERRLOG("Wrong op code of fused operations\n"); 4228 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4229 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4230 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4231 } 4232 4233 req->qpair->first_fused_req = req; 4234 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 4235 } else if (cmd->fuse == SPDK_NVME_CMD_FUSE_SECOND) { 4236 /* second fused operation (should be write) */ 4237 if (first_fused_req == NULL) { 4238 SPDK_ERRLOG("Wrong sequence of fused operations\n"); 4239 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4240 rsp->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4241 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4242 } else if (cmd->opc != SPDK_NVME_OPC_WRITE) { 4243 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4244 4245 SPDK_ERRLOG("Wrong op code of fused operations\n"); 4246 4247 /* abort req->qpair->first_fused_request and fail current command */ 4248 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4249 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4250 _nvmf_request_complete(first_fused_req); 4251 4252 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4253 rsp->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4254 req->qpair->first_fused_req = NULL; 4255 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4256 } 4257 4258 /* save request of first command to generate response later */ 4259 req->first_fused_req = first_fused_req; 4260 req->first_fused = true; 4261 req->qpair->first_fused_req = NULL; 4262 } else { 4263 SPDK_ERRLOG("Invalid fused command fuse field.\n"); 4264 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4265 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 4266 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4267 } 4268 4269 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(bdev, desc, ch, req->first_fused_req, req); 4270 4271 if (rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 4272 if (spdk_nvme_cpl_is_error(rsp)) { 4273 struct spdk_nvme_cpl *fused_response = &first_fused_req->rsp->nvme_cpl; 4274 4275 fused_response->status = rsp->status; 4276 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 4277 rsp->status.sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 4278 /* Complete first of fused commands. Second will be completed by upper layer */ 4279 _nvmf_request_complete(first_fused_req); 4280 req->first_fused_req = NULL; 4281 req->first_fused = false; 4282 } 4283 } 4284 4285 return rc; 4286 } 4287 4288 bool 4289 nvmf_ctrlr_use_zcopy(struct spdk_nvmf_request *req) 4290 { 4291 struct spdk_nvmf_transport *transport = req->qpair->transport; 4292 struct spdk_nvmf_ns *ns; 4293 4294 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE); 4295 4296 if (!transport->opts.zcopy) { 4297 return false; 4298 } 4299 4300 if (nvmf_qpair_is_admin_queue(req->qpair)) { 4301 /* Admin queue */ 4302 return false; 4303 } 4304 4305 if ((req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_WRITE) && 4306 (req->cmd->nvme_cmd.opc != SPDK_NVME_OPC_READ)) { 4307 /* Not a READ or WRITE command */ 4308 return false; 4309 } 4310 4311 if (req->cmd->nvme_cmd.fuse != SPDK_NVME_CMD_FUSE_NONE) { 4312 /* Fused commands dont use zcopy buffers */ 4313 return false; 4314 } 4315 4316 ns = nvmf_ctrlr_get_ns(req->qpair->ctrlr, req->cmd->nvme_cmd.nsid); 4317 if (ns == NULL || ns->bdev == NULL || !ns->zcopy) { 4318 return false; 4319 } 4320 4321 req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT; 4322 return true; 4323 } 4324 4325 void 4326 spdk_nvmf_request_zcopy_start(struct spdk_nvmf_request *req) 4327 { 4328 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT); 4329 4330 /* Set iovcnt to be the maximum number of iovs that the ZCOPY can use */ 4331 req->iovcnt = NVMF_REQ_MAX_BUFFERS; 4332 4333 spdk_nvmf_request_exec(req); 4334 } 4335 4336 void 4337 spdk_nvmf_request_zcopy_end(struct spdk_nvmf_request *req, bool commit) 4338 { 4339 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_EXECUTE); 4340 req->zcopy_phase = NVMF_ZCOPY_PHASE_END_PENDING; 4341 4342 nvmf_bdev_ctrlr_zcopy_end(req, commit); 4343 } 4344 4345 int 4346 nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req) 4347 { 4348 uint32_t nsid; 4349 struct spdk_nvmf_ns *ns; 4350 struct spdk_bdev *bdev; 4351 struct spdk_bdev_desc *desc; 4352 struct spdk_io_channel *ch; 4353 struct spdk_nvmf_qpair *qpair = req->qpair; 4354 struct spdk_nvmf_poll_group *group = qpair->group; 4355 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4356 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 4357 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 4358 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4359 enum spdk_nvme_ana_state ana_state; 4360 4361 /* pre-set response details for this command */ 4362 response->status.sc = SPDK_NVME_SC_SUCCESS; 4363 nsid = cmd->nsid; 4364 4365 assert(ctrlr != NULL); 4366 if (spdk_unlikely(ctrlr->vcprop.cc.bits.en != 1)) { 4367 SPDK_ERRLOG("I/O command sent to disabled controller\n"); 4368 response->status.sct = SPDK_NVME_SCT_GENERIC; 4369 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 4370 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4371 } 4372 4373 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 4374 if (spdk_unlikely(ns == NULL || ns->bdev == NULL)) { 4375 SPDK_DEBUGLOG(nvmf, "Unsuccessful query for nsid %u\n", cmd->nsid); 4376 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4377 response->status.dnr = 1; 4378 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4379 } 4380 4381 ana_state = nvmf_ctrlr_get_ana_state(ctrlr, ns->anagrpid); 4382 if (spdk_unlikely(ana_state != SPDK_NVME_ANA_OPTIMIZED_STATE && 4383 ana_state != SPDK_NVME_ANA_NON_OPTIMIZED_STATE)) { 4384 SPDK_DEBUGLOG(nvmf, "Fail I/O command due to ANA state %d\n", 4385 ana_state); 4386 response->status.sct = SPDK_NVME_SCT_PATH; 4387 response->status.sc = _nvme_ana_state_to_path_status(ana_state); 4388 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4389 } 4390 4391 if (spdk_likely(ctrlr->listener != NULL)) { 4392 SPDK_DTRACE_PROBE3_TICKS(nvmf_request_io_exec_path, req, 4393 ctrlr->listener->trid->traddr, 4394 ctrlr->listener->trid->trsvcid); 4395 } 4396 4397 /* scan-build falsely reporting dereference of null pointer */ 4398 assert(group != NULL && group->sgroups != NULL); 4399 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 4400 if (nvmf_ns_reservation_request_check(ns_info, ctrlr, req)) { 4401 SPDK_DEBUGLOG(nvmf, "Reservation Conflict for nsid %u, opcode %u\n", 4402 cmd->nsid, cmd->opc); 4403 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4404 } 4405 4406 bdev = ns->bdev; 4407 desc = ns->desc; 4408 ch = ns_info->channel; 4409 4410 if (spdk_unlikely(cmd->fuse & SPDK_NVME_CMD_FUSE_MASK)) { 4411 return nvmf_ctrlr_process_io_fused_cmd(req, bdev, desc, ch); 4412 } else if (spdk_unlikely(qpair->first_fused_req != NULL)) { 4413 struct spdk_nvme_cpl *fused_response = &qpair->first_fused_req->rsp->nvme_cpl; 4414 4415 SPDK_ERRLOG("Second fused cmd expected - failing first one (cntlid:%u, qid:%u, opcode:0x%x)\n", 4416 ctrlr->cntlid, qpair->qid, 4417 req->qpair->first_fused_req->cmd->nvmf_cmd.opcode); 4418 4419 /* abort qpair->first_fused_request and continue with new command */ 4420 fused_response->status.sc = SPDK_NVME_SC_ABORTED_MISSING_FUSED; 4421 fused_response->status.sct = SPDK_NVME_SCT_GENERIC; 4422 _nvmf_request_complete(qpair->first_fused_req); 4423 qpair->first_fused_req = NULL; 4424 } 4425 4426 if (spdk_nvmf_request_using_zcopy(req)) { 4427 assert(req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT); 4428 return nvmf_bdev_ctrlr_zcopy_start(bdev, desc, ch, req); 4429 } else { 4430 switch (cmd->opc) { 4431 case SPDK_NVME_OPC_READ: 4432 return nvmf_bdev_ctrlr_read_cmd(bdev, desc, ch, req); 4433 case SPDK_NVME_OPC_WRITE: 4434 return nvmf_bdev_ctrlr_write_cmd(bdev, desc, ch, req); 4435 case SPDK_NVME_OPC_FLUSH: 4436 return nvmf_bdev_ctrlr_flush_cmd(bdev, desc, ch, req); 4437 case SPDK_NVME_OPC_COMPARE: 4438 if (spdk_unlikely(!ctrlr->cdata.oncs.compare)) { 4439 goto invalid_opcode; 4440 } 4441 return nvmf_bdev_ctrlr_compare_cmd(bdev, desc, ch, req); 4442 case SPDK_NVME_OPC_WRITE_ZEROES: 4443 if (spdk_unlikely(!ctrlr->cdata.oncs.write_zeroes)) { 4444 goto invalid_opcode; 4445 } 4446 return nvmf_bdev_ctrlr_write_zeroes_cmd(bdev, desc, ch, req); 4447 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 4448 if (spdk_unlikely(!ctrlr->cdata.oncs.dsm)) { 4449 goto invalid_opcode; 4450 } 4451 return nvmf_bdev_ctrlr_dsm_cmd(bdev, desc, ch, req); 4452 case SPDK_NVME_OPC_RESERVATION_REGISTER: 4453 case SPDK_NVME_OPC_RESERVATION_ACQUIRE: 4454 case SPDK_NVME_OPC_RESERVATION_RELEASE: 4455 case SPDK_NVME_OPC_RESERVATION_REPORT: 4456 if (spdk_unlikely(!ctrlr->cdata.oncs.reservations)) { 4457 goto invalid_opcode; 4458 } 4459 spdk_thread_send_msg(ctrlr->subsys->thread, nvmf_ns_reservation_request, req); 4460 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 4461 case SPDK_NVME_OPC_COPY: 4462 if (spdk_unlikely(!ctrlr->cdata.oncs.copy)) { 4463 goto invalid_opcode; 4464 } 4465 return nvmf_bdev_ctrlr_copy_cmd(bdev, desc, ch, req); 4466 default: 4467 if (spdk_unlikely(qpair->transport->opts.disable_command_passthru)) { 4468 goto invalid_opcode; 4469 } 4470 return nvmf_bdev_ctrlr_nvme_passthru_io(bdev, desc, ch, req); 4471 } 4472 } 4473 invalid_opcode: 4474 SPDK_INFOLOG(nvmf, "Unsupported IO opcode 0x%x\n", cmd->opc); 4475 response->status.sct = SPDK_NVME_SCT_GENERIC; 4476 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 4477 response->status.dnr = 1; 4478 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4479 } 4480 4481 static void 4482 nvmf_qpair_request_cleanup(struct spdk_nvmf_qpair *qpair) 4483 { 4484 if (spdk_unlikely(qpair->state == SPDK_NVMF_QPAIR_DEACTIVATING)) { 4485 assert(qpair->state_cb != NULL); 4486 4487 if (TAILQ_EMPTY(&qpair->outstanding)) { 4488 qpair->state_cb(qpair->state_cb_arg, 0); 4489 } 4490 } 4491 } 4492 4493 int 4494 spdk_nvmf_request_free(struct spdk_nvmf_request *req) 4495 { 4496 struct spdk_nvmf_qpair *qpair = req->qpair; 4497 4498 TAILQ_REMOVE(&qpair->outstanding, req, link); 4499 if (spdk_unlikely(nvmf_transport_req_free(req))) { 4500 SPDK_ERRLOG("Unable to free transport level request resources.\n"); 4501 } 4502 4503 nvmf_qpair_request_cleanup(qpair); 4504 4505 return 0; 4506 } 4507 4508 static void 4509 _nvmf_request_complete(void *ctx) 4510 { 4511 struct spdk_nvmf_request *req = ctx; 4512 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 4513 struct spdk_nvmf_qpair *qpair; 4514 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 4515 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4516 bool is_aer = false; 4517 uint32_t nsid; 4518 bool paused; 4519 uint8_t opcode; 4520 4521 rsp->sqid = 0; 4522 rsp->status.p = 0; 4523 rsp->cid = req->cmd->nvme_cmd.cid; 4524 nsid = req->cmd->nvme_cmd.nsid; 4525 opcode = req->cmd->nvmf_cmd.opcode; 4526 4527 qpair = req->qpair; 4528 if (spdk_likely(qpair->ctrlr)) { 4529 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 4530 assert(sgroup != NULL); 4531 is_aer = req->cmd->nvme_cmd.opc == SPDK_NVME_OPC_ASYNC_EVENT_REQUEST; 4532 if (spdk_likely(qpair->qid != 0)) { 4533 qpair->group->stat.completed_nvme_io++; 4534 } 4535 4536 /* 4537 * Set the crd value. 4538 * If the the IO has any error, and dnr (DoNotRetry) is not 1, 4539 * and ACRE is enabled, we will set the crd to 1 to select the first CRDT. 4540 */ 4541 if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp) && 4542 rsp->status.dnr == 0 && 4543 qpair->ctrlr->acre_enabled)) { 4544 rsp->status.crd = 1; 4545 } 4546 } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) { 4547 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 4548 } 4549 4550 if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) { 4551 spdk_nvme_print_completion(qpair->qid, rsp); 4552 } 4553 4554 switch (req->zcopy_phase) { 4555 case NVMF_ZCOPY_PHASE_NONE: 4556 TAILQ_REMOVE(&qpair->outstanding, req, link); 4557 break; 4558 case NVMF_ZCOPY_PHASE_INIT: 4559 if (spdk_unlikely(spdk_nvme_cpl_is_error(rsp))) { 4560 req->zcopy_phase = NVMF_ZCOPY_PHASE_INIT_FAILED; 4561 TAILQ_REMOVE(&qpair->outstanding, req, link); 4562 } else { 4563 req->zcopy_phase = NVMF_ZCOPY_PHASE_EXECUTE; 4564 } 4565 break; 4566 case NVMF_ZCOPY_PHASE_EXECUTE: 4567 break; 4568 case NVMF_ZCOPY_PHASE_END_PENDING: 4569 TAILQ_REMOVE(&qpair->outstanding, req, link); 4570 req->zcopy_phase = NVMF_ZCOPY_PHASE_COMPLETE; 4571 break; 4572 default: 4573 SPDK_ERRLOG("Invalid ZCOPY phase %u\n", req->zcopy_phase); 4574 break; 4575 } 4576 4577 if (spdk_unlikely(nvmf_transport_req_complete(req))) { 4578 SPDK_ERRLOG("Transport request completion error!\n"); 4579 } 4580 4581 /* AER cmd is an exception */ 4582 if (spdk_likely(sgroup && !is_aer)) { 4583 if (spdk_unlikely(opcode == SPDK_NVME_OPC_FABRIC || 4584 nvmf_qpair_is_admin_queue(qpair))) { 4585 assert(sgroup->mgmt_io_outstanding > 0); 4586 sgroup->mgmt_io_outstanding--; 4587 } else { 4588 if (req->zcopy_phase == NVMF_ZCOPY_PHASE_NONE || 4589 req->zcopy_phase == NVMF_ZCOPY_PHASE_COMPLETE || 4590 req->zcopy_phase == NVMF_ZCOPY_PHASE_INIT_FAILED) { 4591 /* End of request */ 4592 4593 /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */ 4594 if (spdk_likely(nsid - 1 < sgroup->num_ns)) { 4595 sgroup->ns_info[nsid - 1].io_outstanding--; 4596 } 4597 } 4598 } 4599 4600 if (spdk_unlikely(sgroup->state == SPDK_NVMF_SUBSYSTEM_PAUSING && 4601 sgroup->mgmt_io_outstanding == 0)) { 4602 paused = true; 4603 for (nsid = 0; nsid < sgroup->num_ns; nsid++) { 4604 ns_info = &sgroup->ns_info[nsid]; 4605 4606 if (ns_info->state == SPDK_NVMF_SUBSYSTEM_PAUSING && 4607 ns_info->io_outstanding > 0) { 4608 paused = false; 4609 break; 4610 } 4611 } 4612 4613 if (paused) { 4614 sgroup->state = SPDK_NVMF_SUBSYSTEM_PAUSED; 4615 sgroup->cb_fn(sgroup->cb_arg, 0); 4616 sgroup->cb_fn = NULL; 4617 sgroup->cb_arg = NULL; 4618 } 4619 } 4620 4621 } 4622 4623 nvmf_qpair_request_cleanup(qpair); 4624 } 4625 4626 int 4627 spdk_nvmf_request_complete(struct spdk_nvmf_request *req) 4628 { 4629 struct spdk_nvmf_qpair *qpair = req->qpair; 4630 4631 spdk_thread_exec_msg(qpair->group->thread, _nvmf_request_complete, req); 4632 4633 return 0; 4634 } 4635 4636 SPDK_LOG_DEPRECATION_REGISTER(nvmf_request_exec_fabrics, "spdk_nvmf_request_exec_fabrics()", 4637 "v24.09", 1); 4638 void 4639 spdk_nvmf_request_exec_fabrics(struct spdk_nvmf_request *req) 4640 { 4641 SPDK_LOG_DEPRECATED(nvmf_request_exec_fabrics); 4642 4643 return spdk_nvmf_request_exec(req); 4644 } 4645 4646 static bool 4647 nvmf_check_subsystem_active(struct spdk_nvmf_request *req) 4648 { 4649 struct spdk_nvmf_qpair *qpair = req->qpair; 4650 struct spdk_nvmf_subsystem_poll_group *sgroup = NULL; 4651 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4652 uint32_t nsid; 4653 4654 if (spdk_likely(qpair->ctrlr)) { 4655 sgroup = &qpair->group->sgroups[qpair->ctrlr->subsys->id]; 4656 assert(sgroup != NULL); 4657 } else if (spdk_unlikely(nvmf_request_is_fabric_connect(req))) { 4658 sgroup = nvmf_subsystem_pg_from_connect_cmd(req); 4659 } 4660 4661 /* Check if the subsystem is paused (if there is a subsystem) */ 4662 if (spdk_unlikely(sgroup == NULL)) { 4663 return true; 4664 } 4665 4666 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC || 4667 nvmf_qpair_is_admin_queue(qpair))) { 4668 if (sgroup->state != SPDK_NVMF_SUBSYSTEM_ACTIVE) { 4669 /* The subsystem is not currently active. Queue this request. */ 4670 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 4671 return false; 4672 } 4673 sgroup->mgmt_io_outstanding++; 4674 } else { 4675 nsid = req->cmd->nvme_cmd.nsid; 4676 4677 /* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */ 4678 if (spdk_unlikely(nsid - 1 >= sgroup->num_ns)) { 4679 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4680 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4681 req->rsp->nvme_cpl.status.dnr = 1; 4682 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4683 _nvmf_request_complete(req); 4684 return false; 4685 } 4686 4687 ns_info = &sgroup->ns_info[nsid - 1]; 4688 if (spdk_unlikely(ns_info->channel == NULL)) { 4689 /* This can can happen if host sends I/O to a namespace that is 4690 * in the process of being added, but before the full addition 4691 * process is complete. Report invalid namespace in that case. 4692 */ 4693 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 4694 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4695 req->rsp->nvme_cpl.status.dnr = 1; 4696 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4697 ns_info->io_outstanding++; 4698 _nvmf_request_complete(req); 4699 return false; 4700 } 4701 4702 if (spdk_unlikely(ns_info->state != SPDK_NVMF_SUBSYSTEM_ACTIVE)) { 4703 /* The namespace is not currently active. Queue this request. */ 4704 TAILQ_INSERT_TAIL(&sgroup->queued, req, link); 4705 return false; 4706 } 4707 4708 ns_info->io_outstanding++; 4709 } 4710 4711 return true; 4712 } 4713 4714 static bool 4715 nvmf_check_qpair_active(struct spdk_nvmf_request *req) 4716 { 4717 struct spdk_nvmf_qpair *qpair = req->qpair; 4718 int sc, sct; 4719 4720 if (spdk_likely(qpair->state == SPDK_NVMF_QPAIR_ENABLED)) { 4721 return true; 4722 } 4723 4724 sct = SPDK_NVME_SCT_GENERIC; 4725 sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 4726 4727 switch (qpair->state) { 4728 case SPDK_NVMF_QPAIR_CONNECTING: 4729 if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) { 4730 SPDK_ERRLOG("Received command 0x%x on qid %u before CONNECT\n", 4731 req->cmd->nvmf_cmd.opcode, qpair->qid); 4732 break; 4733 } 4734 if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 4735 SPDK_ERRLOG("Received fctype 0x%x on qid %u before CONNECT\n", 4736 req->cmd->nvmf_cmd.fctype, qpair->qid); 4737 break; 4738 } 4739 return true; 4740 case SPDK_NVMF_QPAIR_AUTHENTICATING: 4741 sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 4742 sc = SPDK_NVMF_FABRIC_SC_AUTH_REQUIRED; 4743 if (req->cmd->nvmf_cmd.opcode != SPDK_NVME_OPC_FABRIC) { 4744 SPDK_ERRLOG("Received command 0x%x on qid %u before authentication\n", 4745 req->cmd->nvmf_cmd.opcode, qpair->qid); 4746 break; 4747 } 4748 if (req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_SEND && 4749 req->cmd->nvmf_cmd.fctype != SPDK_NVMF_FABRIC_COMMAND_AUTHENTICATION_RECV) { 4750 SPDK_ERRLOG("Received fctype 0x%x on qid %u before authentication\n", 4751 req->cmd->nvmf_cmd.fctype, qpair->qid); 4752 break; 4753 } 4754 return true; 4755 default: 4756 SPDK_ERRLOG("Received command 0x%x on qid %u in state %d\n", 4757 req->cmd->nvmf_cmd.opcode, qpair->qid, qpair->state); 4758 break; 4759 } 4760 4761 req->rsp->nvme_cpl.status.sct = sct; 4762 req->rsp->nvme_cpl.status.sc = sc; 4763 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4764 _nvmf_request_complete(req); 4765 4766 return false; 4767 } 4768 4769 void 4770 spdk_nvmf_request_exec(struct spdk_nvmf_request *req) 4771 { 4772 struct spdk_nvmf_qpair *qpair = req->qpair; 4773 enum spdk_nvmf_request_exec_status status; 4774 4775 if (spdk_unlikely(!nvmf_check_subsystem_active(req))) { 4776 return; 4777 } 4778 if (spdk_unlikely(!nvmf_check_qpair_active(req))) { 4779 return; 4780 } 4781 4782 if (SPDK_DEBUGLOG_FLAG_ENABLED("nvmf")) { 4783 spdk_nvme_print_command(qpair->qid, &req->cmd->nvme_cmd); 4784 } 4785 4786 /* Place the request on the outstanding list so we can keep track of it */ 4787 TAILQ_INSERT_TAIL(&qpair->outstanding, req, link); 4788 4789 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 4790 status = nvmf_ctrlr_process_fabrics_cmd(req); 4791 } else if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) { 4792 status = nvmf_ctrlr_process_admin_cmd(req); 4793 } else { 4794 status = nvmf_ctrlr_process_io_cmd(req); 4795 } 4796 4797 if (status == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE) { 4798 _nvmf_request_complete(req); 4799 } 4800 } 4801 4802 static bool 4803 nvmf_ctrlr_get_dif_ctx(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_cmd *cmd, 4804 struct spdk_dif_ctx *dif_ctx) 4805 { 4806 struct spdk_nvmf_ns *ns; 4807 struct spdk_bdev *bdev; 4808 4809 if (ctrlr == NULL || cmd == NULL) { 4810 return false; 4811 } 4812 4813 ns = nvmf_ctrlr_get_ns(ctrlr, cmd->nsid); 4814 if (ns == NULL || ns->bdev == NULL) { 4815 return false; 4816 } 4817 4818 bdev = ns->bdev; 4819 4820 switch (cmd->opc) { 4821 case SPDK_NVME_OPC_READ: 4822 case SPDK_NVME_OPC_WRITE: 4823 case SPDK_NVME_OPC_COMPARE: 4824 return nvmf_bdev_ctrlr_get_dif_ctx(bdev, cmd, dif_ctx); 4825 default: 4826 break; 4827 } 4828 4829 return false; 4830 } 4831 4832 bool 4833 spdk_nvmf_request_get_dif_ctx(struct spdk_nvmf_request *req, struct spdk_dif_ctx *dif_ctx) 4834 { 4835 struct spdk_nvmf_qpair *qpair = req->qpair; 4836 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 4837 4838 if (spdk_likely(ctrlr == NULL || !ctrlr->dif_insert_or_strip)) { 4839 return false; 4840 } 4841 4842 if (spdk_unlikely(!spdk_nvmf_qpair_is_active(qpair))) { 4843 return false; 4844 } 4845 4846 if (spdk_unlikely(req->cmd->nvmf_cmd.opcode == SPDK_NVME_OPC_FABRIC)) { 4847 return false; 4848 } 4849 4850 if (spdk_unlikely(nvmf_qpair_is_admin_queue(qpair))) { 4851 return false; 4852 } 4853 4854 return nvmf_ctrlr_get_dif_ctx(ctrlr, &req->cmd->nvme_cmd, dif_ctx); 4855 } 4856 4857 void 4858 spdk_nvmf_set_custom_admin_cmd_hdlr(uint8_t opc, spdk_nvmf_custom_cmd_hdlr hdlr) 4859 { 4860 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = hdlr; 4861 } 4862 4863 static int 4864 nvmf_passthru_admin_cmd_for_bdev_nsid(struct spdk_nvmf_request *req, uint32_t bdev_nsid) 4865 { 4866 struct spdk_bdev *bdev; 4867 struct spdk_bdev_desc *desc; 4868 struct spdk_io_channel *ch; 4869 struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req); 4870 int rc; 4871 4872 rc = spdk_nvmf_request_get_bdev(bdev_nsid, req, &bdev, &desc, &ch); 4873 if (rc) { 4874 response->status.sct = SPDK_NVME_SCT_GENERIC; 4875 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4876 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4877 } 4878 return spdk_nvmf_bdev_ctrlr_nvme_passthru_admin(bdev, desc, ch, req, NULL); 4879 } 4880 4881 static int 4882 nvmf_passthru_admin_cmd(struct spdk_nvmf_request *req) 4883 { 4884 struct spdk_nvme_cmd *cmd = spdk_nvmf_request_get_cmd(req); 4885 uint32_t bdev_nsid; 4886 4887 if (g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid != 0) { 4888 bdev_nsid = g_nvmf_custom_admin_cmd_hdlrs[cmd->opc].nsid; 4889 } else { 4890 bdev_nsid = cmd->nsid; 4891 } 4892 4893 return nvmf_passthru_admin_cmd_for_bdev_nsid(req, bdev_nsid); 4894 } 4895 4896 int 4897 nvmf_passthru_admin_cmd_for_ctrlr(struct spdk_nvmf_request *req, struct spdk_nvmf_ctrlr *ctrlr) 4898 { 4899 struct spdk_nvme_cpl *response = spdk_nvmf_request_get_response(req); 4900 struct spdk_nvmf_ns *ns; 4901 4902 ns = spdk_nvmf_subsystem_get_first_ns(ctrlr->subsys); 4903 if (ns == NULL) { 4904 /* Is there a better sc to use here? */ 4905 response->status.sct = SPDK_NVME_SCT_GENERIC; 4906 response->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 4907 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 4908 } 4909 4910 return nvmf_passthru_admin_cmd_for_bdev_nsid(req, ns->nsid); 4911 } 4912 4913 void 4914 spdk_nvmf_set_passthru_admin_cmd(uint8_t opc, uint32_t forward_nsid) 4915 { 4916 g_nvmf_custom_admin_cmd_hdlrs[opc].hdlr = nvmf_passthru_admin_cmd; 4917 g_nvmf_custom_admin_cmd_hdlrs[opc].nsid = forward_nsid; 4918 } 4919 4920 int 4921 spdk_nvmf_request_get_bdev(uint32_t nsid, struct spdk_nvmf_request *req, 4922 struct spdk_bdev **bdev, struct spdk_bdev_desc **desc, struct spdk_io_channel **ch) 4923 { 4924 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 4925 struct spdk_nvmf_ns *ns; 4926 struct spdk_nvmf_poll_group *group = req->qpair->group; 4927 struct spdk_nvmf_subsystem_pg_ns_info *ns_info; 4928 4929 *bdev = NULL; 4930 *desc = NULL; 4931 *ch = NULL; 4932 4933 ns = nvmf_ctrlr_get_ns(ctrlr, nsid); 4934 if (ns == NULL || ns->bdev == NULL) { 4935 return -EINVAL; 4936 } 4937 4938 assert(group != NULL && group->sgroups != NULL); 4939 ns_info = &group->sgroups[ctrlr->subsys->id].ns_info[nsid - 1]; 4940 *bdev = ns->bdev; 4941 *desc = ns->desc; 4942 *ch = ns_info->channel; 4943 4944 return 0; 4945 } 4946 4947 struct spdk_nvmf_ctrlr *spdk_nvmf_request_get_ctrlr(struct spdk_nvmf_request *req) 4948 { 4949 return req->qpair->ctrlr; 4950 } 4951 4952 struct spdk_nvme_cmd *spdk_nvmf_request_get_cmd(struct spdk_nvmf_request *req) 4953 { 4954 return &req->cmd->nvme_cmd; 4955 } 4956 4957 struct spdk_nvme_cpl *spdk_nvmf_request_get_response(struct spdk_nvmf_request *req) 4958 { 4959 return &req->rsp->nvme_cpl; 4960 } 4961 4962 struct spdk_nvmf_subsystem *spdk_nvmf_request_get_subsystem(struct spdk_nvmf_request *req) 4963 { 4964 return req->qpair->ctrlr->subsys; 4965 } 4966 4967 size_t 4968 spdk_nvmf_request_copy_from_buf(struct spdk_nvmf_request *req, 4969 void *buf, size_t buflen) 4970 { 4971 struct spdk_iov_xfer ix; 4972 4973 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 4974 return spdk_iov_xfer_from_buf(&ix, buf, buflen); 4975 } 4976 4977 size_t 4978 spdk_nvmf_request_copy_to_buf(struct spdk_nvmf_request *req, 4979 void *buf, size_t buflen) 4980 { 4981 struct spdk_iov_xfer ix; 4982 4983 spdk_iov_xfer_init(&ix, req->iov, req->iovcnt); 4984 return spdk_iov_xfer_to_buf(&ix, buf, buflen); 4985 } 4986 4987 struct spdk_nvmf_subsystem *spdk_nvmf_ctrlr_get_subsystem(struct spdk_nvmf_ctrlr *ctrlr) 4988 { 4989 return ctrlr->subsys; 4990 } 4991 4992 uint16_t 4993 spdk_nvmf_ctrlr_get_id(struct spdk_nvmf_ctrlr *ctrlr) 4994 { 4995 return ctrlr->cntlid; 4996 } 4997 4998 struct spdk_nvmf_request *spdk_nvmf_request_get_req_to_abort(struct spdk_nvmf_request *req) 4999 { 5000 return req->req_to_abort; 5001 } 5002