Debian Codegraph @

src/shared/varlink-io.systemd.BootControl.c

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "varlink-io.systemd.BootControl.h"
4
5 SD_VARLINK_DEFINE_ENUM_TYPE(
6 BootEntryType,
7 SD_VARLINK_FIELD_COMMENT("Boot Loader Specification Type #1 entries (.conf files)"),
8 SD_VARLINK_DEFINE_ENUM_VALUE(type1),
9 SD_VARLINK_FIELD_COMMENT("Boot Loader Specification Type #2 entries (UKIs)"),
10 SD_VARLINK_DEFINE_ENUM_VALUE(type2),
11 SD_VARLINK_FIELD_COMMENT("Additional entries reported by boot loader"),
12 SD_VARLINK_DEFINE_ENUM_VALUE(loader),
13 SD_VARLINK_FIELD_COMMENT("Automatically generated entries"),
14 SD_VARLINK_DEFINE_ENUM_VALUE(auto));
15
16 SD_VARLINK_DEFINE_ENUM_TYPE(
17 BootEntrySource,
18 SD_VARLINK_FIELD_COMMENT("Boot entry found in EFI system partition (ESP)"),
19 SD_VARLINK_DEFINE_ENUM_VALUE(esp),
20 SD_VARLINK_FIELD_COMMENT("Boot entry found in XBOOTLDR partition"),
21 SD_VARLINK_DEFINE_ENUM_VALUE(xbootldr));
22
23 static SD_VARLINK_DEFINE_STRUCT_TYPE(
24 BootEntryAddon,
25 SD_VARLINK_FIELD_COMMENT("The location of the global addon."),
26 SD_VARLINK_DEFINE_FIELD(globalAddon, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
27 SD_VARLINK_FIELD_COMMENT("The location of the local addon."),
28 SD_VARLINK_DEFINE_FIELD(localAddon, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
29 SD_VARLINK_FIELD_COMMENT("The command line options by the addon."),
30 SD_VARLINK_DEFINE_FIELD(options, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
31
32 static SD_VARLINK_DEFINE_STRUCT_TYPE(
33 BootEntry,
34 SD_VARLINK_DEFINE_FIELD_BY_TYPE(type, BootEntryType, 0),
35 SD_VARLINK_FIELD_COMMENT("The source of the entry"),
36 SD_VARLINK_DEFINE_FIELD_BY_TYPE(source, BootEntrySource, 0),
37 SD_VARLINK_FIELD_COMMENT("The string identifier of the entry"),
38 SD_VARLINK_DEFINE_FIELD(id, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
39 SD_VARLINK_FIELD_COMMENT("Path to the primary definition file for the entry"),
40 SD_VARLINK_DEFINE_FIELD(path, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
41 SD_VARLINK_FIELD_COMMENT("Directory path of the file system root the entry was found on"),
42 SD_VARLINK_DEFINE_FIELD(root, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
43 SD_VARLINK_FIELD_COMMENT("The entry's title string"),
44 SD_VARLINK_DEFINE_FIELD(title, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
45 SD_VARLINK_FIELD_COMMENT("The possibly mangled/augmented title to show for the entry"),
46 SD_VARLINK_DEFINE_FIELD(showTitle, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
47 SD_VARLINK_FIELD_COMMENT("An explicitly configured sorting key for the enry"),
48 SD_VARLINK_DEFINE_FIELD(sortKey, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
49 SD_VARLINK_FIELD_COMMENT("The version of the entry"),
50 SD_VARLINK_DEFINE_FIELD(version, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
51 SD_VARLINK_FIELD_COMMENT("Machine ID of the OS installation belonging to the entry, if known"),
52 SD_VARLINK_DEFINE_FIELD(machineId, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
53 SD_VARLINK_FIELD_COMMENT("EFI architecture name for this entry"),
54 SD_VARLINK_DEFINE_FIELD(architecture, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
55 SD_VARLINK_FIELD_COMMENT("Command line options to pass to the invoked kernel or EFI binary"),
56 SD_VARLINK_DEFINE_FIELD(options, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
57 SD_VARLINK_FIELD_COMMENT("Path to the Linux kernel to invoke, relative to the root directory of the file system containing the entry file"),
58 SD_VARLINK_DEFINE_FIELD(linux, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
59 SD_VARLINK_FIELD_COMMENT("Path to the EFI binary to invoke, relative to the root directory of the file system containing the entry file"),
60 SD_VARLINK_DEFINE_FIELD(efi, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
61 SD_VARLINK_FIELD_COMMENT("Path to an UKI EFI binary to invoke, relative to the root directory of the file system containing the entry file"),
62 SD_VARLINK_DEFINE_FIELD(uki, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
63 SD_VARLINK_FIELD_COMMENT("An UKI profile index to invoke. If not specified defaults to the first profile."),
64 SD_VARLINK_DEFINE_FIELD(profile, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
65 SD_VARLINK_FIELD_COMMENT("Path to the initrd image to pass to the invoked kernel, relative to the root directory of the file system containing the entry file"),
66 SD_VARLINK_DEFINE_FIELD(initrd, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
67 SD_VARLINK_FIELD_COMMENT("Devicetree file to pass to the invoked kernel, relative to the root directory of the file system containing the entry file"),
68 SD_VARLINK_DEFINE_FIELD(devicetree, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
69 SD_VARLINK_FIELD_COMMENT("Devicetree overlay file to pass to the invoked kernel, relative to the root directory of the file system containing the entry file"),
70 SD_VARLINK_DEFINE_FIELD(devicetreeOverlay, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
71 SD_VARLINK_FIELD_COMMENT("Indicates whether the boot loader reported this entry on the current boot"),
72 SD_VARLINK_DEFINE_FIELD(isReported, SD_VARLINK_BOOL, 0),
73 SD_VARLINK_FIELD_COMMENT("Indicates the number of tries left for this boot entry before it is assumed to be not working."),
74 SD_VARLINK_DEFINE_FIELD(triesLeft, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
75 SD_VARLINK_FIELD_COMMENT("Indicates the number of unsuccessful tries already made for this boot entry."),
76 SD_VARLINK_DEFINE_FIELD(triesDone, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
77 SD_VARLINK_FIELD_COMMENT("Indicates whether this entry is the default entry."),
78 SD_VARLINK_DEFINE_FIELD(isDefault, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
79 SD_VARLINK_FIELD_COMMENT("Indicates whether this entry has been booted."),
80 SD_VARLINK_DEFINE_FIELD(isSelected, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
81 SD_VARLINK_FIELD_COMMENT("Addon images of the entry."),
82 SD_VARLINK_DEFINE_FIELD_BY_TYPE(addons, BootEntryAddon, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
83 SD_VARLINK_FIELD_COMMENT("Extra files associated with the entry."),
84 SD_VARLINK_DEFINE_FIELD(extras, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
85 SD_VARLINK_FIELD_COMMENT("Command line options of the entry."),
86 SD_VARLINK_DEFINE_FIELD(cmdline, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
87
88 static SD_VARLINK_DEFINE_METHOD_FULL(
89 ListBootEntries,
90 SD_VARLINK_REQUIRES_MORE,
91 SD_VARLINK_FIELD_COMMENT("A boot menu entry structure"),
92 SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(entry, BootEntry, 0));
93
94 static SD_VARLINK_DEFINE_METHOD(
95 SetRebootToFirmware,
96 SD_VARLINK_FIELD_COMMENT("The new value of the reboot-to-firmware-UI flag"),
97 SD_VARLINK_DEFINE_INPUT(state, SD_VARLINK_BOOL, 0));
98
99 static SD_VARLINK_DEFINE_METHOD(
100 GetRebootToFirmware,
101 SD_VARLINK_FIELD_COMMENT("The current state of the reboot-to-firmware-UI flag"),
102 SD_VARLINK_DEFINE_OUTPUT(state, SD_VARLINK_BOOL, 0));
103
104 static SD_VARLINK_DEFINE_ENUM_TYPE(
105 Operation,
106 SD_VARLINK_FIELD_COMMENT("Install the boot loader afresh, creating everything it needs"),
107 SD_VARLINK_DEFINE_ENUM_VALUE(new),
108 SD_VARLINK_FIELD_COMMENT("Just update existing boot loader binaries"),
109 SD_VARLINK_DEFINE_ENUM_VALUE(update));
110
111 static SD_VARLINK_DEFINE_ENUM_TYPE(
112 BootEntryTokenType,
113 SD_VARLINK_FIELD_COMMENT("Pick identifiers for type #1 boot entries based on /etc/machine-id"),
114 SD_VARLINK_DEFINE_ENUM_VALUE(machine_id),
115 SD_VARLINK_FIELD_COMMENT("Pick identifiers for type #1 boot entries based on the IMAGE_ID= field from /etc/os-release"),
116 SD_VARLINK_DEFINE_ENUM_VALUE(os_image_id),
117 SD_VARLINK_FIELD_COMMENT("Pick identifiers for type #1 boot entries based on the ID= field from /etc/os-release"),
118 SD_VARLINK_DEFINE_ENUM_VALUE(os_id),
119 SD_VARLINK_FIELD_COMMENT("Pick identifiers for type #1 boot entries based on a manually chosen string"),
120 SD_VARLINK_DEFINE_ENUM_VALUE(literal),
121 SD_VARLINK_FIELD_COMMENT("Choose automatically how to pick identifiers for type #1 boot entries"),
122 SD_VARLINK_DEFINE_ENUM_VALUE(auto));
123
124 static SD_VARLINK_DEFINE_METHOD(
125 Install,
126 SD_VARLINK_FIELD_COMMENT("Operation, either 'new' or 'update'"),
127 SD_VARLINK_DEFINE_INPUT_BY_TYPE(operation, Operation, 0),
128 SD_VARLINK_FIELD_COMMENT("If true, continue on various failures"),
129 SD_VARLINK_DEFINE_INPUT(graceful, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
130 SD_VARLINK_FIELD_COMMENT("Index into array of file descriptors passed along with this message, pointing to file descriptor to root file system to operate on"),
131 SD_VARLINK_DEFINE_INPUT(rootFileDescriptor, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
132 SD_VARLINK_FIELD_COMMENT("Root directory to operate relative to. If both this and rootFileDescriptor is specified, this is purely informational. If only this is specified, it is what will be used."),
133 SD_VARLINK_DEFINE_INPUT(rootDirectory, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
134 SD_VARLINK_FIELD_COMMENT("Selects how to identify boot entries"),
135 SD_VARLINK_DEFINE_INPUT_BY_TYPE(bootEntryTokenType, BootEntryTokenType, SD_VARLINK_NULLABLE),
136 SD_VARLINK_FIELD_COMMENT("If true the boot loader will be registered in an EFI boot entry via EFI variables, otherwise this is omitted"),
137 SD_VARLINK_DEFINE_INPUT(touchVariables, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE));
138
139 static SD_VARLINK_DEFINE_METHOD(
140 Unlink,
141 SD_VARLINK_FIELD_COMMENT("Index into array of file descriptors passed along with this message, pointing to file descriptor to root file system to operate on"),
142 SD_VARLINK_DEFINE_INPUT(rootFileDescriptor, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
143 SD_VARLINK_FIELD_COMMENT("Root directory to operate relative to. If both this and rootFileDescriptor is specified, this is purely informational. If only this is specified, it is what will be used."),
144 SD_VARLINK_DEFINE_INPUT(rootDirectory, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
145 SD_VARLINK_FIELD_COMMENT("Selects how to identify boot entries"),
146 SD_VARLINK_DEFINE_INPUT_BY_TYPE(bootEntryTokenType, BootEntryTokenType, SD_VARLINK_NULLABLE),
147 SD_VARLINK_FIELD_COMMENT("The ID of the boot loader entry to remove."),
148 SD_VARLINK_DEFINE_INPUT(id, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
149 SD_VARLINK_FIELD_COMMENT("If true, remove the oldest entry."),
150 SD_VARLINK_DEFINE_INPUT(oldest, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE));
151
152 static SD_VARLINK_DEFINE_STRUCT_TYPE(
153 BootEntryExtraFile,
154 SD_VARLINK_FIELD_COMMENT("The name of the extra file"),
155 SD_VARLINK_DEFINE_FIELD(filename, SD_VARLINK_STRING, 0),
156 SD_VARLINK_FIELD_COMMENT("Index into array of file descriptors, pointing to a file descriptor referencing the extra file to copy in. Either this or the 'data' field below must be set – not both, not neither."),
157 SD_VARLINK_DEFINE_FIELD(fileDescriptor, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
158 SD_VARLINK_FIELD_COMMENT("Literal data to place in the extra file."),
159 SD_VARLINK_DEFINE_FIELD(data, SD_VARLINK_STRING, SD_VARLINK_NULLABLE));
160
161 static SD_VARLINK_DEFINE_METHOD(
162 Link,
163 SD_VARLINK_FIELD_COMMENT("Index into array of file descriptors passed along with this message, pointing to file descriptor to root file system to operate on"),
164 SD_VARLINK_DEFINE_INPUT(rootFileDescriptor, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
165 SD_VARLINK_FIELD_COMMENT("Root directory to operate relative to. If both this and rootFileDescriptor is specified, this is purely informational. If only this is specified, it is what will be used."),
166 SD_VARLINK_DEFINE_INPUT(rootDirectory, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
167 SD_VARLINK_FIELD_COMMENT("Selects how to identify boot entries"),
168 SD_VARLINK_DEFINE_INPUT_BY_TYPE(bootEntryTokenType, BootEntryTokenType, SD_VARLINK_NULLABLE),
169 SD_VARLINK_FIELD_COMMENT("The entry title for the newly created boot menu entry"),
170 SD_VARLINK_DEFINE_INPUT(entryTitle, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
171 SD_VARLINK_FIELD_COMMENT("The entry version for the newly created boot menu entry"),
172 SD_VARLINK_DEFINE_INPUT(entryVersion, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
173 SD_VARLINK_FIELD_COMMENT("The commit number for the newly created boot menu entry"),
174 SD_VARLINK_DEFINE_INPUT(entryCommit, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
175 SD_VARLINK_FIELD_COMMENT("Target filename for the kernel image (UKI) in the $BOOT partition"),
176 SD_VARLINK_DEFINE_INPUT(kernelFilename, SD_VARLINK_STRING, 0),
177 SD_VARLINK_FIELD_COMMENT("Index into array of file descriptors passed along with this message, pointing to file descriptor to the kernel image to copy"),
178 SD_VARLINK_DEFINE_INPUT(kernelFileDescriptor, SD_VARLINK_INT, 0),
179 SD_VARLINK_FIELD_COMMENT("An array of 'extra' files for this entry, i.e. credentials, confexts, sysexts, addons."),
180 SD_VARLINK_DEFINE_INPUT_BY_TYPE(extraFiles, BootEntryExtraFile, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY),
181 SD_VARLINK_FIELD_COMMENT("What to set the triesLeft counter of the boot menu entry to initially."),
182 SD_VARLINK_DEFINE_INPUT(triesLeft, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
183 SD_VARLINK_FIELD_COMMENT("How much space to always keep free on ESP/XBOOTLDR. Defaults to 1 MiB"),
184 SD_VARLINK_DEFINE_INPUT(keepFree, SD_VARLINK_INT, SD_VARLINK_NULLABLE),
185 SD_VARLINK_FIELD_COMMENT("The IDs of the created boot loader entries."),
186 SD_VARLINK_DEFINE_OUTPUT(ids, SD_VARLINK_STRING, SD_VARLINK_ARRAY));
187
188 static SD_VARLINK_DEFINE_ERROR(
189 RebootToFirmwareNotSupported);
190
191 static SD_VARLINK_DEFINE_ERROR(
192 NoSuchBootEntry);
193
194 static SD_VARLINK_DEFINE_ERROR(
195 NoESPFound);
196
197 static SD_VARLINK_DEFINE_ERROR(
198 NoDollarBootFound);
199
200 static SD_VARLINK_DEFINE_ERROR(
201 BootEntryTokenUnavailable);
202
203 static SD_VARLINK_DEFINE_ERROR(
204 InvalidKernelImage);
205
206 SD_VARLINK_DEFINE_INTERFACE(
207 io_systemd_BootControl,
208 "io.systemd.BootControl",
209 SD_VARLINK_INTERFACE_COMMENT("Boot Loader control APIs"),
210 SD_VARLINK_SYMBOL_COMMENT("The type of a boot entry"),
211 &vl_type_BootEntryType,
212 SD_VARLINK_SYMBOL_COMMENT("The source of a boot entry"),
213 &vl_type_BootEntrySource,
214 SD_VARLINK_SYMBOL_COMMENT("A structure encapsulating an addon of a boot entry"),
215 &vl_type_BootEntryAddon,
216 SD_VARLINK_SYMBOL_COMMENT("An additional file to install"),
217 &vl_type_BootEntryExtraFile,
218 SD_VARLINK_SYMBOL_COMMENT("A structure encapsulating a boot entry"),
219 &vl_type_BootEntry,
220 SD_VARLINK_SYMBOL_COMMENT("The operation to execute"),
221 &vl_type_Operation,
222 SD_VARLINK_SYMBOL_COMMENT("Enumerates boot entries. Method call must be called with 'more' flag set. Each response returns one entry. If no entries are defined returns the NoSuchBootEntry error."),
223 &vl_method_ListBootEntries,
224 SD_VARLINK_SYMBOL_COMMENT("Sets the reboot-to-firmware-UI flag of the firmware, if this concept exists. Returns the RebootToFirmwareNotSupported error if not."),
225 &vl_method_SetRebootToFirmware,
226 SD_VARLINK_SYMBOL_COMMENT("Gets the current state of the reboot-to-firmware-UI flag of the firmware, if this concept exists. Returns the RebootToFirmwareNotSupported error if not."),
227 &vl_method_GetRebootToFirmware,
228 SD_VARLINK_SYMBOL_COMMENT("The boot entry token type to use."),
229 &vl_type_BootEntryTokenType,
230 SD_VARLINK_SYMBOL_COMMENT("Install the boot loader on the ESP."),
231 &vl_method_Install,
232 SD_VARLINK_SYMBOL_COMMENT("Unlink a boot menu item"),
233 &vl_method_Unlink,
234 SD_VARLINK_SYMBOL_COMMENT("Install a kernel as boot menu item"),
235 &vl_method_Link,
236 SD_VARLINK_SYMBOL_COMMENT("SetRebootToFirmware() and GetRebootToFirmware() return this if the firmware does not actually support the reboot-to-firmware-UI concept."),
237 &vl_error_RebootToFirmwareNotSupported,
238 SD_VARLINK_SYMBOL_COMMENT("No boot entry defined."),
239 &vl_error_NoSuchBootEntry,
240 SD_VARLINK_SYMBOL_COMMENT("No EFI System Partition (ESP) found."),
241 &vl_error_NoESPFound,
242 SD_VARLINK_SYMBOL_COMMENT("Neither ESP nor XBOOTLDR found, hence no $BOOT location identified."),
243 &vl_error_NoDollarBootFound,
244 SD_VARLINK_SYMBOL_COMMENT("The selected boot entry token could not be determined."),
245 &vl_error_BootEntryTokenUnavailable,
246 SD_VARLINK_SYMBOL_COMMENT("The specified kernel image is not valid."),
247 &vl_error_InvalidKernelImage);