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