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 #include <sys/dsched.h>
 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  * This routine is only called for newly minted drives or to reprobe
 254  * a drive with no open slices.  disk_probe_slice() is called directly
 255  * when reprobing partition changes within slices.
 256  */
 257 static void
 258 disk_probe(struct disk *dp, int reprobe)
 259 {
 260         struct disk_info *info = &dp->d_info;
 261         cdev_t dev = dp->d_cdev;
 262         cdev_t ndev;
 263         int error, i, sno;
 264         struct diskslices *osp;
 265         struct diskslice *sp;
 266
 267         KKASSERT (info->d_media_blksize != 0);
 268
 269         osp = dp->d_slice;
 270         dp->d_slice = dsmakeslicestruct(BASE_SLICE, info);
 271         disk_debug(1, "disk_probe (begin): %s\n", dp->d_cdev->si_name);
 272
 273         error = mbrinit(dev, info, &(dp->d_slice));
 274         if (error) {
 275                 dsgone(&osp);
 276                 return;
 277         }
 278
 279         for (i = 0; i < dp->d_slice->dss_nslices; i++) {
 280                 /*
 281                  * Ignore the whole-disk slice, it has already been created.
 282                  */
 283                 if (i == WHOLE_DISK_SLICE)
 284                         continue;
 285                 sp = &dp->d_slice->dss_slices[i];
 286
 287                 /*
 288                  * Handle s0.  s0 is a compatibility slice if there are no
 289                  * other slices and it has not otherwise been set up, else
 290                  * we ignore it.
 291                  */
 292                 if (i == COMPATIBILITY_SLICE) {
 293                         sno = 0;
 294                         if (sp->ds_type == 0 &&
 295                             dp->d_slice->dss_nslices == BASE_SLICE) {
 296                                 sp->ds_size = info->d_media_blocks;
 297                                 sp->ds_reserved = 0;
 298                         }
 299                 } else {
 300                         sno = i - 1;
 301                         sp->ds_reserved = 0;
 302                 }
 303
 304                 /*
 305                  * Ignore 0-length slices
 306                  */
 307                 if (sp->ds_size == 0)
 308                         continue;
 309
 310                 if (reprobe &&
 311                     (ndev = devfs_find_device_by_name("%ss%d",
 312                                                       dev->si_name, sno))) {
 313                         /*
 314                          * Device already exists and is still valid
 315                          */
 316                         ndev->si_flags |= SI_REPROBE_TEST;
 317                 } else {
 318                         /*
 319                          * Else create new device
 320                          */
 321                         ndev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
 322                                         dkmakewholeslice(dkunit(dev), i),
 323                                         UID_ROOT, GID_OPERATOR, 0640,
 324                                         "%ss%d", dev->si_name, sno);
 325                         if (dp->d_info.d_serialno) {
 326                                 make_dev_alias(ndev, "serno/%s.s%d",
 327                                                dp->d_info.d_serialno, sno);
 328                         }
 329                         ndev->si_disk = dp;
 330                         ndev->si_flags |= SI_REPROBE_TEST;
 331                 }
 332                 sp->ds_dev = ndev;
 333
 334                 /*
 335                  * Probe appropriate slices for a disklabel
 336                  *
 337                  * XXX slice type 1 used by our gpt probe code.
 338                  * XXX slice type 0 used by mbr compat slice.
 339                  */
 340                 if (sp->ds_type == DOSPTYP_386BSD ||
 341                     sp->ds_type == DOSPTYP_NETBSD ||
 342                     sp->ds_type == DOSPTYP_OPENBSD ||
 343                     sp->ds_type == 0 ||
 344                     sp->ds_type == 1) {
 345                         if (dp->d_slice->dss_first_bsd_slice == 0)
 346                                 dp->d_slice->dss_first_bsd_slice = i;
 347                         disk_probe_slice(dp, ndev, i, reprobe);
 348                 }
 349         }
 350         dsgone(&osp);
 351         disk_debug(1, "disk_probe (end): %s\n", dp->d_cdev->si_name);
 352 }
 353
 354
 355 static void
 356 disk_msg_core(void *arg)
 357 {
 358         struct disk     *dp;
 359         struct diskslice *sp;
 360         lwkt_tokref ilock;
 361         disk_msg_t msg;
 362         int run;
 363
 364         lwkt_initport_thread(&disk_msg_port, curthread);
 365         wakeup(curthread);
 366         run = 1;
 367
 368         while (run) {
 369                 msg = (disk_msg_t)lwkt_waitport(&disk_msg_port, 0);
 370
 371                 switch (msg->hdr.u.ms_result) {
 372                 case DISK_DISK_PROBE:
 373                         dp = (struct disk *)msg->load;
 374                         disk_debug(1,
 375                                     "DISK_DISK_PROBE: %s\n",
 376                                         dp->d_cdev->si_name);
 377                         disk_probe(dp, 0);
 378                         break;
 379                 case DISK_DISK_DESTROY:
 380                         dp = (struct disk *)msg->load;
 381                         disk_debug(1,
 382                                     "DISK_DISK_DESTROY: %s\n",
 383                                         dp->d_cdev->si_name);
 384                         devfs_destroy_subnames(dp->d_cdev->si_name);
 385                         devfs_destroy_dev(dp->d_cdev);
 386                         lwkt_gettoken(&ilock, &disklist_token);
 387                         LIST_REMOVE(dp, d_list);
 388                         lwkt_reltoken(&ilock);
 389                         if (dp->d_info.d_serialno) {
 390                                 kfree(dp->d_info.d_serialno, M_TEMP);
 391                                 dp->d_info.d_serialno = NULL;
 392                         }
 393                         break;
 394                 case DISK_UNPROBE:
 395                         dp = (struct disk *)msg->load;
 396                         disk_debug(1,
 397                                     "DISK_DISK_UNPROBE: %s\n",
 398                                         dp->d_cdev->si_name);
 399                         devfs_destroy_subnames(dp->d_cdev->si_name);
 400                         break;
 401                 case DISK_SLICE_REPROBE:
 402                         dp = (struct disk *)msg->load;
 403                         sp = (struct diskslice *)msg->load2;
 404                         devfs_clr_subnames_flag(sp->ds_dev->si_name,
 405                                                 SI_REPROBE_TEST);
 406                         disk_debug(1,
 407                                     "DISK_SLICE_REPROBE: %s\n",
 408                                     sp->ds_dev->si_name);
 409                         disk_probe_slice(dp, sp->ds_dev,
 410                                          dkslice(sp->ds_dev), 1);
 411                         devfs_destroy_subnames_without_flag(
 412                                         sp->ds_dev->si_name, SI_REPROBE_TEST);
 413                         break;
 414                 case DISK_DISK_REPROBE:
 415                         dp = (struct disk *)msg->load;
 416                         devfs_clr_subnames_flag(dp->d_cdev->si_name, SI_REPROBE_TEST);
 417                         disk_debug(1,
 418                                     "DISK_DISK_REPROBE: %s\n",
 419                                     dp->d_cdev->si_name);
 420                         disk_probe(dp, 1);
 421                         devfs_destroy_subnames_without_flag(
 422                                         dp->d_cdev->si_name, SI_REPROBE_TEST);
 423                         break;
 424                 case DISK_SYNC:
 425                         disk_debug(1, "DISK_SYNC\n");
 426                         break;
 427                 default:
 428                         devfs_debug(DEVFS_DEBUG_WARNING,
 429                                     "disk_msg_core: unknown message "
 430                                     "received at core\n");
 431                         break;
 432                 }
 433                 lwkt_replymsg(&msg->hdr, 0);
 434         }
 435         lwkt_exit();
 436 }
 437
 438
 439 /*
 440  * Acts as a message drain. Any message that is replied to here gets
 441  * destroyed and the memory freed.
 442  */
 443 static void
 444 disk_msg_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
 445 {
 446         objcache_put(disk_msg_cache, msg);
 447 }
 448
 449
 450 void
 451 disk_msg_send(uint32_t cmd, void *load, void *load2)
 452 {
 453         disk_msg_t disk_msg;
 454         lwkt_port_t port = &disk_msg_port;
 455
 456         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
 457
 458         lwkt_initmsg(&disk_msg->hdr, &disk_dispose_port, 0);
 459
 460         disk_msg->hdr.u.ms_result = cmd;
 461         disk_msg->load = load;
 462         disk_msg->load2 = load2;
 463         KKASSERT(port);
 464         lwkt_sendmsg(port, &disk_msg->hdr);
 465 }
 466
 467 void
 468 disk_msg_send_sync(uint32_t cmd, void *load, void *load2)
 469 {
 470         struct lwkt_port rep_port;
 471         disk_msg_t disk_msg;
 472         lwkt_port_t port;
 473
 474         disk_msg = objcache_get(disk_msg_cache, M_WAITOK);
 475         port = &disk_msg_port;
 476
 477         /* XXX could probably use curthread's built-in msgport */
 478         lwkt_initport_thread(&rep_port, curthread);
 479         lwkt_initmsg(&disk_msg->hdr, &rep_port, 0);
 480
 481         disk_msg->hdr.u.ms_result = cmd;
 482         disk_msg->load = load;
 483         disk_msg->load2 = load2;
 484
 485         lwkt_sendmsg(port, &disk_msg->hdr);
 486         lwkt_waitmsg(&disk_msg->hdr, 0);
 487         objcache_put(disk_msg_cache, disk_msg);
 488 }
 489
 490 /*
 491  * Create a raw device for the dev_ops template (which is returned).  Also
 492  * create a slice and unit managed disk and overload the user visible
 493  * device space with it.
 494  *
 495  * NOTE: The returned raw device is NOT a slice and unit managed device.
 496  * It is an actual raw device representing the raw disk as specified by
 497  * the passed dev_ops.  The disk layer not only returns such a raw device,
 498  * it also uses it internally when passing (modified) commands through.
 499  */
 500 cdev_t
 501 disk_create(int unit, struct disk *dp, struct dev_ops *raw_ops)
 502 {
 503         lwkt_tokref ilock;
 504         cdev_t rawdev;
 505
 506         disk_debug(1,
 507                     "disk_create (begin): %s%d\n",
 508                         raw_ops->head.name, unit);
 509
 510         rawdev = make_only_dev(raw_ops, dkmakewholedisk(unit),
 511                             UID_ROOT, GID_OPERATOR, 0640,
 512                             "%s%d", raw_ops->head.name, unit);
 513
 514         bzero(dp, sizeof(*dp));
 515
 516         dp->d_rawdev = rawdev;
 517         dp->d_raw_ops = raw_ops;
 518         dp->d_dev_ops = &disk_ops;
 519         dp->d_cdev = make_dev_covering(&disk_ops, dp->d_rawdev->si_ops,
 520                             dkmakewholedisk(unit),
 521                             UID_ROOT, GID_OPERATOR, 0640,
 522                             "%s%d", raw_ops->head.name, unit);
 523
 524         dp->d_cdev->si_disk = dp;
 525
 526         lwkt_gettoken(&ilock, &disklist_token);
 527         LIST_INSERT_HEAD(&disklist, dp, d_list);
 528         lwkt_reltoken(&ilock);
 529
 530         disk_debug(1,
 531                     "disk_create (end): %s%d\n",
 532                         raw_ops->head.name, unit);
 533
 534         dsched_create(dp, raw_ops->head.name, unit);
 535         return (dp->d_rawdev);
 536 }
 537
 538
 539 static void
 540 _setdiskinfo(struct disk *disk, struct disk_info *info)
 541 {
 542         char *oldserialno;
 543
 544         oldserialno = disk->d_info.d_serialno;
 545         bcopy(info, &disk->d_info, sizeof(disk->d_info));
 546         info = &disk->d_info;
 547
 548         disk_debug(1,
 549                     "_setdiskinfo: %s\n",
 550                         disk->d_cdev->si_name);
 551
 552         /*
 553          * The serial number is duplicated so the caller can throw
 554          * their copy away.
 555          */
 556         if (info->d_serialno && info->d_serialno[0]) {
 557                 info->d_serialno = kstrdup(info->d_serialno, M_TEMP);
 558                 disk_cleanserial(info->d_serialno);
 559                 if (disk->d_cdev) {
 560                         make_dev_alias(disk->d_cdev, "serno/%s",
 561                                         info->d_serialno);
 562                 }
 563         } else {
 564                 info->d_serialno = NULL;
 565         }
 566         if (oldserialno)
 567                 kfree(oldserialno, M_TEMP);
 568
 569         /*
 570          * The caller may set d_media_size or d_media_blocks and we
 571          * calculate the other.
 572          */
 573         KKASSERT(info->d_media_size == 0 || info->d_media_blksize == 0);
 574         if (info->d_media_size == 0 && info->d_media_blocks) {
 575                 info->d_media_size = (u_int64_t)info->d_media_blocks *
 576                                      info->d_media_blksize;
 577         } else if (info->d_media_size && info->d_media_blocks == 0 &&
 578                    info->d_media_blksize) {
 579                 info->d_media_blocks = info->d_media_size /
 580                                        info->d_media_blksize;
 581         }
 582
 583         /*
 584          * The si_* fields for rawdev are not set until after the
 585          * disk_create() call, so someone using the cooked version
 586          * of the raw device (i.e. da0s0) will not get the right
 587          * si_iosize_max unless we fix it up here.
 588          */
 589         if (disk->d_cdev && disk->d_rawdev &&
 590             disk->d_cdev->si_iosize_max == 0) {
 591                 disk->d_cdev->si_iosize_max = disk->d_rawdev->si_iosize_max;
 592                 disk->d_cdev->si_bsize_phys = disk->d_rawdev->si_bsize_phys;
 593                 disk->d_cdev->si_bsize_best = disk->d_rawdev->si_bsize_best;
 594         }
 595 }
 596
 597 /*
 598  * Disk drivers must call this routine when media parameters are available
 599  * or have changed.
 600  */
 601 void
 602 disk_setdiskinfo(struct disk *disk, struct disk_info *info)
 603 {
 604         _setdiskinfo(disk, info);
 605         disk_msg_send(DISK_DISK_PROBE, disk, NULL);
 606         disk_debug(1,
 607                     "disk_setdiskinfo: sent probe for %s\n",
 608                         disk->d_cdev->si_name);
 609 }
 610
 611 void
 612 disk_setdiskinfo_sync(struct disk *disk, struct disk_info *info)
 613 {
 614         _setdiskinfo(disk, info);
 615         disk_msg_send_sync(DISK_DISK_PROBE, disk, NULL);
 616         disk_debug(1,
 617                     "disk_setdiskinfo_sync: sent probe for %s\n",
 618                         disk->d_cdev->si_name);
 619 }
 620
 621 /*
 622  * This routine is called when an adapter detaches.  The higher level
 623  * managed disk device is destroyed while the lower level raw device is
 624  * released.
 625  */
 626 void
 627 disk_destroy(struct disk *disk)
 628 {
 629         disk_msg_send_sync(DISK_DISK_DESTROY, disk, NULL);
 630         return;
 631 }
 632
 633 int
 634 disk_dumpcheck(cdev_t dev, u_int64_t *size, u_int64_t *blkno, u_int32_t *secsize)
 635 {
 636         struct partinfo pinfo;
 637         int error;
 638
 639         bzero(&pinfo, sizeof(pinfo));
 640         error = dev_dioctl(dev, DIOCGPART, (void *)&pinfo, 0,
 641                            proc0.p_ucred, NULL);
 642         if (error)
 643                 return (error);
 644
 645         if (pinfo.media_blksize == 0)
 646                 return (ENXIO);
 647
 648         if (blkno) /* XXX: make sure this reserved stuff is right */
 649                 *blkno = pinfo.reserved_blocks +
 650                         pinfo.media_offset / pinfo.media_blksize;
 651         if (secsize)
 652                 *secsize = pinfo.media_blksize;
 653         if (size)
 654                 *size = (pinfo.media_blocks - pinfo.reserved_blocks);
 655
 656         return (0);
 657 }
 658
 659 int
 660 disk_dumpconf(cdev_t dev, u_int onoff)
 661 {
 662         struct dumperinfo di;
 663         u_int64_t       size, blkno;
 664         u_int32_t       secsize;
 665         int error;
 666
 667         if (!onoff)
 668                 return set_dumper(NULL);
 669
 670         error = disk_dumpcheck(dev, &size, &blkno, &secsize);
 671
 672         if (error)
 673                 return ENXIO;
 674
 675         bzero(&di, sizeof(struct dumperinfo));
 676         di.dumper = diskdump;
 677         di.priv = dev;
 678         di.blocksize = secsize;
 679         di.mediaoffset = blkno * DEV_BSIZE;
 680         di.mediasize = size * DEV_BSIZE;
 681
 682         return set_dumper(&di);
 683 }
 684
 685 void
 686 disk_unprobe(struct disk *disk)
 687 {
 688         if (disk == NULL)
 689                 return;
 690
 691         disk_msg_send_sync(DISK_UNPROBE, disk, NULL);
 692 }
 693
 694 void
 695 disk_invalidate (struct disk *disk)
 696 {
 697         dsgone(&disk->d_slice);
 698 }
 699
 700 struct disk *
 701 disk_enumerate(struct disk *disk)
 702 {
 703         struct disk *dp;
 704         lwkt_tokref ilock;
 705
 706         lwkt_gettoken(&ilock, &disklist_token);
 707         if (!disk)
 708                 dp = (LIST_FIRST(&disklist));
 709         else
 710                 dp = (LIST_NEXT(disk, d_list));
 711         lwkt_reltoken(&ilock);
 712
 713         return dp;
 714 }
 715
 716 static
 717 int
 718 sysctl_disks(SYSCTL_HANDLER_ARGS)
 719 {
 720         struct disk *disk;
 721         int error, first;
 722
 723         disk = NULL;
 724         first = 1;
 725
 726         while ((disk = disk_enumerate(disk))) {
 727                 if (!first) {
 728                         error = SYSCTL_OUT(req, " ", 1);
 729                         if (error)
 730                                 return error;
 731                 } else {
 732                         first = 0;
 733                 }
 734                 error = SYSCTL_OUT(req, disk->d_rawdev->si_name,
 735                                    strlen(disk->d_rawdev->si_name));
 736                 if (error)
 737                         return error;
 738         }
 739         error = SYSCTL_OUT(req, "", 1);
 740         return error;
 741 }
 742
 743 SYSCTL_PROC(_kern, OID_AUTO, disks, CTLTYPE_STRING | CTLFLAG_RD, NULL, 0,
 744     sysctl_disks, "A", "names of available disks");
 745
 746 /*
 747  * Open a disk device or partition.
 748  */
 749 static
 750 int
 751 diskopen(struct dev_open_args *ap)
 752 {
 753         cdev_t dev = ap->a_head.a_dev;
 754         struct disk *dp;
 755         int error;
 756
 757         /*
 758          * dp can't be NULL here XXX.
 759          *
 760          * d_slice will be NULL if setdiskinfo() has not been called yet.
 761          * setdiskinfo() is typically called whether the disk is present
 762          * or not (e.g. CD), but the base disk device is created first
 763          * and there may be a race.
 764          */
 765         dp = dev->si_disk;
 766         if (dp == NULL || dp->d_slice == NULL)
 767                 return (ENXIO);
 768         error = 0;
 769
 770         /*
 771          * Deal with open races
 772          */
 773         while (dp->d_flags & DISKFLAG_LOCK) {
 774                 dp->d_flags |= DISKFLAG_WANTED;
 775                 error = tsleep(dp, PCATCH, "diskopen", hz);
 776                 if (error)
 777                         return (error);
 778         }
 779         dp->d_flags |= DISKFLAG_LOCK;
 780
 781         /*
 782          * Open the underlying raw device.
 783          */
 784         if (!dsisopen(dp->d_slice)) {
 785 #if 0
 786                 if (!pdev->si_iosize_max)
 787                         pdev->si_iosize_max = dev->si_iosize_max;
 788 #endif
 789                 error = dev_dopen(dp->d_rawdev, ap->a_oflags,
 790                                   ap->a_devtype, ap->a_cred);
 791         }
 792 #if 0
 793         /*
 794          * Inherit properties from the underlying device now that it is
 795          * open.
 796          */
 797         dev_dclone(dev);
 798 #endif
 799
 800         if (error)
 801                 goto out;
 802         error = dsopen(dev, ap->a_devtype, dp->d_info.d_dsflags,
 803                        &dp->d_slice, &dp->d_info);
 804         if (!dsisopen(dp->d_slice)) {
 805                 dev_dclose(dp->d_rawdev, ap->a_oflags, ap->a_devtype);
 806         }
 807 out:
 808         dp->d_flags &= ~DISKFLAG_LOCK;
 809         if (dp->d_flags & DISKFLAG_WANTED) {
 810                 dp->d_flags &= ~DISKFLAG_WANTED;
 811                 wakeup(dp);
 812         }
 813
 814         return(error);
 815 }
 816
 817 /*
 818  * Close a disk device or partition
 819  */
 820 static
 821 int
 822 diskclose(struct dev_close_args *ap)
 823 {
 824         cdev_t dev = ap->a_head.a_dev;
 825         struct disk *dp;
 826         int error;
 827
 828         error = 0;
 829         dp = dev->si_disk;
 830
 831         dsclose(dev, ap->a_devtype, dp->d_slice);
 832         if (!dsisopen(dp->d_slice)) {
 833                 error = dev_dclose(dp->d_rawdev, ap->a_fflag, ap->a_devtype);
 834         }
 835         return (error);
 836 }
 837
 838 /*
 839  * First execute the ioctl on the disk device, and if it isn't supported
 840  * try running it on the backing device.
 841  */
 842 static
 843 int
 844 diskioctl(struct dev_ioctl_args *ap)
 845 {
 846         cdev_t dev = ap->a_head.a_dev;
 847         struct disk *dp;
 848         int error;
 849         u_int u;
 850
 851         dp = dev->si_disk;
 852         if (dp == NULL)
 853                 return (ENXIO);
 854
 855         devfs_debug(DEVFS_DEBUG_DEBUG,
 856                     "diskioctl: cmd is: %x (name: %s)\n",
 857                     ap->a_cmd, dev->si_name);
 858         devfs_debug(DEVFS_DEBUG_DEBUG,
 859                     "diskioctl: &dp->d_slice is: %x, %x\n",
 860                     &dp->d_slice, dp->d_slice);
 861
 862         if (ap->a_cmd == DIOCGKERNELDUMP) {
 863                 u = *(u_int *)ap->a_data;
 864                 return disk_dumpconf(dev, u);
 865         }
 866
 867         error = dsioctl(dev, ap->a_cmd, ap->a_data, ap->a_fflag,
 868                         &dp->d_slice, &dp->d_info);
 869
 870         if (error == ENOIOCTL) {
 871                 error = dev_dioctl(dp->d_rawdev, ap->a_cmd, ap->a_data,
 872                                    ap->a_fflag, ap->a_cred, NULL);
 873         }
 874         return (error);
 875 }
 876
 877 /*
 878  * Execute strategy routine
 879  */
 880 static
 881 int
 882 diskstrategy(struct dev_strategy_args *ap)
 883 {
 884         cdev_t dev = ap->a_head.a_dev;
 885         struct bio *bio = ap->a_bio;
 886         struct bio *nbio;
 887         struct disk *dp;
 888
 889         dp = dev->si_disk;
 890
 891         if (dp == NULL) {
 892                 bio->bio_buf->b_error = ENXIO;
 893                 bio->bio_buf->b_flags |= B_ERROR;
 894                 biodone(bio);
 895                 return(0);
 896         }
 897         KKASSERT(dev->si_disk == dp);
 898
 899         /*
 900          * The dscheck() function will also transform the slice relative
 901          * block number i.e. bio->bio_offset into a block number that can be
 902          * passed directly to the underlying raw device.  If dscheck()
 903          * returns NULL it will have handled the bio for us (e.g. EOF
 904          * or error due to being beyond the device size).
 905          */
 906         if ((nbio = dscheck(dev, bio, dp->d_slice)) != NULL) {
 907                 dsched_queue(dp, nbio);
 908         } else {
 909                 biodone(bio);
 910         }
 911         return(0);
 912 }
 913
 914 /*
 915  * Return the partition size in ?blocks?
 916  */
 917 static
 918 int
 919 diskpsize(struct dev_psize_args *ap)
 920 {
 921         cdev_t dev = ap->a_head.a_dev;
 922         struct disk *dp;
 923
 924         dp = dev->si_disk;
 925         if (dp == NULL)
 926                 return(ENODEV);
 927         ap->a_result = dssize(dev, &dp->d_slice);
 928         return(0);
 929 }
 930
 931 /*
 932  * When new device entries are instantiated, make sure they inherit our
 933  * si_disk structure and block and iosize limits from the raw device.
 934  *
 935  * This routine is always called synchronously in the context of the
 936  * client.
 937  *
 938  * XXX The various io and block size constraints are not always initialized
 939  * properly by devices.
 940  */
 941 static
 942 int
 943 diskclone(struct dev_clone_args *ap)
 944 {
 945         cdev_t dev = ap->a_head.a_dev;
 946         struct disk *dp;
 947         dp = dev->si_disk;
 948
 949         KKASSERT(dp != NULL);
 950         dev->si_disk = dp;
 951         dev->si_iosize_max = dp->d_rawdev->si_iosize_max;
 952         dev->si_bsize_phys = dp->d_rawdev->si_bsize_phys;
 953         dev->si_bsize_best = dp->d_rawdev->si_bsize_best;
 954         return(0);
 955 }
 956
 957 int
 958 diskdump(struct dev_dump_args *ap)
 959 {
 960         cdev_t dev = ap->a_head.a_dev;
 961         struct disk *dp = dev->si_disk;
 962         u_int64_t size, offset;
 963         int error;
 964
 965         error = disk_dumpcheck(dev, &size, &ap->a_blkno, &ap->a_secsize);
 966         /* XXX: this should probably go in disk_dumpcheck somehow */
 967         if (ap->a_length != 0) {
 968                 size *= DEV_BSIZE;
 969                 offset = ap->a_blkno * DEV_BSIZE;
 970                 if ((ap->a_offset < offset) ||
 971                     (ap->a_offset + ap->a_length - offset > size)) {
 972                         kprintf("Attempt to write outside dump device boundaries.\n");
 973                         error = ENOSPC;
 974                 }
 975         }
 976
 977         if (error == 0) {
 978                 ap->a_head.a_dev = dp->d_rawdev;
 979                 error = dev_doperate(&ap->a_head);
 980         }
 981
 982         return(error);
 983 }
 984
 985
 986 SYSCTL_INT(_debug_sizeof, OID_AUTO, diskslices, CTLFLAG_RD,
 987     0, sizeof(struct diskslices), "sizeof(struct diskslices)");
 988
 989 SYSCTL_INT(_debug_sizeof, OID_AUTO, disk, CTLFLAG_RD,
 990     0, sizeof(struct disk), "sizeof(struct disk)");
 991
 992 /*
 993  * Reorder interval for burst write allowance and minor write
 994  * allowance.
 995  *
 996  * We always want to trickle some writes in to make use of the
 997  * disk's zone cache.  Bursting occurs on a longer interval and only
 998  * runningbufspace is well over the hirunningspace limit.
 999  */
1000 int bioq_reorder_burst_interval = 60;   /* should be multiple of minor */
1001 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_interval,
1002            CTLFLAG_RW, &bioq_reorder_burst_interval, 0, "");
1003 int bioq_reorder_minor_interval = 5;
1004 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_interval,
1005            CTLFLAG_RW, &bioq_reorder_minor_interval, 0, "");
1006
1007 int bioq_reorder_burst_bytes = 3000000;
1008 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_burst_bytes,
1009            CTLFLAG_RW, &bioq_reorder_burst_bytes, 0, "");
1010 int bioq_reorder_minor_bytes = 262144;
1011 SYSCTL_INT(_kern, OID_AUTO, bioq_reorder_minor_bytes,
1012            CTLFLAG_RW, &bioq_reorder_minor_bytes, 0, "");
1013
1014
1015 /*
1016  * Order I/Os.  Generally speaking this code is designed to make better
1017  * use of drive zone caches.  A drive zone cache can typically track linear
1018  * reads or writes for around 16 zones simultaniously.
1019  *
1020  * Read prioritization issues:  It is possible for hundreds of megabytes worth
1021  * of writes to be queued asynchronously.  This creates a huge bottleneck
1022  * for reads which reduce read bandwidth to a trickle.
1023  *
1024  * To solve this problem we generally reorder reads before writes.
1025  *
1026  * However, a large number of random reads can also starve writes and
1027  * make poor use of the drive zone cache so we allow writes to trickle
1028  * in every N reads.
1029  */
1030 void
1031 bioqdisksort(struct bio_queue_head *bioq, struct bio *bio)
1032 {
1033         /*
1034          * The BIO wants to be ordered.  Adding to the tail also
1035          * causes transition to be set to NULL, forcing the ordering
1036          * of all prior I/O's.
1037          */
1038         if (bio->bio_buf->b_flags & B_ORDERED) {
1039                 bioq_insert_tail(bioq, bio);
1040                 return;
1041         }
1042
1043         switch(bio->bio_buf->b_cmd) {
1044         case BUF_CMD_READ:
1045                 if (bioq->transition) {
1046                         /*
1047                          * Insert before the first write.  Bleedover writes
1048                          * based on reorder intervals to prevent starvation.
1049                          */
1050                         TAILQ_INSERT_BEFORE(bioq->transition, bio, bio_act);
1051                         ++bioq->reorder;
1052                         if (bioq->reorder % bioq_reorder_minor_interval == 0) {
1053                                 bioqwritereorder(bioq);
1054                                 if (bioq->reorder >=
1055                                     bioq_reorder_burst_interval) {
1056                                         bioq->reorder = 0;
1057                                 }
1058                         }
1059                 } else {
1060                         /*
1061                          * No writes queued (or ordering was forced),
1062                          * insert at tail.
1063                          */
1064                         TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1065                 }
1066                 break;
1067         case BUF_CMD_WRITE:
1068                 /*
1069                  * Writes are always appended.  If no writes were previously
1070                  * queued or an ordered tail insertion occured the transition
1071                  * field will be NULL.
1072                  */
1073                 TAILQ_INSERT_TAIL(&bioq->queue, bio, bio_act);
1074                 if (bioq->transition == NULL)
1075                         bioq->transition = bio;
1076                 break;
1077         default:
1078                 /*
1079                  * All other request types are forced to be ordered.
1080                  */
1081                 bioq_insert_tail(bioq, bio);
1082                 break;
1083         }
1084 }
1085
1086 /*
1087  * Move the read-write transition point to prevent reads from
1088  * completely starving our writes.  This brings a number of writes into
1089  * the fold every N reads.
1090  *
1091  * We bring a few linear writes into the fold on a minor interval
1092  * and we bring a non-linear burst of writes into the fold on a major
1093  * interval.  Bursting only occurs if runningbufspace is really high
1094  * (typically from syncs, fsyncs, or HAMMER flushes).
1095  */
1096 static
1097 void
1098 bioqwritereorder(struct bio_queue_head *bioq)
1099 {
1100         struct bio *bio;
1101         off_t next_offset;
1102         size_t left;
1103         size_t n;
1104         int check_off;
1105
1106         if (bioq->reorder < bioq_reorder_burst_interval ||
1107             !buf_runningbufspace_severe()) {
1108                 left = (size_t)bioq_reorder_minor_bytes;
1109                 check_off = 1;
1110         } else {
1111                 left = (size_t)bioq_reorder_burst_bytes;
1112                 check_off = 0;
1113         }
1114
1115         next_offset = bioq->transition->bio_offset;
1116         while ((bio = bioq->transition) != NULL &&
1117                (check_off == 0 || next_offset == bio->bio_offset)
1118         ) {
1119                 n = bio->bio_buf->b_bcount;
1120                 next_offset = bio->bio_offset + n;
1121                 bioq->transition = TAILQ_NEXT(bio, bio_act);
1122                 if (left < n)
1123                         break;
1124                 left -= n;
1125         }
1126 }
1127
1128 /*
1129  * Disk error is the preface to plaintive error messages
1130  * about failing disk transfers.  It prints messages of the form
1131
1132 hp0g: hard error reading fsbn 12345 of 12344-12347 (hp0 bn %d cn %d tn %d sn %d)
1133
1134  * if the offset of the error in the transfer and a disk label
1135  * are both available.  blkdone should be -1 if the position of the error
1136  * is unknown; the disklabel pointer may be null from drivers that have not
1137  * been converted to use them.  The message is printed with kprintf
1138  * if pri is LOG_PRINTF, otherwise it uses log at the specified priority.
1139  * The message should be completed (with at least a newline) with kprintf
1140  * or log(-1, ...), respectively.  There is no trailing space.
1141  */
1142 void
1143 diskerr(struct bio *bio, cdev_t dev, const char *what, int pri, int donecnt)
1144 {
1145         struct buf *bp = bio->bio_buf;
1146         const char *term;
1147
1148         switch(bp->b_cmd) {
1149         case BUF_CMD_READ:
1150                 term = "read";
1151                 break;
1152         case BUF_CMD_WRITE:
1153                 term = "write";
1154                 break;
1155         default:
1156                 term = "access";
1157                 break;
1158         }
1159         kprintf("%s: %s %sing ", dev->si_name, what, term);
1160         kprintf("offset %012llx for %d",
1161                 (long long)bio->bio_offset,
1162                 bp->b_bcount);
1163
1164         if (donecnt)
1165                 kprintf(" (%d bytes completed)", donecnt);
1166 }
1167
1168 /*
1169  * Locate a disk device
1170  */
1171 cdev_t
1172 disk_locate(const char *devname)
1173 {
1174         return devfs_find_device_by_name(devname);
1175 }
1176
1177 void
1178 disk_config(void *arg)
1179 {
1180         disk_msg_send_sync(DISK_SYNC, NULL, NULL);
1181 }
1182
1183 static void
1184 disk_init(void)
1185 {
1186         struct thread* td_core;
1187
1188         disk_msg_cache = objcache_create("disk-msg-cache", 0, 0,
1189                                          NULL, NULL, NULL,
1190                                          objcache_malloc_alloc,
1191                                          objcache_malloc_free,
1192                                          &disk_msg_malloc_args);
1193
1194         lwkt_token_init(&disklist_token);
1195
1196         /*
1197          * Initialize the reply-only port which acts as a message drain
1198          */
1199         lwkt_initport_replyonly(&disk_dispose_port, disk_msg_autofree_reply);
1200
1201         lwkt_create(disk_msg_core, /*args*/NULL, &td_core, NULL,
1202                     0, 0, "disk_msg_core");
1203
1204         tsleep(td_core, 0, "diskcore", 0);
1205 }
1206
1207 static void
1208 disk_uninit(void)
1209 {
1210         objcache_destroy(disk_msg_cache);
1211 }
1212
1213 /*
1214  * Clean out illegal characters in serial numbers.
1215  */
1216 static void
1217 disk_cleanserial(char *serno)
1218 {
1219         char c;
1220
1221         while ((c = *serno) != 0) {
1222                 if (c >= 'a' && c <= 'z')
1223                         ;
1224                 else if (c >= 'A' && c <= 'Z')
1225                         ;
1226                 else if (c >= '0' && c <= '9')
1227                         ;
1228                 else if (c == '-' || c == '@' || c == '+' || c == '.')
1229                         ;
1230                 else
1231                         c = '_';
1232                 *serno++= c;
1233         }
1234 }
1235
1236 TUNABLE_INT("kern.disk_debug", &disk_debug_enable);
1237 SYSCTL_INT(_kern, OID_AUTO, disk_debug, CTLFLAG_RW, &disk_debug_enable,
1238                 0, "Enable subr_disk debugging");
1239
1240 SYSINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST, disk_init, NULL);
1241 SYSUNINIT(disk_register, SI_SUB_PRE_DRIVERS, SI_ORDER_ANY, disk_uninit, NULL);