1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (C) 2012-2013 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 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/bio.h> 34 #include <sys/bus.h> 35 #include <sys/conf.h> 36 #include <sys/disk.h> 37 #include <sys/fcntl.h> 38 #include <sys/ioccom.h> 39 #include <sys/malloc.h> 40 #include <sys/module.h> 41 #include <sys/proc.h> 42 #include <sys/systm.h> 43 44 #include <dev/pci/pcivar.h> 45 46 #include <geom/geom.h> 47 48 #include "nvme_private.h" 49 50 static void nvme_bio_child_inbed(struct bio *parent, int bio_error); 51 static void nvme_bio_child_done(void *arg, 52 const struct nvme_completion *cpl); 53 static uint32_t nvme_get_num_segments(uint64_t addr, uint64_t size, 54 uint32_t alignment); 55 static void nvme_free_child_bios(int num_bios, 56 struct bio **child_bios); 57 static struct bio ** nvme_allocate_child_bios(int num_bios); 58 static struct bio ** nvme_construct_child_bios(struct bio *bp, 59 uint32_t alignment, 60 int *num_bios); 61 static int nvme_ns_split_bio(struct nvme_namespace *ns, 62 struct bio *bp, 63 uint32_t alignment); 64 65 static int 66 nvme_ns_ioctl(struct cdev *cdev, u_long cmd, caddr_t arg, int flag, 67 struct thread *td) 68 { 69 struct nvme_namespace *ns; 70 struct nvme_controller *ctrlr; 71 struct nvme_pt_command *pt; 72 73 ns = cdev->si_drv1; 74 ctrlr = ns->ctrlr; 75 76 switch (cmd) { 77 case NVME_IO_TEST: 78 case NVME_BIO_TEST: 79 nvme_ns_test(ns, cmd, arg); 80 break; 81 case NVME_PASSTHROUGH_CMD: 82 pt = (struct nvme_pt_command *)arg; 83 return (nvme_ctrlr_passthrough_cmd(ctrlr, pt, ns->id, 84 1 /* is_user_buffer */, 0 /* is_admin_cmd */)); 85 case NVME_GET_NSID: 86 { 87 struct nvme_get_nsid *gnsid = (struct nvme_get_nsid *)arg; 88 strncpy(gnsid->cdev, device_get_nameunit(ctrlr->dev), 89 sizeof(gnsid->cdev)); 90 gnsid->cdev[sizeof(gnsid->cdev) - 1] = '\0'; 91 gnsid->nsid = ns->id; 92 break; 93 } 94 case DIOCGMEDIASIZE: 95 *(off_t *)arg = (off_t)nvme_ns_get_size(ns); 96 break; 97 case DIOCGSECTORSIZE: 98 *(u_int *)arg = nvme_ns_get_sector_size(ns); 99 break; 100 default: 101 return (ENOTTY); 102 } 103 104 return (0); 105 } 106 107 static int 108 nvme_ns_open(struct cdev *dev __unused, int flags, int fmt __unused, 109 struct thread *td) 110 { 111 int error = 0; 112 113 if (flags & FWRITE) 114 error = securelevel_gt(td->td_ucred, 0); 115 116 return (error); 117 } 118 119 static int 120 nvme_ns_close(struct cdev *dev __unused, int flags, int fmt __unused, 121 struct thread *td) 122 { 123 124 return (0); 125 } 126 127 static void 128 nvme_ns_strategy_done(void *arg, const struct nvme_completion *cpl) 129 { 130 struct bio *bp = arg; 131 132 /* 133 * TODO: add more extensive translation of NVMe status codes 134 * to different bio error codes (i.e. EIO, EINVAL, etc.) 135 */ 136 if (nvme_completion_is_error(cpl)) { 137 bp->bio_error = EIO; 138 bp->bio_flags |= BIO_ERROR; 139 bp->bio_resid = bp->bio_bcount; 140 } else 141 bp->bio_resid = 0; 142 143 biodone(bp); 144 } 145 146 static void 147 nvme_ns_strategy(struct bio *bp) 148 { 149 struct nvme_namespace *ns; 150 int err; 151 152 ns = bp->bio_dev->si_drv1; 153 err = nvme_ns_bio_process(ns, bp, nvme_ns_strategy_done); 154 155 if (err) { 156 bp->bio_error = err; 157 bp->bio_flags |= BIO_ERROR; 158 bp->bio_resid = bp->bio_bcount; 159 biodone(bp); 160 } 161 162 } 163 164 static struct cdevsw nvme_ns_cdevsw = { 165 .d_version = D_VERSION, 166 .d_flags = D_DISK, 167 .d_read = physread, 168 .d_write = physwrite, 169 .d_open = nvme_ns_open, 170 .d_close = nvme_ns_close, 171 .d_strategy = nvme_ns_strategy, 172 .d_ioctl = nvme_ns_ioctl 173 }; 174 175 uint32_t 176 nvme_ns_get_max_io_xfer_size(struct nvme_namespace *ns) 177 { 178 return ns->ctrlr->max_xfer_size; 179 } 180 181 uint32_t 182 nvme_ns_get_sector_size(struct nvme_namespace *ns) 183 { 184 uint8_t flbas_fmt, lbads; 185 186 flbas_fmt = (ns->data.flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) & 187 NVME_NS_DATA_FLBAS_FORMAT_MASK; 188 lbads = (ns->data.lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) & 189 NVME_NS_DATA_LBAF_LBADS_MASK; 190 191 return (1 << lbads); 192 } 193 194 uint64_t 195 nvme_ns_get_num_sectors(struct nvme_namespace *ns) 196 { 197 return (ns->data.nsze); 198 } 199 200 uint64_t 201 nvme_ns_get_size(struct nvme_namespace *ns) 202 { 203 return (nvme_ns_get_num_sectors(ns) * nvme_ns_get_sector_size(ns)); 204 } 205 206 uint32_t 207 nvme_ns_get_flags(struct nvme_namespace *ns) 208 { 209 return (ns->flags); 210 } 211 212 const char * 213 nvme_ns_get_serial_number(struct nvme_namespace *ns) 214 { 215 return ((const char *)ns->ctrlr->cdata.sn); 216 } 217 218 const char * 219 nvme_ns_get_model_number(struct nvme_namespace *ns) 220 { 221 return ((const char *)ns->ctrlr->cdata.mn); 222 } 223 224 const struct nvme_namespace_data * 225 nvme_ns_get_data(struct nvme_namespace *ns) 226 { 227 228 return (&ns->data); 229 } 230 231 uint32_t 232 nvme_ns_get_stripesize(struct nvme_namespace *ns) 233 { 234 235 if (((ns->data.nsfeat >> NVME_NS_DATA_NSFEAT_NPVALID_SHIFT) & 236 NVME_NS_DATA_NSFEAT_NPVALID_MASK) != 0 && ns->data.npwg != 0) { 237 return ((ns->data.npwg + 1) * nvme_ns_get_sector_size(ns)); 238 } 239 return (ns->boundary); 240 } 241 242 static void 243 nvme_ns_bio_done(void *arg, const struct nvme_completion *status) 244 { 245 struct bio *bp = arg; 246 nvme_cb_fn_t bp_cb_fn; 247 248 bp_cb_fn = bp->bio_driver1; 249 250 if (bp->bio_driver2) 251 free(bp->bio_driver2, M_NVME); 252 253 if (nvme_completion_is_error(status)) { 254 bp->bio_flags |= BIO_ERROR; 255 if (bp->bio_error == 0) 256 bp->bio_error = EIO; 257 } 258 259 if ((bp->bio_flags & BIO_ERROR) == 0) 260 bp->bio_resid = 0; 261 else 262 bp->bio_resid = bp->bio_bcount; 263 264 bp_cb_fn(bp, status); 265 } 266 267 static void 268 nvme_bio_child_inbed(struct bio *parent, int bio_error) 269 { 270 struct nvme_completion parent_cpl; 271 int children, inbed; 272 273 if (bio_error != 0) { 274 parent->bio_flags |= BIO_ERROR; 275 parent->bio_error = bio_error; 276 } 277 278 /* 279 * atomic_fetchadd will return value before adding 1, so we still 280 * must add 1 to get the updated inbed number. Save bio_children 281 * before incrementing to guard against race conditions when 282 * two children bios complete on different queues. 283 */ 284 children = atomic_load_acq_int(&parent->bio_children); 285 inbed = atomic_fetchadd_int(&parent->bio_inbed, 1) + 1; 286 if (inbed == children) { 287 bzero(&parent_cpl, sizeof(parent_cpl)); 288 if (parent->bio_flags & BIO_ERROR) { 289 parent_cpl.status &= ~(NVME_STATUS_SC_MASK << NVME_STATUS_SC_SHIFT); 290 parent_cpl.status |= (NVME_SC_DATA_TRANSFER_ERROR) << NVME_STATUS_SC_SHIFT; 291 } 292 nvme_ns_bio_done(parent, &parent_cpl); 293 } 294 } 295 296 static void 297 nvme_bio_child_done(void *arg, const struct nvme_completion *cpl) 298 { 299 struct bio *child = arg; 300 struct bio *parent; 301 int bio_error; 302 303 parent = child->bio_parent; 304 g_destroy_bio(child); 305 bio_error = nvme_completion_is_error(cpl) ? EIO : 0; 306 nvme_bio_child_inbed(parent, bio_error); 307 } 308 309 static uint32_t 310 nvme_get_num_segments(uint64_t addr, uint64_t size, uint32_t align) 311 { 312 uint32_t num_segs, offset, remainder; 313 314 if (align == 0) 315 return (1); 316 317 KASSERT((align & (align - 1)) == 0, ("alignment not power of 2\n")); 318 319 num_segs = size / align; 320 remainder = size & (align - 1); 321 offset = addr & (align - 1); 322 if (remainder > 0 || offset > 0) 323 num_segs += 1 + (remainder + offset - 1) / align; 324 return (num_segs); 325 } 326 327 static void 328 nvme_free_child_bios(int num_bios, struct bio **child_bios) 329 { 330 int i; 331 332 for (i = 0; i < num_bios; i++) { 333 if (child_bios[i] != NULL) 334 g_destroy_bio(child_bios[i]); 335 } 336 337 free(child_bios, M_NVME); 338 } 339 340 static struct bio ** 341 nvme_allocate_child_bios(int num_bios) 342 { 343 struct bio **child_bios; 344 int err = 0, i; 345 346 child_bios = malloc(num_bios * sizeof(struct bio *), M_NVME, M_NOWAIT); 347 if (child_bios == NULL) 348 return (NULL); 349 350 for (i = 0; i < num_bios; i++) { 351 child_bios[i] = g_new_bio(); 352 if (child_bios[i] == NULL) 353 err = ENOMEM; 354 } 355 356 if (err == ENOMEM) { 357 nvme_free_child_bios(num_bios, child_bios); 358 return (NULL); 359 } 360 361 return (child_bios); 362 } 363 364 static struct bio ** 365 nvme_construct_child_bios(struct bio *bp, uint32_t alignment, int *num_bios) 366 { 367 struct bio **child_bios; 368 struct bio *child; 369 uint64_t cur_offset; 370 caddr_t data; 371 uint32_t rem_bcount; 372 int i; 373 struct vm_page **ma; 374 uint32_t ma_offset; 375 376 *num_bios = nvme_get_num_segments(bp->bio_offset, bp->bio_bcount, 377 alignment); 378 child_bios = nvme_allocate_child_bios(*num_bios); 379 if (child_bios == NULL) 380 return (NULL); 381 382 bp->bio_children = *num_bios; 383 bp->bio_inbed = 0; 384 cur_offset = bp->bio_offset; 385 rem_bcount = bp->bio_bcount; 386 data = bp->bio_data; 387 ma_offset = bp->bio_ma_offset; 388 ma = bp->bio_ma; 389 390 for (i = 0; i < *num_bios; i++) { 391 child = child_bios[i]; 392 child->bio_parent = bp; 393 child->bio_cmd = bp->bio_cmd; 394 child->bio_offset = cur_offset; 395 child->bio_bcount = min(rem_bcount, 396 alignment - (cur_offset & (alignment - 1))); 397 child->bio_flags = bp->bio_flags; 398 if (bp->bio_flags & BIO_UNMAPPED) { 399 child->bio_ma_offset = ma_offset; 400 child->bio_ma = ma; 401 child->bio_ma_n = 402 nvme_get_num_segments(child->bio_ma_offset, 403 child->bio_bcount, PAGE_SIZE); 404 ma_offset = (ma_offset + child->bio_bcount) & 405 PAGE_MASK; 406 ma += child->bio_ma_n; 407 if (ma_offset != 0) 408 ma -= 1; 409 } else { 410 child->bio_data = data; 411 data += child->bio_bcount; 412 } 413 cur_offset += child->bio_bcount; 414 rem_bcount -= child->bio_bcount; 415 } 416 417 return (child_bios); 418 } 419 420 static int 421 nvme_ns_split_bio(struct nvme_namespace *ns, struct bio *bp, 422 uint32_t alignment) 423 { 424 struct bio *child; 425 struct bio **child_bios; 426 int err, i, num_bios; 427 428 child_bios = nvme_construct_child_bios(bp, alignment, &num_bios); 429 if (child_bios == NULL) 430 return (ENOMEM); 431 432 for (i = 0; i < num_bios; i++) { 433 child = child_bios[i]; 434 err = nvme_ns_bio_process(ns, child, nvme_bio_child_done); 435 if (err != 0) { 436 nvme_bio_child_inbed(bp, err); 437 g_destroy_bio(child); 438 } 439 } 440 441 free(child_bios, M_NVME); 442 return (0); 443 } 444 445 int 446 nvme_ns_bio_process(struct nvme_namespace *ns, struct bio *bp, 447 nvme_cb_fn_t cb_fn) 448 { 449 struct nvme_dsm_range *dsm_range; 450 uint32_t num_bios; 451 int err; 452 453 bp->bio_driver1 = cb_fn; 454 455 if (ns->boundary > 0 && 456 (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE)) { 457 num_bios = nvme_get_num_segments(bp->bio_offset, 458 bp->bio_bcount, ns->boundary); 459 if (num_bios > 1) 460 return (nvme_ns_split_bio(ns, bp, ns->boundary)); 461 } 462 463 switch (bp->bio_cmd) { 464 case BIO_READ: 465 err = nvme_ns_cmd_read_bio(ns, bp, nvme_ns_bio_done, bp); 466 break; 467 case BIO_WRITE: 468 err = nvme_ns_cmd_write_bio(ns, bp, nvme_ns_bio_done, bp); 469 break; 470 case BIO_FLUSH: 471 err = nvme_ns_cmd_flush(ns, nvme_ns_bio_done, bp); 472 break; 473 case BIO_DELETE: 474 dsm_range = 475 malloc(sizeof(struct nvme_dsm_range), M_NVME, 476 M_ZERO | M_WAITOK); 477 if (!dsm_range) { 478 err = ENOMEM; 479 break; 480 } 481 dsm_range->length = 482 htole32(bp->bio_bcount/nvme_ns_get_sector_size(ns)); 483 dsm_range->starting_lba = 484 htole64(bp->bio_offset/nvme_ns_get_sector_size(ns)); 485 bp->bio_driver2 = dsm_range; 486 err = nvme_ns_cmd_deallocate(ns, dsm_range, 1, 487 nvme_ns_bio_done, bp); 488 if (err != 0) 489 free(dsm_range, M_NVME); 490 break; 491 default: 492 err = EOPNOTSUPP; 493 break; 494 } 495 496 return (err); 497 } 498 499 int 500 nvme_ns_ioctl_process(struct nvme_namespace *ns, u_long cmd, caddr_t arg, 501 int flag, struct thread *td) 502 { 503 return (nvme_ns_ioctl(ns->cdev, cmd, arg, flag, td)); 504 } 505 506 int 507 nvme_ns_construct(struct nvme_namespace *ns, uint32_t id, 508 struct nvme_controller *ctrlr) 509 { 510 struct make_dev_args md_args; 511 struct nvme_completion_poll_status status; 512 int res; 513 int unit; 514 uint8_t flbas_fmt; 515 uint8_t vwc_present; 516 517 ns->ctrlr = ctrlr; 518 ns->id = id; 519 520 /* 521 * Namespaces are reconstructed after a controller reset, so check 522 * to make sure we only call mtx_init once on each mtx. 523 * 524 * TODO: Move this somewhere where it gets called at controller 525 * construction time, which is not invoked as part of each 526 * controller reset. 527 */ 528 if (!mtx_initialized(&ns->lock)) 529 mtx_init(&ns->lock, "nvme ns lock", NULL, MTX_DEF); 530 531 status.done = 0; 532 nvme_ctrlr_cmd_identify_namespace(ctrlr, id, &ns->data, 533 nvme_completion_poll_cb, &status); 534 nvme_completion_poll(&status); 535 if (nvme_completion_is_error(&status.cpl)) { 536 nvme_printf(ctrlr, "nvme_identify_namespace failed\n"); 537 return (ENXIO); 538 } 539 540 /* Convert data to host endian */ 541 nvme_namespace_data_swapbytes(&ns->data); 542 543 /* 544 * If the size of is zero, chances are this isn't a valid 545 * namespace (eg one that's not been configured yet). The 546 * standard says the entire id will be zeros, so this is a 547 * cheap way to test for that. 548 */ 549 if (ns->data.nsze == 0) 550 return (ENXIO); 551 552 flbas_fmt = (ns->data.flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) & 553 NVME_NS_DATA_FLBAS_FORMAT_MASK; 554 /* 555 * Note: format is a 0-based value, so > is appropriate here, 556 * not >=. 557 */ 558 if (flbas_fmt > ns->data.nlbaf) { 559 printf("lba format %d exceeds number supported (%d)\n", 560 flbas_fmt, ns->data.nlbaf + 1); 561 return (ENXIO); 562 } 563 564 /* 565 * Older Intel devices advertise in vendor specific space an alignment 566 * that improves performance. If present use for the stripe size. NVMe 567 * 1.3 standardized this as NOIOB, and newer Intel drives use that. 568 */ 569 switch (pci_get_devid(ctrlr->dev)) { 570 case 0x09538086: /* Intel DC PC3500 */ 571 case 0x0a538086: /* Intel DC PC3520 */ 572 case 0x0a548086: /* Intel DC PC4500 */ 573 case 0x0a558086: /* Dell Intel P4600 */ 574 if (ctrlr->cdata.vs[3] != 0) 575 ns->boundary = 576 (1 << ctrlr->cdata.vs[3]) * ctrlr->min_page_size; 577 else 578 ns->boundary = 0; 579 break; 580 default: 581 ns->boundary = ns->data.noiob * nvme_ns_get_sector_size(ns); 582 break; 583 } 584 585 if (nvme_ctrlr_has_dataset_mgmt(&ctrlr->cdata)) 586 ns->flags |= NVME_NS_DEALLOCATE_SUPPORTED; 587 588 vwc_present = (ctrlr->cdata.vwc >> NVME_CTRLR_DATA_VWC_PRESENT_SHIFT) & 589 NVME_CTRLR_DATA_VWC_PRESENT_MASK; 590 if (vwc_present) 591 ns->flags |= NVME_NS_FLUSH_SUPPORTED; 592 593 /* 594 * cdev may have already been created, if we are reconstructing the 595 * namespace after a controller-level reset. 596 */ 597 if (ns->cdev != NULL) 598 return (0); 599 600 /* 601 * Namespace IDs start at 1, so we need to subtract 1 to create a 602 * correct unit number. 603 */ 604 unit = device_get_unit(ctrlr->dev) * NVME_MAX_NAMESPACES + ns->id - 1; 605 606 make_dev_args_init(&md_args); 607 md_args.mda_devsw = &nvme_ns_cdevsw; 608 md_args.mda_unit = unit; 609 md_args.mda_mode = 0600; 610 md_args.mda_si_drv1 = ns; 611 res = make_dev_s(&md_args, &ns->cdev, "nvme%dns%d", 612 device_get_unit(ctrlr->dev), ns->id); 613 if (res != 0) 614 return (ENXIO); 615 616 ns->cdev->si_flags |= SI_UNMAPPED; 617 618 return (0); 619 } 620 621 void 622 nvme_ns_destruct(struct nvme_namespace *ns) 623 { 624 625 if (ns->cdev != NULL) 626 destroy_dev(ns->cdev); 627 } 628