2 efibootmgr.c - Manipulates EFI variables as exported in /proc/efi/vars
4 Copyright (C) 2001-2004 Dell, Inc. <Matt_Domsch@dell.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 This must tie the EFI_DEVICE_PATH to /boot/efi/elilo.efi
22 The EFI_DEVICE_PATH will look something like:
23 ACPI device path, length 12 bytes
24 Hardware Device Path, PCI, length 6 bytes
25 Messaging Device Path, SCSI, length 8 bytes, or ATAPI, length ??
26 Media Device Path, Hard Drive, partition XX, length 30 bytes
27 Media Device Path, File Path, length ??
28 End of Hardware Device Path, length 4
29 Arguments passed to elilo, as UCS-2 characters, length ??
49 #include "unparse_path.h"
51 #include "efibootmgr.h"
54 #ifndef EFIBOOTMGR_VERSION
55 #define EFIBOOTMGR_VERSION "unknown (fix Makefile!)"
59 typedef struct _var_entry {
62 efi_variable_t var_data;
67 /* global variables */
68 static LIST_HEAD(boot_entry_list);
69 static LIST_HEAD(blk_list);
70 efibootmgr_opt_t opts;
73 var_num_from_name(const char *pattern, char *name, uint16_t *num)
75 sscanf(name, pattern, num);
79 fill_bootvar_name(char *dest, size_t len, const char *name)
81 efi_guid_t guid = EFI_GLOBAL_VARIABLE;
83 efi_guid_unparse(&guid, text_uuid);
84 snprintf(dest, len, "%s-%s", name, text_uuid);
88 fill_var(efi_variable_t *var, const char *name)
90 efi_guid_t guid = EFI_GLOBAL_VARIABLE;
92 efichar_from_char(var->VariableName, name, 1024);
93 memcpy(&var->VendorGuid, &guid, sizeof(guid));
94 var->Attributes = EFI_VARIABLE_NON_VOLATILE
95 | EFI_VARIABLE_BOOTSERVICE_ACCESS
96 | EFI_VARIABLE_RUNTIME_ACCESS;
101 read_vars(struct dirent **namelist,
109 if (!namelist) return;
111 for (i=0; i < num_boot_names; i++)
114 entry = malloc(sizeof(var_entry_t));
116 memset(entry, 0, sizeof(var_entry_t));
118 status = read_variable(namelist[i]->d_name,
120 if (status != EFI_SUCCESS) break;
121 entry->name = namelist[i];
122 list_add_tail(&entry->list, head);
133 free_dirents(struct dirent **ptr, int num_dirents)
137 for (i=0; i < num_dirents; i++) {
149 compare(const void *a, const void *b)
153 memcpy(&n1, a, sizeof(n1));
154 memcpy(&n2, b, sizeof(n2));
155 if (n1 < n2) rc = -1;
156 if (n1 == n2) rc = 0;
163 Return an available boot variable number,
167 find_free_boot_var(list_t *boot_list)
169 int num_vars=0, i=0, found;
170 uint16_t *vars, free_number;
173 list_for_each(pos, boot_list) {
176 vars = malloc(sizeof(uint16_t) * num_vars);
177 if (!vars) return -1;
178 memset(vars, 0, sizeof(uint16_t) * num_vars);
180 list_for_each(pos, boot_list) {
181 boot = list_entry(pos, var_entry_t, list);
185 qsort(vars, i, sizeof(uint16_t), compare);
189 for (free_number = 0; free_number < num_vars && found; free_number++) {
191 list_for_each(pos, boot_list) {
192 boot = list_entry(pos, var_entry_t, list);
193 if (boot->num == free_number) {
200 if (found && num_vars) free_number = vars[num_vars-1] + 1;
207 warn_duplicate_name(list_t *boot_list)
211 EFI_LOAD_OPTION *load_option;
213 list_for_each(pos, boot_list) {
214 boot = list_entry(pos, var_entry_t, list);
215 load_option = (EFI_LOAD_OPTION *)
217 if (!efichar_char_strcmp(opts.label,
218 load_option->description)) {
219 fprintf(stderr, "** Warning ** : %.8s has same label %s\n",
228 make_boot_var(list_t *boot_list)
234 if (opts.bootnum == -1)
235 free_number = find_free_boot_var(boot_list);
237 list_for_each(pos, boot_list) {
238 boot = list_entry(pos, var_entry_t, list);
239 if (boot->num == opts.bootnum) {
240 fprintf(stderr, "** Warning ** : bootnum %04X "
241 "already exists\n", opts.bootnum);
245 free_number = opts.bootnum;
248 if (free_number == -1) return NULL;
250 /* Create a new var_entry_t object
254 boot = malloc(sizeof(*boot));
255 if (!boot) return NULL;
256 memset(boot, 0, sizeof(*boot));
257 boot->num = free_number;
258 if (!make_linux_efi_variable(&boot->var_data, free_number)) {
262 create_variable(&boot->var_data);
263 list_add_tail(&boot->list, boot_list);
270 read_boot(efi_variable_t *var, const char *name)
272 char name_guid[PATH_MAX];
274 memset(var, 0, sizeof(*var));
275 fill_bootvar_name(name_guid, sizeof(name_guid), name);
276 return read_variable(name_guid, var);
280 read_boot_order(efi_variable_t *boot_order)
284 status = read_boot(boot_order, "BootOrder");
285 if (status != EFI_SUCCESS && status != EFI_NOT_FOUND)
288 if (status == EFI_NOT_FOUND) {
289 fill_var(boot_order, "BootOrder");
296 add_to_boot_order(uint16_t num)
299 efi_variable_t boot_order;
300 uint64_t new_data_size;
301 uint16_t *new_data, *old_data;
303 status = read_boot_order(&boot_order);
304 if (status != EFI_SUCCESS) return status;
306 /* We've now got an array (in boot_order.Data) of the
307 boot order. First add our entry, then copy the old array.
309 old_data = (uint16_t *)&(boot_order.Data);
310 new_data_size = boot_order.DataSize + sizeof(uint16_t);
311 new_data = malloc(new_data_size);
314 memcpy(new_data+1, old_data, boot_order.DataSize);
316 /* Now new_data has what we need */
317 memcpy(&(boot_order.Data), new_data, new_data_size);
318 boot_order.DataSize = new_data_size;
319 return create_or_edit_variable(&boot_order);
324 remove_from_boot_order(uint16_t num)
327 efi_variable_t boot_order;
328 uint64_t new_data_size;
329 uint16_t *new_data, *old_data;
331 char boot_order_name[PATH_MAX];
333 status = read_boot_order(&boot_order);
334 if (status != EFI_SUCCESS) return status;
335 /* If it's empty, yea! */
336 if (!boot_order.DataSize) return EFI_SUCCESS;
338 fill_bootvar_name(boot_order_name, sizeof(boot_order_name),
341 /* We've now got an array (in boot_order.Data) of the
342 boot order. Simply copy the array, skipping the
343 entry we're deleting.
345 old_data = (uint16_t *)&(boot_order.Data);
346 /* Start with the same size */
347 new_data_size = boot_order.DataSize;
348 new_data = malloc(new_data_size);
349 for (old_i=0,new_i=0;
350 old_i < boot_order.DataSize / sizeof(uint16_t);
352 if (old_data[old_i] != num) {
353 /* Copy this value */
354 new_data[new_i] = old_data[old_i];
359 /* Now new_data has what we need */
360 new_data_size = new_i * sizeof(uint16_t);
361 memset(&(boot_order.Data), 0, boot_order.DataSize);
362 memcpy(&(boot_order.Data), new_data, new_data_size);
363 boot_order.DataSize = new_data_size;
365 return edit_variable(&boot_order);
369 delete_var(const char *name)
373 memset(&var, 0, sizeof(var));
374 fill_var(&var, name);
375 return delete_variable(&var);
379 read_boot_u16(const char *name)
383 uint16_t *n = (uint16_t *)(var.Data);
385 memset(&var, 0, sizeof(var));
386 status = read_boot(&var, name);
387 if (status) return -1;
392 set_boot_u16(const char *name, uint16_t num)
395 uint16_t *n = (uint16_t *)var.Data;
397 memset(&var, 0, sizeof(var));
399 fill_var(&var, name);
401 var.DataSize = sizeof(uint16_t);
402 return create_or_edit_variable(&var);
406 delete_boot_var(uint16_t num)
414 snprintf(name, sizeof(name), "Boot%04X", num);
415 memset(&var, 0, sizeof(var));
416 fill_var(&var, name);
417 status = delete_variable(&var);
419 /* For backwards compatibility, try to delete abcdef entries as well */
421 snprintf(name, sizeof(name), "Boot%04x", num);
422 memset(&var, 0, sizeof(var));
423 fill_var(&var, name);
424 status = delete_variable(&var);
427 if (status) return status;
428 list_for_each_safe(pos, n, &boot_entry_list) {
429 boot = list_entry(pos, var_entry_t, list);
430 if (boot->num == num) {
431 status = remove_from_boot_order(num);
432 if (status) return status;
433 list_del(&(boot->list));
434 break; /* short-circuit since it was found */
442 set_var_nums(const char *pattern, list_t *list)
450 list_for_each(pos, list) {
451 var = list_entry(pos, var_entry_t, list);
452 rc = sscanf(var->name->d_name, pattern, &num);
455 name = var->name->d_name; /* shorter name */
456 if ((isalpha(name[4]) && islower(name[4])) ||
457 (isalpha(name[5]) && islower(name[5])) ||
458 (isalpha(name[6]) && islower(name[6])) ||
459 (isalpha(name[7]) && islower(name[7]))) {
460 fprintf(stderr, "** Warning ** : %.8s is not "
461 "EFI 1.10 compliant (lowercase hex in name)\n", name);
467 fprintf(stderr, "** Warning ** : please recreate these using efibootmgr to remove this warning.\n");
472 static efi_variable_t *
473 find_pci_scsi_disk_blk(int fd, int bus, int device, int func,
479 unsigned char host, channel, id, lun;
481 efi_variable_t *blk_var;
484 memset(&idlun, 0, sizeof(idlun));
485 rc = get_scsi_idlun(fd, &idlun);
488 rc = disk_get_size(fd, &size);
490 idlun_to_components(&idlun, &host, &channel, &id, &lun);
492 list_for_each(pos, blk_list) {
493 blk = list_entry(pos, var_entry_t, list);
494 blk_var = blk->var_data;
496 if (!compare_pci_scsi_disk_blk(blk_var,
498 host, channel, id, lun,
509 /* The right blkX variable contains:
510 1) the PCI and SCSI information for the disk passed in disk_name
511 2) Does not contain a partition field
515 static efi_variable_t *
516 find_disk_blk(char *disk_name, list_t *blk_list)
518 efi_variable_t *disk_blk = NULL;
520 unsigned char bus=0,device=0,func=0;
521 int interface_type=interface_type_unknown;
522 unsigned int controllernum=0, disknum=0;
523 unsigned char part=0;
525 fd = open(disk_name, O_RDONLY|O_DIRECT);
526 rc = disk_get_pci(fd, &bus, &device, &func);
528 fprintf(stderr, "disk_get_pci() failed.\n");
531 rc = disk_info_from_fd(fd,
537 fprintf(stderr, "disk_info_from_fd() failed.\n");
540 switch (interface_type)
543 return find_pci_scsi_disk_blk(fd,bus,device,func,blk_list);
546 return find_pci_ata_disk_blk(fd,bus,device,func,blk_list);
549 return find_pci_i2o_disk_blk(fd,bus,device,func,blk_list);
552 return find_pci_md_disk_blk(fd,bus,device,func,blk_list);
562 unparse_boot_order(uint16_t *order, int length)
565 printf("BootOrder: ");
566 for (i=0; i<length; i++) {
567 printf("%04X", order[i]);
575 parse_boot_order(char *buffer, uint16_t *order, int length)
580 for (i=0; i<length && *buffer; i++) {
581 rc = sscanf(buffer, "%x", &num);
582 if (rc == 1) order[i] = num & 0xFFFF;
583 /* Advance to the comma */
584 while (*buffer && *buffer != ',') buffer++;
585 /* Advance through the comma(s) */
586 while (*buffer && *buffer == ',') buffer++;
594 efi_variable_t boot_order;
595 uint16_t *n = (uint16_t *)boot_order.Data;
597 if (!opts.bootorder) return EFI_SUCCESS;
599 memset(&boot_order, 0, sizeof(boot_order));
600 fill_var(&boot_order, "BootOrder");
602 boot_order.DataSize = parse_boot_order(opts.bootorder, n, 1024/sizeof(uint16_t)) * sizeof(uint16_t);
603 return create_or_edit_variable(&boot_order);
611 char description[80];
612 EFI_LOAD_OPTION *load_option;
613 EFI_DEVICE_PATH *path;
614 char text_path[1024], *p;
615 unsigned long optional_data_len=0;
617 list_for_each(pos, &boot_entry_list) {
618 boot = list_entry(pos, var_entry_t, list);
619 load_option = (EFI_LOAD_OPTION *)
621 efichar_to_char(description,
622 load_option->description, sizeof(description));
623 memset(text_path, 0, sizeof(text_path));
624 path = load_option_path(load_option);
626 printf("%.8s", boot->name->d_name);
628 printf("Boot%04X", boot->num);
630 if (load_option->attributes & LOAD_OPTION_ACTIVE)
633 printf("%s", description);
636 unparse_path(text_path, path,
637 load_option->file_path_list_length);
638 /* Print optional data */
640 boot->var_data.DataSize -
641 load_option->file_path_list_length -
642 ((char *)path - (char *)load_option);
643 if (optional_data_len) {
645 p += strlen(text_path);
646 unparse_raw_text(p, ((uint8_t *)path) +
647 load_option->file_path_list_length,
651 printf("\t%s", text_path);
663 efi_variable_t boot_order;
666 status = read_boot_order(&boot_order);
668 if (status != EFI_SUCCESS) {
669 perror("show_boot_order()");
673 /* We've now got an array (in boot_order.Data) of the
674 boot order. First add our entry, then copy the old array.
676 data = (uint16_t *)&(boot_order.Data);
677 if (boot_order.DataSize)
678 unparse_boot_order(data, boot_order.DataSize / sizeof(uint16_t));
687 EFI_LOAD_OPTION *load_option;
689 list_for_each(pos, &boot_entry_list) {
690 boot = list_entry(pos, var_entry_t, list);
691 load_option = (EFI_LOAD_OPTION *)
693 if (boot->num == opts.bootnum) {
694 if (opts.active == 1) {
695 if (load_option->attributes
696 & LOAD_OPTION_ACTIVE) return EFI_SUCCESS;
698 load_option->attributes
699 |= LOAD_OPTION_ACTIVE;
700 return edit_variable(&boot->var_data);
703 else if (opts.active == 0) {
704 if (!(load_option->attributes
705 & LOAD_OPTION_ACTIVE))
708 load_option->attributes
709 &= ~LOAD_OPTION_ACTIVE;
710 return edit_variable(&boot->var_data);
724 printf("efibootmgr version %s\n", EFIBOOTMGR_VERSION);
725 printf("usage: efibootmgr [options]\n");
726 printf("\t-a | --active sets bootnum active\n");
727 printf("\t-A | --inactive sets bootnum inactive\n");
728 printf("\t-b | --bootnum XXXX modify BootXXXX (hex)\n");
729 printf("\t-B | --delete-bootnum delete bootnum (hex)\n");
730 printf("\t-c | --create create new variable bootnum and add to bootorder\n");
731 printf("\t-d | --disk disk (defaults to /dev/sda) containing loader\n");
732 printf("\t-e | --edd [1|3|-1] force EDD 1.0 or 3.0 creation variables, or guess\n");
733 printf("\t-E | --device num EDD 1.0 device number (defaults to 0x80)\n");
734 printf("\t-g | --gpt force disk with invalid PMBR to be treated as GPT\n");
735 printf("\t-H | --acpi_hid XXXX set the ACPI HID (used with -i)\n");
736 printf("\t-i | --iface name create a netboot entry for the named interface\n");
737 printf("\t-l | --loader name (defaults to \\elilo.efi)\n");
738 printf("\t-L | --label label Boot manager display label (defaults to \"Linux\")\n");
739 printf("\t-n | --bootnext XXXX set BootNext to XXXX (hex)\n");
740 printf("\t-N | --delete-bootnext delete BootNext\n");
741 printf("\t-o | --bootorder XXXX,YYYY,ZZZZ,... explicitly set BootOrder (hex)\n");
742 printf("\t-O | --delete-bootorder delete BootOrder\n");
743 printf("\t-p | --part part (defaults to 1) containing loader\n");
744 printf("\t-q | --quiet be quiet\n");
745 printf("\t | --test filename don't write to NVRAM, write to filename.\n");
746 printf("\t-t | --timeout seconds set boot manager timeout waiting for user input.\n");
747 printf("\t-T | --delete-timeout delete Timeout.\n");
748 printf("\t-u | --unicode | --UCS-2 pass extra args as UCS-2 (default is ASCII)\n");
749 printf("\t-U | --acpi_uid XXXX set the ACPI UID (used with -i)\n");
750 printf("\t-v | --verbose print additional information\n");
751 printf("\t-V | --version return version and exit\n");
752 printf("\t-w | --write-signature write unique sig to MBR if needed\n");
758 memset(&opts, 0, sizeof(opts));
759 opts.bootnum = -1; /* auto-detect */
760 opts.bootnext = -1; /* Don't set it */
761 opts.active = -1; /* Don't set it */
762 opts.timeout = -1; /* Don't set it */
763 opts.edd10_devicenum = 0x80;
764 opts.loader = "\\elilo.efi";
765 opts.label = "Linux";
766 opts.disk = "/dev/sda";
774 parse_opts(int argc, char **argv)
777 int option_index = 0;
781 static struct option long_options[] =
782 /* name, has_arg, flag, val */
784 {"active", no_argument, 0, 'a'},
785 {"inactive", no_argument, 0, 'A'},
786 {"bootnum", required_argument, 0, 'b'},
787 {"delete-bootnum", no_argument, 0, 'B'},
788 {"create", no_argument, 0, 'c'},
789 {"disk", required_argument, 0, 'd'},
790 {"iface", required_argument, 0, 'i'},
791 {"acpi_hid", required_argument, 0, 'H'},
792 {"edd-device", required_argument, 0, 'E'},
793 {"edd30", required_argument, 0, 'e'},
794 {"gpt", no_argument, 0, 'g'},
795 {"loader", required_argument, 0, 'l'},
796 {"label", required_argument, 0, 'L'},
797 {"bootnext", required_argument, 0, 'n'},
798 {"delete-bootnext", no_argument, 0, 'N'},
799 {"bootorder", required_argument, 0, 'o'},
800 {"delete-bootorder", no_argument, 0, 'O'},
801 {"part", required_argument, 0, 'p'},
802 {"quiet", no_argument, 0, 'q'},
803 {"test", required_argument, 0, 1},
804 {"timeout", required_argument, 0, 't'},
805 {"delete-timeout", no_argument, 0, 'T'},
806 {"unicode", no_argument, 0, 'u'},
807 {"UCS-2", no_argument, 0, 'u'},
808 {"acpi_uid", required_argument, 0, 'U'},
809 {"verbose", optional_argument, 0, 'v'},
810 {"version", no_argument, 0, 'V'},
811 {"write-signature", no_argument, 0, 'w'},
815 c = getopt_long (argc, argv,
816 "AaBb:cd:e:E:gH:i:l:L:n:No:Op:qt:TuU:v::Vw",
817 long_options, &option_index);
830 opts.delete_boot = 1;
833 rc = sscanf(optarg, "%X", &num);
834 if (rc == 1) opts.bootnum = num;
843 rc = sscanf(optarg, "%d", &num);
844 if (rc == 1) opts.edd_version = num;
847 rc = sscanf(optarg, "%x", &num);
848 if (rc == 1) opts.edd10_devicenum = num;
854 rc = sscanf(optarg, "%x", &num);
855 if (rc == 1) opts.acpi_hid = num;
861 opts.loader = optarg;
867 opts.delete_bootnext = 1;
870 rc = sscanf(optarg, "%x", &num);
871 if (rc == 1) opts.bootnext = num;
874 opts.bootorder = optarg;
877 opts.delete_bootorder = 1;
880 rc = sscanf(optarg, "%u", &num);
881 if (rc == 1) opts.part = num;
887 opts.testfile = optarg;
890 rc = sscanf(optarg, "%u", &num);
893 opts.set_timeout = 1;
897 opts.delete_timeout = 1;
904 rc = sscanf(optarg, "%x", &num);
905 if (rc == 1) opts.acpi_uid = num;
910 if (!strcmp(optarg, "v")) opts.verbose = 2;
911 if (!strcmp(optarg, "vv")) opts.verbose = 3;
912 rc = sscanf(optarg, "%d", &num);
913 if (rc == 1) opts.verbose = num;
917 opts.showversion = 1;
921 opts.write_signature = 1;
933 opts.optind = optind;
939 main(int argc, char **argv)
941 struct dirent **boot_names = NULL;
942 var_entry_t *new_boot = NULL;
943 int num, num_boot_names=0;
946 parse_opts(argc, argv);
947 if (opts.showversion) {
948 printf("version %s\n", EFIBOOTMGR_VERSION);
952 if (opts.iface && opts.acpi_hid == -1 && opts.acpi_uid == -1) {
953 fprintf(stderr, "\nYou must specify the ACPI HID and UID when using -i.\n\n");
958 set_fs_kernel_calls();
960 if (!opts.testfile) {
961 num_boot_names = read_boot_var_names(&boot_names);
962 read_vars(boot_names, num_boot_names, &boot_entry_list);
963 set_var_nums("Boot%04X-%*s", &boot_entry_list);
965 if (opts.delete_boot) {
966 if (opts.bootnum == -1)
967 fprintf(stderr, "\nYou must specify a boot entry to delete (see the -b option).\n\n");
969 delete_boot_var(opts.bootnum);
972 if (opts.active >= 0) {
978 warn_duplicate_name(&boot_entry_list);
979 new_boot = make_boot_var(&boot_entry_list);
980 /* Put this boot var in the right BootOrder */
981 if (!opts.testfile && new_boot)
982 add_to_boot_order(new_boot->num);
985 if (!opts.testfile) {
987 if (opts.delete_bootorder) {
988 delete_var("BootOrder");
991 if (opts.bootorder) {
996 if (opts.delete_bootnext) {
997 delete_var("BootNext");
1000 if (opts.delete_timeout) {
1001 delete_var("Timeout");
1004 if (opts.bootnext >= 0) {
1005 set_boot_u16("BootNext", opts.bootnext & 0xFFFF);
1008 if (opts.set_timeout) {
1009 set_boot_u16("Timeout", opts.timeout);
1013 num = read_boot_u16("BootNext");
1015 printf("BootNext: %04X\n", num);
1017 num = read_boot_u16("BootCurrent");
1019 printf("BootCurrent: %04X\n", num);
1021 num = read_boot_u16("Timeout");
1023 printf("Timeout: %u seconds\n", num);
1029 free_dirents(boot_names, num_boot_names);