2 * Copyright (c) 2017-2018 Netflix, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
52 #include <geom/geom.h>
53 #include <geom/geom_ctl.h>
54 #include <geom/geom_int.h>
59 #include <efivar-dp.h>
61 #ifndef LOAD_OPTION_ACTIVE
62 #define LOAD_OPTION_ACTIVE 0x00000001
65 #ifndef LOAD_OPTION_CATEGORY_BOOT
66 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
69 #define BAD_LENGTH ((size_t)-1)
71 typedef struct _bmgr_opts {
96 static struct option lopts[] = {
97 {"activate", no_argument, NULL, 'a'},
98 {"bootnext", no_argument, NULL, 'n'}, /* set bootnext */
99 {"bootnum", required_argument, NULL, 'b'},
100 {"bootorder", required_argument, NULL, 'o'}, /* set order */
101 {"copy", required_argument, NULL, 'C'}, /* Copy boot method */
102 {"create", no_argument, NULL, 'c'},
103 {"deactivate", no_argument, NULL, 'A'},
104 {"del-timout", no_argument, NULL, 'T'},
105 {"delete", no_argument, NULL, 'B'},
106 {"delete-bootnext", no_argument, NULL, 'N'},
107 {"dry-run", no_argument, NULL, 'D'},
108 {"env", required_argument, NULL, 'e'},
109 {"help", no_argument, NULL, 'h'},
110 {"kernel", required_argument, NULL, 'k'},
111 {"label", required_argument, NULL, 'L'},
112 {"loader", required_argument, NULL, 'l'},
113 {"once", no_argument, NULL, 'O'},
114 {"set-timeout", required_argument, NULL, 't'},
115 {"verbose", no_argument, NULL, 'v'},
119 /* global efibootmgr opts */
120 static bmgr_opts_t opts;
122 static LIST_HEAD(efivars_head, entry) efivars =
123 LIST_HEAD_INITIALIZER(efivars);
136 LIST_ENTRY(entry) entries;
139 #define MAX_DP_LEN 4096
140 #define MAX_LOADOPT_LEN 8192
144 mangle_loader(char *loader)
148 for (c = loader; *c; c++)
156 #define COMMON_ATTRS EFI_VARIABLE_NON_VOLATILE | \
157 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
158 EFI_VARIABLE_RUNTIME_ACCESS
161 * We use global guid, and common var attrs and
162 * find it better to just delete and re-create a var.
165 set_bootvar(const char *name, uint8_t *data, size_t size)
168 return efi_set_variable(EFI_GLOBAL_GUID, name, data, size,
174 " [-aAnB -b bootnum] [-N] [-t timeout] [-T] [-o bootorder] [-O] [--verbose] [--help]\n\
175 [-c -l loader [-k kernel] [-L label] [--dry-run] [-b bootnum]]"
177 #define CREATE_USAGE \
178 " efibootmgr -c -l loader [-k kernel] [-L label] [--dry-run] [-b bootnum] [-a]"
179 #define ORDER_USAGE \
180 " efibootmgr -o bootvarnum1,bootvarnum2,..."
181 #define TIMEOUT_USAGE \
182 " efibootmgr -t seconds"
183 #define DELETE_USAGE \
184 " efibootmgr -B -b bootnum"
185 #define ACTIVE_USAGE \
186 " efibootmgr [-a | -A] -b bootnum"
187 #define BOOTNEXT_USAGE \
188 " efibootmgr [-n | -N] -b bootnum"
191 parse_args(int argc, char *argv[])
195 while ((ch = getopt_long(argc, argv, "AaBb:C:cDe:hk:L:l:NnOo:Tt:v",
196 lopts, NULL)) != -1) {
199 opts.set_inactive = true;
202 opts.set_active = true;
205 opts.has_bootnum = true;
206 opts.bootnum = strtoul(optarg, NULL, 16);
213 opts.cp_src = strtoul(optarg, NULL, 16);
217 case 'D': /* should be remove dups XXX */
222 opts.env = strdup(optarg);
226 errx(1, "%s", USAGE);
230 opts.kernel = strdup(optarg);
234 opts.label = strdup(optarg);
238 opts.loader = strdup(optarg);
239 opts.loader = mangle_loader(opts.loader);
242 opts.delete_bootnext = true;
245 opts.set_bootnext = true;
252 opts.order = strdup(optarg);
255 opts.del_timeout = true;
258 opts.set_timeout = true;
259 opts.timeout = strtoul(optarg, NULL, 10);
268 errx(1, "%s",CREATE_USAGE);
272 if (opts.order && !(opts.order))
273 errx(1, "%s", ORDER_USAGE);
275 if ((opts.set_inactive || opts.set_active) && !opts.has_bootnum)
276 errx(1, "%s", ACTIVE_USAGE);
278 if (opts.delete && !opts.has_bootnum)
279 errx(1, "%s", DELETE_USAGE);
281 if (opts.set_bootnext && !opts.has_bootnum)
282 errx(1, "%s", BOOTNEXT_USAGE);
291 char *next_name = NULL;
297 while ((ret = efi_get_next_variable_name(&guid, &next_name)) > 0) {
299 * Only pay attention to EFI:BootXXXX variables to get the list.
301 if (efi_guid_cmp(guid, &EFI_GLOBAL_GUID) != 0 ||
302 strlen(next_name) != 8 ||
303 strncmp(next_name, "Boot", 4) != 0 ||
304 !isxdigit(next_name[4]) ||
305 !isxdigit(next_name[5]) ||
306 !isxdigit(next_name[6]) ||
307 !isxdigit(next_name[7]))
309 nent = malloc(sizeof(struct entry));
310 nent->name = strdup(next_name);
312 ret = efi_get_variable(*guid, next_name, &nent->data,
313 &nent->size, &nent->attrs);
315 err(1, "efi_get_variable");
317 nent->idx = strtoul(&next_name[4], NULL, 16);
318 LIST_INSERT_HEAD(&efivars, nent, entries);
324 set_boot_order(char *order)
338 size = sizeof(uint16_t) * cnt;
339 new_data = malloc(size);
343 while ((next = strsep(&cp, ",")) != NULL) {
344 new_data[i] = strtoul(next, NULL, 16);
345 if (new_data[i] == 0 && errno == EINVAL) {
346 warnx("can't parse %s as a numb", next);
347 errx(1, "%s", ORDER_USAGE);
352 if (set_bootvar("BootOrder", (uint8_t*)new_data, size) < 0)
353 err(1, "Unabke to set BootOrder to %s", order);
358 handle_activity(int bootnum, bool active)
360 uint32_t attrs, load_attrs;
365 asprintf(&name, "%s%04X", "Boot", bootnum);
368 if (efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, &attrs) < 0)
369 err(1, "No such bootvar %s\n", name);
371 load_attrs = le32dec(data);
374 load_attrs |= LOAD_OPTION_ACTIVE;
376 load_attrs &= ~LOAD_OPTION_ACTIVE;
378 le32enc(data, load_attrs);
380 if (set_bootvar(name, data, size) < 0)
381 err(1, "handle activity efi_set_variable");
386 * add boot var to boot order.
387 * called by create boot var. There is no option
388 * to add one independent of create.
390 * Note: we currently don't support where it goes
391 * so it goes on the front, inactive.
392 * use -o 2,3,7 etc to affect order, -a to activate.
395 add_to_boot_order(char *bootvar)
402 val = strtoul(&bootvar[4], NULL, 16);
404 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0) {
405 if (errno == ENOENT) { /* create it and set this bootvar to active */
409 err(1, "efi_get_variable BootOrder");
413 * We have BootOrder with the current order
414 * so grow the array by one, add the value
415 * and write the new variable value.
417 size += sizeof(uint16_t);
423 if (size > sizeof(uint16_t))
424 memcpy(new + sizeof(uint16_t), data, size - sizeof(uint16_t));
426 if (set_bootvar("BootOrder", new, size) < 0)
427 err(1, "set_bootvar");
433 remove_from_order(uint16_t bootnum)
439 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0)
446 for (j = i = 0; i < size; i += sizeof(uint16_t)) {
447 if (le16dec(data + i) == bootnum)
449 memcpy(new + j, data + i, sizeof(uint16_t));
450 j += sizeof(uint16_t);
453 warnx("Boot variable %04x not in BootOrder", bootnum);
454 else if (set_bootvar("BootOrder", new, j) < 0)
455 err(1, "Unable to update BootOrder with new value");
461 delete_bootvar(int bootnum)
467 * Try to delete the boot variable and remocve it
468 * from the boot order. We always do both actions
469 * to make it easy to clean up from oopses.
471 if (bootnum < 0 || bootnum > 0xffff)
472 errx(1, "Bad boot variable %#x", bootnum);
473 asprintf(&name, "%s%04X", "Boot", bootnum);
476 printf("Removing boot variable '%s'\n", name);
477 if (efi_del_variable(EFI_GLOBAL_GUID, name) < 0) {
479 warn("cannot delete variable %s", name);
481 printf("Removing 0x%x from BootOrder\n", bootnum);
482 remove_from_order(bootnum);
493 if (efi_del_variable(EFI_GLOBAL_GUID, "BootNext") < 0)
494 err(1, "efi_del_variable");
498 handle_bootnext(uint16_t bootnum)
502 le16enc(&num, bootnum);
503 if (set_bootvar("BootNext", (uint8_t*)&bootnum, sizeof(uint16_t)) < 0)
504 err(1, "set_bootvar");
509 compare(const void *a, const void *b)
514 memcpy(&c, a, sizeof(uint16_t));
515 memcpy(&d, b, sizeof(uint16_t));
525 make_next_boot_var_name(void)
528 uint16_t *vals, next_free = 0;
533 LIST_FOREACH(v, &efivars, entries) {
537 vals = malloc(sizeof(uint16_t) * cnt);
542 LIST_FOREACH(v, &efivars, entries) {
545 qsort(vals, cnt, sizeof(uint16_t), compare);
546 /* if the hole is at the beginning, just return zero */
550 /* now just run the list looking for the first hole */
551 for (i = 0; i < cnt - 1 && next_free == 0; i++)
552 if (vals[i] + 1 != vals[i + 1])
553 next_free = vals[i] + 1;
555 next_free = vals[cnt - 1] + 1;
556 /* In theory we could have used all 65k slots -- what to do? */
560 asprintf(&name, "%s%04X", "Boot", next_free);
567 make_boot_var_name(uint16_t bootnum)
572 LIST_FOREACH(v, &efivars, entries) {
573 if (v->idx == bootnum)
577 asprintf(&name, "%s%04X", "Boot", bootnum);
584 create_loadopt(uint8_t *buf, size_t bufmax, uint32_t attributes, efidp dp, size_t dp_size,
585 const char *description, const uint8_t *optional_data, size_t optional_data_size)
587 efi_char *bbuf = NULL;
592 if (optional_data == NULL && optional_data_size != 0)
594 if (dp == NULL && dp_size != 0)
598 * Compute the length to make sure the passed in buffer is long enough.
600 utf8_to_ucs2(description, &bbuf, &desc_len);
601 len = sizeof(uint32_t) + sizeof(uint16_t) + desc_len + dp_size + optional_data_size;
607 le32enc(pos, attributes);
608 pos += sizeof (attributes);
610 le16enc(pos, dp_size);
611 pos += sizeof (uint16_t);
613 memcpy(pos, bbuf, desc_len); /* NB:desc_len includes strailing NUL */
617 memcpy(pos, dp, dp_size);
620 if (optional_data && optional_data_size > 0) {
621 memcpy(pos, optional_data, optional_data_size);
622 pos += optional_data_size;
630 make_boot_var(const char *label, const char *loader, const char *kernel, const char *env, bool dry_run,
631 int bootnum, bool activate)
633 struct entry *new_ent;
634 uint32_t load_attrs = 0;
635 uint8_t *load_opt_buf;
636 size_t lopt_size, llen, klen;
637 efidp dp, loaderdp, kerneldp;
638 char *bootvar = NULL;
641 assert(label != NULL);
644 bootvar = make_next_boot_var_name();
646 bootvar = make_boot_var_name((uint16_t)bootnum);
648 err(1, "bootvar creation");
650 errx(1, "Must specify boot loader");
651 if (efivar_unix_path_to_device_path(loader, &loaderdp) != 0)
652 err(1, "Cannot translate unix loader path '%s' to UEFI", loader);
653 if (kernel != NULL) {
654 if (efivar_unix_path_to_device_path(kernel, &kerneldp) != 0)
655 err(1, "Cannot translate unix kernel path '%s' to UEFI", kernel);
659 llen = efidp_size(loaderdp);
660 if (llen > MAX_DP_LEN)
661 errx(1, "Loader path too long.");
662 klen = efidp_size(kerneldp);
663 if (klen > MAX_DP_LEN)
664 errx(1, "Kernel path too long.");
665 dp = malloc(llen + klen);
667 errx(1, "Can't allocate memory for new device paths");
668 memcpy(dp, loaderdp, llen);
669 if (kerneldp != NULL)
670 memcpy((char *)dp + llen, kerneldp, klen);
672 /* don't make the new bootvar active by default, use the -a option later */
673 load_attrs = LOAD_OPTION_CATEGORY_BOOT;
675 load_attrs |= LOAD_OPTION_ACTIVE;
676 load_opt_buf = malloc(MAX_LOADOPT_LEN);
677 if (load_opt_buf == NULL)
680 lopt_size = create_loadopt(load_opt_buf, MAX_LOADOPT_LEN, load_attrs,
681 dp, llen + klen, label, env, env ? strlen(env) + 1 : 0);
682 if (lopt_size == BAD_LENGTH)
683 errx(1, "Can't crate loadopt");
687 ret = efi_set_variable(EFI_GLOBAL_GUID, bootvar,
688 (uint8_t*)load_opt_buf, lopt_size, COMMON_ATTRS);
692 err(1, "efi_set_variable");
694 add_to_boot_order(bootvar); /* first, still not active */
695 new_ent = malloc(sizeof(struct entry));
698 memset(new_ent, 0, sizeof(struct entry));
699 new_ent->name = bootvar;
700 new_ent->guid = EFI_GLOBAL_GUID;
701 LIST_INSERT_HEAD(&efivars, new_ent, entries);
710 print_loadopt_str(uint8_t *data, size_t datalen)
712 char *dev, *relpath, *abspath;
716 uint8_t *ep = data + datalen;
717 uint8_t *walker = data;
724 if (datalen < sizeof(attr) + sizeof(fplen) + sizeof(efi_char))
726 // First 4 bytes are attribute flags
727 attr = le32dec(walker);
728 walker += sizeof(attr);
729 // Next two bytes are length of the file paths
730 fplen = le16dec(walker);
731 walker += sizeof(fplen);
732 // Next we have a 0 terminated UCS2 string that we know to be aligned
733 descr = (efi_char *)(intptr_t)(void *)walker;
734 len = ucs2len(descr); // XXX need to sanity check that len < (datalen - (ep - walker) / 2)
735 walker += (len + 1) * sizeof(efi_char);
738 // Now we have fplen bytes worth of file path stuff
745 * Everything left is the binary option args
747 * optlen = ep - walker;
751 efidp_format_device_path(buf, sizeof(buf), dp,
752 (intptr_t)(void *)edp - (intptr_t)(void *)dp);
753 printf("%*s%s\n", indent, "", buf);
754 indent = 10 + len + 1;
755 rv = efivar_device_path_to_unix_path(dp, &dev, &relpath, &abspath);
757 printf("%*s%s:%s %s\n", indent + 4, "", dev, relpath, abspath);
762 dp = (efidp)((char *)dp + efidp_size(dp));
767 get_descr(uint8_t *data)
775 pos += sizeof(uint32_t) + sizeof(uint16_t);
776 desc = (efi_char*)(intptr_t)(void *)pos;
778 buf = malloc(len + 1);
779 memset(buf, 0, len + 1);
789 print_boot_var(const char *name, bool verbose, bool curboot)
797 ret = efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, NULL);
800 load_attrs = le32dec(data);
802 printf("%c%s%c %s", curboot ? '+' : ' ', name,
803 ((load_attrs & LOAD_OPTION_ACTIVE) ? '*': ' '), d);
806 print_loadopt_str(data, size);
813 /* Cmd epilogue, or just the default with no args.
814 * The order is [bootnext] bootcurrent, timeout, order, and the bootvars [-v]
817 print_boot_vars(bool verbose)
820 * just read and print the current values
821 * as a command epilogue
828 uint16_t *boot_order = NULL, current;
830 ret = efi_get_variable(EFI_GLOBAL_GUID, "BootNext", &data, &size, &attrs);
832 printf("BootNext : %04x\n", le16dec(data));
835 ret = efi_get_variable(EFI_GLOBAL_GUID, "BootCurrent", &data, &size,&attrs);
836 current = le16dec(data);
837 printf("BootCurrent: %04x\n", current);
839 ret = efi_get_variable(EFI_GLOBAL_GUID, "Timeout", &data, &size, &attrs);
841 printf("Timeout : %d seconds\n", le16dec(data));
844 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) > 0) {
846 warn("Bad BootOrder variable: odd length %d", (int)size);
847 boot_order = malloc(size);
849 printf("BootOrder : ");
850 for (size_t i = 0; i < size; i += 2) {
851 boot_order[i / 2] = le16dec(data + i);
852 printf("%04X%s", boot_order[i / 2], i == size - 2 ? "\n" : ", ");
856 if (boot_order == NULL) {
858 * now we want to fetch 'em all fresh again
859 * which possibly includes a newly created bootvar
861 LIST_FOREACH(v, &efivars, entries) {
862 print_boot_var(v->name, verbose, v->idx == current);
865 LIST_FOREACH(v, &efivars, entries) {
868 for (int i = 0; i < bolen; i++) {
871 snprintf(buffer, sizeof(buffer), "Boot%04X", boot_order[i]);
872 if (!print_boot_var(buffer, verbose, boot_order[i] == current))
873 printf("%s: MISSING!\n", buffer);
874 LIST_FOREACH(v, &efivars, entries) {
875 if (v->idx == boot_order[i]) {
882 printf("\n\nUnreferenced Variables:\n");
883 LIST_FOREACH(v, &efivars, entries) {
885 print_boot_var(v->name, verbose, v->idx == current);
896 efi_del_variable(EFI_GLOBAL_GUID,"Timeout");
900 handle_timeout(int to)
904 le16enc(&timeout, to);
905 if (set_bootvar("Timeout", (uint8_t *)&timeout, sizeof(timeout)) < 0)
906 errx(1, "Can't set Timeout for booting.");
910 main(int argc, char *argv[])
913 if (!efi_variables_supported())
914 errx(1, "efi variables not supported on this system. root? kldload efirt?");
916 memset(&opts, 0, sizeof (bmgr_opts_t));
917 parse_args(argc, argv);
922 * side effect, adds to boot order, but not yet active.
924 make_boot_var(opts.label ? opts.label : "",
925 opts.loader, opts.kernel, opts.env, opts.dry_run,
926 opts.has_bootnum ? opts.bootnum : -1, opts.set_active);
927 else if (opts.set_active || opts.set_inactive )
928 handle_activity(opts.bootnum, opts.set_active);
929 else if (opts.order != NULL)
930 set_boot_order(opts.order); /* create a new bootorder with opts.order */
931 else if (opts.set_bootnext)
932 handle_bootnext(opts.bootnum);
933 else if (opts.delete_bootnext)
935 else if (opts.delete)
936 delete_bootvar(opts.bootnum);
937 else if (opts.del_timeout)
939 else if (opts.set_timeout)
940 handle_timeout(opts.timeout);
942 print_boot_vars(opts.verbose);