1 /* SPDX-License-Identifier: LGPL-2.1+ */
9 #include "alloc-util.h"
13 #include "fstab-util.h"
14 #include "generator.h"
16 #include "main-func.h"
18 #include "mount-setup.h"
19 #include "mount-util.h"
20 #include "mountpoint-util.h"
21 #include "parse-util.h"
22 #include "path-util.h"
23 #include "proc-cmdline.h"
25 #include "specifier.h"
26 #include "stat-util.h"
27 #include "string-util.h"
29 #include "unit-name.h"
32 #include "volatile-util.h"
34 typedef enum MountpointFlags
{
42 static const char *arg_dest
= NULL
;
43 static const char *arg_dest_late
= NULL
;
44 static bool arg_fstab_enabled
= true;
45 static char *arg_root_what
= NULL
;
46 static char *arg_root_fstype
= NULL
;
47 static char *arg_root_options
= NULL
;
48 static char *arg_root_hash
= NULL
;
49 static int arg_root_rw
= -1;
50 static char *arg_usr_what
= NULL
;
51 static char *arg_usr_fstype
= NULL
;
52 static char *arg_usr_options
= NULL
;
53 static VolatileMode arg_volatile_mode
= _VOLATILE_MODE_INVALID
;
55 STATIC_DESTRUCTOR_REGISTER(arg_root_what
, freep
);
56 STATIC_DESTRUCTOR_REGISTER(arg_root_fstype
, freep
);
57 STATIC_DESTRUCTOR_REGISTER(arg_root_options
, freep
);
58 STATIC_DESTRUCTOR_REGISTER(arg_root_hash
, freep
);
59 STATIC_DESTRUCTOR_REGISTER(arg_usr_what
, freep
);
60 STATIC_DESTRUCTOR_REGISTER(arg_usr_fstype
, freep
);
61 STATIC_DESTRUCTOR_REGISTER(arg_usr_options
, freep
);
63 static int write_options(FILE *f
, const char *options
) {
64 _cleanup_free_
char *o
= NULL
;
69 if (streq(options
, "defaults"))
72 o
= specifier_escape(options
);
76 fprintf(f
, "Options=%s\n", o
);
80 static int write_what(FILE *f
, const char *what
) {
81 _cleanup_free_
char *w
= NULL
;
83 w
= specifier_escape(what
);
87 fprintf(f
, "What=%s\n", w
);
94 MountpointFlags flags
) {
96 _cleanup_free_
char *name
= NULL
;
97 _cleanup_fclose_
FILE *f
= NULL
;
103 if (access("/proc/swaps", F_OK
) < 0) {
104 log_info("Swap not supported, ignoring fstab swap entry for %s.", what
);
108 if (detect_container() > 0) {
109 log_info("Running in a container, ignoring fstab swap entry for %s.", what
);
113 r
= unit_name_from_path(what
, ".swap", &name
);
115 return log_error_errno(r
, "Failed to generate unit name: %m");
117 r
= generator_open_unit_file(arg_dest
, "/etc/fstab", name
, &f
);
122 "SourcePath=/etc/fstab\n"
123 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n\n"
126 r
= write_what(f
, what
);
130 r
= write_options(f
, me
->mnt_opts
);
134 r
= fflush_and_check(f
);
136 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
138 /* use what as where, to have a nicer error message */
139 r
= generator_write_timeouts(arg_dest
, what
, what
, me
->mnt_opts
, NULL
);
143 if (flags
& MAKEFS
) {
144 r
= generator_hook_up_mkswap(arg_dest
, what
);
150 /* TODO: swap devices must be wiped and recreated */
151 log_warning("%s: growing swap devices is currently unsupported.", what
);
153 if (!(flags
& NOAUTO
)) {
154 r
= generator_add_symlink(arg_dest
, SPECIAL_SWAP_TARGET
,
155 (flags
& NOFAIL
) ? "wants" : "requires", name
);
163 static bool mount_is_network(struct mntent
*me
) {
166 return fstab_test_option(me
->mnt_opts
, "_netdev\0") ||
167 fstype_is_network(me
->mnt_type
);
170 static bool mount_in_initrd(struct mntent
*me
) {
173 return fstab_test_option(me
->mnt_opts
, "x-initrd.mount\0") ||
174 streq(me
->mnt_dir
, "/usr");
177 static int write_timeout(FILE *f
, const char *where
, const char *opts
,
178 const char *filter
, const char *variable
) {
179 _cleanup_free_
char *timeout
= NULL
;
180 char timespan
[FORMAT_TIMESPAN_MAX
];
184 r
= fstab_filter_options(opts
, filter
, NULL
, &timeout
, NULL
);
186 return log_warning_errno(r
, "Failed to parse options: %m");
190 r
= parse_sec_fix_0(timeout
, &u
);
192 log_warning("Failed to parse timeout for %s, ignoring: %s", where
, timeout
);
196 fprintf(f
, "%s=%s\n", variable
, format_timespan(timespan
, sizeof(timespan
), u
, 0));
201 static int write_idle_timeout(FILE *f
, const char *where
, const char *opts
) {
202 return write_timeout(f
, where
, opts
,
203 "x-systemd.idle-timeout\0", "TimeoutIdleSec");
206 static int write_mount_timeout(FILE *f
, const char *where
, const char *opts
) {
207 return write_timeout(f
, where
, opts
,
208 "x-systemd.mount-timeout\0", "TimeoutSec");
211 static int write_dependency(FILE *f
, const char *opts
,
212 const char *filter
, const char *format
) {
213 _cleanup_strv_free_
char **names
= NULL
, **units
= NULL
;
214 _cleanup_free_
char *res
= NULL
;
221 r
= fstab_extract_values(opts
, filter
, &names
);
223 return log_warning_errno(r
, "Failed to parse options: %m");
227 STRV_FOREACH(s
, names
) {
230 r
= unit_name_mangle_with_suffix(*s
, "as dependency", 0, ".mount", &x
);
232 return log_error_errno(r
, "Failed to generate unit name: %m");
233 r
= strv_consume(&units
, x
);
239 res
= strv_join(units
, " ");
242 #pragma GCC diagnostic push
243 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
244 fprintf(f
, format
, res
);
245 #pragma GCC diagnostic pop
251 static int write_after(FILE *f
, const char *opts
) {
252 return write_dependency(f
, opts
, "x-systemd.after", "After=%1$s\n");
255 static int write_requires_after(FILE *f
, const char *opts
) {
256 return write_dependency(f
, opts
,
257 "x-systemd.requires", "After=%1$s\nRequires=%1$s\n");
260 static int write_before(FILE *f
, const char *opts
) {
261 return write_dependency(f
, opts
,
262 "x-systemd.before", "Before=%1$s\n");
265 static int write_requires_mounts_for(FILE *f
, const char *opts
) {
266 _cleanup_strv_free_
char **paths
= NULL
, **paths_escaped
= NULL
;
267 _cleanup_free_
char *res
= NULL
;
273 r
= fstab_extract_values(opts
, "x-systemd.requires-mounts-for", &paths
);
275 return log_warning_errno(r
, "Failed to parse options: %m");
279 r
= specifier_escape_strv(paths
, &paths_escaped
);
281 return log_error_errno(r
, "Failed to escape paths: %m");
283 res
= strv_join(paths_escaped
, " ");
287 fprintf(f
, "RequiresMountsFor=%s\n", res
);
292 static int add_mount(
296 const char *original_where
,
300 MountpointFlags flags
,
302 const char *source
) {
306 *automount_name
= NULL
,
308 *where_escaped
= NULL
;
309 _cleanup_fclose_
FILE *f
= NULL
;
318 if (streq_ptr(fstype
, "autofs"))
321 if (!is_path(where
)) {
322 log_warning("Mount point %s is not a valid path, ignoring.", where
);
326 if (mount_point_is_api(where
) ||
327 mount_point_ignore(where
))
330 if (path_equal(where
, "/")) {
332 log_warning("Ignoring \"noauto\" for root device");
334 log_warning("Ignoring \"nofail\" for root device");
335 if (flags
& AUTOMOUNT
)
336 log_warning("Ignoring automount option for root device");
338 SET_FLAG(flags
, NOAUTO
| NOFAIL
| AUTOMOUNT
, false);
341 r
= unit_name_from_path(where
, ".mount", &name
);
343 return log_error_errno(r
, "Failed to generate unit name: %m");
345 r
= generator_open_unit_file(dest
, "/etc/fstab", name
, &f
);
352 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
355 /* All mounts under /sysroot need to happen later, at initrd-fs.target time. IOW, it's not
356 * technically part of the basic initrd filesystem itself, and so shouldn't inherit the default
357 * Before=local-fs.target dependency. */
358 if (in_initrd() && path_startswith(where
, "/sysroot"))
359 fprintf(f
, "DefaultDependencies=no\n");
361 if (STRPTR_IN_SET(fstype
, "nfs", "nfs4") && !(flags
& AUTOMOUNT
) &&
362 fstab_test_yes_no_option(opts
, "bg\0" "fg\0")) {
363 /* The default retry timeout that mount.nfs uses for 'bg' mounts
364 * is 10000 minutes, where as it uses 2 minutes for 'fg' mounts.
365 * As we are making 'bg' mounts look like an 'fg' mount to
366 * mount.nfs (so systemd can manage the job-control aspects of 'bg'),
367 * we need to explicitly preserve that default, and also ensure
368 * the systemd mount-timeout doesn't interfere.
369 * By placing these options first, they can be over-ridden by
370 * settings in /etc/fstab. */
371 opts
= strjoina("x-systemd.mount-timeout=infinity,retry=10000,", opts
, ",fg");
372 SET_FLAG(flags
, NOFAIL
, true);
375 if (!(flags
& NOFAIL
) && !(flags
& AUTOMOUNT
))
376 fprintf(f
, "Before=%s\n", post
);
378 if (!(flags
& AUTOMOUNT
) && opts
) {
379 r
= write_after(f
, opts
);
382 r
= write_requires_after(f
, opts
);
385 r
= write_before(f
, opts
);
388 r
= write_requires_mounts_for(f
, opts
);
394 r
= generator_write_fsck_deps(f
, dest
, what
, where
, fstype
);
399 fprintf(f
, "\n[Mount]\n");
401 fprintf(f
, "# Canonicalized from %s\n", original_where
);
403 where_escaped
= specifier_escape(where
);
406 fprintf(f
, "Where=%s\n", where_escaped
);
408 r
= write_what(f
, what
);
412 if (!isempty(fstype
) && !streq(fstype
, "auto")) {
413 _cleanup_free_
char *t
;
415 t
= specifier_escape(fstype
);
419 fprintf(f
, "Type=%s\n", t
);
422 r
= generator_write_timeouts(dest
, what
, where
, opts
, &filtered
);
426 r
= generator_write_device_deps(dest
, what
, where
, opts
);
430 r
= write_mount_timeout(f
, where
, opts
);
434 r
= write_options(f
, filtered
);
438 r
= fflush_and_check(f
);
440 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
442 if (flags
& MAKEFS
) {
443 r
= generator_hook_up_mkfs(dest
, what
, where
, fstype
);
448 if (flags
& GROWFS
) {
449 r
= generator_hook_up_growfs(dest
, where
, post
);
454 if (!(flags
& NOAUTO
) && !(flags
& AUTOMOUNT
)) {
455 r
= generator_add_symlink(dest
, post
,
456 (flags
& NOFAIL
) ? "wants" : "requires", name
);
461 if (flags
& AUTOMOUNT
) {
462 r
= unit_name_from_path(where
, ".automount", &automount_name
);
464 return log_error_errno(r
, "Failed to generate unit name: %m");
468 r
= generator_open_unit_file(dest
, "/etc/fstab", automount_name
, &f
);
475 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
478 fprintf(f
, "Before=%s\n", post
);
481 r
= write_after(f
, opts
);
484 r
= write_requires_after(f
, opts
);
487 r
= write_before(f
, opts
);
490 r
= write_requires_mounts_for(f
, opts
);
501 r
= write_idle_timeout(f
, where
, opts
);
505 r
= fflush_and_check(f
);
507 return log_error_errno(r
, "Failed to write unit file %s: %m", automount_name
);
509 r
= generator_add_symlink(dest
, post
,
510 (flags
& NOFAIL
) ? "wants" : "requires", automount_name
);
518 static int parse_fstab(bool initrd
) {
519 _cleanup_endmntent_
FILE *f
= NULL
;
520 const char *fstab_path
;
524 fstab_path
= initrd
? "/sysroot/etc/fstab" : "/etc/fstab";
525 log_debug("Parsing %s...", fstab_path
);
527 f
= setmntent(fstab_path
, "re");
532 return log_error_errno(errno
, "Failed to open %s: %m", fstab_path
);
535 while ((me
= getmntent(f
))) {
536 _cleanup_free_
char *where
= NULL
, *what
= NULL
, *canonical_where
= NULL
;
537 bool makefs
, growfs
, noauto
, nofail
;
540 if (initrd
&& !mount_in_initrd(me
))
543 what
= fstab_node_to_udev_node(me
->mnt_fsname
);
547 if (is_device_path(what
) && path_is_read_only_fs("/sys") > 0) {
548 log_info("Running in a container, ignoring fstab device entry for %s.", what
);
552 where
= strdup(me
->mnt_dir
);
556 if (is_path(where
)) {
557 path_simplify(where
, false);
559 /* Follow symlinks here; see 5261ba901845c084de5a8fd06500ed09bfb0bd80 which makes sense for
560 * mount units, but causes problems since it historically worked to have symlinks in e.g.
561 * /etc/fstab. So we canonicalize here. Note that we use CHASE_NONEXISTENT to handle the case
562 * where a symlink refers to another mount target; this works assuming the sub-mountpoint
563 * target is the final directory. */
564 r
= chase_symlinks(where
, initrd
? "/sysroot" : NULL
,
565 CHASE_PREFIX_ROOT
| CHASE_NONEXISTENT
,
566 &canonical_where
, NULL
);
567 if (r
< 0) /* If we can't canonicalize we continue on as if it wasn't a symlink */
568 log_debug_errno(r
, "Failed to read symlink target for %s, ignoring: %m", where
);
569 else if (streq(canonical_where
, where
)) /* If it was fully canonicalized, suppress the change */
570 canonical_where
= mfree(canonical_where
);
572 log_debug("Canonicalized what=%s where=%s to %s", what
, where
, canonical_where
);
575 makefs
= fstab_test_option(me
->mnt_opts
, "x-systemd.makefs\0");
576 growfs
= fstab_test_option(me
->mnt_opts
, "x-systemd.growfs\0");
577 noauto
= fstab_test_yes_no_option(me
->mnt_opts
, "noauto\0" "auto\0");
578 nofail
= fstab_test_yes_no_option(me
->mnt_opts
, "nofail\0" "fail\0");
580 log_debug("Found entry what=%s where=%s type=%s makefs=%s growfs=%s noauto=%s nofail=%s",
581 what
, where
, me
->mnt_type
,
582 yes_no(makefs
), yes_no(growfs
),
583 yes_no(noauto
), yes_no(nofail
));
585 if (streq(me
->mnt_type
, "swap"))
586 k
= add_swap(what
, me
,
587 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
);
592 automount
= fstab_test_option(me
->mnt_opts
,
593 "comment=systemd.automount\0"
594 "x-systemd.automount\0");
596 post
= SPECIAL_INITRD_FS_TARGET
;
597 else if (mount_is_network(me
))
598 post
= SPECIAL_REMOTE_FS_TARGET
;
600 post
= SPECIAL_LOCAL_FS_TARGET
;
602 k
= add_mount(arg_dest
,
604 canonical_where
?: where
,
605 canonical_where
? where
: NULL
,
609 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
| automount
*AUTOMOUNT
,
621 static int add_sysroot_mount(void) {
622 _cleanup_free_
char *what
= NULL
;
626 if (isempty(arg_root_what
)) {
627 log_debug("Could not find a root= entry on the kernel command line.");
631 if (streq(arg_root_what
, "gpt-auto")) {
632 /* This is handled by the gpt-auto generator */
633 log_debug("Skipping root directory handling, as gpt-auto was requested.");
637 if (path_equal(arg_root_what
, "/dev/nfs")) {
638 /* This is handled by the kernel or the initrd */
639 log_debug("Skipping root directory handling, as /dev/nfs was requested.");
643 what
= fstab_node_to_udev_node(arg_root_what
);
647 if (!arg_root_options
)
648 opts
= arg_root_rw
> 0 ? "rw" : "ro";
649 else if (arg_root_rw
>= 0 ||
650 !fstab_test_option(arg_root_options
, "ro\0" "rw\0"))
651 opts
= strjoina(arg_root_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
653 opts
= arg_root_options
;
655 log_debug("Found entry what=%s where=/sysroot type=%s", what
, strna(arg_root_fstype
));
657 if (is_device_path(what
)) {
658 r
= generator_write_initrd_root_device_deps(arg_dest
, what
);
663 return add_mount(arg_dest
,
669 is_device_path(what
) ? 1 : 0, /* passno */
670 0, /* makefs off, growfs off, noauto off, nofail off, automount off */
671 SPECIAL_INITRD_ROOT_FS_TARGET
,
675 static int add_sysroot_usr_mount(void) {
676 _cleanup_free_
char *what
= NULL
;
679 if (!arg_usr_what
&& !arg_usr_fstype
&& !arg_usr_options
)
682 if (arg_root_what
&& !arg_usr_what
) {
683 /* Copy over the root device, in case the /usr mount just differs in a mount option (consider btrfs subvolumes) */
684 arg_usr_what
= strdup(arg_root_what
);
689 if (arg_root_fstype
&& !arg_usr_fstype
) {
690 arg_usr_fstype
= strdup(arg_root_fstype
);
695 if (arg_root_options
&& !arg_usr_options
) {
696 arg_usr_options
= strdup(arg_root_options
);
697 if (!arg_usr_options
)
704 what
= fstab_node_to_udev_node(arg_usr_what
);
708 if (!arg_usr_options
)
709 opts
= arg_root_rw
> 0 ? "rw" : "ro";
710 else if (!fstab_test_option(arg_usr_options
, "ro\0" "rw\0"))
711 opts
= strjoina(arg_usr_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
713 opts
= arg_usr_options
;
715 log_debug("Found entry what=%s where=/sysroot/usr type=%s", what
, strna(arg_usr_fstype
));
716 return add_mount(arg_dest
,
722 is_device_path(what
) ? 1 : 0, /* passno */
724 SPECIAL_INITRD_FS_TARGET
,
728 static int add_volatile_root(void) {
730 /* Let's add in systemd-remount-volatile.service which will remount the root device to tmpfs if this is
731 * requested (or as an overlayfs), leaving only /usr from the root mount inside. */
733 if (!IN_SET(arg_volatile_mode
, VOLATILE_YES
, VOLATILE_OVERLAY
))
736 return generator_add_symlink(arg_dest
, SPECIAL_INITRD_ROOT_FS_TARGET
, "requires",
737 SYSTEM_DATA_UNIT_PATH
"/" SPECIAL_VOLATILE_ROOT_SERVICE
);
740 static int add_volatile_var(void) {
742 if (arg_volatile_mode
!= VOLATILE_STATE
)
745 /* If requested, mount /var as tmpfs, but do so only if there's nothing else defined for this. */
747 return add_mount(arg_dest_late
,
755 SPECIAL_LOCAL_FS_TARGET
,
759 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
762 /* root=, usr=, usrfstype= and roofstype= may occur more than once, the last
763 * instance should take precedence. In the case of multiple rootflags=
764 * or usrflags= the arguments should be concatenated */
766 if (STR_IN_SET(key
, "fstab", "rd.fstab")) {
768 r
= value
? parse_boolean(value
) : 1;
770 log_warning("Failed to parse fstab switch %s. Ignoring.", value
);
772 arg_fstab_enabled
= r
;
774 } else if (streq(key
, "root")) {
776 if (proc_cmdline_value_missing(key
, value
))
779 if (free_and_strdup(&arg_root_what
, value
) < 0)
782 } else if (streq(key
, "rootfstype")) {
784 if (proc_cmdline_value_missing(key
, value
))
787 if (free_and_strdup(&arg_root_fstype
, value
) < 0)
790 } else if (streq(key
, "rootflags")) {
792 if (proc_cmdline_value_missing(key
, value
))
795 if (!strextend_with_separator(&arg_root_options
, ",", value
, NULL
))
798 } else if (streq(key
, "roothash")) {
800 if (proc_cmdline_value_missing(key
, value
))
803 if (free_and_strdup(&arg_root_hash
, value
) < 0)
806 } else if (streq(key
, "mount.usr")) {
808 if (proc_cmdline_value_missing(key
, value
))
811 if (free_and_strdup(&arg_usr_what
, value
) < 0)
814 } else if (streq(key
, "mount.usrfstype")) {
816 if (proc_cmdline_value_missing(key
, value
))
819 if (free_and_strdup(&arg_usr_fstype
, value
) < 0)
822 } else if (streq(key
, "mount.usrflags")) {
824 if (proc_cmdline_value_missing(key
, value
))
827 if (!strextend_with_separator(&arg_usr_options
, ",", value
, NULL
))
830 } else if (streq(key
, "rw") && !value
)
832 else if (streq(key
, "ro") && !value
)
834 else if (streq(key
, "systemd.volatile")) {
838 m
= volatile_mode_from_string(value
);
840 log_warning("Failed to parse systemd.volatile= argument: %s", value
);
842 arg_volatile_mode
= m
;
844 arg_volatile_mode
= VOLATILE_YES
;
850 static int determine_root(void) {
851 /* If we have a root hash but no root device then Verity is used, and we use the "root" DM device as root. */
859 arg_root_what
= strdup("/dev/mapper/root");
863 log_info("Using verity root device %s.", arg_root_what
);
868 static int run(const char *dest
, const char *dest_early
, const char *dest_late
) {
869 int r
, r2
= 0, r3
= 0;
871 assert_se(arg_dest
= dest
);
872 assert_se(arg_dest_late
= dest_late
);
874 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, 0);
876 log_warning_errno(r
, "Failed to parse kernel command line, ignoring: %m");
878 (void) determine_root();
880 /* Always honour root= and usr= in the kernel command line if we are in an initrd */
882 r
= add_sysroot_mount();
884 r2
= add_sysroot_usr_mount();
886 r3
= add_volatile_root();
888 r
= add_volatile_var();
890 /* Honour /etc/fstab only when that's enabled */
891 if (arg_fstab_enabled
) {
892 /* Parse the local /etc/fstab, possibly from the initrd */
893 r2
= parse_fstab(false);
895 /* If running in the initrd also parse the /etc/fstab from the host */
897 r3
= parse_fstab(true);
899 r3
= generator_enable_remount_fs_service(arg_dest
);
902 return r
< 0 ? r
: r2
< 0 ? r2
: r3
;
905 DEFINE_MAIN_GENERATOR_FUNCTION(run
);