1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2013 Lennart Poettering
20 #include "alloc-util.h"
21 #include "dirent-util.h"
26 #include "parse-util.h"
27 #include "stdio-util.h"
28 #include "time-util.h"
35 #define LOAD_OPTION_ACTIVE 0x00000001
36 #define MEDIA_DEVICE_PATH 0x04
37 #define MEDIA_HARDDRIVE_DP 0x01
38 #define MEDIA_FILEPATH_DP 0x04
39 #define SIGNATURE_TYPE_GUID 0x02
40 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
41 #define END_DEVICE_PATH_TYPE 0x7f
42 #define END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
43 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
57 uint8_t signature_type
;
66 struct drive_path drive
;
70 bool is_efi_boot(void) {
71 return access("/sys/firmware/efi", F_OK
) >= 0;
74 static int read_flag(const char *varname
) {
75 _cleanup_free_
void *v
= NULL
;
80 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, varname
, NULL
, &v
, &s
);
91 bool is_efi_secure_boot(void) {
92 return read_flag("SecureBoot") > 0;
95 bool is_efi_secure_boot_setup_mode(void) {
96 return read_flag("SetupMode") > 0;
99 int efi_reboot_to_firmware_supported(void) {
100 _cleanup_free_
void *v
= NULL
;
105 if (!is_efi_boot() || detect_container() > 0)
108 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "OsIndicationsSupported", NULL
, &v
, &s
);
109 if (r
== -ENOENT
) /* variable doesn't exist? it's not supported then */
113 if (s
!= sizeof(uint64_t))
117 if (!(b
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
))
118 return -EOPNOTSUPP
; /* bit unset? it's not supported then */
123 static int get_os_indications(uint64_t *os_indication
) {
124 _cleanup_free_
void *v
= NULL
;
128 r
= efi_reboot_to_firmware_supported();
132 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "OsIndications", NULL
, &v
, &s
);
134 /* Some firmware implementations that do support
135 * OsIndications and report that with
136 * OsIndicationsSupported will remove the
137 * OsIndications variable when it is unset. Let's
138 * pretend it's 0 then, to hide this implementation
139 * detail. Note that this call will return -ENOENT
140 * then only if the support for OsIndications is
141 * missing entirely, as determined by
142 * efi_reboot_to_firmware_supported() above. */
147 else if (s
!= sizeof(uint64_t))
150 *os_indication
= *(uint64_t *)v
;
154 int efi_get_reboot_to_firmware(void) {
158 r
= get_os_indications(&b
);
162 return !!(b
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
);
165 int efi_set_reboot_to_firmware(bool value
) {
169 r
= get_os_indications(&b
);
174 b_new
= b
| EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
176 b_new
= b
& ~EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
178 /* Avoid writing to efi vars store if we can due to firmware bugs. */
180 return efi_set_variable(EFI_VENDOR_GLOBAL
, "OsIndications", &b_new
, sizeof(uint64_t));
185 int efi_get_variable(
192 _cleanup_close_
int fd
= -1;
193 _cleanup_free_
char *p
= NULL
;
197 _cleanup_free_
void *buf
= NULL
;
204 "/sys/firmware/efi/efivars/%s-%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
205 name
, SD_ID128_FORMAT_VAL(vendor
)) < 0)
208 fd
= open(p
, O_RDONLY
|O_NOCTTY
|O_CLOEXEC
);
212 if (fstat(fd
, &st
) < 0)
216 if (st
.st_size
> 4*1024*1024 + 4)
219 n
= read(fd
, &a
, sizeof(a
));
225 buf
= malloc(st
.st_size
- 4 + 2);
229 n
= read(fd
, buf
, (size_t) st
.st_size
- 4);
232 if (n
!= (ssize_t
) st
.st_size
- 4)
235 /* Always NUL terminate (2 bytes, to protect UTF-16) */
236 ((char*) buf
)[st
.st_size
- 4] = 0;
237 ((char*) buf
)[st
.st_size
- 4 + 1] = 0;
239 *value
= TAKE_PTR(buf
);
240 *size
= (size_t) st
.st_size
- 4;
248 int efi_set_variable(
257 } _packed_
* _cleanup_free_ buf
= NULL
;
258 _cleanup_free_
char *p
= NULL
;
259 _cleanup_close_
int fd
= -1;
262 assert(value
|| size
== 0);
265 "/sys/firmware/efi/efivars/%s-%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
266 name
, SD_ID128_FORMAT_VAL(vendor
)) < 0)
275 fd
= open(p
, O_WRONLY
|O_CREAT
|O_NOCTTY
|O_CLOEXEC
, 0644);
279 buf
= malloc(sizeof(uint32_t) + size
);
283 buf
->attr
= EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
|EFI_VARIABLE_RUNTIME_ACCESS
;
284 memcpy(buf
->buf
, value
, size
);
286 return loop_write(fd
, buf
, sizeof(uint32_t) + size
, false);
289 int efi_get_variable_string(sd_id128_t vendor
, const char *name
, char **p
) {
290 _cleanup_free_
void *s
= NULL
;
295 r
= efi_get_variable(vendor
, name
, NULL
, &s
, &ss
);
299 x
= utf16_to_utf8(s
, ss
);
307 static size_t utf16_size(const uint16_t *s
) {
313 return (l
+1) * sizeof(uint16_t);
316 static void efi_guid_to_id128(const void *guid
, sd_id128_t
*id128
) {
323 const struct uuid
*uuid
= guid
;
325 id128
->bytes
[0] = (uuid
->u1
>> 24) & 0xff;
326 id128
->bytes
[1] = (uuid
->u1
>> 16) & 0xff;
327 id128
->bytes
[2] = (uuid
->u1
>> 8) & 0xff;
328 id128
->bytes
[3] = (uuid
->u1
) & 0xff;
329 id128
->bytes
[4] = (uuid
->u2
>> 8) & 0xff;
330 id128
->bytes
[5] = (uuid
->u2
) & 0xff;
331 id128
->bytes
[6] = (uuid
->u3
>> 8) & 0xff;
332 id128
->bytes
[7] = (uuid
->u3
) & 0xff;
333 memcpy(&id128
->bytes
[8], uuid
->u4
, sizeof(uuid
->u4
));
336 int efi_get_boot_option(
339 sd_id128_t
*part_uuid
,
344 _cleanup_free_
uint8_t *buf
= NULL
;
346 struct boot_option
*header
;
348 _cleanup_free_
char *s
= NULL
, *p
= NULL
;
349 sd_id128_t p_uuid
= SD_ID128_NULL
;
352 xsprintf(boot_id
, "Boot%04X", id
);
353 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, boot_id
, NULL
, (void **)&buf
, &l
);
356 if (l
< sizeof(struct boot_option
))
359 header
= (struct boot_option
*)buf
;
360 title_size
= utf16_size(header
->title
);
361 if (title_size
> l
- offsetof(struct boot_option
, title
))
365 s
= utf16_to_utf8(header
->title
, title_size
);
370 if (header
->path_len
> 0) {
374 dbuf
= buf
+ offsetof(struct boot_option
, title
) + title_size
;
376 while (dnext
< header
->path_len
) {
377 struct device_path
*dpath
;
379 dpath
= (struct device_path
*)(dbuf
+ dnext
);
380 if (dpath
->length
< 4)
383 /* Type 0x7F – End of Hardware Device Path, Sub-Type 0xFF – End Entire Device Path */
384 if (dpath
->type
== END_DEVICE_PATH_TYPE
&& dpath
->sub_type
== END_ENTIRE_DEVICE_PATH_SUBTYPE
)
387 dnext
+= dpath
->length
;
389 /* Type 0x04 – Media Device Path */
390 if (dpath
->type
!= MEDIA_DEVICE_PATH
)
393 /* Sub-Type 1 – Hard Drive */
394 if (dpath
->sub_type
== MEDIA_HARDDRIVE_DP
) {
395 /* 0x02 – GUID Partition Table */
396 if (dpath
->drive
.mbr_type
!= MBR_TYPE_EFI_PARTITION_TABLE_HEADER
)
399 /* 0x02 – GUID signature */
400 if (dpath
->drive
.signature_type
!= SIGNATURE_TYPE_GUID
)
404 efi_guid_to_id128(dpath
->drive
.signature
, &p_uuid
);
408 /* Sub-Type 4 – File Path */
409 if (dpath
->sub_type
== MEDIA_FILEPATH_DP
&& !p
&& path
) {
410 p
= utf16_to_utf8(dpath
->path
, dpath
->length
-4);
411 efi_tilt_backslashes(p
);
418 *title
= TAKE_PTR(s
);
424 *active
= !!(header
->attr
& LOAD_OPTION_ACTIVE
);
429 static void to_utf16(uint16_t *dest
, const char *src
) {
432 for (i
= 0; src
[i
] != '\0'; i
++)
444 static void id128_to_efi_guid(sd_id128_t id
, void *guid
) {
445 struct guid
*uuid
= guid
;
447 uuid
->u1
= id
.bytes
[0] << 24 | id
.bytes
[1] << 16 | id
.bytes
[2] << 8 | id
.bytes
[3];
448 uuid
->u2
= id
.bytes
[4] << 8 | id
.bytes
[5];
449 uuid
->u3
= id
.bytes
[6] << 8 | id
.bytes
[7];
450 memcpy(uuid
->u4
, id
.bytes
+8, sizeof(uuid
->u4
));
453 static uint16_t *tilt_slashes(uint16_t *s
) {
463 int efi_add_boot_option(uint16_t id
, const char *title
,
464 uint32_t part
, uint64_t pstart
, uint64_t psize
,
465 sd_id128_t part_uuid
, const char *path
) {
470 struct boot_option
*option
;
471 struct device_path
*devicep
;
472 _cleanup_free_
char *buf
= NULL
;
474 title_len
= (strlen(title
)+1) * 2;
475 path_len
= (strlen(path
)+1) * 2;
477 buf
= calloc(sizeof(struct boot_option
) + title_len
+
478 sizeof(struct drive_path
) +
479 sizeof(struct device_path
) + path_len
, 1);
484 option
= (struct boot_option
*)buf
;
485 option
->attr
= LOAD_OPTION_ACTIVE
;
486 option
->path_len
= offsetof(struct device_path
, drive
) + sizeof(struct drive_path
) +
487 offsetof(struct device_path
, path
) + path_len
+
488 offsetof(struct device_path
, path
);
489 to_utf16(option
->title
, title
);
490 size
= offsetof(struct boot_option
, title
) + title_len
;
493 devicep
= (struct device_path
*)(buf
+ size
);
494 devicep
->type
= MEDIA_DEVICE_PATH
;
495 devicep
->sub_type
= MEDIA_HARDDRIVE_DP
;
496 devicep
->length
= offsetof(struct device_path
, drive
) + sizeof(struct drive_path
);
497 devicep
->drive
.part_nr
= part
;
498 devicep
->drive
.part_start
= pstart
;
499 devicep
->drive
.part_size
= psize
;
500 devicep
->drive
.signature_type
= SIGNATURE_TYPE_GUID
;
501 devicep
->drive
.mbr_type
= MBR_TYPE_EFI_PARTITION_TABLE_HEADER
;
502 id128_to_efi_guid(part_uuid
, devicep
->drive
.signature
);
503 size
+= devicep
->length
;
506 devicep
= (struct device_path
*)(buf
+ size
);
507 devicep
->type
= MEDIA_DEVICE_PATH
;
508 devicep
->sub_type
= MEDIA_FILEPATH_DP
;
509 devicep
->length
= offsetof(struct device_path
, path
) + path_len
;
510 to_utf16(devicep
->path
, path
);
511 tilt_slashes(devicep
->path
);
512 size
+= devicep
->length
;
515 devicep
= (struct device_path
*)(buf
+ size
);
516 devicep
->type
= END_DEVICE_PATH_TYPE
;
517 devicep
->sub_type
= END_ENTIRE_DEVICE_PATH_SUBTYPE
;
518 devicep
->length
= offsetof(struct device_path
, path
);
519 size
+= devicep
->length
;
521 xsprintf(boot_id
, "Boot%04X", id
);
522 return efi_set_variable(EFI_VENDOR_GLOBAL
, boot_id
, buf
, size
);
525 int efi_remove_boot_option(uint16_t id
) {
528 xsprintf(boot_id
, "Boot%04X", id
);
529 return efi_set_variable(EFI_VENDOR_GLOBAL
, boot_id
, NULL
, 0);
532 int efi_get_boot_order(uint16_t **order
) {
533 _cleanup_free_
void *buf
= NULL
;
537 r
= efi_get_variable(EFI_VENDOR_GLOBAL
, "BootOrder", NULL
, &buf
, &l
);
544 if (l
% sizeof(uint16_t) > 0 ||
545 l
/ sizeof(uint16_t) > INT_MAX
)
548 *order
= TAKE_PTR(buf
);
549 return (int) (l
/ sizeof(uint16_t));
552 int efi_set_boot_order(uint16_t *order
, size_t n
) {
553 return efi_set_variable(EFI_VENDOR_GLOBAL
, "BootOrder", order
, n
* sizeof(uint16_t));
556 static int boot_id_hex(const char s
[4]) {
560 for (i
= 0; i
< 4; i
++)
561 if (s
[i
] >= '0' && s
[i
] <= '9')
562 id
|= (s
[i
] - '0') << (3 - i
) * 4;
563 else if (s
[i
] >= 'A' && s
[i
] <= 'F')
564 id
|= (s
[i
] - 'A' + 10) << (3 - i
) * 4;
571 static int cmp_uint16(const void *_a
, const void *_b
) {
572 const uint16_t *a
= _a
, *b
= _b
;
574 return (int)*a
- (int)*b
;
577 int efi_get_boot_options(uint16_t **options
) {
578 _cleanup_closedir_
DIR *dir
= NULL
;
580 _cleanup_free_
uint16_t *list
= NULL
;
586 dir
= opendir("/sys/firmware/efi/efivars/");
590 FOREACH_DIRENT(de
, dir
, return -errno
) {
593 if (strncmp(de
->d_name
, "Boot", 4) != 0)
596 if (strlen(de
->d_name
) != 45)
599 if (strcmp(de
->d_name
+ 8, "-8be4df61-93ca-11d2-aa0d-00e098032b8c") != 0)
602 id
= boot_id_hex(de
->d_name
+ 4);
606 if (!GREEDY_REALLOC(list
, alloc
, count
+ 1))
612 qsort_safe(list
, count
, sizeof(uint16_t), cmp_uint16
);
614 *options
= TAKE_PTR(list
);
619 static int read_usec(sd_id128_t vendor
, const char *name
, usec_t
*u
) {
620 _cleanup_free_
char *j
= NULL
;
627 r
= efi_get_variable_string(EFI_VENDOR_LOADER
, name
, &j
);
631 r
= safe_atou64(j
, &x
);
639 int efi_loader_get_boot_usec(usec_t
*firmware
, usec_t
*loader
) {
646 r
= read_usec(EFI_VENDOR_LOADER
, "LoaderTimeInitUSec", &x
);
650 r
= read_usec(EFI_VENDOR_LOADER
, "LoaderTimeExecUSec", &y
);
657 if (y
> USEC_PER_HOUR
)
666 int efi_loader_get_device_part_uuid(sd_id128_t
*u
) {
667 _cleanup_free_
char *p
= NULL
;
670 r
= efi_get_variable_string(EFI_VENDOR_LOADER
, "LoaderDevicePartUUID", &p
);
674 if (sscanf(p
, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
675 &parsed
[0], &parsed
[1], &parsed
[2], &parsed
[3],
676 &parsed
[4], &parsed
[5], &parsed
[6], &parsed
[7],
677 &parsed
[8], &parsed
[9], &parsed
[10], &parsed
[11],
678 &parsed
[12], &parsed
[13], &parsed
[14], &parsed
[15]) != 16)
684 for (i
= 0; i
< ELEMENTSOF(parsed
); i
++)
685 u
->bytes
[i
] = parsed
[i
];
693 char *efi_tilt_backslashes(char *s
) {