2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2001 Dima Dorfman.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * mdmfs (md/MFS) is a wrapper around mdconfig(8),
31 * newfs(8), and mount(8) that mimics the command line option set of
32 * the deprecated mount_mfs(8).
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/linker.h>
40 #include <sys/mdioctl.h>
41 #include <sys/module.h>
42 #include <sys/mount.h>
61 typedef enum { false, true } bool;
73 static bool debug; /* Emit debugging information? */
74 static bool loudsubs; /* Suppress output from helper programs? */
75 static bool norun; /* Actually run the helper programs? */
76 static int unit; /* The unit we're working with. */
77 static const char *mdname; /* Name of memory disk device (e.g., "md"). */
78 static const char *mdsuffix; /* Suffix of memory disk device (e.g., ".uzip"). */
79 static size_t mdnamelen; /* Length of mdname. */
80 static const char *path_mdconfig =_PATH_MDCONFIG;
82 static void argappend(char **, const char *, ...) __printflike(2, 3);
83 static void debugprintf(const char *, ...) __printflike(1, 2);
84 static void do_mdconfig_attach(const char *, const enum md_types);
85 static void do_mdconfig_attach_au(const char *, const enum md_types);
86 static void do_mdconfig_detach(void);
87 static void do_mount_md(const char *, const char *);
88 static void do_mount_tmpfs(const char *, const char *);
89 static void do_mtptsetup(const char *, struct mtpt_info *);
90 static void do_newfs(const char *);
91 static void extract_ugid(const char *, struct mtpt_info *);
92 static int run(int *, const char *, ...) __printflike(2, 3);
93 static void usage(void);
96 main(int argc, char **argv)
98 struct mtpt_info mi; /* Mountpoint info. */
100 char *mdconfig_arg, *newfs_arg, /* Args to helper programs. */
102 enum md_types mdtype; /* The type of our memory disk. */
103 bool have_mdtype, mlmac;
104 bool detach, softdep, autounit, newfs;
105 const char *mtpoint, *size_arg, *unitstr;
111 /* Misc. initialization. */
112 (void)memset(&mi, '\0', sizeof(mi));
121 mdnamelen = strlen(mdname);
124 * Can't set these to NULL. They may be passed to the
125 * respective programs without modification. I.e., we may not
126 * receive any command-line options which will caused them to
129 mdconfig_arg = strdup("");
130 newfs_arg = strdup("");
131 mount_arg = strdup("");
134 /* If we were started as mount_mfs or mfs, imply -C. */
135 if (strcmp(getprogname(), "mount_mfs") == 0 ||
136 strcmp(getprogname(), "mfs") == 0) {
137 /* Make compatibility assumptions. */
139 mi.mi_have_mode = true;
142 while ((ch = getopt(argc, argv,
143 "a:b:Cc:Dd:E:e:F:f:hi:LlMm:NnO:o:Pp:Ss:tT:Uv:w:X")) != -1)
146 argappend(&newfs_arg, "-a %s", optarg);
149 argappend(&newfs_arg, "-b %s", optarg);
152 /* Ignored for compatibility. */
155 argappend(&newfs_arg, "-c %s", optarg);
161 argappend(&newfs_arg, "-d %s", optarg);
164 path_mdconfig = optarg;
167 argappend(&newfs_arg, "-e %s", optarg);
174 argappend(&mdconfig_arg, "-f %s", optarg);
177 argappend(&newfs_arg, "-f %s", optarg);
183 argappend(&newfs_arg, "-i %s", optarg);
190 argappend(&newfs_arg, "-l");
197 argappend(&mdconfig_arg, "-o reserve");
200 argappend(&newfs_arg, "-m %s", optarg);
206 argappend(&newfs_arg, "-n");
209 argappend(&newfs_arg, "-o %s", optarg);
212 argappend(&mount_arg, "-o %s", optarg);
218 if ((set = setmode(optarg)) == NULL)
220 mi.mi_mode = getmode(set, S_IRWXU | S_IRWXG | S_IRWXO);
221 mi.mi_have_mode = true;
222 mi.mi_forced_pw = true;
232 argappend(&newfs_arg, "-t");
235 argappend(&mount_arg, "-t %s", optarg);
241 argappend(&newfs_arg, "-O %s", optarg);
244 extract_ugid(optarg, &mi);
245 mi.mi_forced_pw = true;
259 * Historically our size arg was passed directly to mdconfig, which
260 * treats a number without a suffix as a count of 512-byte sectors;
261 * tmpfs would treat it as a count of bytes. To get predictable
262 * behavior for 'auto' we document that the size always uses mdconfig
263 * rules. To make that work, decode the size here so it can be passed
264 * to either tmpfs or mdconfig as a count of bytes.
266 if (size_arg != NULL) {
267 mdsize = (intmax_t)strtoumax(size_arg, &p, 0);
268 if (p == size_arg || (p[0] != 0 && p[1] != 0) || mdsize < 0)
269 errx(1, "invalid size '%s'", size_arg);
293 errx(1, "invalid size suffix on '%s'", size_arg);
298 * Based on the command line 'md-device' either mount a tmpfs filesystem
299 * or configure the md device then format and mount a filesystem on it.
300 * If the device is 'auto' use tmpfs if it is available and there is no
301 * request for multilabel MAC (which tmpfs does not support).
306 if (strcmp(unitstr, "auto") == 0) {
308 idx = -1; /* Must use md for mlmac. */
309 else if ((idx = modfind("tmpfs")) == -1)
310 idx = kldload("tmpfs");
317 if (strcmp(unitstr, "tmpfs") == 0) {
318 if (size_arg != NULL && mdsize != 0)
319 argappend(&mount_arg, "-o size=%jd", mdsize);
320 do_mount_tmpfs(mount_arg, mtpoint);
322 if (size_arg != NULL)
323 argappend(&mdconfig_arg, "-s %jdB", mdsize);
324 if (strncmp(unitstr, "/dev/", 5) == 0)
326 if (strncmp(unitstr, mdname, mdnamelen) == 0)
327 unitstr += mdnamelen;
328 if (!isdigit(*unitstr)) {
333 ul = strtoul(unitstr, &p, 10);
335 errx(1, "bad device unit: %s", unitstr);
337 mdsuffix = p; /* can be empty */
343 argappend(&newfs_arg, "-U");
344 if (mdtype != MD_VNODE && !newfs)
345 errx(1, "-P requires a vnode-backed disk");
348 if (detach && !autounit)
349 do_mdconfig_detach();
351 do_mdconfig_attach_au(mdconfig_arg, mdtype);
353 do_mdconfig_attach(mdconfig_arg, mdtype);
356 do_mount_md(mount_arg, mtpoint);
359 do_mtptsetup(mtpoint, &mi);
365 * Append the expansion of 'fmt' to the buffer pointed to by '*dstp';
366 * reallocate as required.
369 argappend(char **dstp, const char *fmt, ...)
378 if (vasprintf(&new, fmt,ap) == -1)
379 errx(1, "vasprintf");
383 if (asprintf(&new, "%s %s", old, new) == -1)
392 * If run-time debugging is enabled, print the expansion of 'fmt'.
393 * Otherwise, do nothing.
396 debugprintf(const char *fmt, ...)
402 fprintf(stderr, "DEBUG: ");
404 vfprintf(stderr, fmt, ap);
406 fprintf(stderr, "\n");
411 * Attach a memory disk with a known unit.
414 do_mdconfig_attach(const char *args, const enum md_types mdtype)
417 const char *ta; /* Type arg. */
432 rv = run(NULL, "%s -a %s%s -u %s%d", path_mdconfig, ta, args,
435 errx(1, "mdconfig (attach) exited with error code %d", rv);
439 * Attach a memory disk with an unknown unit; use autounit.
442 do_mdconfig_attach_au(const char *args, const enum md_types mdtype)
444 const char *ta; /* Type arg. */
446 char linebuf[12]; /* 32-bit unit (10) + '\n' (1) + '\0' (1) */
447 int fd; /* Standard output of mdconfig invocation. */
467 rv = run(&fd, "%s -a %s%s", path_mdconfig, ta, args);
469 errx(1, "mdconfig (attach) exited with error code %d", rv);
471 /* Receive the unit number. */
472 if (norun) { /* Since we didn't run, we can't read. Fake it. */
476 sfd = fdopen(fd, "r");
479 linep = fgetln(sfd, &linelen);
480 /* If the output format changes, we want to know about it. */
481 if (linep == NULL || linelen <= mdnamelen + 1 ||
482 linelen - mdnamelen >= sizeof(linebuf) ||
483 strncmp(linep, mdname, mdnamelen) != 0)
484 errx(1, "unexpected output from mdconfig (attach)");
486 linelen -= mdnamelen;
487 /* Can't use strlcpy because linep is not NULL-terminated. */
488 strncpy(linebuf, linep, linelen);
489 linebuf[linelen] = '\0';
490 ul = strtoul(linebuf, &p, 10);
491 if (ul == ULONG_MAX || *p != '\n')
492 errx(1, "unexpected output from mdconfig (attach)");
499 * Detach a memory disk.
502 do_mdconfig_detach(void)
506 rv = run(NULL, "%s -d -u %s%d", path_mdconfig, mdname, unit);
507 if (rv && debug) /* This is allowed to fail. */
508 warnx("mdconfig (detach) exited with error code %d (ignored)",
513 * Mount the configured memory disk.
516 do_mount_md(const char *args, const char *mtpoint)
520 rv = run(NULL, "%s%s /dev/%s%d%s %s", _PATH_MOUNT, args,
521 mdname, unit, mdsuffix, mtpoint);
523 errx(1, "mount exited with error code %d", rv);
527 * Mount the configured tmpfs.
530 do_mount_tmpfs(const char *args, const char *mtpoint)
534 rv = run(NULL, "%s -t tmpfs %s tmp %s", _PATH_MOUNT, args, mtpoint);
536 errx(1, "tmpfs mount exited with error code %d", rv);
540 * Various configuration of the mountpoint. Mostly, enact 'mip'.
543 do_mtptsetup(const char *mtpoint, struct mtpt_info *mip)
547 if (!mip->mi_have_mode && !mip->mi_have_uid && !mip->mi_have_gid)
551 if (statfs(mtpoint, &sfs) == -1) {
552 warn("statfs: %s", mtpoint);
555 if ((sfs.f_flags & MNT_RDONLY) != 0) {
556 if (mip->mi_forced_pw) {
558 "Not changing mode/owner of %s since it is read-only",
562 "Not changing mode/owner of %s since it is read-only",
569 if (mip->mi_have_mode) {
570 debugprintf("changing mode of %s to %o.", mtpoint,
573 if (chmod(mtpoint, mip->mi_mode) == -1)
574 err(1, "chmod: %s", mtpoint);
577 * We have to do these separately because the user may have
578 * only specified one of them.
580 if (mip->mi_have_uid) {
581 debugprintf("changing owner (user) or %s to %u.", mtpoint,
584 if (chown(mtpoint, mip->mi_uid, -1) == -1)
585 err(1, "chown %s to %u (user)", mtpoint,
588 if (mip->mi_have_gid) {
589 debugprintf("changing owner (group) or %s to %u.", mtpoint,
592 if (chown(mtpoint, -1, mip->mi_gid) == -1)
593 err(1, "chown %s to %u (group)", mtpoint,
599 * Put a file system on the memory disk.
602 do_newfs(const char *args)
606 rv = run(NULL, "%s%s /dev/%s%d", _PATH_NEWFS, args, mdname, unit);
608 errx(1, "newfs exited with error code %d", rv);
612 * 'str' should be a user and group name similar to the last argument
613 * to chown(1); i.e., a user, followed by a colon, followed by a
614 * group. The user and group in 'str' may be either a [ug]id or a
615 * name. Upon return, the uid and gid fields in 'mip' will contain
616 * the uid and gid of the user and group name in 'str', respectively.
618 * In other words, this derives a user and group id from a string
619 * formatted like the last argument to chown(1).
621 * Notice: At this point we don't support only a username or only a
622 * group name. do_mtptsetup already does, so when this feature is
623 * desired, this is the only routine that needs to be changed.
626 extract_ugid(const char *str, struct mtpt_info *mip)
628 char *ug; /* Writable 'str'. */
629 char *user, *group; /* Result of extracton. */
638 mip->mi_have_uid = mip->mi_have_gid = false;
640 /* Extract the user and group from 'str'. Format above. */
644 user = strsep(&group, ":");
645 if (user == NULL || group == NULL || *user == '\0' || *group == '\0')
649 *uid = strtoul(user, &p, 10);
650 if (*uid == (uid_t)ULONG_MAX)
655 errx(1, "invalid user: %s", user);
658 mip->mi_have_uid = true;
661 *gid = strtoul(group, &p, 10);
662 if (*gid == (gid_t)ULONG_MAX)
665 gr = getgrnam(group);
667 errx(1, "invalid group: %s", group);
670 mip->mi_have_gid = true;
676 * Run a process with command name and arguments pointed to by the
677 * formatted string 'cmdline'. Since system(3) is not used, the first
678 * space-delimited token of 'cmdline' must be the full pathname of the
679 * program to run. The return value is the return code of the process
680 * spawned. If 'ofd' is non-NULL, it is set to the standard output of
681 * the program spawned (i.e., you can read from ofd and get the output
685 run(int *ofd, const char *cmdline, ...)
687 char **argv, **argvp; /* Result of splitting 'cmd'. */
689 char *cmd; /* Expansion of 'cmdline'. */
690 int pid, status; /* Child info. */
691 int pfd[2]; /* Pipe to the child. */
692 int nfd; /* Null (/dev/null) file descriptor. */
693 bool dup2dn; /* Dup /dev/null to stdout? */
699 va_start(ap, cmdline);
700 rv = vasprintf(&cmd, cmdline, ap);
705 /* Split up 'cmd' into 'argv' for use with execve. */
706 for (argc = 1, p = cmd; (p = strchr(p, ' ')) != NULL; p++)
707 argc++; /* 'argc' generation loop. */
708 argv = (char **)malloc(sizeof(*argv) * (argc + 1));
709 assert(argv != NULL);
710 for (p = cmd, argvp = argv; (*argvp = strsep(&p, " ")) != NULL;)
712 if (++argvp >= &argv[argc]) {
717 /* The argv array ends up NULL-terminated here. */
719 /* Make sure the above loop works as expected. */
722 * We can't, but should, use debugprintf here. First,
723 * it appends a trailing newline to the output, and
724 * second it prepends "DEBUG: " to the output. The
725 * former is a problem for this would-be first call,
726 * and the latter for the would-be call inside the
729 (void)fprintf(stderr, "DEBUG: running:");
730 /* Should be equivalent to 'cmd' (before strsep, of course). */
731 for (i = 0; argv[i] != NULL; i++)
732 (void)fprintf(stderr, " %s", argv[i]);
733 (void)fprintf(stderr, "\n");
736 /* Create a pipe if necessary and fork the helper program. */
738 if (pipe(&pfd[0]) == -1)
746 /* XXX can we call err() in here? */
750 if (dup2(pfd[1], STDOUT_FILENO) < 0)
753 nfd = open(_PATH_DEVNULL, O_RDWR);
755 err(1, "open: %s", _PATH_DEVNULL);
756 if (dup2(nfd, STDIN_FILENO) < 0)
759 if (dup2(nfd, STDOUT_FILENO) < 0)
761 if (dup2(nfd, STDERR_FILENO) < 0)
765 (void)execv(argv[0], argv);
766 warn("exec: %s", argv[0]);
774 while (waitpid(pid, &status, 0) != pid)
776 return (WEXITSTATUS(status));
784 "usage: %s [-DLlMNnPStUX] [-a maxcontig] [-b block-size]\n"
785 "\t[-c blocks-per-cylinder-group][-d max-extent-size] [-E path-mdconfig]\n"
786 "\t[-e maxbpg] [-F file] [-f frag-size] [-i bytes] [-m percent-free]\n"
787 "\t[-O optimization] [-o mount-options]\n"
788 "\t[-p permissions] [-s size] [-v version] [-w user:group]\n"
789 "\tmd-device mount-point\n", getprogname());