usr.sbin/efibootmgr/efibootmgr.c

   1 /*-
   2  * Copyright (c) 2017-2018 Netflix, Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer
   9  *    in this position and unchanged.
  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 ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include <sys/stat.h>
  30 #include <sys/vtoc.h>
  31 #include <sys/param.h>
  32 #include <assert.h>
  33 #include <ctype.h>
  34 #include <err.h>
  35 #include <errno.h>
  36 #include <fcntl.h>
  37 #include <libgeom.h>
  38 #include <paths.h>
  39 #include <signal.h>
  40 #include <stdint.h>
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <getopt.h>
  44 #include <limits.h>
  45 #include <inttypes.h>
  46 #include <stdbool.h>
  47 #include <string.h>
  48 #include <strings.h>
  49 #include <unistd.h>
  50 #include <libgeom.h>
  51 #include <geom/geom.h>
  52 #include <geom/geom_ctl.h>
  53 #include <geom/geom_int.h>
  54
  55 #include <efivar.h>
  56 #include <efiutil.h>
  57 #include <efichar.h>
  58 #include <efivar-dp.h>
  59
  60 #ifndef LOAD_OPTION_ACTIVE
  61 #define LOAD_OPTION_ACTIVE 0x00000001
  62 #endif
  63
  64 #ifndef LOAD_OPTION_CATEGORY_BOOT
  65 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
  66 #endif
  67
  68 #define BAD_LENGTH      ((size_t)-1)
  69
  70 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
  71
  72 typedef struct _bmgr_opts {
  73         char    *env;
  74         char    *loader;
  75         char    *label;
  76         char    *kernel;
  77         char    *name;
  78         char    *order;
  79         int     bootnum;
  80         bool    copy;
  81         bool    create;
  82         bool    delete;
  83         bool    delete_bootnext;
  84         bool    del_timeout;
  85         bool    dry_run;
  86         bool    device_path;
  87         bool    esp_device;
  88         bool    fw_ui;
  89         bool    no_fw_ui;
  90         bool    has_bootnum;
  91         bool    once;
  92         int     cp_src;
  93         bool    set_active;
  94         bool    set_bootnext;
  95         bool    set_inactive;
  96         bool    set_timeout;
  97         int     timeout;
  98         bool    unix_path;
  99         bool    verbose;
 100 } bmgr_opts_t;
 101
 102 static struct option lopts[] = {
 103         {"activate", no_argument, NULL, 'a'},
 104         {"bootnext", no_argument, NULL, 'n'}, /* set bootnext */
 105         {"bootnum", required_argument, NULL, 'b'},
 106         {"bootorder", required_argument, NULL, 'o'}, /* set order */
 107         {"copy", required_argument, NULL, 'C'},         /* Copy boot method */
 108         {"create", no_argument, NULL, 'c'},
 109         {"deactivate", no_argument, NULL, 'A'},
 110         {"del-timeout", no_argument, NULL, 'T'},
 111         {"delete", no_argument, NULL, 'B'},
 112         {"delete-bootnext", no_argument, NULL, 'N'},
 113         {"device-path", no_argument, NULL, 'd'},
 114         {"dry-run", no_argument, NULL, 'D'},
 115         {"env", required_argument, NULL, 'e'},
 116         {"esp", no_argument, NULL, 'E'},
 117         {"fw-ui", no_argument, NULL, 'f'},
 118         {"no-fw-ui", no_argument, NULL, 'F'},
 119         {"help", no_argument, NULL, 'h'},
 120         {"kernel", required_argument, NULL, 'k'},
 121         {"label", required_argument, NULL, 'L'},
 122         {"loader", required_argument, NULL, 'l'},
 123         {"once", no_argument, NULL, 'O'},
 124         {"set-timeout", required_argument, NULL, 't'},
 125         {"unix-path", no_argument, NULL, 'p'},
 126         {"verbose", no_argument, NULL, 'v'},
 127         { NULL, 0, NULL, 0}
 128 };
 129
 130 /* global efibootmgr opts */
 131 static bmgr_opts_t opts;
 132
 133 static LIST_HEAD(efivars_head, entry) efivars =
 134         LIST_HEAD_INITIALIZER(efivars);
 135
 136 struct entry {
 137         efi_guid_t      guid;
 138         uint32_t        attrs;
 139         uint8_t         *data;
 140         size_t          size;
 141         char            *name;
 142         char            *label;
 143         int             idx;
 144         int             flags;
 145 #define SEEN    1
 146
 147         LIST_ENTRY(entry) entries;
 148 };
 149
 150 #define MAX_DP_LEN      4096
 151 #define MAX_LOADOPT_LEN 8192
 152
 153
 154 static char *
 155 mangle_loader(char *loader)
 156 {
 157         char *c;
 158
 159         for (c = loader; *c; c++)
 160                 if (*c == '/')
 161                         *c = '\\';
 162
 163         return loader;
 164 }
 165
 166
 167 #define COMMON_ATTRS EFI_VARIABLE_NON_VOLATILE | \
 168         EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 169         EFI_VARIABLE_RUNTIME_ACCESS
 170
 171 /*
 172  * We use global guid, and common var attrs and
 173  * find it better to just delete and re-create a var.
 174  */
 175 static int
 176 set_bootvar(const char *name, uint8_t *data, size_t size)
 177 {
 178
 179         return efi_set_variable(EFI_GLOBAL_GUID, name, data, size,
 180             COMMON_ATTRS);
 181 }
 182
 183
 184 #define USAGE \
 185         "   [-aAnB -b bootnum] [-N] [-t timeout] [-T] [-o bootorder] [-O] [--verbose] [--help]\n\
 186   [-c -l loader [-k kernel] [-L label] [--dry-run] [-b bootnum]]"
 187
 188 #define CREATE_USAGE \
 189         "       efibootmgr -c -l loader [-k kernel] [-L label] [--dry-run] [-b bootnum] [-a]"
 190 #define ORDER_USAGE \
 191         "       efibootmgr -o bootvarnum1,bootvarnum2,..."
 192 #define TIMEOUT_USAGE \
 193         "       efibootmgr -t seconds"
 194 #define DELETE_USAGE \
 195         "       efibootmgr -B -b bootnum"
 196 #define ACTIVE_USAGE \
 197         "       efibootmgr [-a | -A] -b bootnum"
 198 #define BOOTNEXT_USAGE \
 199         "       efibootmgr [-n | -N] -b bootnum"
 200
 201 static void
 202 parse_args(int argc, char *argv[])
 203 {
 204         int ch;
 205
 206         while ((ch = getopt_long(argc, argv, "AaBb:C:cdDe:EFfhk:L:l:NnOo:pTt:v",
 207                     lopts, NULL)) != -1) {
 208                 switch (ch) {
 209                 case 'A':
 210                         opts.set_inactive = true;
 211                         break;
 212                 case 'a':
 213                         opts.set_active = true;
 214                         break;
 215                 case 'b':
 216                         opts.has_bootnum = true;
 217                         opts.bootnum = strtoul(optarg, NULL, 16);
 218                         break;
 219                 case 'B':
 220                         opts.delete = true;
 221                         break;
 222                 case 'C':
 223                         opts.copy = true;
 224                         opts.cp_src = strtoul(optarg, NULL, 16);
 225                 case 'c':
 226                         opts.create = true;
 227                         break;
 228                 case 'D': /* should be remove dups XXX */
 229                         opts.dry_run = true;
 230                         break;
 231                 case 'd':
 232                         opts.device_path = true;
 233                         break;
 234                 case 'e':
 235                         free(opts.env);
 236                         opts.env = strdup(optarg);
 237                         break;
 238                 case 'E':
 239                         opts.esp_device = true;
 240                         break;
 241                 case 'F':
 242                         opts.no_fw_ui = true;
 243                         break;
 244                 case 'f':
 245                         opts.fw_ui = true;
 246                         break;
 247                 case 'h':
 248                 default:
 249                         errx(1, "%s", USAGE);
 250                         break;
 251                 case 'k':
 252                         free(opts.kernel);
 253                         opts.kernel = strdup(optarg);
 254                         break;
 255                 case 'L':
 256                         free(opts.label);
 257                         opts.label = strdup(optarg);
 258                         break;
 259                 case 'l':
 260                         free(opts.loader);
 261                         opts.loader = strdup(optarg);
 262                         opts.loader = mangle_loader(opts.loader);
 263                         break;
 264                 case 'N':
 265                         opts.delete_bootnext = true;
 266                         break;
 267                 case 'n':
 268                         opts.set_bootnext = true;
 269                         break;
 270                 case 'O':
 271                         opts.once = true;
 272                         break;
 273                 case 'o':
 274                         free(opts.order);
 275                         opts.order = strdup(optarg);
 276                         break;
 277                 case 'p':
 278                         opts.unix_path = true;
 279                         break;
 280                 case 'T':
 281                         opts.del_timeout = true;
 282                         break;
 283                 case 't':
 284                         opts.set_timeout = true;
 285                         opts.timeout = strtoul(optarg, NULL, 10);
 286                         break;
 287                 case 'v':
 288                         opts.verbose = true;
 289                         break;
 290                 }
 291         }
 292         if (opts.create) {
 293                 if (!opts.loader)
 294                         errx(1, "%s",CREATE_USAGE);
 295                 return;
 296         }
 297
 298         if (opts.order != NULL && *opts.order == '\0')
 299                 errx(1, "%s", ORDER_USAGE);
 300
 301         if ((opts.set_inactive || opts.set_active) && !opts.has_bootnum)
 302                 errx(1, "%s", ACTIVE_USAGE);
 303
 304         if (opts.delete && !opts.has_bootnum)
 305                 errx(1, "%s", DELETE_USAGE);
 306
 307         if (opts.set_bootnext && !opts.has_bootnum)
 308                 errx(1, "%s", BOOTNEXT_USAGE);
 309 }
 310
 311
 312 static void
 313 read_vars(void)
 314 {
 315
 316         efi_guid_t *guid;
 317         char *next_name = NULL;
 318         int ret = 0;
 319
 320         struct entry *nent;
 321
 322         LIST_INIT(&efivars);
 323         while ((ret = efi_get_next_variable_name(&guid, &next_name)) > 0) {
 324                 /*
 325                  * Only pay attention to EFI:BootXXXX variables to get the list.
 326                  */
 327                 if (efi_guid_cmp(guid, &EFI_GLOBAL_GUID) != 0 ||
 328                     strlen(next_name) != 8 ||
 329                     strncmp(next_name, "Boot", 4) != 0 ||
 330                     !isxdigit(next_name[4]) ||
 331                     !isxdigit(next_name[5]) ||
 332                     !isxdigit(next_name[6]) ||
 333                     !isxdigit(next_name[7]))
 334                         continue;
 335                 nent = malloc(sizeof(struct entry));
 336                 nent->name = strdup(next_name);
 337
 338                 ret = efi_get_variable(*guid, next_name, &nent->data,
 339                     &nent->size, &nent->attrs);
 340                 if (ret < 0)
 341                         err(1, "efi_get_variable");
 342                 nent->guid = *guid;
 343                 nent->idx = strtoul(&next_name[4], NULL, 16);
 344                 LIST_INSERT_HEAD(&efivars, nent, entries);
 345         }
 346 }
 347
 348
 349 static void
 350 set_boot_order(char *order)
 351 {
 352         uint16_t *new_data;
 353         size_t size;
 354         char *next, *cp;
 355         int cnt;
 356         int i;
 357
 358         cp = order;
 359         cnt = 1;
 360         while (*cp) {
 361                 if (*cp++ == ',')
 362                         cnt++;
 363         }
 364         size = sizeof(uint16_t) * cnt;
 365         new_data = malloc(size);
 366
 367         i = 0;
 368         cp = strdup(order);
 369         while ((next = strsep(&cp, ",")) != NULL) {
 370                 new_data[i] = strtoul(next, NULL, 16);
 371                 if (new_data[i] == 0 && errno == EINVAL) {
 372                         warnx("can't parse %s as a numb", next);
 373                         errx(1, "%s", ORDER_USAGE);
 374                 }
 375                 i++;
 376         }
 377         free(cp);
 378         if (set_bootvar("BootOrder", (uint8_t*)new_data, size) < 0)
 379                 err(1, "Unabke to set BootOrder to %s", order);
 380         free(new_data);
 381 }
 382
 383 static void
 384 handle_activity(int bootnum, bool active)
 385 {
 386         uint32_t attrs, load_attrs;
 387         uint8_t *data;
 388         size_t size;
 389         char *name;
 390
 391         asprintf(&name, "%s%04X", "Boot", bootnum);
 392         if (name == NULL)
 393                 err(1, "asprintf");
 394         if (efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, &attrs) < 0)
 395                 err(1, "No such bootvar %s\n", name);
 396
 397         load_attrs = le32dec(data);
 398
 399         if (active)
 400                 load_attrs |= LOAD_OPTION_ACTIVE;
 401         else
 402                 load_attrs &= ~LOAD_OPTION_ACTIVE;
 403
 404         le32enc(data, load_attrs);
 405
 406         if (set_bootvar(name, data, size) < 0)
 407                 err(1, "handle activity efi_set_variable");
 408 }
 409
 410
 411 /*
 412  * add boot var to boot order.
 413  * called by create boot var. There is no option
 414  * to add one independent of create.
 415  *
 416  * Note: we currently don't support where it goes
 417  * so it goes on the front, inactive.
 418  * use -o 2,3,7 etc to affect order, -a to activate.
 419  */
 420 static void
 421 add_to_boot_order(char *bootvar)
 422 {
 423         size_t size;
 424         uint32_t attrs;
 425         uint16_t val;
 426         uint8_t *data, *new;
 427
 428         val = strtoul(&bootvar[4], NULL, 16);
 429
 430         if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0) {
 431                 if (errno == ENOENT) { /* create it and set this bootvar to active */
 432                         size = 0;
 433                         data = NULL;
 434                 } else
 435                         err(1, "efi_get_variable BootOrder");
 436         }
 437
 438         /*
 439          * We have BootOrder with the current order
 440          * so grow the array by one, add the value
 441          * and write the new variable value.
 442          */
 443         size += sizeof(uint16_t);
 444         new = malloc(size);
 445         if (!new)
 446                 err(1, "malloc");
 447
 448         le16enc(new, val);
 449         if (size > sizeof(uint16_t))
 450                 memcpy(new + sizeof(uint16_t), data, size - sizeof(uint16_t));
 451
 452         if (set_bootvar("BootOrder", new, size) < 0)
 453                 err(1, "set_bootvar");
 454         free(new);
 455 }
 456
 457
 458 static void
 459 remove_from_order(uint16_t bootnum)
 460 {
 461         uint32_t attrs;
 462         size_t size, i, j;
 463         uint8_t *new, *data;
 464
 465         if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) < 0)
 466                 return;
 467
 468         new = malloc(size);
 469         if (new == NULL)
 470                 err(1, "malloc");
 471
 472         for (j = i = 0; i < size; i += sizeof(uint16_t)) {
 473                 if (le16dec(data + i) == bootnum)
 474                         continue;
 475                 memcpy(new + j, data + i, sizeof(uint16_t));
 476                 j += sizeof(uint16_t);
 477         }
 478         if (i == j)
 479                 warnx("Boot variable %04x not in BootOrder", bootnum);
 480         else if (set_bootvar("BootOrder", new, j) < 0)
 481                 err(1, "Unable to update BootOrder with new value");
 482         free(new);
 483 }
 484
 485
 486 static void
 487 delete_bootvar(int bootnum)
 488 {
 489         char *name;
 490         int defer = 0;
 491
 492         /*
 493          * Try to delete the boot variable and remocve it
 494          * from the boot order. We always do both actions
 495          * to make it easy to clean up from oopses.
 496          */
 497         if (bootnum < 0 || bootnum > 0xffff)
 498                 errx(1, "Bad boot variable %#x", bootnum);
 499         asprintf(&name, "%s%04X", "Boot", bootnum);
 500         if (name == NULL)
 501                 err(1, "asprintf");
 502         printf("Removing boot variable '%s'\n", name);
 503         if (efi_del_variable(EFI_GLOBAL_GUID, name) < 0) {
 504                 defer = 1;
 505                 warn("cannot delete variable %s", name);
 506         }
 507         printf("Removing 0x%x from BootOrder\n", bootnum);
 508         remove_from_order(bootnum);
 509         free(name);
 510         if (defer)
 511                 exit(defer);
 512 }
 513
 514
 515 static void
 516 del_bootnext(void)
 517 {
 518
 519         if (efi_del_variable(EFI_GLOBAL_GUID, "BootNext") < 0)
 520                 err(1, "efi_del_variable");
 521 }
 522
 523 static void
 524 handle_bootnext(uint16_t bootnum)
 525 {
 526         uint16_t num;
 527
 528         le16enc(&num, bootnum);
 529         if (set_bootvar("BootNext", (uint8_t*)&bootnum, sizeof(uint16_t)) < 0)
 530                 err(1, "set_bootvar");
 531 }
 532
 533
 534 static int
 535 compare(const void *a, const void *b)
 536 {
 537         uint16_t c;
 538         uint16_t d;
 539
 540         memcpy(&c, a, sizeof(uint16_t));
 541         memcpy(&d, b, sizeof(uint16_t));
 542
 543         if (c < d)
 544                 return -1;
 545         if (c == d)
 546                 return  0;
 547         return  1;
 548 }
 549
 550 static char *
 551 make_next_boot_var_name(void)
 552 {
 553         struct entry *v;
 554         uint16_t *vals, next_free = 0;
 555         char *name;
 556         int cnt = 0;
 557         int i;
 558
 559         LIST_FOREACH(v, &efivars, entries) {
 560                 cnt++;
 561         }
 562
 563         vals = malloc(sizeof(uint16_t) * cnt);
 564         if (!vals)
 565                 return NULL;
 566
 567         i = 0;
 568         LIST_FOREACH(v, &efivars, entries) {
 569                 vals[i++] = v->idx;
 570         }
 571         qsort(vals, cnt, sizeof(uint16_t), compare);
 572         /* if the hole is at the beginning, just return zero */
 573         if (vals[0] > 0) {
 574                 next_free = 0;
 575         } else {
 576                 /* now just run the list looking for the first hole */
 577                 for (i = 0; i < cnt - 1 && next_free == 0; i++)
 578                         if (vals[i] + 1 != vals[i + 1])
 579                                 next_free = vals[i] + 1;
 580                 if (next_free == 0)
 581                         next_free = vals[cnt - 1] + 1;
 582                 /* In theory we could have used all 65k slots -- what to do? */
 583         }
 584         free(vals);
 585
 586         asprintf(&name, "%s%04X", "Boot", next_free);
 587         if (name == NULL)
 588                 err(1, "asprintf");
 589         return name;
 590 }
 591
 592 static char *
 593 make_boot_var_name(uint16_t bootnum)
 594 {
 595         struct entry *v;
 596         char *name;
 597
 598         LIST_FOREACH(v, &efivars, entries) {
 599                 if (v->idx == bootnum)
 600                         return NULL;
 601         }
 602
 603         asprintf(&name, "%s%04X", "Boot", bootnum);
 604         if (name == NULL)
 605                 err(1, "asprintf");
 606         return name;
 607 }
 608
 609 static size_t
 610 create_loadopt(uint8_t *buf, size_t bufmax, uint32_t attributes, efidp dp, size_t dp_size,
 611     const char *description, const uint8_t *optional_data, size_t optional_data_size)
 612 {
 613         efi_char *bbuf = NULL;
 614         uint8_t *pos = buf;
 615         size_t desc_len = 0;
 616         size_t len;
 617
 618         if (optional_data == NULL && optional_data_size != 0)
 619                 return BAD_LENGTH;
 620         if (dp == NULL && dp_size != 0)
 621                 return BAD_LENGTH;
 622
 623         /*
 624          * Compute the length to make sure the passed in buffer is long enough.
 625          */
 626         utf8_to_ucs2(description, &bbuf, &desc_len);
 627         len = sizeof(uint32_t) + sizeof(uint16_t) + desc_len + dp_size + optional_data_size;
 628         if (len > bufmax) {
 629                 free(bbuf);
 630                 return BAD_LENGTH;
 631         }
 632
 633         le32enc(pos, attributes);
 634         pos += sizeof (attributes);
 635
 636         le16enc(pos, dp_size);
 637         pos += sizeof (uint16_t);
 638
 639         memcpy(pos, bbuf, desc_len);    /* NB:desc_len includes strailing NUL */
 640         pos += desc_len;
 641         free(bbuf);
 642
 643         memcpy(pos, dp, dp_size);
 644         pos += dp_size;
 645
 646         if (optional_data && optional_data_size > 0) {
 647                 memcpy(pos, optional_data, optional_data_size);
 648                 pos += optional_data_size;
 649         }
 650
 651         return pos - buf;
 652 }
 653
 654
 655 static int
 656 make_boot_var(const char *label, const char *loader, const char *kernel, const char *env, bool dry_run,
 657     int bootnum, bool activate)
 658 {
 659         struct entry *new_ent;
 660         uint32_t load_attrs = 0;
 661         uint8_t *load_opt_buf;
 662         size_t lopt_size, llen, klen;
 663         efidp dp, loaderdp, kerneldp;
 664         char *bootvar = NULL;
 665         int ret;
 666
 667         assert(label != NULL);
 668
 669         if (bootnum == -1)
 670                 bootvar = make_next_boot_var_name();
 671         else
 672                 bootvar = make_boot_var_name((uint16_t)bootnum);
 673         if (bootvar == NULL)
 674                 err(1, "bootvar creation");
 675         if (loader == NULL)
 676                 errx(1, "Must specify boot loader");
 677         ret = efivar_unix_path_to_device_path(loader, &loaderdp);
 678         if (ret != 0)
 679                 errc(1, ret, "Cannot translate unix loader path '%s' to UEFI",
 680                     loader);
 681         if (kernel != NULL) {
 682                 ret = efivar_unix_path_to_device_path(kernel, &kerneldp);
 683                 if (ret != 0)
 684                         errc(1, ret,
 685                             "Cannot translate unix kernel path '%s' to UEFI",
 686                             kernel);
 687         } else {
 688                 kerneldp = NULL;
 689         }
 690         llen = efidp_size(loaderdp);
 691         if (llen > MAX_DP_LEN)
 692                 errx(1, "Loader path too long.");
 693         klen = efidp_size(kerneldp);
 694         if (klen > MAX_DP_LEN)
 695                 errx(1, "Kernel path too long.");
 696         dp = malloc(llen + klen);
 697         if (dp == NULL)
 698                 errx(1, "Can't allocate memory for new device paths");
 699         memcpy(dp, loaderdp, llen);
 700         if (kerneldp != NULL)
 701                 memcpy((char *)dp + llen, kerneldp, klen);
 702
 703         /* don't make the new bootvar active by default, use the -a option later */
 704         load_attrs = LOAD_OPTION_CATEGORY_BOOT;
 705         if (activate)
 706                 load_attrs |= LOAD_OPTION_ACTIVE;
 707         load_opt_buf = malloc(MAX_LOADOPT_LEN);
 708         if (load_opt_buf == NULL)
 709                 err(1, "malloc");
 710
 711         lopt_size = create_loadopt(load_opt_buf, MAX_LOADOPT_LEN, load_attrs,
 712             dp, llen + klen, label, env, env ? strlen(env) + 1 : 0);
 713         if (lopt_size == BAD_LENGTH)
 714                 errx(1, "Can't create loadopt");
 715
 716         ret = 0;
 717         if (!dry_run) {
 718                 ret = efi_set_variable(EFI_GLOBAL_GUID, bootvar,
 719                     (uint8_t*)load_opt_buf, lopt_size, COMMON_ATTRS);
 720         }
 721
 722         if (ret)
 723                 err(1, "efi_set_variable");
 724
 725         if (!dry_run)
 726                 add_to_boot_order(bootvar); /* first, still not active */
 727         new_ent = malloc(sizeof(struct entry));
 728         if (new_ent == NULL)
 729                 err(1, "malloc");
 730         memset(new_ent, 0, sizeof(struct entry));
 731         new_ent->name = bootvar;
 732         new_ent->guid = EFI_GLOBAL_GUID;
 733         LIST_INSERT_HEAD(&efivars, new_ent, entries);
 734         free(load_opt_buf);
 735         free(dp);
 736
 737         return 0;
 738 }
 739
 740
 741 static void
 742 print_loadopt_str(uint8_t *data, size_t datalen)
 743 {
 744         char *dev, *relpath, *abspath;
 745         uint32_t attr;
 746         uint16_t fplen;
 747         efi_char *descr;
 748         uint8_t *ep = data + datalen;
 749         uint8_t *walker = data;
 750         efidp dp, edp;
 751         char buf[1024];
 752         int len;
 753         int rv;
 754         int indent;
 755
 756         if (datalen < sizeof(attr) + sizeof(fplen) + sizeof(efi_char))
 757                 return;
 758         // First 4 bytes are attribute flags
 759         attr = le32dec(walker);
 760         walker += sizeof(attr);
 761         // Next two bytes are length of the file paths
 762         fplen = le16dec(walker);
 763         walker += sizeof(fplen);
 764         // Next we have a 0 terminated UCS2 string that we know to be aligned
 765         descr = (efi_char *)(intptr_t)(void *)walker;
 766         len = ucs2len(descr); // XXX need to sanity check that len < (datalen - (ep - walker) / 2)
 767         walker += (len + 1) * sizeof(efi_char);
 768         if (walker > ep)
 769                 return;
 770         // Now we have fplen bytes worth of file path stuff
 771         dp = (efidp)walker;
 772         walker += fplen;
 773         if (walker > ep)
 774                 return;
 775         edp = (efidp)walker;
 776         /*
 777          * Everything left is the binary option args
 778          * opt = walker;
 779          * optlen = ep - walker;
 780          */
 781         indent = 1;
 782         while (dp < edp) {
 783                 efidp_format_device_path(buf, sizeof(buf), dp,
 784                     (intptr_t)(void *)edp - (intptr_t)(void *)dp);
 785                 printf("%*s%s\n", indent, "", buf);
 786                 indent = 10 + len + 1;
 787                 rv = efivar_device_path_to_unix_path(dp, &dev, &relpath, &abspath);
 788                 if (rv == 0) {
 789                         printf("%*s%s:%s %s\n", indent + 4, "", dev, relpath, abspath);
 790                         free(dev);
 791                         free(relpath);
 792                         free(abspath);
 793                 }
 794                 dp = (efidp)((char *)dp + efidp_size(dp));
 795         }
 796 }
 797
 798 static char *
 799 get_descr(uint8_t *data)
 800 {
 801         uint8_t *pos = data;
 802         efi_char *desc;
 803         int  len;
 804         char *buf;
 805         int i = 0;
 806
 807         pos += sizeof(uint32_t) + sizeof(uint16_t);
 808         desc = (efi_char*)(intptr_t)(void *)pos;
 809         len = ucs2len(desc);
 810         buf = malloc(len + 1);
 811         memset(buf, 0, len + 1);
 812         while (desc[i]) {
 813                 buf[i] = desc[i];
 814                 i++;
 815         }
 816         return (char*)buf;
 817 }
 818
 819
 820 static bool
 821 print_boot_var(const char *name, bool verbose, bool curboot)
 822 {
 823         size_t size;
 824         uint32_t load_attrs;
 825         uint8_t *data;
 826         int ret;
 827         char *d;
 828
 829         ret = efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, NULL);
 830         if (ret < 0)
 831                 return false;
 832         load_attrs = le32dec(data);
 833         d = get_descr(data);
 834         printf("%c%s%c %s", curboot ? '+' : ' ', name,
 835             ((load_attrs & LOAD_OPTION_ACTIVE) ? '*': ' '), d);
 836         free(d);
 837         if (verbose)
 838                 print_loadopt_str(data, size);
 839         else
 840                 printf("\n");
 841         return true;
 842 }
 843
 844
 845 static bool
 846 os_indication_supported(uint64_t indication)
 847 {
 848         uint8_t *data;
 849         size_t size;
 850         uint32_t attrs;
 851         int ret;
 852
 853         ret = efi_get_variable(EFI_GLOBAL_GUID, "OsIndicationsSupported", &data,
 854             &size, &attrs);
 855         if (ret < 0)
 856                 return false;
 857         return (le64dec(data) & indication) == indication;
 858 }
 859
 860 static uint64_t
 861 os_indications(void)
 862 {
 863         uint8_t *data;
 864         size_t size;
 865         uint32_t attrs;
 866         int ret;
 867
 868         ret = efi_get_variable(EFI_GLOBAL_GUID, "OsIndications", &data, &size,
 869             &attrs);
 870         if (ret < 0)
 871                 return 0;
 872         return le64dec(data);
 873 }
 874
 875 static int
 876 os_indications_set(uint64_t mask, uint64_t val)
 877 {
 878         uint8_t new[sizeof(uint64_t)];
 879
 880         le64enc(&new, (os_indications() & ~mask) | (val & mask));
 881         return set_bootvar("OsIndications", new, sizeof(new));
 882 }
 883
 884 /* Cmd epilogue, or just the default with no args.
 885  * The order is [bootnext] bootcurrent, timeout, order, and the bootvars [-v]
 886  */
 887 static int
 888 print_boot_vars(bool verbose)
 889 {
 890         /*
 891          * just read and print the current values
 892          * as a command epilogue
 893          */
 894         struct entry *v;
 895         uint8_t *data;
 896         size_t size;
 897         uint32_t attrs;
 898         int ret, bolen;
 899         uint16_t *boot_order = NULL, current;
 900         bool boot_to_fw_ui;
 901
 902         if (os_indication_supported(EFI_OS_INDICATIONS_BOOT_TO_FW_UI)) {
 903                 boot_to_fw_ui =
 904                     (os_indications() & EFI_OS_INDICATIONS_BOOT_TO_FW_UI) != 0;
 905                 printf("Boot to FW : %s\n", boot_to_fw_ui != 0 ?
 906                     "true" : "false");
 907         }
 908
 909         ret = efi_get_variable(EFI_GLOBAL_GUID, "BootNext", &data, &size, &attrs);
 910         if (ret > 0) {
 911                 printf("BootNext : %04x\n", le16dec(data));
 912         }
 913
 914         ret = efi_get_variable(EFI_GLOBAL_GUID, "BootCurrent", &data, &size,&attrs);
 915         current = le16dec(data);
 916         printf("BootCurrent: %04x\n", current);
 917
 918         ret = efi_get_variable(EFI_GLOBAL_GUID, "Timeout", &data, &size, &attrs);
 919         if (ret > 0) {
 920                 printf("Timeout    : %d seconds\n", le16dec(data));
 921         }
 922
 923         if (efi_get_variable(EFI_GLOBAL_GUID, "BootOrder", &data, &size, &attrs) > 0) {
 924                 if (size % 2 == 1)
 925                         warn("Bad BootOrder variable: odd length %d", (int)size);
 926                 boot_order = malloc(size);
 927                 bolen = size / 2;
 928                 printf("BootOrder  : ");
 929                 for (size_t i = 0; i < size; i += 2) {
 930                         boot_order[i / 2] = le16dec(data + i);
 931                         printf("%04X%s", boot_order[i / 2], i == size - 2 ? "\n" : ", ");
 932                 }
 933         }
 934
 935         if (boot_order == NULL) {
 936                 /*
 937                  * now we want to fetch 'em all fresh again
 938                  * which possibly includes a newly created bootvar
 939                  */
 940                 LIST_FOREACH(v, &efivars, entries) {
 941                         print_boot_var(v->name, verbose, v->idx == current);
 942                 }
 943         } else {
 944                 LIST_FOREACH(v, &efivars, entries) {
 945                         v->flags = 0;
 946                 }
 947                 for (int i = 0; i < bolen; i++) {
 948                         char buffer[10];
 949
 950                         snprintf(buffer, sizeof(buffer), "Boot%04X", boot_order[i]);
 951                         if (!print_boot_var(buffer, verbose, boot_order[i] == current))
 952                                 printf("%s: MISSING!\n", buffer);
 953                         LIST_FOREACH(v, &efivars, entries) {
 954                                 if (v->idx == boot_order[i]) {
 955                                         v->flags |= SEEN;
 956                                         break;
 957                                 }
 958                         }
 959                 }
 960                 if (verbose) {
 961                         printf("\n\nUnreferenced Variables:\n");
 962                         LIST_FOREACH(v, &efivars, entries) {
 963                                 if (v->flags == 0)
 964                                         print_boot_var(v->name, verbose, v->idx == current);
 965                         }
 966                 }
 967         }
 968         return 0;
 969 }
 970
 971 static void
 972 delete_timeout(void)
 973 {
 974
 975         efi_del_variable(EFI_GLOBAL_GUID,"Timeout");
 976 }
 977
 978 static void
 979 handle_timeout(int to)
 980 {
 981         uint16_t timeout;
 982
 983         le16enc(&timeout, to);
 984         if (set_bootvar("Timeout", (uint8_t *)&timeout, sizeof(timeout)) < 0)
 985                 errx(1, "Can't set Timeout for booting.");
 986 }
 987
 988 static void
 989 report_esp_device(bool do_dp, bool do_unix)
 990 {
 991         uint8_t *data;
 992         size_t size, len;
 993         uint32_t attrs;
 994         int ret;
 995         uint16_t current, fplen;
 996         char *name, *dev, *relpath, *abspath;
 997         uint8_t *walker, *ep;
 998         efi_char *descr;
 999         efidp dp, edp;
1000         char buf[PATH_MAX];
1001
1002         if (do_dp && do_unix)
1003                 errx(1, "Can't report both UEFI device-path and Unix path together");
1004
1005         ret = efi_get_variable(EFI_GLOBAL_GUID, "BootCurrent", &data, &size,&attrs);
1006         if (ret < 0)
1007                 err(1, "Can't get BootCurrent");
1008         current = le16dec(data);
1009         if (asprintf(&name, "Boot%04X", current) < 0)
1010                 err(1, "Can't format boot var\n");
1011         if (efi_get_variable(EFI_GLOBAL_GUID, name, &data, &size, NULL) < 0)
1012                 err(1, "Can't retrieve EFI var %s", name);
1013         // First 4 bytes are attribute flags
1014         walker = data;
1015         ep = walker + size;
1016         walker += sizeof(uint32_t);
1017         // Next two bytes are length of the file paths
1018         fplen = le16dec(walker);
1019         walker += sizeof(fplen);
1020         // Next we have a 0 terminated UCS2 string that we know to be aligned
1021         descr = (efi_char *)(intptr_t)(void *)walker;
1022         len = ucs2len(descr); // XXX need to sanity check that len < (datalen - (ep - walker) / 2)
1023         walker += (len + 1) * sizeof(efi_char);
1024         if (walker > ep)
1025                 errx(1, "malformed boot variable %s", name);
1026         // Now we have fplen bytes worth of file path stuff
1027         dp = (efidp)walker;
1028         walker += fplen;
1029         edp = (efidp)walker;
1030         if (walker > ep)
1031                 errx(1, "malformed boot variable %s", name);
1032         if (do_dp) {
1033                 efidp_format_device_path_node(buf, sizeof(buf), dp);
1034                 printf("%s\n", buf);
1035                 exit(0);
1036         }
1037         if (efivar_device_path_to_unix_path(dp, &dev, &relpath, &abspath) != 0)
1038                 errx(1, "Can't convert to unix path");
1039         if (do_unix) {
1040                 if (abspath == NULL)
1041                         errx(1, "Can't find where %s:%s is mounted",
1042                             dev, relpath);
1043                 abspath[strlen(abspath) - strlen(relpath) - 1] = '\0';
1044                 printf("%s\n", abspath);
1045         } else {
1046                 printf("%s\n", dev);
1047         }
1048         free(dev);
1049         free(relpath);
1050         free(abspath);
1051         exit(0);
1052 }
1053
1054 static void
1055 set_boot_to_fw_ui(bool to_fw)
1056 {
1057         int ret;
1058
1059         if (!os_indication_supported(EFI_OS_INDICATIONS_BOOT_TO_FW_UI)) {
1060                 if (to_fw)
1061                         errx(1, "boot to fw ui not supported");
1062                 else
1063                         return;
1064         }
1065         ret = os_indications_set(EFI_OS_INDICATIONS_BOOT_TO_FW_UI,
1066             to_fw ? ~0 : 0);
1067         if (ret < 0)
1068                 errx(1, "failed to set boot to fw ui");
1069 }
1070
1071 int
1072 main(int argc, char *argv[])
1073 {
1074
1075         if (!efi_variables_supported())
1076                 errx(1, "efi variables not supported on this system. root? kldload efirt?");
1077
1078         memset(&opts, 0, sizeof (bmgr_opts_t));
1079         parse_args(argc, argv);
1080         read_vars();
1081
1082         if (opts.create)
1083                 /*
1084                  * side effect, adds to boot order, but not yet active.
1085                  */
1086                 make_boot_var(opts.label ? opts.label : "",
1087                     opts.loader, opts.kernel, opts.env, opts.dry_run,
1088                     opts.has_bootnum ? opts.bootnum : -1, opts.set_active);
1089         else if (opts.set_active || opts.set_inactive )
1090                 handle_activity(opts.bootnum, opts.set_active);
1091         else if (opts.order != NULL)
1092                 set_boot_order(opts.order); /* create a new bootorder with opts.order */
1093         else if (opts.set_bootnext)
1094                 handle_bootnext(opts.bootnum);
1095         else if (opts.delete_bootnext)
1096                 del_bootnext();
1097         else if (opts.delete)
1098                 delete_bootvar(opts.bootnum);
1099         else if (opts.del_timeout)
1100                 delete_timeout();
1101         else if (opts.set_timeout)
1102                 handle_timeout(opts.timeout);
1103         else if (opts.esp_device)
1104                 report_esp_device(opts.device_path, opts.unix_path);
1105         else if (opts.fw_ui)
1106                 set_boot_to_fw_ui(true);
1107         else if (opts.no_fw_ui)
1108                 set_boot_to_fw_ui(false);
1109
1110         print_boot_vars(opts.verbose);
1111 }