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