1 /* SPDX-License-Identifier: LGPL-2.1+ */
7 #include "alloc-util.h"
11 #include "fstab-util.h"
12 #include "generator.h"
14 #include "main-func.h"
16 #include "mount-setup.h"
17 #include "mount-util.h"
18 #include "mountpoint-util.h"
19 #include "parse-util.h"
20 #include "path-util.h"
21 #include "proc-cmdline.h"
23 #include "specifier.h"
24 #include "stat-util.h"
25 #include "string-util.h"
27 #include "unit-name.h"
30 #include "volatile-util.h"
32 typedef enum MountpointFlags
{
40 static const char *arg_dest
= NULL
;
41 static const char *arg_dest_late
= NULL
;
42 static bool arg_fstab_enabled
= true;
43 static char *arg_root_what
= NULL
;
44 static char *arg_root_fstype
= NULL
;
45 static char *arg_root_options
= NULL
;
46 static char *arg_root_hash
= NULL
;
47 static int arg_root_rw
= -1;
48 static char *arg_usr_what
= NULL
;
49 static char *arg_usr_fstype
= NULL
;
50 static char *arg_usr_options
= NULL
;
51 static VolatileMode arg_volatile_mode
= _VOLATILE_MODE_INVALID
;
53 STATIC_DESTRUCTOR_REGISTER(arg_root_what
, freep
);
54 STATIC_DESTRUCTOR_REGISTER(arg_root_fstype
, freep
);
55 STATIC_DESTRUCTOR_REGISTER(arg_root_options
, freep
);
56 STATIC_DESTRUCTOR_REGISTER(arg_root_hash
, freep
);
57 STATIC_DESTRUCTOR_REGISTER(arg_usr_what
, freep
);
58 STATIC_DESTRUCTOR_REGISTER(arg_usr_fstype
, freep
);
59 STATIC_DESTRUCTOR_REGISTER(arg_usr_options
, freep
);
61 static int write_options(FILE *f
, const char *options
) {
62 _cleanup_free_
char *o
= NULL
;
67 if (streq(options
, "defaults"))
70 o
= specifier_escape(options
);
74 fprintf(f
, "Options=%s\n", o
);
78 static int write_what(FILE *f
, const char *what
) {
79 _cleanup_free_
char *w
= NULL
;
81 w
= specifier_escape(what
);
85 fprintf(f
, "What=%s\n", w
);
92 MountpointFlags flags
) {
94 _cleanup_free_
char *name
= NULL
;
95 _cleanup_fclose_
FILE *f
= NULL
;
101 if (access("/proc/swaps", F_OK
) < 0) {
102 log_info("Swap not supported, ignoring fstab swap entry for %s.", what
);
106 if (detect_container() > 0) {
107 log_info("Running in a container, ignoring fstab swap entry for %s.", what
);
111 r
= unit_name_from_path(what
, ".swap", &name
);
113 return log_error_errno(r
, "Failed to generate unit name: %m");
115 r
= generator_open_unit_file(arg_dest
, fstab_path(), name
, &f
);
122 "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_strv_free_
char **wanted_by
= NULL
, **required_by
= NULL
;
310 _cleanup_fclose_
FILE *f
= NULL
;
319 if (streq_ptr(fstype
, "autofs"))
322 if (!is_path(where
)) {
323 log_warning("Mount point %s is not a valid path, ignoring.", where
);
327 if (mount_point_is_api(where
) ||
328 mount_point_ignore(where
))
331 r
= fstab_extract_values(opts
, "x-systemd.wanted-by", &wanted_by
);
335 r
= fstab_extract_values(opts
, "x-systemd.required-by", &required_by
);
339 if (path_equal(where
, "/")) {
341 log_warning("Ignoring \"noauto\" for root device");
343 log_warning("Ignoring \"nofail\" for root device");
344 if (flags
& AUTOMOUNT
)
345 log_warning("Ignoring automount option for root device");
346 if (!strv_isempty(wanted_by
))
347 log_warning("Ignoring \"x-systemd.wanted-by=\" for root device");
348 if (!strv_isempty(required_by
))
349 log_warning("Ignoring \"x-systemd.required-by=\" for root device");
351 required_by
= strv_free(required_by
);
352 wanted_by
= strv_free(wanted_by
);
353 SET_FLAG(flags
, NOAUTO
| NOFAIL
| AUTOMOUNT
, false);
356 r
= unit_name_from_path(where
, ".mount", &name
);
358 return log_error_errno(r
, "Failed to generate unit name: %m");
360 r
= generator_open_unit_file(dest
, fstab_path(), name
, &f
);
367 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
370 /* All mounts under /sysroot need to happen later, at initrd-fs.target time. IOW, it's not
371 * technically part of the basic initrd filesystem itself, and so shouldn't inherit the default
372 * Before=local-fs.target dependency. */
373 if (in_initrd() && path_startswith(where
, "/sysroot"))
374 fprintf(f
, "DefaultDependencies=no\n");
376 if (STRPTR_IN_SET(fstype
, "nfs", "nfs4") && !(flags
& AUTOMOUNT
) &&
377 fstab_test_yes_no_option(opts
, "bg\0" "fg\0")) {
378 /* The default retry timeout that mount.nfs uses for 'bg' mounts
379 * is 10000 minutes, where as it uses 2 minutes for 'fg' mounts.
380 * As we are making 'bg' mounts look like an 'fg' mount to
381 * mount.nfs (so systemd can manage the job-control aspects of 'bg'),
382 * we need to explicitly preserve that default, and also ensure
383 * the systemd mount-timeout doesn't interfere.
384 * By placing these options first, they can be over-ridden by
385 * settings in /etc/fstab. */
386 opts
= strjoina("x-systemd.mount-timeout=infinity,retry=10000,", opts
, ",fg");
387 SET_FLAG(flags
, NOFAIL
, true);
390 if (!(flags
& NOFAIL
) && !(flags
& AUTOMOUNT
))
391 fprintf(f
, "Before=%s\n", post
);
393 if (!(flags
& AUTOMOUNT
) && opts
) {
394 r
= write_after(f
, opts
);
397 r
= write_requires_after(f
, opts
);
400 r
= write_before(f
, opts
);
403 r
= write_requires_mounts_for(f
, opts
);
409 r
= generator_write_fsck_deps(f
, dest
, what
, where
, fstype
);
414 fprintf(f
, "\n[Mount]\n");
416 fprintf(f
, "# Canonicalized from %s\n", original_where
);
418 where_escaped
= specifier_escape(where
);
421 fprintf(f
, "Where=%s\n", where_escaped
);
423 r
= write_what(f
, what
);
427 if (!isempty(fstype
) && !streq(fstype
, "auto")) {
428 _cleanup_free_
char *t
;
430 t
= specifier_escape(fstype
);
434 fprintf(f
, "Type=%s\n", t
);
437 r
= generator_write_timeouts(dest
, what
, where
, opts
, &filtered
);
441 r
= generator_write_device_deps(dest
, what
, where
, opts
);
445 r
= write_mount_timeout(f
, where
, opts
);
449 r
= write_options(f
, filtered
);
453 r
= fflush_and_check(f
);
455 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
457 if (flags
& MAKEFS
) {
458 r
= generator_hook_up_mkfs(dest
, what
, where
, fstype
);
463 if (flags
& GROWFS
) {
464 r
= generator_hook_up_growfs(dest
, where
, post
);
469 if (!FLAGS_SET(flags
, AUTOMOUNT
)) {
470 if (!FLAGS_SET(flags
, NOAUTO
) && strv_isempty(wanted_by
) && strv_isempty(required_by
)) {
471 r
= generator_add_symlink(dest
, post
,
472 (flags
& NOFAIL
) ? "wants" : "requires", name
);
478 STRV_FOREACH(s
, wanted_by
) {
479 r
= generator_add_symlink(dest
, *s
, "wants", name
);
484 STRV_FOREACH(s
, required_by
) {
485 r
= generator_add_symlink(dest
, *s
, "requires", name
);
491 r
= unit_name_from_path(where
, ".automount", &automount_name
);
493 return log_error_errno(r
, "Failed to generate unit name: %m");
497 r
= generator_open_unit_file(dest
, fstab_path(), automount_name
, &f
);
504 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
507 fprintf(f
, "Before=%s\n", post
);
510 r
= write_after(f
, opts
);
513 r
= write_requires_after(f
, opts
);
516 r
= write_before(f
, opts
);
519 r
= write_requires_mounts_for(f
, opts
);
530 r
= write_idle_timeout(f
, where
, opts
);
534 r
= fflush_and_check(f
);
536 return log_error_errno(r
, "Failed to write unit file %s: %m", automount_name
);
538 r
= generator_add_symlink(dest
, post
,
539 (flags
& NOFAIL
) ? "wants" : "requires", automount_name
);
547 static int parse_fstab(bool initrd
) {
548 _cleanup_endmntent_
FILE *f
= NULL
;
553 fstab
= initrd
? "/sysroot/etc/fstab" : fstab_path();
554 log_debug("Parsing %s...", fstab
);
556 f
= setmntent(fstab
, "re");
561 return log_error_errno(errno
, "Failed to open %s: %m", fstab
);
564 while ((me
= getmntent(f
))) {
565 _cleanup_free_
char *where
= NULL
, *what
= NULL
, *canonical_where
= NULL
;
566 bool makefs
, growfs
, noauto
, nofail
;
569 if (initrd
&& !mount_in_initrd(me
))
572 what
= fstab_node_to_udev_node(me
->mnt_fsname
);
576 if (is_device_path(what
) && path_is_read_only_fs("/sys") > 0) {
577 log_info("Running in a container, ignoring fstab device entry for %s.", what
);
581 where
= strdup(me
->mnt_dir
);
585 if (is_path(where
)) {
586 path_simplify(where
, false);
588 /* Follow symlinks here; see 5261ba901845c084de5a8fd06500ed09bfb0bd80 which makes sense for
589 * mount units, but causes problems since it historically worked to have symlinks in e.g.
590 * /etc/fstab. So we canonicalize here. Note that we use CHASE_NONEXISTENT to handle the case
591 * where a symlink refers to another mount target; this works assuming the sub-mountpoint
592 * target is the final directory. */
593 r
= chase_symlinks(where
, initrd
? "/sysroot" : NULL
,
594 CHASE_PREFIX_ROOT
| CHASE_NONEXISTENT
,
595 &canonical_where
, NULL
);
596 if (r
< 0) /* If we can't canonicalize we continue on as if it wasn't a symlink */
597 log_debug_errno(r
, "Failed to read symlink target for %s, ignoring: %m", where
);
598 else if (streq(canonical_where
, where
)) /* If it was fully canonicalized, suppress the change */
599 canonical_where
= mfree(canonical_where
);
601 log_debug("Canonicalized what=%s where=%s to %s", what
, where
, canonical_where
);
604 makefs
= fstab_test_option(me
->mnt_opts
, "x-systemd.makefs\0");
605 growfs
= fstab_test_option(me
->mnt_opts
, "x-systemd.growfs\0");
606 noauto
= fstab_test_yes_no_option(me
->mnt_opts
, "noauto\0" "auto\0");
607 nofail
= fstab_test_yes_no_option(me
->mnt_opts
, "nofail\0" "fail\0");
609 log_debug("Found entry what=%s where=%s type=%s makefs=%s growfs=%s noauto=%s nofail=%s",
610 what
, where
, me
->mnt_type
,
611 yes_no(makefs
), yes_no(growfs
),
612 yes_no(noauto
), yes_no(nofail
));
614 if (streq(me
->mnt_type
, "swap"))
615 k
= add_swap(what
, me
,
616 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
);
621 automount
= fstab_test_option(me
->mnt_opts
,
622 "comment=systemd.automount\0"
623 "x-systemd.automount\0");
625 post
= SPECIAL_INITRD_FS_TARGET
;
626 else if (mount_is_network(me
))
627 post
= SPECIAL_REMOTE_FS_TARGET
;
629 post
= SPECIAL_LOCAL_FS_TARGET
;
631 k
= add_mount(arg_dest
,
633 canonical_where
?: where
,
634 canonical_where
? where
: NULL
,
638 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
| automount
*AUTOMOUNT
,
650 static int add_sysroot_mount(void) {
651 _cleanup_free_
char *what
= NULL
;
655 if (isempty(arg_root_what
)) {
656 log_debug("Could not find a root= entry on the kernel command line.");
660 if (streq(arg_root_what
, "gpt-auto")) {
661 /* This is handled by the gpt-auto generator */
662 log_debug("Skipping root directory handling, as gpt-auto was requested.");
666 if (path_equal(arg_root_what
, "/dev/nfs")) {
667 /* This is handled by the kernel or the initrd */
668 log_debug("Skipping root directory handling, as /dev/nfs was requested.");
672 what
= fstab_node_to_udev_node(arg_root_what
);
676 if (!arg_root_options
)
677 opts
= arg_root_rw
> 0 ? "rw" : "ro";
678 else if (arg_root_rw
>= 0 ||
679 !fstab_test_option(arg_root_options
, "ro\0" "rw\0"))
680 opts
= strjoina(arg_root_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
682 opts
= arg_root_options
;
684 log_debug("Found entry what=%s where=/sysroot type=%s", what
, strna(arg_root_fstype
));
686 if (is_device_path(what
)) {
687 r
= generator_write_initrd_root_device_deps(arg_dest
, what
);
692 return add_mount(arg_dest
,
698 is_device_path(what
) ? 1 : 0, /* passno */
699 0, /* makefs off, growfs off, noauto off, nofail off, automount off */
700 SPECIAL_INITRD_ROOT_FS_TARGET
,
704 static int add_sysroot_usr_mount(void) {
705 _cleanup_free_
char *what
= NULL
;
708 if (!arg_usr_what
&& !arg_usr_fstype
&& !arg_usr_options
)
711 if (arg_root_what
&& !arg_usr_what
) {
712 /* Copy over the root device, in case the /usr mount just differs in a mount option (consider btrfs subvolumes) */
713 arg_usr_what
= strdup(arg_root_what
);
718 if (arg_root_fstype
&& !arg_usr_fstype
) {
719 arg_usr_fstype
= strdup(arg_root_fstype
);
724 if (arg_root_options
&& !arg_usr_options
) {
725 arg_usr_options
= strdup(arg_root_options
);
726 if (!arg_usr_options
)
733 what
= fstab_node_to_udev_node(arg_usr_what
);
737 if (!arg_usr_options
)
738 opts
= arg_root_rw
> 0 ? "rw" : "ro";
739 else if (!fstab_test_option(arg_usr_options
, "ro\0" "rw\0"))
740 opts
= strjoina(arg_usr_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
742 opts
= arg_usr_options
;
744 log_debug("Found entry what=%s where=/sysroot/usr type=%s", what
, strna(arg_usr_fstype
));
745 return add_mount(arg_dest
,
751 is_device_path(what
) ? 1 : 0, /* passno */
753 SPECIAL_INITRD_FS_TARGET
,
757 static int add_volatile_root(void) {
759 /* Let's add in systemd-remount-volatile.service which will remount the root device to tmpfs if this is
760 * requested (or as an overlayfs), leaving only /usr from the root mount inside. */
762 if (!IN_SET(arg_volatile_mode
, VOLATILE_YES
, VOLATILE_OVERLAY
))
765 return generator_add_symlink(arg_dest
, SPECIAL_INITRD_ROOT_FS_TARGET
, "requires",
766 SYSTEM_DATA_UNIT_PATH
"/" SPECIAL_VOLATILE_ROOT_SERVICE
);
769 static int add_volatile_var(void) {
771 if (arg_volatile_mode
!= VOLATILE_STATE
)
774 /* If requested, mount /var as tmpfs, but do so only if there's nothing else defined for this. */
776 return add_mount(arg_dest_late
,
784 SPECIAL_LOCAL_FS_TARGET
,
788 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
791 /* root=, usr=, usrfstype= and roofstype= may occur more than once, the last
792 * instance should take precedence. In the case of multiple rootflags=
793 * or usrflags= the arguments should be concatenated */
795 if (STR_IN_SET(key
, "fstab", "rd.fstab")) {
797 r
= value
? parse_boolean(value
) : 1;
799 log_warning("Failed to parse fstab switch %s. Ignoring.", value
);
801 arg_fstab_enabled
= r
;
803 } else if (streq(key
, "root")) {
805 if (proc_cmdline_value_missing(key
, value
))
808 if (free_and_strdup(&arg_root_what
, value
) < 0)
811 } else if (streq(key
, "rootfstype")) {
813 if (proc_cmdline_value_missing(key
, value
))
816 if (free_and_strdup(&arg_root_fstype
, value
) < 0)
819 } else if (streq(key
, "rootflags")) {
821 if (proc_cmdline_value_missing(key
, value
))
824 if (!strextend_with_separator(&arg_root_options
, ",", value
, NULL
))
827 } else if (streq(key
, "roothash")) {
829 if (proc_cmdline_value_missing(key
, value
))
832 if (free_and_strdup(&arg_root_hash
, value
) < 0)
835 } else if (streq(key
, "mount.usr")) {
837 if (proc_cmdline_value_missing(key
, value
))
840 if (free_and_strdup(&arg_usr_what
, value
) < 0)
843 } else if (streq(key
, "mount.usrfstype")) {
845 if (proc_cmdline_value_missing(key
, value
))
848 if (free_and_strdup(&arg_usr_fstype
, value
) < 0)
851 } else if (streq(key
, "mount.usrflags")) {
853 if (proc_cmdline_value_missing(key
, value
))
856 if (!strextend_with_separator(&arg_usr_options
, ",", value
, NULL
))
859 } else if (streq(key
, "rw") && !value
)
861 else if (streq(key
, "ro") && !value
)
863 else if (streq(key
, "systemd.volatile")) {
867 m
= volatile_mode_from_string(value
);
869 log_warning("Failed to parse systemd.volatile= argument: %s", value
);
871 arg_volatile_mode
= m
;
873 arg_volatile_mode
= VOLATILE_YES
;
879 static int determine_root(void) {
880 /* If we have a root hash but no root device then Verity is used, and we use the "root" DM device as root. */
888 arg_root_what
= strdup("/dev/mapper/root");
892 log_info("Using verity root device %s.", arg_root_what
);
897 static int run(const char *dest
, const char *dest_early
, const char *dest_late
) {
898 int r
, r2
= 0, r3
= 0;
900 assert_se(arg_dest
= dest
);
901 assert_se(arg_dest_late
= dest_late
);
903 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, 0);
905 log_warning_errno(r
, "Failed to parse kernel command line, ignoring: %m");
907 (void) determine_root();
909 /* Always honour root= and usr= in the kernel command line if we are in an initrd */
911 r
= add_sysroot_mount();
913 r2
= add_sysroot_usr_mount();
915 r3
= add_volatile_root();
917 r
= add_volatile_var();
919 /* Honour /etc/fstab only when that's enabled */
920 if (arg_fstab_enabled
) {
921 /* Parse the local /etc/fstab, possibly from the initrd */
922 r2
= parse_fstab(false);
924 /* If running in the initrd also parse the /etc/fstab from the host */
926 r3
= parse_fstab(true);
928 r3
= generator_enable_remount_fs_service(arg_dest
);
931 return r
< 0 ? r
: r2
< 0 ? r2
: r3
;
934 DEFINE_MAIN_GENERATOR_FUNCTION(run
);