1 /* $NetBSD: subr_disk.c,v 1.111 2015/01/02 01:14:22 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 1996, 1997, 1999, 2000, 2009 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Copyright (c) 1982, 1986, 1988, 1993 35 * The Regents of the University of California. All rights reserved. 36 * (c) UNIX System Laboratories, Inc. 37 * All or some portions of this file are derived from material licensed 38 * to the University of California by American Telephone and Telegraph 39 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 40 * the permission of UNIX System Laboratories, Inc. 41 * 42 * Redistribution and use in source and binary forms, with or without 43 * modification, are permitted provided that the following conditions 44 * are met: 45 * 1. Redistributions of source code must retain the above copyright 46 * notice, this list of conditions and the following disclaimer. 47 * 2. Redistributions in binary form must reproduce the above copyright 48 * notice, this list of conditions and the following disclaimer in the 49 * documentation and/or other materials provided with the distribution. 50 * 3. Neither the name of the University nor the names of its contributors 51 * may be used to endorse or promote products derived from this software 52 * without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 64 * SUCH DAMAGE. 65 * 66 * @(#)ufs_disksubr.c 8.5 (Berkeley) 1/21/94 67 */ 68 69 #include <sys/cdefs.h> 70 __KERNEL_RCSID(0, "$NetBSD: subr_disk.c,v 1.111 2015/01/02 01:14:22 christos Exp $"); 71 72 #include <sys/param.h> 73 #include <sys/kernel.h> 74 #include <sys/kmem.h> 75 #include <sys/buf.h> 76 #include <sys/fcntl.h> 77 #include <sys/syslog.h> 78 #include <sys/disklabel.h> 79 #include <sys/disk.h> 80 #include <sys/sysctl.h> 81 #include <lib/libkern/libkern.h> 82 83 /* 84 * Compute checksum for disk label. 85 */ 86 u_int 87 dkcksum(struct disklabel *lp) 88 { 89 90 return dkcksum_sized(lp, lp->d_npartitions); 91 } 92 93 u_int 94 dkcksum_sized(struct disklabel *lp, size_t npartitions) 95 { 96 uint16_t *start, *end; 97 uint16_t sum = 0; 98 99 start = (uint16_t *)lp; 100 end = (uint16_t *)&lp->d_partitions[npartitions]; 101 while (start < end) 102 sum ^= *start++; 103 return sum; 104 } 105 106 /* 107 * Disk error is the preface to plaintive error messages 108 * about failing disk transfers. It prints messages of the form 109 110 hp0g: hard error reading fsbn 12345 of 12344-12347 (hp0 bn %d cn %d tn %d sn %d) 111 112 * if the offset of the error in the transfer and a disk label 113 * are both available. blkdone should be -1 if the position of the error 114 * is unknown; the disklabel pointer may be null from drivers that have not 115 * been converted to use them. The message is printed with printf 116 * if pri is LOG_PRINTF, otherwise it uses log at the specified priority. 117 * The message should be completed (with at least a newline) with printf 118 * or addlog, respectively. There is no trailing space. 119 */ 120 #ifndef PRIdaddr 121 #define PRIdaddr PRId64 122 #endif 123 void 124 diskerr(const struct buf *bp, const char *dname, const char *what, int pri, 125 int blkdone, const struct disklabel *lp) 126 { 127 int unit = DISKUNIT(bp->b_dev), part = DISKPART(bp->b_dev); 128 void (*pr)(const char *, ...) __printflike(1, 2); 129 char partname = 'a' + part; 130 daddr_t sn; 131 132 if (/*CONSTCOND*/0) 133 /* Compiler will error this is the format is wrong... */ 134 printf("%" PRIdaddr, bp->b_blkno); 135 136 if (pri != LOG_PRINTF) { 137 static const char fmt[] = ""; 138 log(pri, fmt); 139 pr = addlog; 140 } else 141 pr = printf; 142 (*pr)("%s%d%c: %s %sing fsbn ", dname, unit, partname, what, 143 bp->b_flags & B_READ ? "read" : "writ"); 144 sn = bp->b_blkno; 145 if (bp->b_bcount <= DEV_BSIZE) 146 (*pr)("%" PRIdaddr, sn); 147 else { 148 if (blkdone >= 0) { 149 sn += blkdone; 150 (*pr)("%" PRIdaddr " of ", sn); 151 } 152 (*pr)("%" PRIdaddr "-%" PRIdaddr "", bp->b_blkno, 153 bp->b_blkno + (bp->b_bcount - 1) / DEV_BSIZE); 154 } 155 if (lp && (blkdone >= 0 || bp->b_bcount <= lp->d_secsize)) { 156 sn += lp->d_partitions[part].p_offset; 157 (*pr)(" (%s%d bn %" PRIdaddr "; cn %" PRIdaddr "", 158 dname, unit, sn, sn / lp->d_secpercyl); 159 sn %= lp->d_secpercyl; 160 (*pr)(" tn %" PRIdaddr " sn %" PRIdaddr ")", 161 sn / lp->d_nsectors, sn % lp->d_nsectors); 162 } 163 } 164 165 /* 166 * Searches the iostatlist for the disk corresponding to the 167 * name provided. 168 */ 169 struct disk * 170 disk_find(const char *name) 171 { 172 struct io_stats *stat; 173 174 stat = iostat_find(name); 175 176 if ((stat != NULL) && (stat->io_type == IOSTAT_DISK)) 177 return stat->io_parent; 178 179 return (NULL); 180 } 181 182 void 183 disk_init(struct disk *diskp, const char *name, const struct dkdriver *driver) 184 { 185 u_int blocksize = DEV_BSIZE; 186 187 /* 188 * Initialize the wedge-related locks and other fields. 189 */ 190 mutex_init(&diskp->dk_rawlock, MUTEX_DEFAULT, IPL_NONE); 191 mutex_init(&diskp->dk_openlock, MUTEX_DEFAULT, IPL_NONE); 192 LIST_INIT(&diskp->dk_wedges); 193 diskp->dk_nwedges = 0; 194 diskp->dk_labelsector = LABELSECTOR; 195 diskp->dk_blkshift = DK_BSIZE2BLKSHIFT(blocksize); 196 diskp->dk_byteshift = DK_BSIZE2BYTESHIFT(blocksize); 197 diskp->dk_name = name; 198 diskp->dk_driver = driver; 199 } 200 201 /* 202 * Attach a disk. 203 */ 204 void 205 disk_attach(struct disk *diskp) 206 { 207 208 /* 209 * Allocate and initialize the disklabel structures. 210 */ 211 diskp->dk_label = kmem_zalloc(sizeof(struct disklabel), KM_SLEEP); 212 diskp->dk_cpulabel = kmem_zalloc(sizeof(struct cpu_disklabel), 213 KM_SLEEP); 214 if ((diskp->dk_label == NULL) || (diskp->dk_cpulabel == NULL)) 215 panic("disk_attach: can't allocate storage for disklabel"); 216 217 /* 218 * Set up the stats collection. 219 */ 220 diskp->dk_stats = iostat_alloc(IOSTAT_DISK, diskp, diskp->dk_name); 221 } 222 223 int 224 disk_begindetach(struct disk *dk, int (*lastclose)(device_t), 225 device_t self, int flags) 226 { 227 int rc; 228 229 rc = 0; 230 mutex_enter(&dk->dk_openlock); 231 if (dk->dk_openmask == 0) 232 ; /* nothing to do */ 233 else if ((flags & DETACH_FORCE) == 0) 234 rc = EBUSY; 235 else if (lastclose != NULL) 236 rc = (*lastclose)(self); 237 mutex_exit(&dk->dk_openlock); 238 239 return rc; 240 } 241 242 /* 243 * Detach a disk. 244 */ 245 void 246 disk_detach(struct disk *diskp) 247 { 248 249 /* 250 * Remove from the drivelist. 251 */ 252 iostat_free(diskp->dk_stats); 253 254 /* 255 * Release the disk-info dictionary. 256 */ 257 if (diskp->dk_info) { 258 prop_object_release(diskp->dk_info); 259 diskp->dk_info = NULL; 260 } 261 262 /* 263 * Free the space used by the disklabel structures. 264 */ 265 kmem_free(diskp->dk_label, sizeof(*diskp->dk_label)); 266 kmem_free(diskp->dk_cpulabel, sizeof(*diskp->dk_cpulabel)); 267 } 268 269 void 270 disk_destroy(struct disk *diskp) 271 { 272 273 mutex_destroy(&diskp->dk_openlock); 274 mutex_destroy(&diskp->dk_rawlock); 275 } 276 277 /* 278 * Mark the disk as busy for metrics collection. 279 */ 280 void 281 disk_busy(struct disk *diskp) 282 { 283 284 iostat_busy(diskp->dk_stats); 285 } 286 287 /* 288 * Finished disk operations, gather metrics. 289 */ 290 void 291 disk_unbusy(struct disk *diskp, long bcount, int read) 292 { 293 294 iostat_unbusy(diskp->dk_stats, bcount, read); 295 } 296 297 /* 298 * Return true if disk has an I/O operation in flight. 299 */ 300 bool 301 disk_isbusy(struct disk *diskp) 302 { 303 304 return iostat_isbusy(diskp->dk_stats); 305 } 306 307 /* 308 * Bounds checking against the media size, used for the raw partition. 309 * secsize, mediasize and b_blkno must all be the same units. 310 * Possibly this has to be DEV_BSIZE (512). 311 */ 312 int 313 bounds_check_with_mediasize(struct buf *bp, int secsize, uint64_t mediasize) 314 { 315 int64_t sz; 316 317 sz = howmany(bp->b_bcount, secsize); 318 319 if (bp->b_blkno + sz > mediasize) { 320 sz = mediasize - bp->b_blkno; 321 if (sz == 0) { 322 /* If exactly at end of disk, return EOF. */ 323 bp->b_resid = bp->b_bcount; 324 return 0; 325 } 326 if (sz < 0) { 327 /* If past end of disk, return EINVAL. */ 328 bp->b_error = EINVAL; 329 return 0; 330 } 331 /* Otherwise, truncate request. */ 332 bp->b_bcount = sz * secsize; 333 } 334 335 return 1; 336 } 337 338 /* 339 * Determine the size of the transfer, and make sure it is 340 * within the boundaries of the partition. Adjust transfer 341 * if needed, and signal errors or early completion. 342 */ 343 int 344 bounds_check_with_label(struct disk *dk, struct buf *bp, int wlabel) 345 { 346 struct disklabel *lp = dk->dk_label; 347 struct partition *p = lp->d_partitions + DISKPART(bp->b_dev); 348 uint64_t p_size, p_offset, labelsector; 349 int64_t sz; 350 351 /* Protect against division by zero. XXX: Should never happen?!?! */ 352 if (lp->d_secpercyl == 0) { 353 bp->b_error = EINVAL; 354 return -1; 355 } 356 357 p_size = (uint64_t)p->p_size << dk->dk_blkshift; 358 p_offset = (uint64_t)p->p_offset << dk->dk_blkshift; 359 #if RAW_PART == 3 360 labelsector = lp->d_partitions[2].p_offset; 361 #else 362 labelsector = lp->d_partitions[RAW_PART].p_offset; 363 #endif 364 labelsector = (labelsector + dk->dk_labelsector) << dk->dk_blkshift; 365 366 sz = howmany(bp->b_bcount, DEV_BSIZE); 367 if ((bp->b_blkno + sz) > p_size) { 368 sz = p_size - bp->b_blkno; 369 if (sz == 0) { 370 /* If exactly at end of disk, return EOF. */ 371 bp->b_resid = bp->b_bcount; 372 return 0; 373 } 374 if (sz < 0) { 375 /* If past end of disk, return EINVAL. */ 376 bp->b_error = EINVAL; 377 return -1; 378 } 379 /* Otherwise, truncate request. */ 380 bp->b_bcount = sz << DEV_BSHIFT; 381 } 382 383 /* Overwriting disk label? */ 384 if (bp->b_blkno + p_offset <= labelsector && 385 bp->b_blkno + p_offset + sz > labelsector && 386 (bp->b_flags & B_READ) == 0 && !wlabel) { 387 bp->b_error = EROFS; 388 return -1; 389 } 390 391 /* calculate cylinder for disksort to order transfers with */ 392 bp->b_cylinder = (bp->b_blkno + p->p_offset) / 393 (lp->d_secsize / DEV_BSIZE) / lp->d_secpercyl; 394 return 1; 395 } 396 397 int 398 disk_read_sectors(void (*strat)(struct buf *), const struct disklabel *lp, 399 struct buf *bp, unsigned int sector, int count) 400 { 401 bp->b_blkno = sector; 402 bp->b_bcount = count * lp->d_secsize; 403 bp->b_flags = (bp->b_flags & ~B_WRITE) | B_READ; 404 bp->b_oflags &= ~BO_DONE; 405 bp->b_cylinder = sector / lp->d_secpercyl; 406 (*strat)(bp); 407 return biowait(bp); 408 } 409 410 const char * 411 convertdisklabel(struct disklabel *lp, void (*strat)(struct buf *), 412 struct buf *bp, uint32_t secperunit) 413 { 414 struct partition rp, *altp, *p; 415 int geom_ok; 416 417 memset(&rp, 0, sizeof(rp)); 418 rp.p_size = secperunit; 419 rp.p_fstype = FS_UNUSED; 420 421 /* If we can seek to d_secperunit - 1, believe the disk geometry. */ 422 if (secperunit != 0 && 423 disk_read_sectors(strat, lp, bp, secperunit - 1, 1) == 0) 424 geom_ok = 1; 425 else 426 geom_ok = 0; 427 428 #if 0 429 printf("%s: secperunit (%" PRIu32 ") %s\n", __func__, 430 secperunit, geom_ok ? "ok" : "not ok"); 431 #endif 432 433 p = &lp->d_partitions[RAW_PART]; 434 if (RAW_PART == 'c' - 'a') 435 altp = &lp->d_partitions['d' - 'a']; 436 else 437 altp = &lp->d_partitions['c' - 'a']; 438 439 if (lp->d_npartitions > RAW_PART && p->p_offset == 0 && p->p_size != 0) 440 ; /* already a raw partition */ 441 else if (lp->d_npartitions > MAX('c', 'd') - 'a' && 442 altp->p_offset == 0 && altp->p_size != 0) { 443 /* alternate partition ('c' or 'd') is suitable for raw slot, 444 * swap with 'd' or 'c'. 445 */ 446 rp = *p; 447 *p = *altp; 448 *altp = rp; 449 } else if (lp->d_npartitions <= RAW_PART && 450 lp->d_npartitions > 'c' - 'a') { 451 /* No raw partition is present, but the alternate is present. 452 * Copy alternate to raw partition. 453 */ 454 lp->d_npartitions = RAW_PART + 1; 455 *p = *altp; 456 } else if (!geom_ok) 457 return "no raw partition and disk reports bad geometry"; 458 else if (lp->d_npartitions <= RAW_PART) { 459 memset(&lp->d_partitions[lp->d_npartitions], 0, 460 sizeof(struct partition) * (RAW_PART - lp->d_npartitions)); 461 *p = rp; 462 lp->d_npartitions = RAW_PART + 1; 463 } else if (lp->d_npartitions < MAXPARTITIONS) { 464 memmove(p + 1, p, 465 sizeof(struct partition) * (lp->d_npartitions - RAW_PART)); 466 *p = rp; 467 lp->d_npartitions++; 468 } else 469 return "no raw partition and partition table is full"; 470 return NULL; 471 } 472 473 /* 474 * disk_ioctl -- 475 * Generic disk ioctl handling. 476 */ 477 int 478 disk_ioctl(struct disk *dk, dev_t dev, u_long cmd, void *data, int flag, 479 struct lwp *l) 480 { 481 struct dkwedge_info *dkw; 482 struct partinfo *pt; 483 #ifdef __HAVE_OLD_DISKLABEL 484 struct disklabel newlabel; 485 #endif 486 487 switch (cmd) { 488 case DIOCGDISKINFO: 489 if (dk->dk_info == NULL) 490 return ENOTSUP; 491 return prop_dictionary_copyout_ioctl(data, cmd, dk->dk_info); 492 493 case DIOCGSECTORSIZE: 494 *(u_int *)data = dk->dk_geom.dg_secsize; 495 return 0; 496 497 case DIOCGMEDIASIZE: 498 *(off_t *)data = (off_t)dk->dk_geom.dg_secsize * 499 dk->dk_geom.dg_secperunit; 500 return 0; 501 default: 502 break; 503 } 504 505 if (dev == NODEV) 506 return EPASSTHROUGH; 507 508 /* The following should be moved to dk_ioctl */ 509 switch (cmd) { 510 case DIOCGDINFO: 511 memcpy(data, dk->dk_label, sizeof (*dk->dk_label)); 512 return 0; 513 514 #ifdef __HAVE_OLD_DISKLABEL 515 case ODIOCGDINFO: 516 memcpy(&newlabel, dk->dk_label, sizeof(newlabel)); 517 if (newlabel.d_npartitions > OLDMAXPARTITIONS) 518 return ENOTTY; 519 memcpy(data, &newlabel, sizeof(struct olddisklabel)); 520 return 0; 521 #endif 522 523 case DIOCGPART: 524 if (dk->dk_label == NULL) 525 return EBUSY; 526 pt = data; 527 pt->disklab = dk->dk_label; 528 pt->part = &dk->dk_label->d_partitions[DISKPART(dev)]; 529 return 0; 530 531 case DIOCAWEDGE: 532 if ((flag & FWRITE) == 0) 533 return EBADF; 534 535 dkw = data; 536 strlcpy(dkw->dkw_parent, dk->dk_name, sizeof(dkw->dkw_parent)); 537 return dkwedge_add(dkw); 538 539 case DIOCDWEDGE: 540 if ((flag & FWRITE) == 0) 541 return EBADF; 542 543 dkw = data; 544 strlcpy(dkw->dkw_parent, dk->dk_name, sizeof(dkw->dkw_parent)); 545 return dkwedge_del(dkw); 546 547 case DIOCLWEDGES: 548 return dkwedge_list(dk, data, l); 549 550 case DIOCMWEDGES: 551 if ((flag & FWRITE) == 0) 552 return EBADF; 553 554 dkwedge_discover(dk); 555 return 0; 556 557 default: 558 return EPASSTHROUGH; 559 } 560 } 561 562 void 563 disk_set_info(device_t dev, struct disk *dk, const char *type) 564 { 565 struct disk_geom *dg = &dk->dk_geom; 566 567 if (dg->dg_secperunit == 0 && dg->dg_ncylinders == 0) { 568 #ifdef DIAGNOSTIC 569 printf("%s: secperunit and ncylinders are zero\n", dk->dk_name); 570 #endif 571 return; 572 } 573 574 if (dg->dg_secperunit == 0) { 575 if (dg->dg_nsectors == 0 || dg->dg_ntracks == 0) { 576 #ifdef DIAGNOSTIC 577 printf("%s: secperunit and (sectors or tracks) " 578 "are zero\n", dk->dk_name); 579 #endif 580 return; 581 } 582 dg->dg_secperunit = (int64_t) dg->dg_nsectors * 583 dg->dg_ntracks * dg->dg_ncylinders; 584 } 585 586 if (dg->dg_ncylinders == 0) { 587 if (dg->dg_ntracks && dg->dg_nsectors) 588 dg->dg_ncylinders = dg->dg_secperunit / 589 (dg->dg_ntracks * dg->dg_nsectors); 590 } 591 592 if (dg->dg_secsize == 0) { 593 #ifdef DIAGNOSTIC 594 printf("%s: fixing 0 sector size\n", dk->dk_name); 595 #endif 596 dg->dg_secsize = DEV_BSIZE; 597 } 598 599 dk->dk_blkshift = DK_BSIZE2BLKSHIFT(dg->dg_secsize); 600 dk->dk_byteshift = DK_BSIZE2BYTESHIFT(dg->dg_secsize); 601 602 prop_dictionary_t disk_info, odisk_info, geom; 603 604 disk_info = prop_dictionary_create(); 605 geom = prop_dictionary_create(); 606 607 prop_dictionary_set_uint64(geom, "sectors-per-unit", 608 dg->dg_secperunit); 609 610 prop_dictionary_set_uint32(geom, "sector-size", dg->dg_secsize); 611 612 if (dg->dg_nsectors) 613 prop_dictionary_set_uint16(geom, "sectors-per-track", 614 dg->dg_nsectors); 615 616 if (dg->dg_ntracks) 617 prop_dictionary_set_uint16(geom, "tracks-per-cylinder", 618 dg->dg_ntracks); 619 620 if (dg->dg_ncylinders) 621 prop_dictionary_set_uint64(geom, "cylinders-per-unit", 622 dg->dg_ncylinders); 623 624 prop_dictionary_set(disk_info, "geometry", geom); 625 626 if (type) 627 prop_dictionary_set_cstring_nocopy(disk_info, "type", type); 628 629 prop_object_release(geom); 630 631 odisk_info = dk->dk_info; 632 dk->dk_info = disk_info; 633 634 if (dev) 635 prop_dictionary_set(device_properties(dev), "disk-info", 636 disk_info); 637 638 /* 639 * Don't release disk_info here; we keep a reference to it. 640 * disk_detach() will release it when we go away. 641 */ 642 if (odisk_info) 643 prop_object_release(odisk_info); 644 } 645