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