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