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