usr.sbin/boot0cfg/boot0cfg.c

   1 /*
   2  * Copyright (c) 2008 Luigi Rizzo
   3  * Copyright (c) 1999 Robert Nordier
   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
  18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
  19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  20  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  22  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  24  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  25  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include <sys/param.h>
  32 #include <sys/disklabel.h>
  33 #include <sys/diskmbr.h>
  34 #include <sys/stat.h>
  35
  36 #include <err.h>
  37 #include <errno.h>
  38 #include <fcntl.h>
  39 #include <libgeom.h>
  40 #include <paths.h>
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <unistd.h>
  45
  46 #define MBRSIZE         512     /* master boot record size */
  47
  48 #define OFF_VERSION     0x1b0   /* offset: version number, only boot0version */
  49 #define OFF_SERIAL      0x1b8   /* offset: volume serial number */
  50 #define OFF_PTBL        0x1be   /* offset: partition table */
  51 #define OFF_MAGIC       0x1fe   /* offset: magic number */
  52 /*
  53  * Offsets to the parameters of the 512-byte boot block.
  54  * For historical reasons they are set as macros
  55  */
  56 struct opt_offsets {
  57         int opt;
  58         int drive;
  59         int flags;
  60         int ticks;
  61 };
  62
  63 struct opt_offsets b0_ofs[] = {
  64         { 0x0, 0x0, 0x0, 0x0 },         /* no boot block */
  65         { 0x1b9, 0x1ba, 0x1bb, 0x1bc }, /* original block */
  66         { 0x1b5, 0x1b6, 0x1b7, 0x1bc }, /* NT_SERIAL block */
  67 };
  68
  69 int b0_ver;             /* boot block version set by boot0bs */
  70
  71 #define OFF_OPT         (b0_ofs[b0_ver].opt)    /* default boot option */
  72 #define OFF_DRIVE       (b0_ofs[b0_ver].drive)  /* setdrv drive */
  73 #define OFF_FLAGS       (b0_ofs[b0_ver].flags)  /* option flags */
  74 #define OFF_TICKS       (b0_ofs[b0_ver].ticks)  /* clock ticks */
  75
  76
  77 #define cv2(p)  ((p)[0] | (p)[1] << 010)
  78
  79 #define mk2(p, x)                               \
  80     (p)[0] = (u_int8_t)(x),                     \
  81     (p)[1] = (u_int8_t)((x) >> 010)
  82
  83 static const struct {
  84     const char *tok;
  85     int def;
  86 } opttbl[] = {
  87     {"packet", 0},
  88     {"update", 1},
  89     {"setdrv", 0}
  90 };
  91 static const int nopt = sizeof(opttbl) / sizeof(opttbl[0]);
  92
  93 static const char fmt0[] = "#   flag     start chs   type"
  94     "       end chs       offset         size\n";
  95
  96 static const char fmt1[] = "%d   0x%02x   %4u:%3u:%2u   0x%02x"
  97     "   %4u:%3u:%2u   %10u   %10u\n";
  98
  99 static int read_mbr(const char *, u_int8_t **, int);
 100 static void write_mbr(const char *, int, u_int8_t *, int);
 101 static void display_mbr(u_int8_t *);
 102 static int boot0version(const u_int8_t *);
 103 static int boot0bs(const u_int8_t *);
 104 static void stropt(const char *, int *, int *);
 105 static char *mkrdev(const char *);
 106 static int argtoi(const char *, int, int, int);
 107 static int set_bell(u_int8_t *, int, int);
 108 static void usage(void);
 109
 110 unsigned vol_id[5];     /* 4 plus 1 for flag */
 111
 112 int v_flag;
 113 /*
 114  * Boot manager installation/configuration utility.
 115  */
 116 int
 117 main(int argc, char *argv[])
 118 {
 119     u_int8_t *mbr, *boot0;
 120     int boot0_size, mbr_size;
 121     const char *bpath, *fpath;
 122     char *disk;
 123     int B_flag, o_flag;
 124     int d_arg, m_arg, s_arg, t_arg;
 125     int o_and, o_or, o_e = -1;
 126     int up, c;
 127
 128     bpath = "/boot/boot0";
 129     fpath = NULL;
 130     B_flag = v_flag = o_flag = 0;
 131     d_arg = m_arg = s_arg = t_arg = -1;
 132     o_and = 0xff;
 133     o_or = 0;
 134     while ((c = getopt(argc, argv, "Bvb:d:e:f:i:m:o:s:t:")) != -1)
 135         switch (c) {
 136         case 'B':
 137             B_flag = 1;
 138             break;
 139         case 'v':
 140             v_flag = 1;
 141             break;
 142         case 'b':
 143             bpath = optarg;
 144             break;
 145         case 'd':
 146             d_arg = argtoi(optarg, 0, 0xff, 'd');
 147             break;
 148         case 'e':
 149             if (optarg[0] == '0' && optarg[1] == 'x')
 150                 sscanf(optarg, "0x%02x", &o_e);
 151             else
 152                 o_e = optarg[0];
 153             break;
 154         case 'f':
 155             fpath = optarg;
 156             break;
 157         case 'i':
 158             if (sscanf(optarg, "%02x%02x-%02x%02x",
 159                 vol_id, vol_id+1, vol_id+2, vol_id+3) == 4)
 160                         vol_id[4] = 1;
 161             else
 162                 errx(1, "bad argument %s", optarg);
 163             break;
 164         case 'm':
 165             m_arg = argtoi(optarg, 0, 0xf, 'm');
 166             break;
 167         case 'o':
 168             stropt(optarg, &o_and, &o_or);
 169             o_flag = 1;
 170             break;
 171         case 's':
 172             s_arg = argtoi(optarg, 1, 5, 's');
 173             break;
 174         case 't':
 175             t_arg = argtoi(optarg, 1, 0xffff, 't');
 176             break;
 177         default:
 178             usage();
 179         }
 180     argc -= optind;
 181     argv += optind;
 182     if (argc != 1)
 183         usage();
 184     disk = mkrdev(*argv);
 185     up = B_flag || d_arg != -1 || m_arg != -1 || o_flag || s_arg != -1
 186         || t_arg != -1;
 187
 188     /* open the disk and read in the existing mbr. Either here or
 189      * when reading the block from disk, we do check for the version
 190      * and abort if a suitable block is not found.
 191      */
 192     mbr_size = read_mbr(disk, &mbr, !B_flag);
 193
 194     /* save the existing MBR if we are asked to do so */
 195     if (fpath)
 196         write_mbr(fpath, O_CREAT | O_TRUNC, mbr, mbr_size);
 197
 198     /*
 199      * If we are installing the boot loader, read it from disk and copy the
 200      * slice table over from the existing MBR.  If not, then point boot0
 201      * back at the MBR we just read in.  After this, boot0 is the data to
 202      * write back to disk if we are going to do a write.
 203      */
 204     if (B_flag) {
 205         boot0_size = read_mbr(bpath, &boot0, 1);
 206         memcpy(boot0 + OFF_PTBL, mbr + OFF_PTBL,
 207             sizeof(struct dos_partition) * NDOSPART);
 208         if (b0_ver == 2)        /* volume serial number support */
 209             memcpy(boot0 + OFF_SERIAL, mbr + OFF_SERIAL, 4);
 210     } else {
 211         boot0 = mbr;
 212         boot0_size = mbr_size;
 213     }
 214
 215     /* set the drive */
 216     if (d_arg != -1)
 217         boot0[OFF_DRIVE] = d_arg;
 218
 219     /* set various flags */
 220     if (m_arg != -1) {
 221         boot0[OFF_FLAGS] &= 0xf0;
 222         boot0[OFF_FLAGS] |= m_arg;
 223     }
 224     if (o_flag) {
 225         boot0[OFF_FLAGS] &= o_and;
 226         boot0[OFF_FLAGS] |= o_or;
 227     }
 228
 229     /* set the default boot selection */
 230     if (s_arg != -1)
 231         boot0[OFF_OPT] = s_arg - 1;
 232
 233     /* set the timeout */
 234     if (t_arg != -1)
 235         mk2(boot0 + OFF_TICKS, t_arg);
 236
 237     /* set the bell char */
 238     if (o_e != -1 && set_bell(boot0, o_e, 0) != -1)
 239         up = 1;
 240
 241     if (vol_id[4]) {
 242         if (b0_ver != 2)
 243             errx(1, "incompatible boot block, cannot set volume ID");
 244         boot0[OFF_SERIAL] = vol_id[0];
 245         boot0[OFF_SERIAL+1] = vol_id[1];
 246         boot0[OFF_SERIAL+2] = vol_id[2];
 247         boot0[OFF_SERIAL+3] = vol_id[3];
 248         up = 1; /* force update */
 249     }
 250     /* write the MBR back to disk */
 251     if (up)
 252         write_mbr(disk, 0, boot0, boot0_size);
 253
 254     /* display the MBR */
 255     if (v_flag)
 256         display_mbr(boot0);
 257
 258     /* clean up */
 259     if (mbr != boot0)
 260         free(boot0);
 261     free(mbr);
 262     free(disk);
 263
 264     return 0;
 265 }
 266
 267 /* get or set the 'bell' character to be used in case of errors.
 268  * Lookup for a certain code sequence, return -1 if not found.
 269  */
 270 static int
 271 set_bell(u_int8_t *mbr, int new_bell, int report)
 272 {
 273     /* lookup sequence: 0x100 means skip, 0x200 means done */
 274     static unsigned seq[] =
 275                 { 0xb0, 0x100, 0xe8, 0x100, 0x100, 0x30, 0xe4, 0x200 };
 276     int ofs, i, c;
 277     for (ofs = 0x60; ofs < 0x180; ofs++) { /* search range */
 278         if (mbr[ofs] != seq[0]) /* search initial pattern */
 279             continue;
 280         for (i=0;; i++) {
 281             if (seq[i] == 0x200) {      /* found */
 282                 c = mbr[ofs+1];
 283                 if (!report)
 284                     mbr[ofs+1] = c = new_bell;
 285                 else
 286                     printf("  bell=%c (0x%x)",
 287                         (c >= ' ' && c < 0x7f) ? c : ' ', c);
 288                 return c;
 289             }
 290             if (seq[i] != 0x100 && seq[i] != mbr[ofs+i])
 291                 break;
 292         }
 293     }
 294     warn("bell not found");
 295     return -1;
 296 }
 297 /*
 298  * Read in the MBR of the disk.  If it is boot0, then use the version to
 299  * read in all of it if necessary.  Use pointers to return a malloc'd
 300  * buffer containing the MBR and then return its size.
 301  */
 302 static int
 303 read_mbr(const char *disk, u_int8_t **mbr, int check_version)
 304 {
 305     u_int8_t buf[MBRSIZE];
 306     int mbr_size, fd;
 307     int ver;
 308     ssize_t n;
 309
 310     if ((fd = open(disk, O_RDONLY)) == -1)
 311         err(1, "open %s", disk);
 312     if ((n = read(fd, buf, MBRSIZE)) == -1)
 313         err(1, "read %s", disk);
 314     if (n != MBRSIZE)
 315         errx(1, "%s: short read", disk);
 316     if (cv2(buf + OFF_MAGIC) != 0xaa55)
 317         errx(1, "%s: bad magic", disk);
 318
 319     if (! (ver = boot0bs(buf))) {
 320         if (check_version)
 321             errx(1, "%s: unknown or incompatible boot code", disk);
 322     } else if (boot0version(buf) == 0x101) {
 323         mbr_size = 1024;
 324         if ((*mbr = malloc(mbr_size)) == NULL)
 325             errx(1, "%s: unable to allocate read buffer", disk);
 326         if (lseek(fd, 0, SEEK_SET) == -1 ||
 327             (n = read(fd, *mbr, mbr_size)) == -1)
 328             err(1, "%s", disk);
 329         if (n != mbr_size)
 330             errx(1, "%s: short read", disk);
 331         return (mbr_size);
 332     }
 333     *mbr = malloc(sizeof(buf));
 334     memcpy(*mbr, buf, sizeof(buf));
 335
 336     return sizeof(buf);
 337 }
 338
 339 /*
 340  * Write out the mbr to the specified file.
 341  */
 342 static void
 343 write_mbr(const char *fname, int flags, u_int8_t *mbr, int mbr_size)
 344 {
 345     int fd, p;
 346     ssize_t n;
 347     char *s;
 348     const char *q;
 349     struct gctl_req *grq;
 350
 351     fd = open(fname, O_WRONLY | flags, 0666);
 352     if (fd != -1) {
 353         n = write(fd, mbr, mbr_size);
 354         close(fd);
 355         if (n != mbr_size)
 356            errx(1, "%s: short write", fname);
 357         return;
 358     }
 359
 360     if (flags != 0)
 361         err(1, "%s", fname);
 362     grq = gctl_get_handle();
 363     gctl_ro_param(grq, "verb", -1, "write MBR");
 364     gctl_ro_param(grq, "class", -1, "MBR");
 365     q = strrchr(fname, '/');
 366     if (q == NULL)
 367         q = fname;
 368     else
 369         q++;
 370     gctl_ro_param(grq, "geom", -1, q);
 371     gctl_ro_param(grq, "data", mbr_size, mbr);
 372     q = gctl_issue(grq);
 373     if (q == NULL)
 374         return;
 375
 376     warnx("%s: %s", fname, q);
 377     gctl_free(grq);
 378
 379 #ifdef DIOCSMBR
 380     for (p = 1; p < 5; p++) {
 381         asprintf(&s, "%ss%d", fname, p);
 382         fd = open(s, O_RDONLY);
 383         if (fd < 0) {
 384             free(s);
 385             continue;
 386         }
 387         n = ioctl(fd, DIOCSMBR, (mbr));
 388         if (n != 0)
 389            err(1, "%s: ioctl DIOCSMBR", fname);
 390         close(fd);
 391         free(s);
 392         return;
 393     }
 394 #endif
 395     err(1, "write_mbr: %s", fname);
 396 }
 397
 398 /*
 399  * Outputs an informative dump of the data in the MBR to stdout.
 400  */
 401 static void
 402 display_mbr(u_int8_t *mbr)
 403 {
 404     struct dos_partition *part;
 405     int i, version;
 406
 407     part = (struct dos_partition *)(mbr + DOSPARTOFF);
 408     printf(fmt0);
 409     for (i = 0; i < NDOSPART; i++)
 410         if (part[i].dp_typ)
 411             printf(fmt1, 1 + i, part[i].dp_flag,
 412                 part[i].dp_scyl + ((part[i].dp_ssect & 0xc0) << 2),
 413                 part[i].dp_shd, part[i].dp_ssect & 0x3f, part[i].dp_typ,
 414                 part[i].dp_ecyl + ((part[i].dp_esect & 0xc0) << 2),
 415                 part[i].dp_ehd, part[i].dp_esect & 0x3f, part[i].dp_start,
 416                 part[i].dp_size);
 417     printf("\n");
 418     version = boot0version(mbr);
 419     printf("version=%d.%d  drive=0x%x  mask=0x%x  ticks=%u",
 420         version >> 8, version & 0xff, mbr[OFF_DRIVE],
 421         mbr[OFF_FLAGS] & 0xf, cv2(mbr + OFF_TICKS));
 422     set_bell(mbr, 0, 1);
 423     printf("\noptions=");
 424     for (i = 0; i < nopt; i++) {
 425         if (i)
 426             printf(",");
 427         if (!(mbr[OFF_FLAGS] & 1 << (7 - i)) ^ opttbl[i].def)
 428             printf("no");
 429         printf("%s", opttbl[i].tok);
 430     }
 431     printf("\n");
 432     if (b0_ver == 2)
 433         printf("volume serial ID %02x%02x-%02x%02x\n",
 434                 mbr[OFF_SERIAL], mbr[OFF_SERIAL+1],
 435                 mbr[OFF_SERIAL+2], mbr[OFF_SERIAL+3]);
 436     printf("default_selection=F%d (", mbr[OFF_OPT] + 1);
 437     if (mbr[OFF_OPT] < 4)
 438         printf("Slice %d", mbr[OFF_OPT] + 1);
 439     else
 440         printf("Drive 1");
 441     printf(")\n");
 442 }
 443
 444 /*
 445  * Return the boot0 version with the minor revision in the low byte, and
 446  * the major revision in the next higher byte.
 447  */
 448 static int
 449 boot0version(const u_int8_t *bs)
 450 {
 451     /* Check for old version, and return 0x100 if found. */
 452     int v = boot0bs(bs);
 453     if (v != 0)
 454         return v << 8;
 455
 456     /* We have a newer boot0, so extract the version number and return it. */
 457     return *(const int *)(bs + OFF_VERSION) & 0xffff;
 458 }
 459
 460 /* descriptor of a pattern to match.
 461  * Start from the first entry trying to match the chunk of bytes,
 462  * if you hit an entry with len=0 terminate the search and report
 463  * off as the version. Otherwise skip to the next block after len=0
 464  * An entry with len=0, off=0 is the end marker.
 465   */
 466 struct byte_pattern {
 467     unsigned off;
 468     unsigned len;
 469     u_int8_t *key;
 470 };
 471
 472 /*
 473  * Decide if we have valid boot0 boot code by looking for
 474  * characteristic byte sequences at fixed offsets.
 475  */
 476 static int
 477 boot0bs(const u_int8_t *bs)
 478 {
 479     /* the initial code sequence */
 480     static u_int8_t id0[] = {0xfc, 0x31, 0xc0, 0x8e, 0xc0, 0x8e, 0xd8,
 481                              0x8e, 0xd0, 0xbc, 0x00, 0x7c };
 482     /* the drive id */
 483     static u_int8_t id1[] = {'D', 'r', 'i', 'v', 'e', ' '};
 484     static struct byte_pattern patterns[] = {
 485         {0x0,   sizeof(id0), id0},
 486         {0x1b2, sizeof(id1), id1},
 487         {1, 0, NULL},
 488         {0x0,   sizeof(id0), id0},      /* version with NT support */
 489         {0x1ae, sizeof(id1), id1},
 490         {2, 0, NULL},
 491         {0, 0, NULL},
 492     };
 493     struct byte_pattern *p = patterns;
 494
 495     for (;  p->off || p->len; p++) {
 496         if (p->len == 0)
 497             break;
 498         if (!memcmp(bs + p->off, p->key, p->len))       /* match */
 499             continue;
 500         while (p->len)  /* skip to next block */
 501             p++;
 502     }
 503     b0_ver = p->off;    /* XXX ugly side effect */
 504     return p->off;
 505 }
 506
 507 /*
 508  * Adjust "and" and "or" masks for a -o option argument.
 509  */
 510 static void
 511 stropt(const char *arg, int *xa, int *xo)
 512 {
 513     const char *q;
 514     char *s, *s1;
 515     int inv, i, x;
 516
 517     if (!(s = strdup(arg)))
 518         err(1, NULL);
 519     for (s1 = s; (q = strtok(s1, ",")); s1 = NULL) {
 520         if ((inv = !strncmp(q, "no", 2)))
 521             q += 2;
 522         for (i = 0; i < nopt; i++)
 523             if (!strcmp(q, opttbl[i].tok))
 524                 break;
 525         if (i == nopt)
 526             errx(1, "%s: Unknown -o option", q);
 527         if (opttbl[i].def)
 528             inv ^= 1;
 529         x = 1 << (7 - i);
 530         if (inv)
 531             *xa &= ~x;
 532         else
 533             *xo |= x;
 534     }
 535     free(s);
 536 }
 537
 538 /*
 539  * Produce a device path for a "canonical" name, where appropriate.
 540  */
 541 static char *
 542 mkrdev(const char *fname)
 543 {
 544     char buf[MAXPATHLEN];
 545     char *s;
 546
 547     if (!strchr(fname, '/')) {
 548         snprintf(buf, sizeof(buf), "%s%s", _PATH_DEV, fname);
 549         s = strdup(buf);
 550     } else
 551         s = strdup(fname);
 552
 553     if (s == NULL)
 554         errx(1, "No more memory");
 555     return s;
 556 }
 557
 558 /*
 559  * Convert and check an option argument.
 560  */
 561 static int
 562 argtoi(const char *arg, int lo, int hi, int opt)
 563 {
 564     char *s;
 565     long x;
 566
 567     errno = 0;
 568     x = strtol(arg, &s, 0);
 569     if (errno || !*arg || *s || x < lo || x > hi)
 570         errx(1, "%s: Bad argument to -%c option", arg, opt);
 571     return x;
 572 }
 573
 574 /*
 575  * Display usage information.
 576  */
 577 static void
 578 usage(void)
 579 {
 580     fprintf(stderr, "%s\n%s\n",
 581     "usage: boot0cfg [-Bv] [-b boot0] [-d drive] [-f file] [-m mask]",
 582     "                [-o options] [-s slice] [-t ticks] disk");
 583     exit(1);
 584 }