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/endian.h" 40 #include "spdk/io_channel.h" 41 #include "spdk/trace.h" 42 #include "spdk/nvme_spec.h" 43 #include "spdk/string.h" 44 #include "spdk/util.h" 45 #include "spdk/version.h" 46 47 #include "spdk_internal/log.h" 48 49 #define MIN_KEEP_ALIVE_TIMEOUT 10000 50 51 #define MODEL_NUMBER "SPDK bdev Controller" 52 53 /* 54 * Report the SPDK version as the firmware revision. 55 * SPDK_VERSION_STRING won't fit into FR (only 8 bytes), so try to fit the most important parts. 56 */ 57 #define FW_VERSION SPDK_VERSION_MAJOR_STRING SPDK_VERSION_MINOR_STRING SPDK_VERSION_PATCH_STRING 58 59 static inline void 60 spdk_nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp, 61 uint8_t iattr, uint16_t ipo) 62 { 63 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 64 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 65 rsp->status_code_specific.invalid.iattr = iattr; 66 rsp->status_code_specific.invalid.ipo = ipo; 67 } 68 69 #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \ 70 spdk_nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field)) 71 #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \ 72 spdk_nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field)) 73 74 static void 75 ctrlr_add_qpair_and_update_rsp(struct spdk_nvmf_qpair *qpair, 76 struct spdk_nvmf_ctrlr *ctrlr, 77 struct spdk_nvmf_fabric_connect_rsp *rsp) 78 { 79 qpair->ctrlr = ctrlr; 80 ctrlr->num_qpairs++; 81 TAILQ_INSERT_HEAD(&ctrlr->qpairs, qpair, link); 82 83 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 84 rsp->status_code_specific.success.cntlid = ctrlr->cntlid; 85 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "connect capsule response: cntlid = 0x%04x\n", 86 rsp->status_code_specific.success.cntlid); 87 } 88 89 static void 90 _spdk_nvmf_request_complete(void *ctx) 91 { 92 struct spdk_nvmf_request *req = ctx; 93 94 spdk_nvmf_request_complete(req); 95 } 96 97 static void 98 _spdk_nvmf_ctrlr_add_admin_qpair(void *ctx) 99 { 100 struct spdk_nvmf_request *req = ctx; 101 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 102 struct spdk_nvmf_qpair *qpair = req->qpair; 103 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 104 105 ctrlr->admin_qpair = qpair; 106 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 107 spdk_nvmf_request_complete(req); 108 } 109 110 static void 111 _spdk_nvmf_subsystem_add_ctrlr(void *ctx) 112 { 113 struct spdk_nvmf_request *req = ctx; 114 struct spdk_nvmf_qpair *qpair = req->qpair; 115 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 116 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 117 118 if (spdk_nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) { 119 SPDK_ERRLOG("Unable to add controller to subsystem\n"); 120 free(ctrlr); 121 qpair->ctrlr = NULL; 122 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 123 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 124 return; 125 } 126 127 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_ctrlr_add_admin_qpair, req); 128 } 129 130 static struct spdk_nvmf_ctrlr * 131 spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 132 struct spdk_nvmf_request *req, 133 struct spdk_nvmf_fabric_connect_cmd *connect_cmd, 134 struct spdk_nvmf_fabric_connect_data *connect_data) 135 { 136 struct spdk_nvmf_ctrlr *ctrlr; 137 struct spdk_nvmf_tgt *tgt; 138 139 tgt = subsystem->tgt; 140 141 ctrlr = calloc(1, sizeof(*ctrlr)); 142 if (ctrlr == NULL) { 143 SPDK_ERRLOG("Memory allocation failed\n"); 144 return NULL; 145 } 146 147 req->qpair->ctrlr = ctrlr; 148 TAILQ_INIT(&ctrlr->qpairs); 149 ctrlr->num_qpairs = 0; 150 ctrlr->subsys = subsystem; 151 ctrlr->max_qpairs_allowed = tgt->opts.max_qpairs_per_ctrlr; 152 153 ctrlr->feat.keep_alive_timer.bits.kato = connect_cmd->kato; 154 155 ctrlr->feat.volatile_write_cache.bits.wce = 1; 156 157 /* Subtract 1 for admin queue, 1 for 0's based */ 158 ctrlr->feat.number_of_queues.bits.ncqr = ctrlr->max_qpairs_allowed - 1 - 1; 159 ctrlr->feat.number_of_queues.bits.nsqr = ctrlr->max_qpairs_allowed - 1 - 1; 160 161 memcpy(ctrlr->hostid, connect_data->hostid, sizeof(ctrlr->hostid)); 162 163 ctrlr->vcprop.cap.raw = 0; 164 ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */ 165 ctrlr->vcprop.cap.bits.mqes = tgt->opts.max_queue_depth - 1; /* max queue depth */ 166 ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */ 167 ctrlr->vcprop.cap.bits.to = 1; /* ready timeout - 500 msec units */ 168 ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */ 169 ctrlr->vcprop.cap.bits.css_nvm = 1; /* NVM command set */ 170 ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */ 171 ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */ 172 173 /* Version Supported: 1.3 */ 174 ctrlr->vcprop.vs.bits.mjr = 1; 175 ctrlr->vcprop.vs.bits.mnr = 3; 176 ctrlr->vcprop.vs.bits.ter = 0; 177 178 ctrlr->vcprop.cc.raw = 0; 179 ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */ 180 181 ctrlr->vcprop.csts.raw = 0; 182 ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */ 183 184 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw); 185 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "vs 0x%x\n", ctrlr->vcprop.vs.raw); 186 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cc 0x%x\n", ctrlr->vcprop.cc.raw); 187 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "csts 0x%x\n", ctrlr->vcprop.csts.raw); 188 189 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_subsystem_add_ctrlr, req); 190 191 return ctrlr; 192 } 193 194 static void ctrlr_destruct(void *ctx) 195 { 196 struct spdk_nvmf_ctrlr *ctrlr = ctx; 197 198 spdk_nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr); 199 free(ctrlr); 200 } 201 202 void 203 spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 204 { 205 while (!TAILQ_EMPTY(&ctrlr->qpairs)) { 206 struct spdk_nvmf_qpair *qpair = TAILQ_FIRST(&ctrlr->qpairs); 207 208 TAILQ_REMOVE(&ctrlr->qpairs, qpair, link); 209 ctrlr->num_qpairs--; 210 spdk_nvmf_transport_qpair_fini(qpair); 211 } 212 213 ctrlr_destruct(ctrlr); 214 } 215 216 static void 217 spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 218 { 219 struct spdk_nvmf_request *req = ctx; 220 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 221 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 222 struct spdk_nvmf_qpair *qpair = req->qpair; 223 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 224 225 /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect. 226 * For error case, the value should be NULL. So set it to NULL at first. 227 */ 228 qpair->ctrlr = NULL; 229 230 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 231 SPDK_ERRLOG("I/O connect not allowed on discovery controller\n"); 232 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 233 goto end; 234 } 235 236 if (!ctrlr->vcprop.cc.bits.en) { 237 SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n"); 238 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 239 goto end; 240 } 241 242 if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) { 243 SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n", 244 ctrlr->vcprop.cc.bits.iosqes); 245 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 246 goto end; 247 } 248 249 if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) { 250 SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n", 251 ctrlr->vcprop.cc.bits.iocqes); 252 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 253 goto end; 254 } 255 256 if (spdk_nvmf_ctrlr_get_qpair(ctrlr, cmd->qid)) { 257 SPDK_ERRLOG("Got I/O connect with duplicate QID %u\n", cmd->qid); 258 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 259 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 260 goto end; 261 } 262 263 /* check if we would exceed ctrlr connection limit */ 264 if (ctrlr->num_qpairs >= ctrlr->max_qpairs_allowed) { 265 SPDK_ERRLOG("qpair limit %d\n", ctrlr->num_qpairs); 266 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 267 rsp->status.sc = SPDK_NVMF_FABRIC_SC_CONTROLLER_BUSY; 268 goto end; 269 } 270 271 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 272 273 end: 274 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 275 } 276 277 static void 278 ctrlr_delete_qpair(void *ctx) 279 { 280 struct spdk_nvmf_qpair *qpair = ctx; 281 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 282 283 assert(ctrlr != NULL); 284 285 ctrlr->num_qpairs--; 286 TAILQ_REMOVE(&ctrlr->qpairs, qpair, link); 287 spdk_nvmf_transport_qpair_fini(qpair); 288 289 if (ctrlr->num_qpairs == 0) { 290 spdk_thread_send_msg(ctrlr->subsys->thread, ctrlr_destruct, ctrlr); 291 } 292 } 293 294 static void 295 _spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 296 { 297 struct spdk_nvmf_request *req = ctx; 298 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 299 struct spdk_nvmf_fabric_connect_data *data = req->data; 300 struct spdk_nvmf_ctrlr *ctrlr; 301 struct spdk_nvmf_qpair *qpair = req->qpair; 302 struct spdk_nvmf_qpair *admin_qpair; 303 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 304 struct spdk_nvmf_subsystem *subsystem; 305 306 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect I/O Queue for controller id 0x%x\n", data->cntlid); 307 308 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 309 /* We already checked this in spdk_nvmf_ctrlr_connect */ 310 assert(subsystem != NULL); 311 312 ctrlr = spdk_nvmf_subsystem_get_ctrlr(subsystem, data->cntlid); 313 if (ctrlr == NULL) { 314 SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid); 315 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 316 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 317 return; 318 } 319 320 admin_qpair = ctrlr->admin_qpair; 321 qpair->ctrlr = ctrlr; 322 spdk_thread_send_msg(admin_qpair->group->thread, spdk_nvmf_ctrlr_add_io_qpair, req); 323 } 324 325 static int 326 spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 327 { 328 struct spdk_nvmf_fabric_connect_data *data = req->data; 329 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 330 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 331 struct spdk_nvmf_qpair *qpair = req->qpair; 332 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 333 struct spdk_nvmf_ctrlr *ctrlr; 334 struct spdk_nvmf_subsystem *subsystem; 335 const char *subnqn, *hostnqn; 336 void *end; 337 338 if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) { 339 SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length); 340 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 341 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 342 } 343 344 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "recfmt 0x%x qid %u sqsize %u\n", 345 cmd->recfmt, cmd->qid, cmd->sqsize); 346 347 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect data:\n"); 348 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " cntlid: 0x%04x\n", data->cntlid); 349 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n", 350 ntohl(*(uint32_t *)&data->hostid[0]), 351 ntohs(*(uint16_t *)&data->hostid[4]), 352 ntohs(*(uint16_t *)&data->hostid[6]), 353 data->hostid[8], 354 data->hostid[9], 355 ntohs(*(uint16_t *)&data->hostid[10]), 356 ntohl(*(uint32_t *)&data->hostid[12])); 357 358 if (cmd->recfmt != 0) { 359 SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt); 360 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 361 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT; 362 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 363 } 364 365 /* Ensure that subnqn is null terminated */ 366 end = memchr(data->subnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 367 if (!end) { 368 SPDK_ERRLOG("Connect SUBNQN is not null terminated\n"); 369 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 370 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 371 } 372 subnqn = data->subnqn; 373 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " subnqn: \"%s\"\n", subnqn); 374 375 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, subnqn); 376 if (subsystem == NULL) { 377 SPDK_ERRLOG("Could not find subsystem '%s'\n", subnqn); 378 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 379 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 380 } 381 382 /* Ensure that hostnqn is null terminated */ 383 end = memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 384 if (!end) { 385 SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n"); 386 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn); 387 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 388 } 389 hostnqn = data->hostnqn; 390 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostnqn: \"%s\"\n", hostnqn); 391 392 if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) { 393 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subnqn, hostnqn); 394 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 395 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 396 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 397 } 398 399 /* 400 * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and 401 * strictly less than max_queue_depth. 402 */ 403 if (cmd->sqsize == 0 || cmd->sqsize >= tgt->opts.max_queue_depth) { 404 SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n", 405 cmd->sqsize, tgt->opts.max_queue_depth - 1); 406 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 407 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 408 } 409 qpair->sq_head_max = cmd->sqsize; 410 qpair->qid = cmd->qid; 411 412 if (cmd->qid == 0) { 413 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid); 414 415 if (data->cntlid != 0xFFFF) { 416 /* This NVMf target only supports dynamic mode. */ 417 SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid); 418 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 419 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 420 } 421 422 /* Establish a new ctrlr */ 423 ctrlr = spdk_nvmf_ctrlr_create(subsystem, req, cmd, data); 424 if (!ctrlr) { 425 SPDK_ERRLOG("spdk_nvmf_ctrlr_create() failed\n"); 426 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 427 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 428 } else { 429 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 430 } 431 } else { 432 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_ctrlr_add_io_qpair, req); 433 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 434 } 435 } 436 437 void 438 spdk_nvmf_ctrlr_disconnect(struct spdk_nvmf_qpair *qpair) 439 { 440 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 441 struct spdk_nvmf_qpair *admin_qpair = ctrlr->admin_qpair; 442 443 spdk_thread_send_msg(admin_qpair->group->thread, ctrlr_delete_qpair, qpair); 444 } 445 446 struct spdk_nvmf_qpair * 447 spdk_nvmf_ctrlr_get_qpair(struct spdk_nvmf_ctrlr *ctrlr, uint16_t qid) 448 { 449 struct spdk_nvmf_qpair *qpair; 450 451 TAILQ_FOREACH(qpair, &ctrlr->qpairs, link) { 452 if (qpair->qid == qid) { 453 return qpair; 454 } 455 } 456 return NULL; 457 } 458 459 static struct spdk_nvmf_request * 460 spdk_nvmf_qpair_get_request(struct spdk_nvmf_qpair *qpair, uint16_t cid) 461 { 462 /* TODO: track list of outstanding requests in qpair? */ 463 return NULL; 464 } 465 466 static uint64_t 467 nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr) 468 { 469 return ctrlr->vcprop.cap.raw; 470 } 471 472 static uint64_t 473 nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr) 474 { 475 return ctrlr->vcprop.vs.raw; 476 } 477 478 static uint64_t 479 nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr) 480 { 481 return ctrlr->vcprop.cc.raw; 482 } 483 484 static bool 485 nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 486 { 487 union spdk_nvme_cc_register cc, diff; 488 489 cc.raw = (uint32_t)value; 490 491 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw); 492 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "new CC: 0x%08x\n", cc.raw); 493 494 /* 495 * Calculate which bits changed between the current and new CC. 496 * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed. 497 */ 498 diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw; 499 500 if (diff.bits.en) { 501 if (cc.bits.en) { 502 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Enable!\n"); 503 ctrlr->vcprop.cc.bits.en = 1; 504 ctrlr->vcprop.csts.bits.rdy = 1; 505 } else { 506 SPDK_ERRLOG("CC.EN transition from 1 to 0 (reset) not implemented!\n"); 507 508 } 509 diff.bits.en = 0; 510 } 511 512 if (diff.bits.shn) { 513 if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || 514 cc.bits.shn == SPDK_NVME_SHN_ABRUPT) { 515 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Shutdown %u%ub!\n", 516 cc.bits.shn >> 1, cc.bits.shn & 1); 517 ctrlr->vcprop.cc.bits.shn = cc.bits.shn; 518 ctrlr->vcprop.cc.bits.en = 0; 519 ctrlr->vcprop.csts.bits.rdy = 0; 520 ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE; 521 } else if (cc.bits.shn == 0) { 522 ctrlr->vcprop.cc.bits.shn = 0; 523 } else { 524 SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n", 525 cc.bits.shn >> 1, cc.bits.shn & 1); 526 return false; 527 } 528 diff.bits.shn = 0; 529 } 530 531 if (diff.bits.iosqes) { 532 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOSQES = %u (%u bytes)\n", 533 cc.bits.iosqes, 1u << cc.bits.iosqes); 534 ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes; 535 diff.bits.iosqes = 0; 536 } 537 538 if (diff.bits.iocqes) { 539 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOCQES = %u (%u bytes)\n", 540 cc.bits.iocqes, 1u << cc.bits.iocqes); 541 ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes; 542 diff.bits.iocqes = 0; 543 } 544 545 if (diff.raw != 0) { 546 SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw); 547 return false; 548 } 549 550 return true; 551 } 552 553 static uint64_t 554 nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr) 555 { 556 return ctrlr->vcprop.csts.raw; 557 } 558 559 struct nvmf_prop { 560 uint32_t ofst; 561 uint8_t size; 562 char name[11]; 563 uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr); 564 bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value); 565 }; 566 567 #define PROP(field, size, get_cb, set_cb) \ 568 { \ 569 offsetof(struct spdk_nvme_registers, field), \ 570 SPDK_NVMF_PROP_SIZE_##size, \ 571 #field, \ 572 get_cb, set_cb \ 573 } 574 575 static const struct nvmf_prop nvmf_props[] = { 576 PROP(cap, 8, nvmf_prop_get_cap, NULL), 577 PROP(vs, 4, nvmf_prop_get_vs, NULL), 578 PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc), 579 PROP(csts, 4, nvmf_prop_get_csts, NULL), 580 }; 581 582 static const struct nvmf_prop * 583 find_prop(uint32_t ofst) 584 { 585 size_t i; 586 587 for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) { 588 const struct nvmf_prop *prop = &nvmf_props[i]; 589 590 if (prop->ofst == ofst) { 591 return prop; 592 } 593 } 594 595 return NULL; 596 } 597 598 static int 599 spdk_nvmf_property_get(struct spdk_nvmf_request *req) 600 { 601 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 602 struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd; 603 struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp; 604 const struct nvmf_prop *prop; 605 606 response->status.sc = 0; 607 response->value.u64 = 0; 608 609 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x\n", 610 cmd->attrib.size, cmd->ofst); 611 612 if (cmd->attrib.size != SPDK_NVMF_PROP_SIZE_4 && 613 cmd->attrib.size != SPDK_NVMF_PROP_SIZE_8) { 614 SPDK_ERRLOG("Invalid size value %d\n", cmd->attrib.size); 615 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 616 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 617 } 618 619 prop = find_prop(cmd->ofst); 620 if (prop == NULL || prop->get_cb == NULL) { 621 /* Reserved properties return 0 when read */ 622 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 623 } 624 625 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 626 if (cmd->attrib.size != prop->size) { 627 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 628 cmd->ofst, cmd->attrib.size, prop->size); 629 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 630 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 631 } 632 633 response->value.u64 = prop->get_cb(ctrlr); 634 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "response value: 0x%" PRIx64 "\n", response->value.u64); 635 636 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 637 } 638 639 static int 640 spdk_nvmf_property_set(struct spdk_nvmf_request *req) 641 { 642 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 643 struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd; 644 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 645 const struct nvmf_prop *prop; 646 uint64_t value; 647 648 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x, value 0x%" PRIx64 "\n", 649 cmd->attrib.size, cmd->ofst, cmd->value.u64); 650 651 prop = find_prop(cmd->ofst); 652 if (prop == NULL || prop->set_cb == NULL) { 653 SPDK_ERRLOG("Invalid offset 0x%x\n", cmd->ofst); 654 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 655 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 656 } 657 658 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 659 if (cmd->attrib.size != prop->size) { 660 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 661 cmd->ofst, cmd->attrib.size, prop->size); 662 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 663 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 664 } 665 666 value = cmd->value.u64; 667 if (prop->size == SPDK_NVMF_PROP_SIZE_4) { 668 value = (uint32_t)value; 669 } 670 671 if (!prop->set_cb(ctrlr, value)) { 672 SPDK_ERRLOG("prop set_cb failed\n"); 673 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 674 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 675 } 676 677 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 678 } 679 680 static int 681 spdk_nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req) 682 { 683 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 684 685 SPDK_ERRLOG("Set Features - Host Identifier not allowed\n"); 686 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 687 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 688 } 689 690 static int 691 spdk_nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req) 692 { 693 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 694 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 695 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 696 union spdk_nvme_feat_host_identifier opts; 697 698 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Host Identifier\n"); 699 700 opts.raw = cmd->cdw11; 701 if (!opts.bits.exhid) { 702 /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */ 703 SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n"); 704 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 705 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 706 } 707 708 if (req->data == NULL || req->length < sizeof(ctrlr->hostid)) { 709 SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n"); 710 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 711 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 712 } 713 714 memcpy(req->data, ctrlr->hostid, sizeof(ctrlr->hostid)); 715 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 716 } 717 718 static int 719 spdk_nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 720 { 721 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 722 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 723 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 724 725 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 726 727 if (cmd->cdw11 == 0) { 728 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 729 } else if (cmd->cdw11 < MIN_KEEP_ALIVE_TIMEOUT) { 730 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT; 731 } else { 732 ctrlr->feat.keep_alive_timer.bits.kato = cmd->cdw11; 733 } 734 735 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer set to %u ms\n", 736 ctrlr->feat.keep_alive_timer.bits.kato); 737 738 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 739 } 740 741 static int 742 spdk_nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 743 { 744 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 745 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 746 747 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Number of Queues, cdw11 0x%x\n", 748 req->cmd->nvme_cmd.cdw11); 749 750 /* verify that the contoller is ready to process commands */ 751 if (ctrlr->num_qpairs > 1) { 752 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Queue pairs already active!\n"); 753 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 754 } else { 755 /* 756 * Ignore the value requested by the host - 757 * always return the pre-configured value based on max_qpairs_allowed. 758 */ 759 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 760 } 761 762 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 763 } 764 765 static int 766 spdk_nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 767 { 768 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 769 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 770 771 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 772 cmd->cdw11); 773 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 774 ctrlr->feat.async_event_configuration.bits.reserved = 0; 775 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 776 } 777 778 static int 779 spdk_nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 780 { 781 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 782 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 783 784 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Async Event Request\n"); 785 786 /* Only one asynchronous event is supported for now */ 787 if (ctrlr->aer_req != NULL) { 788 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "AERL exceeded\n"); 789 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 790 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 791 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 792 } 793 794 ctrlr->aer_req = req; 795 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 796 } 797 798 static int 799 spdk_nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 800 { 801 struct spdk_nvmf_subsystem *subsystem = req->qpair->ctrlr->subsys; 802 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 803 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 804 uint64_t offset, len; 805 uint32_t numdl, numdu; 806 uint8_t lid; 807 808 if (req->data == NULL) { 809 SPDK_ERRLOG("get log command with no buffer\n"); 810 response->status.sct = SPDK_NVME_SCT_GENERIC; 811 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 812 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 813 } 814 815 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 816 if (offset & 3) { 817 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 818 response->status.sct = SPDK_NVME_SCT_GENERIC; 819 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 820 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 821 } 822 823 numdl = (cmd->cdw10 >> 16) & 0xFFFFu; 824 numdu = (cmd->cdw11) & 0xFFFFu; 825 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 826 if (len > req->length) { 827 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 828 len, req->length); 829 response->status.sct = SPDK_NVME_SCT_GENERIC; 830 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 831 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 832 } 833 834 lid = cmd->cdw10 & 0xFF; 835 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 "\n", 836 lid, offset, len); 837 838 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 839 switch (lid) { 840 case SPDK_NVME_LOG_DISCOVERY: 841 spdk_nvmf_get_discovery_log_page(subsystem->tgt, req->data, offset, len); 842 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 843 default: 844 goto invalid_log_page; 845 } 846 } else { 847 switch (lid) { 848 case SPDK_NVME_LOG_ERROR: 849 case SPDK_NVME_LOG_HEALTH_INFORMATION: 850 case SPDK_NVME_LOG_FIRMWARE_SLOT: 851 /* TODO: actually fill out log page data */ 852 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 853 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 854 spdk_nvmf_get_cmds_and_effects_log_page(req->data, offset, len); 855 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 856 default: 857 goto invalid_log_page; 858 } 859 } 860 861 invalid_log_page: 862 SPDK_ERRLOG("Unsupported Get Log Page 0x%02X\n", lid); 863 response->status.sct = SPDK_NVME_SCT_GENERIC; 864 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 865 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 866 } 867 868 static int 869 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_subsystem *subsystem, 870 struct spdk_nvme_cmd *cmd, 871 struct spdk_nvme_cpl *rsp, 872 struct spdk_nvme_ns_data *nsdata) 873 { 874 struct spdk_nvmf_ns *ns; 875 876 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 877 if (ns == NULL || ns->bdev == NULL) { 878 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", cmd->nsid); 879 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 880 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 881 } 882 883 return spdk_nvmf_bdev_ctrlr_identify_ns(ns, nsdata); 884 } 885 886 static int 887 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 888 { 889 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 890 struct spdk_nvmf_tgt *tgt = subsystem->tgt; 891 892 /* 893 * Common fields for discovery and NVM subsystems 894 */ 895 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 896 assert((tgt->opts.max_io_size % 4096) == 0); 897 cdata->mdts = spdk_u32log2(tgt->opts.max_io_size / 4096); 898 cdata->cntlid = ctrlr->cntlid; 899 cdata->ver = ctrlr->vcprop.vs; 900 cdata->lpa.edlp = 1; 901 cdata->elpe = 127; 902 cdata->maxcmd = tgt->opts.max_queue_depth; 903 cdata->sgls.supported = 1; 904 cdata->sgls.keyed_sgl = 1; 905 cdata->sgls.sgl_offset = 1; 906 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 907 908 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 909 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 910 911 /* 912 * NVM subsystem fields (reserved for discovery subsystems) 913 */ 914 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_NVME) { 915 spdk_strcpy_pad(cdata->mn, MODEL_NUMBER, sizeof(cdata->mn), ' '); 916 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 917 cdata->kas = 10; 918 919 cdata->rab = 6; 920 cdata->ctratt.host_id_exhid_supported = 1; 921 cdata->aerl = 0; 922 cdata->frmw.slot1_ro = 1; 923 cdata->frmw.num_slots = 1; 924 925 cdata->sqes.min = 6; 926 cdata->sqes.max = 6; 927 cdata->cqes.min = 4; 928 cdata->cqes.max = 4; 929 cdata->nn = subsystem->max_nsid; 930 cdata->vwc.present = 1; 931 932 cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16; 933 cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16; 934 cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */ 935 cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC; 936 cdata->nvmf_specific.msdbd = 1; /* target supports single SGL in capsule */ 937 938 /* TODO: this should be set by the transport */ 939 cdata->nvmf_specific.ioccsz += tgt->opts.in_capsule_data_size / 16; 940 941 cdata->oncs.dsm = spdk_nvmf_ctrlr_dsm_supported(ctrlr); 942 cdata->oncs.write_zeroes = spdk_nvmf_ctrlr_write_zeroes_supported(ctrlr); 943 944 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ioccsz 0x%x\n", 945 cdata->nvmf_specific.ioccsz); 946 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: iorcsz 0x%x\n", 947 cdata->nvmf_specific.iorcsz); 948 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: icdoff 0x%x\n", 949 cdata->nvmf_specific.icdoff); 950 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ctrattr 0x%x\n", 951 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 952 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: msdbd 0x%x\n", 953 cdata->nvmf_specific.msdbd); 954 } 955 956 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 957 } 958 959 static int 960 spdk_nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_subsystem *subsystem, 961 struct spdk_nvme_cmd *cmd, 962 struct spdk_nvme_cpl *rsp, 963 struct spdk_nvme_ns_list *ns_list) 964 { 965 struct spdk_nvmf_ns *ns; 966 uint32_t count = 0; 967 968 if (cmd->nsid >= 0xfffffffeUL) { 969 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 970 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 971 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 972 } 973 974 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 975 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 976 if (ns->opts.nsid <= cmd->nsid) { 977 continue; 978 } 979 980 ns_list->ns_list[count++] = ns->opts.nsid; 981 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 982 break; 983 } 984 } 985 986 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 987 } 988 989 static void 990 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 991 enum spdk_nvme_nidt type, 992 const void *data, size_t data_size) 993 { 994 struct spdk_nvme_ns_id_desc *desc; 995 size_t desc_size = sizeof(*desc) + data_size; 996 997 /* 998 * These should never fail in practice, since all valid NS ID descriptors 999 * should be defined so that they fit in the available 4096-byte buffer. 1000 */ 1001 assert(data_size > 0); 1002 assert(data_size <= UINT8_MAX); 1003 assert(desc_size < *buf_remain); 1004 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 1005 return; 1006 } 1007 1008 desc = *buf_ptr; 1009 desc->nidt = type; 1010 desc->nidl = data_size; 1011 memcpy(desc->nid, data, data_size); 1012 1013 *buf_ptr += desc_size; 1014 *buf_remain -= desc_size; 1015 } 1016 1017 static int 1018 spdk_nvmf_ctrlr_identify_ns_id_descriptor_list( 1019 struct spdk_nvmf_subsystem *subsystem, 1020 struct spdk_nvme_cmd *cmd, 1021 struct spdk_nvme_cpl *rsp, 1022 void *id_desc_list, size_t id_desc_list_size) 1023 { 1024 struct spdk_nvmf_ns *ns; 1025 size_t buf_remain = id_desc_list_size; 1026 void *buf_ptr = id_desc_list; 1027 1028 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1029 if (ns == NULL || ns->bdev == NULL) { 1030 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1031 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1032 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1033 } 1034 1035 #define ADD_ID_DESC(type, data, size) \ 1036 do { \ 1037 if (!spdk_mem_all_zero(data, size)) { \ 1038 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 1039 } \ 1040 } while (0) 1041 1042 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 1043 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 1044 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 1045 1046 /* 1047 * The list is automatically 0-terminated because controller to host buffers in 1048 * admin commands always get zeroed in spdk_nvmf_ctrlr_process_admin_cmd(). 1049 */ 1050 1051 #undef ADD_ID_DESC 1052 1053 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1054 } 1055 1056 static int 1057 spdk_nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 1058 { 1059 uint8_t cns; 1060 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1061 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1062 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1063 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1064 1065 if (req->data == NULL || req->length < 4096) { 1066 SPDK_ERRLOG("identify command with invalid buffer\n"); 1067 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1068 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1069 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1070 } 1071 1072 cns = cmd->cdw10 & 0xFF; 1073 1074 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY && 1075 cns != SPDK_NVME_IDENTIFY_CTRLR) { 1076 /* Discovery controllers only support Identify Controller */ 1077 goto invalid_cns; 1078 } 1079 1080 switch (cns) { 1081 case SPDK_NVME_IDENTIFY_NS: 1082 return spdk_nvmf_ctrlr_identify_ns(subsystem, cmd, rsp, req->data); 1083 case SPDK_NVME_IDENTIFY_CTRLR: 1084 return spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, req->data); 1085 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 1086 return spdk_nvmf_ctrlr_identify_active_ns_list(subsystem, cmd, rsp, req->data); 1087 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 1088 return spdk_nvmf_ctrlr_identify_ns_id_descriptor_list(subsystem, cmd, rsp, req->data, req->length); 1089 default: 1090 goto invalid_cns; 1091 } 1092 1093 invalid_cns: 1094 SPDK_ERRLOG("Identify command with unsupported CNS 0x%02x\n", cns); 1095 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1096 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1097 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1098 } 1099 1100 static int 1101 spdk_nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 1102 { 1103 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1104 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1105 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1106 uint32_t cdw10 = cmd->cdw10; 1107 uint16_t cid = cdw10 >> 16; 1108 uint16_t sqid = cdw10 & 0xFFFFu; 1109 struct spdk_nvmf_qpair *qpair; 1110 struct spdk_nvmf_request *req_to_abort; 1111 1112 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "abort sqid=%u cid=%u\n", sqid, cid); 1113 1114 rsp->cdw0 = 1; /* Command not aborted */ 1115 1116 qpair = spdk_nvmf_ctrlr_get_qpair(ctrlr, sqid); 1117 if (qpair == NULL) { 1118 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "sqid %u not found\n", sqid); 1119 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1120 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1121 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1122 } 1123 1124 /* 1125 * NOTE: This relies on the assumption that all connections for a ctrlr will be handled 1126 * on the same thread. If this assumption becomes untrue, this will need to pass a message 1127 * to the thread handling qpair, and the abort will need to be asynchronous. 1128 */ 1129 req_to_abort = spdk_nvmf_qpair_get_request(qpair, cid); 1130 if (req_to_abort == NULL) { 1131 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cid %u not found\n", cid); 1132 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1133 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1134 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1135 } 1136 1137 if (spdk_nvmf_request_abort(req_to_abort) == 0) { 1138 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "abort ctrlr=%p req=%p sqid=%u cid=%u successful\n", 1139 ctrlr, req_to_abort, sqid, cid); 1140 rsp->cdw0 = 0; /* Command successfully aborted */ 1141 } 1142 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1143 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1144 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1145 } 1146 1147 static int 1148 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 1149 { 1150 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1151 1152 rsp->cdw0 = cdw0; 1153 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1154 } 1155 1156 static int 1157 spdk_nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 1158 { 1159 uint8_t feature; 1160 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1161 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1162 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1163 1164 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1165 switch (feature) { 1166 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1167 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 1168 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 1169 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 1170 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1171 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 1172 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1173 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 1174 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1175 return spdk_nvmf_ctrlr_get_features_host_identifier(req); 1176 default: 1177 SPDK_ERRLOG("Get Features command with unsupported feature ID 0x%02x\n", feature); 1178 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1179 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1180 } 1181 } 1182 1183 static int 1184 spdk_nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 1185 { 1186 uint8_t feature; 1187 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1188 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1189 1190 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1191 switch (feature) { 1192 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1193 return spdk_nvmf_ctrlr_set_features_number_of_queues(req); 1194 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1195 return spdk_nvmf_ctrlr_set_features_keep_alive_timer(req); 1196 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1197 return spdk_nvmf_ctrlr_set_features_async_event_configuration(req); 1198 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1199 return spdk_nvmf_ctrlr_set_features_host_identifier(req); 1200 default: 1201 SPDK_ERRLOG("Set Features command with unsupported feature ID 0x%02x\n", feature); 1202 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1203 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1204 } 1205 } 1206 1207 static int 1208 spdk_nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 1209 { 1210 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Keep Alive\n"); 1211 /* 1212 * To handle keep alive just clear or reset the 1213 * ctrlr based keep alive duration counter. 1214 * When added, a separate timer based process 1215 * will monitor if the time since last recorded 1216 * keep alive has exceeded the max duration and 1217 * take appropriate action. 1218 */ 1219 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1220 } 1221 1222 int 1223 spdk_nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 1224 { 1225 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1226 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1227 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1228 1229 if (ctrlr == NULL) { 1230 SPDK_ERRLOG("Admin command sent before CONNECT\n"); 1231 response->status.sct = SPDK_NVME_SCT_GENERIC; 1232 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1233 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1234 } 1235 1236 if (ctrlr->vcprop.cc.bits.en != 1) { 1237 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 1238 response->status.sct = SPDK_NVME_SCT_GENERIC; 1239 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1240 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1241 } 1242 1243 if (req->data && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 1244 memset(req->data, 0, req->length); 1245 } 1246 1247 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1248 /* Discovery controllers only support Get Log Page and Identify */ 1249 switch (cmd->opc) { 1250 case SPDK_NVME_OPC_IDENTIFY: 1251 case SPDK_NVME_OPC_GET_LOG_PAGE: 1252 break; 1253 default: 1254 goto invalid_opcode; 1255 } 1256 } 1257 1258 switch (cmd->opc) { 1259 case SPDK_NVME_OPC_GET_LOG_PAGE: 1260 return spdk_nvmf_ctrlr_get_log_page(req); 1261 case SPDK_NVME_OPC_IDENTIFY: 1262 return spdk_nvmf_ctrlr_identify(req); 1263 case SPDK_NVME_OPC_ABORT: 1264 return spdk_nvmf_ctrlr_abort(req); 1265 case SPDK_NVME_OPC_GET_FEATURES: 1266 return spdk_nvmf_ctrlr_get_features(req); 1267 case SPDK_NVME_OPC_SET_FEATURES: 1268 return spdk_nvmf_ctrlr_set_features(req); 1269 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 1270 return spdk_nvmf_ctrlr_async_event_request(req); 1271 case SPDK_NVME_OPC_KEEP_ALIVE: 1272 return spdk_nvmf_ctrlr_keep_alive(req); 1273 1274 case SPDK_NVME_OPC_CREATE_IO_SQ: 1275 case SPDK_NVME_OPC_CREATE_IO_CQ: 1276 case SPDK_NVME_OPC_DELETE_IO_SQ: 1277 case SPDK_NVME_OPC_DELETE_IO_CQ: 1278 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 1279 goto invalid_opcode; 1280 1281 default: 1282 goto invalid_opcode; 1283 } 1284 1285 invalid_opcode: 1286 SPDK_ERRLOG("Unsupported admin opcode 0x%x\n", cmd->opc); 1287 response->status.sct = SPDK_NVME_SCT_GENERIC; 1288 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1289 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1290 } 1291 1292 int 1293 spdk_nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 1294 { 1295 struct spdk_nvmf_qpair *qpair = req->qpair; 1296 struct spdk_nvmf_capsule_cmd *cap_hdr; 1297 1298 cap_hdr = &req->cmd->nvmf_cmd; 1299 1300 if (qpair->ctrlr == NULL) { 1301 /* No ctrlr established yet; the only valid command is Connect */ 1302 if (cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 1303 return spdk_nvmf_ctrlr_connect(req); 1304 } else { 1305 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Got fctype 0x%x, expected Connect\n", 1306 cap_hdr->fctype); 1307 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1308 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1309 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1310 } 1311 } else if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1312 /* 1313 * Controller session is established, and this is an admin queue. 1314 * Disallow Connect and allow other fabrics commands. 1315 */ 1316 switch (cap_hdr->fctype) { 1317 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 1318 return spdk_nvmf_property_set(req); 1319 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 1320 return spdk_nvmf_property_get(req); 1321 default: 1322 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "unknown fctype 0x%02x\n", 1323 cap_hdr->fctype); 1324 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1325 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1326 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1327 } 1328 } else { 1329 /* Controller session is established, and this is an I/O queue */ 1330 /* For now, no I/O-specific Fabrics commands are implemented (other than Connect) */ 1331 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 1332 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1333 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1334 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1335 } 1336 } 1337