usr.sbin/boot0cfg/boot0cfg.c

   1 /*
   2  * Copyright (c) 1999 Robert Nordier
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
  18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  19  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  20  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  21  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef lint
  28 static const char rcsid[] =
  29   "$FreeBSD: src/usr.sbin/boot0cfg/boot0cfg.c,v 1.7.2.4 2002/03/16 01:06:51 mikeh Exp $";
  30 #endif /* not lint */
  31
  32 #include <sys/param.h>
  33 #include <sys/disklabel.h>
  34 #include <sys/stat.h>
  35
  36 #include <err.h>
  37 #include <errno.h>
  38 #include <fcntl.h>
  39 #include <paths.h>
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <unistd.h>
  44
  45 #define MBRSIZE         512     /* master boot record size */
  46
  47 #define OFF_VERSION     0x1b0   /* offset: version number */
  48 #define OFF_OPT         0x1b9   /* offset: default boot option */
  49 #define OFF_DRIVE       0x1ba   /* offset: setdrv drive */
  50 #define OFF_FLAGS       0x1bb   /* offset: option flags */
  51 #define OFF_TICKS       0x1bc   /* offset: clock ticks */
  52 #define OFF_PTBL        0x1be   /* offset: partition table */
  53 #define OFF_MAGIC       0x1fe   /* offset: magic number */
  54
  55 #define cv2(p)  ((p)[0] | (p)[1] << 010)
  56
  57 #define mk2(p, x)                               \
  58     (p)[0] = (u_int8_t)(x),                     \
  59     (p)[1] = (u_int8_t)((x) >> 010)
  60
  61 static const struct {
  62     const char *tok;
  63     int def;
  64 } opttbl[] = {
  65     {"packet", 0},
  66     {"update", 1},
  67     {"setdrv", 0}
  68 };
  69 static const int nopt = sizeof(opttbl) / sizeof(opttbl[0]);
  70
  71 static const char fmt0[] = "#   flag     start chs   type"
  72     "       end chs       offset         size\n";
  73
  74 static const char fmt1[] = "%d   0x%02x   %4u:%3u:%2u   0x%02x"
  75     "   %4u:%3u:%2u   %10u   %10u\n";
  76
  77 static int read_mbr(const char *, u_int8_t **, int);
  78 static void write_mbr(const char *, int, u_int8_t *, int);
  79 static void display_mbr(u_int8_t *);
  80 static int boot0version(const u_int8_t *);
  81 static int boot0bs(const u_int8_t *);
  82 static void stropt(const char *, int *, int *);
  83 static char *mkrdev(const char *);
  84 static int argtoi(const char *, int, int, int);
  85 static void usage(void);
  86
  87 /*
  88  * Boot manager installation/configuration utility.
  89  */
  90 int
  91 main(int argc, char *argv[])
  92 {
  93     u_int8_t *mbr, *boot0;
  94     int boot0_size, mbr_size;
  95     const char *bpath, *fpath;
  96     char *disk;
  97     int B_flag, v_flag, o_flag;
  98     int d_arg, m_arg, s_arg, t_arg;
  99     int o_and, o_or;
 100     int up, c;
 101
 102     bpath = "/boot/boot0";
 103     fpath = NULL;
 104     B_flag = v_flag = o_flag = 0;
 105     d_arg = m_arg = s_arg = t_arg = -1;
 106     o_and = 0xff;
 107     o_or = 0;
 108     while ((c = getopt(argc, argv, "Bvb:d:f:m:o:s:t:")) != -1)
 109         switch (c) {
 110         case 'B':
 111             B_flag = 1;
 112             break;
 113         case 'v':
 114             v_flag = 1;
 115             break;
 116         case 'b':
 117             bpath = optarg;
 118             break;
 119         case 'd':
 120             d_arg = argtoi(optarg, 0, 0xff, 'd');
 121             break;
 122         case 'f':
 123             fpath = optarg;
 124             break;
 125         case 'm':
 126             m_arg = argtoi(optarg, 0, 0xf, 'm');
 127             break;
 128         case 'o':
 129             stropt(optarg, &o_and, &o_or);
 130             o_flag = 1;
 131             break;
 132         case 's':
 133             s_arg = argtoi(optarg, 1, 5, 's');
 134             break;
 135         case 't':
 136             t_arg = argtoi(optarg, 1, 0xffff, 't');
 137             break;
 138         default:
 139             usage();
 140         }
 141     argc -= optind;
 142     argv += optind;
 143     if (argc != 1)
 144         usage();
 145     disk = mkrdev(*argv);
 146     up = B_flag || d_arg != -1 || m_arg != -1 || o_flag || s_arg != -1
 147         || t_arg != -1;
 148
 149     /* open the disk and read in the existing mbr */
 150     mbr_size = read_mbr(disk, &mbr, !B_flag);
 151
 152     /* save the existing MBR if we are asked to do so */
 153     if (fpath)
 154         write_mbr(fpath, O_CREAT | O_TRUNC, mbr, mbr_size);
 155
 156     /*
 157      * If we are installing the boot loader, read it from disk and copy the
 158      * slice table over from the existing MBR.  If not, then point boot0
 159      * back at the MBR we just read in.  After this, boot0 is the data to
 160      * write back to disk if we are going to do a write.
 161      */
 162     if (B_flag) {
 163         boot0_size = read_mbr(bpath, &boot0, 1);
 164         memcpy(boot0 + OFF_PTBL, mbr + OFF_PTBL,
 165             sizeof(struct dos_partition) * NDOSPART);
 166     } else {
 167         boot0 = mbr;
 168         boot0_size = mbr_size;
 169     }
 170
 171     /* set the drive */
 172     if (d_arg != -1)
 173         boot0[OFF_DRIVE] = d_arg;
 174
 175     /* set various flags */
 176     if (m_arg != -1) {
 177         boot0[OFF_FLAGS] &= 0xf0;
 178         boot0[OFF_FLAGS] |= m_arg;
 179     }
 180     if (o_flag) {
 181         boot0[OFF_FLAGS] &= o_and;
 182         boot0[OFF_FLAGS] |= o_or;
 183     }
 184
 185     /* set the default boot selection */
 186     if (s_arg != -1)
 187         boot0[OFF_OPT] = s_arg - 1;
 188
 189     /* set the timeout */
 190     if (t_arg != -1)
 191         mk2(boot0 + OFF_TICKS, t_arg);
 192
 193     /* write the MBR back to disk */
 194     if (up)
 195         write_mbr(disk, 0, boot0, boot0_size);
 196
 197     /* display the MBR */
 198     if (v_flag)
 199         display_mbr(boot0);
 200
 201     /* clean up */
 202     if (mbr != boot0)
 203         free(boot0);
 204     free(mbr);
 205     free(disk);
 206
 207     return 0;
 208 }
 209
 210 /*
 211  * Read in the MBR of the disk.  If it is boot0, then use the version to
 212  * read in all of it if necessary.  Use pointers to return a malloc'd
 213  * buffer containing the MBR and then return its size.
 214  */
 215 static int
 216 read_mbr(const char *disk, u_int8_t **mbr, int check_version)
 217 {
 218     u_int8_t buf[MBRSIZE];
 219     int mbr_size, fd;
 220     ssize_t n;
 221
 222     if ((fd = open(disk, O_RDONLY)) == -1)
 223         err(1, "%s", disk);
 224     if ((n = read(fd, buf, MBRSIZE)) == -1)
 225         err(1, "%s", disk);
 226     if (n != MBRSIZE)
 227         errx(1, "%s: short read", disk);
 228     if (cv2(buf + OFF_MAGIC) != 0xaa55)
 229         errx(1, "%s: bad magic", disk);
 230
 231     if (!boot0bs(buf)) {
 232         if (check_version)
 233             errx(1, "%s: unknown or incompatible boot code", disk);
 234     } else if (boot0version(buf) == 0x101) {
 235         mbr_size = 1024;
 236         if ((*mbr = malloc(mbr_size)) == NULL)
 237             errx(1, "%s: unable to allocate read buffer", disk);
 238         if (lseek(fd, 0, SEEK_SET) == -1 ||
 239             (n = read(fd, *mbr, mbr_size)) == -1)
 240             err(1, "%s", disk);
 241         if (n != mbr_size)
 242             errx(1, "%s: short read", disk);
 243         return (mbr_size);
 244     }
 245     *mbr = malloc(sizeof(buf));
 246     memcpy(*mbr, buf, sizeof(buf));
 247
 248     return sizeof(buf);
 249 }
 250
 251 /*
 252  * Write out the mbr to the specified file.
 253  */
 254 static void
 255 write_mbr(const char *fname, int flags, u_int8_t *mbr, int mbr_size)
 256 {
 257     int fd;
 258     ssize_t n;
 259
 260     if ((fd = open(fname, O_WRONLY | flags, 0666)) == -1 ||
 261         (n = write(fd, mbr, mbr_size)) == -1 || close(fd))
 262         err(1, "%s", fname);
 263     if (n != mbr_size)
 264         errx(1, "%s: short write", fname);
 265 }
 266
 267 /*
 268  * Outputs an informative dump of the data in the MBR to stdout.
 269  */
 270 static void
 271 display_mbr(u_int8_t *mbr)
 272 {
 273     struct dos_partition *part;
 274     int i, version;
 275
 276     part = (struct dos_partition *)(mbr + DOSPARTOFF);
 277     printf(fmt0);
 278     for (i = 0; i < NDOSPART; i++)
 279         if (part[i].dp_typ)
 280             printf(fmt1, 1 + i, part[i].dp_flag,
 281                 part[i].dp_scyl + ((part[i].dp_ssect & 0xc0) << 2),
 282                 part[i].dp_shd, part[i].dp_ssect & 0x3f, part[i].dp_typ,
 283                 part[i].dp_ecyl + ((part[i].dp_esect & 0xc0) << 2),
 284                 part[i].dp_ehd, part[i].dp_esect & 0x3f, part[i].dp_start,
 285                 part[i].dp_size);
 286     printf("\n");
 287     version = boot0version(mbr);
 288     printf("version=%d.%d  drive=0x%x  mask=0x%x  ticks=%u\noptions=",
 289         version >> 8, version & 0xff, mbr[OFF_DRIVE],
 290         mbr[OFF_FLAGS] & 0xf, cv2(mbr + OFF_TICKS));
 291     for (i = 0; i < nopt; i++) {
 292         if (i)
 293             printf(",");
 294         if (!(mbr[OFF_FLAGS] & 1 << (7 - i)) ^ opttbl[i].def)
 295             printf("no");
 296         printf("%s", opttbl[i].tok);
 297     }
 298     printf("\n");
 299     printf("default_selection=F%d (", mbr[OFF_OPT] + 1);
 300     if (mbr[OFF_OPT] < 4)
 301         printf("Slice %d", mbr[OFF_OPT] + 1);
 302     else
 303         printf("Drive 1");
 304     printf(")\n");
 305 }
 306
 307 /*
 308  * Return the boot0 version with the minor revision in the low byte, and
 309  * the major revision in the next higher byte.
 310  */
 311 static int
 312 boot0version(const u_int8_t *bs)
 313 {
 314     static u_int8_t idold[] = {0xfe, 0x45, 0xf2, 0xe9, 0x00, 0x8a};
 315
 316     /* Check for old version, and return 0x100 if found. */
 317     if (memcmp(bs + 0x1c, idold, sizeof(idold)) == 0)
 318         return 0x100;
 319
 320     /* We have a newer boot0, so extract the version number and return it. */
 321     return *(const int *)(bs + OFF_VERSION) & 0xffff;
 322 }
 323
 324 /*
 325  * Decide if we have valid boot0 boot code by looking for
 326  * characteristic byte sequences at fixed offsets.
 327  */
 328 static int
 329 boot0bs(const u_int8_t *bs)
 330 {
 331     static u_int8_t id0[] = {0xfc, 0x31, 0xc0, 0x8e, 0xc0, 0x8e, 0xd8,
 332                              0x8e, 0xd0, 0xbc, 0x00, 0x7c };
 333     static u_int8_t id1[] = {'D', 'r', 'i', 'v', 'e', ' '};
 334     static struct {
 335         unsigned off;
 336         unsigned len;
 337         u_int8_t *key;
 338     } ident[2] = {
 339         {0x0,   sizeof(id0), id0},
 340         {0x1b2, sizeof(id1), id1}
 341     };
 342     unsigned int i;
 343
 344     for (i = 0; i < sizeof(ident) / sizeof(ident[0]); i++)
 345         if (memcmp(bs + ident[i].off, ident[i].key, ident[i].len))
 346             return 0;
 347     return 1;
 348 };
 349
 350 /*
 351  * Adjust "and" and "or" masks for a -o option argument.
 352  */
 353 static void
 354 stropt(const char *arg, int *xa, int *xo)
 355 {
 356     const char *q;
 357     char *s, *s1;
 358     int inv, i, x;
 359
 360     if (!(s = strdup(arg)))
 361         err(1, NULL);
 362     for (s1 = s; (q = strtok(s1, ",")); s1 = NULL) {
 363         if ((inv = !strncmp(q, "no", 2)))
 364             q += 2;
 365         for (i = 0; i < nopt; i++)
 366             if (!strcmp(q, opttbl[i].tok))
 367                 break;
 368         if (i == nopt)
 369             errx(1, "%s: Unknown -o option", q);
 370         if (opttbl[i].def)
 371             inv ^= 1;
 372         x = 1 << (7 - i);
 373         if (inv)
 374             *xa &= ~x;
 375         else
 376             *xo |= x;
 377     }
 378     free(s);
 379 }
 380
 381 /*
 382  * Produce a device path for a "canonical" name, where appropriate.
 383  */
 384 static char *
 385 mkrdev(const char *fname)
 386 {
 387     char buf[MAXPATHLEN];
 388     char *s;
 389
 390     if (!strchr(fname, '/')) {
 391         snprintf(buf, sizeof(buf), "%s%s", _PATH_DEV, fname);
 392         s = strdup(buf);
 393     } else
 394         s = strdup(fname);
 395
 396     if (s == NULL)
 397         errx(1, "No more memory");
 398     return s;
 399 }
 400
 401 /*
 402  * Convert and check an option argument.
 403  */
 404 static int
 405 argtoi(const char *arg, int lo, int hi, int opt)
 406 {
 407     char *s;
 408     long x;
 409
 410     errno = 0;
 411     x = strtol(arg, &s, 0);
 412     if (errno || !*arg || *s || x < lo || x > hi)
 413         errx(1, "%s: Bad argument to -%c option", arg, opt);
 414     return x;
 415 }
 416
 417 /*
 418  * Display usage information.
 419  */
 420 static void
 421 usage(void)
 422 {
 423     fprintf(stderr, "%s\n%s\n",
 424     "usage: boot0cfg [-Bv] [-b boot0] [-d drive] [-f file] [-m mask]",
 425     "                [-o options] [-s slice] [-t ticks] disk");
 426     exit(1);
 427 }