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