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