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 int argtoi(const char *, int, int, int);
 106 static int set_bell(u_int8_t *, int, int);
 107 static void usage(void);
 108
 109 unsigned vol_id[5];     /* 4 plus 1 for flag */
 110
 111 int v_flag;
 112 /*
 113  * Boot manager installation/configuration utility.
 114  */
 115 int
 116 main(int argc, char *argv[])
 117 {
 118     u_int8_t *mbr, *boot0;
 119     int boot0_size, mbr_size;
 120     const char *bpath, *fpath;
 121     char *disk;
 122     int B_flag, o_flag;
 123     int d_arg, m_arg, s_arg, t_arg;
 124     int o_and, o_or, o_e = -1;
 125     int up, c;
 126
 127     bpath = "/boot/boot0";
 128     fpath = NULL;
 129     B_flag = v_flag = o_flag = 0;
 130     d_arg = m_arg = s_arg = t_arg = -1;
 131     o_and = 0xff;
 132     o_or = 0;
 133     while ((c = getopt(argc, argv, "Bvb:d:e:f:i:m:o:s:t:")) != -1)
 134         switch (c) {
 135         case 'B':
 136             B_flag = 1;
 137             break;
 138         case 'v':
 139             v_flag = 1;
 140             break;
 141         case 'b':
 142             bpath = optarg;
 143             break;
 144         case 'd':
 145             d_arg = argtoi(optarg, 0, 0xff, 'd');
 146             break;
 147         case 'e':
 148             if (optarg[0] == '0' && optarg[1] == 'x')
 149                 sscanf(optarg, "0x%02x", &o_e);
 150             else
 151                 o_e = optarg[0];
 152             break;
 153         case 'f':
 154             fpath = optarg;
 155             break;
 156         case 'i':
 157             if (sscanf(optarg, "%02x%02x-%02x%02x",
 158                 vol_id, vol_id+1, vol_id+2, vol_id+3) == 4)
 159                         vol_id[4] = 1;
 160             else
 161                 errx(1, "bad argument %s", optarg);
 162             break;
 163         case 'm':
 164             m_arg = argtoi(optarg, 0, 0xf, 'm');
 165             break;
 166         case 'o':
 167             stropt(optarg, &o_and, &o_or);
 168             o_flag = 1;
 169             break;
 170         case 's':
 171             if (strcasecmp(optarg, "pxe") == 0)
 172                 s_arg = 6;
 173             else
 174                 s_arg = argtoi(optarg, 1, 6, 's');
 175             break;
 176         case 't':
 177             t_arg = argtoi(optarg, 1, 0xffff, 't');
 178             break;
 179         default:
 180             usage();
 181         }
 182     argc -= optind;
 183     argv += optind;
 184     if (argc != 1)
 185         usage();
 186     disk = g_device_path(*argv);
 187     if (disk == NULL)
 188         errx(1, "Unable to get providername for %s\n", *argv);
 189     up = B_flag || d_arg != -1 || m_arg != -1 || o_flag || s_arg != -1
 190         || t_arg != -1;
 191
 192     /* open the disk and read in the existing mbr. Either here or
 193      * when reading the block from disk, we do check for the version
 194      * and abort if a suitable block is not found.
 195      */
 196     mbr_size = read_mbr(disk, &mbr, !B_flag);
 197
 198     /* save the existing MBR if we are asked to do so */
 199     if (fpath)
 200         write_mbr(fpath, O_CREAT | O_TRUNC, mbr, mbr_size);
 201
 202     /*
 203      * If we are installing the boot loader, read it from disk and copy the
 204      * slice table over from the existing MBR.  If not, then point boot0
 205      * back at the MBR we just read in.  After this, boot0 is the data to
 206      * write back to disk if we are going to do a write.
 207      */
 208     if (B_flag) {
 209         boot0_size = read_mbr(bpath, &boot0, 1);
 210         memcpy(boot0 + OFF_PTBL, mbr + OFF_PTBL,
 211             sizeof(struct dos_partition) * NDOSPART);
 212         if (b0_ver == 2)        /* volume serial number support */
 213             memcpy(boot0 + OFF_SERIAL, mbr + OFF_SERIAL, 4);
 214     } else {
 215         boot0 = mbr;
 216         boot0_size = mbr_size;
 217     }
 218
 219     /* set the drive */
 220     if (d_arg != -1)
 221         boot0[OFF_DRIVE] = d_arg;
 222
 223     /* set various flags */
 224     if (m_arg != -1) {
 225         boot0[OFF_FLAGS] &= 0xf0;
 226         boot0[OFF_FLAGS] |= m_arg;
 227     }
 228     if (o_flag) {
 229         boot0[OFF_FLAGS] &= o_and;
 230         boot0[OFF_FLAGS] |= o_or;
 231     }
 232
 233     /* set the default boot selection */
 234     if (s_arg != -1)
 235         boot0[OFF_OPT] = s_arg - 1;
 236
 237     /* set the timeout */
 238     if (t_arg != -1)
 239         mk2(boot0 + OFF_TICKS, t_arg);
 240
 241     /* set the bell char */
 242     if (o_e != -1 && set_bell(boot0, o_e, 0) != -1)
 243         up = 1;
 244
 245     if (vol_id[4]) {
 246         if (b0_ver != 2)
 247             errx(1, "incompatible boot block, cannot set volume ID");
 248         boot0[OFF_SERIAL] = vol_id[0];
 249         boot0[OFF_SERIAL+1] = vol_id[1];
 250         boot0[OFF_SERIAL+2] = vol_id[2];
 251         boot0[OFF_SERIAL+3] = vol_id[3];
 252         up = 1; /* force update */
 253     }
 254     /* write the MBR back to disk */
 255     if (up)
 256         write_mbr(disk, 0, boot0, boot0_size);
 257
 258     /* display the MBR */
 259     if (v_flag)
 260         display_mbr(boot0);
 261
 262     /* clean up */
 263     if (mbr != boot0)
 264         free(boot0);
 265     free(mbr);
 266     free(disk);
 267
 268     return 0;
 269 }
 270
 271 /* get or set the 'bell' character to be used in case of errors.
 272  * Lookup for a certain code sequence, return -1 if not found.
 273  */
 274 static int
 275 set_bell(u_int8_t *mbr, int new_bell, int report)
 276 {
 277     /* lookup sequence: 0x100 means skip, 0x200 means done */
 278     static unsigned seq[] =
 279                 { 0xb0, 0x100, 0xe8, 0x100, 0x100, 0x30, 0xe4, 0x200 };
 280     int ofs, i, c;
 281     for (ofs = 0x60; ofs < 0x180; ofs++) { /* search range */
 282         if (mbr[ofs] != seq[0]) /* search initial pattern */
 283             continue;
 284         for (i=0;; i++) {
 285             if (seq[i] == 0x200) {      /* found */
 286                 c = mbr[ofs+1];
 287                 if (!report)
 288                     mbr[ofs+1] = c = new_bell;
 289                 else
 290                     printf("  bell=%c (0x%x)",
 291                         (c >= ' ' && c < 0x7f) ? c : ' ', c);
 292                 return c;
 293             }
 294             if (seq[i] != 0x100 && seq[i] != mbr[ofs+i])
 295                 break;
 296         }
 297     }
 298     warn("bell not found");
 299     return -1;
 300 }
 301 /*
 302  * Read in the MBR of the disk.  If it is boot0, then use the version to
 303  * read in all of it if necessary.  Use pointers to return a malloc'd
 304  * buffer containing the MBR and then return its size.
 305  */
 306 static int
 307 read_mbr(const char *disk, u_int8_t **mbr, int check_version)
 308 {
 309     u_int8_t buf[MBRSIZE];
 310     int mbr_size, fd;
 311     int ver;
 312     ssize_t n;
 313
 314     if ((fd = open(disk, O_RDONLY)) == -1)
 315         err(1, "open %s", disk);
 316     if ((n = read(fd, buf, MBRSIZE)) == -1)
 317         err(1, "read %s", disk);
 318     if (n != MBRSIZE)
 319         errx(1, "%s: short read", disk);
 320     if (cv2(buf + OFF_MAGIC) != 0xaa55)
 321         errx(1, "%s: bad magic", disk);
 322
 323     if (! (ver = boot0bs(buf))) {
 324         if (check_version)
 325             errx(1, "%s: unknown or incompatible boot code", disk);
 326     } else if (boot0version(buf) == 0x101) {
 327         mbr_size = 1024;
 328         if ((*mbr = malloc(mbr_size)) == NULL)
 329             errx(1, "%s: unable to allocate read buffer", disk);
 330         if (lseek(fd, 0, SEEK_SET) == -1 ||
 331             (n = read(fd, *mbr, mbr_size)) == -1)
 332             err(1, "%s", disk);
 333         if (n != mbr_size)
 334             errx(1, "%s: short read", disk);
 335         return (mbr_size);
 336     }
 337     *mbr = malloc(sizeof(buf));
 338     memcpy(*mbr, buf, sizeof(buf));
 339
 340     return sizeof(buf);
 341 }
 342
 343 /*
 344  * Write out the mbr to the specified file.
 345  */
 346 static void
 347 write_mbr(const char *fname, int flags, u_int8_t *mbr, int mbr_size)
 348 {
 349     int fd;
 350     ssize_t n;
 351     const char *errmsg;
 352     char *pname;
 353     struct gctl_req *grq;
 354
 355     fd = open(fname, O_WRONLY | flags, 0666);
 356     if (fd != -1) {
 357         n = write(fd, mbr, mbr_size);
 358         close(fd);
 359         if (n != mbr_size)
 360            errx(1, "%s: short write", fname);
 361         return;
 362     }
 363
 364     /*
 365      * If we're called to write to a backup file, don't try to
 366      * write through GEOM. It only generates additional errors.
 367      */
 368     if (flags != 0)
 369         return;
 370
 371     /* Try open it read only. */
 372     fd = open(fname, O_RDONLY);
 373     if (fd == -1) {
 374         warn("error opening %s", fname);
 375         return;
 376     }
 377     pname = g_providername(fd);
 378     if (pname == NULL) {
 379         warn("error getting providername for %s", fname);
 380         return;
 381     }
 382     grq = gctl_get_handle();
 383     gctl_ro_param(grq, "class", -1, "PART");
 384     gctl_ro_param(grq, "arg0", -1, pname);
 385     gctl_ro_param(grq, "verb", -1, "bootcode");
 386     gctl_ro_param(grq, "bootcode", mbr_size, mbr);
 387     gctl_ro_param(grq, "flags", -1, "C");
 388     errmsg = gctl_issue(grq);
 389     if (errmsg == NULL)
 390         goto out;
 391
 392     grq = gctl_get_handle();
 393     gctl_ro_param(grq, "verb", -1, "write MBR");
 394     gctl_ro_param(grq, "class", -1, "MBR");
 395     gctl_ro_param(grq, "geom", -1, pname);
 396     gctl_ro_param(grq, "data", mbr_size, mbr);
 397     errmsg = gctl_issue(grq);
 398     if (errmsg != NULL)
 399         err(1, "write_mbr: %s", fname);
 400
 401 out:
 402     free(pname);
 403     gctl_free(grq);
 404 }
 405
 406 /*
 407  * Outputs an informative dump of the data in the MBR to stdout.
 408  */
 409 static void
 410 display_mbr(u_int8_t *mbr)
 411 {
 412     struct dos_partition *part;
 413     int i, version;
 414
 415     part = (struct dos_partition *)(mbr + DOSPARTOFF);
 416     printf(fmt0);
 417     for (i = 0; i < NDOSPART; i++)
 418         if (part[i].dp_typ)
 419             printf(fmt1, 1 + i, part[i].dp_flag,
 420                 part[i].dp_scyl + ((part[i].dp_ssect & 0xc0) << 2),
 421                 part[i].dp_shd, part[i].dp_ssect & 0x3f, part[i].dp_typ,
 422                 part[i].dp_ecyl + ((part[i].dp_esect & 0xc0) << 2),
 423                 part[i].dp_ehd, part[i].dp_esect & 0x3f, part[i].dp_start,
 424                 part[i].dp_size);
 425     printf("\n");
 426     version = boot0version(mbr);
 427     printf("version=%d.%d  drive=0x%x  mask=0x%x  ticks=%u",
 428         version >> 8, version & 0xff, mbr[OFF_DRIVE],
 429         mbr[OFF_FLAGS] & 0xf, cv2(mbr + OFF_TICKS));
 430     set_bell(mbr, 0, 1);
 431     printf("\noptions=");
 432     for (i = 0; i < nopt; i++) {
 433         if (i)
 434             printf(",");
 435         if (!(mbr[OFF_FLAGS] & 1 << (7 - i)) ^ opttbl[i].def)
 436             printf("no");
 437         printf("%s", opttbl[i].tok);
 438     }
 439     printf("\n");
 440     if (b0_ver == 2)
 441         printf("volume serial ID %02x%02x-%02x%02x\n",
 442                 mbr[OFF_SERIAL], mbr[OFF_SERIAL+1],
 443                 mbr[OFF_SERIAL+2], mbr[OFF_SERIAL+3]);
 444     printf("default_selection=F%d (", mbr[OFF_OPT] + 1);
 445     if (mbr[OFF_OPT] < 4)
 446         printf("Slice %d", mbr[OFF_OPT] + 1);
 447     else if (mbr[OFF_OPT] == 4)
 448         printf("Drive 1");
 449     else
 450         printf("PXE");
 451     printf(")\n");
 452 }
 453
 454 /*
 455  * Return the boot0 version with the minor revision in the low byte, and
 456  * the major revision in the next higher byte.
 457  */
 458 static int
 459 boot0version(const u_int8_t *bs)
 460 {
 461     /* Check for old version, and return 0x100 if found. */
 462     int v = boot0bs(bs);
 463     if (v != 0)
 464         return v << 8;
 465
 466     /* We have a newer boot0, so extract the version number and return it. */
 467     return *(const int *)(bs + OFF_VERSION) & 0xffff;
 468 }
 469
 470 /* descriptor of a pattern to match.
 471  * Start from the first entry trying to match the chunk of bytes,
 472  * if you hit an entry with len=0 terminate the search and report
 473  * off as the version. Otherwise skip to the next block after len=0
 474  * An entry with len=0, off=0 is the end marker.
 475   */
 476 struct byte_pattern {
 477     unsigned off;
 478     unsigned len;
 479     u_int8_t *key;
 480 };
 481
 482 /*
 483  * Decide if we have valid boot0 boot code by looking for
 484  * characteristic byte sequences at fixed offsets.
 485  */
 486 static int
 487 boot0bs(const u_int8_t *bs)
 488 {
 489     /* the initial code sequence */
 490     static u_int8_t id0[] = {0xfc, 0x31, 0xc0, 0x8e, 0xc0, 0x8e, 0xd8,
 491                              0x8e, 0xd0, 0xbc, 0x00, 0x7c };
 492     /* the drive id */
 493     static u_int8_t id1[] = {'D', 'r', 'i', 'v', 'e', ' '};
 494     static struct byte_pattern patterns[] = {
 495         {0x0,   sizeof(id0), id0},
 496         {0x1b2, sizeof(id1), id1},
 497         {1, 0, NULL},
 498         {0x0,   sizeof(id0), id0},      /* version with NT support */
 499         {0x1ae, sizeof(id1), id1},
 500         {2, 0, NULL},
 501         {0, 0, NULL},
 502     };
 503     struct byte_pattern *p = patterns;
 504
 505     for (;  p->off || p->len; p++) {
 506         if (p->len == 0)
 507             break;
 508         if (!memcmp(bs + p->off, p->key, p->len))       /* match */
 509             continue;
 510         while (p->len)  /* skip to next block */
 511             p++;
 512     }
 513     b0_ver = p->off;    /* XXX ugly side effect */
 514     return p->off;
 515 }
 516
 517 /*
 518  * Adjust "and" and "or" masks for a -o option argument.
 519  */
 520 static void
 521 stropt(const char *arg, int *xa, int *xo)
 522 {
 523     const char *q;
 524     char *s, *s1;
 525     int inv, i, x;
 526
 527     if (!(s = strdup(arg)))
 528         err(1, NULL);
 529     for (s1 = s; (q = strtok(s1, ",")); s1 = NULL) {
 530         if ((inv = !strncmp(q, "no", 2)))
 531             q += 2;
 532         for (i = 0; i < nopt; i++)
 533             if (!strcmp(q, opttbl[i].tok))
 534                 break;
 535         if (i == nopt)
 536             errx(1, "%s: Unknown -o option", q);
 537         if (opttbl[i].def)
 538             inv ^= 1;
 539         x = 1 << (7 - i);
 540         if (inv)
 541             *xa &= ~x;
 542         else
 543             *xo |= x;
 544     }
 545     free(s);
 546 }
 547
 548 /*
 549  * Convert and check an option argument.
 550  */
 551 static int
 552 argtoi(const char *arg, int lo, int hi, int opt)
 553 {
 554     char *s;
 555     long x;
 556
 557     errno = 0;
 558     x = strtol(arg, &s, 0);
 559     if (errno || !*arg || *s || x < lo || x > hi)
 560         errx(1, "%s: Bad argument to -%c option", arg, opt);
 561     return x;
 562 }
 563
 564 /*
 565  * Display usage information.
 566  */
 567 static void
 568 usage(void)
 569 {
 570     fprintf(stderr, "%s\n%s\n",
 571     "usage: boot0cfg [-Bv] [-b boot0] [-d drive] [-f file] [-m mask]",
 572     "                [-o options] [-s slice] [-t ticks] disk");
 573     exit(1);
 574 }