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