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