]> git.ipfire.org Git - thirdparty/systemd.git/blob - docs/BOOT_LOADER_SPECIFICATION.md
doc: fix typo
[thirdparty/systemd.git] / docs / BOOT_LOADER_SPECIFICATION.md
1 ---
2 title: Boot Loader Specification
3 category: Booting
4 layout: default
5 SPDX-License-Identifier: LGPL-2.1-or-later
6 ---
7
8 # The Boot Loader Specification
9
10 This document defines a set of file formats and naming conventions that allow
11 the boot loader configuration to be shared between multiple operating systems
12 and boot loaders installed on one device.
13
14 Operating systems cooperatively manage a boot loader configuration directory
15 that contains drop-in files, making multi-boot scenarios easy to support. Boot
16 menu items are defined via a simple format that can be understood by different
17 boot loader implementations, operating systems, and userspace programs. The
18 same scheme can be used to prepare OS media for cases where the firmware
19 includes a boot loader.
20
21 ## Target audience
22
23 The target audience for this specification is:
24
25 * Boot loader developers, to write a boot loader that directly reads its
26 configuration from these files
27 * Firmware developers, to add generic boot loading support directly to the
28 firmware itself
29 * OS installer developers, to create appropriate partitions and set up the
30 initial boot loader configuration
31 * Distribution developers, to create appropriate configuration snippets when
32 installing or updating kernel packages
33 * UI developers, to implement user interfaces that list and select among the
34 available boot options
35
36 ## The boot partition
37
38 Everything described below is located on one or two partitions. The boot loader
39 or user-space programs reading the boot loader configuration should locate them
40 in the following manner:
41
42 * On disks with an MBR partition table:
43
44 * The boot partition — partition with the type ID of 0xEA — shall be used
45 for boot loader configuration and entries.
46
47 * On disks with GPT (GUID Partition Table)
48
49 * The EFI System Partition (ESP for short) — a partition with GPT type GUID
50 of `c12a7328-f81f-11d2-ba4b-00a0c93ec93b` — should be used for boot loader
51 configuration and boot entries.
52
53 * Optionally, an Extended Boot Loader Partition (XBOOTLDR partition for
54 short) — a partition with GPT type GUID of
55 `bc13c2ff-59e6-4262-a352-b275fd6f7172` — may be used as an additional
56 location for boot loader entries. This partition must be located on the
57 same disk as the ESP.
58
59 In the text below, `$BOOT` will be used to refer to (the root of) the first of
60 the two partitions (the boot partition on MBR disks and the ESP on GPT disks),
61 and `$XBOOTLDR` will be used to refer to (the root of) the optional second
62 partition.
63
64 An installer for the operating system should use this logic when selecting or
65 creating partitions:
66
67 * If `$BOOT` is not found, a new suitably sized partition (let's say 500MB)
68 should be created, matching the characteristics described above. On disks
69 with GPT, only the ESP partition without the XBOOTLDR partition should be
70 created.
71
72 * If the OS is installed on a disk with GPT and the ESP partition is found
73 but is too small, a new suitably sized (let's say 500MB) XBOOTLDR partition
74 shall be created.
75
76 Those file systems shall be determined during _installation time_, and an fstab
77 entry may be created. If only one partition is used, it should be mounted on
78 `/boot/`. If both XBOOTLDR partition and the ESP are used, they should be
79 mounted on `/boot` and `/efi`, or on `/boot` and `/boot/efi`.
80
81 **Note:** _Those file systems are **shared** among all OS installations on the
82 system. Instead of maintaining one boot partition per installed OS (as `/boot/`
83 was traditionally handled), all installed OSes use the same place for boot-time
84 configuration._
85
86 For systems where the firmware is able to read file systems directly, the ESP
87 must — and the XBOOTLDR partition should — be a file system readable by the
88 firmware. For most systems this means VFAT (16 or 32 bit). Applications
89 accessing both partitions should hence not assume that fancier file system
90 features such as symlinks, hardlinks, access control or case sensitivity are
91 supported.
92
93 ## Boot loader entries
94
95 This specification defines two types of boot loader entries. The first type is
96 text based, very simple, and suitable for a variety of firmware, architecture
97 and image types ("Type #1"). The second type is specific to EFI, but allows
98 single-file images that embed all metadata in the kernel binary itself, which
99 is useful to cryptographically sign them as one file for the purpose of
100 SecureBoot ("Type #2").
101
102 Not all boot loader entries will apply to all systems. For example, Type #1
103 entries that use the `efi` key and all Type #2 entries only apply to EFI
104 systems. Entries using the `architecture` key might specify an architecture that
105 doesn't match the local one. Boot loaders should ignore all entries that don't
106 match the local platform and what the boot loader can support, and hide them
107 from the user. Only entries matching the feature set of boot loader and system
108 shall be considered and displayed. This allows image builders to put together
109 images that transparently support multiple different architectures.
110
111 Note that the boot partitions are not supposed to be the exclusive territory of
112 this specification. This specification only defines semantics of the `/loader/`
113 directory inside the file system (see below), but it doesn't intend to define
114 ownership of the whole file system. Boot loaders, firmware, and other software
115 implementing this specification may choose to place other files and directories
116 in the same file system. For example, boot loaders that implement this
117 specification might install their own boot code on the same partition; this is
118 particularly common in the case of the ESP. Implementations of this specification
119 must be able to operate correctly if files or directories other than `/loader/`
120 are found in the top level directory. Implementations that add their own files
121 or directories to the file systems should use well-named directories, to make
122 name collisions between multiple users of the file system unlikely.
123
124 ### Type #1 Boot Loader Specification Entries
125
126 `$ESP/loader/` is the main directory containing the configuration for the boot
127 loader.
128
129 **Note:** _In all cases the `/loader/` directory should be located directly in
130 the root of the file system. Specifically, the `/loader/` directory should
131 **not** be located under the `/EFI/` subdirectory on the ESP._
132
133 `$BOOT/loader/entries/` and `$XBOOTLDR/loader/entries/` are the directories
134 containing the drop-in snippets defining boot entries, one `.conf` file for
135 each boot menu item. Each OS may provide one or more such entries. The boot
136 loader should enumerate both directories and provide a merged list.
137
138 The file name is used for identification of the boot item but shall never be
139 presented to the user in the UI. The file name may be chosen freely but should
140 be unique enough to avoid clashes between OS installations. More specifically,
141 it is suggested to include the `entry-token` (see
142 [kernel-install](https://www.freedesktop.org/software/systemd/man/kernel-install.html))
143 or machine ID (see
144 [/etc/machine-id](https://www.freedesktop.org/software/systemd/man/machine-id.html)),
145 and the kernel version (as returned by `uname -r`, including the OS
146 identifier), so that the whole filename is
147 `$BOOT/loader/entries/<entry-token-or-machine-id>-<version>.conf`.
148
149 Example: `$BOOT/loader/entries/6a9857a393724b7a981ebb5b8495b9ea-3.8.0-2.fc19.x86_64.conf`.
150
151 In order to maximize compatibility with file system implementations and
152 restricted boot loader environments, and to minimize conflicting character use
153 with other programs, file names shall be chosen from a restricted character
154 set: ASCII upper and lower case characters, digits, "+", "-", "_" and ".".
155 Also, the file names should have a length of at least one and at most 255
156 characters (including the file name suffix).
157
158 These configuration snippets shall be UNIX-style text files (i.e. lines
159 separated by a single newline character), in the UTF-8 encoding. The
160 configuration snippets are loosely inspired by Grub1's configuration syntax.
161 Lines beginning with "#" are used for comments and shall be ignored. The first
162 word of a line is used as key and is separated by one or more spaces from the
163 value.
164
165 #### Type #1 Boot Loader Entry Keys
166
167 The following keys are recognized:
168
169 * `title` is a human-readable title for this menu item to be displayed in the
170 boot menu. It is a good idea to initialize this from the `PRETTY_NAME=` of
171 [os-release](https://www.freedesktop.org/software/systemd/man/os-release.html).
172 This name should be descriptive and does not have to be unique. If a boot
173 loader discovers two entries with the same title it should show more than
174 just the raw title in the UI, for example by appending the `version`
175 field. This field is optional.
176
177 Example: `title Fedora 18 (Spherical Cow)`
178
179 * `version` is a human-readable version for this menu item. This is usually the
180 kernel version and is intended for use by OSes to install multiple kernel
181 versions with the same `title` field. This field is used for sorting entries,
182 so that the boot loader can order entries by age or select the newest one
183 automatically. This field is optional.
184
185 See [Sorting](#sorting) below.
186
187 Example: `version 3.7.2-201.fc18.x86_64`
188
189 * `machine-id` is the machine ID of the OS. This can be used by boot loaders
190 and applications to filter out boot entries, for example to show only a
191 single newest kernel per OS, to group items by OS, or to filter out the
192 currently booted OS when showing only other installed operating systems.
193 This ID shall be formatted as 32 lower case hexadecimal characters
194 (i.e. without any UUID formatting). This key is optional.
195
196 Example: `machine-id 4098b3f648d74c13b1f04ccfba7798e8`
197
198 * `sort-key` is a short string used for sorting entries on display. This should
199 typically be initialized from the `IMAGE_ID=` or `ID=` fields of
200 [os-release](https://www.freedesktop.org/software/systemd/man/os-release.html),
201 possibly with an additional suffix. This field is optional.
202
203 Example: `sort-key fedora`
204
205 * `linux` is the Linux kernel to spawn and as a path relative to file system
206 root. It is recommended that every distribution creates a machine id and
207 version specific subdirectory and places its kernels and initial RAM disk
208 images there.
209
210 Example: `linux /6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/linux`
211
212 * `initrd` is the initrd to use when executing the kernel. This key is
213 optional. This key may appear more than once in which case all specified
214 images are used, in the order they are listed.
215
216 Example: `initrd 6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/initrd`
217
218 * `efi` refers to an arbitrary EFI program. If this key is set, and the system
219 is not an EFI system, this entry should be hidden.
220
221 * `options` shall contain kernel parameters to pass to the Linux kernel to
222 spawn. This key is optional and may appear more than once in which case all
223 specified parameters are used in the order they are listed.
224
225 Example: `options root=UUID=6d3376e4-fc93-4509-95ec-a21d68011da2 quiet`
226
227 * `devicetree` refers to the binary device tree to use when executing the
228 kernel. This key is optional.
229
230 Example: `devicetree 6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.armv7hl/tegra20-paz00.dtb`
231
232 * `devicetree-overlay` refers to a list of device tree overlays that should be
233 applied by the boot loader. Multiple overlays are separated by spaces and
234 applied in the same order as they are listed. This key is optional but
235 depends on the `devicetree` key.
236
237 Example: `devicetree-overlay /6a9857a393724b7a981ebb5b8495b9ea/overlays/overlay_A.dtbo /6a9857a393724b7a981ebb5b8495b9ea/overlays/overlay_B.dtbo`
238
239 * `architecture` refers to the architecture this entry is for. The argument
240 should be an architecture identifier, using the architecture vocabulary
241 defined by the EFI specification (i.e. `IA32`, `x64`, `IA64`, `ARM`, `AA64`,
242 …). If specified and it does not match the local system architecture this
243 entry should be hidden. The comparison should be done case-insensitively.
244
245 Example: `architecture aa64`
246
247 Each configuration drop-in snippet must include at least a `linux` or an `efi`
248 key. Here is an example for a complete drop-in file:
249
250 # /boot/loader/entries/6a9857a393724b7a981ebb5b8495b9ea-3.8.0-2.fc19.x86_64.conf
251 title Fedora 19 (Rawhide)
252 sort-key fedora
253 machine-id 6a9857a393724b7a981ebb5b8495b9ea
254 version 3.8.0-2.fc19.x86_64
255 options root=UUID=6d3376e4-fc93-4509-95ec-a21d68011da2 quiet
256 architecture x64
257 linux /6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/linux
258 initrd /6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/initrd
259
260 On EFI systems all Linux kernel images should be EFI images. In order to
261 increase compatibility with EFI systems it is highly recommended only to
262 install EFI kernel images, even on non-EFI systems, if that's applicable and
263 supported on the specific architecture.
264
265 Conversely, in order to increase compatibility it is recommended to install
266 generic kernel images that make few assumptions about the firmware they run on,
267 i.e. it is a good idea that both images shipped as UEFI PE images and those
268 which are not don't make unnecessary assumption on the underlying firmware,
269 i.e. don't hard depend on legacy BIOS calls or UEFI boot services.
270
271 When Type #1 configuration snippets refer to other files (for `linux`,
272 `initrd`, `efi`, `devicetree`, and `devicetree-overlay`), those files must be
273 located on the same partition, and the paths must be absolute paths relative to
274 the root of that file system. The naming of those files can be chosen by the
275 installer. A recommended scheme is described in the next section.
276
277 ### Recommended Directory Layout for Additional Files
278
279 It is recommended to place the kernel and other other files comprising a single
280 boot loader entry in a separate directory:
281 `/<entry-token-or-machine-id>/<version>/`. This naming scheme uses the same
282 elements as the boot loader configuration snippet, providing the same level of
283 uniqueness.
284
285 Example: `$BOOT/6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/linux`
286 `$BOOT/6a9857a393724b7a981ebb5b8495b9ea/3.8.0-2.fc19.x86_64/initrd`
287
288 Other naming schemes are possible. In particular, traditionally a flat naming
289 scheme with files in the root directory was used. This is not recommended
290 because it is hard to avoid conflicts in a multi-boot installation.
291
292 ### Standard-conformance Marker File
293
294 Unfortunately, there are implementations of boot loading infrastructure that
295 are also using the `/loader/entries/` directory, but installing files that do
296 not follow this specification. In order to minimize confusion, a boot loader
297 implementation may place the file `/loader/entries.srel` next to the
298 `/loader/entries/` directory containing the ASCII string `type1` (followed by a
299 UNIX newline). Tools that need to determine whether an existing directory
300 implements the semantics described here may check for this file and contents:
301 if it exists and contains the mentioned string, it shall assume a
302 standards-compliant implementation is in place. If it exists but contains a
303 different string it shall assume other semantics are implemented. If the file
304 does not exist, no assumptions should be made.
305
306 ### Type #2 EFI Unified Kernel Images
307
308 A unified kernel image is a single EFI PE executable combining an EFI stub
309 loader, a kernel image, an initramfs image, and the kernel command line. See
310 the description of the `--uefi` option in
311 [dracut(8)](http://man7.org/linux/man-pages/man8/dracut.8.html). Such unified
312 images are installed in the`$BOOT/EFI/Linux/` and `$XBOOTLDR/EFI/Linux/`
313 directories and must have the extension `.efi`.
314 Support for images of this type is of course specific to systems with EFI
315 firmware. Ignore this section if you work on systems not supporting EFI.
316
317 Type #2 file names should be chosen from the same restricted character set as
318 Type #1 described above (but with the file name suffix of `.efi` instead of
319 `.conf`).
320
321 Images of this type have the advantage that all metadata and payload that makes
322 up the boot entry is contained in a single PE file that can be signed
323 cryptographically as one for the purpose of EFI SecureBoot.
324
325 A valid unified kernel image must contain two PE sections:
326
327 * `.cmdline` section with the kernel command line,
328 * `.osrel` section with an embedded copy of the
329 [os-release](https://www.freedesktop.org/software/systemd/man/os-release.html)
330 file describing the image.
331
332 The `PRETTY_NAME=` and `VERSION_ID=` fields in the embedded `os-release` file
333 are used the same as `title` and `version` in the Type #1 entries. The
334 `.cmdline` section is used instead of the `options` field. `linux` and `initrd`
335 fields are not necessary, and there is no counterpart for the `machine-id`
336 field.
337
338 On EFI, any such images shall be added to the list of valid boot entries.
339
340 ### Additional notes
341
342 Note that these configurations snippets do not need to be the only
343 configuration source for a boot loader. It may extend this list of entries with
344 additional items from other configuration files (for example its own native
345 configuration files) or automatically detected other entries without explicit
346 configuration.
347
348 To make this explicitly clear: this specification is designed with "free"
349 operating systems in mind, starting Windows or macOS is out of focus with these
350 configuration snippets, use boot-loader specific solutions for that. In the
351 text above, if we say "OS" we hence imply "free", i.e. primarily Linux (though
352 this could be easily be extended to the BSDs and whatnot).
353
354 Note that all paths used in the configuration snippets use a Unix-style "/" as
355 path separator. This needs to be converted to an EFI-style "\\" separator in
356 EFI boot loaders.
357
358
359 ## Locating boot entries
360
361 A _boot loader_ locates `$BOOT` and `$XBOOTLDR`, then simply reads all the
362 files `$BOOT/loader/entries/*.conf` and `$XBOOTLDR/loader/entries/*.conf`, and
363 populates its boot menu. On EFI, it then extends this with any unified kernel
364 images found in `$BOOT/EFI/Linux/*.efi` and `$XBOOTLDR/EFI/Linux/*.efi`. It may
365 also add additional entries, for example a "Reboot into firmware" option.
366 Optionally it may sort the menu based on the `sort-key`, `machine-id` and
367 `version` fields, and possibly others. It uses the file name to identify
368 specific items, for example in case it supports storing away default entry
369 information somewhere. A boot loader should generally not modify these files.
370
371 For "Boot Loader Specification Entries" (Type #1), the _kernel package
372 installer_ installs the kernel and initrd images to `$XBOOTLDR` (if used) or
373 `$BOOT`. It is recommended to place these files in a vendor and OS and
374 installation specific directory. It then generates a configuration snippet,
375 placing it in `$BOOT/loader/entries/xyz.conf`, with "xyz" as concatenation of
376 machine id and version information (see above). The files created by a kernel
377 package are tied to the kernel package and should be removed along with it.
378
379 For "EFI Unified Kernel Images" (Type #2), the vendor or kernel package
380 installer should create the combined image and drop it into
381 `$BOOT/EFI/Linux/`. This file is also tied to the kernel package and should be
382 removed along with it.
383
384 A _UI application_ intended to show available boot options shall operate
385 similarly to a boot loader, but might apply additional filters, for example by
386 filtering the booted OS via the machine ID, or by suppressing all but the
387 newest kernel versions.
388
389 An _OS installer_ picks the right place for `$BOOT` as defined above (possibly
390 creating a partition and file system for it) and creates the `/loader/entries/`
391 directory in it. It then installs an appropriate boot loader that can read
392 these snippets. Finally, it installs one or more kernel packages.
393
394 ## Sorting
395
396 The boot loader menu should generally show entries in some order meaningful to
397 the user. The `title` key is free-form and not suitable to be used as the
398 primary sorting key. Instead, the boot loader should use the following rules:
399 if `sort-key` is set on both entries, use in order of priority,
400 the `sort-key` (A-Z, increasing [alphanumerical order](#alphanumerical-order)),
401 `machine-id` (A-Z, increasing alphanumerical order),
402 and `version` keys (decreasing [version order](#version-order)).
403 If `sort-key` is set on one entry, it sorts earlier.
404 At the end, if necessary, when `sort-key` is not set or those fields are not
405 set or are all equal, the boot loader should sort using the file name of the
406 entry (decreasing version sort), with the suffix removed.
407
408 **Note:** _This description assumes that the boot loader shows entries in a
409 traditional menu, with newest and "best" entries at the top, thus entries with
410 a higher version number are sorter *earlier*. The boot loader is free to
411 use a different direction (or none at all) during display._
412
413 ### Alphanumerical order
414
415 Free-form strings and machine IDs should be compared using a method equivalent
416 to [strcmp(3)](https://man7.org/linux/man-pages/man3/strcmp.3.html) on their
417 UTF-8 representations. If just one of the strings is unspecified or empty, it
418 compares lower. If both strings are unspecified or empty, they compare equal.
419
420 ### Version order
421
422 The following method should be used to compare version strings. The algorithm
423 is based on rpm's `rpmvercmp()`, but not identical.
424
425 ASCII letters (`a-z`, `A-Z`) and digits (`0-9`) form alphanumerical components of the version.
426 Minus (`-`) separates the version and release parts.
427 Dot (`.`) separates parts of version or release.
428 Tilde (`~`) is a prefix that always compares lower.
429 Caret (`^`) is a prefix that always compares higher.
430
431 Both strings are compared from the beginning until the end, or until the
432 strings are found to compare as different. In a loop:
433 1. Any characters which are outside of the set of listed above (`a-z`, `A-Z`, `0-9`, `-`, `.`, `~`, `^`)
434 are skipped in both strings. In particular, this means that non-ASCII characters
435 that are Unicode digits or letters are skipped too.
436 2. If one of the strings has ended: if the other string hasn't, the string that
437 has remaining characters compares higher. Otherwise, the strings compare
438 equal.
439 3. If the remaining part of one of strings starts with `~`:
440 if other remaining part does not start with `~`,
441 the string with `~` compares lower. Otherwise, both tilde characters are skipped.
442 4. The check from point 2. is repeated here.
443 5. If the remaining part of one of strings starts with `-`:
444 if the other remaining part does not start with `-`,
445 the string with `-` compares lower. Otherwise, both minus characters are skipped.
446 6. If the remaining part of one of strings starts with `^`:
447 if the other remaining part does not start with `^`,
448 the string with `^` compares higher. Otherwise, both caret characters are skipped.
449 6. If the remaining part of one of strings starts with `.`:
450 if the other remaining part does not start with `.`,
451 the string with `.` compares lower. Otherwise, both dot characters are skipped.
452 7. If either of the remaining parts starts with a digit, numerical prefixes are
453 compared numerically. Any leading zeroes are skipped.
454 The numerical prefixes (until the first non-digit character) are evaluated as numbers.
455 If one of the prefixes is empty, it evaluates as 0.
456 If the numbers are different, the string with the bigger number compares higher.
457 Otherwise, the comparison continues at the following characters at point 1.
458 8. Leading alphabetical prefixes are compared alphabetically.
459 The substrings are compared letter-by-letter.
460 If both letters are the same, the comparison continues with the next letter.
461 Capital letters compare lower than lower-case letters (`A < a`).
462 When the end of one substring has been reached (a non-letter character or the end
463 of the whole string), if the other substring has remaining letters, it compares higher.
464 Otherwise, the comparison continues at the following characters at point 1.
465
466 Examples (with '' meaning the empty string):
467
468 * `11 == 11`
469 * `systemd-123 == systemd-123`
470 * `bar-123 < foo-123`
471 * `123a > 123`
472 * `123.a > 123`
473 * `123.a < 123.b`
474 * `123a > 123.a`
475 * `11α == 11β`
476 * `A < a`
477 * '' < `0`
478 * `0.` > `0`
479 * `0.0` > `0`
480 * `0` < `~`
481 * '' < `~`
482
483 Note: [systemd-analyze](https://www.freedesktop.org/software/systemd/man/systemd-analyze.html)
484 implements this version comparison algorithm as
485 ```
486 systemd-analyze compare-versions <version-a> <version-b>
487 ```
488
489 ## Additional discussion
490
491 ### Why is there a need for this specification?
492
493 This specification brings the following advantages:
494
495 * Installation of new boot entries is more robust, as no explicit rewriting of
496 configuration files is required.
497
498 * It allows an out-of-the-box boot experience on any platform without the need
499 of traditional firmware mechanisms (e.g. BIOS calls, UEFI Boot Services).
500
501 * It improves dual-boot scenarios. Without cooperation, multiple Linux
502 installations tend to fight over which boot loader becomes the primary one in
503 possession of the MBR or the boot partition, and only that one installation
504 can then update the boot loader configuration. Other Linux installs have to
505 be manually configured to never touch the MBR and instead install a
506 chain-loaded boot loader in their own partition headers. In this new scheme
507 all installations share a loader directory and no manual configuration has to
508 take place. All participants implicitly cooperate due to removal of name
509 collisions and can install/remove their own boot menu entries without
510 interfering with the entries of other installed operating systems.
511
512 * Drop-in directories are now pretty ubiquitous on Linux as an easy way to
513 extend configuration without having to edit, regenerate or manipulate
514 configuration files. For the sake of uniformity, we should do the same for
515 the boot menu.
516
517 * Userspace code can sanely parse boot loader configuration which is essential
518 with modern firmware which does not necessarily initialize USB keyboards
519 during boot, which makes boot menus hard to reach for the user. If userspace
520 code can parse the boot loader configuration too, UI can be written that
521 select a boot menu item to boot into before rebooting the machine, thus not
522 requiring interactivity during early boot.
523
524 * To unify and thus simplify configuration of the various boot loaders, which
525 makes configuration of the boot loading process easier for users,
526 administrators, and developers alike.
527
528 * For boot loaders with configuration _scripts_ such as grub2, adopting this
529 spec allows for mostly static scripts that are generated only once at first
530 installation, but then do not need to be updated anymore as that is done via
531 drop-in files exclusively.
532
533 ### Why not simply rely on the EFI boot menu logic?
534
535 EFI is not ubiquitous, especially not in embedded systems. But even on systems
536 with EFI, which provides a boot options logic that can offer similar
537 functionality, this specification is still needed for the following reasons:
538
539 * The various EFI implementations implement the boot order/boot item logic to
540 different levels. Some firmware implementations do not offer a boot menu at
541 all and instead unconditionally follow the EFI boot order, booting the first
542 item that is working.
543
544 * If the firmware setup is used to reset data, usually all EFI boot entries
545 are lost, making the system entirely unbootable, as the firmware setups
546 generally do not offer a UI to define additional boot items. By placing the
547 menu item information on disk, it is always available, even if the firmware
548 configuration is lost.
549
550 * Harddisk images should be movable between machines and be bootable without
551 requiring firmware configuration. This also requires that the list
552 of boot options is defined on disk, and not in EFI variables alone.
553
554 * EFI is not universal yet (especially on non-x86 platforms), this
555 specification is useful both for EFI and non-EFI boot loaders.
556
557 * Many EFI systems disable USB support during early boot to optimize boot
558 times, thus making keyboard input unavailable in the EFI menu. It is thus
559 useful if the OS UI has a standardized way to discover available boot options
560 which can be booted to.
561
562 ### Why is the version comparison logic so complicated?
563
564 The `sort-key` allows us to group entries by "operating system", e.g. all
565 versions of Fedora together, no matter if they identify themselves as "Fedora
566 Workstation" or "Fedora Rawhide (prerelease)". The `sort-key` was introduced
567 only recently, so we need to provide a meaningful order for entries both with
568 and without it. Since it is a new concept, it is assumed that entries with
569 `sort-key` are newer.
570
571 In a traditional menu with entries displayed vertically, we want names to be
572 sorter alpabetically (CentOS, Debian, Fedora, OpenSUSE, …), it would be strange
573 to have them in reverse order. But when multiple kernels are available for the
574 same installation, we want to display the latest kernel with highest priority,
575 i.e. earlier in the list.
576
577 ### Out of Focus
578
579 There are a couple of items that are out of focus for this specification:
580
581 * If userspace can figure out the available boot options, then this is only
582 useful so much: we'd still need to come up with a way how userspace could
583 communicate to the boot loader the default boot loader entry temporarily or
584 persistently. Defining a common scheme for this is certainly a good idea, but
585 out of focus for this specification.
586
587 * This specification is just about "Free" Operating systems. Hooking in other
588 operating systems (like Windows and macOS) into the boot menu is a different
589 story and should probably happen outside of this specification. For example,
590 boot loaders might choose to detect other available OSes dynamically at
591 runtime without explicit configuration (like `systemd-boot` does it), or via
592 native configuration (for example via explicit Grub2 configuration generated
593 once at installation).
594
595 * This specification leaves undefined what to do about systems which are
596 upgraded from an OS that does not implement this specification. As the
597 previous boot loader logic was largely handled by in distribution-specific
598 ways we probably should leave the upgrade path (and whether there actually is
599 one) to the distributions. The simplest solution might be to simply continue
600 with the old scheme for old installations and use this new scheme only for
601 new installations.
602
603 * Referencing kernels or initrds on other partitions other than the partition
604 containing the Type #1 boot loader entry. This is by design, as specifying
605 other partitions or devices would require a non-trivial language for denoting
606 device paths. In particular this means that on non-EFI systems configuration
607 snippets following this specification cannot be used to spawn other operating
608 systems (such as Windows).
609
610
611 ## Links
612
613 [GUID Partition Table](https://en.wikipedia.org/wiki/GUID_Partition_Table)<br>
614 [Boot Loader Interface](BOOT_LOADER_INTERFACE.md)<br>
615 [Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md)<br>
616 [`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)<br>
617 [`bootctl(1)`](https://www.freedesktop.org/software/systemd/man/bootctl.html)<br>
618 [`systemd-gpt-auto-generator(8)`](https://www.freedesktop.org/software/systemd/man/systemd-gpt-auto-generator.html)