Debian Codegraph @

src/bootctl/bootctl.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "shared-forward.h"
5
6 typedef enum InstallSource {
7 INSTALL_SOURCE_IMAGE,
8 INSTALL_SOURCE_HOST,
9 INSTALL_SOURCE_AUTO,
10 _INSTALL_SOURCE_MAX,
11 _INSTALL_SOURCE_INVALID = -EINVAL,
12 } InstallSource;
13
14 typedef enum GracefulMode {
15 ARG_GRACEFUL_NO,
16 ARG_GRACEFUL_YES,
17 ARG_GRACEFUL_FORCE,
18 } GracefulMode;
19
20 extern char *arg_esp_path;
21 extern char *arg_xbootldr_path;
22 extern bool arg_print_esp_path;
23 extern bool arg_print_dollar_boot_path;
24 extern bool arg_print_loader_path;
25 extern bool arg_print_stub_path;
26 extern unsigned arg_print_root_device;
27 extern bool arg_print_efi_architecture;
28 extern int arg_touch_variables;
29 extern bool arg_install_random_seed;
30 extern PagerFlags arg_pager_flags;
31 extern bool arg_quiet;
32 extern int arg_make_entry_directory; /* tri-state: < 0 for automatic logic */
33 extern sd_id128_t arg_machine_id;
34 extern char *arg_install_layout;
35 extern BootEntryTokenType arg_entry_token_type;
36 extern char *arg_entry_token;
37 extern sd_json_format_flags_t arg_json_format_flags;
38 extern bool arg_arch_all;
39 extern char *arg_root;
40 extern char *arg_image;
41 extern InstallSource arg_install_source;
42 extern char *arg_efi_boot_option_description;
43 extern bool arg_efi_boot_option_description_with_device;
44 extern bool arg_dry_run;
45 extern ImagePolicy *arg_image_policy;
46 extern bool arg_varlink;
47 extern bool arg_secure_boot_auto_enroll;
48 extern char *arg_certificate;
49 extern CertificateSourceType arg_certificate_source_type;
50 extern char *arg_certificate_source;
51 extern char *arg_private_key;
52 extern KeySourceType arg_private_key_source_type;
53 extern char *arg_private_key_source;
54 extern bool arg_oldest;
55 extern uint64_t arg_keep_free;
56 extern char *arg_entry_title;
57 extern char *arg_entry_version;
58 extern uint64_t arg_entry_commit;
59 extern char **arg_extras;
60 extern unsigned arg_tries_left;
61
62 static inline const char* arg_dollar_boot_path(void) {
63 /* $BOOT shall be the XBOOTLDR partition if it exists, and otherwise the ESP */
64 return arg_xbootldr_path ?: arg_esp_path;
65 }
66
67 GracefulMode arg_graceful(void);
68
69 int acquire_esp(int unprivileged_mode, bool graceful, int *ret_fd, uint32_t *ret_part, uint64_t *ret_pstart, uint64_t *ret_psize, sd_id128_t *ret_uuid, dev_t *ret_devid);
70 int acquire_xbootldr(int unprivileged_mode, int *ret_fd, sd_id128_t *ret_uuid, dev_t *ret_devid);
71
72 /* EFI_BOOT_OPTION_DESCRIPTION_MAX sets the maximum length for the boot option description
73 * stored in NVRAM. The UEFI spec does not specify a minimum or maximum length for this
74 * string, but we limit the length to something reasonable to prevent from the firmware
75 * having to deal with a potentially too long string. */
76 #define EFI_BOOT_OPTION_DESCRIPTION_MAX ((size_t) 255)
77
78 /* Before we "materialize" a new entry, let's ensure we have this much space free still on the partition, by
79 * default */
80 #define KEEP_FREE_BYTES_DEFAULT (5U * U64_MB)