usr/src/boot/sys/boot/common/disk.c

   1 /*-
   2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   3  * Copyright (c) 2012 Andrey V. Elsukov <ae@FreeBSD.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 #include <sys/disk.h>
  30 #include <sys/queue.h>
  31 #include <stand.h>
  32 #include <stdarg.h>
  33 #include <bootstrap.h>
  34 #include <part.h>
  35
  36 #include "disk.h"
  37
  38 #ifdef DISK_DEBUG
  39 # define DEBUG(fmt, args...)    printf("%s: " fmt "\n" , __func__ , ## args)
  40 #else
  41 # define DEBUG(fmt, args...)
  42 #endif
  43
  44 struct open_disk {
  45         struct ptable           *table;
  46         uint64_t                mediasize;
  47         uint64_t                entrysize;
  48         u_int                   sectorsize;
  49 };
  50
  51 struct print_args {
  52         struct disk_devdesc     *dev;
  53         const char              *prefix;
  54         int                     verbose;
  55 };
  56
  57 /* Convert size to a human-readable number. */
  58 static char *
  59 display_size(uint64_t size, u_int sectorsize)
  60 {
  61         static char buf[80];
  62         char unit;
  63
  64         size = size * sectorsize / 1024;
  65         unit = 'K';
  66         if (size >= 10485760000LL) {
  67                 size /= 1073741824;
  68                 unit = 'T';
  69         } else if (size >= 10240000) {
  70                 size /= 1048576;
  71                 unit = 'G';
  72         } else if (size >= 10000) {
  73                 size /= 1024;
  74                 unit = 'M';
  75         }
  76         sprintf(buf, "%ld%cB", (long)size, unit);
  77         return (buf);
  78 }
  79
  80 static int
  81 ptblread(void *d, void *buf, size_t blocks, uint64_t offset)
  82 {
  83         struct disk_devdesc *dev;
  84         struct open_disk *od;
  85
  86         dev = (struct disk_devdesc *)d;
  87         od = (struct open_disk *)dev->d_opendata;
  88
  89         /*
  90          * As the GPT backup partition is located at the end of the disk,
  91          * to avoid reading past disk end, flag bcache not to use RA.
  92          */
  93         return (dev->d_dev->dv_strategy(dev, F_READ | F_NORA , offset,
  94             blocks * od->sectorsize, (char *)buf, NULL));
  95 }
  96
  97 #define PWIDTH  35
  98 static int
  99 ptable_print(void *arg, const char *pname, const struct ptable_entry *part)
 100 {
 101         struct disk_devdesc dev;
 102         struct print_args *pa, bsd;
 103         struct open_disk *od;
 104         struct ptable *table;
 105         char line[80];
 106         int ret = 0;
 107
 108         pa = (struct print_args *)arg;
 109         od = (struct open_disk *)pa->dev->d_opendata;
 110         sprintf(line, "  %s%s: %s", pa->prefix, pname,
 111             parttype2str(part->type));
 112         if (pa->verbose)
 113                 sprintf(line, "%-*s%s", PWIDTH, line,
 114                     display_size(part->end - part->start + 1,
 115                     od->sectorsize));
 116         strcat(line, "\n");
 117         ret = pager_output(line);
 118         if (ret != 0)
 119                 return (ret);
 120         if (part->type == PART_FREEBSD || part->type == PART_SOLARIS2) {
 121                 /* Open slice with BSD or VTOC label */
 122                 dev.d_dev = pa->dev->d_dev;
 123                 dev.d_unit = pa->dev->d_unit;
 124                 dev.d_slice = part->index;
 125                 dev.d_partition = -1;
 126                 if (disk_open(&dev, part->end - part->start + 1,
 127                     od->sectorsize) == 0) {
 128                         table = ptable_open(&dev, part->end - part->start + 1,
 129                             od->sectorsize, ptblread);
 130                         if (table != NULL) {
 131                                 sprintf(line, "  %s%s", pa->prefix, pname);
 132                                 bsd.dev = &dev;
 133                                 bsd.prefix = line;
 134                                 bsd.verbose = pa->verbose;
 135                                 ret = ptable_iterate(table, &bsd, ptable_print);
 136                                 ptable_close(table);
 137                         }
 138                         disk_close(&dev);
 139                 }
 140         }
 141         return (ret);
 142 }
 143 #undef PWIDTH
 144
 145 int
 146 disk_print(struct disk_devdesc *dev, char *prefix, int verbose)
 147 {
 148         struct open_disk *od;
 149         struct print_args pa;
 150
 151         /* Disk should be opened */
 152         od = (struct open_disk *)dev->d_opendata;
 153         pa.dev = dev;
 154         pa.prefix = prefix;
 155         pa.verbose = verbose;
 156         return (ptable_iterate(od->table, &pa, ptable_print));
 157 }
 158
 159 int
 160 disk_read(struct disk_devdesc *dev, void *buf, uint64_t offset, u_int blocks)
 161 {
 162         struct open_disk *od;
 163         int ret;
 164
 165         od = (struct open_disk *)dev->d_opendata;
 166         ret = dev->d_dev->dv_strategy(dev, F_READ, dev->d_offset + offset,
 167             blocks * od->sectorsize, buf, NULL);
 168
 169         return (ret);
 170 }
 171
 172 int
 173 disk_write(struct disk_devdesc *dev, void *buf, uint64_t offset, u_int blocks)
 174 {
 175         struct open_disk *od;
 176         int ret;
 177
 178         od = (struct open_disk *)dev->d_opendata;
 179         ret = dev->d_dev->dv_strategy(dev, F_WRITE, dev->d_offset + offset,
 180             blocks * od->sectorsize, buf, NULL);
 181
 182         return (ret);
 183 }
 184
 185 int
 186 disk_ioctl(struct disk_devdesc *dev, u_long cmd, void *data)
 187 {
 188         struct open_disk *od = dev->d_opendata;
 189
 190         if (od == NULL)
 191                 return (ENOTTY);
 192
 193         switch (cmd) {
 194         case DIOCGSECTORSIZE:
 195                 *(u_int *)data = od->sectorsize;
 196                 break;
 197         case DIOCGMEDIASIZE:
 198                 if (dev->d_offset == 0)
 199                         *(uint64_t *)data = od->mediasize;
 200                 else
 201                         *(uint64_t *)data = od->entrysize * od->sectorsize;
 202                 break;
 203         default:
 204                 return (ENOTTY);
 205         }
 206
 207         return (0);
 208 }
 209
 210 int
 211 disk_open(struct disk_devdesc *dev, uint64_t mediasize, u_int sectorsize)
 212 {
 213         struct open_disk *od;
 214         struct ptable *table;
 215         struct ptable_entry part;
 216         int rc, slice, partition;
 217
 218         rc = 0;
 219         /*
 220          * While we are reading disk metadata, make sure we do it relative
 221          * to the start of the disk
 222          */
 223         dev->d_offset = 0;
 224         table = NULL;
 225         slice = dev->d_slice;
 226         partition = dev->d_partition;
 227         od = (struct open_disk *)malloc(sizeof(struct open_disk));
 228         if (od == NULL) {
 229                 DEBUG("no memory");
 230                 return (ENOMEM);
 231         }
 232         dev->d_opendata = od;
 233         od->entrysize = 0;
 234         od->mediasize = mediasize;
 235         od->sectorsize = sectorsize;
 236         DEBUG("%s unit %d, slice %d, partition %d => %p",
 237             disk_fmtdev(dev), dev->d_unit, dev->d_slice, dev->d_partition, od);
 238
 239         /* Determine disk layout. */
 240         od->table = ptable_open(dev, mediasize / sectorsize, sectorsize,
 241             ptblread);
 242         if (od->table == NULL) {
 243                 DEBUG("Can't read partition table");
 244                 rc = ENXIO;
 245                 goto out;
 246         }
 247
 248         if (ptable_getsize(od->table, &mediasize) != 0) {
 249                 rc = ENXIO;
 250                 goto out;
 251         }
 252         if (mediasize > od->mediasize) {
 253                 od->mediasize = mediasize;
 254         }
 255
 256         if (ptable_gettype(od->table) == PTABLE_BSD &&
 257             partition >= 0) {
 258                 /* It doesn't matter what value has d_slice */
 259                 rc = ptable_getpart(od->table, &part, partition);
 260                 if (rc == 0) {
 261                         dev->d_offset = part.start;
 262                         od->entrysize = part.end - part.start + 1;
 263                 }
 264         } else if (slice >= 0) {
 265                 /* Try to get information about partition */
 266                 if (slice == 0)
 267                         rc = ptable_getbestpart(od->table, &part);
 268                 else
 269                         rc = ptable_getpart(od->table, &part, slice);
 270                 if (rc != 0) /* Partition doesn't exist */
 271                         goto out;
 272                 dev->d_offset = part.start;
 273                 od->entrysize = part.end - part.start + 1;
 274                 slice = part.index;
 275                 if (ptable_gettype(od->table) == PTABLE_GPT) {
 276                         partition = 255;
 277                         goto out; /* Nothing more to do */
 278                 } else if (partition == 255) {
 279                         /*
 280                          * When we try to open GPT partition, but partition
 281                          * table isn't GPT, reset d_partition value to -1
 282                          * and try to autodetect appropriate value.
 283                          */
 284                         partition = -1;
 285                 }
 286                 /*
 287                  * If d_partition < 0 and we are looking at a BSD/VTOC slice,
 288                  * then try to read label, otherwise return the
 289                  * whole MBR slice.
 290                  */
 291                 if (partition == -1 &&
 292                     (part.type != PART_FREEBSD || part.type != PART_SOLARIS2))
 293                         goto out;
 294                 /* Try to read label */
 295                 table = ptable_open(dev, part.end - part.start + 1,
 296                     od->sectorsize, ptblread);
 297                 if (table == NULL) {
 298                         DEBUG("Can't read BSD/VTOC label");
 299                         rc = ENXIO;
 300                         goto out;
 301                 }
 302                 /*
 303                  * If slice contains BSD/VTOC label and d_partition < 0, then
 304                  * assume the 'a' partition. Otherwise just return the
 305                  * whole MBR slice, because it can contain ZFS.
 306                  */
 307                 if (partition < 0) {
 308                         if (ptable_gettype(table) != PTABLE_BSD ||
 309                             ptable_gettype(table) != PTABLE_VTOC)
 310                                 goto out;
 311                         partition = 0;
 312                 }
 313                 rc = ptable_getpart(table, &part, partition);
 314                 if (rc != 0)
 315                         goto out;
 316                 dev->d_offset += part.start;
 317                 od->entrysize = part.end - part.start + 1;
 318         }
 319 out:
 320         if (table != NULL)
 321                 ptable_close(table);
 322
 323         if (rc != 0) {
 324                 if (od->table != NULL)
 325                         ptable_close(od->table);
 326                 free(od);
 327                 DEBUG("%s could not open", disk_fmtdev(dev));
 328         } else {
 329                 /* Save the slice and partition number to the dev */
 330                 dev->d_slice = slice;
 331                 dev->d_partition = partition;
 332                 DEBUG("%s offset %lld => %p", disk_fmtdev(dev),
 333                     (long long)dev->d_offset, od);
 334         }
 335         return (rc);
 336 }
 337
 338 int
 339 disk_close(struct disk_devdesc *dev)
 340 {
 341         struct open_disk *od;
 342
 343         od = (struct open_disk *)dev->d_opendata;
 344         DEBUG("%s closed => %p", disk_fmtdev(dev), od);
 345         ptable_close(od->table);
 346         free(od);
 347         return (0);
 348 }
 349
 350 char*
 351 disk_fmtdev(struct disk_devdesc *dev)
 352 {
 353         static char buf[128];
 354         char *cp;
 355
 356         cp = buf + sprintf(buf, "%s%d", dev->d_dev->dv_name, dev->d_unit);
 357         if (dev->d_slice >= 0) {
 358 #ifdef LOADER_GPT_SUPPORT
 359                 if (dev->d_partition == 255) {
 360                         sprintf(cp, "p%d:", dev->d_slice);
 361                         return (buf);
 362                 } else
 363 #endif
 364 #ifdef LOADER_MBR_SUPPORT
 365                         cp += sprintf(cp, "s%d", dev->d_slice);
 366 #endif
 367         }
 368         if (dev->d_partition >= 0)
 369                 cp += sprintf(cp, "%c", dev->d_partition + 'a');
 370         strcat(cp, ":");
 371         return (buf);
 372 }
 373
 374 int
 375 disk_parsedev(struct disk_devdesc *dev, const char *devspec, const char **path)
 376 {
 377         int unit, slice, partition;
 378         const char *np;
 379         char *cp;
 380
 381         np = devspec;
 382         unit = slice = partition = -1;
 383         if (*np != '\0' && *np != ':') {
 384                 unit = strtol(np, &cp, 10);
 385                 if (cp == np)
 386                         return (EUNIT);
 387 #ifdef LOADER_GPT_SUPPORT
 388                 if (*cp == 'p') {
 389                         np = cp + 1;
 390                         slice = strtol(np, &cp, 10);
 391                         if (np == cp)
 392                                 return (ESLICE);
 393                         /* we don't support nested partitions on GPT */
 394                         if (*cp != '\0' && *cp != ':')
 395                                 return (EINVAL);
 396                         partition = 255;
 397                 } else
 398 #endif
 399 #ifdef LOADER_MBR_SUPPORT
 400                 if (*cp == 's') {
 401                         np = cp + 1;
 402                         slice = strtol(np, &cp, 10);
 403                         if (np == cp)
 404                                 return (ESLICE);
 405                 }
 406 #endif
 407                 if (*cp != '\0' && *cp != ':') {
 408                         partition = *cp - 'a';
 409                         if (partition < 0)
 410                                 return (EPART);
 411                         cp++;
 412                 }
 413         } else
 414                 return (EINVAL);
 415
 416         if (*cp != '\0' && *cp != ':')
 417                 return (EINVAL);
 418         dev->d_unit = unit;
 419         dev->d_slice = slice;
 420         dev->d_partition = partition;
 421         if (path != NULL)
 422                 *path = (*cp == '\0') ? cp: cp + 1;
 423         return (0);
 424 }