sys/kern/subr_disk.c

   1 /*
   2  * Copyright (c) 2003,2004,2009 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   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  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. 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  * 3. Neither the name of The DragonFly Project 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
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * ----------------------------------------------------------------------------
  35  * "THE BEER-WARE LICENSE" (Revision 42):
  36  * <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
  37  * can do whatever you want with this stuff. If we meet some day, and you think
  38  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
  39  * ----------------------------------------------------------------------------
  40  *
  41  * Copyright (c) 1982, 1986, 1988, 1993
  42  *      The Regents of the University of California.  All rights reserved.
  43  * (c) UNIX System Laboratories, Inc.
  44  * All or some portions of this file are derived from material licensed
  45  * to the University of California by American Telephone and Telegraph
  46  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  47  * the permission of UNIX System Laboratories, Inc.
  48  *
  49  * Redistribution and use in source and binary forms, with or without
  50  * modification, are permitted provided that the following conditions
  51  * are met:
  52  * 1. Redistributions of source code must retain the above copyright
  53  *    notice, this list of conditions and the following disclaimer.
  54  * 2. Redistributions in binary form must reproduce the above copyright
  55  *    notice, this list of conditions and the following disclaimer in the
  56  *    documentation and/or other materials provided with the distribution.
  57  * 3. All advertising materials mentioning features or use of this software
  58  *    must display the following acknowledgement:
  59  *      This product includes software developed by the University of
  60  *      California, Berkeley and its contributors.
  61  * 4. Neither the name of the University nor the names of its contributors
  62  *    may be used to endorse or promote products derived from this software
  63  *    without specific prior written permission.
  64  *
  65  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  66  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  67  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  68  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  69  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  70  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  71  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  72  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  73  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  74  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  75  * SUCH DAMAGE.
  76  *
  77  *      @(#)ufs_disksubr.c      8.5 (Berkeley) 1/21/94
  78  * $FreeBSD: src/sys/kern/subr_disk.c,v 1.20.2.6 2001/10/05 07:14:57 peter Exp $
  79  * $FreeBSD: src/sys/ufs/ufs/ufs_disksubr.c,v 1.44.2.3 2001/03/05 05:42:19 obrien Exp $
  80  * $DragonFly: src/sys/kern/subr_disk.c,v 1.40 2008/06/05 18:06:32 swildner Exp $
  81  */
  82
  83 #include <sys/param.h>
  84 #include <sys/systm.h>
  85 #include <sys/kernel.h>
  86 #include <sys/proc.h>
  87 #include <sys/sysctl.h>
  88 #include <sys/buf.h>
  89 #include <sys/conf.h>
  90 #include <sys/disklabel.h>
  91 #include <sys/disklabel32.h>
  92 #include <sys/disklabel64.h>
  93 #include <sys/diskslice.h>
  94 #include <sys/diskmbr.h>
  95 #include <sys/disk.h>
  96 #include <sys/kerneldump.h>
  97 #include <sys/malloc.h>
  98 #include <sys/sysctl.h>
  99 #include <machine/md_var.h>
 100 #include <sys/ctype.h>
 101 #include <sys/syslog.h>
 102 #include <sys/device.h>
 103 #include <sys/msgport.h>
 104 #include <sys/msgport2.h>
 105 #include <sys/buf2.h>
 106 #include <sys/devfs.h>
 107 #include <sys/thread.h>
 108 #include <sys/thread2.h>
 109
 110 #include <sys/queue.h>
 111 #include <sys/lock.h>
 112
 113 static MALLOC_DEFINE(M_DISK, "disk", "disk data");
 114 static int disk_debug_enable = 0;
 115
 116 static void disk_msg_autofree_reply(lwkt_port_t, lwkt_msg_t);
 117 static void disk_msg_core(void *);
 118 static int disk_probe_slice(struct disk *dp, cdev_t dev, int slice, int reprobe);
 119 static void disk_probe(struct disk *dp, int reprobe);
 120 static void _setdiskinfo(struct disk *disk, struct disk_info *info);
 121 static void bioqwritereorder(struct bio_queue_head *bioq);
 122 static void disk_cleanserial(char *serno);
 123
 124 static d_open_t diskopen;
 125 static d_close_t diskclose;
 126 static d_ioctl_t diskioctl;
 127 static d_strategy_t diskstrategy;
 128 static d_psize_t diskpsize;
 129 static d_clone_t diskclone;
 130 static d_dump_t diskdump;
 131
 132 static LIST_HEAD(, disk) disklist = LIST_HEAD_INITIALIZER(&disklist);
 133 static struct lwkt_token disklist_token;
 134
 135 static struct dev_ops disk_ops = {
 136         { "disk", 0, D_DISK },
 137         .d_open = diskopen,
 138         .d_close = diskclose,
 139         .d_read = physread,
 140         .d_write = physwrite,
 141         .d_ioctl = diskioctl,
 142         .d_strategy = diskstrategy,
 143         .d_dump = diskdump,
 144         .d_psize = diskpsize,
 145         .d_clone = diskclone
 146 };
 147
 148 static struct objcache  *disk_msg_cache;
 149
 150 struct objcache_malloc_args disk_msg_malloc_args = {
 151         sizeof(struct disk_msg), M_DISK };
 152
 153 static struct lwkt_port disk_dispose_port;
 154 static struct lwkt_port disk_msg_port;
 155
 156 static int
 157 disk_debug(int level, char *fmt, ...)
 158 {
 159         __va_list ap;
 160
 161         __va_start(ap, fmt);
 162         if (level <= disk_debug_enable)
 163                 kvprintf(fmt, ap);
 164         __va_end(ap);
 165
 166         return 0;
 167 }
 168
 169 static int
 170 disk_probe_slice(struct disk *dp, cdev_t dev, int slice, int reprobe)
 171 {
 172         struct disk_info *info = &dp->d_info;
 173         struct diskslice *sp = &dp->d_slice->dss_slices[slice];
 174         disklabel_ops_t ops;
 175         struct partinfo part;
 176         const char *msg;
 177         cdev_t ndev;
 178         int sno;
 179         u_int i;
 180
 181         disk_debug(2,
 182                     "disk_probe_slice (begin): %s (%s)\n",
 183                         dev->si_name, dp->d_cdev->si_name);
 184
 185         sno = slice ? slice - 1 : 0;
 186
 187         ops = &disklabel32_ops;
 188         msg = ops->op_readdisklabel(dev, sp, &sp->ds_label, info);
 189         if (msg && !strcmp(msg, "no disk label")) {
 190                 ops = &disklabel64_ops;
 191                 msg = ops->op_readdisklabel(dev, sp, &sp->ds_label, info);
 192         }
 193         if (msg == NULL) {
 194                 if (slice != WHOLE_DISK_SLICE)
 195                         ops->op_adjust_label_reserved(dp->d_slice, slice, sp);
 196                 else
 197                         sp->ds_reserved = 0;
 198
 199                 sp->ds_ops = ops;
 200                 for (i = 0; i < ops->op_getnumparts(sp->ds_label); i++) {
 201                         ops->op_loadpartinfo(sp->ds_label, i, &part);
 202                         if (part.fstype) {
 203                                 if (reprobe &&
 204                                     (ndev = devfs_find_device_by_name("%s%c",
 205                                                 dev->si_name, 'a' + i))
 206                                 ) {
 207                                         /*
 208                                          * Device already exists and
 209                                          * is still valid.
 210                                          */
 211                                         ndev->si_flags |= SI_REPROBE_TEST;
 212                                 } else {
 213                                         ndev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
 214                                                 dkmakeminor(dkunit(dp->d_cdev),
 215                                                             slice, i),
 216                                                 UID_ROOT, GID_OPERATOR, 0640,
 217                                                 "%s%c", dev->si_name, 'a'+ i);
 218                                         ndev->si_disk = dp;
 219                                         if (dp->d_info.d_serialno) {
 220                                                 make_dev_alias(ndev,
 221                                                     "serno/%s.s%d%c",
 222                                                     dp->d_info.d_serialno,
 223                                                     sno, 'a' + i);
 224                                         }
 225                                         ndev->si_flags |= SI_REPROBE_TEST;
 226                                 }
 227                         }
 228                 }
 229         } else if (info->d_dsflags & DSO_COMPATLABEL) {
 230                 msg = NULL;
 231                 if (sp->ds_size >= 0x100000000ULL)
 232                         ops = &disklabel64_ops;
 233                 else
 234                         ops = &disklabel32_ops;
 235                 sp->ds_label = ops->op_clone_label(info, sp);
 236         } else {
 237                 if (sp->ds_type == DOSPTYP_386BSD || /* XXX */
 238                     sp->ds_type == DOSPTYP_NETBSD ||
 239                     sp->ds_type == DOSPTYP_OPENBSD) {
 240                         log(LOG_WARNING, "%s: cannot find label (%s)\n",
 241                             dev->si_name, msg);
 242                 }
 243         }
 244
 245         if (msg == NULL) {
 246                 sp->ds_wlabel = FALSE;
 247         }
 248
 249         return (msg ? EINVAL : 0);
 250 }
 251
 252
 253 static void
 254 disk_probe(struct disk *dp, int reprobe)
 255 {
 256         struct disk_info *info = &dp->d_info;
 257         cdev_t dev = dp->d_cdev;
 258         cdev_t ndev;
 259         int error, i, sno;
 260         struct diskslice *sp;
 261
 262         KKASSERT (info->d_media_blksize != 0);
 263
 264         dp->d_slice = dsmakeslicestruct(BASE_SLICE, info);
 265         disk_debug(1,
 266                     "disk_probe (begin): %s\n",
 267                         dp->d_cdev->si_name);
 268
 269         error = mbrinit(dev, info, &(dp->d_slice));
 270         if (error)
 271                 return;
 272
 273         for (i = 0; i < dp->d_slice->dss_nslices; i++) {
 274                 /*
 275                  * Ignore the whole-disk slice, it has already been created.
 276                  */
 277                 if (i == WHOLE_DISK_SLICE)
 278                         continue;
 279                 sp = &dp->d_slice->dss_slices[i];
 280
 281                 /*
 282                  * Handle s0.  s0 is a compatibility slice if there are no
 283                  * other slices and it has not otherwise been set up, else
 284                  * we ignore it.
 285                  */
 286                 if (i == COMPATIBILITY_SLICE) {
 287                         sno = 0;
 288                         if (sp->ds_type == 0 &&
 289                             dp->d_slice->dss_nslices == BASE_SLICE) {
 290                                 sp->ds_size = info->d_media_blocks;
 291                                 sp->ds_reserved = 0;
 292                         }
 293                 } else {
 294                         sno = i - 1;
 295                         sp->ds_reserved = 0;
 296                 }
 297
 298                 /*
 299                  * Ignore 0-length slices
 300                  */
 301                 if (sp->ds_size == 0)
 302                         continue;
 303
 304                 if (reprobe &&
 305                     (ndev = devfs_find_device_by_name("%ss%d",
 306                                                       dev->si_name, sno))) {
 307                         /*
 308                          * Device already exists and is still valid
 309                          */
 310                         ndev->si_flags |= SI_REPROBE_TEST;
 311                 } else {
 312                         /*
 313                          * Else create new device
 314                          */
 315                         ndev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
 316                                         dkmakewholeslice(dkunit(dev), i),
 317                                         UID_ROOT, GID_OPERATOR, 0640,
 318                                         "%ss%d", dev->si_name, sno);
 319                         if (dp->d_info.d_serialno) {
 320                                 make_dev_alias(ndev, "serno/%s.s%d",
 321                                                dp->d_info.d_serialno, sno);
 322                         }
 323                         ndev->si_disk = dp;
 324                         ndev->si_flags |= SI_REPROBE_TEST;
 325                 }
 326                 sp->ds_dev = ndev;
 327
 328                 /*
 329                  * Probe appropriate slices for a disklabel
 330                  *
 331                  * XXX slice type 1 used by our gpt probe code.
 332                  * XXX slice type 0 used by mbr compat slice.
 333                  */
 334                 if (sp->ds_type == DOSPTYP_386BSD ||
 335                     sp->ds_type == DOSPTYP_NETBSD ||
 336                     sp->ds_type == DOSPTYP_OPENBSD ||
 337                     sp->ds_type == 0 ||
 338                     sp->ds_type == 1) {
 339                         if (dp->d_slice->dss_first_bsd_slice == 0)
 340                                 dp->d_slice->dss_first_bsd_slice = i;
 341                         disk_probe_slice(dp, ndev, i, reprobe);
 342                 }
 343         }
 344         disk_debug(1,
 345                     "disk_probe (end): %s\n",
 346                         dp->d_cdev->si_name);
 347 }
 348
 349
 350 static void
 351 disk_msg_core(void *arg)
 352 {
 353         struct disk     *dp;
 354         struct diskslice *sp;
 355         lwkt_tokref ilock;
 356         disk_msg_t msg;
 357         int run;
 358
 359         lwkt_initport_thread(&disk_msg_port, curthread);
 360         wakeup(curthread);
 361         run = 1;
 362
 363         while (run) {
 364                 msg = (disk_msg_t)lwkt_waitport(&disk_msg_port, 0);
 365
 366                 switch (msg->hdr.u.ms_result) {
 367                 case DISK_DISK_PROBE:
 368                         dp = (struct disk *)msg->load;
 369                         disk_debug(1,
 370                                     "DISK_DISK_PROBE: %s\n",
 371                                         dp->d_cdev->si_name);
 372                         disk_probe(dp, 0);
 373                         break;
 374                 case DISK_DISK_DESTROY:
 375                         dp = (struct disk *)msg->load;
 376                         disk_debug(1,
 377                                     "DISK_DISK_DESTROY: %s\n",
 378                                         dp->d_cdev->si_name);
 379                         devfs_destroy_subnames(dp->d_cdev->si_name);
 380                         devfs_destroy_dev(dp->d_cdev);
 381                         lwkt_gettoken(&ilock, &disklist_token);
 382                         LIST_REMOVE(dp, d_list);
 383                         lwkt_reltoken(&ilock);
 384                         if (dp->d_info.d_serialno) {
 385                                 kfree(dp->d_info.d_serialno, M_TEMP);
 386                                 dp->d_info.d_serialno = NULL;
 387                         }
 388                         break;
 389                 case DISK_UNPROBE:
 390                         dp = (struct disk *)msg->load;
 391                         disk_debug(1,
 392                                     "DISK_DISK_UNPROBE: %s\n",
 393                                         dp->d_cdev->si_name);
 394                         devfs_destroy_subnames(dp->d_cdev->si_name);
 395                         break;
 396                 case DISK_SLICE_REPROBE:
 397                         dp = (struct disk *)msg->load;
 398                         sp = (struct diskslice *)msg->load2;
 399                         devfs_clr_subnames_flag(sp->ds_dev->si_name,
 400                                                 SI_REPROBE_TEST);
 401                         disk_debug(1,
 402                                     "DISK_SLICE_REPROBE: %s\n",
 403                                     sp->ds_dev->si_name);
 404                         disk_probe_slice(dp, sp->ds_dev,
 405                                          dkslice(sp->ds_dev), 1);
 406                         devfs_destroy_subnames_without_flag(
 407                                         sp->ds_dev->si_name, SI_REPROBE_TEST);
 408                         break;
 409                 case DISK_DISK_REPROBE:
 410                         dp = (struct disk *)msg->load;
 411                         devfs_clr_subnames_flag(dp->d_cdev->si_name, SI_REPROBE_TEST);
 412                         disk_debug(1,
 413                                     "DISK_DISK_REPROBE: %s\n",
 414                                     dp->d_cdev->si_name);
 415                         disk_probe(dp, 1);
 416                         devfs_destroy_subnames_without_flag(
 417                                         dp->d_cdev->si_name, SI_REPROBE_TEST);
 418                         break;
 419                 case DISK_SYNC:
 420                         disk_debug(1, "DISK_SYNC\n");
 421                         break;
 422                 default:
 423                         devfs_debug(DEVFS_DEBUG_WARNING,
 424                                     "disk_msg_core: unknown message "
 425                                     "received at core\n");
 426                         break;
 427                 }
 428                 lwkt_replymsg(&msg->hdr, 0);
 429         }
 430         lwkt_exit();
 431 }
 432
 433
 434 /*
 435  * Acts as a message drain. Any message that is replied to here gets
 436  * destroyed and the memory freed.
 437  */
 438 static void
 439 disk_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
 440 {
 441         objcache_put(disk_msg_cache, msg);
 442 }
 443
 444
 445 void
 446 disk_msg_send(uint32_t cmd, void *load, void *load2)
 447 {
 448         disk_msg_t disk_msg;
 449         lwkt_port_t port = &disk_msg_port;
 450
 451         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
 452
 453         lwkt_initmsg(&disk_msg->hdr, &disk_dispose_port, 0);
 454
 455         disk_msg->hdr.u.ms_result = cmd;
 456         disk_msg->load = load;
 457         disk_msg->load2 = load2;
 458         KKASSERT(port);
 459         lwkt_sendmsg(port, &disk_msg->hdr);
 460 }
 461
 462 void
 463 disk_msg_send_sync(uint32_t cmd, void *load, void *load2)
 464 {
 465         struct lwkt_port rep_port;
 466         disk_msg_t disk_msg;
 467         lwkt_port_t port;
 468
 469         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
 470         port = &disk_msg_port;
 471
 472         /* XXX could probably use curthread's built-in msgport */
 473         lwkt_initport_thread(&rep_port, curthread);
 474         lwkt_initmsg(&disk_msg->hdr, &rep_port, 0);
 475
 476         disk_msg->hdr.u.ms_result = cmd;
 477         disk_msg->load = load;
 478         disk_msg->load2 = load2;
 479
 480         lwkt_sendmsg(port, &disk_msg->hdr);
 481         lwkt_waitmsg(&disk_msg->hdr, 0);
 482         objcache_put(disk_msg_cache, disk_msg);
 483 }
 484
 485 /*
 486  * Create a raw device for the dev_ops template (which is returned).  Also
 487  * create a slice and unit managed disk and overload the user visible
 488  * device space with it.
 489  *
 490  * NOTE: The returned raw device is NOT a slice and unit managed device.
 491  * It is an actual raw device representing the raw disk as specified by
 492  * the passed dev_ops.  The disk layer not only returns such a raw device,
 493  * it also uses it internally when passing (modified) commands through.
 494  */
 495 cdev_t
 496 disk_create(int unit, struct disk *dp, struct dev_ops *raw_ops)
 497 {
 498         lwkt_tokref ilock;
 499         cdev_t rawdev;
 500
 501         disk_debug(1,
 502                     "disk_create (begin): %s%d\n",
 503                         raw_ops->head.name, unit);
 504
 505         rawdev = make_only_dev(raw_ops, dkmakewholedisk(unit),
 506                             UID_ROOT, GID_OPERATOR, 0640,
 507                             "%s%d", raw_ops->head.name, unit);
 508
 509         bzero(dp, sizeof(*dp));
 510
 511         dp->d_rawdev = rawdev;
 512         dp->d_raw_ops = raw_ops;
 513         dp->d_dev_ops = &disk_ops;
 514         dp->d_cdev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
 515                             dkmakewholedisk(unit),
 516                             UID_ROOT, GID_OPERATOR, 0640,
 517                             "%s%d", raw_ops->head.name, unit);
 518
 519         dp->d_cdev->si_disk = dp;
 520
 521         lwkt_gettoken(&ilock, &disklist_token);
 522         LIST_INSERT_HEAD(&disklist, dp, d_list);
 523         lwkt_reltoken(&ilock);
 524
 525         disk_debug(1,
 526                     "disk_create (end): %s%d\n",
 527                         raw_ops->head.name, unit);
 528
 529         return (dp->d_rawdev);
 530 }
 531
 532
 533 static void
 534 _setdiskinfo(struct disk *disk, struct disk_info *info)
 535 {
 536         char *oldserialno;
 537
 538         oldserialno = disk->d_info.d_serialno;
 539         bcopy(info, &disk->d_info, sizeof(disk->d_info));
 540         info = &disk->d_info;
 541
 542         disk_debug(1,
 543                     "_setdiskinfo: %s\n",
 544                         disk->d_cdev->si_name);
 545
 546         /*
 547          * The serial number is duplicated so the caller can throw
 548          * their copy away.
 549          */
 550         if (info->d_serialno && info->d_serialno[0]) {
 551                 info->d_serialno = kstrdup(info->d_serialno, M_TEMP);
 552                 disk_cleanserial(info->d_serialno);
 553                 if (disk->d_cdev) {
 554                         make_dev_alias(disk->d_cdev, "serno/%s",
 555                                         info->d_serialno);
 556                 }
 557         } else {
 558                 info->d_serialno = NULL;
 559         }
 560         if (oldserialno)
 561                 kfree(oldserialno, M_TEMP);
 562
 563         /*
 564          * The caller may set d_media_size or d_media_blocks and we
 565          * calculate the other.
 566          */
 567         KKASSERT(info->d_media_size == 0 || info->d_media_blksize == 0);
 568         if (info->d_media_size == 0 && info->d_media_blocks) {
 569                 info->d_media_size = (u_int64_t)info->d_media_blocks *
 570                                      info->d_media_blksize;
 571         } else if (info->d_media_size && info->d_media_blocks == 0 &&
 572                    info->d_media_blksize) {
 573                 info->d_media_blocks = info->d_media_size /
 574                                        info->d_media_blksize;
 575         }
 576
 577         /*
 578          * The si_* fields for rawdev are not set until after the
 579          * disk_create() call, so someone using the cooked version
 580          * of the raw device (i.e. da0s0) will not get the right
 581          * si_iosize_max unless we fix it up here.
 582          */
 583         if (disk->d_cdev && disk->d_rawdev &&
 584             disk->d_cdev->si_iosize_max == 0) {
 585                 disk->d_cdev->si_iosize_max = disk->d_rawdev->si_iosize_max;
 586                 disk->d_cdev->si_bsize_phys = disk->d_rawdev->si_bsize_phys;
 587                 disk->d_cdev->si_bsize_best = disk->d_rawdev->si_bsize_best;
 588         }
 589 }
 590
 591 /*
 592  * Disk drivers must call this routine when media parameters are available
 593  * or have changed.
 594  */
 595 void
 596 disk_setdiskinfo(struct disk *disk, struct disk_info *info)
 597 {
 598         _setdiskinfo(disk, info);
 599         disk_msg_send(DISK_DISK_PROBE, disk, NULL);
 600         disk_debug(1,
 601                     "disk_setdiskinfo: sent probe for %s\n",
 602                         disk->d_cdev->si_name);
 603 }
 604
 605 void
 606 disk_setdiskinfo_sync(struct disk *disk, struct disk_info *info)
 607 {
 608         _setdiskinfo(disk, info);
 609         disk_msg_send_sync(DISK_DISK_PROBE, disk, NULL);
 610         disk_debug(1,
 611                     "disk_setdiskinfo_sync: sent probe for %s\n",
 612                         disk->d_cdev->si_name);
 613 }
 614
 615 /*
 616  * This routine is called when an adapter detaches.  The higher level
 617  * managed disk device is destroyed while the lower level raw device is
 618  * released.
 619  */
 620 void
 621 disk_destroy(struct disk *disk)
 622 {
 623         disk_msg_send_sync(DISK_DISK_DESTROY, disk, NULL);
 624         return;
 625 }
 626
 627 int
 628 disk_dumpcheck(cdev_t dev, u_int64_t *size, u_int64_t *blkno, u_int32_t *secsize)
 629 {
 630         struct partinfo pinfo;
 631         int error;
 632
 633         bzero(&pinfo, sizeof(pinfo));
 634         error = dev_dioctl(dev, DIOCGPART, (void *)&pinfo, 0,
 635                            proc0.p_ucred, NULL);
 636         if (error)
 637                 return (error);
 638
 639         if (pinfo.media_blksize == 0)
 640                 return (ENXIO);
 641
 642         if (blkno) /* XXX: make sure this reserved stuff is right */
 643                 *blkno = pinfo.reserved_blocks +
 644                         pinfo.media_offset / pinfo.media_blksize;
 645         if (secsize)
 646                 *secsize = pinfo.media_blksize;
 647         if (size)
 648                 *size = (pinfo.media_blocks - pinfo.reserved_blocks);
 649
 650         return (0);
 651 }
 652
 653 int
 654 disk_dumpconf(cdev_t dev, u_int onoff)
 655 {
 656         struct dumperinfo di;
 657         u_int64_t       size, blkno;
 658         u_int32_t       secsize;
 659         int error;
 660
 661         if (!onoff)
 662                 return set_dumper(NULL);
 663
 664         error = disk_dumpcheck(dev, &size, &blkno, &secsize);
 665
 666         if (error)
 667                 return ENXIO;
 668
 669         bzero(&di, sizeof(struct dumperinfo));
 670         di.dumper = diskdump;
 671         di.priv = dev;
 672         di.blocksize = secsize;
 673         di.mediaoffset = blkno * DEV_BSIZE;
 674         di.mediasize = size * DEV_BSIZE;
 675
 676         return set_dumper(&di);
 677 }
 678
 679 void
 680 disk_unprobe(struct disk *disk)
 681 {
 682         if (disk == NULL)
 683                 return;
 684
 685         disk_msg_send_sync(DISK_UNPROBE, disk, NULL);
 686 }
 687
 688 void
 689 disk_invalidate (struct disk *disk)
 690 {
 691         if (disk->d_slice)
 692                 dsgone(&disk->d_slice);
 693 }
 694
 695 struct disk *
 696 disk_enumerate(struct disk *disk)
 697 {
 698         struct disk *dp;
 699         lwkt_tokref ilock;
 700
 701         lwkt_gettoken(&ilock, &disklist_token);
 702         if (!disk)
 703                 dp = (LIST_FIRST(&disklist));
 704         else
 705                 dp = (LIST_NEXT(disk, d_list));
 706         lwkt_reltoken(&ilock);
 707
 708         return dp;
 709 }
 710
 711 static
 712 int
 713 sysctl_disks(SYSCTL_HANDLER_ARGS)
 714 {
 715         struct disk *disk;
 716         int error, first;
 717
 718         disk = NULL;
 719         first = 1;
 720
 721         while ((disk = disk_enumerate(disk))) {
 722                 if (!first) {
 723                         error = SYSCTL_OUT(req, " ", 1);
 724                         if (error)
 725                                 return error;
 726                 } else {
 727                         first = 0;
 728                 }
 729                 error = SYSCTL_OUT(req, disk->d_rawdev->si_name,
 730                                    strlen(disk->d_rawdev->si_name));
 731                 if (error)
 732                         return error;
 733         }
 734         error = SYSCTL_OUT(req, "", 1);
 735         return error;
 736 }
 737
 738 SYSCTL_PROC(_kern, OID_AUTO, disks, CTLTYPE_STRING | CTLFLAG_RD, NULL, 0,
 739     sysctl_disks, "A", "names of available disks");
 740
 741 /*
 742  * Open a disk device or partition.
 743  */
 744 static
 745 int
 746 diskopen(struct dev_open_args *ap)
 747 {
 748         cdev_t dev = ap->a_head.a_dev;
 749         struct disk *dp;
 750         int error;
 751
 752         /*
 753          * dp can't be NULL here XXX.
 754          *
 755          * d_slice will be NULL if setdiskinfo() has not been called yet.
 756          * setdiskinfo() is typically called whether the disk is present
 757          * or not (e.g. CD), but the base disk device is created first
 758          * and there may be a race.
 759          */
 760         dp = dev->si_disk;
 761         if (dp == NULL || dp->d_slice == NULL)
 762                 return (ENXIO);
 763         error = 0;
 764
 765         /*
 766          * Deal with open races
 767          */
 768         while (dp->d_flags & DISKFLAG_LOCK) {
 769                 dp->d_flags |= DISKFLAG_WANTED;
 770                 error = tsleep(dp, PCATCH, "diskopen", hz);
 771                 if (error)
 772                         return (error);
 773         }
 774         dp->d_flags |= DISKFLAG_LOCK;
 775
 776         /*
 777          * Open the underlying raw device.
 778          */
 779         if (!dsisopen(dp->d_slice)) {
 780 #if 0
 781                 if (!pdev->si_iosize_max)
 782                         pdev->si_iosize_max = dev->si_iosize_max;
 783 #endif
 784                 error = dev_dopen(dp->d_rawdev, ap->a_oflags,
 785                                   ap->a_devtype, ap->a_cred);
 786         }
 787 #if 0
 788         /*
 789          * Inherit properties from the underlying device now that it is
 790          * open.
 791          */
 792         dev_dclone(dev);
 793 #endif
 794
 795         if (error)
 796                 goto out;
 797         error = dsopen(dev, ap->a_devtype, dp->d_info.d_dsflags,
 798                        &dp->d_slice, &dp->d_info);
 799         if (!dsisopen(dp->d_slice)) {
 800                 dev_dclose(dp->d_rawdev, ap->a_oflags, ap->a_devtype);
 801         }
 802 out:
 803         dp->d_flags &= ~DISKFLAG_LOCK;
 804         if (dp->d_flags & DISKFLAG_WANTED) {
 805                 dp->d_flags &= ~DISKFLAG_WANTED;
 806                 wakeup(dp);
 807         }
 808
 809         return(error);
 810 }
 811
 812 /*
 813  * Close a disk device or partition
 814  */
 815 static
 816 int
 817 diskclose(struct dev_close_args *ap)
 818 {
 819         cdev_t dev = ap->a_head.a_dev;
 820         struct disk *dp;
 821         int error;
 822
 823         error = 0;
 824         dp = dev->si_disk;
 825
 826         dsclose(dev, ap->a_devtype, dp->d_slice);
 827         if (!dsisopen(dp->d_slice)) {
 828                 error = dev_dclose(dp->d_rawdev, ap->a_fflag, ap->a_devtype);
 829         }
 830         return (error);
 831 }
 832
 833 /*
 834  * First execute the ioctl on the disk device, and if it isn't supported
 835  * try running it on the backing device.
 836  */
 837 static
 838 int
 839 diskioctl(struct dev_ioctl_args *ap)
 840 {
 841         cdev_t dev = ap->a_head.a_dev;
 842         struct disk *dp;
 843         int error;
 844         u_int u;
 845
 846         dp = dev->si_disk;
 847         if (dp == NULL)
 848                 return (ENXIO);
 849
 850         devfs_debug(DEVFS_DEBUG_DEBUG,
 851                     "diskioctl: cmd is: %x (name: %s)\n",
 852                     ap->a_cmd, dev->si_name);
 853         devfs_debug(DEVFS_DEBUG_DEBUG,
 854                     "diskioctl: &dp->d_slice is: %x, %x\n",
 855                     &dp->d_slice, dp->d_slice);
 856
 857         if (ap->a_cmd == DIOCGKERNELDUMP) {
 858                 u = *(u_int *)ap->a_data;
 859                 return disk_dumpconf(dev, u);
 860         }
 861
 862         error = dsioctl(dev, ap->a_cmd, ap->a_data, ap->a_fflag,
 863                         &dp->d_slice, &dp->d_info);
 864
 865         if (error == ENOIOCTL) {
 866                 error = dev_dioctl(dp->d_rawdev, ap->a_cmd, ap->a_data,
 867                                    ap->a_fflag, ap->a_cred, NULL);
 868         }
 869         return (error);
 870 }
 871
 872 /*
 873  * Execute strategy routine
 874  */
 875 static
 876 int
 877 diskstrategy(struct dev_strategy_args *ap)
 878 {
 879         cdev_t dev = ap->a_head.a_dev;
 880         struct bio *bio = ap->a_bio;
 881         struct bio *nbio;
 882         struct disk *dp;
 883
 884         dp = dev->si_disk;
 885
 886         if (dp == NULL) {
 887                 bio->bio_buf->b_error = ENXIO;
 888                 bio->bio_buf->b_flags |= B_ERROR;
 889                 biodone(bio);
 890                 return(0);
 891         }
 892         KKASSERT(dev->si_disk == dp);
 893
 894         /*
 895          * The dscheck() function will also transform the slice relative
 896          * block number i.e. bio->bio_offset into a block number that can be
 897          * passed directly to the underlying raw device.  If dscheck()
 898          * returns NULL it will have handled the bio for us (e.g. EOF
 899          * or error due to being beyond the device size).
 900          */
 901         if ((nbio = dscheck(dev, bio, dp->d_slice)) != NULL) {
 902                 dev_dstrategy(dp->d_rawdev, nbio);
 903         } else {
 904                 biodone(bio);
 905         }
 906         return(0);
 907 }
 908
 909 /*
 910  * Return the partition size in ?blocks?
 911  */
 912 static
 913 int
 914 diskpsize(struct dev_psize_args *ap)
 915 {
 916         cdev_t dev = ap->a_head.a_dev;
 917         struct disk *dp;
 918
 919         dp = dev->si_disk;
 920         if (dp == NULL)
 921                 return(ENODEV);
 922         ap->a_result = dssize(dev, &dp->d_slice);
 923         return(0);
 924 }
 925
 926 /*
 927  * When new device entries are instantiated, make sure they inherit our
 928  * si_disk structure and block and iosize limits from the raw device.
 929  *
 930  * This routine is always called synchronously in the context of the
 931  * client.
 932  *
 933  * XXX The various io and block size constraints are not always initialized
 934  * properly by devices.
 935  */
 936 static
 937 int
 938 diskclone(struct dev_clone_args *ap)
 939 {
 940         cdev_t dev = ap->a_head.a_dev;
 941         struct disk *dp;
 942         dp = dev->si_disk;
 943
 944         KKASSERT(dp != NULL);
 945         dev->si_disk = dp;
 946         dev->si_iosize_max = dp->d_rawdev->si_iosize_max;
 947         dev->si_bsize_phys = dp->d_rawdev->si_bsize_phys;
 948         dev->si_bsize_best = dp->d_rawdev->si_bsize_best;
 949         return(0);
 950 }
 951
 952 int
 953 diskdump(struct dev_dump_args *ap)
 954 {
 955         cdev_t dev = ap->a_head.a_dev;
 956         struct disk *dp = dev->si_disk;
 957         u_int64_t size, offset;
 958         int error;
 959
 960         error = disk_dumpcheck(dev, &size, &ap->a_blkno, &ap->a_secsize);
 961         /* XXX: this should probably go in disk_dumpcheck somehow */
 962         if (ap->a_length != 0) {
 963                 size *= DEV_BSIZE;
 964                 offset = ap->a_blkno * DEV_BSIZE;
 965                 if ((ap->a_offset < offset) ||
 966                     (ap->a_offset + ap->a_length - offset > size)) {
 967                         kprintf("Attempt to write outside dump device boundaries.\n");
 968                         error = ENOSPC;
 969                 }
 970         }
 971
 972         if (error == 0) {
 973                 ap->a_head.a_dev = dp->d_rawdev;
 974                 error = dev_doperate(&ap->a_head);
 975         }
 976
 977         return(error);
 978 }
 979
 980
 981 SYSCTL_INT(_debug_sizeof, OID_AUTO, diskslices, CTLFLAG_RD,
 982     0, sizeof(struct diskslices), "sizeof(struct diskslices)");
 983
 984 SYSCTL_INT(_debug_sizeof, OID_AUTO, disk, CTLFLAG_RD,
 985     0, sizeof(struct disk), "sizeof(struct disk)");
 986
 987 /*
 988  * Reorder interval for burst write allowance and minor write
 989  * allowance.
 990  *
 991  * We always want to trickle some writes in to make use of the
 992  * disk's zone cache.  Bursting occurs on a longer interval and only
 993  * runningbufspace is well over the hirunningspace limit.
 994  */
 995 int bioq_reorder_burst_interval = 60;   /* should be multiple of minor */
 996 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_interval,
 997            CTLFLAG_RW, &bioq_reorder_burst_interval, 0, "");
 998 int bioq_reorder_minor_interval = 5;
 999 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_interval,
1000            CTLFLAG_RW, &bioq_reorder_minor_interval, 0, "");
1001
1002 int bioq_reorder_burst_bytes = 3000000;
1003 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_bytes,
1004            CTLFLAG_RW, &bioq_reorder_burst_bytes, 0, "");
1005 int bioq_reorder_minor_bytes = 262144;
1006 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_bytes,
1007            CTLFLAG_RW, &bioq_reorder_minor_bytes, 0, "");
1008
1009
1010 /*
1011  * Order I/Os.  Generally speaking this code is designed to make better
1012  * use of drive zone caches.  A drive zone cache can typically track linear
1013  * reads or writes for around 16 zones simultaniously.
1014  *
1015  * Read prioritization issues:  It is possible for hundreds of megabytes worth
1016  * of writes to be queued asynchronously.  This creates a huge bottleneck
1017  * for reads which reduce read bandwidth to a trickle.
1018  *
1019  * To solve this problem we generally reorder reads before writes.
1020  *
1021  * However, a large number of random reads can also starve writes and
1022  * make poor use of the drive zone cache so we allow writes to trickle
1023  * in every N reads.
1024  */
1025 void
1026 bioqdisksort(struct bio_queue_head *bioq, struct bio *bio)
1027 {
1028         /*
1029          * The BIO wants to be ordered.  Adding to the tail also
1030          * causes transition to be set to NULL, forcing the ordering
1031          * of all prior I/O's.
1032          */
1033         if (bio->bio_buf->b_flags & B_ORDERED) {
1034                 bioq_insert_tail(bioq, bio);
1035                 return;
1036         }
1037
1038         switch(bio->bio_buf->b_cmd) {
1039         case BUF_CMD_READ:
1040                 if (bioq->transition) {
1041                         /*
1042                          * Insert before the first write.  Bleedover writes
1043                          * based on reorder intervals to prevent starvation.
1044                          */
1045                         TAILQ_INSERT_BEFORE(bioq->transition, bio, bio_act);
1046                         ++bioq->reorder;
1047                         if (bioq->reorder % bioq_reorder_minor_interval == 0) {
1048                                 bioqwritereorder(bioq);
1049                                 if (bioq->reorder >=
1050                                     bioq_reorder_burst_interval) {
1051                                         bioq->reorder = 0;
1052                                 }
1053                         }
1054                 } else {
1055                         /*
1056                          * No writes queued (or ordering was forced),
1057                          * insert at tail.
1058                          */
1059                         TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1060                 }
1061                 break;
1062         case BUF_CMD_WRITE:
1063                 /*
1064                  * Writes are always appended.  If no writes were previously
1065                  * queued or an ordered tail insertion occured the transition
1066                  * field will be NULL.
1067                  */
1068                 TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1069                 if (bioq->transition == NULL)
1070                         bioq->transition = bio;
1071                 break;
1072         default:
1073                 /*
1074                  * All other request types are forced to be ordered.
1075                  */
1076                 bioq_insert_tail(bioq, bio);
1077                 break;
1078         }
1079 }
1080
1081 /*
1082  * Move the read-write transition point to prevent reads from
1083  * completely starving our writes.  This brings a number of writes into
1084  * the fold every N reads.
1085  *
1086  * We bring a few linear writes into the fold on a minor interval
1087  * and we bring a non-linear burst of writes into the fold on a major
1088  * interval.  Bursting only occurs if runningbufspace is really high
1089  * (typically from syncs, fsyncs, or HAMMER flushes).
1090  */
1091 static
1092 void
1093 bioqwritereorder(struct bio_queue_head *bioq)
1094 {
1095         struct bio *bio;
1096         off_t next_offset;
1097         size_t left;
1098         size_t n;
1099         int check_off;
1100
1101         if (bioq->reorder < bioq_reorder_burst_interval ||
1102             !buf_runningbufspace_severe()) {
1103                 left = (size_t)bioq_reorder_minor_bytes;
1104                 check_off = 1;
1105         } else {
1106                 left = (size_t)bioq_reorder_burst_bytes;
1107                 check_off = 0;
1108         }
1109
1110         next_offset = bioq->transition->bio_offset;
1111         while ((bio = bioq->transition) != NULL &&
1112                (check_off == 0 || next_offset == bio->bio_offset)
1113         ) {
1114                 n = bio->bio_buf->b_bcount;
1115                 next_offset = bio->bio_offset + n;
1116                 bioq->transition = TAILQ_NEXT(bio, bio_act);
1117                 if (left < n)
1118                         break;
1119                 left -= n;
1120         }
1121 }
1122
1123 /*
1124  * Disk error is the preface to plaintive error messages
1125  * about failing disk transfers.  It prints messages of the form
1126
1127 hp0g: hard error reading fsbn 12345 of 12344-12347 (hp0 bn %d cn %d tn %d sn %d)
1128
1129  * if the offset of the error in the transfer and a disk label
1130  * are both available.  blkdone should be -1 if the position of the error
1131  * is unknown; the disklabel pointer may be null from drivers that have not
1132  * been converted to use them.  The message is printed with kprintf
1133  * if pri is LOG_PRINTF, otherwise it uses log at the specified priority.
1134  * The message should be completed (with at least a newline) with kprintf
1135  * or log(-1, ...), respectively.  There is no trailing space.
1136  */
1137 void
1138 diskerr(struct bio *bio, cdev_t dev, const char *what, int pri, int donecnt)
1139 {
1140         struct buf *bp = bio->bio_buf;
1141         const char *term;
1142
1143         switch(bp->b_cmd) {
1144         case BUF_CMD_READ:
1145                 term = "read";
1146                 break;
1147         case BUF_CMD_WRITE:
1148                 term = "write";
1149                 break;
1150         default:
1151                 term = "access";
1152                 break;
1153         }
1154         kprintf("%s: %s %sing ", dev->si_name, what, term);
1155         kprintf("offset %012llx for %d",
1156                 (long long)bio->bio_offset,
1157                 bp->b_bcount);
1158
1159         if (donecnt)
1160                 kprintf(" (%d bytes completed)", donecnt);
1161 }
1162
1163 /*
1164  * Locate a disk device
1165  */
1166 cdev_t
1167 disk_locate(const char *devname)
1168 {
1169         return devfs_find_device_by_name(devname);
1170 }
1171
1172 void
1173 disk_config(void *arg)
1174 {
1175         disk_msg_send_sync(DISK_SYNC, NULL, NULL);
1176 }
1177
1178 static void
1179 disk_init(void)
1180 {
1181         struct thread* td_core;
1182
1183         disk_msg_cache = objcache_create("disk-msg-cache", 0, 0,
1184                                          NULL, NULL, NULL,
1185                                          objcache_malloc_alloc,
1186                                          objcache_malloc_free,
1187                                          &disk_msg_malloc_args);
1188
1189         lwkt_token_init(&disklist_token);
1190
1191         /*
1192          * Initialize the reply-only port which acts as a message drain
1193          */
1194         lwkt_initport_replyonly(&disk_dispose_port, disk_msg_autofree_reply);
1195
1196         lwkt_create(disk_msg_core, /*args*/NULL, &td_core, NULL,
1197                     0, 0, "disk_msg_core");
1198
1199         tsleep(td_core, 0, "diskcore", 0);
1200 }
1201
1202 static void
1203 disk_uninit(void)
1204 {
1205         objcache_destroy(disk_msg_cache);
1206 }
1207
1208 /*
1209  * Clean out illegal characters in serial numbers.
1210  */
1211 static void
1212 disk_cleanserial(char *serno)
1213 {
1214         char c;
1215
1216         while ((c = *serno) != 0) {
1217                 if (c >= 'a' && c <= 'z')
1218                         ;
1219                 else if (c >= 'A' && c <= 'Z')
1220                         ;
1221                 else if (c >= '0' && c <= '9')
1222                         ;
1223                 else if (c == '-' || c == '@' || c == '+' || c == '.')
1224                         ;
1225                 else
1226                         c = '_';
1227                 *serno++= c;
1228         }
1229 }
1230
1231 TUNABLE_INT("kern.disk_debug", &disk_debug_enable);
1232 SYSCTL_INT(_kern, OID_AUTO, disk_debug, CTLFLAG_RW, &disk_debug_enable,
1233                 0, "Enable subr_disk debugging");
1234
1235 SYSINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST, disk_init, NULL);
1236 SYSUNINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY, disk_uninit, NULL);