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