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/bit_array.h" 40 #include "spdk/endian.h" 41 #include "spdk/thread.h" 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 inline void 61 spdk_nvmf_invalid_connect_response(struct spdk_nvmf_fabric_connect_rsp *rsp, 62 uint8_t iattr, uint16_t ipo) 63 { 64 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 65 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 66 rsp->status_code_specific.invalid.iattr = iattr; 67 rsp->status_code_specific.invalid.ipo = ipo; 68 } 69 70 #define SPDK_NVMF_INVALID_CONNECT_CMD(rsp, field) \ 71 spdk_nvmf_invalid_connect_response(rsp, 0, offsetof(struct spdk_nvmf_fabric_connect_cmd, field)) 72 #define SPDK_NVMF_INVALID_CONNECT_DATA(rsp, field) \ 73 spdk_nvmf_invalid_connect_response(rsp, 1, offsetof(struct spdk_nvmf_fabric_connect_data, field)) 74 75 static void 76 ctrlr_add_qpair_and_update_rsp(struct spdk_nvmf_qpair *qpair, 77 struct spdk_nvmf_ctrlr *ctrlr, 78 struct spdk_nvmf_fabric_connect_rsp *rsp) 79 { 80 assert(ctrlr->admin_qpair->group->thread == spdk_get_thread()); 81 82 /* check if we would exceed ctrlr connection limit */ 83 if (qpair->qid >= spdk_bit_array_capacity(ctrlr->qpair_mask)) { 84 SPDK_ERRLOG("Requested QID %u but Max QID is %u\n", 85 qpair->qid, spdk_bit_array_capacity(ctrlr->qpair_mask) - 1); 86 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 87 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 88 return; 89 } 90 91 if (spdk_bit_array_get(ctrlr->qpair_mask, qpair->qid)) { 92 SPDK_ERRLOG("Got I/O connect with duplicate QID %u\n", qpair->qid); 93 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 94 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 95 return; 96 } 97 98 qpair->ctrlr = ctrlr; 99 spdk_bit_array_set(ctrlr->qpair_mask, qpair->qid); 100 101 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 102 rsp->status_code_specific.success.cntlid = ctrlr->cntlid; 103 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "connect capsule response: cntlid = 0x%04x\n", 104 rsp->status_code_specific.success.cntlid); 105 } 106 107 static void 108 _spdk_nvmf_request_complete(void *ctx) 109 { 110 struct spdk_nvmf_request *req = ctx; 111 112 spdk_nvmf_request_complete(req); 113 } 114 115 static void 116 _spdk_nvmf_ctrlr_add_admin_qpair(void *ctx) 117 { 118 struct spdk_nvmf_request *req = ctx; 119 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 120 struct spdk_nvmf_qpair *qpair = req->qpair; 121 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 122 123 ctrlr->admin_qpair = qpair; 124 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 125 spdk_nvmf_request_complete(req); 126 } 127 128 static void 129 _spdk_nvmf_subsystem_add_ctrlr(void *ctx) 130 { 131 struct spdk_nvmf_request *req = ctx; 132 struct spdk_nvmf_qpair *qpair = req->qpair; 133 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 134 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 135 136 if (spdk_nvmf_subsystem_add_ctrlr(ctrlr->subsys, ctrlr)) { 137 SPDK_ERRLOG("Unable to add controller to subsystem\n"); 138 free(ctrlr); 139 qpair->ctrlr = NULL; 140 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 141 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 142 return; 143 } 144 145 spdk_thread_send_msg(ctrlr->thread, _spdk_nvmf_ctrlr_add_admin_qpair, req); 146 } 147 148 static struct spdk_nvmf_ctrlr * 149 spdk_nvmf_ctrlr_create(struct spdk_nvmf_subsystem *subsystem, 150 struct spdk_nvmf_request *req, 151 struct spdk_nvmf_fabric_connect_cmd *connect_cmd, 152 struct spdk_nvmf_fabric_connect_data *connect_data) 153 { 154 struct spdk_nvmf_ctrlr *ctrlr; 155 struct spdk_nvmf_transport *transport; 156 157 ctrlr = calloc(1, sizeof(*ctrlr)); 158 if (ctrlr == NULL) { 159 SPDK_ERRLOG("Memory allocation failed\n"); 160 return NULL; 161 } 162 163 req->qpair->ctrlr = ctrlr; 164 ctrlr->subsys = subsystem; 165 ctrlr->thread = req->qpair->group->thread; 166 167 transport = req->qpair->transport; 168 ctrlr->qpair_mask = spdk_bit_array_create(transport->opts.max_qpairs_per_ctrlr); 169 if (!ctrlr->qpair_mask) { 170 SPDK_ERRLOG("Failed to allocate controller qpair mask\n"); 171 free(ctrlr); 172 return NULL; 173 } 174 175 ctrlr->feat.keep_alive_timer.bits.kato = connect_cmd->kato; 176 ctrlr->feat.async_event_configuration.bits.ns_attr_notice = 1; 177 ctrlr->feat.volatile_write_cache.bits.wce = 1; 178 179 /* Subtract 1 for admin queue, 1 for 0's based */ 180 ctrlr->feat.number_of_queues.bits.ncqr = transport->opts.max_qpairs_per_ctrlr - 1 - 181 1; 182 ctrlr->feat.number_of_queues.bits.nsqr = transport->opts.max_qpairs_per_ctrlr - 1 - 183 1; 184 185 memcpy(ctrlr->hostid, connect_data->hostid, sizeof(ctrlr->hostid)); 186 187 ctrlr->vcprop.cap.raw = 0; 188 ctrlr->vcprop.cap.bits.cqr = 1; /* NVMe-oF specification required */ 189 ctrlr->vcprop.cap.bits.mqes = transport->opts.max_queue_depth - 190 1; /* max queue depth */ 191 ctrlr->vcprop.cap.bits.ams = 0; /* optional arb mechanisms */ 192 ctrlr->vcprop.cap.bits.to = 1; /* ready timeout - 500 msec units */ 193 ctrlr->vcprop.cap.bits.dstrd = 0; /* fixed to 0 for NVMe-oF */ 194 ctrlr->vcprop.cap.bits.css = SPDK_NVME_CAP_CSS_NVM; /* NVM command set */ 195 ctrlr->vcprop.cap.bits.mpsmin = 0; /* 2 ^ (12 + mpsmin) == 4k */ 196 ctrlr->vcprop.cap.bits.mpsmax = 0; /* 2 ^ (12 + mpsmax) == 4k */ 197 198 /* Version Supported: 1.3 */ 199 ctrlr->vcprop.vs.bits.mjr = 1; 200 ctrlr->vcprop.vs.bits.mnr = 3; 201 ctrlr->vcprop.vs.bits.ter = 0; 202 203 ctrlr->vcprop.cc.raw = 0; 204 ctrlr->vcprop.cc.bits.en = 0; /* Init controller disabled */ 205 206 ctrlr->vcprop.csts.raw = 0; 207 ctrlr->vcprop.csts.bits.rdy = 0; /* Init controller as not ready */ 208 209 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cap 0x%" PRIx64 "\n", ctrlr->vcprop.cap.raw); 210 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "vs 0x%x\n", ctrlr->vcprop.vs.raw); 211 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cc 0x%x\n", ctrlr->vcprop.cc.raw); 212 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "csts 0x%x\n", ctrlr->vcprop.csts.raw); 213 214 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_subsystem_add_ctrlr, req); 215 216 return ctrlr; 217 } 218 219 void 220 spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr) 221 { 222 spdk_nvmf_subsystem_remove_ctrlr(ctrlr->subsys, ctrlr); 223 224 free(ctrlr); 225 } 226 227 static void 228 spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 229 { 230 struct spdk_nvmf_request *req = ctx; 231 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 232 struct spdk_nvmf_qpair *qpair = req->qpair; 233 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 234 235 /* Unit test will check qpair->ctrlr after calling spdk_nvmf_ctrlr_connect. 236 * For error case, the value should be NULL. So set it to NULL at first. 237 */ 238 qpair->ctrlr = NULL; 239 240 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 241 SPDK_ERRLOG("I/O connect not allowed on discovery controller\n"); 242 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 243 goto end; 244 } 245 246 if (!ctrlr->vcprop.cc.bits.en) { 247 SPDK_ERRLOG("Got I/O connect before ctrlr was enabled\n"); 248 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 249 goto end; 250 } 251 252 if (1u << ctrlr->vcprop.cc.bits.iosqes != sizeof(struct spdk_nvme_cmd)) { 253 SPDK_ERRLOG("Got I/O connect with invalid IOSQES %u\n", 254 ctrlr->vcprop.cc.bits.iosqes); 255 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 256 goto end; 257 } 258 259 if (1u << ctrlr->vcprop.cc.bits.iocqes != sizeof(struct spdk_nvme_cpl)) { 260 SPDK_ERRLOG("Got I/O connect with invalid IOCQES %u\n", 261 ctrlr->vcprop.cc.bits.iocqes); 262 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, qid); 263 goto end; 264 } 265 266 ctrlr_add_qpair_and_update_rsp(qpair, ctrlr, rsp); 267 268 end: 269 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 270 } 271 272 static void 273 _spdk_nvmf_ctrlr_add_io_qpair(void *ctx) 274 { 275 struct spdk_nvmf_request *req = ctx; 276 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 277 struct spdk_nvmf_fabric_connect_data *data = req->data; 278 struct spdk_nvmf_ctrlr *ctrlr; 279 struct spdk_nvmf_qpair *qpair = req->qpair; 280 struct spdk_nvmf_qpair *admin_qpair; 281 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 282 struct spdk_nvmf_subsystem *subsystem; 283 284 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect I/O Queue for controller id 0x%x\n", data->cntlid); 285 286 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, data->subnqn); 287 /* We already checked this in spdk_nvmf_ctrlr_connect */ 288 assert(subsystem != NULL); 289 290 ctrlr = spdk_nvmf_subsystem_get_ctrlr(subsystem, data->cntlid); 291 if (ctrlr == NULL) { 292 SPDK_ERRLOG("Unknown controller ID 0x%x\n", data->cntlid); 293 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 294 spdk_thread_send_msg(qpair->group->thread, _spdk_nvmf_request_complete, req); 295 return; 296 } 297 298 admin_qpair = ctrlr->admin_qpair; 299 qpair->ctrlr = ctrlr; 300 spdk_thread_send_msg(admin_qpair->group->thread, spdk_nvmf_ctrlr_add_io_qpair, req); 301 } 302 303 static int 304 spdk_nvmf_ctrlr_connect(struct spdk_nvmf_request *req) 305 { 306 struct spdk_nvmf_fabric_connect_data *data = req->data; 307 struct spdk_nvmf_fabric_connect_cmd *cmd = &req->cmd->connect_cmd; 308 struct spdk_nvmf_fabric_connect_rsp *rsp = &req->rsp->connect_rsp; 309 struct spdk_nvmf_qpair *qpair = req->qpair; 310 struct spdk_nvmf_tgt *tgt = qpair->transport->tgt; 311 struct spdk_nvmf_ctrlr *ctrlr; 312 struct spdk_nvmf_subsystem *subsystem; 313 const char *subnqn, *hostnqn; 314 void *end; 315 316 if (req->length < sizeof(struct spdk_nvmf_fabric_connect_data)) { 317 SPDK_ERRLOG("Connect command data length 0x%x too small\n", req->length); 318 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 319 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 320 } 321 322 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "recfmt 0x%x qid %u sqsize %u\n", 323 cmd->recfmt, cmd->qid, cmd->sqsize); 324 325 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect data:\n"); 326 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " cntlid: 0x%04x\n", data->cntlid); 327 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostid: %08x-%04x-%04x-%02x%02x-%04x%08x ***\n", 328 ntohl(*(uint32_t *)&data->hostid[0]), 329 ntohs(*(uint16_t *)&data->hostid[4]), 330 ntohs(*(uint16_t *)&data->hostid[6]), 331 data->hostid[8], 332 data->hostid[9], 333 ntohs(*(uint16_t *)&data->hostid[10]), 334 ntohl(*(uint32_t *)&data->hostid[12])); 335 336 if (cmd->recfmt != 0) { 337 SPDK_ERRLOG("Connect command unsupported RECFMT %u\n", cmd->recfmt); 338 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 339 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INCOMPATIBLE_FORMAT; 340 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 341 } 342 343 /* Ensure that subnqn is null terminated */ 344 end = memchr(data->subnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 345 if (!end) { 346 SPDK_ERRLOG("Connect SUBNQN is not null terminated\n"); 347 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 348 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 349 } 350 subnqn = data->subnqn; 351 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " subnqn: \"%s\"\n", subnqn); 352 353 subsystem = spdk_nvmf_tgt_find_subsystem(tgt, subnqn); 354 if (subsystem == NULL) { 355 SPDK_ERRLOG("Could not find subsystem '%s'\n", subnqn); 356 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, subnqn); 357 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 358 } 359 360 /* Ensure that hostnqn is null terminated */ 361 end = memchr(data->hostnqn, '\0', SPDK_NVMF_NQN_MAX_LEN + 1); 362 if (!end) { 363 SPDK_ERRLOG("Connect HOSTNQN is not null terminated\n"); 364 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, hostnqn); 365 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 366 } 367 hostnqn = data->hostnqn; 368 SPDK_DEBUGLOG(SPDK_LOG_NVMF, " hostnqn: \"%s\"\n", hostnqn); 369 370 if (!spdk_nvmf_subsystem_host_allowed(subsystem, hostnqn)) { 371 SPDK_ERRLOG("Subsystem '%s' does not allow host '%s'\n", subnqn, hostnqn); 372 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 373 rsp->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_HOST; 374 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 375 } 376 377 /* 378 * SQSIZE is a 0-based value, so it must be at least 1 (minimum queue depth is 2) and 379 * strictly less than max_queue_depth. 380 */ 381 if (cmd->sqsize == 0 || cmd->sqsize >= qpair->transport->opts.max_queue_depth) { 382 SPDK_ERRLOG("Invalid SQSIZE %u (min 1, max %u)\n", 383 cmd->sqsize, qpair->transport->opts.max_queue_depth - 1); 384 SPDK_NVMF_INVALID_CONNECT_CMD(rsp, sqsize); 385 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 386 } 387 qpair->sq_head_max = cmd->sqsize; 388 qpair->qid = cmd->qid; 389 390 if (cmd->qid == 0) { 391 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Connect Admin Queue for controller ID 0x%x\n", data->cntlid); 392 393 if (data->cntlid != 0xFFFF) { 394 /* This NVMf target only supports dynamic mode. */ 395 SPDK_ERRLOG("The NVMf target only supports dynamic mode (CNTLID = 0x%x).\n", data->cntlid); 396 SPDK_NVMF_INVALID_CONNECT_DATA(rsp, cntlid); 397 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 398 } 399 400 /* Establish a new ctrlr */ 401 ctrlr = spdk_nvmf_ctrlr_create(subsystem, req, cmd, data); 402 if (!ctrlr) { 403 SPDK_ERRLOG("spdk_nvmf_ctrlr_create() failed\n"); 404 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 405 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 406 } else { 407 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 408 } 409 } else { 410 spdk_thread_send_msg(subsystem->thread, _spdk_nvmf_ctrlr_add_io_qpair, req); 411 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 412 } 413 } 414 415 static uint64_t 416 nvmf_prop_get_cap(struct spdk_nvmf_ctrlr *ctrlr) 417 { 418 return ctrlr->vcprop.cap.raw; 419 } 420 421 static uint64_t 422 nvmf_prop_get_vs(struct spdk_nvmf_ctrlr *ctrlr) 423 { 424 return ctrlr->vcprop.vs.raw; 425 } 426 427 static uint64_t 428 nvmf_prop_get_cc(struct spdk_nvmf_ctrlr *ctrlr) 429 { 430 return ctrlr->vcprop.cc.raw; 431 } 432 433 static bool 434 nvmf_prop_set_cc(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value) 435 { 436 union spdk_nvme_cc_register cc, diff; 437 438 cc.raw = (uint32_t)value; 439 440 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cur CC: 0x%08x\n", ctrlr->vcprop.cc.raw); 441 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "new CC: 0x%08x\n", cc.raw); 442 443 /* 444 * Calculate which bits changed between the current and new CC. 445 * Mark each bit as 0 once it is handled to determine if any unhandled bits were changed. 446 */ 447 diff.raw = cc.raw ^ ctrlr->vcprop.cc.raw; 448 449 if (diff.bits.en) { 450 if (cc.bits.en) { 451 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Enable!\n"); 452 ctrlr->vcprop.cc.bits.en = 1; 453 ctrlr->vcprop.csts.bits.rdy = 1; 454 } else { 455 SPDK_ERRLOG("CC.EN transition from 1 to 0 (reset) not implemented!\n"); 456 457 } 458 diff.bits.en = 0; 459 } 460 461 if (diff.bits.shn) { 462 if (cc.bits.shn == SPDK_NVME_SHN_NORMAL || 463 cc.bits.shn == SPDK_NVME_SHN_ABRUPT) { 464 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Property Set CC Shutdown %u%ub!\n", 465 cc.bits.shn >> 1, cc.bits.shn & 1); 466 ctrlr->vcprop.cc.bits.shn = cc.bits.shn; 467 ctrlr->vcprop.cc.bits.en = 0; 468 ctrlr->vcprop.csts.bits.rdy = 0; 469 ctrlr->vcprop.csts.bits.shst = SPDK_NVME_SHST_COMPLETE; 470 } else if (cc.bits.shn == 0) { 471 ctrlr->vcprop.cc.bits.shn = 0; 472 } else { 473 SPDK_ERRLOG("Prop Set CC: Invalid SHN value %u%ub\n", 474 cc.bits.shn >> 1, cc.bits.shn & 1); 475 return false; 476 } 477 diff.bits.shn = 0; 478 } 479 480 if (diff.bits.iosqes) { 481 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOSQES = %u (%u bytes)\n", 482 cc.bits.iosqes, 1u << cc.bits.iosqes); 483 ctrlr->vcprop.cc.bits.iosqes = cc.bits.iosqes; 484 diff.bits.iosqes = 0; 485 } 486 487 if (diff.bits.iocqes) { 488 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Prop Set IOCQES = %u (%u bytes)\n", 489 cc.bits.iocqes, 1u << cc.bits.iocqes); 490 ctrlr->vcprop.cc.bits.iocqes = cc.bits.iocqes; 491 diff.bits.iocqes = 0; 492 } 493 494 if (diff.raw != 0) { 495 SPDK_ERRLOG("Prop Set CC toggled reserved bits 0x%x!\n", diff.raw); 496 return false; 497 } 498 499 return true; 500 } 501 502 static uint64_t 503 nvmf_prop_get_csts(struct spdk_nvmf_ctrlr *ctrlr) 504 { 505 return ctrlr->vcprop.csts.raw; 506 } 507 508 struct nvmf_prop { 509 uint32_t ofst; 510 uint8_t size; 511 char name[11]; 512 uint64_t (*get_cb)(struct spdk_nvmf_ctrlr *ctrlr); 513 bool (*set_cb)(struct spdk_nvmf_ctrlr *ctrlr, uint64_t value); 514 }; 515 516 #define PROP(field, size, get_cb, set_cb) \ 517 { \ 518 offsetof(struct spdk_nvme_registers, field), \ 519 SPDK_NVMF_PROP_SIZE_##size, \ 520 #field, \ 521 get_cb, set_cb \ 522 } 523 524 static const struct nvmf_prop nvmf_props[] = { 525 PROP(cap, 8, nvmf_prop_get_cap, NULL), 526 PROP(vs, 4, nvmf_prop_get_vs, NULL), 527 PROP(cc, 4, nvmf_prop_get_cc, nvmf_prop_set_cc), 528 PROP(csts, 4, nvmf_prop_get_csts, NULL), 529 }; 530 531 static const struct nvmf_prop * 532 find_prop(uint32_t ofst) 533 { 534 size_t i; 535 536 for (i = 0; i < SPDK_COUNTOF(nvmf_props); i++) { 537 const struct nvmf_prop *prop = &nvmf_props[i]; 538 539 if (prop->ofst == ofst) { 540 return prop; 541 } 542 } 543 544 return NULL; 545 } 546 547 static int 548 spdk_nvmf_property_get(struct spdk_nvmf_request *req) 549 { 550 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 551 struct spdk_nvmf_fabric_prop_get_cmd *cmd = &req->cmd->prop_get_cmd; 552 struct spdk_nvmf_fabric_prop_get_rsp *response = &req->rsp->prop_get_rsp; 553 const struct nvmf_prop *prop; 554 555 response->status.sc = 0; 556 response->value.u64 = 0; 557 558 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x\n", 559 cmd->attrib.size, cmd->ofst); 560 561 if (cmd->attrib.size != SPDK_NVMF_PROP_SIZE_4 && 562 cmd->attrib.size != SPDK_NVMF_PROP_SIZE_8) { 563 SPDK_ERRLOG("Invalid size value %d\n", cmd->attrib.size); 564 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 565 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 566 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 567 } 568 569 prop = find_prop(cmd->ofst); 570 if (prop == NULL || prop->get_cb == NULL) { 571 /* Reserved properties return 0 when read */ 572 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 573 } 574 575 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 576 if (cmd->attrib.size != prop->size) { 577 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 578 cmd->ofst, cmd->attrib.size, prop->size); 579 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 580 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 581 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 582 } 583 584 response->value.u64 = prop->get_cb(ctrlr); 585 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "response value: 0x%" PRIx64 "\n", response->value.u64); 586 587 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 588 } 589 590 static int 591 spdk_nvmf_property_set(struct spdk_nvmf_request *req) 592 { 593 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 594 struct spdk_nvmf_fabric_prop_set_cmd *cmd = &req->cmd->prop_set_cmd; 595 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 596 const struct nvmf_prop *prop; 597 uint64_t value; 598 599 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "size %d, offset 0x%x, value 0x%" PRIx64 "\n", 600 cmd->attrib.size, cmd->ofst, cmd->value.u64); 601 602 prop = find_prop(cmd->ofst); 603 if (prop == NULL || prop->set_cb == NULL) { 604 SPDK_ERRLOG("Invalid offset 0x%x\n", cmd->ofst); 605 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 606 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 607 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 608 } 609 610 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "name: %s\n", prop->name); 611 if (cmd->attrib.size != prop->size) { 612 SPDK_ERRLOG("offset 0x%x size mismatch: cmd %u, prop %u\n", 613 cmd->ofst, cmd->attrib.size, prop->size); 614 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 615 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 616 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 617 } 618 619 value = cmd->value.u64; 620 if (prop->size == SPDK_NVMF_PROP_SIZE_4) { 621 value = (uint32_t)value; 622 } 623 624 if (!prop->set_cb(ctrlr, value)) { 625 SPDK_ERRLOG("prop set_cb failed\n"); 626 response->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 627 response->status.sc = SPDK_NVMF_FABRIC_SC_INVALID_PARAM; 628 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 629 } 630 631 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 632 } 633 634 static int 635 spdk_nvmf_ctrlr_set_features_arbitration(struct spdk_nvmf_request *req) 636 { 637 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 638 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 639 640 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Arbitration (cdw11 = 0x%0x)\n", cmd->cdw11); 641 642 ctrlr->feat.arbitration.raw = cmd->cdw11; 643 ctrlr->feat.arbitration.bits.reserved = 0; 644 645 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 646 } 647 648 static int 649 spdk_nvmf_ctrlr_set_features_power_management(struct spdk_nvmf_request *req) 650 { 651 union spdk_nvme_feat_power_management opts; 652 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 653 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 654 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 655 656 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Power Management (cdw11 = 0x%0x)\n", cmd->cdw11); 657 opts.raw = cmd->cdw11; 658 659 /* Only PS = 0 is allowed, since we report NPSS = 0 */ 660 if (opts.bits.ps != 0) { 661 SPDK_ERRLOG("Invalid power state %u\n", opts.bits.ps); 662 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 663 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 664 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 665 } 666 667 ctrlr->feat.power_management.raw = cmd->cdw11; 668 ctrlr->feat.power_management.bits.reserved = 0; 669 670 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 671 } 672 673 static bool 674 temp_threshold_opts_valid(const union spdk_nvme_feat_temperature_threshold *opts) 675 { 676 /* 677 * Valid TMPSEL values: 678 * 0000b - 1000b: temperature sensors 679 * 1111b: set all implemented temperature sensors 680 */ 681 if (opts->bits.tmpsel >= 9 && opts->bits.tmpsel != 15) { 682 /* 1001b - 1110b: reserved */ 683 SPDK_ERRLOG("Invalid TMPSEL %u\n", opts->bits.tmpsel); 684 return false; 685 } 686 687 /* 688 * Valid THSEL values: 689 * 00b: over temperature threshold 690 * 01b: under temperature threshold 691 */ 692 if (opts->bits.thsel > 1) { 693 /* 10b - 11b: reserved */ 694 SPDK_ERRLOG("Invalid THSEL %u\n", opts->bits.thsel); 695 return false; 696 } 697 698 return true; 699 } 700 701 static int 702 spdk_nvmf_ctrlr_set_features_temperature_threshold(struct spdk_nvmf_request *req) 703 { 704 union spdk_nvme_feat_temperature_threshold opts; 705 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 706 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 707 708 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 709 opts.raw = cmd->cdw11; 710 711 if (!temp_threshold_opts_valid(&opts)) { 712 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 713 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 714 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 715 } 716 717 /* TODO: no sensors implemented - ignore new values */ 718 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 719 } 720 721 static int 722 spdk_nvmf_ctrlr_get_features_temperature_threshold(struct spdk_nvmf_request *req) 723 { 724 union spdk_nvme_feat_temperature_threshold opts; 725 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 726 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 727 728 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Temperature Threshold (cdw11 = 0x%0x)\n", cmd->cdw11); 729 opts.raw = cmd->cdw11; 730 731 if (!temp_threshold_opts_valid(&opts)) { 732 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 733 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 734 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 735 } 736 737 /* TODO: no sensors implemented - return 0 for all thresholds */ 738 rsp->cdw0 = 0; 739 740 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 741 } 742 743 static int 744 spdk_nvmf_ctrlr_set_features_error_recovery(struct spdk_nvmf_request *req) 745 { 746 union spdk_nvme_feat_error_recovery opts; 747 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 748 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 749 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 750 751 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Error Recovery (cdw11 = 0x%0x)\n", cmd->cdw11); 752 opts.raw = cmd->cdw11; 753 754 if (opts.bits.dulbe) { 755 /* 756 * Host is not allowed to set this bit, since we don't advertise it in 757 * Identify Namespace. 758 */ 759 SPDK_ERRLOG("Host set unsupported DULBE bit\n"); 760 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 761 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 762 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 763 } 764 765 ctrlr->feat.error_recovery.raw = cmd->cdw11; 766 ctrlr->feat.error_recovery.bits.reserved = 0; 767 768 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 769 } 770 771 static int 772 spdk_nvmf_ctrlr_set_features_volatile_write_cache(struct spdk_nvmf_request *req) 773 { 774 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 775 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 776 777 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Volatile Write Cache (cdw11 = 0x%0x)\n", cmd->cdw11); 778 779 ctrlr->feat.volatile_write_cache.raw = cmd->cdw11; 780 ctrlr->feat.volatile_write_cache.bits.reserved = 0; 781 782 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 783 } 784 785 static int 786 spdk_nvmf_ctrlr_set_features_write_atomicity(struct spdk_nvmf_request *req) 787 { 788 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 789 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 790 791 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Write Atomicity (cdw11 = 0x%0x)\n", cmd->cdw11); 792 793 ctrlr->feat.write_atomicity.raw = cmd->cdw11; 794 ctrlr->feat.write_atomicity.bits.reserved = 0; 795 796 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 797 } 798 799 static int 800 spdk_nvmf_ctrlr_set_features_host_identifier(struct spdk_nvmf_request *req) 801 { 802 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 803 804 SPDK_ERRLOG("Set Features - Host Identifier not allowed\n"); 805 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 806 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 807 } 808 809 static int 810 spdk_nvmf_ctrlr_get_features_host_identifier(struct spdk_nvmf_request *req) 811 { 812 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 813 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 814 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 815 union spdk_nvme_feat_host_identifier opts; 816 817 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get Features - Host Identifier\n"); 818 819 opts.raw = cmd->cdw11; 820 if (!opts.bits.exhid) { 821 /* NVMe over Fabrics requires EXHID=1 (128-bit/16-byte host ID) */ 822 SPDK_ERRLOG("Get Features - Host Identifier with EXHID=0 not allowed\n"); 823 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 824 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 825 } 826 827 if (req->data == NULL || req->length < sizeof(ctrlr->hostid)) { 828 SPDK_ERRLOG("Invalid data buffer for Get Features - Host Identifier\n"); 829 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 830 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 831 } 832 833 memcpy(req->data, ctrlr->hostid, sizeof(ctrlr->hostid)); 834 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 835 } 836 837 static int 838 spdk_nvmf_ctrlr_set_features_keep_alive_timer(struct spdk_nvmf_request *req) 839 { 840 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 841 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 842 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 843 844 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer (%u ms)\n", cmd->cdw11); 845 846 if (cmd->cdw11 == 0) { 847 rsp->status.sc = SPDK_NVME_SC_KEEP_ALIVE_INVALID; 848 } else if (cmd->cdw11 < MIN_KEEP_ALIVE_TIMEOUT) { 849 ctrlr->feat.keep_alive_timer.bits.kato = MIN_KEEP_ALIVE_TIMEOUT; 850 } else { 851 ctrlr->feat.keep_alive_timer.bits.kato = cmd->cdw11; 852 } 853 854 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Keep Alive Timer set to %u ms\n", 855 ctrlr->feat.keep_alive_timer.bits.kato); 856 857 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 858 } 859 860 static int 861 spdk_nvmf_ctrlr_set_features_number_of_queues(struct spdk_nvmf_request *req) 862 { 863 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 864 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 865 uint32_t count; 866 867 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Number of Queues, cdw11 0x%x\n", 868 req->cmd->nvme_cmd.cdw11); 869 870 count = spdk_bit_array_count_set(ctrlr->qpair_mask); 871 /* verify that the controller is ready to process commands */ 872 if (count > 1) { 873 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Queue pairs already active!\n"); 874 rsp->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 875 } else { 876 /* 877 * Ignore the value requested by the host - 878 * always return the pre-configured value based on max_qpairs_allowed. 879 */ 880 rsp->cdw0 = ctrlr->feat.number_of_queues.raw; 881 } 882 883 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 884 } 885 886 static int 887 spdk_nvmf_ctrlr_set_features_async_event_configuration(struct spdk_nvmf_request *req) 888 { 889 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 890 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 891 892 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Set Features - Async Event Configuration, cdw11 0x%08x\n", 893 cmd->cdw11); 894 ctrlr->feat.async_event_configuration.raw = cmd->cdw11; 895 ctrlr->feat.async_event_configuration.bits.reserved = 0; 896 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 897 } 898 899 static int 900 spdk_nvmf_ctrlr_async_event_request(struct spdk_nvmf_request *req) 901 { 902 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 903 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 904 905 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Async Event Request\n"); 906 907 /* Only one asynchronous event is supported for now */ 908 if (ctrlr->aer_req != NULL) { 909 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "AERL exceeded\n"); 910 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 911 rsp->status.sc = SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED; 912 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 913 } 914 915 if (ctrlr->notice_event.bits.async_event_type == 916 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 917 rsp->cdw0 = ctrlr->notice_event.raw; 918 ctrlr->notice_event.raw = 0; 919 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 920 } 921 922 ctrlr->aer_req = req; 923 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 924 } 925 926 static void 927 spdk_nvmf_get_firmware_slot_log_page(void *buffer, uint64_t offset, uint32_t length) 928 { 929 struct spdk_nvme_firmware_page fw_page; 930 size_t copy_len; 931 932 memset(&fw_page, 0, sizeof(fw_page)); 933 fw_page.afi.active_slot = 1; 934 fw_page.afi.next_reset_slot = 0; 935 spdk_strcpy_pad(fw_page.revision[0], FW_VERSION, sizeof(fw_page.revision[0]), ' '); 936 937 if (offset < sizeof(fw_page)) { 938 copy_len = spdk_min(sizeof(fw_page) - offset, length); 939 if (copy_len > 0) { 940 memcpy(buffer, (const char *)&fw_page + offset, copy_len); 941 } 942 } 943 } 944 945 void 946 spdk_nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid) 947 { 948 uint16_t max_changes = SPDK_COUNTOF(ctrlr->changed_ns_list.ns_list); 949 uint16_t i; 950 bool found = false; 951 952 for (i = 0; i < ctrlr->changed_ns_list_count; i++) { 953 if (ctrlr->changed_ns_list.ns_list[i] == nsid) { 954 /* nsid is already in the list */ 955 found = true; 956 break; 957 } 958 } 959 960 if (!found) { 961 if (ctrlr->changed_ns_list_count == max_changes) { 962 /* Out of space - set first entry to FFFFFFFFh and zero-fill the rest. */ 963 ctrlr->changed_ns_list.ns_list[0] = 0xFFFFFFFFu; 964 for (i = 1; i < max_changes; i++) { 965 ctrlr->changed_ns_list.ns_list[i] = 0; 966 } 967 } else { 968 ctrlr->changed_ns_list.ns_list[ctrlr->changed_ns_list_count++] = nsid; 969 } 970 } 971 972 spdk_nvmf_ctrlr_async_event_ns_notice(ctrlr); 973 } 974 975 static void 976 spdk_nvmf_get_changed_ns_list_log_page(struct spdk_nvmf_ctrlr *ctrlr, 977 void *buffer, uint64_t offset, uint32_t length) 978 { 979 size_t copy_length; 980 981 if (offset < sizeof(ctrlr->changed_ns_list)) { 982 copy_length = spdk_min(length, sizeof(ctrlr->changed_ns_list) - offset); 983 if (copy_length) { 984 memcpy(buffer, (char *)&ctrlr->changed_ns_list + offset, copy_length); 985 } 986 } 987 988 /* Clear log page each time it is read */ 989 ctrlr->changed_ns_list_count = 0; 990 memset(&ctrlr->changed_ns_list, 0, sizeof(ctrlr->changed_ns_list)); 991 } 992 993 /* The structure can be modified if we provide support for other commands in future */ 994 static const struct spdk_nvme_cmds_and_effect_log_page g_cmds_and_effect_log_page = { 995 .admin_cmds_supported = { 996 /* CSUPP, LBCC, NCC, NIC, CCC, CSE */ 997 /* Get Log Page */ 998 [SPDK_NVME_OPC_GET_LOG_PAGE] = {1, 0, 0, 0, 0, 0, 0, 0}, 999 /* Identify */ 1000 [SPDK_NVME_OPC_IDENTIFY] = {1, 0, 0, 0, 0, 0, 0, 0}, 1001 /* Abort */ 1002 [SPDK_NVME_OPC_ABORT] = {1, 0, 0, 0, 0, 0, 0, 0}, 1003 /* Set Features */ 1004 [SPDK_NVME_OPC_SET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1005 /* Get Features */ 1006 [SPDK_NVME_OPC_GET_FEATURES] = {1, 0, 0, 0, 0, 0, 0, 0}, 1007 /* Async Event Request */ 1008 [SPDK_NVME_OPC_ASYNC_EVENT_REQUEST] = {1, 0, 0, 0, 0, 0, 0, 0}, 1009 /* Keep Alive */ 1010 [SPDK_NVME_OPC_KEEP_ALIVE] = {1, 0, 0, 0, 0, 0, 0, 0}, 1011 }, 1012 .io_cmds_supported = { 1013 /* FLUSH */ 1014 [SPDK_NVME_OPC_FLUSH] = {1, 1, 0, 0, 0, 0, 0, 0}, 1015 /* WRITE */ 1016 [SPDK_NVME_OPC_WRITE] = {1, 1, 0, 0, 0, 0, 0, 0}, 1017 /* READ */ 1018 [SPDK_NVME_OPC_READ] = {1, 0, 0, 0, 0, 0, 0, 0}, 1019 /* WRITE ZEROES */ 1020 [SPDK_NVME_OPC_WRITE_ZEROES] = {1, 1, 0, 0, 0, 0, 0, 0}, 1021 /* DATASET MANAGEMENT */ 1022 [SPDK_NVME_OPC_DATASET_MANAGEMENT] = {1, 1, 0, 0, 0, 0, 0, 0}, 1023 }, 1024 }; 1025 1026 static void 1027 spdk_nvmf_get_cmds_and_effects_log_page(void *buffer, 1028 uint64_t offset, uint32_t length) 1029 { 1030 uint32_t page_size = sizeof(struct spdk_nvme_cmds_and_effect_log_page); 1031 size_t copy_len = 0; 1032 size_t zero_len = length; 1033 1034 if (offset < page_size) { 1035 copy_len = spdk_min(page_size - offset, length); 1036 zero_len -= copy_len; 1037 memcpy(buffer, (char *)(&g_cmds_and_effect_log_page) + offset, copy_len); 1038 } 1039 1040 if (zero_len) { 1041 memset((char *)buffer + copy_len, 0, zero_len); 1042 } 1043 } 1044 1045 static int 1046 spdk_nvmf_ctrlr_get_log_page(struct spdk_nvmf_request *req) 1047 { 1048 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1049 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1050 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1051 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1052 uint64_t offset, len; 1053 uint32_t numdl, numdu; 1054 uint8_t lid; 1055 1056 if (req->data == NULL) { 1057 SPDK_ERRLOG("get log command with no buffer\n"); 1058 response->status.sct = SPDK_NVME_SCT_GENERIC; 1059 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1060 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1061 } 1062 1063 offset = (uint64_t)cmd->cdw12 | ((uint64_t)cmd->cdw13 << 32); 1064 if (offset & 3) { 1065 SPDK_ERRLOG("Invalid log page offset 0x%" PRIx64 "\n", offset); 1066 response->status.sct = SPDK_NVME_SCT_GENERIC; 1067 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1068 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1069 } 1070 1071 numdl = (cmd->cdw10 >> 16) & 0xFFFFu; 1072 numdu = (cmd->cdw11) & 0xFFFFu; 1073 len = ((numdu << 16) + numdl + (uint64_t)1) * 4; 1074 if (len > req->length) { 1075 SPDK_ERRLOG("Get log page: len (%" PRIu64 ") > buf size (%u)\n", 1076 len, req->length); 1077 response->status.sct = SPDK_NVME_SCT_GENERIC; 1078 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1079 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1080 } 1081 1082 lid = cmd->cdw10 & 0xFF; 1083 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Get log page: LID=0x%02X offset=0x%" PRIx64 " len=0x%" PRIx64 "\n", 1084 lid, offset, len); 1085 1086 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1087 switch (lid) { 1088 case SPDK_NVME_LOG_DISCOVERY: 1089 spdk_nvmf_get_discovery_log_page(subsystem->tgt, req->data, offset, len); 1090 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1091 default: 1092 goto invalid_log_page; 1093 } 1094 } else { 1095 switch (lid) { 1096 case SPDK_NVME_LOG_ERROR: 1097 case SPDK_NVME_LOG_HEALTH_INFORMATION: 1098 /* TODO: actually fill out log page data */ 1099 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1100 case SPDK_NVME_LOG_FIRMWARE_SLOT: 1101 spdk_nvmf_get_firmware_slot_log_page(req->data, offset, len); 1102 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1103 case SPDK_NVME_LOG_COMMAND_EFFECTS_LOG: 1104 spdk_nvmf_get_cmds_and_effects_log_page(req->data, offset, len); 1105 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1106 case SPDK_NVME_LOG_CHANGED_NS_LIST: 1107 spdk_nvmf_get_changed_ns_list_log_page(ctrlr, req->data, offset, len); 1108 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1109 default: 1110 goto invalid_log_page; 1111 } 1112 } 1113 1114 invalid_log_page: 1115 SPDK_ERRLOG("Unsupported Get Log Page 0x%02X\n", lid); 1116 response->status.sct = SPDK_NVME_SCT_GENERIC; 1117 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1118 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1119 } 1120 1121 static int 1122 spdk_nvmf_ctrlr_identify_ns(struct spdk_nvmf_subsystem *subsystem, 1123 struct spdk_nvme_cmd *cmd, 1124 struct spdk_nvme_cpl *rsp, 1125 struct spdk_nvme_ns_data *nsdata) 1126 { 1127 struct spdk_nvmf_ns *ns; 1128 1129 if (cmd->nsid == 0 || cmd->nsid > subsystem->max_nsid) { 1130 SPDK_ERRLOG("Identify Namespace for invalid NSID %u\n", cmd->nsid); 1131 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1132 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1133 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1134 } 1135 1136 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1137 if (ns == NULL || ns->bdev == NULL) { 1138 /* 1139 * Inactive namespaces should return a zero filled data structure. 1140 * The data buffer is already zeroed by spdk_nvmf_ctrlr_process_admin_cmd(), 1141 * so we can just return early here. 1142 */ 1143 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Identify Namespace for inactive NSID %u\n", cmd->nsid); 1144 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1145 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1146 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1147 } 1148 1149 return spdk_nvmf_bdev_ctrlr_identify_ns(ns, nsdata); 1150 } 1151 1152 static int 1153 spdk_nvmf_ctrlr_identify_ctrlr(struct spdk_nvmf_ctrlr *ctrlr, struct spdk_nvme_ctrlr_data *cdata) 1154 { 1155 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1156 struct spdk_nvmf_transport *transport = ctrlr->admin_qpair->transport; 1157 1158 /* 1159 * Common fields for discovery and NVM subsystems 1160 */ 1161 spdk_strcpy_pad(cdata->fr, FW_VERSION, sizeof(cdata->fr), ' '); 1162 assert((transport->opts.max_io_size % 4096) == 0); 1163 cdata->mdts = spdk_u32log2(transport->opts.max_io_size / 4096); 1164 cdata->cntlid = ctrlr->cntlid; 1165 cdata->ver = ctrlr->vcprop.vs; 1166 cdata->lpa.edlp = 1; 1167 cdata->elpe = 127; 1168 cdata->maxcmd = transport->opts.max_queue_depth; 1169 cdata->sgls.supported = 1; 1170 cdata->sgls.keyed_sgl = 1; 1171 cdata->sgls.sgl_offset = 1; 1172 spdk_strcpy_pad(cdata->subnqn, subsystem->subnqn, sizeof(cdata->subnqn), '\0'); 1173 1174 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ctrlr data: maxcmd 0x%x\n", cdata->maxcmd); 1175 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "sgls data: 0x%x\n", from_le32(&cdata->sgls)); 1176 1177 /* 1178 * NVM subsystem fields (reserved for discovery subsystems) 1179 */ 1180 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_NVME) { 1181 spdk_strcpy_pad(cdata->mn, MODEL_NUMBER, sizeof(cdata->mn), ' '); 1182 spdk_strcpy_pad(cdata->sn, spdk_nvmf_subsystem_get_sn(subsystem), sizeof(cdata->sn), ' '); 1183 cdata->kas = 10; 1184 1185 cdata->rab = 6; 1186 cdata->cmic.multi_port = 1; 1187 cdata->cmic.multi_host = 1; 1188 cdata->oaes.ns_attribute_notices = 1; 1189 cdata->ctratt.host_id_exhid_supported = 1; 1190 cdata->aerl = 0; 1191 cdata->frmw.slot1_ro = 1; 1192 cdata->frmw.num_slots = 1; 1193 1194 cdata->lpa.celp = 1; /* Command Effects log page supported */ 1195 1196 cdata->sqes.min = 6; 1197 cdata->sqes.max = 6; 1198 cdata->cqes.min = 4; 1199 cdata->cqes.max = 4; 1200 cdata->nn = subsystem->max_nsid; 1201 cdata->vwc.present = 1; 1202 cdata->vwc.flush_broadcast = SPDK_NVME_FLUSH_BROADCAST_NOT_SUPPORTED; 1203 1204 cdata->nvmf_specific.ioccsz = sizeof(struct spdk_nvme_cmd) / 16; 1205 cdata->nvmf_specific.iorcsz = sizeof(struct spdk_nvme_cpl) / 16; 1206 cdata->nvmf_specific.icdoff = 0; /* offset starts directly after SQE */ 1207 cdata->nvmf_specific.ctrattr.ctrlr_model = SPDK_NVMF_CTRLR_MODEL_DYNAMIC; 1208 cdata->nvmf_specific.msdbd = 1; /* target supports single SGL in capsule */ 1209 1210 /* TODO: this should be set by the transport */ 1211 cdata->nvmf_specific.ioccsz += transport->opts.in_capsule_data_size / 16; 1212 1213 cdata->oncs.dsm = spdk_nvmf_ctrlr_dsm_supported(ctrlr); 1214 cdata->oncs.write_zeroes = spdk_nvmf_ctrlr_write_zeroes_supported(ctrlr); 1215 1216 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ioccsz 0x%x\n", 1217 cdata->nvmf_specific.ioccsz); 1218 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: iorcsz 0x%x\n", 1219 cdata->nvmf_specific.iorcsz); 1220 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: icdoff 0x%x\n", 1221 cdata->nvmf_specific.icdoff); 1222 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: ctrattr 0x%x\n", 1223 *(uint8_t *)&cdata->nvmf_specific.ctrattr); 1224 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "ext ctrlr data: msdbd 0x%x\n", 1225 cdata->nvmf_specific.msdbd); 1226 } 1227 1228 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1229 } 1230 1231 static int 1232 spdk_nvmf_ctrlr_identify_active_ns_list(struct spdk_nvmf_subsystem *subsystem, 1233 struct spdk_nvme_cmd *cmd, 1234 struct spdk_nvme_cpl *rsp, 1235 struct spdk_nvme_ns_list *ns_list) 1236 { 1237 struct spdk_nvmf_ns *ns; 1238 uint32_t count = 0; 1239 1240 if (cmd->nsid >= 0xfffffffeUL) { 1241 SPDK_ERRLOG("Identify Active Namespace List with invalid NSID %u\n", cmd->nsid); 1242 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1243 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1244 } 1245 1246 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 1247 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 1248 if (ns->opts.nsid <= cmd->nsid) { 1249 continue; 1250 } 1251 1252 ns_list->ns_list[count++] = ns->opts.nsid; 1253 if (count == SPDK_COUNTOF(ns_list->ns_list)) { 1254 break; 1255 } 1256 } 1257 1258 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1259 } 1260 1261 static void 1262 _add_ns_id_desc(void **buf_ptr, size_t *buf_remain, 1263 enum spdk_nvme_nidt type, 1264 const void *data, size_t data_size) 1265 { 1266 struct spdk_nvme_ns_id_desc *desc; 1267 size_t desc_size = sizeof(*desc) + data_size; 1268 1269 /* 1270 * These should never fail in practice, since all valid NS ID descriptors 1271 * should be defined so that they fit in the available 4096-byte buffer. 1272 */ 1273 assert(data_size > 0); 1274 assert(data_size <= UINT8_MAX); 1275 assert(desc_size < *buf_remain); 1276 if (data_size == 0 || data_size > UINT8_MAX || desc_size > *buf_remain) { 1277 return; 1278 } 1279 1280 desc = *buf_ptr; 1281 desc->nidt = type; 1282 desc->nidl = data_size; 1283 memcpy(desc->nid, data, data_size); 1284 1285 *buf_ptr += desc_size; 1286 *buf_remain -= desc_size; 1287 } 1288 1289 static int 1290 spdk_nvmf_ctrlr_identify_ns_id_descriptor_list( 1291 struct spdk_nvmf_subsystem *subsystem, 1292 struct spdk_nvme_cmd *cmd, 1293 struct spdk_nvme_cpl *rsp, 1294 void *id_desc_list, size_t id_desc_list_size) 1295 { 1296 struct spdk_nvmf_ns *ns; 1297 size_t buf_remain = id_desc_list_size; 1298 void *buf_ptr = id_desc_list; 1299 1300 ns = _spdk_nvmf_subsystem_get_ns(subsystem, cmd->nsid); 1301 if (ns == NULL || ns->bdev == NULL) { 1302 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1303 rsp->status.sc = SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT; 1304 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1305 } 1306 1307 #define ADD_ID_DESC(type, data, size) \ 1308 do { \ 1309 if (!spdk_mem_all_zero(data, size)) { \ 1310 _add_ns_id_desc(&buf_ptr, &buf_remain, type, data, size); \ 1311 } \ 1312 } while (0) 1313 1314 ADD_ID_DESC(SPDK_NVME_NIDT_EUI64, ns->opts.eui64, sizeof(ns->opts.eui64)); 1315 ADD_ID_DESC(SPDK_NVME_NIDT_NGUID, ns->opts.nguid, sizeof(ns->opts.nguid)); 1316 ADD_ID_DESC(SPDK_NVME_NIDT_UUID, &ns->opts.uuid, sizeof(ns->opts.uuid)); 1317 1318 /* 1319 * The list is automatically 0-terminated because controller to host buffers in 1320 * admin commands always get zeroed in spdk_nvmf_ctrlr_process_admin_cmd(). 1321 */ 1322 1323 #undef ADD_ID_DESC 1324 1325 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1326 } 1327 1328 static int 1329 spdk_nvmf_ctrlr_identify(struct spdk_nvmf_request *req) 1330 { 1331 uint8_t cns; 1332 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1333 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1334 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1335 struct spdk_nvmf_subsystem *subsystem = ctrlr->subsys; 1336 1337 if (req->data == NULL || req->length < 4096) { 1338 SPDK_ERRLOG("identify command with invalid buffer\n"); 1339 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1340 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1341 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1342 } 1343 1344 cns = cmd->cdw10 & 0xFF; 1345 1346 if (subsystem->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY && 1347 cns != SPDK_NVME_IDENTIFY_CTRLR) { 1348 /* Discovery controllers only support Identify Controller */ 1349 goto invalid_cns; 1350 } 1351 1352 switch (cns) { 1353 case SPDK_NVME_IDENTIFY_NS: 1354 return spdk_nvmf_ctrlr_identify_ns(subsystem, cmd, rsp, req->data); 1355 case SPDK_NVME_IDENTIFY_CTRLR: 1356 return spdk_nvmf_ctrlr_identify_ctrlr(ctrlr, req->data); 1357 case SPDK_NVME_IDENTIFY_ACTIVE_NS_LIST: 1358 return spdk_nvmf_ctrlr_identify_active_ns_list(subsystem, cmd, rsp, req->data); 1359 case SPDK_NVME_IDENTIFY_NS_ID_DESCRIPTOR_LIST: 1360 return spdk_nvmf_ctrlr_identify_ns_id_descriptor_list(subsystem, cmd, rsp, req->data, req->length); 1361 default: 1362 goto invalid_cns; 1363 } 1364 1365 invalid_cns: 1366 SPDK_ERRLOG("Identify command with unsupported CNS 0x%02x\n", cns); 1367 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1368 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1369 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1370 } 1371 1372 1373 static struct spdk_nvmf_request * 1374 spdk_nvmf_qpair_abort(struct spdk_nvmf_qpair *qpair, uint16_t cid) 1375 { 1376 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1377 struct spdk_nvmf_request *req; 1378 1379 if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1380 if (ctrlr->aer_req && ctrlr->aer_req->cmd->nvme_cmd.cid == cid) { 1381 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Aborting AER request\n"); 1382 req = ctrlr->aer_req; 1383 ctrlr->aer_req = NULL; 1384 return req; 1385 } 1386 } 1387 1388 /* TODO: track list of outstanding requests in qpair? */ 1389 return NULL; 1390 } 1391 1392 static void 1393 spdk_nvmf_ctrlr_abort_done(struct spdk_io_channel_iter *i, int status) 1394 { 1395 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1396 1397 spdk_nvmf_request_complete(req); 1398 } 1399 1400 static void 1401 spdk_nvmf_ctrlr_abort_on_pg(struct spdk_io_channel_iter *i) 1402 { 1403 struct spdk_nvmf_request *req = spdk_io_channel_iter_get_ctx(i); 1404 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 1405 struct spdk_nvmf_poll_group *group = spdk_io_channel_get_ctx(ch); 1406 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1407 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1408 uint16_t sqid = cmd->cdw10 & 0xFFFFu; 1409 struct spdk_nvmf_qpair *qpair; 1410 1411 TAILQ_FOREACH(qpair, &group->qpairs, link) { 1412 if (qpair->ctrlr == req->qpair->ctrlr && qpair->qid == sqid) { 1413 struct spdk_nvmf_request *req_to_abort; 1414 uint16_t cid = cmd->cdw10 >> 16; 1415 1416 /* Found the qpair */ 1417 1418 req_to_abort = spdk_nvmf_qpair_abort(qpair, cid); 1419 if (req_to_abort == NULL) { 1420 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "cid %u not found\n", cid); 1421 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1422 rsp->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1423 spdk_for_each_channel_continue(i, -EINVAL); 1424 return; 1425 } 1426 1427 /* Complete the request with aborted status */ 1428 req_to_abort->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1429 req_to_abort->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 1430 spdk_nvmf_request_complete(req_to_abort); 1431 1432 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "abort ctrlr=%p req=%p sqid=%u cid=%u successful\n", 1433 qpair->ctrlr, req_to_abort, sqid, cid); 1434 rsp->cdw0 = 0; /* Command successfully aborted */ 1435 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 1436 rsp->status.sc = SPDK_NVME_SC_SUCCESS; 1437 /* Return -1 for the status so the iteration across threads stops. */ 1438 spdk_for_each_channel_continue(i, -1); 1439 1440 } 1441 } 1442 1443 spdk_for_each_channel_continue(i, 0); 1444 } 1445 1446 static int 1447 spdk_nvmf_ctrlr_abort(struct spdk_nvmf_request *req) 1448 { 1449 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1450 1451 rsp->cdw0 = 1; /* Command not aborted */ 1452 rsp->status.sct = SPDK_NVME_SCT_COMMAND_SPECIFIC; 1453 rsp->status.sc = SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER; 1454 1455 /* Send a message to each poll group, searching for this ctrlr, sqid, and command. */ 1456 spdk_for_each_channel(req->qpair->ctrlr->subsys->tgt, 1457 spdk_nvmf_ctrlr_abort_on_pg, 1458 req, 1459 spdk_nvmf_ctrlr_abort_done 1460 ); 1461 1462 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 1463 } 1464 1465 static int 1466 get_features_generic(struct spdk_nvmf_request *req, uint32_t cdw0) 1467 { 1468 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 1469 1470 rsp->cdw0 = cdw0; 1471 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1472 } 1473 1474 static int 1475 spdk_nvmf_ctrlr_get_features(struct spdk_nvmf_request *req) 1476 { 1477 uint8_t feature; 1478 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1479 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1480 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1481 1482 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1483 switch (feature) { 1484 case SPDK_NVME_FEAT_ARBITRATION: 1485 return get_features_generic(req, ctrlr->feat.arbitration.raw); 1486 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 1487 return get_features_generic(req, ctrlr->feat.power_management.raw); 1488 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 1489 return spdk_nvmf_ctrlr_get_features_temperature_threshold(req); 1490 case SPDK_NVME_FEAT_ERROR_RECOVERY: 1491 return get_features_generic(req, ctrlr->feat.error_recovery.raw); 1492 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 1493 return get_features_generic(req, ctrlr->feat.volatile_write_cache.raw); 1494 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1495 return get_features_generic(req, ctrlr->feat.number_of_queues.raw); 1496 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 1497 return get_features_generic(req, ctrlr->feat.write_atomicity.raw); 1498 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1499 return get_features_generic(req, ctrlr->feat.async_event_configuration.raw); 1500 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1501 return get_features_generic(req, ctrlr->feat.keep_alive_timer.raw); 1502 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1503 return spdk_nvmf_ctrlr_get_features_host_identifier(req); 1504 default: 1505 SPDK_ERRLOG("Get Features command with unsupported feature ID 0x%02x\n", feature); 1506 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1507 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1508 } 1509 } 1510 1511 static int 1512 spdk_nvmf_ctrlr_set_features(struct spdk_nvmf_request *req) 1513 { 1514 uint8_t feature; 1515 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1516 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1517 1518 feature = cmd->cdw10 & 0xff; /* mask out the FID value */ 1519 switch (feature) { 1520 case SPDK_NVME_FEAT_ARBITRATION: 1521 return spdk_nvmf_ctrlr_set_features_arbitration(req); 1522 case SPDK_NVME_FEAT_POWER_MANAGEMENT: 1523 return spdk_nvmf_ctrlr_set_features_power_management(req); 1524 case SPDK_NVME_FEAT_TEMPERATURE_THRESHOLD: 1525 return spdk_nvmf_ctrlr_set_features_temperature_threshold(req); 1526 case SPDK_NVME_FEAT_ERROR_RECOVERY: 1527 return spdk_nvmf_ctrlr_set_features_error_recovery(req); 1528 case SPDK_NVME_FEAT_VOLATILE_WRITE_CACHE: 1529 return spdk_nvmf_ctrlr_set_features_volatile_write_cache(req); 1530 case SPDK_NVME_FEAT_NUMBER_OF_QUEUES: 1531 return spdk_nvmf_ctrlr_set_features_number_of_queues(req); 1532 case SPDK_NVME_FEAT_WRITE_ATOMICITY: 1533 return spdk_nvmf_ctrlr_set_features_write_atomicity(req); 1534 case SPDK_NVME_FEAT_ASYNC_EVENT_CONFIGURATION: 1535 return spdk_nvmf_ctrlr_set_features_async_event_configuration(req); 1536 case SPDK_NVME_FEAT_KEEP_ALIVE_TIMER: 1537 return spdk_nvmf_ctrlr_set_features_keep_alive_timer(req); 1538 case SPDK_NVME_FEAT_HOST_IDENTIFIER: 1539 return spdk_nvmf_ctrlr_set_features_host_identifier(req); 1540 default: 1541 SPDK_ERRLOG("Set Features command with unsupported feature ID 0x%02x\n", feature); 1542 response->status.sc = SPDK_NVME_SC_INVALID_FIELD; 1543 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1544 } 1545 } 1546 1547 static int 1548 spdk_nvmf_ctrlr_keep_alive(struct spdk_nvmf_request *req) 1549 { 1550 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Keep Alive\n"); 1551 /* 1552 * To handle keep alive just clear or reset the 1553 * ctrlr based keep alive duration counter. 1554 * When added, a separate timer based process 1555 * will monitor if the time since last recorded 1556 * keep alive has exceeded the max duration and 1557 * take appropriate action. 1558 */ 1559 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1560 } 1561 1562 int 1563 spdk_nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req) 1564 { 1565 struct spdk_nvmf_ctrlr *ctrlr = req->qpair->ctrlr; 1566 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 1567 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 1568 1569 if (ctrlr == NULL) { 1570 SPDK_ERRLOG("Admin command sent before CONNECT\n"); 1571 response->status.sct = SPDK_NVME_SCT_GENERIC; 1572 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1573 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1574 } 1575 1576 if (ctrlr->vcprop.cc.bits.en != 1) { 1577 SPDK_ERRLOG("Admin command sent to disabled controller\n"); 1578 response->status.sct = SPDK_NVME_SCT_GENERIC; 1579 response->status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1580 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1581 } 1582 1583 if (req->data && spdk_nvme_opc_get_data_transfer(cmd->opc) == SPDK_NVME_DATA_CONTROLLER_TO_HOST) { 1584 memset(req->data, 0, req->length); 1585 } 1586 1587 if (ctrlr->subsys->subtype == SPDK_NVMF_SUBTYPE_DISCOVERY) { 1588 /* Discovery controllers only support Get Log Page and Identify */ 1589 switch (cmd->opc) { 1590 case SPDK_NVME_OPC_IDENTIFY: 1591 case SPDK_NVME_OPC_GET_LOG_PAGE: 1592 break; 1593 default: 1594 goto invalid_opcode; 1595 } 1596 } 1597 1598 switch (cmd->opc) { 1599 case SPDK_NVME_OPC_GET_LOG_PAGE: 1600 return spdk_nvmf_ctrlr_get_log_page(req); 1601 case SPDK_NVME_OPC_IDENTIFY: 1602 return spdk_nvmf_ctrlr_identify(req); 1603 case SPDK_NVME_OPC_ABORT: 1604 return spdk_nvmf_ctrlr_abort(req); 1605 case SPDK_NVME_OPC_GET_FEATURES: 1606 return spdk_nvmf_ctrlr_get_features(req); 1607 case SPDK_NVME_OPC_SET_FEATURES: 1608 return spdk_nvmf_ctrlr_set_features(req); 1609 case SPDK_NVME_OPC_ASYNC_EVENT_REQUEST: 1610 return spdk_nvmf_ctrlr_async_event_request(req); 1611 case SPDK_NVME_OPC_KEEP_ALIVE: 1612 return spdk_nvmf_ctrlr_keep_alive(req); 1613 1614 case SPDK_NVME_OPC_CREATE_IO_SQ: 1615 case SPDK_NVME_OPC_CREATE_IO_CQ: 1616 case SPDK_NVME_OPC_DELETE_IO_SQ: 1617 case SPDK_NVME_OPC_DELETE_IO_CQ: 1618 /* Create and Delete I/O CQ/SQ not allowed in NVMe-oF */ 1619 goto invalid_opcode; 1620 1621 default: 1622 goto invalid_opcode; 1623 } 1624 1625 invalid_opcode: 1626 SPDK_ERRLOG("Unsupported admin opcode 0x%x\n", cmd->opc); 1627 response->status.sct = SPDK_NVME_SCT_GENERIC; 1628 response->status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1629 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1630 } 1631 1632 int 1633 spdk_nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req) 1634 { 1635 struct spdk_nvmf_qpair *qpair = req->qpair; 1636 struct spdk_nvmf_capsule_cmd *cap_hdr; 1637 1638 cap_hdr = &req->cmd->nvmf_cmd; 1639 1640 if (qpair->ctrlr == NULL) { 1641 /* No ctrlr established yet; the only valid command is Connect */ 1642 if (cap_hdr->fctype == SPDK_NVMF_FABRIC_COMMAND_CONNECT) { 1643 return spdk_nvmf_ctrlr_connect(req); 1644 } else { 1645 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Got fctype 0x%x, expected Connect\n", 1646 cap_hdr->fctype); 1647 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1648 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR; 1649 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1650 } 1651 } else if (spdk_nvmf_qpair_is_admin_queue(qpair)) { 1652 /* 1653 * Controller session is established, and this is an admin queue. 1654 * Disallow Connect and allow other fabrics commands. 1655 */ 1656 switch (cap_hdr->fctype) { 1657 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_SET: 1658 return spdk_nvmf_property_set(req); 1659 case SPDK_NVMF_FABRIC_COMMAND_PROPERTY_GET: 1660 return spdk_nvmf_property_get(req); 1661 default: 1662 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "unknown fctype 0x%02x\n", 1663 cap_hdr->fctype); 1664 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1665 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1666 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1667 } 1668 } else { 1669 /* Controller session is established, and this is an I/O queue */ 1670 /* For now, no I/O-specific Fabrics commands are implemented (other than Connect) */ 1671 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "Unexpected I/O fctype 0x%x\n", cap_hdr->fctype); 1672 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 1673 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 1674 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 1675 } 1676 } 1677 1678 int 1679 spdk_nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr) 1680 { 1681 struct spdk_nvmf_request *req; 1682 struct spdk_nvme_cpl *rsp; 1683 union spdk_nvme_async_event_completion event = {0}; 1684 1685 /* Users may disable the event notification */ 1686 if (!ctrlr->feat.async_event_configuration.bits.ns_attr_notice) { 1687 return 0; 1688 } 1689 1690 event.bits.async_event_type = SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE; 1691 event.bits.async_event_info = SPDK_NVME_ASYNC_EVENT_NS_ATTR_CHANGED; 1692 event.bits.log_page_identifier = SPDK_NVME_LOG_CHANGED_NS_LIST; 1693 1694 /* If there is no outstanding AER request, queue the event. Then 1695 * if an AER is later submitted, this event can be sent as a 1696 * response. 1697 */ 1698 if (!ctrlr->aer_req) { 1699 if (ctrlr->notice_event.bits.async_event_type == 1700 SPDK_NVME_ASYNC_EVENT_TYPE_NOTICE) { 1701 return 0; 1702 } 1703 1704 ctrlr->notice_event.raw = event.raw; 1705 return 0; 1706 } 1707 1708 req = ctrlr->aer_req; 1709 rsp = &req->rsp->nvme_cpl; 1710 1711 rsp->cdw0 = event.raw; 1712 1713 spdk_nvmf_request_complete(req); 1714 ctrlr->aer_req = NULL; 1715 1716 return 0; 1717 } 1718 1719 void 1720 spdk_nvmf_qpair_free_aer(struct spdk_nvmf_qpair *qpair) 1721 { 1722 struct spdk_nvmf_ctrlr *ctrlr = qpair->ctrlr; 1723 1724 if (!spdk_nvmf_qpair_is_admin_queue(qpair)) { 1725 return; 1726 } 1727 1728 if (ctrlr->aer_req != NULL) { 1729 spdk_nvmf_request_free(ctrlr->aer_req); 1730 ctrlr->aer_req = NULL; 1731 } 1732 } 1733 1734 void 1735 spdk_nvmf_ctrlr_abort_aer(struct spdk_nvmf_ctrlr *ctrlr) 1736 { 1737 if (!ctrlr->aer_req) { 1738 return; 1739 } 1740 1741 spdk_nvmf_request_complete(ctrlr->aer_req); 1742 ctrlr->aer_req = NULL; 1743 } 1744