2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008 Luigi Rizzo
5 * Copyright (c) 1999 Robert Nordier
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
22 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/disklabel.h>
35 #include <sys/diskmbr.h>
48 #define MBRSIZE 512 /* master boot record size */
50 #define OFF_VERSION 0x1b0 /* offset: version number, only boot0version */
51 #define OFF_SERIAL 0x1b8 /* offset: volume serial number */
52 #define OFF_PTBL 0x1be /* offset: partition table */
53 #define OFF_MAGIC 0x1fe /* offset: magic number */
55 * Offsets to the parameters of the 512-byte boot block.
56 * For historical reasons they are set as macros
65 static struct opt_offsets b0_ofs[] = {
66 { 0x0, 0x0, 0x0, 0x0 }, /* no boot block */
67 { 0x1b9, 0x1ba, 0x1bb, 0x1bc }, /* original block */
68 { 0x1b5, 0x1b6, 0x1b7, 0x1bc }, /* NT_SERIAL block */
71 static int b0_ver; /* boot block version set by boot0bs */
73 #define OFF_OPT (b0_ofs[b0_ver].opt) /* default boot option */
74 #define OFF_DRIVE (b0_ofs[b0_ver].drive) /* setdrv drive */
75 #define OFF_FLAGS (b0_ofs[b0_ver].flags) /* option flags */
76 #define OFF_TICKS (b0_ofs[b0_ver].ticks) /* clock ticks */
79 #define cv2(p) ((p)[0] | (p)[1] << 010)
82 (p)[0] = (u_int8_t)(x), \
83 (p)[1] = (u_int8_t)((x) >> 010)
93 static const int nopt = nitems(opttbl);
95 static const char fmt0[] = "# flag start chs type"
96 " end chs offset size\n";
98 static const char fmt1[] = "%d 0x%02x %4u:%3u:%2u 0x%02x"
99 " %4u:%3u:%2u %10u %10u\n";
101 static int geom_class_available(const char *);
102 static int read_mbr(const char *, u_int8_t **, int);
103 static void write_mbr(const char *, int, u_int8_t *, int, int);
104 static void display_mbr(u_int8_t *);
105 static int boot0version(const u_int8_t *);
106 static int boot0bs(const u_int8_t *);
107 static void stropt(const char *, int *, int *);
108 static int argtoi(const char *, int, int, int);
109 static int set_bell(u_int8_t *, int, int);
110 static void usage(void);
112 static unsigned vol_id[5]; /* 4 plus 1 for flag */
116 * Boot manager installation/configuration utility.
119 main(int argc, char *argv[])
121 u_int8_t *mbr, *boot0;
122 int boot0_size, mbr_size;
123 const char *bpath, *fpath;
126 int d_arg, m_arg, s_arg, t_arg;
127 int o_and, o_or, o_e = -1;
130 bpath = "/boot/boot0";
132 B_flag = v_flag = o_flag = 0;
133 d_arg = m_arg = s_arg = t_arg = -1;
136 while ((c = getopt(argc, argv, "Bvb:d:e:f:i:m:o:s:t:")) != -1)
148 d_arg = argtoi(optarg, 0, 0xff, 'd');
151 if (optarg[0] == '0' && optarg[1] == 'x')
152 sscanf(optarg, "0x%02x", &o_e);
160 if (sscanf(optarg, "%02x%02x-%02x%02x",
161 vol_id, vol_id+1, vol_id+2, vol_id+3) == 4)
164 errx(1, "bad argument %s", optarg);
167 m_arg = argtoi(optarg, 0, 0xf, 'm');
170 stropt(optarg, &o_and, &o_or);
174 if (strcasecmp(optarg, "pxe") == 0)
177 s_arg = argtoi(optarg, 1, 6, 's');
180 t_arg = argtoi(optarg, 1, 0xffff, 't');
189 disk = g_device_path(*argv);
191 errx(1, "Unable to get providername for %s\n", *argv);
192 up = B_flag || d_arg != -1 || m_arg != -1 || o_flag || s_arg != -1
195 /* open the disk and read in the existing mbr. Either here or
196 * when reading the block from disk, we do check for the version
197 * and abort if a suitable block is not found.
199 mbr_size = read_mbr(disk, &mbr, !B_flag);
201 /* save the existing MBR if we are asked to do so */
203 write_mbr(fpath, O_CREAT | O_TRUNC, mbr, mbr_size, 0);
206 * If we are installing the boot loader, read it from disk and copy the
207 * slice table over from the existing MBR. If not, then point boot0
208 * back at the MBR we just read in. After this, boot0 is the data to
209 * write back to disk if we are going to do a write.
212 boot0_size = read_mbr(bpath, &boot0, 1);
213 memcpy(boot0 + OFF_PTBL, mbr + OFF_PTBL,
214 sizeof(struct dos_partition) * NDOSPART);
215 if (b0_ver == 2) /* volume serial number support */
216 memcpy(boot0 + OFF_SERIAL, mbr + OFF_SERIAL, 4);
219 boot0_size = mbr_size;
224 boot0[OFF_DRIVE] = d_arg;
226 /* set various flags */
228 boot0[OFF_FLAGS] &= 0xf0;
229 boot0[OFF_FLAGS] |= m_arg;
232 boot0[OFF_FLAGS] &= o_and;
233 boot0[OFF_FLAGS] |= o_or;
236 /* set the default boot selection */
238 boot0[OFF_OPT] = s_arg - 1;
240 /* set the timeout */
242 mk2(boot0 + OFF_TICKS, t_arg);
244 /* set the bell char */
245 if (o_e != -1 && set_bell(boot0, o_e, 0) != -1)
250 errx(1, "incompatible boot block, cannot set volume ID");
251 boot0[OFF_SERIAL] = vol_id[0];
252 boot0[OFF_SERIAL+1] = vol_id[1];
253 boot0[OFF_SERIAL+2] = vol_id[2];
254 boot0[OFF_SERIAL+3] = vol_id[3];
255 up = 1; /* force update */
257 /* write the MBR back to disk */
259 write_mbr(disk, 0, boot0, boot0_size, vol_id[4] || b0_ver == 1);
261 /* display the MBR */
274 /* get or set the 'bell' character to be used in case of errors.
275 * Lookup for a certain code sequence, return -1 if not found.
278 set_bell(u_int8_t *mbr, int new_bell, int report)
280 /* lookup sequence: 0x100 means skip, 0x200 means done */
281 static unsigned seq[] =
282 { 0xb0, 0x100, 0xe8, 0x100, 0x100, 0x30, 0xe4, 0x200 };
284 for (ofs = 0x60; ofs < 0x180; ofs++) { /* search range */
285 if (mbr[ofs] != seq[0]) /* search initial pattern */
288 if (seq[i] == 0x200) { /* found */
291 mbr[ofs+1] = c = new_bell;
293 printf(" bell=%c (0x%x)",
294 (c >= ' ' && c < 0x7f) ? c : ' ', c);
297 if (seq[i] != 0x100 && seq[i] != mbr[ofs+i])
301 warn("bell not found");
305 * Read in the MBR of the disk. If it is boot0, then use the version to
306 * read in all of it if necessary. Use pointers to return a malloc'd
307 * buffer containing the MBR and then return its size.
310 read_mbr(const char *disk, u_int8_t **mbr, int check_version)
312 u_int8_t buf[MBRSIZE];
317 if ((fd = open(disk, O_RDONLY)) == -1)
318 err(1, "open %s", disk);
319 if ((n = read(fd, buf, MBRSIZE)) == -1)
320 err(1, "read %s", disk);
322 errx(1, "%s: short read", disk);
323 if (cv2(buf + OFF_MAGIC) != 0xaa55)
324 errx(1, "%s: bad magic", disk);
326 if (! (ver = boot0bs(buf))) {
328 errx(1, "%s: unknown or incompatible boot code", disk);
329 } else if (boot0version(buf) == 0x101) {
331 if ((*mbr = malloc(mbr_size)) == NULL)
332 errx(1, "%s: unable to allocate read buffer", disk);
333 if (lseek(fd, 0, SEEK_SET) == -1 ||
334 (n = read(fd, *mbr, mbr_size)) == -1)
337 errx(1, "%s: short read", disk);
341 if ((*mbr = malloc(sizeof(buf))) == NULL)
342 errx(1, "%s: unable to allocate MBR buffer", disk);
343 memcpy(*mbr, buf, sizeof(buf));
350 geom_class_available(const char *name)
352 struct gclass *class;
356 error = geom_gettree(&mesh);
358 errc(1, error, "Cannot get GEOM tree");
360 LIST_FOREACH(class, &mesh.lg_class, lg_class) {
361 if (strcmp(class->lg_name, name) == 0) {
362 geom_deletetree(&mesh);
367 geom_deletetree(&mesh);
372 * Write out the mbr to the specified file.
375 write_mbr(const char *fname, int flags, u_int8_t *mbr, int mbr_size,
378 struct gctl_req *grq;
384 fd = open(fname, O_WRONLY | flags, 0666);
386 n = write(fd, mbr, mbr_size);
389 errx(1, "%s: short write", fname);
394 * If we're called to write to a backup file, don't try to
395 * write through GEOM.
398 err(1, "can't open file %s to write backup", fname);
400 /* Try open it read only. */
401 fd = open(fname, O_RDONLY);
403 warn("error opening %s", fname);
407 pname = g_providername(fd);
409 warn("error getting providername for %s", fname);
413 /* First check that GEOM_PART is available */
414 if (geom_class_available("PART") != 0) {
415 grq = gctl_get_handle();
416 gctl_ro_param(grq, "class", -1, "PART");
417 gctl_ro_param(grq, "arg0", -1, pname);
418 gctl_ro_param(grq, "verb", -1, "bootcode");
419 gctl_ro_param(grq, "bootcode", mbr_size, mbr);
420 gctl_ro_param(grq, "flags", -1, "C");
422 gctl_ro_param(grq, "skip_dsn", sizeof(int),
424 errmsg = gctl_issue(grq);
425 if (errmsg != NULL && errmsg[0] != '\0')
426 errx(1, "GEOM_PART: write bootcode to %s failed: %s",
430 errx(1, "can't write MBR to %s", fname);
435 * Outputs an informative dump of the data in the MBR to stdout.
438 display_mbr(u_int8_t *mbr)
440 struct dos_partition *part;
443 part = (struct dos_partition *)(mbr + DOSPARTOFF);
445 for (i = 0; i < NDOSPART; i++)
447 printf(fmt1, 1 + i, part[i].dp_flag,
448 part[i].dp_scyl + ((part[i].dp_ssect & 0xc0) << 2),
449 part[i].dp_shd, part[i].dp_ssect & 0x3f, part[i].dp_typ,
450 part[i].dp_ecyl + ((part[i].dp_esect & 0xc0) << 2),
451 part[i].dp_ehd, part[i].dp_esect & 0x3f, part[i].dp_start,
454 version = boot0version(mbr);
455 printf("version=%d.%d drive=0x%x mask=0x%x ticks=%u",
456 version >> 8, version & 0xff, mbr[OFF_DRIVE],
457 mbr[OFF_FLAGS] & 0xf, cv2(mbr + OFF_TICKS));
459 printf("\noptions=");
460 for (i = 0; i < nopt; i++) {
463 if (!(mbr[OFF_FLAGS] & 1 << (7 - i)) ^ opttbl[i].def)
465 printf("%s", opttbl[i].tok);
469 printf("volume serial ID %02x%02x-%02x%02x\n",
470 mbr[OFF_SERIAL], mbr[OFF_SERIAL+1],
471 mbr[OFF_SERIAL+2], mbr[OFF_SERIAL+3]);
472 printf("default_selection=F%d (", mbr[OFF_OPT] + 1);
473 if (mbr[OFF_OPT] < 4)
474 printf("Slice %d", mbr[OFF_OPT] + 1);
475 else if (mbr[OFF_OPT] == 4)
483 * Return the boot0 version with the minor revision in the low byte, and
484 * the major revision in the next higher byte.
487 boot0version(const u_int8_t *bs)
489 /* Check for old version, and return 0x100 if found. */
494 /* We have a newer boot0, so extract the version number and return it. */
495 return *(const int *)(bs + OFF_VERSION) & 0xffff;
498 /* descriptor of a pattern to match.
499 * Start from the first entry trying to match the chunk of bytes,
500 * if you hit an entry with len=0 terminate the search and report
501 * off as the version. Otherwise skip to the next block after len=0
502 * An entry with len=0, off=0 is the end marker.
504 struct byte_pattern {
511 * Decide if we have valid boot0 boot code by looking for
512 * characteristic byte sequences at fixed offsets.
515 boot0bs(const u_int8_t *bs)
517 /* the initial code sequence */
518 static u_int8_t id0[] = {0xfc, 0x31, 0xc0, 0x8e, 0xc0, 0x8e, 0xd8,
519 0x8e, 0xd0, 0xbc, 0x00, 0x7c };
521 static u_int8_t id1[] = {'D', 'r', 'i', 'v', 'e', ' '};
522 static struct byte_pattern patterns[] = {
523 {0x0, sizeof(id0), id0},
524 {0x1b2, sizeof(id1), id1},
526 {0x0, sizeof(id0), id0}, /* version with NT support */
527 {0x1ae, sizeof(id1), id1},
531 struct byte_pattern *p = patterns;
533 for (; p->off || p->len; p++) {
536 if (!memcmp(bs + p->off, p->key, p->len)) /* match */
538 while (p->len) /* skip to next block */
541 b0_ver = p->off; /* XXX ugly side effect */
546 * Adjust "and" and "or" masks for a -o option argument.
549 stropt(const char *arg, int *xa, int *xo)
555 if (!(s = strdup(arg)))
557 for (s1 = s; (q = strtok(s1, ",")); s1 = NULL) {
558 if ((inv = !strncmp(q, "no", 2)))
560 for (i = 0; i < nopt; i++)
561 if (!strcmp(q, opttbl[i].tok))
564 errx(1, "%s: Unknown -o option", q);
577 * Convert and check an option argument.
580 argtoi(const char *arg, int lo, int hi, int opt)
586 x = strtol(arg, &s, 0);
587 if (errno || !*arg || *s || x < lo || x > hi)
588 errx(1, "%s: Bad argument to -%c option", arg, opt);
593 * Display usage information.
598 fprintf(stderr, "%s\n%s\n",
599 "usage: boot0cfg [-Bv] [-b boot0] [-d drive] [-f file] [-m mask]",
600 " [-o options] [-s slice] [-t ticks] disk");