2020-08-20 17:41:19 +02:00
<?xml version="1.0"?> <!-- * - nxml - * -->
2019-03-14 14:40:58 +01:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2023-12-25 15:48:33 +01:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
2020-11-09 13:23:58 +09:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2020-08-20 17:41:19 +02:00
2023-08-22 17:52:02 +01:00
<refentry id= "systemd-gpt-auto-generator" conditional= 'HAVE_BLKID'
xmlns:xi="http://www.w3.org/2001/XInclude">
2013-08-13 21:57:43 +02:00
2015-02-03 21:14:13 -05:00
<refentryinfo >
<title > systemd-gpt-auto-generator</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > systemd-gpt-auto-generator</refentrytitle>
<manvolnum > 8</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd-gpt-auto-generator</refname>
2019-12-19 10:08:18 +01:00
<refpurpose > Generator for automatically discovering and mounting root, <filename > /home/</filename> ,
<filename > /srv/</filename> , <filename > /var/</filename> and <filename > /var/tmp/</filename> partitions, as
2020-07-06 10:49:59 +02:00
well as discovering and enabling swap partitions, based on GPT partition type GUIDs</refpurpose>
2015-02-03 21:14:13 -05:00
</refnamediv>
<refsynopsisdiv >
2015-06-18 19:47:44 +02:00
<para > <filename > /usr/lib/systemd/system-generators/systemd-gpt-auto-generator</filename> </para>
2015-02-03 21:14:13 -05:00
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
2019-02-12 16:06:21 +01:00
<para > <filename > systemd-gpt-auto-generator</filename> is a unit generator that automatically discovers
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
the root partition, <filename > /home/</filename> , <filename > /srv/</filename> , <filename > /var/</filename> ,
2024-02-07 13:41:48 +01:00
<filename > /var/tmp/</filename> , the EFI System Partition (ESP), the Extended Boot Loader Partition
(XBOOTLDR), and swap partitions and creates mount and swap units for them, based on the partition type
GUIDs of GUID partition tables (GPT). See <ulink url= "https://uefi.org/specifications" > UEFI
Specification</ulink> , chapter 5 for more details. It implements the <ulink
2025-11-23 18:07:13 +01:00
url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
Partitions Specification</ulink> .</para>
<para > Note that this generator has no effect on non-GPT systems. It will also not create mount point
configuration for directories which already contain files or if the mount point is explicitly configured
in <citerefentry
2024-02-07 13:41:48 +01:00
project='man-pages'><refentrytitle > fstab</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> . Additionally
no unit will be created for the ESP or the XBOOTLDR partition if mount entries are found in the
<filename > /boot/</filename> or <filename > /efi/</filename> hierarchies in <citerefentry
project='man-pages'><refentrytitle > fstab</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
<para > If the units this generator creates are overridden, for example by units in directories with higher
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
precedence, drop-ins and additional dependencies created by this generator might still be used.</para>
2015-02-03 21:14:13 -05:00
2025-02-10 22:24:52 +01:00
<para > When run in the initial RAM disk (initrd) this generator can automatically search for the root file
system. Specifically:
<itemizedlist >
<listitem > <para > It will look for the root partition on the same physical disk where the EFI System
Partition (ESP) is located. Note that support from the boot loader is required for this to work: the
EFI variable <varname > LoaderDevicePartUUID</varname> of the
<constant > 4a67b082-0a4c-41cf-b6c7-440b29bb8c4f</constant> vendor UUID is used to determine from which
partition (and hence disk) the system was booted. If the boot loader does not set this variable, this
generator will not be able to detect the root partition. See the <ulink
url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink> for
details.</para> </listitem>
<listitem > <para > Alternatively, it will look for the root file system on a loopback block device whose
<literal > .lo_name</literal> field is set to one of the literal strings <literal > rootdisk</literal> or
<literal > rootdisk.raw</literal> . This field can be set via <command > losetup</command> 's
<option > --loop-ref=</option> string. For images downloaded via
<citerefentry > <refentrytitle > systemd-import-generator</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
make sure to set the <literal > blockdev</literal> option and set the local name string to
<literal > rootdisk</literal> to achieve this effect. Note that discovery of the root file system on
2025-03-20 22:51:04 +01:00
loopback block devices like this is only done if <literal > root=gpt-auto</literal> or
<literal > root=dissect</literal> is specified explicitly on the kernel command line, unlike the
discovery based on the boot loader reported ESP which is also enabled if no <literal > root=</literal>
parameter is specified at all. (The latter relies on <command > systemd-udevd.service</command> 's
<filename > /dev/gpt-auto-root</filename> block device symlink generation).</para> </listitem>
2025-02-10 22:24:52 +01:00
</itemizedlist>
2018-03-23 12:59:09 +01:00
</para>
2015-02-03 21:14:13 -05:00
2025-02-10 22:24:52 +01:00
<para > When run on the host system (i.e. after successfully transitioning out of the initrd into the root
filesystem) this generator will look for all other partitions on the same physical disk as the root
partition. For this discovery, boot loader support is not required. Moreover, it is not required that the
root partition was automatically discovered by the initrd (as described above) for the discovery of the
non-root file partitions to take place. Or in other words: automatic discovery of the root file system
and of the non-root file systems are independent operations, that do not rely on each other, and are done
during two distinct phases of the boot process (one in the initrd, the other after). These partitions will
not be searched for on systems where the root file system is distributed on multiple disks, for example
via btrfs RAID.</para>
<para > The root partition can be configured explicitly by symlinking
<filename > /run/systemd/volatile-root</filename> to <filename > /dev/block/$major:$minor</filename> . This is
especially useful if the root mount has been replaced by some form of volatile file system
(overlayfs).</para>
2019-11-28 18:21:22 +01:00
<para > <filename > systemd-gpt-auto-generator</filename> is useful for centralizing file system
configuration in the partition table and making configuration in <filename > /etc/fstab</filename> or on
the kernel command line unnecessary.</para>
2015-02-03 21:14:13 -05:00
<para > This generator looks for the partitions based on their
partition type GUID. The following partition type GUIDs are
identified:</para>
<table >
<title > Partition Type GUIDs</title>
2024-04-19 18:36:16 +02:00
<tgroup cols= '5' align= 'left' colsep= '1' rowsep= '1' >
<colspec colname= "type" />
2015-02-03 21:14:13 -05:00
<colspec colname= "guid" />
<colspec colname= "name" />
2019-02-12 16:06:21 +01:00
<colspec colname= "where" />
2015-02-03 21:14:13 -05:00
<colspec colname= "explanation" />
<thead >
<row >
2024-04-19 18:36:16 +02:00
<entry > Partition Type</entry>
<entry > GUID</entry>
2015-02-03 21:14:13 -05:00
<entry > Name</entry>
2019-02-12 16:06:21 +01:00
<entry > Mount Point</entry>
2015-02-03 21:14:13 -05:00
<entry > Explanation</entry>
</row>
</thead>
<tbody >
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_ROOT_X86_64</constant> </entry>
<entry > <constant > 4f68bce3-e8cd-4db1-96e7-fbcaf984b709</constant> </entry>
2015-02-03 21:14:13 -05:00
<entry > <filename > Root Partition (x86-64)</filename> </entry>
2019-02-12 16:06:21 +01:00
<entry > <filename > /</filename> </entry>
2024-04-19 18:36:33 +02:00
<entry > The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename > /</filename> on AMD64 / 64-bit x86 systems.</entry>
2015-02-03 21:14:13 -05:00
</row>
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_ROOT_ARM64</constant> </entry>
<entry > <constant > b921b045-1df0-41c3-af44-4c6f280d3fae</constant> </entry>
2015-02-03 21:14:13 -05:00
<entry > <filename > Root Partition (64-bit ARM)</filename> </entry>
2019-02-12 16:06:21 +01:00
<entry > <filename > /</filename> </entry>
2024-04-19 18:36:33 +02:00
<entry > The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename > /</filename> on AArch64 / 64-bit ARM systems.</entry>
2015-02-03 21:14:13 -05:00
</row>
2016-11-12 04:25:32 +01:00
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_ROOT_ALPHA</constant> <constant > SD_GPT_ROOT_ARC</constant> <constant > SD_GPT_ROOT_ARM</constant> <constant > SD_GPT_ROOT_ARM64</constant> <constant > SD_GPT_ROOT_IA64</constant> <constant > SD_GPT_ROOT_LOONGARCH64</constant> <constant > SD_GPT_ROOT_MIPS</constant> <constant > SD_GPT_ROOT_MIPS64</constant> <constant > SD_GPT_ROOT_MIPS_LE</constant> <constant > SD_GPT_ROOT_MIPS64_LE</constant> <constant > SD_GPT_ROOT_PARISC</constant> <constant > SD_GPT_ROOT_PPC</constant> <constant > SD_GPT_ROOT_PPC64</constant> <constant > SD_GPT_ROOT_PPC64_LE</constant> <constant > SD_GPT_ROOT_RISCV32</constant> <constant > SD_GPT_ROOT_RISCV64</constant> <constant > SD_GPT_ROOT_S390</constant> <constant > SD_GPT_ROOT_S390X</constant> <constant > SD_GPT_ROOT_TILEGX</constant> <constant > SD_GPT_ROOT_X86</constant> <constant > SD_GPT_ROOT_X86_64</constant> <constant > SD_GPT_USR_ALPHA</constant> <constant > SD_GPT_USR_ARC</constant> <constant > SD_GPT_USR_ARM</constant> <constant > SD_GPT_USR_IA64</constant> <constant > SD_GPT_USR_LOONGARCH64</constant> <constant > SD_GPT_USR_MIPS_LE</constant> <constant > SD_GPT_USR_MIPS64_LE</constant> <constant > SD_GPT_USR_PARISC</constant> <constant > SD_GPT_USR_PPC</constant> <constant > SD_GPT_USR_PPC64</constant> <constant > SD_GPT_USR_PPC64_LE</constant> <constant > SD_GPT_USR_RISCV32</constant> <constant > SD_GPT_USR_RISCV64</constant> <constant > SD_GPT_USR_S390</constant> <constant > SD_GPT_USR_S390X</constant> <constant > SD_GPT_USR_TILEGX</constant> <constant > SD_GPT_USR_X86</constant> </entry>
<entry > …</entry>
<entry > Root partitions for other architectures</entry>
2021-06-16 16:44:38 +08:00
<entry > <filename > /</filename> </entry>
2025-11-23 18:07:13 +01:00
<entry > The first partition with the type UUID matching the architecture, located on the same disk as the ESP used for booting, is used as the root file system <filename > /</filename> . For the full list and constant values, see <ulink url= "https://uapi-group.org/specifications/specs/discoverable_partitions_specification" > UAPI.2 Discoverable Partitions Specification</ulink> .</entry>
2021-06-16 16:44:38 +08:00
</row>
2020-11-23 14:31:07 +00:00
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_HOME</constant> </entry>
<entry > <constant > 933ac7e1-2eb4-4f13-b844-0e14e2aef915</constant> </entry>
2015-02-03 21:14:13 -05:00
<entry > Home Partition</entry>
2019-02-12 16:06:21 +01:00
<entry > <filename > /home/</filename> </entry>
2024-04-19 18:36:33 +02:00
<entry > The first partition with this type UUID on the same disk as the root partition is mounted to <filename > /home/</filename> .</entry>
2015-02-03 21:14:13 -05:00
</row>
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_SRV</constant> </entry>
<entry > <constant > 3b8f8425-20e0-4f3b-907f-1a25a76f98e8</constant> </entry>
2015-02-03 21:14:13 -05:00
<entry > Server Data Partition</entry>
2019-02-12 16:06:21 +01:00
<entry > <filename > /srv/</filename> </entry>
2024-04-19 18:36:33 +02:00
<entry > The first partition with this type UUID on the same disk as the root partition is mounted to <filename > /srv/</filename> .</entry>
2019-12-19 10:08:18 +01:00
</row>
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_VAR</constant> </entry>
<entry > <constant > 4d21b016-b534-45c2-a9fb-5c16e091fd2d</constant> </entry>
2019-12-19 10:08:18 +01:00
<entry > Variable Data Partition</entry>
<entry > <filename > /var/</filename> </entry>
2025-05-28 15:20:50 +02:00
<entry > The first partition with this type UUID on the same disk as the root partition is mounted to <filename > /var/</filename> — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in <citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> . This can be generated using <citerefentry > <refentrytitle > systemd-id128</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> .</entry>
2019-12-19 10:08:18 +01:00
</row>
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_TMP</constant> </entry>
<entry > <constant > 7ec6f557-3bc5-4aca-b293-16ef5df639d1</constant> </entry>
2019-12-19 10:08:18 +01:00
<entry > Temporary Data Partition</entry>
<entry > <filename > /var/tmp/</filename> </entry>
2024-04-19 18:36:33 +02:00
<entry > The first partition with this type UUID on the same disk as the root partition is mounted to <filename > /var/tmp/</filename> .</entry>
2015-02-03 21:14:13 -05:00
</row>
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_SWAP</constant> </entry>
<entry > <constant > 0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</constant> </entry>
2015-02-03 21:14:13 -05:00
<entry > Swap</entry>
2019-02-12 16:06:21 +01:00
<entry > n/a</entry>
2024-04-19 18:36:33 +02:00
<entry > All partitions with this type UUID on the same disk as the root partition are used as swap.</entry>
2015-02-03 21:14:13 -05:00
</row>
2016-07-19 18:19:29 +02:00
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_ESP</constant> </entry>
<entry > <constant > c12a7328-f81f-11d2-ba4b-00a0c93ec93b</constant> </entry>
2016-07-19 18:19:29 +02:00
<entry > EFI System Partition (ESP)</entry>
2019-02-12 16:06:21 +01:00
<entry > <filename > /efi/</filename> or <filename > /boot/</filename> </entry>
2022-09-17 12:19:31 +02:00
<entry > The first partition with this type UUID located on the same disk as the root partition is mounted to <filename > /boot/</filename> or <filename > /efi/</filename> , see below.</entry>
2016-07-19 18:19:29 +02:00
</row>
2019-02-12 16:06:21 +01:00
<row >
2024-04-19 18:36:16 +02:00
<entry > <constant > SD_GPT_XBOOTLDR</constant> </entry>
<entry > <constant > bc13c2ff-59e6-4262-a352-b275fd6f7172</constant> </entry>
2019-02-12 16:06:21 +01:00
<entry > Extended Boot Loader Partition</entry>
<entry > <filename > /boot/</filename> </entry>
2022-09-17 12:19:31 +02:00
<entry > The first partition with this type UUID located on the same disk as the root partition is mounted to <filename > /boot/</filename> , see below.</entry>
2019-02-12 16:06:21 +01:00
</row>
2015-02-03 21:14:13 -05:00
</tbody>
</tgroup>
</table>
2018-03-23 12:59:09 +01:00
<para > This generator understands the following attribute flags for partitions:</para>
<table >
2022-09-17 12:02:53 +02:00
<title > Partition Attribute Flags</title>
2024-04-19 18:34:43 +02:00
<tgroup cols= '4' align= 'left' colsep= '1' rowsep= '1' >
2022-09-17 12:02:53 +02:00
<colspec colname= "flag" />
2024-04-19 18:34:43 +02:00
<colspec colname= "value" />
2018-03-23 12:59:09 +01:00
<colspec colname= "where" />
<colspec colname= "explanation" />
<thead >
<row >
2022-09-17 12:02:53 +02:00
<entry > Flag</entry>
2024-04-19 18:34:43 +02:00
<entry > Value</entry>
2018-03-23 12:59:09 +01:00
<entry > Applicable to</entry>
<entry > Explanation</entry>
</row>
</thead>
<tbody >
<row >
2024-04-19 18:34:43 +02:00
<entry > <constant > SD_GPT_FLAG_READ_ONLY</constant> </entry>
<entry > <constant > 0x1000000000000000</constant> </entry>
2019-12-19 10:08:18 +01:00
<entry > <filename > /</filename> , <filename > /home/</filename> , <filename > /srv/</filename> , <filename > /var/</filename> , <filename > /var/tmp/</filename> , Extended Boot Loader Partition</entry>
2018-03-23 12:59:09 +01:00
<entry > Partition is mounted read-only</entry>
</row>
<row >
2024-04-19 18:34:43 +02:00
<entry > <constant > SD_GPT_FLAG_NO_AUTO</constant> </entry>
<entry > <constant > 0x8000000000000000</constant> </entry>
2019-12-19 10:08:18 +01:00
<entry > <filename > /</filename> , <filename > /home/</filename> , <filename > /srv/</filename> , <filename > /var/</filename> , <filename > /var/tmp/</filename> , Extended Boot Loader Partition</entry>
2018-03-23 12:59:09 +01:00
<entry > Partition is not mounted automatically</entry>
</row>
<row >
2024-04-19 18:34:43 +02:00
<entry > <constant > SD_GPT_FLAG_NO_BLOCK_IO_PROTOCOL</constant> </entry>
<entry > <constant > 0x0000000000000002</constant> </entry>
2019-02-12 16:06:21 +01:00
<entry > EFI System Partition (ESP)</entry>
2018-03-23 12:59:09 +01:00
<entry > Partition is not mounted automatically</entry>
</row>
</tbody>
</tgroup>
</table>
2023-05-30 11:28:48 +02:00
<para > The <filename > /home/</filename> , <filename > /srv/</filename> , <filename > /var/</filename> ,
<filename > /var/tmp/</filename> and swap partitions may be encrypted in LUKS format. In this case, a
device mapper device is set up under the names <filename > /dev/mapper/home</filename> ,
<filename > /dev/mapper/srv</filename> , <filename > /dev/mapper/var</filename> ,
<filename > /dev/mapper/tmp</filename> or <filename > /dev/mapper/swap</filename> . Note that this might
create conflicts if the same partition is listed in <filename > /etc/crypttab</filename> with a different
device mapper device name.</para>
<para > When systemd is running in the initrd the <filename > /</filename> partition may be encrypted with
LUKS as well. In this case, a device mapper device is set up under the name
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
<filename > /dev/mapper/root</filename> , and a <filename > sysroot.mount</filename> is set up that mounts the
device under <filename > /sysroot</filename> . For more information, see
<citerefentry > <refentrytitle > bootup</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> .
2019-06-12 19:18:04 +02:00
</para>
2019-02-12 16:06:21 +01:00
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
<para > Mount and automount units for the EFI System Partition (ESP) and Extended Boot Loader Partition
(XBOOTLDR) are generated on EFI systems. If the disk contains an XBOOTLDR partition, as defined in the
2025-11-23 18:07:13 +01:00
<ulink url= "https://uapi-group.org/specifications/specs/boot_loader_specification" > UAPI.1 Boot Loader
gpt-auto-generator: rework/simplify logic for picking /efi or /boot
I started looking into https://github.com/uapi-group/specifications/issues/35.
BLS says:
> Otherwise [no existing XBOOTLDR partition], if on GPT and an ESP is found and
> it is large enough (let’s say at least 1G) it should be used as $BOOT and
> used as primary location to place boot loader menu resources in.
> It is recommended to mount $BOOT to /boot/, and the ESP to /efi/.
DPS says:
> The ESP used for the current boot is automatically mounted to /efi/ (or
> /boot/ as fallback), unless a different partition is mounted there (possibly
> via /etc/fstab, or because the Extended Boot Loader Partition — see below —
> exists) or the directory is non-empty on the root disk.
I don't think we want to mount the same partition in two places.
If the same partition is not mounted in two places, then the two specs are
contradictory.
The code in gpt-auto-generator implemented the logic from the DPS. It is
modified to implement the logic from BLS.
Effectively:
- if both /boot and /efi are available:
- if both XBOOTLDR and ESP exist:
ESP on /efi, XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only XBOOTLDR exists:
XBOOTLDR on /boot
- if only /boot is available:
- if XBOOTLDR exists:
XBOOTLDR on /boot
- if only ESP exists:
ESP on /boot
- if only /efi is available:
- if ESP exists:
ESP on /efi
"Available" means that it the mount point is not mounted over and does not
contain files. If the directory doesn't exist, it is also "available" and will
be created later when the mount or automount unit is started.
Thus, the generator attempts to match the partitions and mount points to the
extent possible. In all cases, /boot is the primary place to install kernels.
ESP can be found on /boot or /efi, depending on the situation.
If this patch is merged, I'll submit fixes for BLS and DPS to describe the
same logic.
2023-04-05 17:10:16 +02:00
Specification</ulink> , it is made available at <filename > /boot/</filename> . This generator creates an
automount unit; the mount will only be activated on-demand when accessed. The mount point will be created
if necessary.</para>
<para > The ESP is mounted to <filename > /boot/</filename> if that directory exists and is not used for
XBOOTLDR, and otherwise to <filename > /efi/</filename> . Same as for <filename > /boot/</filename> , an
automount unit is used. The mount point will be created if necessary.</para>
<para > No configuration is created for mount points that are configured in <citerefentry
project='man-pages'><refentrytitle > fstab</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> or when
the target directory contains files.</para>
2015-02-03 21:14:13 -05:00
<para > When using this generator in conjunction with btrfs file
systems, make sure to set the correct default subvolumes on them,
using <command > btrfs subvolume set-default</command> .</para>
2022-10-14 15:54:09 +02:00
<para > If the system was booted via
<citerefentry > <refentrytitle > systemd-stub</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> and the
stub reported to userspace that the kernel image was measured to a TPM2 PCR, then any discovered root and
<filename > /var/</filename> volume identifiers (and volume encryption key in case it is encrypted) will be
automatically measured into PCR 15 on activation, via
<citerefentry > <refentrytitle > systemd-pcrfs@.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
2025-03-12 09:49:52 +01:00
<para > Mount constraint metadata contained in the file systems is validated by pulling in
<citerefentry > <refentrytitle > systemd-validatefs@.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
for generated mounts.</para>
2015-02-03 21:14:13 -05:00
<para > <filename > systemd-gpt-auto-generator</filename> implements
2015-03-04 18:43:20 -05:00
<citerefentry > <refentrytitle > systemd.generator</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> .</para>
2015-02-03 21:14:13 -05:00
</refsect1>
2018-12-20 16:09:48 +01:00
<refsect1 >
<title > Kernel Command Line</title>
<para > <filename > systemd-gpt-auto-generator</filename> understands the following kernel command line
parameters:</para>
<variablelist class= 'kernel-commandline-options' >
<varlistentry >
<term > <varname > systemd.gpt_auto</varname> </term>
<term > <varname > rd.systemd.gpt_auto</varname> </term>
<listitem > <para > Those options take an optional boolean argument, and default to yes.
2023-08-27 17:10:38 +03:00
The generator is enabled by default, and a false value may be used to disable it
(e.g. <literal > systemd.gpt_auto=0</literal> ).
2023-08-22 17:52:36 +01:00
</para>
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2018-12-20 16:09:48 +01:00
</varlistentry>
2022-12-01 22:41:47 +01:00
<varlistentry >
<term > <varname > systemd.image_policy=</varname> </term>
<listitem > <para > Takes an image dissection policy string as argument (as per
<citerefentry > <refentrytitle > systemd.image-policy</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> ),
and allows enforcing a policy on dissection and use of the automatically discovered GPT partition
2023-08-22 17:52:36 +01:00
table entries.</para>
2025-03-20 22:51:04 +01:00
<para > Note that the specified image policy is not taken into account for automatic root or
<filename > /usr/</filename> file system discovery unless
<varname > root=dissect</varname> /<varname > mount.usr=dissect</varname> (or
<varname > root=dissect-force</varname> ) are specified. (The policy will always be applied to the other
auto-discoverable partition types.)</para>
2023-08-22 17:52:36 +01:00
<xi:include href= "version-info.xml" xpointer= "v254" /> </listitem>
2022-12-01 22:41:47 +01:00
</varlistentry>
2025-03-20 17:15:41 +01:00
<varlistentry >
<term > <varname > systemd.image_filter=</varname> </term>
<listitem > <para > Takes an image dissection filter string as argument (as per
<citerefentry > <refentrytitle > systemd.image-filter</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> ),
and allows enforcing a set of globbing patterns on the partition matching of the automatically
discovered GPT partition table entries.</para>
2025-03-20 22:51:04 +01:00
<para > Note that the specified image filter is not taken into account for automatic root or
<filename > /usr/</filename> file system discovery unless
<varname > root=dissect</varname> /<varname > mount.usr=dissect</varname> (or
<varname > root=dissect-force</varname> ) are specified. (The filter will always be applied to the other
auto-discoverable partition types.)</para>
2025-03-20 17:15:41 +01:00
<xi:include href= "version-info.xml" xpointer= "v258" /> </listitem>
</varlistentry>
2018-12-20 16:09:48 +01:00
<varlistentry >
<term > <varname > root=</varname> </term>
2022-12-21 09:47:46 +01:00
<term > <varname > rootfstype=</varname> </term>
<term > <varname > rootflags=</varname> </term>
2018-12-20 16:09:48 +01:00
2022-12-21 09:47:46 +01:00
<listitem > <para > When <varname > root=</varname> is used with the special value
2025-03-20 22:51:04 +01:00
<literal > gpt-auto</literal> , basic automatic discovery of the root partition based on the GPT
2025-02-21 17:23:22 +01:00
partition type is enabled. Use of the root partition is delayed until factory reset mode is left, in
case it is enabled during the current boot. See <ulink url= "https://systemd.io/FACTORY_RESET" > Factory
Reset</ulink> for more information on that. If <literal > gpt-auto-force</literal> is specified
2025-03-20 22:51:04 +01:00
automatic discovery of the root partition is enabled, ignoring any factory reset mode.</para>
<para > If <varname > root=</varname> is set to the special value <literal > dissect</literal> full
automatic discovery of the root partition based on GPT partition information is enabled. This is a
superset of <varname > root=gpt-auto</varname> , as it automatically configures Verity partitions
(including signature-based setup) following the logic defined for that in the <ulink
2025-11-23 18:07:13 +01:00
url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification/">UAPI.2 Discoverable
2025-03-20 22:51:04 +01:00
Partitions Specification</ulink> . Moreover it takes the configured image policy and image filter into
account for all partition types, including the root file system. <literal > root=dissect</literal> will
wait for the factory reset phase to be completed if it is in effect before activating the root file
system. Use <literal > root=dissect-force</literal> to ignore the factory reset phase and activate the
root file system immediately.</para>
<para > Any other value (i.e. besides <literal > gpt-auto</literal> , <literal > gpt-auto-force</literal> ,
<literal > dissect</literal> , <literal > dissect-force</literal> ) disables automatic root file system
discovery.</para>
2022-12-21 09:47:46 +01:00
2025-02-10 22:24:52 +01:00
<para > If <varname > root=</varname> is not specified at all on the kernel command line automatic
2025-02-21 17:23:22 +01:00
discovery of the root partition via the ESP reported by the boot loader is also enabled (taking
2025-03-20 22:51:04 +01:00
factory reset state into account, i.e. equivalent to <literal > root=gpt-auto</literal> ), however in
this case discovery based on the loopback block device <literal > .lo_name</literal> field is not
enabled.</para>
2025-02-10 22:24:52 +01:00
2025-02-21 17:23:22 +01:00
<para > The <varname > rootfstype=</varname> and <varname > rootflags=</varname> options are used to select
the file system type and options when the root file system is automatically discovered.</para>
2023-09-18 16:03:38 +01:00
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2018-12-20 16:09:48 +01:00
</varlistentry>
2025-03-20 22:51:04 +01:00
<varlistentry >
<term > <varname > mount.usr=</varname> </term>
<term > <varname > mount.usrfstype=</varname> </term>
<term > <varname > mount.usrflags=</varname> </term>
<listitem > <para > Similar to <varname > root=</varname> , <varname > rootfstype=</varname> ,
<varname > rootflags=</varname> (see above), but applies to the <filename > /usr/</filename> partition
instead. Note that the <literal > gpt-auto</literal> , <literal > gpt-auto-force</literal> ,
<literal > dissect-force</literal> settings that <filename > root=</filename> understands are not
supported by <varname > mount.usr=</varname> (however <literal > dissect</literal> is).</para>
<para > Also note that automatic partition discovery for <filename > /usr/</filename> must be enabled
explicitly, unlike the discovery for the root file system, which is enabled if no
2025-04-07 16:57:08 +09:00
<varname > root=</varname> parameter is passed at all.</para>
2025-03-20 22:51:04 +01:00
<xi:include href= "version-info.xml" xpointer= "v258" /> </listitem>
</varlistentry>
2018-12-20 16:09:48 +01:00
<varlistentry >
<term > <varname > rw</varname> </term>
<term > <varname > ro</varname> </term>
<listitem > <para > Mount the root partition read-write or read-only <emphasis > initially</emphasis> .</para>
<para > Note that unlike most kernel command line options these settings do not override configuration
in the file system, and the file system may be remounted later. See
<citerefentry > <refentrytitle > systemd-remount-fs.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
2023-08-22 17:52:36 +01:00
</para>
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2018-12-20 16:09:48 +01:00
</varlistentry>
2023-05-25 09:03:10 +02:00
<varlistentry >
<term > <varname > systemd.swap=</varname> </term>
<listitem > <para > Takes a boolean argument or enables the option if specified without an argument.
If disabled, automatic discovery of swap partition(s) based on GPT partition type is disabled.
2023-08-22 17:52:36 +01:00
Defaults to enabled.</para>
<xi:include href= "version-info.xml" xpointer= "v254" /> </listitem>
2023-05-25 09:03:10 +02:00
</varlistentry>
2018-12-20 16:09:48 +01:00
</variablelist>
</refsect1>
2015-02-03 21:14:13 -05:00
<refsect1 >
<title > See Also</title>
2023-12-22 19:09:32 +01:00
<para > <simplelist type= "inline" >
<member > <citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd.mount</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd.swap</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd-fstab-generator</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd-cryptsetup@.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd-pcrfs@.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
2025-03-12 09:49:52 +01:00
<member > <citerefentry > <refentrytitle > systemd-validatefs@.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
2023-12-22 19:09:32 +01:00
<member > <citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> </member>
<member > <citerefentry project= 'die-net' > <refentrytitle > cryptsetup</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
<member > <citerefentry project= 'man-pages' > <refentrytitle > fstab</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> </member>
<member > <citerefentry project= 'url' > <refentrytitle url= 'https://btrfs.readthedocs.io/en/latest/btrfs.html' > btrfs</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
</simplelist> </para>
2015-02-03 21:14:13 -05:00
</refsect1>
2013-08-13 21:57:43 +02:00
</refentry>