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 38 #include "spdk/bdev.h" 39 #include "spdk/endian.h" 40 #include "spdk/thread.h" 41 #include "spdk/likely.h" 42 #include "spdk/nvme.h" 43 #include "spdk/nvmf_spec.h" 44 #include "spdk/trace.h" 45 #include "spdk/scsi_spec.h" 46 #include "spdk/string.h" 47 #include "spdk/util.h" 48 49 #include "spdk_internal/log.h" 50 51 static bool 52 spdk_nvmf_subsystem_bdev_io_type_supported(struct spdk_nvmf_subsystem *subsystem, 53 enum spdk_bdev_io_type io_type) 54 { 55 struct spdk_nvmf_ns *ns; 56 57 for (ns = spdk_nvmf_subsystem_get_first_ns(subsystem); ns != NULL; 58 ns = spdk_nvmf_subsystem_get_next_ns(subsystem, ns)) { 59 if (ns->bdev == NULL) { 60 continue; 61 } 62 63 if (!spdk_bdev_io_type_supported(ns->bdev, io_type)) { 64 SPDK_DEBUGLOG(SPDK_LOG_NVMF, 65 "Subsystem %s namespace %u (%s) does not support io_type %d\n", 66 spdk_nvmf_subsystem_get_nqn(subsystem), 67 ns->opts.nsid, spdk_bdev_get_name(ns->bdev), (int)io_type); 68 return false; 69 } 70 } 71 72 SPDK_DEBUGLOG(SPDK_LOG_NVMF, "All devices in Subsystem %s support io_type %d\n", 73 spdk_nvmf_subsystem_get_nqn(subsystem), (int)io_type); 74 return true; 75 } 76 77 bool 78 spdk_nvmf_ctrlr_dsm_supported(struct spdk_nvmf_ctrlr *ctrlr) 79 { 80 return spdk_nvmf_subsystem_bdev_io_type_supported(ctrlr->subsys, SPDK_BDEV_IO_TYPE_UNMAP); 81 } 82 83 bool 84 spdk_nvmf_ctrlr_write_zeroes_supported(struct spdk_nvmf_ctrlr *ctrlr) 85 { 86 return spdk_nvmf_subsystem_bdev_io_type_supported(ctrlr->subsys, SPDK_BDEV_IO_TYPE_WRITE_ZEROES); 87 } 88 89 static void 90 nvmf_bdev_ctrlr_complete_cmd(struct spdk_bdev_io *bdev_io, bool success, 91 void *cb_arg) 92 { 93 struct spdk_nvmf_request *req = cb_arg; 94 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 95 int sc, sct; 96 97 spdk_bdev_io_get_nvme_status(bdev_io, &sct, &sc); 98 response->status.sc = sc; 99 response->status.sct = sct; 100 101 spdk_nvmf_request_complete(req); 102 spdk_bdev_free_io(bdev_io); 103 } 104 105 void 106 spdk_nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata) 107 { 108 struct spdk_bdev *bdev = ns->bdev; 109 uint64_t num_blocks; 110 111 num_blocks = spdk_bdev_get_num_blocks(bdev); 112 113 nsdata->nsze = num_blocks; 114 nsdata->ncap = num_blocks; 115 nsdata->nuse = num_blocks; 116 nsdata->nlbaf = 0; 117 nsdata->flbas.format = 0; 118 nsdata->lbaf[0].lbads = spdk_u32log2(spdk_bdev_get_block_size(bdev)); 119 nsdata->noiob = spdk_bdev_get_optimal_io_boundary(bdev); 120 nsdata->nmic.can_share = 1; 121 122 SPDK_STATIC_ASSERT(sizeof(nsdata->nguid) == sizeof(ns->opts.nguid), "size mismatch"); 123 memcpy(nsdata->nguid, ns->opts.nguid, sizeof(nsdata->nguid)); 124 125 SPDK_STATIC_ASSERT(sizeof(nsdata->eui64) == sizeof(ns->opts.eui64), "size mismatch"); 126 memcpy(&nsdata->eui64, ns->opts.eui64, sizeof(nsdata->eui64)); 127 } 128 129 static void 130 nvmf_bdev_ctrlr_get_rw_params(const struct spdk_nvme_cmd *cmd, uint64_t *start_lba, 131 uint64_t *num_blocks) 132 { 133 /* SLBA: CDW10 and CDW11 */ 134 *start_lba = from_le64(&cmd->cdw10); 135 136 /* NLB: CDW12 bits 15:00, 0's based */ 137 *num_blocks = (from_le32(&cmd->cdw12) & 0xFFFFu) + 1; 138 } 139 140 static bool 141 nvmf_bdev_ctrlr_lba_in_range(uint64_t bdev_num_blocks, uint64_t io_start_lba, 142 uint64_t io_num_blocks) 143 { 144 if (io_start_lba + io_num_blocks > bdev_num_blocks || 145 io_start_lba + io_num_blocks < io_start_lba) { 146 return false; 147 } 148 149 return true; 150 } 151 152 static void 153 spdk_nvmf_ctrlr_process_io_cmd_resubmit(void *arg) 154 { 155 struct spdk_nvmf_request *req = arg; 156 157 spdk_nvmf_ctrlr_process_io_cmd(req); 158 } 159 160 static void 161 nvmf_bdev_ctrl_queue_io(struct spdk_nvmf_request *req, struct spdk_bdev *bdev, 162 struct spdk_io_channel *ch, spdk_bdev_io_wait_cb cb_fn, void *cb_arg) 163 { 164 int rc; 165 166 req->bdev_io_wait.bdev = bdev; 167 req->bdev_io_wait.cb_fn = cb_fn; 168 req->bdev_io_wait.cb_arg = cb_arg; 169 170 rc = spdk_bdev_queue_io_wait(bdev, ch, &req->bdev_io_wait); 171 if (rc != 0) { 172 assert(false); 173 } 174 } 175 176 int 177 spdk_nvmf_bdev_ctrlr_read_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 178 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 179 { 180 uint64_t bdev_num_blocks = spdk_bdev_get_num_blocks(bdev); 181 uint32_t block_size = spdk_bdev_get_block_size(bdev); 182 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 183 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 184 uint64_t start_lba; 185 uint64_t num_blocks; 186 int rc; 187 188 nvmf_bdev_ctrlr_get_rw_params(cmd, &start_lba, &num_blocks); 189 190 if (spdk_unlikely(!nvmf_bdev_ctrlr_lba_in_range(bdev_num_blocks, start_lba, num_blocks))) { 191 SPDK_ERRLOG("end of media\n"); 192 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 193 rsp->status.sc = SPDK_NVME_SC_LBA_OUT_OF_RANGE; 194 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 195 } 196 197 if (spdk_unlikely(num_blocks * block_size > req->length)) { 198 SPDK_ERRLOG("Read NLB %" PRIu64 " * block size %" PRIu32 " > SGL length %" PRIu32 "\n", 199 num_blocks, block_size, req->length); 200 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 201 rsp->status.sc = SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID; 202 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 203 } 204 205 rc = spdk_bdev_readv_blocks(desc, ch, req->iov, req->iovcnt, start_lba, num_blocks, 206 nvmf_bdev_ctrlr_complete_cmd, req); 207 if (spdk_unlikely(rc)) { 208 if (rc == -ENOMEM) { 209 nvmf_bdev_ctrl_queue_io(req, bdev, ch, spdk_nvmf_ctrlr_process_io_cmd_resubmit, req); 210 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 211 } 212 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 213 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 214 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 215 } 216 217 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 218 } 219 220 int 221 spdk_nvmf_bdev_ctrlr_write_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 222 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 223 { 224 uint64_t bdev_num_blocks = spdk_bdev_get_num_blocks(bdev); 225 uint32_t block_size = spdk_bdev_get_block_size(bdev); 226 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 227 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 228 uint64_t start_lba; 229 uint64_t num_blocks; 230 int rc; 231 232 nvmf_bdev_ctrlr_get_rw_params(cmd, &start_lba, &num_blocks); 233 234 if (spdk_unlikely(!nvmf_bdev_ctrlr_lba_in_range(bdev_num_blocks, start_lba, num_blocks))) { 235 SPDK_ERRLOG("end of media\n"); 236 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 237 rsp->status.sc = SPDK_NVME_SC_LBA_OUT_OF_RANGE; 238 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 239 } 240 241 if (spdk_unlikely(num_blocks * block_size > req->length)) { 242 SPDK_ERRLOG("Write NLB %" PRIu64 " * block size %" PRIu32 " > SGL length %" PRIu32 "\n", 243 num_blocks, block_size, req->length); 244 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 245 rsp->status.sc = SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID; 246 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 247 } 248 249 rc = spdk_bdev_writev_blocks(desc, ch, req->iov, req->iovcnt, start_lba, num_blocks, 250 nvmf_bdev_ctrlr_complete_cmd, req); 251 if (spdk_unlikely(rc)) { 252 if (rc == -ENOMEM) { 253 nvmf_bdev_ctrl_queue_io(req, bdev, ch, spdk_nvmf_ctrlr_process_io_cmd_resubmit, req); 254 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 255 } 256 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 257 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 258 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 259 } 260 261 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 262 } 263 264 int 265 spdk_nvmf_bdev_ctrlr_write_zeroes_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 266 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 267 { 268 uint64_t bdev_num_blocks = spdk_bdev_get_num_blocks(bdev); 269 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 270 struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl; 271 uint64_t start_lba; 272 uint64_t num_blocks; 273 int rc; 274 275 nvmf_bdev_ctrlr_get_rw_params(cmd, &start_lba, &num_blocks); 276 277 if (spdk_unlikely(!nvmf_bdev_ctrlr_lba_in_range(bdev_num_blocks, start_lba, num_blocks))) { 278 SPDK_ERRLOG("end of media\n"); 279 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 280 rsp->status.sc = SPDK_NVME_SC_LBA_OUT_OF_RANGE; 281 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 282 } 283 284 rc = spdk_bdev_write_zeroes_blocks(desc, ch, start_lba, num_blocks, 285 nvmf_bdev_ctrlr_complete_cmd, req); 286 if (spdk_unlikely(rc)) { 287 if (rc == -ENOMEM) { 288 nvmf_bdev_ctrl_queue_io(req, bdev, ch, spdk_nvmf_ctrlr_process_io_cmd_resubmit, req); 289 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 290 } 291 rsp->status.sct = SPDK_NVME_SCT_GENERIC; 292 rsp->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 293 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 294 } 295 296 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 297 } 298 299 int 300 spdk_nvmf_bdev_ctrlr_flush_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 301 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 302 { 303 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 304 int rc; 305 306 /* As for NVMeoF controller, SPDK always set volatile write 307 * cache bit to 1, return success for those block devices 308 * which can't support FLUSH command. 309 */ 310 if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_FLUSH)) { 311 response->status.sct = SPDK_NVME_SCT_GENERIC; 312 response->status.sc = SPDK_NVME_SC_SUCCESS; 313 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 314 } 315 316 rc = spdk_bdev_flush_blocks(desc, ch, 0, spdk_bdev_get_num_blocks(bdev), 317 nvmf_bdev_ctrlr_complete_cmd, req); 318 if (spdk_unlikely(rc)) { 319 if (rc == -ENOMEM) { 320 nvmf_bdev_ctrl_queue_io(req, bdev, ch, spdk_nvmf_ctrlr_process_io_cmd_resubmit, req); 321 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 322 } 323 response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 324 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 325 } 326 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 327 } 328 329 struct nvmf_bdev_ctrlr_unmap { 330 struct spdk_nvmf_request *req; 331 uint32_t count; 332 struct spdk_bdev_desc *desc; 333 struct spdk_bdev *bdev; 334 struct spdk_io_channel *ch; 335 }; 336 337 static void 338 nvmf_bdev_ctrlr_unmap_cpl(struct spdk_bdev_io *bdev_io, bool success, 339 void *cb_arg) 340 { 341 struct nvmf_bdev_ctrlr_unmap *unmap_ctx = cb_arg; 342 struct spdk_nvmf_request *req = unmap_ctx->req; 343 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 344 int sc, sct; 345 346 unmap_ctx->count--; 347 348 if (response->status.sct == SPDK_NVME_SCT_GENERIC && 349 response->status.sc == SPDK_NVME_SC_SUCCESS) { 350 spdk_bdev_io_get_nvme_status(bdev_io, &sct, &sc); 351 response->status.sc = sc; 352 response->status.sct = sct; 353 } 354 355 if (unmap_ctx->count == 0) { 356 spdk_nvmf_request_complete(req); 357 free(unmap_ctx); 358 } 359 spdk_bdev_free_io(bdev_io); 360 } 361 362 static int 363 nvmf_bdev_ctrlr_unmap(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 364 struct spdk_io_channel *ch, struct spdk_nvmf_request *req, 365 struct nvmf_bdev_ctrlr_unmap *unmap_ctx); 366 static void 367 nvmf_bdev_ctrlr_unmap_resubmit(void *arg) 368 { 369 struct nvmf_bdev_ctrlr_unmap *unmap_ctx = arg; 370 struct spdk_nvmf_request *req = unmap_ctx->req; 371 struct spdk_bdev_desc *desc = unmap_ctx->desc; 372 struct spdk_bdev *bdev = unmap_ctx->bdev; 373 struct spdk_io_channel *ch = unmap_ctx->ch; 374 375 nvmf_bdev_ctrlr_unmap(bdev, desc, ch, req, unmap_ctx); 376 } 377 378 static int 379 nvmf_bdev_ctrlr_unmap(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 380 struct spdk_io_channel *ch, struct spdk_nvmf_request *req, 381 struct nvmf_bdev_ctrlr_unmap *unmap_ctx) 382 { 383 uint16_t nr, i; 384 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 385 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 386 struct spdk_nvme_dsm_range *dsm_range; 387 uint64_t lba; 388 uint32_t lba_count; 389 int rc; 390 391 nr = ((cmd->cdw10 & 0x000000ff) + 1); 392 if (nr * sizeof(struct spdk_nvme_dsm_range) > req->length) { 393 SPDK_ERRLOG("Dataset Management number of ranges > SGL length\n"); 394 response->status.sc = SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID; 395 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 396 } 397 398 if (unmap_ctx == NULL) { 399 unmap_ctx = calloc(1, sizeof(*unmap_ctx)); 400 if (!unmap_ctx) { 401 response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 402 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 403 } 404 405 unmap_ctx->req = req; 406 unmap_ctx->desc = desc; 407 unmap_ctx->ch = ch; 408 } 409 410 response->status.sct = SPDK_NVME_SCT_GENERIC; 411 response->status.sc = SPDK_NVME_SC_SUCCESS; 412 413 dsm_range = (struct spdk_nvme_dsm_range *)req->data; 414 for (i = unmap_ctx->count; i < nr; i++) { 415 lba = dsm_range[i].starting_lba; 416 lba_count = dsm_range[i].length; 417 418 unmap_ctx->count++; 419 420 rc = spdk_bdev_unmap_blocks(desc, ch, lba, lba_count, 421 nvmf_bdev_ctrlr_unmap_cpl, unmap_ctx); 422 if (rc) { 423 if (rc == -ENOMEM) { 424 nvmf_bdev_ctrl_queue_io(req, bdev, ch, nvmf_bdev_ctrlr_unmap_resubmit, unmap_ctx); 425 /* Unmap was not yet submitted to bdev */ 426 unmap_ctx->count--; 427 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 428 } 429 response->status.sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 430 unmap_ctx->count--; 431 /* We can't return here - we may have to wait for any other 432 * unmaps already sent to complete */ 433 break; 434 } 435 } 436 437 if (unmap_ctx->count == 0) { 438 free(unmap_ctx); 439 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 440 } 441 442 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 443 } 444 445 int 446 spdk_nvmf_bdev_ctrlr_dsm_cmd(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 447 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 448 { 449 uint32_t attribute; 450 struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd; 451 struct spdk_nvme_cpl *response = &req->rsp->nvme_cpl; 452 453 attribute = cmd->cdw11 & 0x00000007; 454 if (attribute & SPDK_NVME_DSM_ATTR_DEALLOCATE) { 455 return nvmf_bdev_ctrlr_unmap(bdev, desc, ch, req, NULL); 456 } 457 458 response->status.sct = SPDK_NVME_SCT_GENERIC; 459 response->status.sc = SPDK_NVME_SC_SUCCESS; 460 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 461 } 462 463 int 464 spdk_nvmf_bdev_ctrlr_nvme_passthru_io(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 465 struct spdk_io_channel *ch, struct spdk_nvmf_request *req) 466 { 467 int rc; 468 469 rc = spdk_bdev_nvme_io_passthru(desc, ch, &req->cmd->nvme_cmd, req->data, req->length, 470 nvmf_bdev_ctrlr_complete_cmd, req); 471 if (spdk_unlikely(rc)) { 472 if (rc == -ENOMEM) { 473 nvmf_bdev_ctrl_queue_io(req, bdev, ch, spdk_nvmf_ctrlr_process_io_cmd_resubmit, req); 474 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 475 } 476 req->rsp->nvme_cpl.status.sct = SPDK_NVME_SCT_GENERIC; 477 req->rsp->nvme_cpl.status.sc = SPDK_NVME_SC_INVALID_OPCODE; 478 return SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE; 479 } 480 481 return SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS; 482 } 483