2 * Copyright (c) 2017 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", required_argument, NULL, 'a'},
98 {"bootnext", required_argument, NULL, 'n'}, /* set bootnext */
99 {"bootorder", required_argument, NULL, 'o'}, /* set order */
100 {"copy", required_argument, NULL, 'C'}, /* Copy boot method */
101 {"create", no_argument, NULL, 'c'},
102 {"deactivate", required_argument, NULL, 'A'},
103 {"del-timout", no_argument, NULL, 'T'},
104 {"delete", required_argument, NULL, 'B'},
105 {"delete-bootnext", required_argument, NULL, 'N'},
106 {"dry-run", no_argument, NULL, 'D'},
107 {"env", required_argument, NULL, 'e'},
108 {"help", no_argument, NULL, 'h'},
109 {"kernel", required_argument, NULL, 'k'},
110 {"label", required_argument, NULL, 'L'},
111 {"loader", required_argument, NULL, 'l'},
112 {"once", no_argument, NULL, 'O'},
113 {"set-timeout", required_argument, NULL, 't'},
114 {"verbose", no_argument, NULL, 'v'},
118 /* global efibootmgr opts */
119 static bmgr_opts_t opts;
121 static LIST_HEAD(efivars_head, entry) efivars =
122 LIST_HEAD_INITIALIZER(efivars);
135 LIST_ENTRY(entry) entries;
138 #define MAX_DP_LEN 4096
139 #define MAX_LOADOPT_LEN 8192
143 mangle_loader(char *loader)
147 for (c = loader; *c; c++)
155 #define COMMON_ATTRS EFI_VARIABLE_NON_VOLATILE | \
156 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
157 EFI_VARIABLE_RUNTIME_ACCESS
160 * We use global guid, and common var attrs and
161 * find it better to just delete and re-create a var.
164 set_bootvar(const char *name, uint8_t *data, size_t size)
167 return efi_set_variable(EFI_GLOBAL_GUID, name, data, size,
173 " [-aAnNB Bootvar] [-t timeout] [-T] [-o bootorder] [-O] [--verbose] [--help] \n\
174 [-c -l loader [-k kernel ] [-L label] [--dry-run] [-b Bootvar]]"
176 #define CREATE_USAGE \
177 " efibootmgr -c -l loader [-k kernel] [-L label] [--dry-run]"
178 #define ORDER_USAGE \
179 " efibootmgr -o bootvarnum1,bootvarnum2,..."
180 #define TIMEOUT_USAGE \
181 " efibootmgr -t seconds"
182 #define DELETE_USAGE \
183 " efibootmgr -B bootvarnum"
184 #define ACTIVE_USAGE \
185 " efibootmgr [-a | -A] bootvarnum"
186 #define BOOTNEXT_USAGE \
187 " efibootmgr [-n | -N] bootvarnum"
190 parse_args(int argc, char *argv[])
194 while ((ch = getopt_long(argc, argv, "A:a:B:C:cDe:hk:L:l:Nn:Oo:Tt:v",
195 lopts, NULL)) != -1) {
198 opts.set_inactive = true;
199 opts.bootnum = strtoul(optarg, NULL, 16);
202 opts.set_active = true;
203 opts.bootnum = strtoul(optarg, NULL, 16);
206 opts.has_bootnum = true;
207 opts.bootnum = strtoul(optarg, NULL, 16);
211 opts.bootnum = strtoul(optarg, NULL, 16);
215 opts.cp_src = strtoul(optarg, NULL, 16);
219 case 'D': /* should be remove dups XXX */
224 opts.env = strdup(optarg);
228 errx(1, "%s", USAGE);
232 opts.kernel = strdup(optarg);
236 opts.label = strdup(optarg);
240 opts.loader = strdup(optarg);
241 opts.loader = mangle_loader(opts.loader);
244 opts.delete_bootnext = true;
247 opts.set_bootnext = true;
248 opts.bootnum = strtoul(optarg, NULL, 16);
255 opts.order = strdup(optarg);
258 opts.del_timeout = true;
261 opts.set_timeout = true;
262 opts.timeout = strtoul(optarg, NULL, 10);
271 errx(1, "%s",CREATE_USAGE);
275 if (opts.order && !(opts.order))
276 errx(1, "%s", ORDER_USAGE);
285 char *next_name = NULL;
291 while ((ret = efi_get_next_variable_name(&guid, &next_name)) > 0) {
293 * Only pay attention to EFI:BootXXXX variables to get the list.
295 if (efi_guid_cmp(guid, &EFI_GLOBAL_GUID) != 0 ||
296 strlen(next_name) != 8 ||
297 strncmp(next_name, "Boot", 4) != 0 ||
298 !isxdigit(next_name[4]) ||
299 !isxdigit(next_name[5]) ||
300 !isxdigit(next_name[6]) ||
301 !isxdigit(next_name[7]))
303 nent = malloc(sizeof(struct entry));
304 nent->name = strdup(next_name);
306 ret = efi_get_variable(*guid, next_name, &nent->data,
307 &nent->size, &nent->attrs);
309 err(1, "efi_get_variable");
311 nent->idx = strtoul(&next_name[4], NULL, 16);
312 LIST_INSERT_HEAD(&efivars, nent, entries);
318 set_boot_order(char *order)
332 size = sizeof(uint16_t) * cnt;
333 new_data = malloc(size);
337 while ((next = strsep(&cp, ",")) != NULL) {
338 new_data[i] = strtoul(next, NULL, 16);
339 if (new_data[i] == 0 && errno == EINVAL) {
340 warnx("can't parse %s as a numb", next);
341 errx(1, "%s", ORDER_USAGE);
346 if (set_bootvar("BootOrder", (uint8_t*)new_data, size) < 0)
347 err(1, "Unabke to set BootOrder to %s", order);
352 handle_activity(int bootnum, bool active)
354 uint32_t attrs, load_attrs;
359 asprintf(&name, "%s%04X", "Boot", bootnum);
362 if (efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, &attrs) < 0)
363 err(1, "No such bootvar %s\n", name);
365 load_attrs = le32dec(data);
368 load_attrs |= LOAD_OPTION_ACTIVE;
370 load_attrs &= ~LOAD_OPTION_ACTIVE;
372 le32enc(data, load_attrs);
374 if (set_bootvar(name, data, size) < 0)
375 err(1, "handle activity efi_set_variable");
380 * add boot var to boot order.
381 * called by create boot var. There is no option
382 * to add one independent of create.
384 * Note: we currently don't support where it goes
385 * so it goes on the front, inactive.
386 * use -o 2,3,7 etc to affect order, -a to activate.
389 add_to_boot_order(char *bootvar)
396 val = strtoul(&bootvar[4], NULL, 16);
398 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0) {
399 if (errno == ENOENT) { /* create it and set this bootvar to active */
403 err(1, "efi_get_variable BootOrder");
407 * We have BootOrder with the current order
408 * so grow the array by one, add the value
409 * and write the new variable value.
411 size += sizeof(uint16_t);
417 if (size > sizeof(uint16_t))
418 memcpy(new + sizeof(uint16_t), data, size - sizeof(uint16_t));
420 if (set_bootvar("BootOrder", new, size) < 0)
421 err(1, "set_bootvar");
427 remove_from_order(uint16_t bootnum)
433 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0)
440 for (j = i = 0; i < size; i += sizeof(uint16_t)) {
441 if (le16dec(data + i) == bootnum)
443 memcpy(new + j, data + i, sizeof(uint16_t));
444 j += sizeof(uint16_t);
447 warnx("Boot variable %04x not in BootOrder", bootnum);
448 else if (set_bootvar("BootOrder", new, j) < 0)
449 err(1, "Unable to update BootOrder with new value");
455 delete_bootvar(int bootnum)
461 * Try to delete the boot variable and remocve it
462 * from the boot order. We always do both actions
463 * to make it easy to clean up from oopses.
465 if (bootnum < 0 || bootnum > 0xffff)
466 errx(1, "Bad boot variable %#x", bootnum);
467 asprintf(&name, "%s%04X", "Boot", bootnum);
470 printf("Removing boot variable '%s'\n", name);
471 if (efi_del_variable(EFI_GLOBAL_GUID, name) < 0) {
473 warn("cannot delete variable %s", name);
475 printf("Removing 0x%x from BootOrder\n", bootnum);
476 remove_from_order(bootnum);
487 if (efi_del_variable(EFI_GLOBAL_GUID, "BootNext") < 0)
488 err(1, "efi_del_variable");
492 handle_bootnext(uint16_t bootnum)
496 le16enc(&num, bootnum);
497 if (set_bootvar("BootNext", (uint8_t*)&bootnum, sizeof(uint16_t)) < 0)
498 err(1, "set_bootvar");
503 compare(const void *a, const void *b)
508 memcpy(&c, a, sizeof(uint16_t));
509 memcpy(&d, b, sizeof(uint16_t));
519 make_next_boot_var_name(void)
522 uint16_t *vals, next_free = 0;
527 LIST_FOREACH(v, &efivars, entries) {
531 vals = malloc(sizeof(uint16_t) * cnt);
536 LIST_FOREACH(v, &efivars, entries) {
539 qsort(vals, cnt, sizeof(uint16_t), compare);
540 /* if the hole is at the beginning, just return zero */
544 /* now just run the list looking for the first hole */
545 for (i = 0; i < cnt - 1 && next_free == 0; i++)
546 if (vals[i] + 1 != vals[i + 1])
547 next_free = vals[i] + 1;
549 next_free = vals[cnt - 1] + 1;
550 /* In theory we could have used all 65k slots -- what to do? */
554 asprintf(&name, "%s%04X", "Boot", next_free);
561 make_boot_var_name(uint16_t bootnum)
566 LIST_FOREACH(v, &efivars, entries) {
567 if (v->idx == bootnum)
571 asprintf(&name, "%s%04X", "Boot", bootnum);
578 create_loadopt(uint8_t *buf, size_t bufmax, uint32_t attributes, efidp dp, size_t dp_size,
579 const char *description, const uint8_t *optional_data, size_t optional_data_size)
581 efi_char *bbuf = NULL;
586 if (optional_data == NULL && optional_data_size != 0)
588 if (dp == NULL && dp_size != 0)
592 * Compute the length to make sure the passed in buffer is long enough.
594 utf8_to_ucs2(description, &bbuf, &desc_len);
595 len = sizeof(uint32_t) + sizeof(uint16_t) + desc_len + dp_size + optional_data_size;
601 le32enc(pos, attributes);
602 pos += sizeof (attributes);
604 le16enc(pos, dp_size);
605 pos += sizeof (uint16_t);
607 memcpy(pos, bbuf, desc_len); /* NB:desc_len includes strailing NUL */
611 memcpy(pos, dp, dp_size);
614 if (optional_data && optional_data_size > 0) {
615 memcpy(pos, optional_data, optional_data_size);
616 pos += optional_data_size;
624 make_boot_var(const char *label, const char *loader, const char *kernel, const char *env, bool dry_run,
625 int bootnum, bool activate)
627 struct entry *new_ent;
628 uint32_t load_attrs = 0;
629 uint8_t *load_opt_buf;
630 size_t lopt_size, llen, klen;
631 efidp dp, loaderdp, kerneldp;
632 char *bootvar = NULL;
635 assert(label != NULL);
638 bootvar = make_next_boot_var_name();
640 bootvar = make_boot_var_name((uint16_t)bootnum);
642 err(1, "bootvar creation");
644 errx(1, "Must specify boot loader");
645 if (efivar_unix_path_to_device_path(loader, &loaderdp) != 0)
646 err(1, "Cannot translate unix loader path '%s' to UEFI", loader);
647 if (kernel != NULL) {
648 if (efivar_unix_path_to_device_path(kernel, &kerneldp) != 0)
649 err(1, "Cannot translate unix kernel path '%s' to UEFI", kernel);
653 llen = efidp_size(loaderdp);
654 if (llen > MAX_DP_LEN)
655 errx(1, "Loader path too long.");
656 klen = efidp_size(kerneldp);
657 if (klen > MAX_DP_LEN)
658 errx(1, "Kernel path too long.");
659 dp = malloc(llen + klen);
661 errx(1, "Can't allocate memory for new device paths");
662 memcpy(dp, loaderdp, llen);
663 if (kerneldp != NULL)
664 memcpy((char *)dp + llen, kerneldp, klen);
666 /* don't make the new bootvar active by default, use the -a option later */
667 load_attrs = LOAD_OPTION_CATEGORY_BOOT;
669 load_attrs |= LOAD_OPTION_ACTIVE;
670 load_opt_buf = malloc(MAX_LOADOPT_LEN);
671 if (load_opt_buf == NULL)
674 lopt_size = create_loadopt(load_opt_buf, MAX_LOADOPT_LEN, load_attrs,
675 dp, llen + klen, label, env, env ? strlen(env) + 1 : 0);
676 if (lopt_size == BAD_LENGTH)
677 errx(1, "Can't crate loadopt");
681 ret = efi_set_variable(EFI_GLOBAL_GUID, bootvar,
682 (uint8_t*)load_opt_buf, lopt_size, COMMON_ATTRS);
686 err(1, "efi_set_variable");
688 add_to_boot_order(bootvar); /* first, still not active */
689 new_ent = malloc(sizeof(struct entry));
692 memset(new_ent, 0, sizeof(struct entry));
693 new_ent->name = bootvar;
694 new_ent->guid = EFI_GLOBAL_GUID;
695 LIST_INSERT_HEAD(&efivars, new_ent, entries);
704 print_loadopt_str(uint8_t *data, size_t datalen)
706 char *dev, *relpath, *abspath;
710 uint8_t *ep = data + datalen;
711 uint8_t *walker = data;
718 if (datalen < sizeof(attr) + sizeof(fplen) + sizeof(efi_char))
720 // First 4 bytes are attribute flags
721 attr = le32dec(walker);
722 walker += sizeof(attr);
723 // Next two bytes are length of the file paths
724 fplen = le16dec(walker);
725 walker += sizeof(fplen);
726 // Next we have a 0 terminated UCS2 string that we know to be aligned
727 descr = (efi_char *)(intptr_t)(void *)walker;
728 len = ucs2len(descr); // XXX need to sanity check that len < (datalen - (ep - walker) / 2)
729 walker += (len + 1) * sizeof(efi_char);
732 // Now we have fplen bytes worth of file path stuff
739 * Everything left is the binary option args
741 * optlen = ep - walker;
745 efidp_format_device_path(buf, sizeof(buf), dp,
746 (intptr_t)(void *)edp - (intptr_t)(void *)dp);
747 printf("%*s%s\n", indent, "", buf);
748 indent = 10 + len + 1;
749 rv = efivar_device_path_to_unix_path(dp, &dev, &relpath, &abspath);
751 printf("%*s%s:%s %s\n", indent + 4, "", dev, relpath, abspath);
756 dp = (efidp)((char *)dp + efidp_size(dp));
761 get_descr(uint8_t *data)
769 pos += sizeof(uint32_t) + sizeof(uint16_t);
770 desc = (efi_char*)(intptr_t)(void *)pos;
772 buf = malloc(len + 1);
773 memset(buf, 0, len + 1);
783 print_boot_var(const char *name, bool verbose, bool curboot)
791 ret = efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, NULL);
794 load_attrs = le32dec(data);
796 printf("%c%s%c %s", curboot ? '+' : ' ', name,
797 ((load_attrs & LOAD_OPTION_ACTIVE) ? '*': ' '), d);
800 print_loadopt_str(data, size);
807 /* Cmd epilogue, or just the default with no args.
808 * The order is [bootnext] bootcurrent, timeout, order, and the bootvars [-v]
811 print_boot_vars(bool verbose)
814 * just read and print the current values
815 * as a command epilogue
822 uint16_t *boot_order = NULL, current;
824 ret = efi_get_variable(EFI_GLOBAL_GUID, "BootNext", &data, &size, &attrs);
826 printf("BootNext : %04x\n", le16dec(data));
829 ret = efi_get_variable(EFI_GLOBAL_GUID, "BootCurrent", &data, &size,&attrs);
830 current = le16dec(data);
831 printf("BootCurrent: %04x\n", current);
833 ret = efi_get_variable(EFI_GLOBAL_GUID, "Timeout", &data, &size, &attrs);
835 printf("Timeout : %d seconds\n", le16dec(data));
838 if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) > 0) {
840 warn("Bad BootOrder variable: odd length %d", (int)size);
841 boot_order = malloc(size);
843 printf("BootOrder : ");
844 for (size_t i = 0; i < size; i += 2) {
845 boot_order[i / 2] = le16dec(data + i);
846 printf("%04X%s", boot_order[i / 2], i == size - 2 ? "\n" : ", ");
850 if (boot_order == NULL) {
852 * now we want to fetch 'em all fresh again
853 * which possibly includes a newly created bootvar
855 LIST_FOREACH(v, &efivars, entries) {
856 print_boot_var(v->name, verbose, v->idx == current);
859 LIST_FOREACH(v, &efivars, entries) {
862 for (int i = 0; i < bolen; i++) {
865 snprintf(buffer, sizeof(buffer), "Boot%04X", boot_order[i]);
866 if (!print_boot_var(buffer, verbose, boot_order[i] == current))
867 printf("%s: MISSING!\n", buffer);
868 LIST_FOREACH(v, &efivars, entries) {
869 if (v->idx == boot_order[i]) {
876 printf("\n\nUnreferenced Variables:\n");
877 LIST_FOREACH(v, &efivars, entries) {
879 print_boot_var(v->name, verbose, v->idx == current);
890 efi_del_variable(EFI_GLOBAL_GUID,"Timeout");
894 handle_timeout(int to)
898 le16enc(&timeout, to);
899 if (set_bootvar("Timeout", (uint8_t *)&timeout, sizeof(timeout)) < 0)
900 errx(1, "Can't set Timeout for booting.");
904 main(int argc, char *argv[])
907 if (!efi_variables_supported())
908 errx(1, "efi variables not supported on this system. root? kldload efirt?");
910 memset(&opts, 0, sizeof (bmgr_opts_t));
911 parse_args(argc, argv);
916 * side effect, adds to boot order, but not yet active.
918 make_boot_var(opts.label ? opts.label : "",
919 opts.loader, opts.kernel, opts.env, opts.dry_run,
920 opts.has_bootnum ? opts.bootnum : -1, opts.set_active);
921 else if (opts.set_active || opts.set_inactive )
922 handle_activity(opts.bootnum, opts.set_active);
923 else if (opts.order != NULL)
924 set_boot_order(opts.order); /* create a new bootorder with opts.order */
925 else if (opts.set_bootnext)
926 handle_bootnext(opts.bootnum);
927 else if (opts.delete_bootnext)
929 else if (opts.delete)
930 delete_bootvar(opts.bootnum);
931 else if (opts.del_timeout)
933 else if (opts.set_timeout)
934 handle_timeout(opts.timeout);
936 print_boot_vars(opts.verbose);