1 /* SPDX-License-Identifier: LGPL-2.1+ */
10 #include "alloc-util.h"
14 #include "fstab-util.h"
15 #include "generator.h"
17 #include "main-func.h"
19 #include "mount-setup.h"
20 #include "mount-util.h"
21 #include "mountpoint-util.h"
22 #include "parse-util.h"
23 #include "path-util.h"
24 #include "proc-cmdline.h"
26 #include "specifier.h"
27 #include "stat-util.h"
28 #include "string-util.h"
30 #include "unit-name.h"
33 #include "volatile-util.h"
35 typedef enum MountpointFlags
{
43 static const char *arg_dest
= "/tmp";
44 static const char *arg_dest_late
= "/tmp";
45 static bool arg_fstab_enabled
= true;
46 static char *arg_root_what
= NULL
;
47 static char *arg_root_fstype
= NULL
;
48 static char *arg_root_options
= NULL
;
49 static char *arg_root_hash
= NULL
;
50 static int arg_root_rw
= -1;
51 static char *arg_usr_what
= NULL
;
52 static char *arg_usr_fstype
= NULL
;
53 static char *arg_usr_options
= NULL
;
54 static VolatileMode arg_volatile_mode
= _VOLATILE_MODE_INVALID
;
56 STATIC_DESTRUCTOR_REGISTER(arg_root_what
, freep
);
57 STATIC_DESTRUCTOR_REGISTER(arg_root_fstype
, freep
);
58 STATIC_DESTRUCTOR_REGISTER(arg_root_options
, freep
);
59 STATIC_DESTRUCTOR_REGISTER(arg_root_hash
, freep
);
60 STATIC_DESTRUCTOR_REGISTER(arg_usr_what
, freep
);
61 STATIC_DESTRUCTOR_REGISTER(arg_usr_fstype
, freep
);
62 STATIC_DESTRUCTOR_REGISTER(arg_usr_options
, freep
);
65 static int write_options(FILE *f
, const char *options
) {
66 _cleanup_free_
char *o
= NULL
;
71 if (streq(options
, "defaults"))
74 o
= specifier_escape(options
);
78 fprintf(f
, "Options=%s\n", o
);
82 static int write_what(FILE *f
, const char *what
) {
83 _cleanup_free_
char *w
= NULL
;
85 w
= specifier_escape(what
);
89 fprintf(f
, "What=%s\n", w
);
96 MountpointFlags flags
) {
98 _cleanup_free_
char *name
= NULL
;
99 _cleanup_fclose_
FILE *f
= NULL
;
105 if (access("/proc/swaps", F_OK
) < 0) {
106 log_info("Swap not supported, ignoring fstab swap entry for %s.", what
);
110 if (detect_container() > 0) {
111 log_info("Running in a container, ignoring fstab swap entry for %s.", what
);
115 r
= unit_name_from_path(what
, ".swap", &name
);
117 return log_error_errno(r
, "Failed to generate unit name: %m");
119 r
= generator_open_unit_file(arg_dest
, "/etc/fstab", name
, &f
);
123 fputs("# Automatically generated by systemd-fstab-generator\n\n"
125 "SourcePath=/etc/fstab\n"
126 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n\n"
129 r
= write_what(f
, what
);
133 r
= write_options(f
, me
->mnt_opts
);
137 r
= fflush_and_check(f
);
139 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
141 /* use what as where, to have a nicer error message */
142 r
= generator_write_timeouts(arg_dest
, what
, what
, me
->mnt_opts
, NULL
);
146 if (flags
& MAKEFS
) {
147 r
= generator_hook_up_mkswap(arg_dest
, what
);
153 /* TODO: swap devices must be wiped and recreated */
154 log_warning("%s: growing swap devices is currently unsupported.", what
);
156 if (!(flags
& NOAUTO
)) {
157 r
= generator_add_symlink(arg_dest
, SPECIAL_SWAP_TARGET
,
158 (flags
& NOFAIL
) ? "wants" : "requires", name
);
166 static bool mount_is_network(struct mntent
*me
) {
169 return fstab_test_option(me
->mnt_opts
, "_netdev\0") ||
170 fstype_is_network(me
->mnt_type
);
173 static bool mount_in_initrd(struct mntent
*me
) {
176 return fstab_test_option(me
->mnt_opts
, "x-initrd.mount\0") ||
177 streq(me
->mnt_dir
, "/usr");
180 static int write_timeout(FILE *f
, const char *where
, const char *opts
,
181 const char *filter
, const char *variable
) {
182 _cleanup_free_
char *timeout
= NULL
;
183 char timespan
[FORMAT_TIMESPAN_MAX
];
187 r
= fstab_filter_options(opts
, filter
, NULL
, &timeout
, NULL
);
189 return log_warning_errno(r
, "Failed to parse options: %m");
193 r
= parse_sec_fix_0(timeout
, &u
);
195 log_warning("Failed to parse timeout for %s, ignoring: %s", where
, timeout
);
199 fprintf(f
, "%s=%s\n", variable
, format_timespan(timespan
, sizeof(timespan
), u
, 0));
204 static int write_idle_timeout(FILE *f
, const char *where
, const char *opts
) {
205 return write_timeout(f
, where
, opts
,
206 "x-systemd.idle-timeout\0", "TimeoutIdleSec");
209 static int write_mount_timeout(FILE *f
, const char *where
, const char *opts
) {
210 return write_timeout(f
, where
, opts
,
211 "x-systemd.mount-timeout\0", "TimeoutSec");
214 static int write_dependency(FILE *f
, const char *opts
,
215 const char *filter
, const char *format
) {
216 _cleanup_strv_free_
char **names
= NULL
, **units
= NULL
;
217 _cleanup_free_
char *res
= NULL
;
224 r
= fstab_extract_values(opts
, filter
, &names
);
226 return log_warning_errno(r
, "Failed to parse options: %m");
230 STRV_FOREACH(s
, names
) {
233 r
= unit_name_mangle_with_suffix(*s
, 0, ".mount", &x
);
235 return log_error_errno(r
, "Failed to generate unit name: %m");
236 r
= strv_consume(&units
, x
);
242 res
= strv_join(units
, " ");
245 #pragma GCC diagnostic push
246 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
247 fprintf(f
, format
, res
);
248 #pragma GCC diagnostic pop
254 static int write_after(FILE *f
, const char *opts
) {
255 return write_dependency(f
, opts
, "x-systemd.after", "After=%1$s\n");
258 static int write_requires_after(FILE *f
, const char *opts
) {
259 return write_dependency(f
, opts
,
260 "x-systemd.requires", "After=%1$s\nRequires=%1$s\n");
263 static int write_before(FILE *f
, const char *opts
) {
264 return write_dependency(f
, opts
,
265 "x-systemd.before", "Before=%1$s\n");
268 static int write_requires_mounts_for(FILE *f
, const char *opts
) {
269 _cleanup_strv_free_
char **paths
= NULL
, **paths_escaped
= NULL
;
270 _cleanup_free_
char *res
= NULL
;
276 r
= fstab_extract_values(opts
, "x-systemd.requires-mounts-for", &paths
);
278 return log_warning_errno(r
, "Failed to parse options: %m");
282 r
= specifier_escape_strv(paths
, &paths_escaped
);
284 return log_error_errno(r
, "Failed to escape paths: %m");
286 res
= strv_join(paths_escaped
, " ");
290 fprintf(f
, "RequiresMountsFor=%s\n", res
);
295 static int add_mount(
299 const char *original_where
,
303 MountpointFlags flags
,
305 const char *source
) {
309 *automount_name
= NULL
,
311 *where_escaped
= NULL
;
312 _cleanup_fclose_
FILE *f
= NULL
;
321 if (streq_ptr(fstype
, "autofs"))
324 if (!is_path(where
)) {
325 log_warning("Mount point %s is not a valid path, ignoring.", where
);
329 if (mount_point_is_api(where
) ||
330 mount_point_ignore(where
))
333 if (path_equal(where
, "/")) {
335 log_warning("Ignoring \"noauto\" for root device");
337 log_warning("Ignoring \"nofail\" for root device");
338 if (flags
& AUTOMOUNT
)
339 log_warning("Ignoring automount option for root device");
341 SET_FLAG(flags
, NOAUTO
| NOFAIL
| AUTOMOUNT
, false);
344 r
= unit_name_from_path(where
, ".mount", &name
);
346 return log_error_errno(r
, "Failed to generate unit name: %m");
348 r
= generator_open_unit_file(dest
, "/etc/fstab", name
, &f
);
355 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
358 if (STRPTR_IN_SET(fstype
, "nfs", "nfs4") && !(flags
& AUTOMOUNT
) &&
359 fstab_test_yes_no_option(opts
, "bg\0" "fg\0")) {
360 /* The default retry timeout that mount.nfs uses for 'bg' mounts
361 * is 10000 minutes, where as it uses 2 minutes for 'fg' mounts.
362 * As we are making 'bg' mounts look like an 'fg' mount to
363 * mount.nfs (so systemd can manage the job-control aspects of 'bg'),
364 * we need to explicitly preserve that default, and also ensure
365 * the systemd mount-timeout doesn't interfere.
366 * By placing these options first, they can be over-ridden by
367 * settings in /etc/fstab. */
368 opts
= strjoina("x-systemd.mount-timeout=infinity,retry=10000,", opts
, ",fg");
369 SET_FLAG(flags
, NOFAIL
, true);
372 if (!(flags
& NOFAIL
) && !(flags
& AUTOMOUNT
))
373 fprintf(f
, "Before=%s\n", post
);
375 if (!(flags
& AUTOMOUNT
) && opts
) {
376 r
= write_after(f
, opts
);
379 r
= write_requires_after(f
, opts
);
382 r
= write_before(f
, opts
);
385 r
= write_requires_mounts_for(f
, opts
);
391 r
= generator_write_fsck_deps(f
, dest
, what
, where
, fstype
);
396 fprintf(f
, "\n[Mount]\n");
398 fprintf(f
, "# Canonicalized from %s\n", original_where
);
400 where_escaped
= specifier_escape(where
);
403 fprintf(f
, "Where=%s\n", where_escaped
);
405 r
= write_what(f
, what
);
409 if (!isempty(fstype
) && !streq(fstype
, "auto")) {
410 _cleanup_free_
char *t
;
412 t
= specifier_escape(fstype
);
416 fprintf(f
, "Type=%s\n", t
);
419 r
= generator_write_timeouts(dest
, what
, where
, opts
, &filtered
);
423 r
= generator_write_device_deps(dest
, what
, where
, opts
);
427 r
= write_mount_timeout(f
, where
, opts
);
431 r
= write_options(f
, filtered
);
435 r
= fflush_and_check(f
);
437 return log_error_errno(r
, "Failed to write unit file %s: %m", name
);
439 if (flags
& MAKEFS
) {
440 r
= generator_hook_up_mkfs(dest
, what
, where
, fstype
);
445 if (flags
& GROWFS
) {
446 r
= generator_hook_up_growfs(dest
, where
, post
);
451 if (!(flags
& NOAUTO
) && !(flags
& AUTOMOUNT
)) {
452 r
= generator_add_symlink(dest
, post
,
453 (flags
& NOFAIL
) ? "wants" : "requires", name
);
458 if (flags
& AUTOMOUNT
) {
459 r
= unit_name_from_path(where
, ".automount", &automount_name
);
461 return log_error_errno(r
, "Failed to generate unit name: %m");
465 r
= generator_open_unit_file(dest
, "/etc/fstab", automount_name
, &f
);
472 "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n",
475 fprintf(f
, "Before=%s\n", post
);
478 r
= write_after(f
, opts
);
481 r
= write_requires_after(f
, opts
);
484 r
= write_before(f
, opts
);
487 r
= write_requires_mounts_for(f
, opts
);
498 r
= write_idle_timeout(f
, where
, opts
);
502 r
= fflush_and_check(f
);
504 return log_error_errno(r
, "Failed to write unit file %s: %m", automount_name
);
506 r
= generator_add_symlink(dest
, post
,
507 (flags
& NOFAIL
) ? "wants" : "requires", automount_name
);
515 static int parse_fstab(bool initrd
) {
516 _cleanup_endmntent_
FILE *f
= NULL
;
517 const char *fstab_path
;
521 fstab_path
= initrd
? "/sysroot/etc/fstab" : "/etc/fstab";
522 f
= setmntent(fstab_path
, "re");
527 return log_error_errno(errno
, "Failed to open %s: %m", fstab_path
);
530 while ((me
= getmntent(f
))) {
531 _cleanup_free_
char *where
= NULL
, *what
= NULL
, *canonical_where
= NULL
;
532 bool makefs
, growfs
, noauto
, nofail
;
535 if (initrd
&& !mount_in_initrd(me
))
538 what
= fstab_node_to_udev_node(me
->mnt_fsname
);
542 if (is_device_path(what
) && path_is_read_only_fs("sys") > 0) {
543 log_info("Running in a container, ignoring fstab device entry for %s.", what
);
547 where
= strdup(me
->mnt_dir
);
551 if (is_path(where
)) {
552 path_simplify(where
, false);
554 /* Follow symlinks here; see 5261ba901845c084de5a8fd06500ed09bfb0bd80 which makes sense for
555 * mount units, but causes problems since it historically worked to have symlinks in e.g.
556 * /etc/fstab. So we canonicalize here. Note that we use CHASE_NONEXISTENT to handle the case
557 * where a symlink refers to another mount target; this works assuming the sub-mountpoint
558 * target is the final directory. */
559 r
= chase_symlinks(where
, initrd
? "/sysroot" : NULL
,
560 CHASE_PREFIX_ROOT
| CHASE_NONEXISTENT
,
562 if (r
< 0) /* If we can't canonicalize we continue on as if it wasn't a symlink */
563 log_debug_errno(r
, "Failed to read symlink target for %s, ignoring: %m", where
);
564 else if (streq(canonical_where
, where
)) /* If it was fully canonicalized, suppress the change */
565 canonical_where
= mfree(canonical_where
);
567 log_debug("Canonicalized what=%s where=%s to %s", what
, where
, canonical_where
);
570 makefs
= fstab_test_option(me
->mnt_opts
, "x-systemd.makefs\0");
571 growfs
= fstab_test_option(me
->mnt_opts
, "x-systemd.growfs\0");
572 noauto
= fstab_test_yes_no_option(me
->mnt_opts
, "noauto\0" "auto\0");
573 nofail
= fstab_test_yes_no_option(me
->mnt_opts
, "nofail\0" "fail\0");
575 log_debug("Found entry what=%s where=%s type=%s makefs=%s nofail=%s noauto=%s",
576 what
, where
, me
->mnt_type
,
578 yes_no(noauto
), yes_no(nofail
));
580 if (streq(me
->mnt_type
, "swap"))
581 k
= add_swap(what
, me
,
582 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
);
587 automount
= fstab_test_option(me
->mnt_opts
,
588 "comment=systemd.automount\0"
589 "x-systemd.automount\0");
591 post
= SPECIAL_INITRD_FS_TARGET
;
592 else if (mount_is_network(me
))
593 post
= SPECIAL_REMOTE_FS_TARGET
;
595 post
= SPECIAL_LOCAL_FS_TARGET
;
597 k
= add_mount(arg_dest
,
599 canonical_where
?: where
,
600 canonical_where
? where
: NULL
,
604 makefs
*MAKEFS
| growfs
*GROWFS
| noauto
*NOAUTO
| nofail
*NOFAIL
| automount
*AUTOMOUNT
,
616 static int add_sysroot_mount(void) {
617 _cleanup_free_
char *what
= NULL
;
621 if (isempty(arg_root_what
)) {
622 log_debug("Could not find a root= entry on the kernel command line.");
626 if (streq(arg_root_what
, "gpt-auto")) {
627 /* This is handled by the gpt-auto generator */
628 log_debug("Skipping root directory handling, as gpt-auto was requested.");
632 if (path_equal(arg_root_what
, "/dev/nfs")) {
633 /* This is handled by the kernel or the initrd */
634 log_debug("Skipping root directory handling, as /dev/nfs was requested.");
638 what
= fstab_node_to_udev_node(arg_root_what
);
642 if (!arg_root_options
)
643 opts
= arg_root_rw
> 0 ? "rw" : "ro";
644 else if (arg_root_rw
>= 0 ||
645 !fstab_test_option(arg_root_options
, "ro\0" "rw\0"))
646 opts
= strjoina(arg_root_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
648 opts
= arg_root_options
;
650 log_debug("Found entry what=%s where=/sysroot type=%s", what
, strna(arg_root_fstype
));
652 if (is_device_path(what
)) {
653 r
= generator_write_initrd_root_device_deps(arg_dest
, what
);
658 return add_mount(arg_dest
,
664 is_device_path(what
) ? 1 : 0, /* passno */
665 0, /* makefs off, growfs off, noauto off, nofail off, automount off */
666 SPECIAL_INITRD_ROOT_FS_TARGET
,
670 static int add_sysroot_usr_mount(void) {
671 _cleanup_free_
char *what
= NULL
;
674 if (!arg_usr_what
&& !arg_usr_fstype
&& !arg_usr_options
)
677 if (arg_root_what
&& !arg_usr_what
) {
678 /* Copy over the root device, in case the /usr mount just differs in a mount option (consider btrfs subvolumes) */
679 arg_usr_what
= strdup(arg_root_what
);
684 if (arg_root_fstype
&& !arg_usr_fstype
) {
685 arg_usr_fstype
= strdup(arg_root_fstype
);
690 if (arg_root_options
&& !arg_usr_options
) {
691 arg_usr_options
= strdup(arg_root_options
);
692 if (!arg_usr_options
)
699 what
= fstab_node_to_udev_node(arg_usr_what
);
703 if (!arg_usr_options
)
704 opts
= arg_root_rw
> 0 ? "rw" : "ro";
705 else if (!fstab_test_option(arg_usr_options
, "ro\0" "rw\0"))
706 opts
= strjoina(arg_usr_options
, ",", arg_root_rw
> 0 ? "rw" : "ro");
708 opts
= arg_usr_options
;
710 log_debug("Found entry what=%s where=/sysroot/usr type=%s", what
, strna(arg_usr_fstype
));
711 return add_mount(arg_dest
,
717 is_device_path(what
) ? 1 : 0, /* passno */
719 SPECIAL_INITRD_FS_TARGET
,
723 static int add_volatile_root(void) {
724 const char *from
, *to
;
726 if (arg_volatile_mode
!= VOLATILE_YES
)
729 /* Let's add in systemd-remount-volatile.service which will remount the root device to tmpfs if this is
730 * requested, leaving only /usr from the root mount inside. */
732 from
= strjoina(SYSTEM_DATA_UNIT_PATH
"/systemd-volatile-root.service");
733 to
= strjoina(arg_dest
, "/" SPECIAL_INITRD_ROOT_FS_TARGET
, ".requires/systemd-volatile-root.service");
735 (void) mkdir_parents(to
, 0755);
737 if (symlink(from
, to
) < 0)
738 return log_error_errno(errno
, "Failed to hook in volatile remount service: %m");
743 static int add_volatile_var(void) {
745 if (arg_volatile_mode
!= VOLATILE_STATE
)
748 /* If requested, mount /var as tmpfs, but do so only if there's nothing else defined for this. */
750 return add_mount(arg_dest_late
,
758 SPECIAL_LOCAL_FS_TARGET
,
762 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
765 /* root=, usr=, usrfstype= and roofstype= may occur more than once, the last
766 * instance should take precedence. In the case of multiple rootflags=
767 * or usrflags= the arguments should be concatenated */
769 if (STR_IN_SET(key
, "fstab", "rd.fstab")) {
771 r
= value
? parse_boolean(value
) : 1;
773 log_warning("Failed to parse fstab switch %s. Ignoring.", value
);
775 arg_fstab_enabled
= r
;
777 } else if (streq(key
, "root")) {
779 if (proc_cmdline_value_missing(key
, value
))
782 if (free_and_strdup(&arg_root_what
, value
) < 0)
785 } else if (streq(key
, "rootfstype")) {
787 if (proc_cmdline_value_missing(key
, value
))
790 if (free_and_strdup(&arg_root_fstype
, value
) < 0)
793 } else if (streq(key
, "rootflags")) {
795 if (proc_cmdline_value_missing(key
, value
))
798 if (!strextend_with_separator(&arg_root_options
, ",", value
, NULL
))
801 } else if (streq(key
, "roothash")) {
803 if (proc_cmdline_value_missing(key
, value
))
806 if (free_and_strdup(&arg_root_hash
, value
) < 0)
809 } else if (streq(key
, "mount.usr")) {
811 if (proc_cmdline_value_missing(key
, value
))
814 if (free_and_strdup(&arg_usr_what
, value
) < 0)
817 } else if (streq(key
, "mount.usrfstype")) {
819 if (proc_cmdline_value_missing(key
, value
))
822 if (free_and_strdup(&arg_usr_fstype
, value
) < 0)
825 } else if (streq(key
, "mount.usrflags")) {
827 if (proc_cmdline_value_missing(key
, value
))
830 if (!strextend_with_separator(&arg_usr_options
, ",", value
, NULL
))
833 } else if (streq(key
, "rw") && !value
)
835 else if (streq(key
, "ro") && !value
)
837 else if (streq(key
, "systemd.volatile")) {
841 m
= volatile_mode_from_string(value
);
843 log_warning("Failed to parse systemd.volatile= argument: %s", value
);
845 arg_volatile_mode
= m
;
847 arg_volatile_mode
= VOLATILE_YES
;
853 static int determine_root(void) {
854 /* If we have a root hash but no root device then Verity is used, and we use the "root" DM device as root. */
862 arg_root_what
= strdup("/dev/mapper/root");
866 log_info("Using verity root device %s.", arg_root_what
);
871 static int run(int argc
, char *argv
[]) {
874 if (argc
> 1 && argc
!= 4)
875 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
876 "This program takes three or no arguments.");
881 arg_dest_late
= argv
[3];
883 log_setup_generator();
885 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, 0);
887 log_warning_errno(r
, "Failed to parse kernel command line, ignoring: %m");
889 (void) determine_root();
891 /* Always honour root= and usr= in the kernel command line if we are in an initrd */
895 r
= add_sysroot_mount();
897 k
= add_sysroot_usr_mount();
901 k
= add_volatile_root();
905 r
= add_volatile_var();
907 /* Honour /etc/fstab only when that's enabled */
908 if (arg_fstab_enabled
) {
911 log_debug("Parsing /etc/fstab");
913 /* Parse the local /etc/fstab, possibly from the initrd */
914 k
= parse_fstab(false);
918 /* If running in the initrd also parse the /etc/fstab from the host */
920 log_debug("Parsing /sysroot/etc/fstab");
922 k
= parse_fstab(true);
931 DEFINE_MAIN_FUNCTION(run
);