sys/geom/geom_disk.c

   1 /*-
   2  * Copyright (c) 2002 Poul-Henning Kamp
   3  * Copyright (c) 2002 Networks Associates Technology, Inc.
   4  * All rights reserved.
   5  *
   6  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
   7  * and NAI Labs, the Security Research Division of Network Associates, Inc.
   8  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
   9  * DARPA CHATS research program.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. The names of the authors may not be used to endorse or promote
  20  *    products derived from this software without specific prior written
  21  *    permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include "opt_geom.h"
  40
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/kernel.h>
  44 #include <sys/sysctl.h>
  45 #include <sys/bio.h>
  46 #include <sys/ctype.h>
  47 #include <sys/fcntl.h>
  48 #include <sys/malloc.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/devicestat.h>
  51 #include <machine/md_var.h>
  52
  53 #include <sys/lock.h>
  54 #include <sys/mutex.h>
  55 #include <geom/geom.h>
  56 #include <geom/geom_disk.h>
  57 #include <geom/geom_int.h>
  58
  59 static struct mtx g_disk_done_mtx;
  60
  61 static g_access_t g_disk_access;
  62 static g_init_t g_disk_init;
  63 static g_fini_t g_disk_fini;
  64 static g_start_t g_disk_start;
  65 static g_ioctl_t g_disk_ioctl;
  66 static g_dumpconf_t g_disk_dumpconf;
  67
  68 static struct g_class g_disk_class = {
  69         .name = "DISK",
  70         .version = G_VERSION,
  71         .init = g_disk_init,
  72         .fini = g_disk_fini,
  73         .start = g_disk_start,
  74         .access = g_disk_access,
  75         .ioctl = g_disk_ioctl,
  76         .dumpconf = g_disk_dumpconf,
  77 };
  78
  79 static void
  80 g_disk_init(struct g_class *mp __unused)
  81 {
  82
  83         mtx_init(&g_disk_done_mtx, "g_disk_done", NULL, MTX_DEF);
  84 }
  85
  86 static void
  87 g_disk_fini(struct g_class *mp __unused)
  88 {
  89
  90         mtx_destroy(&g_disk_done_mtx);
  91 }
  92
  93 DECLARE_GEOM_CLASS(g_disk_class, g_disk);
  94
  95 static void __inline
  96 g_disk_lock_giant(struct disk *dp)
  97 {
  98         if (dp->d_flags & DISKFLAG_NEEDSGIANT)
  99                 mtx_lock(&Giant);
 100 }
 101
 102 static void __inline
 103 g_disk_unlock_giant(struct disk *dp)
 104 {
 105         if (dp->d_flags & DISKFLAG_NEEDSGIANT)
 106                 mtx_unlock(&Giant);
 107 }
 108
 109 static int
 110 g_disk_access(struct g_provider *pp, int r, int w, int e)
 111 {
 112         struct disk *dp;
 113         int error;
 114
 115         g_trace(G_T_ACCESS, "g_disk_access(%s, %d, %d, %d)",
 116             pp->name, r, w, e);
 117         g_topology_assert();
 118         dp = pp->geom->softc;
 119         if (dp == NULL || dp->d_destroyed) {
 120                 /*
 121                  * Allow decreasing access count even if disk is not
 122                  * avaliable anymore.
 123                  */
 124                 if (r <= 0 && w <= 0 && e <= 0)
 125                         return (0);
 126                 return (ENXIO);
 127         }
 128         r += pp->acr;
 129         w += pp->acw;
 130         e += pp->ace;
 131         error = 0;
 132         if ((pp->acr + pp->acw + pp->ace) == 0 && (r + w + e) > 0) {
 133                 if (dp->d_open != NULL) {
 134                         g_disk_lock_giant(dp);
 135                         error = dp->d_open(dp);
 136                         if (bootverbose && error != 0)
 137                                 printf("Opened disk %s -> %d\n",
 138                                     pp->name, error);
 139                         g_disk_unlock_giant(dp);
 140                 }
 141                 pp->mediasize = dp->d_mediasize;
 142                 pp->sectorsize = dp->d_sectorsize;
 143                 if (dp->d_flags & DISKFLAG_CANDELETE)
 144                         pp->flags |= G_PF_CANDELETE;
 145                 else
 146                         pp->flags &= ~G_PF_CANDELETE;
 147                 pp->stripeoffset = dp->d_stripeoffset;
 148                 pp->stripesize = dp->d_stripesize;
 149                 dp->d_flags |= DISKFLAG_OPEN;
 150                 if (dp->d_maxsize == 0) {
 151                         printf("WARNING: Disk drive %s%d has no d_maxsize\n",
 152                             dp->d_name, dp->d_unit);
 153                         dp->d_maxsize = DFLTPHYS;
 154                 }
 155         } else if ((pp->acr + pp->acw + pp->ace) > 0 && (r + w + e) == 0) {
 156                 if (dp->d_close != NULL) {
 157                         g_disk_lock_giant(dp);
 158                         error = dp->d_close(dp);
 159                         if (error != 0)
 160                                 printf("Closed disk %s -> %d\n",
 161                                     pp->name, error);
 162                         g_disk_unlock_giant(dp);
 163                 }
 164                 dp->d_flags &= ~DISKFLAG_OPEN;
 165         }
 166         return (error);
 167 }
 168
 169 static void
 170 g_disk_kerneldump(struct bio *bp, struct disk *dp)
 171 {
 172         struct g_kerneldump *gkd;
 173         struct g_geom *gp;
 174
 175         gkd = (struct g_kerneldump*)bp->bio_data;
 176         gp = bp->bio_to->geom;
 177         g_trace(G_T_TOPOLOGY, "g_disk_kernedump(%s, %jd, %jd)",
 178                 gp->name, (intmax_t)gkd->offset, (intmax_t)gkd->length);
 179         if (dp->d_dump == NULL) {
 180                 g_io_deliver(bp, ENODEV);
 181                 return;
 182         }
 183         gkd->di.dumper = dp->d_dump;
 184         gkd->di.priv = dp;
 185         gkd->di.blocksize = dp->d_sectorsize;
 186         gkd->di.maxiosize = dp->d_maxsize;
 187         gkd->di.mediaoffset = gkd->offset;
 188         if ((gkd->offset + gkd->length) > dp->d_mediasize)
 189                 gkd->length = dp->d_mediasize - gkd->offset;
 190         gkd->di.mediasize = gkd->length;
 191         g_io_deliver(bp, 0);
 192 }
 193
 194 static void
 195 g_disk_done(struct bio *bp)
 196 {
 197         struct bio *bp2;
 198         struct disk *dp;
 199
 200         /* See "notes" for why we need a mutex here */
 201         /* XXX: will witness accept a mix of Giant/unGiant drivers here ? */
 202         mtx_lock(&g_disk_done_mtx);
 203         bp->bio_completed = bp->bio_length - bp->bio_resid;
 204
 205         bp2 = bp->bio_parent;
 206         if (bp2->bio_error == 0)
 207                 bp2->bio_error = bp->bio_error;
 208         bp2->bio_completed += bp->bio_completed;
 209         if ((bp->bio_cmd & (BIO_READ|BIO_WRITE|BIO_DELETE)) &&
 210             (dp = bp2->bio_to->geom->softc)) {
 211                 devstat_end_transaction_bio(dp->d_devstat, bp);
 212         }
 213         g_destroy_bio(bp);
 214         bp2->bio_inbed++;
 215         if (bp2->bio_children == bp2->bio_inbed) {
 216                 bp2->bio_resid = bp2->bio_bcount - bp2->bio_completed;
 217                 g_io_deliver(bp2, bp2->bio_error);
 218         }
 219         mtx_unlock(&g_disk_done_mtx);
 220 }
 221
 222 static int
 223 g_disk_ioctl(struct g_provider *pp, u_long cmd, void * data, int fflag, struct thread *td)
 224 {
 225         struct g_geom *gp;
 226         struct disk *dp;
 227         int error;
 228
 229         gp = pp->geom;
 230         dp = gp->softc;
 231
 232         if (dp->d_ioctl == NULL)
 233                 return (ENOIOCTL);
 234         g_disk_lock_giant(dp);
 235         error = dp->d_ioctl(dp, cmd, data, fflag, td);
 236         g_disk_unlock_giant(dp);
 237         return(error);
 238 }
 239
 240 static void
 241 g_disk_start(struct bio *bp)
 242 {
 243         struct bio *bp2, *bp3;
 244         struct disk *dp;
 245         int error;
 246         off_t off;
 247
 248         dp = bp->bio_to->geom->softc;
 249         if (dp == NULL || dp->d_destroyed) {
 250                 g_io_deliver(bp, ENXIO);
 251                 return;
 252         }
 253         error = EJUSTRETURN;
 254         switch(bp->bio_cmd) {
 255         case BIO_DELETE:
 256                 if (!(dp->d_flags & DISKFLAG_CANDELETE)) {
 257                         error = 0;
 258                         break;
 259                 }
 260                 /* fall-through */
 261         case BIO_READ:
 262         case BIO_WRITE:
 263                 off = 0;
 264                 bp3 = NULL;
 265                 bp2 = g_clone_bio(bp);
 266                 if (bp2 == NULL) {
 267                         error = ENOMEM;
 268                         break;
 269                 }
 270                 do {
 271                         bp2->bio_offset += off;
 272                         bp2->bio_length -= off;
 273                         bp2->bio_data += off;
 274                         if (bp2->bio_length > dp->d_maxsize) {
 275                                 /*
 276                                  * XXX: If we have a stripesize we should really
 277                                  * use it here.
 278                                  */
 279                                 bp2->bio_length = dp->d_maxsize;
 280                                 off += dp->d_maxsize;
 281                                 /*
 282                                  * To avoid a race, we need to grab the next bio
 283                                  * before we schedule this one.  See "notes".
 284                                  */
 285                                 bp3 = g_clone_bio(bp);
 286                                 if (bp3 == NULL)
 287                                         bp->bio_error = ENOMEM;
 288                         }
 289                         bp2->bio_done = g_disk_done;
 290                         bp2->bio_pblkno = bp2->bio_offset / dp->d_sectorsize;
 291                         bp2->bio_bcount = bp2->bio_length;
 292                         bp2->bio_disk = dp;
 293                         devstat_start_transaction_bio(dp->d_devstat, bp2);
 294                         g_disk_lock_giant(dp);
 295                         dp->d_strategy(bp2);
 296                         g_disk_unlock_giant(dp);
 297                         bp2 = bp3;
 298                         bp3 = NULL;
 299                 } while (bp2 != NULL);
 300                 break;
 301         case BIO_GETATTR:
 302                 if (g_handleattr_int(bp, "GEOM::candelete",
 303                     (dp->d_flags & DISKFLAG_CANDELETE) != 0))
 304                         break;
 305                 else if (g_handleattr_int(bp, "GEOM::fwsectors",
 306                     dp->d_fwsectors))
 307                         break;
 308                 else if (g_handleattr_int(bp, "GEOM::fwheads", dp->d_fwheads))
 309                         break;
 310                 else if (g_handleattr_off_t(bp, "GEOM::frontstuff", 0))
 311                         break;
 312                 else if (g_handleattr_str(bp, "GEOM::ident", dp->d_ident))
 313                         break;
 314                 else if (!strcmp(bp->bio_attribute, "GEOM::kerneldump"))
 315                         g_disk_kerneldump(bp, dp);
 316                 else
 317                         error = ENOIOCTL;
 318                 break;
 319         case BIO_FLUSH:
 320                 g_trace(G_T_TOPOLOGY, "g_disk_flushcache(%s)",
 321                     bp->bio_to->name);
 322                 if (!(dp->d_flags & DISKFLAG_CANFLUSHCACHE)) {
 323                         g_io_deliver(bp, ENODEV);
 324                         return;
 325                 }
 326                 bp2 = g_clone_bio(bp);
 327                 if (bp2 == NULL) {
 328                         g_io_deliver(bp, ENOMEM);
 329                         return;
 330                 }
 331                 bp2->bio_done = g_disk_done;
 332                 bp2->bio_disk = dp;
 333                 g_disk_lock_giant(dp);
 334                 dp->d_strategy(bp2);
 335                 g_disk_unlock_giant(dp);
 336                 break;
 337         default:
 338                 error = EOPNOTSUPP;
 339                 break;
 340         }
 341         if (error != EJUSTRETURN)
 342                 g_io_deliver(bp, error);
 343         return;
 344 }
 345
 346 static void
 347 g_disk_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
 348 {
 349         struct disk *dp;
 350
 351         dp = gp->softc;
 352         if (dp == NULL)
 353                 return;
 354         if (indent == NULL) {
 355                 sbuf_printf(sb, " hd %u", dp->d_fwheads);
 356                 sbuf_printf(sb, " sc %u", dp->d_fwsectors);
 357                 return;
 358         }
 359         if (pp != NULL) {
 360                 sbuf_printf(sb, "%s<fwheads>%u</fwheads>\n",
 361                     indent, dp->d_fwheads);
 362                 sbuf_printf(sb, "%s<fwsectors>%u</fwsectors>\n",
 363                     indent, dp->d_fwsectors);
 364         }
 365 }
 366
 367 static void
 368 g_disk_create(void *arg, int flag)
 369 {
 370         struct g_geom *gp;
 371         struct g_provider *pp;
 372         struct disk *dp;
 373
 374         if (flag == EV_CANCEL)
 375                 return;
 376         g_topology_assert();
 377         dp = arg;
 378         gp = g_new_geomf(&g_disk_class, "%s%d", dp->d_name, dp->d_unit);
 379         gp->softc = dp;
 380         pp = g_new_providerf(gp, "%s", gp->name);
 381         pp->mediasize = dp->d_mediasize;
 382         pp->sectorsize = dp->d_sectorsize;
 383         if (dp->d_flags & DISKFLAG_CANDELETE)
 384                 pp->flags |= G_PF_CANDELETE;
 385         pp->stripeoffset = dp->d_stripeoffset;
 386         pp->stripesize = dp->d_stripesize;
 387         if (bootverbose)
 388                 printf("GEOM: new disk %s\n", gp->name);
 389         dp->d_geom = gp;
 390         g_error_provider(pp, 0);
 391 }
 392
 393 static void
 394 g_disk_destroy(void *ptr, int flag)
 395 {
 396         struct disk *dp;
 397         struct g_geom *gp;
 398
 399         g_topology_assert();
 400         dp = ptr;
 401         gp = dp->d_geom;
 402         if (gp != NULL) {
 403                 gp->softc = NULL;
 404                 g_wither_geom(gp, ENXIO);
 405         }
 406         g_free(dp);
 407 }
 408
 409 /*
 410  * We only allow printable characters in disk ident,
 411  * the rest is converted to 'x<HH>'.
 412  */
 413 static void
 414 g_disk_ident_adjust(char *ident, size_t size)
 415 {
 416         char *p, tmp[4], newid[DISK_IDENT_SIZE];
 417
 418         newid[0] = '\0';
 419         for (p = ident; *p != '\0'; p++) {
 420                 if (isprint(*p)) {
 421                         tmp[0] = *p;
 422                         tmp[1] = '\0';
 423                 } else {
 424                         snprintf(tmp, sizeof(tmp), "x%02hhx",
 425                             *(unsigned char *)p);
 426                 }
 427                 if (strlcat(newid, tmp, sizeof(newid)) >= sizeof(newid))
 428                         break;
 429         }
 430         bzero(ident, size);
 431         strlcpy(ident, newid, size);
 432 }
 433
 434 struct disk *
 435 disk_alloc()
 436 {
 437         struct disk *dp;
 438
 439         dp = g_malloc(sizeof *dp, M_WAITOK | M_ZERO);
 440         return (dp);
 441 }
 442
 443 void
 444 disk_create(struct disk *dp, int version)
 445 {
 446         if (version != DISK_VERSION_00 && version != DISK_VERSION_01) {
 447                 printf("WARNING: Attempt to add disk %s%d %s",
 448                     dp->d_name, dp->d_unit,
 449                     " using incompatible ABI version of disk(9)\n");
 450                 printf("WARNING: Ignoring disk %s%d\n",
 451                     dp->d_name, dp->d_unit);
 452                 return;
 453         }
 454         KASSERT(dp->d_strategy != NULL, ("disk_create need d_strategy"));
 455         KASSERT(dp->d_name != NULL, ("disk_create need d_name"));
 456         KASSERT(*dp->d_name != 0, ("disk_create need d_name"));
 457         KASSERT(strlen(dp->d_name) < SPECNAMELEN - 4, ("disk name too long"));
 458         if (dp->d_devstat == NULL)
 459                 dp->d_devstat = devstat_new_entry(dp->d_name, dp->d_unit,
 460                     dp->d_sectorsize, DEVSTAT_ALL_SUPPORTED,
 461                     DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
 462         dp->d_geom = NULL;
 463         g_disk_ident_adjust(dp->d_ident, sizeof(dp->d_ident));
 464         g_post_event(g_disk_create, dp, M_WAITOK, dp, NULL);
 465 }
 466
 467 void
 468 disk_destroy(struct disk *dp)
 469 {
 470
 471         g_cancel_event(dp);
 472         dp->d_destroyed = 1;
 473         if (dp->d_devstat != NULL)
 474                 devstat_remove_entry(dp->d_devstat);
 475         g_post_event(g_disk_destroy, dp, M_WAITOK, NULL);
 476 }
 477
 478 void
 479 disk_gone(struct disk *dp)
 480 {
 481         struct g_geom *gp;
 482         struct g_provider *pp;
 483
 484         gp = dp->d_geom;
 485         if (gp != NULL)
 486                 LIST_FOREACH(pp, &gp->provider, provider)
 487                         g_wither_provider(pp, ENXIO);
 488 }
 489
 490 static void
 491 g_kern_disks(void *p, int flag __unused)
 492 {
 493         struct sbuf *sb;
 494         struct g_geom *gp;
 495         char *sp;
 496
 497         sb = p;
 498         sp = "";
 499         g_topology_assert();
 500         LIST_FOREACH(gp, &g_disk_class.geom, geom) {
 501                 sbuf_printf(sb, "%s%s", sp, gp->name);
 502                 sp = " ";
 503         }
 504         sbuf_finish(sb);
 505 }
 506
 507 static int
 508 sysctl_disks(SYSCTL_HANDLER_ARGS)
 509 {
 510         int error;
 511         struct sbuf *sb;
 512
 513         sb = sbuf_new_auto();
 514         g_waitfor_event(g_kern_disks, sb, M_WAITOK, NULL);
 515         error = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
 516         sbuf_delete(sb);
 517         return error;
 518 }
 519
 520 SYSCTL_PROC(_kern, OID_AUTO, disks, CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NOLOCK, 0, 0,
 521     sysctl_disks, "A", "names of available disks");
 522