1 /* SPDX-License-Identifier: LGPL-2.1+ */
16 #include "alloc-util.h"
17 #include "chattr-util.h"
18 #include "dirent-util.h"
23 #include "parse-util.h"
24 #include "stdio-util.h"
26 #include "time-util.h"
33 #define LOAD_OPTION_ACTIVE 0x00000001
34 #define MEDIA_DEVICE_PATH 0x04
35 #define MEDIA_HARDDRIVE_DP 0x01
36 #define MEDIA_FILEPATH_DP 0x04
37 #define SIGNATURE_TYPE_GUID 0x02
38 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
39 #define END_DEVICE_PATH_TYPE 0x7f
40 #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
41 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
55 uint8_t signature_type
;
64 struct drive_path drive
;
68 bool is_efi_boot(void) {
69 if (detect_container() > 0)
72 return access("/sys/firmware/efi/", F_OK
) >= 0;
75 static int read_flag(const char *varname
) {
76 _cleanup_free_
void *v
= NULL
;
81 if (!is_efi_boot()) /* If this is not an EFI boot, assume the queried flags are zero */
84 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, varname
, NULL
, &v
, &s
);
95 bool is_efi_secure_boot(void) {
96 return read_flag("SecureBoot") > 0;
99 bool is_efi_secure_boot_setup_mode(void) {
100 return read_flag("SetupMode") > 0;
103 int efi_reboot_to_firmware_supported(void) {
104 _cleanup_free_
void *v
= NULL
;
112 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "OsIndicationsSupported", NULL
, &v
, &s
);
113 if (r
== -ENOENT
) /* variable doesn't exist? it's not supported then */
117 if (s
!= sizeof(uint64_t))
121 if (!(b
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
))
122 return -EOPNOTSUPP
; /* bit unset? it's not supported then */
127 static int get_os_indications(uint64_t *os_indication
) {
128 _cleanup_free_
void *v
= NULL
;
132 /* Let's verify general support first */
133 r
= efi_reboot_to_firmware_supported();
137 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "OsIndications", NULL
, &v
, &s
);
139 /* Some firmware implementations that do support OsIndications and report that with
140 * OsIndicationsSupported will remove the OsIndications variable when it is unset. Let's pretend it's 0
141 * then, to hide this implementation detail. Note that this call will return -ENOENT then only if the
142 * support for OsIndications is missing entirely, as determined by efi_reboot_to_firmware_supported()
148 else if (s
!= sizeof(uint64_t))
151 *os_indication
= *(uint64_t *)v
;
155 int efi_get_reboot_to_firmware(void) {
159 r
= get_os_indications(&b
);
163 return !!(b
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
);
166 int efi_set_reboot_to_firmware(bool value
) {
170 r
= get_os_indications(&b
);
175 b_new
= b
| EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
177 b_new
= b
& ~EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
179 /* Avoid writing to efi vars store if we can due to firmware bugs. */
181 return efi_set_variable(EFI_VENDOR_GLOBAL
, "OsIndications", &b_new
, sizeof(uint64_t));
186 int efi_get_variable(
193 _cleanup_close_
int fd
= -1;
194 _cleanup_free_
char *p
= NULL
;
198 _cleanup_free_
void *buf
= NULL
;
205 "/sys/firmware/efi/efivars/%s-%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
206 name
, SD_ID128_FORMAT_VAL(vendor
)) < 0)
209 fd
= open(p
, O_RDONLY
|O_NOCTTY
|O_CLOEXEC
);
213 if (fstat(fd
, &st
) < 0)
217 if (st
.st_size
> 4*1024*1024 + 4)
220 n
= read(fd
, &a
, sizeof(a
));
226 buf
= malloc(st
.st_size
- 4 + 2);
230 n
= read(fd
, buf
, (size_t) st
.st_size
- 4);
233 if (n
!= (ssize_t
) st
.st_size
- 4)
236 /* Always NUL terminate (2 bytes, to protect UTF-16) */
237 ((char*) buf
)[st
.st_size
- 4] = 0;
238 ((char*) buf
)[st
.st_size
- 4 + 1] = 0;
240 *value
= TAKE_PTR(buf
);
241 *size
= (size_t) st
.st_size
- 4;
249 int efi_set_variable(
258 } _packed_
* _cleanup_free_ buf
= NULL
;
259 _cleanup_free_
char *p
= NULL
;
260 _cleanup_close_
int fd
= -1;
261 bool saved_flags_valid
= false;
262 unsigned saved_flags
;
266 assert(value
|| size
== 0);
269 "/sys/firmware/efi/efivars/%s-%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
270 name
, SD_ID128_FORMAT_VAL(vendor
)) < 0)
273 /* Newer efivarfs protects variables that are not in a whitelist with FS_IMMUTABLE_FL by default, to protect
274 * them for accidental removal and modification. We are not changing these variables accidentally however,
275 * hence let's unset the bit first. */
277 r
= chattr_path(p
, 0, FS_IMMUTABLE_FL
, &saved_flags
);
278 if (r
< 0 && r
!= -ENOENT
)
279 log_debug_errno(r
, "Failed to drop FS_IMMUTABLE_FL flag from '%s', ignoring: %m", p
);
281 saved_flags_valid
= r
>= 0;
292 fd
= open(p
, O_WRONLY
|O_CREAT
|O_NOCTTY
|O_CLOEXEC
, 0644);
298 buf
= malloc(sizeof(uint32_t) + size
);
304 buf
->attr
= EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
|EFI_VARIABLE_RUNTIME_ACCESS
;
305 memcpy(buf
->buf
, value
, size
);
307 r
= loop_write(fd
, buf
, sizeof(uint32_t) + size
, false);
314 if (saved_flags_valid
) {
317 /* Restore the original flags field, just in case */
319 q
= chattr_path(p
, saved_flags
, FS_IMMUTABLE_FL
, NULL
);
321 q
= chattr_fd(fd
, saved_flags
, FS_IMMUTABLE_FL
, NULL
);
323 log_debug_errno(q
, "Failed to restore FS_IMMUTABLE_FL on '%s', ignoring: %m", p
);
329 int efi_get_variable_string(sd_id128_t vendor
, const char *name
, char **p
) {
330 _cleanup_free_
void *s
= NULL
;
335 r
= efi_get_variable(vendor
, name
, NULL
, &s
, &ss
);
339 x
= utf16_to_utf8(s
, ss
);
347 static size_t utf16_size(const uint16_t *s
) {
353 return (l
+1) * sizeof(uint16_t);
356 static void efi_guid_to_id128(const void *guid
, sd_id128_t
*id128
) {
363 const struct uuid
*uuid
= guid
;
365 id128
->bytes
[0] = (uuid
->u1
>> 24) & 0xff;
366 id128
->bytes
[1] = (uuid
->u1
>> 16) & 0xff;
367 id128
->bytes
[2] = (uuid
->u1
>> 8) & 0xff;
368 id128
->bytes
[3] = (uuid
->u1
) & 0xff;
369 id128
->bytes
[4] = (uuid
->u2
>> 8) & 0xff;
370 id128
->bytes
[5] = (uuid
->u2
) & 0xff;
371 id128
->bytes
[6] = (uuid
->u3
>> 8) & 0xff;
372 id128
->bytes
[7] = (uuid
->u3
) & 0xff;
373 memcpy(&id128
->bytes
[8], uuid
->u4
, sizeof(uuid
->u4
));
376 int efi_get_boot_option(
379 sd_id128_t
*part_uuid
,
384 _cleanup_free_
uint8_t *buf
= NULL
;
386 struct boot_option
*header
;
388 _cleanup_free_
char *s
= NULL
, *p
= NULL
;
389 sd_id128_t p_uuid
= SD_ID128_NULL
;
395 xsprintf(boot_id
, "Boot%04X", id
);
396 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, boot_id
, NULL
, (void **)&buf
, &l
);
399 if (l
< sizeof(struct boot_option
))
402 header
= (struct boot_option
*)buf
;
403 title_size
= utf16_size(header
->title
);
404 if (title_size
> l
- offsetof(struct boot_option
, title
))
408 s
= utf16_to_utf8(header
->title
, title_size
);
413 if (header
->path_len
> 0) {
417 doff
= offsetof(struct boot_option
, title
) + title_size
;
419 if (header
->path_len
> l
- doff
)
423 while (dnext
< header
->path_len
) {
424 struct device_path
*dpath
;
426 dpath
= (struct device_path
*)(dbuf
+ dnext
);
427 if (dpath
->length
< 4)
430 /* Type 0x7F – End of Hardware Device Path, Sub-Type 0xFF – End Entire Device Path */
431 if (dpath
->type
== END_DEVICE_PATH_TYPE
&& dpath
->sub_type
== END_ENTIRE_DEVICE_PATH_SUBTYPE
)
434 dnext
+= dpath
->length
;
436 /* Type 0x04 – Media Device Path */
437 if (dpath
->type
!= MEDIA_DEVICE_PATH
)
440 /* Sub-Type 1 – Hard Drive */
441 if (dpath
->sub_type
== MEDIA_HARDDRIVE_DP
) {
442 /* 0x02 – GUID Partition Table */
443 if (dpath
->drive
.mbr_type
!= MBR_TYPE_EFI_PARTITION_TABLE_HEADER
)
446 /* 0x02 – GUID signature */
447 if (dpath
->drive
.signature_type
!= SIGNATURE_TYPE_GUID
)
451 efi_guid_to_id128(dpath
->drive
.signature
, &p_uuid
);
455 /* Sub-Type 4 – File Path */
456 if (dpath
->sub_type
== MEDIA_FILEPATH_DP
&& !p
&& path
) {
457 p
= utf16_to_utf8(dpath
->path
, dpath
->length
-4);
461 efi_tilt_backslashes(p
);
468 *title
= TAKE_PTR(s
);
474 *active
= !!(header
->attr
& LOAD_OPTION_ACTIVE
);
479 static void to_utf16(uint16_t *dest
, const char *src
) {
482 for (i
= 0; src
[i
] != '\0'; i
++)
494 static void id128_to_efi_guid(sd_id128_t id
, void *guid
) {
495 struct guid
*uuid
= guid
;
497 uuid
->u1
= id
.bytes
[0] << 24 | id
.bytes
[1] << 16 | id
.bytes
[2] << 8 | id
.bytes
[3];
498 uuid
->u2
= id
.bytes
[4] << 8 | id
.bytes
[5];
499 uuid
->u3
= id
.bytes
[6] << 8 | id
.bytes
[7];
500 memcpy(uuid
->u4
, id
.bytes
+8, sizeof(uuid
->u4
));
503 static uint16_t *tilt_slashes(uint16_t *s
) {
513 int efi_add_boot_option(
519 sd_id128_t part_uuid
,
522 size_t size
, title_len
, path_len
;
523 _cleanup_free_
char *buf
= NULL
;
524 struct boot_option
*option
;
525 struct device_path
*devicep
;
531 title_len
= (strlen(title
)+1) * 2;
532 path_len
= (strlen(path
)+1) * 2;
534 buf
= malloc0(sizeof(struct boot_option
) + title_len
+
535 sizeof(struct drive_path
) +
536 sizeof(struct device_path
) + path_len
);
541 option
= (struct boot_option
*)buf
;
542 option
->attr
= LOAD_OPTION_ACTIVE
;
543 option
->path_len
= offsetof(struct device_path
, drive
) + sizeof(struct drive_path
) +
544 offsetof(struct device_path
, path
) + path_len
+
545 offsetof(struct device_path
, path
);
546 to_utf16(option
->title
, title
);
547 size
= offsetof(struct boot_option
, title
) + title_len
;
550 devicep
= (struct device_path
*)(buf
+ size
);
551 devicep
->type
= MEDIA_DEVICE_PATH
;
552 devicep
->sub_type
= MEDIA_HARDDRIVE_DP
;
553 devicep
->length
= offsetof(struct device_path
, drive
) + sizeof(struct drive_path
);
554 devicep
->drive
.part_nr
= part
;
555 devicep
->drive
.part_start
= pstart
;
556 devicep
->drive
.part_size
= psize
;
557 devicep
->drive
.signature_type
= SIGNATURE_TYPE_GUID
;
558 devicep
->drive
.mbr_type
= MBR_TYPE_EFI_PARTITION_TABLE_HEADER
;
559 id128_to_efi_guid(part_uuid
, devicep
->drive
.signature
);
560 size
+= devicep
->length
;
563 devicep
= (struct device_path
*)(buf
+ size
);
564 devicep
->type
= MEDIA_DEVICE_PATH
;
565 devicep
->sub_type
= MEDIA_FILEPATH_DP
;
566 devicep
->length
= offsetof(struct device_path
, path
) + path_len
;
567 to_utf16(devicep
->path
, path
);
568 tilt_slashes(devicep
->path
);
569 size
+= devicep
->length
;
572 devicep
= (struct device_path
*)(buf
+ size
);
573 devicep
->type
= END_DEVICE_PATH_TYPE
;
574 devicep
->sub_type
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
575 devicep
->length
= offsetof(struct device_path
, path
);
576 size
+= devicep
->length
;
578 xsprintf(boot_id
, "Boot%04X", id
);
579 return efi_set_variable(EFI_VENDOR_GLOBAL
, boot_id
, buf
, size
);
582 int efi_remove_boot_option(uint16_t id
) {
588 xsprintf(boot_id
, "Boot%04X", id
);
589 return efi_set_variable(EFI_VENDOR_GLOBAL
, boot_id
, NULL
, 0);
592 int efi_get_boot_order(uint16_t **order
) {
593 _cleanup_free_
void *buf
= NULL
;
600 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "BootOrder", NULL
, &buf
, &l
);
607 if (l
% sizeof(uint16_t) > 0 ||
608 l
/ sizeof(uint16_t) > INT_MAX
)
611 *order
= TAKE_PTR(buf
);
612 return (int) (l
/ sizeof(uint16_t));
615 int efi_set_boot_order(uint16_t *order
, size_t n
) {
620 return efi_set_variable(EFI_VENDOR_GLOBAL
, "BootOrder", order
, n
* sizeof(uint16_t));
623 static int boot_id_hex(const char s
[4]) {
626 for (i
= 0; i
< 4; i
++)
627 if (s
[i
] >= '0' && s
[i
] <= '9')
628 id
|= (s
[i
] - '0') << (3 - i
) * 4;
629 else if (s
[i
] >= 'A' && s
[i
] <= 'F')
630 id
|= (s
[i
] - 'A' + 10) << (3 - i
) * 4;
637 static int cmp_uint16(const uint16_t *a
, const uint16_t *b
) {
641 int efi_get_boot_options(uint16_t **options
) {
642 _cleanup_closedir_
DIR *dir
= NULL
;
643 _cleanup_free_
uint16_t *list
= NULL
;
653 dir
= opendir("/sys/firmware/efi/efivars/");
657 FOREACH_DIRENT(de
, dir
, return -errno
) {
660 if (strncmp(de
->d_name
, "Boot", 4) != 0)
663 if (strlen(de
->d_name
) != 45)
666 if (strcmp(de
->d_name
+ 8, "-8be4df61-93ca-11d2-aa0d-00e098032b8c") != 0)
669 id
= boot_id_hex(de
->d_name
+ 4);
673 if (!GREEDY_REALLOC(list
, alloc
, count
+ 1))
679 typesafe_qsort(list
, count
, cmp_uint16
);
681 *options
= TAKE_PTR(list
);
686 static int read_usec(sd_id128_t vendor
, const char *name
, usec_t
*u
) {
687 _cleanup_free_
char *j
= NULL
;
694 r
= efi_get_variable_string(EFI_VENDOR_LOADER
, name
, &j
);
698 r
= safe_atou64(j
, &x
);
706 int efi_loader_get_boot_usec(usec_t
*firmware
, usec_t
*loader
) {
716 r
= read_usec(EFI_VENDOR_LOADER
, "LoaderTimeInitUSec", &x
);
720 r
= read_usec(EFI_VENDOR_LOADER
, "LoaderTimeExecUSec", &y
);
727 if (y
> USEC_PER_HOUR
)
736 int efi_loader_get_device_part_uuid(sd_id128_t
*u
) {
737 _cleanup_free_
char *p
= NULL
;
743 r
= efi_get_variable_string(EFI_VENDOR_LOADER
, "LoaderDevicePartUUID", &p
);
747 if (sscanf(p
, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
748 &parsed
[0], &parsed
[1], &parsed
[2], &parsed
[3],
749 &parsed
[4], &parsed
[5], &parsed
[6], &parsed
[7],
750 &parsed
[8], &parsed
[9], &parsed
[10], &parsed
[11],
751 &parsed
[12], &parsed
[13], &parsed
[14], &parsed
[15]) != 16)
757 for (i
= 0; i
< ELEMENTSOF(parsed
); i
++)
758 u
->bytes
[i
] = parsed
[i
];
764 int efi_loader_get_entries(char ***ret
) {
765 _cleanup_free_ char16_t
*entries
= NULL
;
766 _cleanup_strv_free_
char **l
= NULL
;
767 size_t size
, i
, start
;
775 r
= efi_get_variable(EFI_VENDOR_LOADER
, "LoaderEntries", NULL
, (void**) &entries
, &size
);
779 /* The variable contains a series of individually NUL terminated UTF-16 strings. */
781 for (i
= 0, start
= 0;; i
++) {
785 /* Is this the end of the variable's data? */
786 end
= i
* sizeof(char16_t
) >= size
;
788 /* Are we in the middle of a string? (i.e. not at the end of the variable, nor at a NUL terminator?) If
789 * so, let's go to the next entry. */
790 if (!end
&& entries
[i
] != 0)
793 /* We reached the end of a string, let's decode it into UTF-8 */
794 decoded
= utf16_to_utf8(entries
+ start
, (i
- start
) * sizeof(char16_t
));
798 r
= strv_consume(&l
, decoded
);
802 /* We reached the end of the variable */
806 /* Continue after the NUL byte */
816 char *efi_tilt_backslashes(char *s
) {