1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "spdk/stdinc.h" 35 36 #include "nvmf_internal.h" 37 #include "transport.h" 38 39 #include "spdk/bit_array.h" 40 #include "spdk/endian.h" 41 #include "spdk/thread.h" 42 #include "spdk/trace.h" 43 #include "spdk/nvme_spec.h" 44 #include "spdk/string.h" 45 #include "spdk/util.h" 46 #include "spdk/version.h" 47 48 #include "spdk_internal/log.h" 49 50 #define MIN_KEEP_ALIVE_TIMEOUT 10000 51 52 #define MODEL_NUMBER "SPDK bdev Controller" 53 54 /* 55 * Report the SPDK version as the firmware revision. 56 * SPDK_VERSION_STRING won't fit into FR (only 8 bytes), so try to fit the most important parts. 57 */ 58 #define FW_VERSION SPDK_VERSION_MAJOR_STRING SPDK_VERSION_MINOR_STRING SPDK_VERSION_PATCH_STRING 59 60 static inline void 61 spdk_nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp, 62 uint8_t iattr, uint16_t ipo) 63 { 64 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 65 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 66 rsp->status_code_specific.invalid.iattr = iattr; 67 rsp->status_code_specific.invalid.ipo = ipo; 68 } 69 70 #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \ 71 spdk_nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field)) 72 #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \ 73 spdk_nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field)) 74 75 static void 76 ctrlr_add_qpair_and_update_rsp(struct spdk_nvmf_qpair *qpair, 77 struct spdk_nvmf_ctrlr *ctrlr, 78 struct spdk_nvmf_fabric_connect_rsp *rsp) 79 { 80 assert(ctrlr->admin_qpair->group->thread == spdk_get_thread()); 81 82 /* check if we would exceed ctrlr connection limit */ 83 if (qpair->qid >= spdk_bit_array_capacity(ctrlr->qpair_mask)) { 84 SPDK_ERRLOG("Requested QID %u but Max QID is %u\n", 85 qpair->qid, spdk_bit_array_capacity(ctrlr->qpair_mask) - 1); 86 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 87 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 88 return; 89 } 90 91 if (spdk_bit_array_get(ctrlr->qpair_mask, qpair->qid)) { 92 SPDK_ERRLOG("Got I/O connect with duplicate QID %u\n", qpair->qid); 93 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 94 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 95 return; 96 } 97 98 qpair->ctrlr = ctrlr; 99 spdk_bit_array_set(ctrlr->qpair_mask, qpair->qid); 100 101 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 102 rsp->status_code_specific.success.cntlid = ctrlr->cntlid; 103 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "connect capsule response: cntlid = 0x%04x\n", 104 rsp->status_code_specific.success.cntlid); 105 } 106 107 static void 108 _spdk_nvmf_request_complete(void *ctx) 109 { 110 struct spdk_nvmf_request *req = ctx; 111 112 spdk_nvmf_request_complete(req); 113 } 114 115 static void 116 _spdk_nvmf_ctrlr_add_admin_qpair(void *ctx) 117 { 118 struct spdk_nvmf_request *req = ctx; 119 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 120 struct spdk_nvmf_qpair *qpair = req->qpair; 121 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 122 123 ctrlr->admin_qpair = qpair; 124 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 125 spdk_nvmf_request_complete(req); 126 } 127 128 static void 129 _spdk_nvmf_subsystem_add_ctrlr(void *ctx) 130 { 131 struct spdk_nvmf_request *req = ctx; 132 struct spdk_nvmf_qpair *qpair = req->qpair; 133 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 134 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 135 136 if (spdk_nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) { 137 SPDK_ERRLOG("Unable to add controller to subsystem\n"); 138 spdk_bit_array_free(&ctrlr->qpair_mask); 139 free(ctrlr); 140 qpair->ctrlr = NULL; 141 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 142 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 143 return; 144 } 145 146 spdk_thread_send_msg(ctrlr->thread, _spdk_nvmf_ctrlr_add_admin_qpair, req); 147 } 148 149 static struct spdk_nvmf_ctrlr * 150 spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 151 struct spdk_nvmf_request *req, 152 struct spdk_nvmf_fabric_connect_cmd *connect_cmd, 153 struct spdk_nvmf_fabric_connect_data *connect_data) 154 { 155 struct spdk_nvmf_ctrlr *ctrlr; 156 struct spdk_nvmf_transport *transport; 157 158 ctrlr = calloc(1, sizeof(*ctrlr)); 159 if (ctrlr == NULL) { 160 SPDK_ERRLOG("Memory allocation failed\n"); 161 return NULL; 162 } 163 164 ctrlr->subsys = subsystem; 165 ctrlr->thread = req->qpair->group->thread; 166 167 transport = req->qpair->transport; 168 ctrlr->qpair_mask = spdk_bit_array_create(transport->opts.max_qpairs_per_ctrlr); 169 if (!ctrlr->qpair_mask) { 170 SPDK_ERRLOG("Failed to allocate controller qpair mask\n"); 171 free(ctrlr); 172 return NULL; 173 } 174 175 ctrlr->feat.keep_alive_timer.bits.kato = connect_cmd->kato; 176 ctrlr->feat.async_event_configuration.bits.ns_attr_notice = 1; 177 ctrlr->feat.volatile_write_cache.bits.wce = 1; 178 179 /* Subtract 1 for admin queue, 1 for 0's based */ 180 ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 - 181 1; 182 ctrlr->feat.number_of_queues.bits.nsqr = transport->opts.max_qpairs_per_ctrlr - 1 - 183 1; 184 185 spdk_uuid_copy(&ctrlr->hostid, (struct spdk_uuid *)connect_data->hostid); 186 187 ctrlr->vcprop.cap.raw = 0; 188 ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */ 189 ctrlr->vcprop.cap.bits.mqes = transport->opts.max_queue_depth - 190 1; /* max queue depth */ 191 ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */ 192 ctrlr->vcprop.cap.bits.to = 1; /* ready timeout - 500 msec units */ 193 ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */ 194 ctrlr->vcprop.cap.bits.css = SPDK_NVME_CAP_CSS_NVM; /* NVM command set */ 195 ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */ 196 ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */ 197 198 /* Version Supported: 1.3 */ 199 ctrlr->vcprop.vs.bits.mjr = 1; 200 ctrlr->vcprop.vs.bits.mnr = 3; 201 ctrlr->vcprop.vs.bits.ter = 0; 202 203 ctrlr->vcprop.cc.raw = 0; 204 ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */ 205 206 ctrlr->vcprop.csts.raw = 0; 207 ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */ 208 209 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw); 210 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "vs 0x%x\n", ctrlr->vcprop.vs.raw); 211 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cc 0x%x\n", ctrlr->vcprop.cc.raw); 212 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "csts 0x%x\n", ctrlr->vcprop.csts.raw); 213 214 req->qpair->ctrlr = ctrlr; 215 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_subsystem_add_ctrlr, req); 216 217 return ctrlr; 218 } 219 220 void 221 spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 222 { 223 spdk_nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr); 224 225 free(ctrlr); 226 } 227 228 static void 229 spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 230 { 231 struct spdk_nvmf_request *req = ctx; 232 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 233 struct spdk_nvmf_qpair *qpair = req->qpair; 234 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 235 236 /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect. 237 * For error case, the value should be NULL. So set it to NULL at first. 238 */ 239 qpair->ctrlr = NULL; 240 241 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 242 SPDK_ERRLOG("I/O connect not allowed on discovery controller\n"); 243 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 244 goto end; 245 } 246 247 if (!ctrlr->vcprop.cc.bits.en) { 248 SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n"); 249 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 250 goto end; 251 } 252 253 if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) { 254 SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n", 255 ctrlr->vcprop.cc.bits.iosqes); 256 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 257 goto end; 258 } 259 260 if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) { 261 SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n", 262 ctrlr->vcprop.cc.bits.iocqes); 263 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 264 goto end; 265 } 266 267 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 268 269 end: 270 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 271 } 272 273 static void 274 _spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 275 { 276 struct spdk_nvmf_request *req = ctx; 277 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 278 struct spdk_nvmf_fabric_connect_data *data = req->data; 279 struct spdk_nvmf_ctrlr *ctrlr; 280 struct spdk_nvmf_qpair *qpair = req->qpair; 281 struct spdk_nvmf_qpair *admin_qpair; 282 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 283 struct spdk_nvmf_subsystem *subsystem; 284 285 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect I/O Queue for controller id 0x%x\n", data->cntlid); 286 287 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 288 /* We already checked this in spdk_nvmf_ctrlr_connect */ 289 assert(subsystem != NULL); 290 291 ctrlr = spdk_nvmf_subsystem_get_ctrlr(subsystem, data->cntlid); 292 if (ctrlr == NULL) { 293 SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid); 294 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 295 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 296 return; 297 } 298 299 admin_qpair = ctrlr->admin_qpair; 300 qpair->ctrlr = ctrlr; 301 spdk_thread_send_msg(admin_qpair->group->thread, spdk_nvmf_ctrlr_add_io_qpair, req); 302 } 303 304 static int 305 spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 306 { 307 struct spdk_nvmf_fabric_connect_data *data = req->data; 308 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 309 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 310 struct spdk_nvmf_qpair *qpair = req->qpair; 311 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 312 struct spdk_nvmf_ctrlr *ctrlr; 313 struct spdk_nvmf_subsystem *subsystem; 314 const char *subnqn, *hostnqn; 315 struct spdk_nvme_transport_id listen_trid = {}; 316 void *end; 317 318 if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) { 319 SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length); 320 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 321 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 322 } 323 324 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "recfmt 0x%x qid %u sqsize %u\n", 325 cmd->recfmt, cmd->qid, cmd->sqsize); 326 327 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect data:\n"); 328 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " cntlid: 0x%04x\n", data->cntlid); 329 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n", 330 ntohl(*(uint32_t *)&data->hostid[0]), 331 ntohs(*(uint16_t *)&data->hostid[4]), 332 ntohs(*(uint16_t *)&data->hostid[6]), 333 data->hostid[8], 334 data->hostid[9], 335 ntohs(*(uint16_t *)&data->hostid[10]), 336 ntohl(*(uint32_t *)&data->hostid[12])); 337 338 if (cmd->recfmt != 0) { 339 SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt); 340 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 341 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT; 342 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 343 } 344 345 /* Ensure that subnqn is null terminated */ 346 end = memchr(data->subnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 347 if (!end) { 348 SPDK_ERRLOG("Connect SUBNQN is not null terminated\n"); 349 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 350 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 351 } 352 subnqn = data->subnqn; 353 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " subnqn: \"%s\"\n", subnqn); 354 355 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, subnqn); 356 if (subsystem == NULL) { 357 SPDK_ERRLOG("Could not find subsystem '%s'\n", subnqn); 358 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 359 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 360 } 361 362 if ((subsystem->state == SPDK_NVMF_SUBSYSTEM_INACTIVE) || 363 (subsystem->state == SPDK_NVMF_SUBSYSTEM_DEACTIVATING)) { 364 SPDK_ERRLOG("Subsystem '%s' is not ready\n", subnqn); 365 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 366 rsp->status.sc = SPDK_NVMF_FABRIC_SC_CONTROLLER_BUSY; 367 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 368 } 369 370 /* Ensure that hostnqn is null terminated */ 371 end = memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 372 if (!end) { 373 SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n"); 374 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn); 375 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 376 } 377 hostnqn = data->hostnqn; 378 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostnqn: \"%s\"\n", hostnqn); 379 380 if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) { 381 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subnqn, hostnqn); 382 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 383 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 384 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 385 } 386 387 if (spdk_nvmf_qpair_get_listen_trid(qpair, &listen_trid)) { 388 SPDK_ERRLOG("Subsystem '%s' is unable to enforce access control due to an internal error.\n", 389 subnqn); 390 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 391 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 392 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 393 } 394 395 if (!spdk_nvmf_subsystem_listener_allowed(subsystem, &listen_trid)) { 396 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s' to connect at this address.\n", subnqn, 397 hostnqn); 398 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 399 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 400 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 401 } 402 403 /* 404 * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and 405 * strictly less than max_queue_depth. 406 */ 407 if (cmd->sqsize == 0 || cmd->sqsize >= qpair->transport->opts.max_queue_depth) { 408 SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n", 409 cmd->sqsize, qpair->transport->opts.max_queue_depth - 1); 410 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 411 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 412 } 413 qpair->sq_head_max = cmd->sqsize; 414 qpair->qid = cmd->qid; 415 416 if (spdk_nvmf_transport_qpair_set_sqsize(qpair)) { 417 SPDK_ERRLOG("Can not create SQSIZE %u for qpair=%p\n", cmd->sqsize, qpair); 418 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 419 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 420 } 421 422 if (cmd->qid == 0) { 423 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid); 424 425 if (data->cntlid != 0xFFFF) { 426 /* This NVMf target only supports dynamic mode. */ 427 SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid); 428 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 429 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 430 } 431 432 /* Establish a new ctrlr */ 433 ctrlr = spdk_nvmf_ctrlr_create(subsystem, req, cmd, data); 434 if (!ctrlr) { 435 SPDK_ERRLOG("spdk_nvmf_ctrlr_create() failed\n"); 436 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 437 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 438 } else { 439 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 440 } 441 } else { 442 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_ctrlr_add_io_qpair, req); 443 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 444 } 445 } 446 447 static uint64_t 448 nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr) 449 { 450 return ctrlr->vcprop.cap.raw; 451 } 452 453 static uint64_t 454 nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr) 455 { 456 return ctrlr->vcprop.vs.raw; 457 } 458 459 static uint64_t 460 nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr) 461 { 462 return ctrlr->vcprop.cc.raw; 463 } 464 465 static bool 466 nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 467 { 468 union spdk_nvme_cc_register cc, diff; 469 470 cc.raw = (uint32_t)value; 471 472 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw); 473 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "new CC: 0x%08x\n", cc.raw); 474 475 /* 476 * Calculate which bits changed between the current and new CC. 477 * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed. 478 */ 479 diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw; 480 481 if (diff.bits.en) { 482 if (cc.bits.en) { 483 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Enable!\n"); 484 ctrlr->vcprop.cc.bits.en = 1; 485 ctrlr->vcprop.csts.bits.rdy = 1; 486 } else { 487 SPDK_ERRLOG("CC.EN transition from 1 to 0 (reset) not implemented!\n"); 488 489 } 490 diff.bits.en = 0; 491 } 492 493 if (diff.bits.shn) { 494 if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || 495 cc.bits.shn == SPDK_NVME_SHN_ABRUPT) { 496 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Shutdown %u%ub!\n", 497 cc.bits.shn >> 1, cc.bits.shn & 1); 498 ctrlr->vcprop.cc.bits.shn = cc.bits.shn; 499 ctrlr->vcprop.cc.bits.en = 0; 500 ctrlr->vcprop.csts.bits.rdy = 0; 501 ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE; 502 } else if (cc.bits.shn == 0) { 503 ctrlr->vcprop.cc.bits.shn = 0; 504 } else { 505 SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n", 506 cc.bits.shn >> 1, cc.bits.shn & 1); 507 return false; 508 } 509 diff.bits.shn = 0; 510 } 511 512 if (diff.bits.iosqes) { 513 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOSQES = %u (%u bytes)\n", 514 cc.bits.iosqes, 1u << cc.bits.iosqes); 515 ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes; 516 diff.bits.iosqes = 0; 517 } 518 519 if (diff.bits.iocqes) { 520 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOCQES = %u (%u bytes)\n", 521 cc.bits.iocqes, 1u << cc.bits.iocqes); 522 ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes; 523 diff.bits.iocqes = 0; 524 } 525 526 if (diff.raw != 0) { 527 SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw); 528 return false; 529 } 530 531 return true; 532 } 533 534 static uint64_t 535 nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr) 536 { 537 return ctrlr->vcprop.csts.raw; 538 } 539 540 struct nvmf_prop { 541 uint32_t ofst; 542 uint8_t size; 543 char name[11]; 544 uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr); 545 bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value); 546 }; 547 548 #define PROP(field, size, get_cb, set_cb) \ 549 { \ 550 offsetof(struct spdk_nvme_registers, field), \ 551 SPDK_NVMF_PROP_SIZE_##size, \ 552 #field, \ 553 get_cb, set_cb \ 554 } 555 556 static const struct nvmf_prop nvmf_props[] = { 557 PROP(cap, 8, nvmf_prop_get_cap, NULL), 558 PROP(vs, 4, nvmf_prop_get_vs, NULL), 559 PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc), 560 PROP(csts, 4, nvmf_prop_get_csts, NULL), 561 }; 562 563 static const struct nvmf_prop * 564 find_prop(uint32_t ofst) 565 { 566 size_t i; 567 568 for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) { 569 const struct nvmf_prop *prop = &nvmf_props[i]; 570 571 if (prop->ofst == ofst) { 572 return prop; 573 } 574 } 575 576 return NULL; 577 } 578 579 static int 580 spdk_nvmf_property_get(struct spdk_nvmf_request *req) 581 { 582 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 583 struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd; 584 struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp; 585 const struct nvmf_prop *prop; 586 587 response->status.sc = 0; 588 response->value.u64 = 0; 589 590 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x\n", 591 cmd->attrib.size, cmd->ofst); 592 593 if (cmd->attrib.size != SPDK_NVMF_PROP_SIZE_4 && 594 cmd->attrib.size != SPDK_NVMF_PROP_SIZE_8) { 595 SPDK_ERRLOG("Invalid size value %d\n", cmd->attrib.size); 596 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 597 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 598 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 599 } 600 601 prop = find_prop(cmd->ofst); 602 if (prop == NULL || prop->get_cb == NULL) { 603 /* Reserved properties return 0 when read */ 604 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 605 } 606 607 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 608 if (cmd->attrib.size != prop->size) { 609 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 610 cmd->ofst, cmd->attrib.size, prop->size); 611 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 612 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 613 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 614 } 615 616 response->value.u64 = prop->get_cb(ctrlr); 617 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "response value: 0x%" PRIx64 "\n", response->value.u64); 618 619 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 620 } 621 622 static int 623 spdk_nvmf_property_set(struct spdk_nvmf_request *req) 624 { 625 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 626 struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd; 627 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 628 const struct nvmf_prop *prop; 629 uint64_t value; 630 631 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x, value 0x%" PRIx64 "\n", 632 cmd->attrib.size, cmd->ofst, cmd->value.u64); 633 634 prop = find_prop(cmd->ofst); 635 if (prop == NULL || prop->set_cb == NULL) { 636 SPDK_ERRLOG("Invalid offset 0x%x\n", cmd->ofst); 637 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 638 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 639 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 640 } 641 642 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 643 if (cmd->attrib.size != prop->size) { 644 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 645 cmd->ofst, cmd->attrib.size, prop->size); 646 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 647 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 648 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 649 } 650 651 value = cmd->value.u64; 652 if (prop->size == SPDK_NVMF_PROP_SIZE_4) { 653 value = (uint32_t)value; 654 } 655 656 if (!prop->set_cb(ctrlr, value)) { 657 SPDK_ERRLOG("prop set_cb failed\n"); 658 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 659 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 660 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 661 } 662 663 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 664 } 665 666 static int 667 spdk_nvmf_ctrlr_set_features_arbitration(struct spdk_nvmf_request *req) 668 { 669 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 670 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 671 672 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Arbitration (cdw11 = 0x%0x)\n", cmd->cdw11); 673 674 ctrlr->feat.arbitration.raw = cmd->cdw11; 675 ctrlr->feat.arbitration.bits.reserved = 0; 676 677 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 678 } 679 680 static int 681 spdk_nvmf_ctrlr_set_features_power_management(struct spdk_nvmf_request *req) 682 { 683 union spdk_nvme_feat_power_management opts; 684 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 685 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 686 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 687 688 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Power Management (cdw11 = 0x%0x)\n", cmd->cdw11); 689 opts.raw = cmd->cdw11; 690 691 /* Only PS = 0 is allowed, since we report NPSS = 0 */ 692 if (opts.bits.ps != 0) { 693 SPDK_ERRLOG("Invalid power state %u\n", opts.bits.ps); 694 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 695 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 696 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 697 } 698 699 ctrlr->feat.power_management.raw = cmd->cdw11; 700 ctrlr->feat.power_management.bits.reserved = 0; 701 702 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 703 } 704 705 static bool 706 temp_threshold_opts_valid(const union spdk_nvme_feat_temperature_threshold *opts) 707 { 708 /* 709 * Valid TMPSEL values: 710 * 0000b - 1000b: temperature sensors 711 * 1111b: set all implemented temperature sensors 712 */ 713 if (opts->bits.tmpsel >= 9 && opts->bits.tmpsel != 15) { 714 /* 1001b - 1110b: reserved */ 715 SPDK_ERRLOG("Invalid TMPSEL %u\n", opts->bits.tmpsel); 716 return false; 717 } 718 719 /* 720 * Valid THSEL values: 721 * 00b: over temperature threshold 722 * 01b: under temperature threshold 723 */ 724 if (opts->bits.thsel > 1) { 725 /* 10b - 11b: reserved */ 726 SPDK_ERRLOG("Invalid THSEL %u\n", opts->bits.thsel); 727 return false; 728 } 729 730 return true; 731 } 732 733 static int 734 spdk_nvmf_ctrlr_set_features_temperature_threshold(struct spdk_nvmf_request *req) 735 { 736 union spdk_nvme_feat_temperature_threshold opts; 737 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 738 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 739 740 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 741 opts.raw = cmd->cdw11; 742 743 if (!temp_threshold_opts_valid(&opts)) { 744 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 745 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 746 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 747 } 748 749 /* TODO: no sensors implemented - ignore new values */ 750 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 751 } 752 753 static int 754 spdk_nvmf_ctrlr_get_features_temperature_threshold(struct spdk_nvmf_request *req) 755 { 756 union spdk_nvme_feat_temperature_threshold opts; 757 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 758 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 759 760 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 761 opts.raw = cmd->cdw11; 762 763 if (!temp_threshold_opts_valid(&opts)) { 764 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 765 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 766 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 767 } 768 769 /* TODO: no sensors implemented - return 0 for all thresholds */ 770 rsp->cdw0 = 0; 771 772 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 773 } 774 775 static int 776 spdk_nvmf_ctrlr_set_features_error_recovery(struct spdk_nvmf_request *req) 777 { 778 union spdk_nvme_feat_error_recovery opts; 779 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 780 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 781 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 782 783 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Error Recovery (cdw11 = 0x%0x)\n", cmd->cdw11); 784 opts.raw = cmd->cdw11; 785 786 if (opts.bits.dulbe) { 787 /* 788 * Host is not allowed to set this bit, since we don't advertise it in 789 * Identify Namespace. 790 */ 791 SPDK_ERRLOG("Host set unsupported DULBE bit\n"); 792 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 793 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 794 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 795 } 796 797 ctrlr->feat.error_recovery.raw = cmd->cdw11; 798 ctrlr->feat.error_recovery.bits.reserved = 0; 799 800 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 801 } 802 803 static int 804 spdk_nvmf_ctrlr_set_features_volatile_write_cache(struct spdk_nvmf_request *req) 805 { 806 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 807 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 808 809 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Volatile Write Cache (cdw11 = 0x%0x)\n", cmd->cdw11); 810 811 ctrlr->feat.volatile_write_cache.raw = cmd->cdw11; 812 ctrlr->feat.volatile_write_cache.bits.reserved = 0; 813 814 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Volatile Write Cache %s\n", 815 ctrlr->feat.volatile_write_cache.bits.wce ? "Enabled" : "Disabled"); 816 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 817 } 818 819 static int 820 spdk_nvmf_ctrlr_set_features_write_atomicity(struct spdk_nvmf_request *req) 821 { 822 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 823 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 824 825 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Write Atomicity (cdw11 = 0x%0x)\n", cmd->cdw11); 826 827 ctrlr->feat.write_atomicity.raw = cmd->cdw11; 828 ctrlr->feat.write_atomicity.bits.reserved = 0; 829 830 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 831 } 832 833 static int 834 spdk_nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req) 835 { 836 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 837 838 SPDK_ERRLOG("Set Features - Host Identifier not allowed\n"); 839 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 840 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 841 } 842 843 static int 844 spdk_nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req) 845 { 846 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 847 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 848 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 849 union spdk_nvme_feat_host_identifier opts; 850 851 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Host Identifier\n"); 852 853 opts.raw = cmd->cdw11; 854 if (!opts.bits.exhid) { 855 /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */ 856 SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n"); 857 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 858 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 859 } 860 861 if (req->data == NULL || req->length < sizeof(ctrlr->hostid)) { 862 SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n"); 863 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 864 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 865 } 866 867 spdk_uuid_copy((struct spdk_uuid *)req->data, &ctrlr->hostid); 868 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 869 } 870 871 static int 872 spdk_nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 873 { 874 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 875 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 876 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 877 878 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 879 880 if (cmd->cdw11 == 0) { 881 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 882 } else if (cmd->cdw11 < MIN_KEEP_ALIVE_TIMEOUT) { 883 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT; 884 } else { 885 ctrlr->feat.keep_alive_timer.bits.kato = cmd->cdw11; 886 } 887 888 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer set to %u ms\n", 889 ctrlr->feat.keep_alive_timer.bits.kato); 890 891 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 892 } 893 894 static int 895 spdk_nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 896 { 897 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 898 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 899 uint32_t count; 900 901 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Number of Queues, cdw11 0x%x\n", 902 req->cmd->nvme_cmd.cdw11); 903 904 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 905 /* verify that the controller is ready to process commands */ 906 if (count > 1) { 907 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Queue pairs already active!\n"); 908 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 909 } else { 910 /* 911 * Ignore the value requested by the host - 912 * always return the pre-configured value based on max_qpairs_allowed. 913 */ 914 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 915 } 916 917 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 918 } 919 920 static int 921 spdk_nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 922 { 923 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 924 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 925 926 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 927 cmd->cdw11); 928 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 929 ctrlr->feat.async_event_configuration.bits.reserved = 0; 930 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 931 } 932 933 static int 934 spdk_nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 935 { 936 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 937 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 938 939 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Async Event Request\n"); 940 941 /* Only one asynchronous event is supported for now */ 942 if (ctrlr->aer_req != NULL) { 943 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "AERL exceeded\n"); 944 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 945 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 946 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 947 } 948 949 if (ctrlr->notice_event.bits.async_event_type == 950 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 951 rsp->cdw0 = ctrlr->notice_event.raw; 952 ctrlr->notice_event.raw = 0; 953 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 954 } 955 956 ctrlr->aer_req = req; 957 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 958 } 959 960 static void 961 spdk_nvmf_get_firmware_slot_log_page(void *buffer, uint64_t offset, uint32_t length) 962 { 963 struct spdk_nvme_firmware_page fw_page; 964 size_t copy_len; 965 966 memset(&fw_page, 0, sizeof(fw_page)); 967 fw_page.afi.active_slot = 1; 968 fw_page.afi.next_reset_slot = 0; 969 spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' '); 970 971 if (offset < sizeof(fw_page)) { 972 copy_len = spdk_min(sizeof(fw_page) - offset, length); 973 if (copy_len > 0) { 974 memcpy(buffer, (const char *)&fw_page + offset, copy_len); 975 } 976 } 977 } 978 979 void 980 spdk_nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 981 { 982 uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list); 983 uint16_t i; 984 bool found = false; 985 986 for (i = 0; i < ctrlr->changed_ns_list_count; i++) { 987 if (ctrlr->changed_ns_list.ns_list[i] == nsid) { 988 /* nsid is already in the list */ 989 found = true; 990 break; 991 } 992 } 993 994 if (!found) { 995 if (ctrlr->changed_ns_list_count == max_changes) { 996 /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */ 997 ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu; 998 for (i = 1; i < max_changes; i++) { 999 ctrlr->changed_ns_list.ns_list[i] = 0; 1000 } 1001 } else { 1002 ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid; 1003 } 1004 } 1005 1006 spdk_nvmf_ctrlr_async_event_ns_notice(ctrlr); 1007 } 1008 1009 static void 1010 spdk_nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr, 1011 void *buffer, uint64_t offset, uint32_t length) 1012 { 1013 size_t copy_length; 1014 1015 if (offset < sizeof(ctrlr->changed_ns_list)) { 1016 copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset); 1017 if (copy_length) { 1018 memcpy(buffer, (char *)&ctrlr->changed_ns_list + offset, copy_length); 1019 } 1020 } 1021 1022 /* Clear log page each time it is read */ 1023 ctrlr->changed_ns_list_count = 0; 1024 memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list)); 1025 } 1026 1027 /* The structure can be modified if we provide support for other commands in future */ 1028 static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = { 1029 .admin_cmds_supported = { 1030 /* CSUPP, LBCC, NCC, NIC, CCC, CSE */ 1031 /* Get Log Page */ 1032 [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1033 /* Identify */ 1034 [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0}, 1035 /* Abort */ 1036 [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0}, 1037 /* Set Features */ 1038 [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1039 /* Get Features */ 1040 [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1041 /* Async Event Request */ 1042 [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0}, 1043 /* Keep Alive */ 1044 [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1045 }, 1046 .io_cmds_supported = { 1047 /* FLUSH */ 1048 [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0}, 1049 /* WRITE */ 1050 [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0}, 1051 /* READ */ 1052 [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0}, 1053 /* WRITE ZEROES */ 1054 [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0}, 1055 /* DATASET MANAGEMENT */ 1056 [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0}, 1057 }, 1058 }; 1059 1060 static void 1061 spdk_nvmf_get_cmds_and_effects_log_page(void *buffer, 1062 uint64_t offset, uint32_t length) 1063 { 1064 uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page); 1065 size_t copy_len = 0; 1066 size_t zero_len = length; 1067 1068 if (offset < page_size) { 1069 copy_len = spdk_min(page_size - offset, length); 1070 zero_len -= copy_len; 1071 memcpy(buffer, (char *)(&g_cmds_and_effect_log_page) + offset, copy_len); 1072 } 1073 1074 if (zero_len) { 1075 memset((char *)buffer + copy_len, 0, zero_len); 1076 } 1077 } 1078 1079 static int 1080 spdk_nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 1081 { 1082 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1083 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1084 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1085 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1086 uint64_t offset, len; 1087 uint32_t numdl, numdu; 1088 uint8_t lid; 1089 1090 if (req->data == NULL) { 1091 SPDK_ERRLOG("get log command with no buffer\n"); 1092 response->status.sct = SPDK_NVME_SCT_GENERIC; 1093 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1094 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1095 } 1096 1097 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 1098 if (offset & 3) { 1099 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 1100 response->status.sct = SPDK_NVME_SCT_GENERIC; 1101 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1102 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1103 } 1104 1105 numdl = (cmd->cdw10 >> 16) & 0xFFFFu; 1106 numdu = (cmd->cdw11) & 0xFFFFu; 1107 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 1108 if (len > req->length) { 1109 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 1110 len, req->length); 1111 response->status.sct = SPDK_NVME_SCT_GENERIC; 1112 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1113 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1114 } 1115 1116 lid = cmd->cdw10 & 0xFF; 1117 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 "\n", 1118 lid, offset, len); 1119 1120 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1121 switch (lid) { 1122 case SPDK_NVME_LOG_DISCOVERY: 1123 spdk_nvmf_get_discovery_log_page(subsystem->tgt, req->iov, req->iovcnt, offset, len); 1124 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1125 default: 1126 goto invalid_log_page; 1127 } 1128 } else { 1129 switch (lid) { 1130 case SPDK_NVME_LOG_ERROR: 1131 case SPDK_NVME_LOG_HEALTH_INFORMATION: 1132 /* TODO: actually fill out log page data */ 1133 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1134 case SPDK_NVME_LOG_FIRMWARE_SLOT: 1135 spdk_nvmf_get_firmware_slot_log_page(req->data, offset, len); 1136 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1137 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 1138 spdk_nvmf_get_cmds_and_effects_log_page(req->data, offset, len); 1139 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1140 case SPDK_NVME_LOG_CHANGED_NS_LIST: 1141 spdk_nvmf_get_changed_ns_list_log_page(ctrlr, req->data, offset, len); 1142 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1143 default: 1144 goto invalid_log_page; 1145 } 1146 } 1147 1148 invalid_log_page: 1149 SPDK_ERRLOG("Unsupported Get Log Page 0x%02X\n", lid); 1150 response->status.sct = SPDK_NVME_SCT_GENERIC; 1151 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1152 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1153 } 1154 1155 static int 1156 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_ctrlr *ctrlr, 1157 struct spdk_nvme_cmd *cmd, 1158 struct spdk_nvme_cpl *rsp, 1159 struct spdk_nvme_ns_data *nsdata) 1160 { 1161 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1162 struct spdk_nvmf_ns *ns; 1163 uint32_t max_num_blocks; 1164 1165 if (cmd->nsid == 0 || cmd->nsid > subsystem->max_nsid) { 1166 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", cmd->nsid); 1167 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1168 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1169 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1170 } 1171 1172 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1173 if (ns == NULL || ns->bdev == NULL) { 1174 /* 1175 * Inactive namespaces should return a zero filled data structure. 1176 * The data buffer is already zeroed by spdk_nvmf_ctrlr_process_admin_cmd(), 1177 * so we can just return early here. 1178 */ 1179 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Identify Namespace for inactive NSID %u\n", cmd->nsid); 1180 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1181 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1182 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1183 } 1184 1185 spdk_nvmf_bdev_ctrlr_identify_ns(ns, nsdata); 1186 1187 /* Due to bug in the Linux kernel NVMe driver we have to set noiob no larger than mdts */ 1188 max_num_blocks = ctrlr->admin_qpair->transport->opts.max_io_size / 1189 (1U << nsdata->lbaf[nsdata->flbas.format].lbads); 1190 if (nsdata->noiob > max_num_blocks) { 1191 nsdata->noiob = max_num_blocks; 1192 } 1193 1194 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1195 } 1196 1197 static int 1198 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 1199 { 1200 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1201 struct spdk_nvmf_transport *transport = ctrlr->admin_qpair->transport; 1202 1203 /* 1204 * Common fields for discovery and NVM subsystems 1205 */ 1206 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 1207 assert((transport->opts.max_io_size % 4096) == 0); 1208 cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096); 1209 cdata->cntlid = ctrlr->cntlid; 1210 cdata->ver = ctrlr->vcprop.vs; 1211 cdata->lpa.edlp = 1; 1212 cdata->elpe = 127; 1213 cdata->maxcmd = transport->opts.max_queue_depth; 1214 cdata->sgls.supported = 1; 1215 cdata->sgls.keyed_sgl = 1; 1216 cdata->sgls.sgl_offset = 1; 1217 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 1218 1219 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 1220 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 1221 1222 /* 1223 * NVM subsystem fields (reserved for discovery subsystems) 1224 */ 1225 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_NVME) { 1226 spdk_strcpy_pad(cdata->mn, MODEL_NUMBER, sizeof(cdata->mn), ' '); 1227 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 1228 cdata->kas = 10; 1229 1230 cdata->rab = 6; 1231 cdata->cmic.multi_port = 1; 1232 cdata->cmic.multi_host = 1; 1233 cdata->oaes.ns_attribute_notices = 1; 1234 cdata->ctratt.host_id_exhid_supported = 1; 1235 cdata->aerl = 0; 1236 cdata->frmw.slot1_ro = 1; 1237 cdata->frmw.num_slots = 1; 1238 1239 cdata->lpa.celp = 1; /* Command Effects log page supported */ 1240 1241 cdata->sqes.min = 6; 1242 cdata->sqes.max = 6; 1243 cdata->cqes.min = 4; 1244 cdata->cqes.max = 4; 1245 cdata->nn = subsystem->max_nsid; 1246 cdata->vwc.present = 1; 1247 cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED; 1248 1249 cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16; 1250 cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16; 1251 cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */ 1252 cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC; 1253 cdata->nvmf_specific.msdbd = 1; /* target supports single SGL in capsule */ 1254 1255 /* TODO: this should be set by the transport */ 1256 cdata->nvmf_specific.ioccsz += transport->opts.in_capsule_data_size / 16; 1257 1258 cdata->oncs.dsm = spdk_nvmf_ctrlr_dsm_supported(ctrlr); 1259 cdata->oncs.write_zeroes = spdk_nvmf_ctrlr_write_zeroes_supported(ctrlr); 1260 1261 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ioccsz 0x%x\n", 1262 cdata->nvmf_specific.ioccsz); 1263 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: iorcsz 0x%x\n", 1264 cdata->nvmf_specific.iorcsz); 1265 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: icdoff 0x%x\n", 1266 cdata->nvmf_specific.icdoff); 1267 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ctrattr 0x%x\n", 1268 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 1269 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: msdbd 0x%x\n", 1270 cdata->nvmf_specific.msdbd); 1271 } 1272 1273 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1274 } 1275 1276 static int 1277 spdk_nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_subsystem *subsystem, 1278 struct spdk_nvme_cmd *cmd, 1279 struct spdk_nvme_cpl *rsp, 1280 struct spdk_nvme_ns_list *ns_list) 1281 { 1282 struct spdk_nvmf_ns *ns; 1283 uint32_t count = 0; 1284 1285 if (cmd->nsid >= 0xfffffffeUL) { 1286 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 1287 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1288 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1289 } 1290 1291 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 1292 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 1293 if (ns->opts.nsid <= cmd->nsid) { 1294 continue; 1295 } 1296 1297 ns_list->ns_list[count++] = ns->opts.nsid; 1298 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 1299 break; 1300 } 1301 } 1302 1303 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1304 } 1305 1306 static void 1307 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 1308 enum spdk_nvme_nidt type, 1309 const void *data, size_t data_size) 1310 { 1311 struct spdk_nvme_ns_id_desc *desc; 1312 size_t desc_size = sizeof(*desc) + data_size; 1313 1314 /* 1315 * These should never fail in practice, since all valid NS ID descriptors 1316 * should be defined so that they fit in the available 4096-byte buffer. 1317 */ 1318 assert(data_size > 0); 1319 assert(data_size <= UINT8_MAX); 1320 assert(desc_size < *buf_remain); 1321 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 1322 return; 1323 } 1324 1325 desc = *buf_ptr; 1326 desc->nidt = type; 1327 desc->nidl = data_size; 1328 memcpy(desc->nid, data, data_size); 1329 1330 *buf_ptr += desc_size; 1331 *buf_remain -= desc_size; 1332 } 1333 1334 static int 1335 spdk_nvmf_ctrlr_identify_ns_id_descriptor_list( 1336 struct spdk_nvmf_subsystem *subsystem, 1337 struct spdk_nvme_cmd *cmd, 1338 struct spdk_nvme_cpl *rsp, 1339 void *id_desc_list, size_t id_desc_list_size) 1340 { 1341 struct spdk_nvmf_ns *ns; 1342 size_t buf_remain = id_desc_list_size; 1343 void *buf_ptr = id_desc_list; 1344 1345 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1346 if (ns == NULL || ns->bdev == NULL) { 1347 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1348 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1349 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1350 } 1351 1352 #define ADD_ID_DESC(type, data, size) \ 1353 do { \ 1354 if (!spdk_mem_all_zero(data, size)) { \ 1355 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 1356 } \ 1357 } while (0) 1358 1359 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 1360 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 1361 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 1362 1363 /* 1364 * The list is automatically 0-terminated because controller to host buffers in 1365 * admin commands always get zeroed in spdk_nvmf_ctrlr_process_admin_cmd(). 1366 */ 1367 1368 #undef ADD_ID_DESC 1369 1370 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1371 } 1372 1373 static int 1374 spdk_nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 1375 { 1376 uint8_t cns; 1377 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1378 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1379 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1380 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1381 1382 if (req->data == NULL || req->length < 4096) { 1383 SPDK_ERRLOG("identify command with invalid buffer\n"); 1384 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1385 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1386 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1387 } 1388 1389 cns = cmd->cdw10 & 0xFF; 1390 1391 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY && 1392 cns != SPDK_NVME_IDENTIFY_CTRLR) { 1393 /* Discovery controllers only support Identify Controller */ 1394 goto invalid_cns; 1395 } 1396 1397 switch (cns) { 1398 case SPDK_NVME_IDENTIFY_NS: 1399 return spdk_nvmf_ctrlr_identify_ns(ctrlr, cmd, rsp, req->data); 1400 case SPDK_NVME_IDENTIFY_CTRLR: 1401 return spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, req->data); 1402 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 1403 return spdk_nvmf_ctrlr_identify_active_ns_list(subsystem, cmd, rsp, req->data); 1404 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 1405 return spdk_nvmf_ctrlr_identify_ns_id_descriptor_list(subsystem, cmd, rsp, req->data, req->length); 1406 default: 1407 goto invalid_cns; 1408 } 1409 1410 invalid_cns: 1411 SPDK_ERRLOG("Identify command with unsupported CNS 0x%02x\n", cns); 1412 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1413 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1414 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1415 } 1416 1417 1418 static struct spdk_nvmf_request * 1419 spdk_nvmf_qpair_abort(struct spdk_nvmf_qpair *qpair, uint16_t cid) 1420 { 1421 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1422 struct spdk_nvmf_request *req; 1423 1424 if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1425 if (ctrlr->aer_req && ctrlr->aer_req->cmd->nvme_cmd.cid == cid) { 1426 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Aborting AER request\n"); 1427 req = ctrlr->aer_req; 1428 ctrlr->aer_req = NULL; 1429 return req; 1430 } 1431 } 1432 1433 /* TODO: track list of outstanding requests in qpair? */ 1434 return NULL; 1435 } 1436 1437 static void 1438 spdk_nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status) 1439 { 1440 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1441 1442 spdk_nvmf_request_complete(req); 1443 } 1444 1445 static void 1446 spdk_nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i) 1447 { 1448 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1449 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 1450 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 1451 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1452 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1453 uint16_t sqid = cmd->cdw10 & 0xFFFFu; 1454 struct spdk_nvmf_qpair *qpair; 1455 1456 TAILQ_FOREACH(qpair, &group->qpairs, link) { 1457 if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) { 1458 struct spdk_nvmf_request *req_to_abort; 1459 uint16_t cid = cmd->cdw10 >> 16; 1460 1461 /* Found the qpair */ 1462 1463 req_to_abort = spdk_nvmf_qpair_abort(qpair, cid); 1464 if (req_to_abort == NULL) { 1465 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cid %u not found\n", cid); 1466 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1467 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1468 spdk_for_each_channel_continue(i, -EINVAL); 1469 return; 1470 } 1471 1472 /* Complete the request with aborted status */ 1473 req_to_abort->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1474 req_to_abort->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 1475 spdk_nvmf_request_complete(req_to_abort); 1476 1477 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "abort ctrlr=%p req=%p sqid=%u cid=%u successful\n", 1478 qpair->ctrlr, req_to_abort, sqid, cid); 1479 rsp->cdw0 = 0; /* Command successfully aborted */ 1480 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1481 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1482 /* Return -1 for the status so the iteration across threads stops. */ 1483 spdk_for_each_channel_continue(i, -1); 1484 1485 } 1486 } 1487 1488 spdk_for_each_channel_continue(i, 0); 1489 } 1490 1491 static int 1492 spdk_nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 1493 { 1494 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1495 1496 rsp->cdw0 = 1; /* Command not aborted */ 1497 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1498 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 1499 1500 /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */ 1501 spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt, 1502 spdk_nvmf_ctrlr_abort_on_pg, 1503 req, 1504 spdk_nvmf_ctrlr_abort_done 1505 ); 1506 1507 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 1508 } 1509 1510 static int 1511 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 1512 { 1513 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1514 1515 rsp->cdw0 = cdw0; 1516 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1517 } 1518 1519 static int 1520 spdk_nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 1521 { 1522 uint8_t feature; 1523 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1524 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1525 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1526 1527 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1528 switch (feature) { 1529 case SPDK_NVME_FEAT_ARBITRATION: 1530 return get_features_generic(req, ctrlr->feat.arbitration.raw); 1531 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 1532 return get_features_generic(req, ctrlr->feat.power_management.raw); 1533 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 1534 return spdk_nvmf_ctrlr_get_features_temperature_threshold(req); 1535 case SPDK_NVME_FEAT_ERROR_RECOVERY: 1536 return get_features_generic(req, ctrlr->feat.error_recovery.raw); 1537 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 1538 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 1539 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1540 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 1541 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 1542 return get_features_generic(req, ctrlr->feat.write_atomicity.raw); 1543 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1544 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 1545 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1546 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 1547 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1548 return spdk_nvmf_ctrlr_get_features_host_identifier(req); 1549 default: 1550 SPDK_ERRLOG("Get Features command with unsupported feature ID 0x%02x\n", feature); 1551 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1552 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1553 } 1554 } 1555 1556 static int 1557 spdk_nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 1558 { 1559 uint8_t feature; 1560 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1561 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1562 1563 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1564 switch (feature) { 1565 case SPDK_NVME_FEAT_ARBITRATION: 1566 return spdk_nvmf_ctrlr_set_features_arbitration(req); 1567 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 1568 return spdk_nvmf_ctrlr_set_features_power_management(req); 1569 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 1570 return spdk_nvmf_ctrlr_set_features_temperature_threshold(req); 1571 case SPDK_NVME_FEAT_ERROR_RECOVERY: 1572 return spdk_nvmf_ctrlr_set_features_error_recovery(req); 1573 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 1574 return spdk_nvmf_ctrlr_set_features_volatile_write_cache(req); 1575 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1576 return spdk_nvmf_ctrlr_set_features_number_of_queues(req); 1577 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 1578 return spdk_nvmf_ctrlr_set_features_write_atomicity(req); 1579 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1580 return spdk_nvmf_ctrlr_set_features_async_event_configuration(req); 1581 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1582 return spdk_nvmf_ctrlr_set_features_keep_alive_timer(req); 1583 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1584 return spdk_nvmf_ctrlr_set_features_host_identifier(req); 1585 default: 1586 SPDK_ERRLOG("Set Features command with unsupported feature ID 0x%02x\n", feature); 1587 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1588 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1589 } 1590 } 1591 1592 static int 1593 spdk_nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 1594 { 1595 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Keep Alive\n"); 1596 /* 1597 * To handle keep alive just clear or reset the 1598 * ctrlr based keep alive duration counter. 1599 * When added, a separate timer based process 1600 * will monitor if the time since last recorded 1601 * keep alive has exceeded the max duration and 1602 * take appropriate action. 1603 */ 1604 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1605 } 1606 1607 int 1608 spdk_nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 1609 { 1610 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1611 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1612 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1613 1614 if (ctrlr == NULL) { 1615 SPDK_ERRLOG("Admin command sent before CONNECT\n"); 1616 response->status.sct = SPDK_NVME_SCT_GENERIC; 1617 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1618 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1619 } 1620 1621 if (ctrlr->vcprop.cc.bits.en != 1) { 1622 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 1623 response->status.sct = SPDK_NVME_SCT_GENERIC; 1624 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1625 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1626 } 1627 1628 if (req->data && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 1629 memset(req->data, 0, req->length); 1630 } 1631 1632 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1633 /* Discovery controllers only support Get Log Page and Identify */ 1634 switch (cmd->opc) { 1635 case SPDK_NVME_OPC_IDENTIFY: 1636 case SPDK_NVME_OPC_GET_LOG_PAGE: 1637 break; 1638 default: 1639 goto invalid_opcode; 1640 } 1641 } 1642 1643 switch (cmd->opc) { 1644 case SPDK_NVME_OPC_GET_LOG_PAGE: 1645 return spdk_nvmf_ctrlr_get_log_page(req); 1646 case SPDK_NVME_OPC_IDENTIFY: 1647 return spdk_nvmf_ctrlr_identify(req); 1648 case SPDK_NVME_OPC_ABORT: 1649 return spdk_nvmf_ctrlr_abort(req); 1650 case SPDK_NVME_OPC_GET_FEATURES: 1651 return spdk_nvmf_ctrlr_get_features(req); 1652 case SPDK_NVME_OPC_SET_FEATURES: 1653 return spdk_nvmf_ctrlr_set_features(req); 1654 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 1655 return spdk_nvmf_ctrlr_async_event_request(req); 1656 case SPDK_NVME_OPC_KEEP_ALIVE: 1657 return spdk_nvmf_ctrlr_keep_alive(req); 1658 1659 case SPDK_NVME_OPC_CREATE_IO_SQ: 1660 case SPDK_NVME_OPC_CREATE_IO_CQ: 1661 case SPDK_NVME_OPC_DELETE_IO_SQ: 1662 case SPDK_NVME_OPC_DELETE_IO_CQ: 1663 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 1664 goto invalid_opcode; 1665 1666 default: 1667 goto invalid_opcode; 1668 } 1669 1670 invalid_opcode: 1671 SPDK_ERRLOG("Unsupported admin opcode 0x%x\n", cmd->opc); 1672 response->status.sct = SPDK_NVME_SCT_GENERIC; 1673 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1674 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1675 } 1676 1677 int 1678 spdk_nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 1679 { 1680 struct spdk_nvmf_qpair *qpair = req->qpair; 1681 struct spdk_nvmf_capsule_cmd *cap_hdr; 1682 1683 cap_hdr = &req->cmd->nvmf_cmd; 1684 1685 if (qpair->ctrlr == NULL) { 1686 /* No ctrlr established yet; the only valid command is Connect */ 1687 if (cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 1688 return spdk_nvmf_ctrlr_connect(req); 1689 } else { 1690 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Got fctype 0x%x, expected Connect\n", 1691 cap_hdr->fctype); 1692 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1693 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1694 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1695 } 1696 } else if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1697 /* 1698 * Controller session is established, and this is an admin queue. 1699 * Disallow Connect and allow other fabrics commands. 1700 */ 1701 switch (cap_hdr->fctype) { 1702 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 1703 return spdk_nvmf_property_set(req); 1704 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 1705 return spdk_nvmf_property_get(req); 1706 default: 1707 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "unknown fctype 0x%02x\n", 1708 cap_hdr->fctype); 1709 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1710 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1711 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1712 } 1713 } else { 1714 /* Controller session is established, and this is an I/O queue */ 1715 /* For now, no I/O-specific Fabrics commands are implemented (other than Connect) */ 1716 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 1717 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1718 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1719 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1720 } 1721 } 1722 1723 int 1724 spdk_nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 1725 { 1726 struct spdk_nvmf_request *req; 1727 struct spdk_nvme_cpl *rsp; 1728 union spdk_nvme_async_event_completion event = {0}; 1729 1730 /* Users may disable the event notification */ 1731 if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) { 1732 return 0; 1733 } 1734 1735 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 1736 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED; 1737 event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST; 1738 1739 /* If there is no outstanding AER request, queue the event. Then 1740 * if an AER is later submitted, this event can be sent as a 1741 * response. 1742 */ 1743 if (!ctrlr->aer_req) { 1744 if (ctrlr->notice_event.bits.async_event_type == 1745 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 1746 return 0; 1747 } 1748 1749 ctrlr->notice_event.raw = event.raw; 1750 return 0; 1751 } 1752 1753 req = ctrlr->aer_req; 1754 rsp = &req->rsp->nvme_cpl; 1755 1756 rsp->cdw0 = event.raw; 1757 1758 spdk_nvmf_request_complete(req); 1759 ctrlr->aer_req = NULL; 1760 1761 return 0; 1762 } 1763 1764 void 1765 spdk_nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair) 1766 { 1767 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1768 1769 if (!spdk_nvmf_qpair_is_admin_queue(qpair)) { 1770 return; 1771 } 1772 1773 if (ctrlr->aer_req != NULL) { 1774 spdk_nvmf_request_free(ctrlr->aer_req); 1775 ctrlr->aer_req = NULL; 1776 } 1777 } 1778 1779 void 1780 spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr) 1781 { 1782 if (!ctrlr->aer_req) { 1783 return; 1784 } 1785 1786 spdk_nvmf_request_complete(ctrlr->aer_req); 1787 ctrlr->aer_req = NULL; 1788 } 1789