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