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