1 /* SPDX-License-Identifier: LGPL-2.1+ */
10 #include <linux/magic.h>
17 #include <sys/statfs.h>
22 #include "alloc-util.h"
23 #include "blkid-util.h"
26 #include "dirent-util.h"
32 #include "locale-util.h"
33 #include "main-func.h"
35 #include "parse-util.h"
36 #include "pretty-print.h"
38 #include "stat-util.h"
39 #include "stdio-util.h"
40 #include "string-util.h"
42 #include "terminal-util.h"
43 #include "tmpfile-util.h"
44 #include "umask-util.h"
50 static char *arg_esp_path
= NULL
;
51 static char *arg_xbootldr_path
= NULL
;
52 static bool arg_print_esp_path
= false;
53 static bool arg_print_dollar_boot_path
= false;
54 static bool arg_touch_variables
= true;
55 static PagerFlags arg_pager_flags
= 0;
57 STATIC_DESTRUCTOR_REGISTER(arg_esp_path
, freep
);
58 STATIC_DESTRUCTOR_REGISTER(arg_xbootldr_path
, freep
);
60 static const char *arg_dollar_boot_path(void) {
61 /* $BOOT shall be the XBOOTLDR partition if it exists, and otherwise the ESP */
62 return arg_xbootldr_path
?: arg_esp_path
;
65 static int acquire_esp(
66 bool unprivileged_mode
,
70 sd_id128_t
*ret_uuid
) {
75 /* Find the ESP, and log about errors. Note that find_esp_and_warn() will log in all error cases on
76 * its own, except for ENOKEY (which is good, we want to show our own message in that case,
77 * suggesting use of --esp-path=) and EACCESS (only when we request unprivileged mode; in this case
78 * we simply eat up the error here, so that --list and --status work too, without noise about
81 r
= find_esp_and_warn(arg_esp_path
, unprivileged_mode
, &np
, ret_part
, ret_pstart
, ret_psize
, ret_uuid
);
83 return log_error_errno(r
,
84 "Couldn't find EFI system partition. It is recommended to mount it to /boot or /efi.\n"
85 "Alternatively, use --esp-path= to specify path to mount point.");
89 free_and_replace(arg_esp_path
, np
);
90 log_debug("Using EFI System Partition at %s.", arg_esp_path
);
95 static int acquire_xbootldr(bool unprivileged_mode
, sd_id128_t
*ret_uuid
) {
99 r
= find_xbootldr_and_warn(arg_xbootldr_path
, unprivileged_mode
, &np
, ret_uuid
);
101 log_debug_errno(r
, "Didn't find an XBOOTLDR partition, using the ESP as $BOOT.");
103 *ret_uuid
= SD_ID128_NULL
;
109 free_and_replace(arg_xbootldr_path
, np
);
110 log_debug("Using XBOOTLDR partition at %s as $BOOT.", arg_xbootldr_path
);
115 /* search for "#### LoaderInfo: systemd-boot 218 ####" string inside the binary */
116 static int get_file_version(int fd
, char **v
) {
126 if (fstat(fd
, &st
) < 0)
127 return log_error_errno(errno
, "Failed to stat EFI binary: %m");
129 r
= stat_verify_regular(&st
);
131 return log_error_errno(r
, "EFI binary is not a regular file: %m");
133 if (st
.st_size
< 27) {
138 buf
= mmap(NULL
, st
.st_size
, PROT_READ
, MAP_PRIVATE
, fd
, 0);
139 if (buf
== MAP_FAILED
)
140 return log_error_errno(errno
, "Failed to memory map EFI binary: %m");
142 s
= memmem(buf
, st
.st_size
- 8, "#### LoaderInfo: ", 17);
147 e
= memmem(s
, st
.st_size
- (s
- buf
), " ####", 5);
148 if (!e
|| e
- s
< 3) {
149 r
= log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Malformed version string.");
153 x
= strndup(s
, e
- s
);
161 (void) munmap(buf
, st
.st_size
);
166 static int enumerate_binaries(const char *esp_path
, const char *path
, const char *prefix
) {
167 _cleanup_closedir_
DIR *d
= NULL
;
175 p
= prefix_roota(esp_path
, path
);
181 return log_error_errno(errno
, "Failed to read \"%s\": %m", p
);
184 FOREACH_DIRENT(de
, d
, break) {
185 _cleanup_free_
char *v
= NULL
;
186 _cleanup_close_
int fd
= -1;
188 if (!endswith_no_case(de
->d_name
, ".efi"))
191 if (prefix
&& !startswith_no_case(de
->d_name
, prefix
))
194 fd
= openat(dirfd(d
), de
->d_name
, O_RDONLY
|O_CLOEXEC
);
196 return log_error_errno(errno
, "Failed to open \"%s/%s\" for reading: %m", p
, de
->d_name
);
198 r
= get_file_version(fd
, &v
);
202 printf(" File: %s/%s/%s (%s%s%s)\n", special_glyph(SPECIAL_GLYPH_TREE_RIGHT
), path
, de
->d_name
, ansi_highlight(), v
, ansi_normal());
204 printf(" File: %s/%s/%s\n", special_glyph(SPECIAL_GLYPH_TREE_RIGHT
), path
, de
->d_name
);
212 static int status_binaries(const char *esp_path
, sd_id128_t partition
) {
215 printf("Available Boot Loaders on ESP:\n");
218 printf(" ESP: Cannot find or access mount point of ESP.\n\n");
222 printf(" ESP: %s", esp_path
);
223 if (!sd_id128_is_null(partition
))
224 printf(" (/dev/disk/by-partuuid/" SD_ID128_UUID_FORMAT_STR
")", SD_ID128_FORMAT_VAL(partition
));
227 r
= enumerate_binaries(esp_path
, "EFI/systemd", NULL
);
231 log_info("systemd-boot not installed in ESP.");
233 r
= enumerate_binaries(esp_path
, "EFI/BOOT", "boot");
237 log_info("No default/fallback boot loader installed in ESP.");
246 static int print_efi_option(uint16_t id
, bool in_order
) {
247 _cleanup_free_
char *title
= NULL
;
248 _cleanup_free_
char *path
= NULL
;
249 sd_id128_t partition
;
253 r
= efi_get_boot_option(id
, &title
, &partition
, &path
, &active
);
257 /* print only configured entries with partition information */
258 if (!path
|| sd_id128_is_null(partition
))
261 efi_tilt_backslashes(path
);
263 printf(" Title: %s%s%s\n", ansi_highlight(), strna(title
), ansi_normal());
264 printf(" ID: 0x%04X\n", id
);
265 printf(" Status: %sactive%s\n", active
? "" : "in", in_order
? ", boot-order" : "");
266 printf(" Partition: /dev/disk/by-partuuid/" SD_ID128_UUID_FORMAT_STR
"\n",
267 SD_ID128_FORMAT_VAL(partition
));
268 printf(" File: %s%s\n", special_glyph(SPECIAL_GLYPH_TREE_RIGHT
), path
);
274 static int status_variables(void) {
275 _cleanup_free_
uint16_t *options
= NULL
, *order
= NULL
;
276 int n_options
, n_order
, i
;
278 n_options
= efi_get_boot_options(&options
);
279 if (n_options
== -ENOENT
)
280 return log_error_errno(n_options
,
281 "Failed to access EFI variables, efivarfs"
282 " needs to be available at /sys/firmware/efi/efivars/.");
284 return log_error_errno(n_options
, "Failed to read EFI boot entries: %m");
286 n_order
= efi_get_boot_order(&order
);
287 if (n_order
== -ENOENT
)
289 else if (n_order
< 0)
290 return log_error_errno(n_order
, "Failed to read EFI boot order: %m");
292 /* print entries in BootOrder first */
293 printf("Boot Loaders Listed in EFI Variables:\n");
294 for (i
= 0; i
< n_order
; i
++)
295 print_efi_option(order
[i
], true);
297 /* print remaining entries */
298 for (i
= 0; i
< n_options
; i
++) {
301 for (j
= 0; j
< n_order
; j
++)
302 if (options
[i
] == order
[j
])
305 print_efi_option(options
[i
], false);
314 static int boot_entry_file_check(const char *root
, const char *p
) {
315 _cleanup_free_
char *path
;
317 path
= path_join(root
, p
);
321 if (access(path
, F_OK
) < 0)
327 static void boot_entry_file_list(const char *field
, const char *root
, const char *p
, int *ret_status
) {
328 int status
= boot_entry_file_check(root
, p
);
330 printf("%13s%s ", strempty(field
), field
? ":" : " ");
333 printf("%s%s%s (%m)\n", ansi_highlight_red(), p
, ansi_normal());
337 if (*ret_status
== 0 && status
< 0)
338 *ret_status
= status
;
341 static int boot_entry_show(const BootEntry
*e
, bool show_as_default
) {
344 /* Returns 0 on success, negative on processing error, and positive if something is wrong with the
345 boot entry itself. */
349 printf(" title: %s%s%s" "%s%s%s\n",
350 ansi_highlight(), boot_entry_title(e
), ansi_normal(),
351 ansi_highlight_green(), show_as_default
? " (default)" : "", ansi_normal());
354 printf(" id: %s\n", e
->id
);
356 _cleanup_free_
char *link
= NULL
;
358 /* Let's urlify the link to make it easy to view in an editor, but only if it is a text
359 * file. Unified images are binary ELFs, and EFI variables are not pure text either. */
360 if (e
->type
== BOOT_ENTRY_CONF
)
361 (void) terminal_urlify_path(e
->path
, NULL
, &link
);
363 printf(" source: %s\n", link
?: e
->path
);
366 printf(" version: %s\n", e
->version
);
368 printf(" machine-id: %s\n", e
->machine_id
);
370 printf(" architecture: %s\n", e
->architecture
);
372 boot_entry_file_list("linux", e
->root
, e
->kernel
, &status
);
375 STRV_FOREACH(s
, e
->initrd
)
376 boot_entry_file_list(s
== e
->initrd
? "initrd" : NULL
,
380 if (!strv_isempty(e
->options
)) {
381 _cleanup_free_
char *t
= NULL
, *t2
= NULL
;
382 _cleanup_strv_free_
char **ts
= NULL
;
384 t
= strv_join(e
->options
, " ");
388 ts
= strv_split_newlines(t
);
392 t2
= strv_join(ts
, "\n ");
396 printf(" options: %s\n", t2
);
399 boot_entry_file_list("devicetree", e
->root
, e
->device_tree
, &status
);
404 static int status_entries(
405 const char *esp_path
,
406 sd_id128_t esp_partition_uuid
,
407 const char *xbootldr_path
,
408 sd_id128_t xbootldr_partition_uuid
) {
410 _cleanup_(boot_config_free
) BootConfig config
= {};
411 sd_id128_t dollar_boot_partition_uuid
;
412 const char *dollar_boot_path
;
415 assert(esp_path
|| xbootldr_path
);
418 dollar_boot_path
= xbootldr_path
;
419 dollar_boot_partition_uuid
= xbootldr_partition_uuid
;
421 dollar_boot_path
= esp_path
;
422 dollar_boot_partition_uuid
= esp_partition_uuid
;
425 printf("Boot Loader Entries:\n"
426 " $BOOT: %s", dollar_boot_path
);
427 if (!sd_id128_is_null(dollar_boot_partition_uuid
))
428 printf(" (/dev/disk/by-partuuid/" SD_ID128_UUID_FORMAT_STR
")",
429 SD_ID128_FORMAT_VAL(dollar_boot_partition_uuid
));
432 r
= boot_entries_load_config(esp_path
, xbootldr_path
, &config
);
436 if (config
.default_entry
< 0)
437 printf("%zu entries, no entry could be determined as default.\n", config
.n_entries
);
439 printf("Default Boot Loader Entry:\n");
441 r
= boot_entry_show(config
.entries
+ config
.default_entry
, false);
443 /* < 0 is already logged by the function itself, let's just emit an extra warning if
444 the default entry is broken */
445 printf("\nWARNING: default boot entry is broken\n");
451 static int compare_product(const char *a
, const char *b
) {
460 return x
< y
? -1 : x
> y
? 1 : 0;
462 return strncmp(a
, b
, x
);
465 static int compare_version(const char *a
, const char *b
) {
469 a
+= strcspn(a
, " ");
471 b
+= strcspn(b
, " ");
474 return strverscmp(a
, b
);
477 static int version_check(int fd_from
, const char *from
, int fd_to
, const char *to
) {
478 _cleanup_free_
char *a
= NULL
, *b
= NULL
;
481 assert(fd_from
>= 0);
486 r
= get_file_version(fd_from
, &a
);
490 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
491 "Source file \"%s\" does not carry version information!",
494 r
= get_file_version(fd_to
, &b
);
497 if (r
== 0 || compare_product(a
, b
) != 0)
498 return log_notice_errno(SYNTHETIC_ERRNO(EEXIST
),
499 "Skipping \"%s\", since it's owned by another boot loader.",
502 if (compare_version(a
, b
) < 0)
503 return log_warning_errno(SYNTHETIC_ERRNO(ESTALE
), "Skipping \"%s\", since a newer boot loader version exists already.", to
);
508 static int copy_file_with_version_check(const char *from
, const char *to
, bool force
) {
509 _cleanup_close_
int fd_from
= -1, fd_to
= -1;
510 _cleanup_free_
char *t
= NULL
;
513 fd_from
= open(from
, O_RDONLY
|O_CLOEXEC
|O_NOCTTY
);
515 return log_error_errno(errno
, "Failed to open \"%s\" for reading: %m", from
);
518 fd_to
= open(to
, O_RDONLY
|O_CLOEXEC
|O_NOCTTY
);
520 if (errno
!= -ENOENT
)
521 return log_error_errno(errno
, "Failed to open \"%s\" for reading: %m", to
);
523 r
= version_check(fd_from
, from
, fd_to
, to
);
527 if (lseek(fd_from
, 0, SEEK_SET
) == (off_t
) -1)
528 return log_error_errno(errno
, "Failed to seek in \"%s\": %m", from
);
530 fd_to
= safe_close(fd_to
);
534 r
= tempfn_random(to
, NULL
, &t
);
538 RUN_WITH_UMASK(0000) {
539 fd_to
= open(t
, O_WRONLY
|O_CREAT
|O_CLOEXEC
|O_EXCL
|O_NOFOLLOW
, 0644);
541 return log_error_errno(errno
, "Failed to open \"%s\" for writing: %m", t
);
544 r
= copy_bytes(fd_from
, fd_to
, (uint64_t) -1, COPY_REFLINK
);
547 return log_error_errno(r
, "Failed to copy data from \"%s\" to \"%s\": %m", from
, t
);
550 (void) copy_times(fd_from
, fd_to
, 0);
552 if (fsync(fd_to
) < 0) {
553 (void) unlink_noerrno(t
);
554 return log_error_errno(errno
, "Failed to copy data from \"%s\" to \"%s\": %m", from
, t
);
557 (void) fsync_directory_of_file(fd_to
);
559 if (renameat(AT_FDCWD
, t
, AT_FDCWD
, to
) < 0) {
560 (void) unlink_noerrno(t
);
561 return log_error_errno(errno
, "Failed to rename \"%s\" to \"%s\": %m", t
, to
);
564 log_info("Copied \"%s\" to \"%s\".", from
, to
);
569 static int mkdir_one(const char *prefix
, const char *suffix
) {
570 _cleanup_free_
char *p
= NULL
;
572 p
= path_join(prefix
, suffix
);
573 if (mkdir(p
, 0700) < 0) {
575 return log_error_errno(errno
, "Failed to create \"%s\": %m", p
);
577 log_info("Created \"%s\".", p
);
582 static const char *const esp_subdirs
[] = {
587 /* Note that "/loader/entries" is not listed here, since it should be placed in $BOOT, which might
588 * not necessarily be the ESP */
592 static int create_esp_subdirs(const char *esp_path
) {
593 const char *const *i
;
596 STRV_FOREACH(i
, esp_subdirs
) {
597 r
= mkdir_one(esp_path
, *i
);
605 static int copy_one_file(const char *esp_path
, const char *name
, bool force
) {
610 p
= strjoina(BOOTLIBDIR
"/", name
);
611 q
= strjoina(esp_path
, "/EFI/systemd/", name
);
612 r
= copy_file_with_version_check(p
, q
, force
);
614 e
= startswith(name
, "systemd-boot");
619 /* Create the EFI default boot loader name (specified for removable devices) */
620 v
= strjoina(esp_path
, "/EFI/BOOT/BOOT", e
);
621 ascii_strupper(strrchr(v
, '/') + 1);
623 k
= copy_file_with_version_check(p
, v
, force
);
631 static int install_binaries(const char *esp_path
, bool force
) {
633 _cleanup_closedir_
DIR *d
= NULL
;
636 d
= opendir(BOOTLIBDIR
);
638 return log_error_errno(errno
, "Failed to open \""BOOTLIBDIR
"\": %m
");
640 FOREACH_DIRENT(de, d, return log_error_errno(errno, "Failed to read
\""BOOTLIBDIR"\": %m
")) {
643 if (!endswith_no_case(de->d_name, ".efi
"))
646 k = copy_one_file(esp_path, de->d_name, force);
654 static bool same_entry(uint16_t id, sd_id128_t uuid, const char *path) {
655 _cleanup_free_ char *opath = NULL;
659 r = efi_get_boot_option(id, NULL, &ouuid, &opath, NULL);
662 if (!sd_id128_equal(uuid, ouuid))
664 if (!streq_ptr(path, opath))
670 static int find_slot(sd_id128_t uuid, const char *path, uint16_t *id) {
671 _cleanup_free_ uint16_t *options = NULL;
674 n = efi_get_boot_options(&options);
678 /* find already existing systemd-boot entry */
679 for (i = 0; i < n; i++)
680 if (same_entry(options[i], uuid, path)) {
685 /* find free slot in the sorted BootXXXX variable list */
686 for (i = 0; i < n; i++)
687 if (i != options[i]) {
692 /* use the next one */
699 static int insert_into_order(uint16_t slot, bool first) {
700 _cleanup_free_ uint16_t *order = NULL;
704 n = efi_get_boot_order(&order);
706 /* no entry, add us */
707 return efi_set_boot_order(&slot, 1);
709 /* are we the first and only one? */
710 if (n == 1 && order[0] == slot)
713 /* are we already in the boot order? */
714 for (i = 0; i < n; i++) {
715 if (order[i] != slot)
718 /* we do not require to be the first one, all is fine */
722 /* move us to the first slot */
723 memmove(order + 1, order, i * sizeof(uint16_t));
725 return efi_set_boot_order(order, n);
729 t = reallocarray(order, n + 1, sizeof(uint16_t));
734 /* add us to the top or end of the list */
736 memmove(order + 1, order, n * sizeof(uint16_t));
741 return efi_set_boot_order(order, n + 1);
744 static int remove_from_order(uint16_t slot) {
745 _cleanup_free_ uint16_t *order = NULL;
748 n = efi_get_boot_order(&order);
752 for (i = 0; i < n; i++) {
753 if (order[i] != slot)
757 memmove(order + i, order + i+1, (n - i) * sizeof(uint16_t));
758 return efi_set_boot_order(order, n - 1);
764 static int install_variables(const char *esp_path,
765 uint32_t part, uint64_t pstart, uint64_t psize,
766 sd_id128_t uuid, const char *path,
772 if (!is_efi_boot()) {
773 log_warning("Not booted with EFI
, skipping EFI variable setup
.");
777 p = prefix_roota(esp_path, path);
778 if (access(p, F_OK) < 0) {
782 return log_error_errno(errno, "Cannot access
\"%s
\": %m
", p);
785 r = find_slot(uuid, path, &slot);
787 return log_error_errno(r,
789 "Failed to access EFI variables
. Is the
\"efivarfs
\" filesystem mounted
?" :
790 "Failed to determine current boot order
: %m
");
792 if (first || r == 0) {
793 r = efi_add_boot_option(slot, "Linux Boot Manager
",
797 return log_error_errno(r, "Failed to create EFI Boot variable entry
: %m
");
799 log_info("Created EFI boot entry
\"Linux Boot Manager
\".");
802 return insert_into_order(slot, first);
805 static int remove_boot_efi(const char *esp_path) {
806 _cleanup_closedir_ DIR *d = NULL;
811 p = prefix_roota(esp_path, "/EFI
/BOOT
");
817 return log_error_errno(errno, "Failed to open directory
\"%s
\": %m
", p);
820 FOREACH_DIRENT(de, d, break) {
821 _cleanup_close_ int fd = -1;
822 _cleanup_free_ char *v = NULL;
824 if (!endswith_no_case(de->d_name, ".efi
"))
827 if (!startswith_no_case(de->d_name, "boot
"))
830 fd = openat(dirfd(d), de->d_name, O_RDONLY|O_CLOEXEC);
832 return log_error_errno(errno, "Failed to open
\"%s
/%s
\" for reading
: %m
", p, de->d_name);
834 r = get_file_version(fd, &v);
837 if (r > 0 && startswith(v, "systemd
-boot
")) {
838 r = unlinkat(dirfd(d), de->d_name, 0);
840 return log_error_errno(errno, "Failed to remove
\"%s
/%s
\": %m
", p, de->d_name);
842 log_info("Removed
\"%s
/%s
\".", p, de->d_name);
851 static int rmdir_one(const char *prefix, const char *suffix) {
854 p = prefix_roota(prefix, suffix);
856 bool ignore = IN_SET(errno, ENOENT, ENOTEMPTY);
858 log_full_errno(ignore ? LOG_DEBUG : LOG_ERR, errno,
859 "Failed to remove directory
\"%s
\": %m
", p);
863 log_info("Removed
\"%s
\".", p);
868 static int remove_esp_subdirs(const char *esp_path) {
872 for (i = ELEMENTSOF(esp_subdirs)-1; i > 0; i--) {
875 q = rmdir_one(esp_path, esp_subdirs[i-1]);
883 static int remove_binaries(const char *esp_path) {
887 p = prefix_roota(esp_path, "/EFI
/systemd
");
888 r = rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL);
890 q = remove_boot_efi(esp_path);
897 static int remove_loader_config(const char *esp_path) {
902 p = prefix_roota(esp_path, "/loader
/loader
.conf
");
904 log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_ERR, errno, "Failed to unlink file
\"%s
\": %m
", p);
908 log_info("Removed
\"%s
\".", p);
913 static int remove_entries_directory(const char *dollar_boot_path) {
914 assert(dollar_boot_path);
916 return rmdir_one(dollar_boot_path, "/loader
/entries
");
919 static int remove_variables(sd_id128_t uuid, const char *path, bool in_order) {
926 r = find_slot(uuid, path, &slot);
930 r = efi_remove_boot_option(slot);
935 return remove_from_order(slot);
940 static int install_loader_config(const char *esp_path, sd_id128_t machine_id) {
941 char machine_string[SD_ID128_STRING_MAX];
942 _cleanup_(unlink_and_freep) char *t = NULL;
943 _cleanup_fclose_ FILE *f = NULL;
947 p = prefix_roota(esp_path, "/loader
/loader
.conf
");
948 if (access(p, F_OK) >= 0) /* Silently skip creation if the file already exists (early check) */
951 fd = open_tmpfile_linkable(p, O_WRONLY|O_CLOEXEC, &t);
953 return log_error_errno(fd, "Failed to open
\"%s
\" for writing
: %m
", p);
961 fprintf(f, "#timeout 3\n"
962 "#console-mode keep\n"
963 "default %s-*\n", sd_id128_to_string(machine_id, machine_string));
965 r = fflush_sync_and_check(f);
967 return log_error_errno(r, "Failed to write \"%s\": %m", p);
969 r = link_tmpfile(fd, t, p);
971 return 0; /* Silently skip creation if the file exists now (recheck) */
973 return log_error_errno(r, "Failed to move \"%s\" into place: %m", p);
979 static int install_entries_directories(const char *dollar_boot_path, sd_id128_t machine_id) {
981 char buf[SD_ID128_STRING_MAX];
983 assert(dollar_boot_path);
985 /* Both /loader/entries and the entry directories themselves should be located on the same
986 * partition. Also create the parent directory for entry directories, so that kernel-install
987 * knows where to put them. */
989 r = mkdir_one(dollar_boot_path, "loader/entries");
993 return mkdir_one(dollar_boot_path, sd_id128_to_string(machine_id, buf));
996 static int help(int argc, char *argv[], void *userdata) {
997 _cleanup_free_ char *link = NULL;
1000 r = terminal_urlify_man("bootctl", "1", &link);
1004 printf("%s [COMMAND] [OPTIONS...]\n\n"
1005 "Install, update or remove the systemd-boot EFI boot manager.\n\n"
1006 " -h --help Show this help\n"
1007 " --version Print version\n"
1008 " --esp-path=PATH Path to the EFI System Partition (ESP)\n"
1009 " --boot-path=PATH Path to the $BOOT partition\n"
1010 " -p --print-esp-path Print path to the EFI System Partition\n"
1011 " -x --print-boot-path Print path to the $BOOT partition\n"
1012 " --no-variables Don't touch EFI variables\n"
1013 " --no-pager Do not pipe output into a pager\n"
1014 "\nBoot Loader Commands:\n"
1015 " status Show status of installed systemd-boot and EFI variables\n"
1016 " install Install systemd-boot to the ESP and EFI variables\n"
1017 " update Update systemd-boot in the ESP and EFI variables\n"
1018 " remove Remove systemd-boot from the ESP and EFI variables\n"
1019 "\nBoot Loader Entries Commands:\n"
1020 " list List boot loader entries\n"
1021 " set-default ID Set default boot loader entry\n"
1022 " set-oneshot ID Set default boot loader entry, for next boot only\n"
1023 "\nSee the %s for details.\n"
1024 , program_invocation_short_name
1030 static int parse_argv(int argc, char *argv[]) {
1032 ARG_ESP_PATH = 0x100,
1039 static const struct option options[] = {
1040 { "help", no_argument, NULL, 'h' },
1041 { "version", no_argument, NULL, ARG_VERSION },
1042 { "esp-path", required_argument, NULL, ARG_ESP_PATH },
1043 { "path", required_argument, NULL, ARG_ESP_PATH }, /* Compatibility alias */
1044 { "boot-path", required_argument, NULL, ARG_BOOT_PATH },
1045 { "print-esp-path", no_argument, NULL, 'p' },
1046 { "print-path", no_argument, NULL, 'p' }, /* Compatibility alias */
1047 { "print-boot-path", no_argument, NULL, 'x' },
1048 { "no-variables", no_argument, NULL, ARG_NO_VARIABLES },
1049 { "no-pager", no_argument, NULL, ARG_NO_PAGER },
1058 while ((c = getopt_long(argc, argv, "hpx", options, NULL)) >= 0)
1062 help(0, NULL, NULL);
1069 r = free_and_strdup(&arg_esp_path, optarg);
1075 r = free_and_strdup(&arg_xbootldr_path, optarg);
1081 if (arg_print_dollar_boot_path)
1082 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1083 "--print-boot-path/-x cannot be combined with --print-esp-path/-p");
1084 arg_print_esp_path = true;
1088 if (arg_print_esp_path)
1089 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1090 "--print-boot-path/-x cannot be combined with --print-esp-path/-p");
1091 arg_print_dollar_boot_path = true;
1094 case ARG_NO_VARIABLES:
1095 arg_touch_variables = false;
1099 arg_pager_flags |= PAGER_DISABLE;
1106 assert_not_reached("Unknown option");
1112 static void read_loader_efi_var(const char *name, char **var) {
1115 r = efi_get_variable_string(EFI_VENDOR_LOADER, name, var);
1116 if (r < 0 && r != -ENOENT)
1117 log_warning_errno(r, "Failed to read EFI variable %s: %m", name);
1120 static int verb_status(int argc, char *argv[], void *userdata) {
1121 sd_id128_t esp_uuid = SD_ID128_NULL, xbootldr_uuid = SD_ID128_NULL;
1124 r = acquire_esp(geteuid() != 0, NULL, NULL, NULL, &esp_uuid);
1125 if (arg_print_esp_path) {
1126 if (r == -EACCES) /* If we couldn't acquire the ESP path, log about access errors (which is the only
1127 * error the
find_esp_and_warn() won
't log on its own) */
1128 return log_error_errno(r, "Failed to determine ESP location: %m");
1135 r = acquire_xbootldr(geteuid() != 0, &xbootldr_uuid);
1136 if (arg_print_dollar_boot_path) {
1138 return log_error_errno(r, "Failed to determine XBOOTLDR location: %m");
1142 puts(arg_dollar_boot_path());
1145 if (arg_print_esp_path || arg_print_dollar_boot_path)
1148 r = 0; /* If we couldn't determine the path
, then don
't consider that a problem from here on, just show what we
1151 (void) pager_open(arg_pager_flags);
1153 if (is_efi_boot()) {
1154 static const struct {
1158 { EFI_LOADER_FEATURE_BOOT_COUNTING, "Boot counting" },
1159 { EFI_LOADER_FEATURE_CONFIG_TIMEOUT, "Menu timeout control" },
1160 { EFI_LOADER_FEATURE_CONFIG_TIMEOUT_ONE_SHOT, "One-shot menu timeout control" },
1161 { EFI_LOADER_FEATURE_ENTRY_DEFAULT, "Default entry control" },
1162 { EFI_LOADER_FEATURE_ENTRY_ONESHOT, "One-shot entry control" },
1163 { EFI_LOADER_FEATURE_XBOOTLDR, "Support for XBOOTLDR partition" },
1166 _cleanup_free_ char *fw_type = NULL, *fw_info = NULL, *loader = NULL, *loader_path = NULL, *stub = NULL;
1167 sd_id128_t loader_part_uuid = SD_ID128_NULL;
1168 uint64_t loader_features = 0;
1171 read_loader_efi_var("LoaderFirmwareType", &fw_type);
1172 read_loader_efi_var("LoaderFirmwareInfo", &fw_info);
1173 read_loader_efi_var("LoaderInfo", &loader);
1174 read_loader_efi_var("StubInfo", &stub);
1175 read_loader_efi_var("LoaderImageIdentifier", &loader_path);
1176 (void) efi_loader_get_features(&loader_features);
1179 efi_tilt_backslashes(loader_path);
1181 k = efi_loader_get_device_part_uuid(&loader_part_uuid);
1182 if (k < 0 && k != -ENOENT)
1183 r = log_warning_errno(k, "Failed to read EFI variable LoaderDevicePartUUID: %m");
1185 printf("System:\n");
1186 printf(" Firmware: %s%s (%s)%s\n", ansi_highlight(), strna(fw_type), strna(fw_info), ansi_normal());
1187 printf(" Secure Boot: %sd\n", enable_disable(is_efi_secure_boot()));
1188 printf(" Setup Mode: %s\n", is_efi_secure_boot_setup_mode() ? "setup" : "user");
1191 printf("Current Boot Loader:\n");
1192 printf(" Product: %s%s%s\n", ansi_highlight(), strna(loader), ansi_normal());
1194 for (i = 0; i < ELEMENTSOF(flags); i++) {
1197 printf(" Features: ");
1201 if (FLAGS_SET(loader_features, flags[i].flag))
1202 printf("%s%s%s %s\n", ansi_highlight_green(), special_glyph(SPECIAL_GLYPH_CHECK_MARK), ansi_normal(), flags[i].name);
1204 printf("%s%s%s %s\n", ansi_highlight_red(), special_glyph(SPECIAL_GLYPH_CROSS_MARK), ansi_normal(), flags[i].name);
1208 printf(" Stub: %s\n", stub);
1209 if (!sd_id128_is_null(loader_part_uuid))
1210 printf(" ESP: /dev/disk/by-partuuid/" SD_ID128_UUID_FORMAT_STR "\n",
1211 SD_ID128_FORMAT_VAL(loader_part_uuid));
1213 printf(" ESP: n/a\n");
1214 printf(" File: %s%s\n", special_glyph(SPECIAL_GLYPH_TREE_RIGHT), strna(loader_path));
1217 printf("System:\n Not booted with EFI\n\n");
1220 k = status_binaries(arg_esp_path, esp_uuid);
1225 if (is_efi_boot()) {
1226 k = status_variables();
1231 if (arg_esp_path || arg_xbootldr_path) {
1232 k = status_entries(arg_esp_path, esp_uuid, arg_xbootldr_path, xbootldr_uuid);
1240 static int verb_list(int argc, char *argv[], void *userdata) {
1241 _cleanup_(boot_config_free) BootConfig config = {};
1244 /* If we lack privileges we invoke find_esp_and_warn() in "unprivileged mode" here, which does two things: turn
1245 * off logging about access errors and turn off potentially privileged device probing. Here we're interested in
1246 * the latter but
not the former
, hence request the mode
, and log about EACCES
. */
1248 r
= acquire_esp(geteuid() != 0, NULL
, NULL
, NULL
, NULL
);
1249 if (r
== -EACCES
) /* We really need the ESP path for this call, hence also log about access errors */
1250 return log_error_errno(r
, "Failed to determine ESP: %m");
1254 r
= acquire_xbootldr(geteuid() != 0, NULL
);
1256 return log_error_errno(r
, "Failed to determine XBOOTLDR partition: %m");
1260 r
= boot_entries_load_config(arg_esp_path
, arg_xbootldr_path
, &config
);
1264 (void) boot_entries_augment_from_loader(&config
, false);
1266 if (config
.n_entries
== 0)
1267 log_info("No boot loader entries found.");
1271 (void) pager_open(arg_pager_flags
);
1273 printf("Boot Loader Entries:\n");
1275 for (n
= 0; n
< config
.n_entries
; n
++) {
1276 r
= boot_entry_show(config
.entries
+ n
, n
== (size_t) config
.default_entry
);
1280 if (n
+1 < config
.n_entries
)
1288 static int sync_everything(void) {
1292 k
= syncfs_path(AT_FDCWD
, arg_esp_path
);
1294 ret
= log_error_errno(k
, "Failed to synchronize the ESP '%s': %m", arg_esp_path
);
1297 if (arg_xbootldr_path
) {
1298 k
= syncfs_path(AT_FDCWD
, arg_xbootldr_path
);
1300 ret
= log_error_errno(k
, "Failed to synchronize $BOOT '%s': %m", arg_xbootldr_path
);
1306 static int verb_install(int argc
, char *argv
[], void *userdata
) {
1307 sd_id128_t uuid
= SD_ID128_NULL
;
1308 uint64_t pstart
= 0, psize
= 0;
1310 sd_id128_t machine_id
;
1314 r
= acquire_esp(false, &part
, &pstart
, &psize
, &uuid
);
1318 r
= acquire_xbootldr(false, NULL
);
1322 r
= sd_id128_get_machine(&machine_id
);
1324 return log_error_errno(r
, "Failed to get machine id: %m");
1326 install
= streq(argv
[0], "install");
1328 RUN_WITH_UMASK(0002) {
1330 /* Don't create any of these directories when we are just updating. When we update
1331 * we'll drop-in our files (unless there are newer ones already), but we won't create
1332 * the directories for them in the first place. */
1333 r
= create_esp_subdirs(arg_esp_path
);
1338 r
= install_binaries(arg_esp_path
, install
);
1343 r
= install_loader_config(arg_esp_path
, machine_id
);
1347 r
= install_entries_directories(arg_dollar_boot_path(), machine_id
);
1353 (void) sync_everything();
1355 if (arg_touch_variables
)
1356 r
= install_variables(arg_esp_path
,
1357 part
, pstart
, psize
, uuid
,
1358 "/EFI/systemd/systemd-boot" EFI_MACHINE_TYPE_NAME
".efi",
1364 static int verb_remove(int argc
, char *argv
[], void *userdata
) {
1365 sd_id128_t uuid
= SD_ID128_NULL
;
1368 r
= acquire_esp(false, NULL
, NULL
, NULL
, &uuid
);
1372 r
= acquire_xbootldr(false, NULL
);
1376 r
= remove_binaries(arg_esp_path
);
1378 q
= remove_loader_config(arg_esp_path
);
1379 if (q
< 0 && r
>= 0)
1382 q
= remove_entries_directory(arg_dollar_boot_path());
1383 if (q
< 0 && r
>= 0)
1386 q
= remove_esp_subdirs(arg_esp_path
);
1387 if (q
< 0 && r
>= 0)
1390 (void) sync_everything();
1392 if (arg_touch_variables
) {
1393 q
= remove_variables(uuid
, "/EFI/systemd/systemd-boot" EFI_MACHINE_TYPE_NAME
".efi", true);
1394 if (q
< 0 && r
>= 0)
1401 static int verb_set_default(int argc
, char *argv
[], void *userdata
) {
1406 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1407 "Not booted with UEFI.");
1409 if (access("/sys/firmware/efi/efivars/LoaderInfo-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f", F_OK
) < 0) {
1410 if (errno
== ENOENT
) {
1411 log_error_errno(errno
, "Not booted with a supported boot loader.");
1415 return log_error_errno(errno
, "Failed to detect whether boot loader supports '%s' operation: %m", argv
[0]);
1418 if (detect_container() > 0)
1419 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1420 "'%s' operation not supported in a container.",
1423 if (!arg_touch_variables
)
1424 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1425 "'%s' operation cannot be combined with --touch-variables=no.",
1428 name
= streq(argv
[0], "set-default") ? "LoaderEntryDefault" : "LoaderEntryOneShot";
1430 if (isempty(argv
[1])) {
1431 r
= efi_set_variable(EFI_VENDOR_LOADER
, name
, NULL
, 0);
1432 if (r
< 0 && r
!= -ENOENT
)
1433 return log_error_errno(r
, "Failed to remove EFI variale: %m");
1435 _cleanup_free_ char16_t
*encoded
= NULL
;
1437 encoded
= utf8_to_utf16(argv
[1], strlen(argv
[1]));
1441 r
= efi_set_variable(EFI_VENDOR_LOADER
, name
, encoded
, char16_strlen(encoded
) * 2 + 2);
1443 return log_error_errno(r
, "Failed to update EFI variable: %m");
1449 static int bootctl_main(int argc
, char *argv
[]) {
1450 static const Verb verbs
[] = {
1451 { "help", VERB_ANY
, VERB_ANY
, 0, help
},
1452 { "status", VERB_ANY
, 1, VERB_DEFAULT
, verb_status
},
1453 { "install", VERB_ANY
, 1, 0, verb_install
},
1454 { "update", VERB_ANY
, 1, 0, verb_install
},
1455 { "remove", VERB_ANY
, 1, 0, verb_remove
},
1456 { "list", VERB_ANY
, 1, 0, verb_list
},
1457 { "set-default", 2, 2, 0, verb_set_default
},
1458 { "set-oneshot", 2, 2, 0, verb_set_default
},
1462 return dispatch_verb(argc
, argv
, verbs
, NULL
);
1465 static int run(int argc
, char *argv
[]) {
1468 log_parse_environment();
1471 /* If we run in a container, automatically turn off EFI file system access */
1472 if (detect_container() > 0)
1473 arg_touch_variables
= false;
1475 r
= parse_argv(argc
, argv
);
1479 return bootctl_main(argc
, argv
);
1482 DEFINE_MAIN_FUNCTION(run
);