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