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