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 const char *run_exitstr(int);
94 static int run_exitnumber(int);
95 static void usage(void);
98 main(int argc, char **argv)
100 struct mtpt_info mi; /* Mountpoint info. */
102 char *mdconfig_arg, *newfs_arg, /* Args to helper programs. */
104 enum md_types mdtype; /* The type of our memory disk. */
105 bool have_mdtype, mlmac;
106 bool detach, softdep, autounit, newfs;
107 const char *mtpoint, *size_arg, *unitstr;
113 /* Misc. initialization. */
114 (void)memset(&mi, '\0', sizeof(mi));
123 mdnamelen = strlen(mdname);
126 * Can't set these to NULL. They may be passed to the
127 * respective programs without modification. I.e., we may not
128 * receive any command-line options which will caused them to
131 mdconfig_arg = strdup("");
132 newfs_arg = strdup("");
133 mount_arg = strdup("");
136 /* If we were started as mount_mfs or mfs, imply -C. */
137 if (strcmp(getprogname(), "mount_mfs") == 0 ||
138 strcmp(getprogname(), "mfs") == 0) {
139 /* Make compatibility assumptions. */
141 mi.mi_have_mode = true;
144 while ((ch = getopt(argc, argv,
145 "a:b:Cc:Dd:E:e:F:f:hi:LlMm:NnO:o:Pp:Ss:tT:Uv:w:X")) != -1)
148 argappend(&newfs_arg, "-a %s", optarg);
151 argappend(&newfs_arg, "-b %s", optarg);
154 /* Ignored for compatibility. */
157 argappend(&newfs_arg, "-c %s", optarg);
163 argappend(&newfs_arg, "-d %s", optarg);
166 path_mdconfig = optarg;
169 argappend(&newfs_arg, "-e %s", optarg);
176 argappend(&mdconfig_arg, "-f %s", optarg);
179 argappend(&newfs_arg, "-f %s", optarg);
185 argappend(&newfs_arg, "-i %s", optarg);
192 argappend(&newfs_arg, "-l");
201 argappend(&newfs_arg, "-m %s", optarg);
207 argappend(&newfs_arg, "-n");
210 argappend(&newfs_arg, "-o %s", optarg);
213 argappend(&mount_arg, "-o %s", optarg);
219 if ((set = setmode(optarg)) == NULL)
221 mi.mi_mode = getmode(set, S_IRWXU | S_IRWXG | S_IRWXO);
222 mi.mi_have_mode = true;
223 mi.mi_forced_pw = true;
233 argappend(&newfs_arg, "-t");
236 argappend(&mount_arg, "-t %s", optarg);
242 argappend(&newfs_arg, "-O %s", optarg);
245 extract_ugid(optarg, &mi);
246 mi.mi_forced_pw = true;
260 * Historically our size arg was passed directly to mdconfig, which
261 * treats a number without a suffix as a count of 512-byte sectors;
262 * tmpfs would treat it as a count of bytes. To get predictable
263 * behavior for 'auto' we document that the size always uses mdconfig
264 * rules. To make that work, decode the size here so it can be passed
265 * to either tmpfs or mdconfig as a count of bytes.
267 if (size_arg != NULL) {
268 mdsize = (intmax_t)strtoumax(size_arg, &p, 0);
269 if (p == size_arg || (p[0] != 0 && p[1] != 0) || mdsize < 0)
270 errx(1, "invalid size '%s'", size_arg);
294 errx(1, "invalid size suffix on '%s'", size_arg);
299 * Based on the command line 'md-device' either mount a tmpfs filesystem
300 * or configure the md device then format and mount a filesystem on it.
301 * If the device is 'auto' use tmpfs if it is available and there is no
302 * request for multilabel MAC (which tmpfs does not support).
307 if (strcmp(unitstr, "auto") == 0) {
309 idx = -1; /* Must use md for mlmac. */
310 else if ((idx = modfind("tmpfs")) == -1)
311 idx = kldload("tmpfs");
318 if (strcmp(unitstr, "tmpfs") == 0) {
319 if (size_arg != NULL && mdsize != 0)
320 argappend(&mount_arg, "-o size=%jd", mdsize);
321 do_mount_tmpfs(mount_arg, mtpoint);
323 if (size_arg != NULL)
324 argappend(&mdconfig_arg, "-s %jdB", mdsize);
325 if (strncmp(unitstr, "/dev/", 5) == 0)
327 if (strncmp(unitstr, mdname, mdnamelen) == 0)
328 unitstr += mdnamelen;
329 if (!isdigit(*unitstr)) {
334 ul = strtoul(unitstr, &p, 10);
336 errx(1, "bad device unit: %s", unitstr);
338 mdsuffix = p; /* can be empty */
344 argappend(&newfs_arg, "-U");
345 if (mdtype != MD_VNODE && !newfs)
346 errx(1, "-P requires a vnode-backed disk");
349 if (detach && !autounit)
350 do_mdconfig_detach();
352 do_mdconfig_attach_au(mdconfig_arg, mdtype);
354 do_mdconfig_attach(mdconfig_arg, mdtype);
357 do_mount_md(mount_arg, mtpoint);
360 do_mtptsetup(mtpoint, &mi);
366 * Append the expansion of 'fmt' to the buffer pointed to by '*dstp';
367 * reallocate as required.
370 argappend(char **dstp, const char *fmt, ...)
379 if (vasprintf(&new, fmt,ap) == -1)
380 errx(1, "vasprintf");
384 if (asprintf(&new, "%s %s", old, new) == -1)
393 * If run-time debugging is enabled, print the expansion of 'fmt'.
394 * Otherwise, do nothing.
397 debugprintf(const char *fmt, ...)
403 fprintf(stderr, "DEBUG: ");
405 vfprintf(stderr, fmt, ap);
407 fprintf(stderr, "\n");
412 * Attach a memory disk with a known unit.
415 do_mdconfig_attach(const char *args, const enum md_types mdtype)
418 const char *ta; /* Type arg. */
433 rv = run(NULL, "%s -a %s%s -u %s%d", path_mdconfig, ta, args,
436 errx(1, "mdconfig (attach) exited %s %d", run_exitstr(rv),
441 * Attach a memory disk with an unknown unit; use autounit.
444 do_mdconfig_attach_au(const char *args, const enum md_types mdtype)
446 const char *ta; /* Type arg. */
447 char *linep, *linebuf; /* Line pointer, line buffer. */
448 int fd; /* Standard output of mdconfig invocation. */
468 rv = run(&fd, "%s -a %s%s", path_mdconfig, ta, args);
470 errx(1, "mdconfig (attach) exited %s %d", run_exitstr(rv),
473 /* Receive the unit number. */
474 if (norun) { /* Since we didn't run, we can't read. Fake it. */
478 sfd = fdopen(fd, "r");
481 linep = fgetln(sfd, &linelen);
482 if (linep == NULL && linelen < mdnamelen + 1)
483 errx(1, "unexpected output from mdconfig (attach)");
484 /* If the output format changes, we want to know about it. */
485 assert(strncmp(linep, mdname, mdnamelen) == 0);
486 linebuf = malloc(linelen - mdnamelen + 1);
487 assert(linebuf != NULL);
488 /* Can't use strlcpy because linep is not NULL-terminated. */
489 strncpy(linebuf, linep + mdnamelen, linelen);
490 linebuf[linelen] = '\0';
491 ul = strtoul(linebuf, &p, 10);
492 if (ul == ULONG_MAX || *p != '\n')
493 errx(1, "unexpected output from mdconfig (attach)");
501 * Detach a memory disk.
504 do_mdconfig_detach(void)
508 rv = run(NULL, "%s -d -u %s%d", path_mdconfig, mdname, unit);
509 if (rv && debug) /* This is allowed to fail. */
510 warnx("mdconfig (detach) exited %s %d (ignored)",
511 run_exitstr(rv), run_exitnumber(rv));
515 * Mount the configured memory disk.
518 do_mount_md(const char *args, const char *mtpoint)
522 rv = run(NULL, "%s%s /dev/%s%d%s %s", _PATH_MOUNT, args,
523 mdname, unit, mdsuffix, mtpoint);
525 errx(1, "mount exited %s %d", run_exitstr(rv),
530 * Mount the configured tmpfs.
533 do_mount_tmpfs(const char *args, const char *mtpoint)
537 rv = run(NULL, "%s -t tmpfs %s tmp %s", _PATH_MOUNT, args, mtpoint);
539 errx(1, "tmpfs mount exited %s %d", run_exitstr(rv),
544 * Various configuration of the mountpoint. Mostly, enact 'mip'.
547 do_mtptsetup(const char *mtpoint, struct mtpt_info *mip)
551 if (!mip->mi_have_mode && !mip->mi_have_uid && !mip->mi_have_gid)
555 if (statfs(mtpoint, &sfs) == -1) {
556 warn("statfs: %s", mtpoint);
559 if ((sfs.f_flags & MNT_RDONLY) != 0) {
560 if (mip->mi_forced_pw) {
562 "Not changing mode/owner of %s since it is read-only",
566 "Not changing mode/owner of %s since it is read-only",
573 if (mip->mi_have_mode) {
574 debugprintf("changing mode of %s to %o.", mtpoint,
577 if (chmod(mtpoint, mip->mi_mode) == -1)
578 err(1, "chmod: %s", mtpoint);
581 * We have to do these separately because the user may have
582 * only specified one of them.
584 if (mip->mi_have_uid) {
585 debugprintf("changing owner (user) or %s to %u.", mtpoint,
588 if (chown(mtpoint, mip->mi_uid, -1) == -1)
589 err(1, "chown %s to %u (user)", mtpoint,
592 if (mip->mi_have_gid) {
593 debugprintf("changing owner (group) or %s to %u.", mtpoint,
596 if (chown(mtpoint, -1, mip->mi_gid) == -1)
597 err(1, "chown %s to %u (group)", mtpoint,
603 * Put a file system on the memory disk.
606 do_newfs(const char *args)
610 rv = run(NULL, "%s%s /dev/%s%d", _PATH_NEWFS, args, mdname, unit);
612 errx(1, "newfs exited %s %d", run_exitstr(rv),
617 * 'str' should be a user and group name similar to the last argument
618 * to chown(1); i.e., a user, followed by a colon, followed by a
619 * group. The user and group in 'str' may be either a [ug]id or a
620 * name. Upon return, the uid and gid fields in 'mip' will contain
621 * the uid and gid of the user and group name in 'str', respectively.
623 * In other words, this derives a user and group id from a string
624 * formatted like the last argument to chown(1).
626 * Notice: At this point we don't support only a username or only a
627 * group name. do_mtptsetup already does, so when this feature is
628 * desired, this is the only routine that needs to be changed.
631 extract_ugid(const char *str, struct mtpt_info *mip)
633 char *ug; /* Writable 'str'. */
634 char *user, *group; /* Result of extracton. */
643 mip->mi_have_uid = mip->mi_have_gid = false;
645 /* Extract the user and group from 'str'. Format above. */
649 user = strsep(&group, ":");
650 if (user == NULL || group == NULL || *user == '\0' || *group == '\0')
654 *uid = strtoul(user, &p, 10);
655 if (*uid == (uid_t)ULONG_MAX)
660 errx(1, "invalid user: %s", user);
663 mip->mi_have_uid = true;
666 *gid = strtoul(group, &p, 10);
667 if (*gid == (gid_t)ULONG_MAX)
670 gr = getgrnam(group);
672 errx(1, "invalid group: %s", group);
675 mip->mi_have_gid = true;
681 * Run a process with command name and arguments pointed to by the
682 * formatted string 'cmdline'. Since system(3) is not used, the first
683 * space-delimited token of 'cmdline' must be the full pathname of the
686 * The return value is the return code of the process spawned, or a negative
687 * signal number if the process exited due to an uncaught signal.
689 * If 'ofd' is non-NULL, it is set to the standard output of
690 * the program spawned (i.e., you can read from ofd and get the output
694 run(int *ofd, const char *cmdline, ...)
696 char **argv, **argvp; /* Result of splitting 'cmd'. */
698 char *cmd; /* Expansion of 'cmdline'. */
699 int pid, status; /* Child info. */
700 int pfd[2]; /* Pipe to the child. */
701 int nfd; /* Null (/dev/null) file descriptor. */
702 bool dup2dn; /* Dup /dev/null to stdout? */
708 va_start(ap, cmdline);
709 rv = vasprintf(&cmd, cmdline, ap);
714 /* Split up 'cmd' into 'argv' for use with execve. */
715 for (argc = 1, p = cmd; (p = strchr(p, ' ')) != NULL; p++)
716 argc++; /* 'argc' generation loop. */
717 argv = (char **)malloc(sizeof(*argv) * (argc + 1));
718 assert(argv != NULL);
719 for (p = cmd, argvp = argv; (*argvp = strsep(&p, " ")) != NULL;)
721 if (++argvp >= &argv[argc]) {
726 /* The argv array ends up NULL-terminated here. */
728 /* Make sure the above loop works as expected. */
731 * We can't, but should, use debugprintf here. First,
732 * it appends a trailing newline to the output, and
733 * second it prepends "DEBUG: " to the output. The
734 * former is a problem for this would-be first call,
735 * and the latter for the would-be call inside the
738 (void)fprintf(stderr, "DEBUG: running:");
739 /* Should be equivalent to 'cmd' (before strsep, of course). */
740 for (i = 0; argv[i] != NULL; i++)
741 (void)fprintf(stderr, " %s", argv[i]);
742 (void)fprintf(stderr, "\n");
745 /* Create a pipe if necessary and fork the helper program. */
747 if (pipe(&pfd[0]) == -1)
755 /* XXX can we call err() in here? */
759 if (dup2(pfd[1], STDOUT_FILENO) < 0)
762 nfd = open(_PATH_DEVNULL, O_RDWR);
764 err(1, "open: %s", _PATH_DEVNULL);
765 if (dup2(nfd, STDIN_FILENO) < 0)
768 if (dup2(nfd, STDOUT_FILENO) < 0)
770 if (dup2(nfd, STDERR_FILENO) < 0)
774 (void)execv(argv[0], argv);
775 warn("exec: %s", argv[0]);
783 while (waitpid(pid, &status, 0) != pid)
785 if (WIFEXITED(status))
786 return (WEXITSTATUS(status));
787 if (WIFSIGNALED(status))
788 return (-WTERMSIG(status));
789 err(1, "unexpected waitpid status: 0x%x", status);
793 * If run() returns non-zero, provide a string explaining why.
799 return ("with error code");
801 return ("with signal");
806 * If run returns non-zero, provide a relevant number.
809 run_exitnumber(int rv)
821 "usage: %s [-DLlMNnPStUX] [-a maxcontig] [-b block-size]\n"
822 "\t[-c blocks-per-cylinder-group][-d max-extent-size] [-E path-mdconfig]\n"
823 "\t[-e maxbpg] [-F file] [-f frag-size] [-i bytes] [-m percent-free]\n"
824 "\t[-O optimization] [-o mount-options]\n"
825 "\t[-p permissions] [-s size] [-v version] [-w user:group]\n"
826 "\tmd-device mount-point\n", getprogname());