1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "alloc-util.h"
12 #include "fstab-util.h"
13 #include "generator.h"
15 #include "main-func.h"
17 #include "mount-setup.h"
18 #include "mount-util.h"
19 #include "mountpoint-util.h"
20 #include "parse-util.h"
21 #include "path-util.h"
22 #include "proc-cmdline.h"
24 #include "specifier.h"
25 #include "stat-util.h"
26 #include "string-util.h"
28 #include "unit-name.h"
31 #include "volatile-util.h"
33 typedef enum MountpointFlags
{
41 static const char *arg_dest
= NULL
;
42 static const char *arg_dest_late
= NULL
;
43 static bool arg_fstab_enabled
= true;
44 static char *arg_root_what
= NULL
;
45 static char *arg_root_fstype
= NULL
;
46 static char *arg_root_options
= NULL
;
47 static char *arg_root_hash
= NULL
;
48 static int arg_root_rw
= -1;
49 static char *arg_usr_what
= NULL
;
50 static char *arg_usr_fstype
= NULL
;
51 static char *arg_usr_options
= NULL
;
52 static VolatileMode arg_volatile_mode
= _VOLATILE_MODE_INVALID
;
54 STATIC_DESTRUCTOR_REGISTER(arg_root_what
, freep
);
55 STATIC_DESTRUCTOR_REGISTER(arg_root_fstype
, freep
);
56 STATIC_DESTRUCTOR_REGISTER(arg_root_options
, freep
);
57 STATIC_DESTRUCTOR_REGISTER(arg_root_hash
, freep
);
58 STATIC_DESTRUCTOR_REGISTER(arg_usr_what
, freep
);
59 STATIC_DESTRUCTOR_REGISTER(arg_usr_fstype
, freep
);
60 STATIC_DESTRUCTOR_REGISTER(arg_usr_options
, freep
);
62 static int write_options(FILE *f
, const char *options
) {
63 _cleanup_free_
char *o
= NULL
;
68 if (streq(options
, "defaults"))
71 o
= specifier_escape(options
);
75 fprintf(f
, "Options=%s\n", o
);
79 static int write_what(FILE *f
, const char *what
) {
80 _cleanup_free_
char *w
= NULL
;
82 w
= specifier_escape(what
);
86 fprintf(f
, "What=%s\n", w
);
93 MountpointFlags flags
) {
95 _cleanup_free_
char *name
= NULL
;
96 _cleanup_fclose_
FILE *f
= NULL
;
102 if (access("/proc/swaps", F_OK
) < 0) {
103 log_info("Swap not supported, ignoring fstab swap entry for %s.", what
);
107 if (detect_container() > 0) {
108 log_info("Running in a container, ignoring fstab swap entry for %s.", what
);
112 r
= unit_name_from_path(what
, ".swap", &name
);
114 return log_error_errno(r
, "Failed to generate unit name: %m");
116 r
= generator_open_unit_file(arg_dest
, "/etc/fstab", name
, &f
);
121 "SourcePath=/etc/fstab\n"
122 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n\n"
125 r
= write_what(f
, what
);
129 r
= write_options(f
, me
->mnt_opts
);
133 r
= fflush_and_check(f
);
135 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
137 /* use what as where, to have a nicer error message */
138 r
= generator_write_timeouts(arg_dest
, what
, what
, me
->mnt_opts
, NULL
);
142 if (flags
& MAKEFS
) {
143 r
= generator_hook_up_mkswap(arg_dest
, what
);
149 /* TODO: swap devices must be wiped and recreated */
150 log_warning("%s: growing swap devices is currently unsupported.", what
);
152 if (!(flags
& NOAUTO
)) {
153 r
= generator_add_symlink(arg_dest
, SPECIAL_SWAP_TARGET
,
154 (flags
& NOFAIL
) ? "wants" : "requires", name
);
162 static bool mount_is_network(struct mntent
*me
) {
165 return fstab_test_option(me
->mnt_opts
, "_netdev\0") ||
166 fstype_is_network(me
->mnt_type
);
169 static bool mount_in_initrd(struct mntent
*me
) {
172 return fstab_test_option(me
->mnt_opts
, "x-initrd.mount\0") ||
173 streq(me
->mnt_dir
, "/usr");
176 static int write_timeout(FILE *f
, const char *where
, const char *opts
,
177 const char *filter
, const char *variable
) {
178 _cleanup_free_
char *timeout
= NULL
;
179 char timespan
[FORMAT_TIMESPAN_MAX
];
183 r
= fstab_filter_options(opts
, filter
, NULL
, &timeout
, NULL
);
185 return log_warning_errno(r
, "Failed to parse options: %m");
189 r
= parse_sec_fix_0(timeout
, &u
);
191 log_warning("Failed to parse timeout for %s, ignoring: %s", where
, timeout
);
195 fprintf(f
, "%s=%s\n", variable
, format_timespan(timespan
, sizeof(timespan
), u
, 0));
200 static int write_idle_timeout(FILE *f
, const char *where
, const char *opts
) {
201 return write_timeout(f
, where
, opts
,
202 "x-systemd.idle-timeout\0", "TimeoutIdleSec");
205 static int write_mount_timeout(FILE *f
, const char *where
, const char *opts
) {
206 return write_timeout(f
, where
, opts
,
207 "x-systemd.mount-timeout\0", "TimeoutSec");
210 static int write_dependency(FILE *f
, const char *opts
,
211 const char *filter
, const char *format
) {
212 _cleanup_strv_free_
char **names
= NULL
, **units
= NULL
;
213 _cleanup_free_
char *res
= NULL
;
220 r
= fstab_extract_values(opts
, filter
, &names
);
222 return log_warning_errno(r
, "Failed to parse options: %m");
226 STRV_FOREACH(s
, names
) {
229 r
= unit_name_mangle_with_suffix(*s
, "as dependency", 0, ".mount", &x
);
231 return log_error_errno(r
, "Failed to generate unit name: %m");
232 r
= strv_consume(&units
, x
);
238 res
= strv_join(units
, " ");
241 #pragma GCC diagnostic push
242 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
243 fprintf(f
, format
, res
);
244 #pragma GCC diagnostic pop
250 static int write_after(FILE *f
, const char *opts
) {
251 return write_dependency(f
, opts
, "x-systemd.after", "After=%1$s\n");
254 static int write_requires_after(FILE *f
, const char *opts
) {
255 return write_dependency(f
, opts
,
256 "x-systemd.requires", "After=%1$s\nRequires=%1$s\n");
259 static int write_before(FILE *f
, const char *opts
) {
260 return write_dependency(f
, opts
,
261 "x-systemd.before", "Before=%1$s\n");
264 static int write_requires_mounts_for(FILE *f
, const char *opts
) {
265 _cleanup_strv_free_
char **paths
= NULL
, **paths_escaped
= NULL
;
266 _cleanup_free_
char *res
= NULL
;
272 r
= fstab_extract_values(opts
, "x-systemd.requires-mounts-for", &paths
);
274 return log_warning_errno(r
, "Failed to parse options: %m");
278 r
= specifier_escape_strv(paths
, &paths_escaped
);
280 return log_error_errno(r
, "Failed to escape paths: %m");
282 res
= strv_join(paths_escaped
, " ");
286 fprintf(f
, "RequiresMountsFor=%s\n", res
);
291 static int add_mount(
295 const char *original_where
,
299 MountpointFlags flags
,
301 const char *source
) {
305 *automount_name
= NULL
,
307 *where_escaped
= NULL
;
308 _cleanup_fclose_
FILE *f
= NULL
;
317 if (streq_ptr(fstype
, "autofs"))
320 if (!is_path(where
)) {
321 log_warning("Mount point %s is not a valid path, ignoring.", where
);
325 if (mount_point_is_api(where
) ||
326 mount_point_ignore(where
))
329 if (path_equal(where
, "/")) {
331 log_warning("Ignoring \"noauto\" for root device");
333 log_warning("Ignoring \"nofail\" for root device");
334 if (flags
& AUTOMOUNT
)
335 log_warning("Ignoring automount option for root device");
337 SET_FLAG(flags
, NOAUTO
| NOFAIL
| AUTOMOUNT
, false);
340 r
= unit_name_from_path(where
, ".mount", &name
);
342 return log_error_errno(r
, "Failed to generate unit name: %m");
344 r
= generator_open_unit_file(dest
, "/etc/fstab", name
, &f
);
351 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
354 /* All mounts under /sysroot need to happen later, at initrd-fs.target time. IOW, it's not
355 * technically part of the basic initrd filesystem itself, and so shouldn't inherit the default
356 * Before=local-fs.target dependency. */
357 if (in_initrd() && path_startswith(where
, "/sysroot"))
358 fprintf(f
, "DefaultDependencies=no\n");
360 if (STRPTR_IN_SET(fstype
, "nfs", "nfs4") && !(flags
& AUTOMOUNT
) &&
361 fstab_test_yes_no_option(opts
, "bg\0" "fg\0")) {
362 /* The default retry timeout that mount.nfs uses for 'bg' mounts
363 * is 10000 minutes, where as it uses 2 minutes for 'fg' mounts.
364 * As we are making 'bg' mounts look like an 'fg' mount to
365 * mount.nfs (so systemd can manage the job-control aspects of 'bg'),
366 * we need to explicitly preserve that default, and also ensure
367 * the systemd mount-timeout doesn't interfere.
368 * By placing these options first, they can be over-ridden by
369 * settings in /etc/fstab. */
370 opts
= strjoina("x-systemd.mount-timeout=infinity,retry=10000,", opts
, ",fg");
371 SET_FLAG(flags
, NOFAIL
, true);
374 if (!(flags
& NOFAIL
) && !(flags
& AUTOMOUNT
))
375 fprintf(f
, "Before=%s\n", post
);
377 if (!(flags
& AUTOMOUNT
) && opts
) {
378 r
= write_after(f
, opts
);
381 r
= write_requires_after(f
, opts
);
384 r
= write_before(f
, opts
);
387 r
= write_requires_mounts_for(f
, opts
);
393 r
= generator_write_fsck_deps(f
, dest
, what
, where
, fstype
);
398 fprintf(f
, "\n[Mount]\n");
400 fprintf(f
, "# Canonicalized from %s\n", original_where
);
402 where_escaped
= specifier_escape(where
);
405 fprintf(f
, "Where=%s\n", where_escaped
);
407 r
= write_what(f
, what
);
411 if (!isempty(fstype
) && !streq(fstype
, "auto")) {
412 _cleanup_free_
char *t
;
414 t
= specifier_escape(fstype
);
418 fprintf(f
, "Type=%s\n", t
);
421 r
= generator_write_timeouts(dest
, what
, where
, opts
, &filtered
);
425 r
= generator_write_device_deps(dest
, what
, where
, opts
);
429 r
= write_mount_timeout(f
, where
, opts
);
433 r
= write_options(f
, filtered
);
437 r
= fflush_and_check(f
);
439 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
441 if (flags
& MAKEFS
) {
442 r
= generator_hook_up_mkfs(dest
, what
, where
, fstype
);
447 if (flags
& GROWFS
) {
448 r
= generator_hook_up_growfs(dest
, where
, post
);
453 if (!(flags
& NOAUTO
) && !(flags
& AUTOMOUNT
)) {
454 r
= generator_add_symlink(dest
, post
,
455 (flags
& NOFAIL
) ? "wants" : "requires", name
);
460 if (flags
& AUTOMOUNT
) {
461 r
= unit_name_from_path(where
, ".automount", &automount_name
);
463 return log_error_errno(r
, "Failed to generate unit name: %m");
467 r
= generator_open_unit_file(dest
, "/etc/fstab", automount_name
, &f
);
474 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
477 fprintf(f
, "Before=%s\n", post
);
480 r
= write_after(f
, opts
);
483 r
= write_requires_after(f
, opts
);
486 r
= write_before(f
, opts
);
489 r
= write_requires_mounts_for(f
, opts
);
500 r
= write_idle_timeout(f
, where
, opts
);
504 r
= fflush_and_check(f
);
506 return log_error_errno(r
, "Failed to write unit file %s: %m", automount_name
);
508 r
= generator_add_symlink(dest
, post
,
509 (flags
& NOFAIL
) ? "wants" : "requires", automount_name
);
517 static int parse_fstab(bool initrd
) {
518 _cleanup_endmntent_
FILE *f
= NULL
;
519 const char *fstab_path
;
523 fstab_path
= initrd
? "/sysroot/etc/fstab" : "/etc/fstab";
524 log_debug("Parsing %s...", fstab_path
);
526 f
= setmntent(fstab_path
, "re");
531 return log_error_errno(errno
, "Failed to open %s: %m", fstab_path
);
534 while ((me
= getmntent(f
))) {
535 _cleanup_free_
char *where
= NULL
, *what
= NULL
, *canonical_where
= NULL
;
536 bool makefs
, growfs
, noauto
, nofail
;
539 if (initrd
&& !mount_in_initrd(me
))
542 what
= fstab_node_to_udev_node(me
->mnt_fsname
);
546 if (is_device_path(what
) && path_is_read_only_fs("/sys") > 0) {
547 log_info("Running in a container, ignoring fstab device entry for %s.", what
);
551 where
= strdup(me
->mnt_dir
);
555 if (is_path(where
)) {
556 path_simplify(where
, false);
558 /* Follow symlinks here; see 5261ba901845c084de5a8fd06500ed09bfb0bd80 which makes sense for
559 * mount units, but causes problems since it historically worked to have symlinks in e.g.
560 * /etc/fstab. So we canonicalize here. Note that we use CHASE_NONEXISTENT to handle the case
561 * where a symlink refers to another mount target; this works assuming the sub-mountpoint
562 * target is the final directory. */
563 r
= chase_symlinks(where
, initrd
? "/sysroot" : NULL
,
564 CHASE_PREFIX_ROOT
| CHASE_NONEXISTENT
,
565 &canonical_where
, NULL
);
566 if (r
< 0) /* If we can't canonicalize we continue on as if it wasn't a symlink */
567 log_debug_errno(r
, "Failed to read symlink target for %s, ignoring: %m", where
);
568 else if (streq(canonical_where
, where
)) /* If it was fully canonicalized, suppress the change */
569 canonical_where
= mfree(canonical_where
);
571 log_debug("Canonicalized what=%s where=%s to %s", what
, where
, canonical_where
);
574 makefs
= fstab_test_option(me
->mnt_opts
, "x-systemd.makefs\0");
575 growfs
= fstab_test_option(me
->mnt_opts
, "x-systemd.growfs\0");
576 noauto
= fstab_test_yes_no_option(me
->mnt_opts
, "noauto\0" "auto\0");
577 nofail
= fstab_test_yes_no_option(me
->mnt_opts
, "nofail\0" "fail\0");
579 log_debug("Found entry what=%s where=%s type=%s makefs=%s growfs=%s noauto=%s nofail=%s",
580 what
, where
, me
->mnt_type
,
581 yes_no(makefs
), yes_no(growfs
),
582 yes_no(noauto
), yes_no(nofail
));
584 if (streq(me
->mnt_type
, "swap"))
585 k
= add_swap(what
, me
,
586 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
);
591 automount
= fstab_test_option(me
->mnt_opts
,
592 "comment=systemd.automount\0"
593 "x-systemd.automount\0");
595 post
= SPECIAL_INITRD_FS_TARGET
;
596 else if (mount_is_network(me
))
597 post
= SPECIAL_REMOTE_FS_TARGET
;
599 post
= SPECIAL_LOCAL_FS_TARGET
;
601 k
= add_mount(arg_dest
,
603 canonical_where
?: where
,
604 canonical_where
? where
: NULL
,
608 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
| automount
*AUTOMOUNT
,
620 static int add_sysroot_mount(void) {
621 _cleanup_free_
char *what
= NULL
;
625 if (isempty(arg_root_what
)) {
626 log_debug("Could not find a root= entry on the kernel command line.");
630 if (streq(arg_root_what
, "gpt-auto")) {
631 /* This is handled by the gpt-auto generator */
632 log_debug("Skipping root directory handling, as gpt-auto was requested.");
636 if (path_equal(arg_root_what
, "/dev/nfs")) {
637 /* This is handled by the kernel or the initrd */
638 log_debug("Skipping root directory handling, as /dev/nfs was requested.");
642 what
= fstab_node_to_udev_node(arg_root_what
);
646 if (!arg_root_options
)
647 opts
= arg_root_rw
> 0 ? "rw" : "ro";
648 else if (arg_root_rw
>= 0 ||
649 !fstab_test_option(arg_root_options
, "ro\0" "rw\0"))
650 opts
= strjoina(arg_root_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
652 opts
= arg_root_options
;
654 log_debug("Found entry what=%s where=/sysroot type=%s", what
, strna(arg_root_fstype
));
656 if (is_device_path(what
)) {
657 r
= generator_write_initrd_root_device_deps(arg_dest
, what
);
662 return add_mount(arg_dest
,
668 is_device_path(what
) ? 1 : 0, /* passno */
669 0, /* makefs off, growfs off, noauto off, nofail off, automount off */
670 SPECIAL_INITRD_ROOT_FS_TARGET
,
674 static int add_sysroot_usr_mount(void) {
675 _cleanup_free_
char *what
= NULL
;
678 if (!arg_usr_what
&& !arg_usr_fstype
&& !arg_usr_options
)
681 if (arg_root_what
&& !arg_usr_what
) {
682 /* Copy over the root device, in case the /usr mount just differs in a mount option (consider btrfs subvolumes) */
683 arg_usr_what
= strdup(arg_root_what
);
688 if (arg_root_fstype
&& !arg_usr_fstype
) {
689 arg_usr_fstype
= strdup(arg_root_fstype
);
694 if (arg_root_options
&& !arg_usr_options
) {
695 arg_usr_options
= strdup(arg_root_options
);
696 if (!arg_usr_options
)
703 what
= fstab_node_to_udev_node(arg_usr_what
);
707 if (!arg_usr_options
)
708 opts
= arg_root_rw
> 0 ? "rw" : "ro";
709 else if (!fstab_test_option(arg_usr_options
, "ro\0" "rw\0"))
710 opts
= strjoina(arg_usr_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
712 opts
= arg_usr_options
;
714 log_debug("Found entry what=%s where=/sysroot/usr type=%s", what
, strna(arg_usr_fstype
));
715 return add_mount(arg_dest
,
721 is_device_path(what
) ? 1 : 0, /* passno */
723 SPECIAL_INITRD_FS_TARGET
,
727 static int add_volatile_root(void) {
729 /* Let's add in systemd-remount-volatile.service which will remount the root device to tmpfs if this is
730 * requested (or as an overlayfs), leaving only /usr from the root mount inside. */
732 if (!IN_SET(arg_volatile_mode
, VOLATILE_YES
, VOLATILE_OVERLAY
))
735 return generator_add_symlink(arg_dest
, SPECIAL_INITRD_ROOT_FS_TARGET
, "requires",
736 SYSTEM_DATA_UNIT_PATH
"/" SPECIAL_VOLATILE_ROOT_SERVICE
);
739 static int add_volatile_var(void) {
741 if (arg_volatile_mode
!= VOLATILE_STATE
)
744 /* If requested, mount /var as tmpfs, but do so only if there's nothing else defined for this. */
746 return add_mount(arg_dest_late
,
754 SPECIAL_LOCAL_FS_TARGET
,
758 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
761 /* root=, usr=, usrfstype= and roofstype= may occur more than once, the last
762 * instance should take precedence. In the case of multiple rootflags=
763 * or usrflags= the arguments should be concatenated */
765 if (STR_IN_SET(key
, "fstab", "rd.fstab")) {
767 r
= value
? parse_boolean(value
) : 1;
769 log_warning("Failed to parse fstab switch %s. Ignoring.", value
);
771 arg_fstab_enabled
= r
;
773 } else if (streq(key
, "root")) {
775 if (proc_cmdline_value_missing(key
, value
))
778 if (free_and_strdup(&arg_root_what
, value
) < 0)
781 } else if (streq(key
, "rootfstype")) {
783 if (proc_cmdline_value_missing(key
, value
))
786 if (free_and_strdup(&arg_root_fstype
, value
) < 0)
789 } else if (streq(key
, "rootflags")) {
791 if (proc_cmdline_value_missing(key
, value
))
794 if (!strextend_with_separator(&arg_root_options
, ",", value
, NULL
))
797 } else if (streq(key
, "roothash")) {
799 if (proc_cmdline_value_missing(key
, value
))
802 if (free_and_strdup(&arg_root_hash
, value
) < 0)
805 } else if (streq(key
, "mount.usr")) {
807 if (proc_cmdline_value_missing(key
, value
))
810 if (free_and_strdup(&arg_usr_what
, value
) < 0)
813 } else if (streq(key
, "mount.usrfstype")) {
815 if (proc_cmdline_value_missing(key
, value
))
818 if (free_and_strdup(&arg_usr_fstype
, value
) < 0)
821 } else if (streq(key
, "mount.usrflags")) {
823 if (proc_cmdline_value_missing(key
, value
))
826 if (!strextend_with_separator(&arg_usr_options
, ",", value
, NULL
))
829 } else if (streq(key
, "rw") && !value
)
831 else if (streq(key
, "ro") && !value
)
833 else if (streq(key
, "systemd.volatile")) {
837 m
= volatile_mode_from_string(value
);
839 log_warning("Failed to parse systemd.volatile= argument: %s", value
);
841 arg_volatile_mode
= m
;
843 arg_volatile_mode
= VOLATILE_YES
;
849 static int determine_root(void) {
850 /* If we have a root hash but no root device then Verity is used, and we use the "root" DM device as root. */
858 arg_root_what
= strdup("/dev/mapper/root");
862 log_info("Using verity root device %s.", arg_root_what
);
867 static int run(const char *dest
, const char *dest_early
, const char *dest_late
) {
868 int r
, r2
= 0, r3
= 0;
870 assert_se(arg_dest
= dest
);
871 assert_se(arg_dest_late
= dest_late
);
873 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, 0);
875 log_warning_errno(r
, "Failed to parse kernel command line, ignoring: %m");
877 (void) determine_root();
879 /* Always honour root= and usr= in the kernel command line if we are in an initrd */
881 r
= add_sysroot_mount();
883 r2
= add_sysroot_usr_mount();
885 r3
= add_volatile_root();
887 r
= add_volatile_var();
889 /* Honour /etc/fstab only when that's enabled */
890 if (arg_fstab_enabled
) {
891 /* Parse the local /etc/fstab, possibly from the initrd */
892 r2
= parse_fstab(false);
894 /* If running in the initrd also parse the /etc/fstab from the host */
896 r3
= parse_fstab(true);
898 r3
= generator_enable_remount_fs_service(arg_dest
);
901 return r
< 0 ? r
: r2
< 0 ? r2
: r3
;
904 DEFINE_MAIN_GENERATOR_FUNCTION(run
);