2 * Copyright (c) 2003,2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sbin/mountctl/mountctl.c,v 1.8 2005/11/06 12:42:26 swildner Exp $
37 * This utility implements the userland mountctl command which is used to
38 * manage high level journaling on mount points.
41 #include <sys/types.h>
42 #include <sys/param.h>
43 #include <sys/ucred.h>
44 #include <sys/mount.h>
46 #include <sys/mountctl.h>
53 static volatile void usage(void);
54 static void parse_option_keyword(const char *opt,
55 const char **wopt, const char **xopt);
56 static int64_t getsize(const char *str);
57 static const char *numtostr(int64_t num);
59 static int mountctl_scan(void (*func)(const char *, const char *, int, void *),
60 const char *keyword, const char *mountpt, int fd);
61 static void mountctl_list(const char *keyword, const char *mountpt,
62 int __unused fd, void *info);
63 static void mountctl_add(const char *keyword, const char *mountpt, int fd);
64 static void mountctl_restart(const char *keyword, const char *mountpt,
65 int fd, void __unused *);
66 static void mountctl_delete(const char *keyword, const char *mountpt,
67 int __unused fd, void __unused *);
68 static void mountctl_modify(const char *keyword, const char *mountpt, int fd, void __unused *);
71 * For all options 0 means unspecified, -1 means noOPT or nonOPT, and a
72 * positive number indicates enabling or execution of the option.
75 static int freeze_opt;
80 static int reversable_opt;
81 static int twoway_opt;
82 static int output_safety_override_opt;
83 static int64_t memfifo_opt;
84 static int64_t swapfifo_opt;
87 main(int ac, char **av)
98 const char *wopt = NULL;
99 const char *xopt = NULL;
100 const char *keyword = NULL;
101 const char *mountpt = NULL;
104 while ((ch = getopt(ac, av, "2adflmo:rw:x:ACFSW:X:Z")) != -1) {
111 if (aopt + dopt + lopt + mopt + ropt != 1) {
112 fprintf(stderr, "too many action options specified\n");
118 if (aopt + dopt + lopt + mopt + ropt != 1) {
119 fprintf(stderr, "too many action options specified\n");
125 if (aopt + dopt + lopt + mopt + ropt != 1) {
126 fprintf(stderr, "too many action options specified\n");
135 if (aopt + dopt + lopt + mopt + ropt != 1) {
136 fprintf(stderr, "too many action options specified\n");
141 parse_option_keyword(optarg, &wopt, &xopt);
145 if (aopt + dopt + lopt + mopt + ropt != 1) {
146 fprintf(stderr, "too many action options specified\n");
151 output_safety_override_opt = 1;
158 output_safety_override_opt = 1;
185 fprintf(stderr, "unknown option: -%c\n", optopt);
193 * Parse the keyword and/or mount point.
198 fprintf(stderr, "action requires a tag and/or mount "
199 "point to be specified\n");
204 if (av[0][0] == '/') {
206 if ((keyword = strchr(mountpt, ':')) != NULL) {
208 tmp = strdup(mountpt);
209 *strchr(tmp, ':') = 0;
217 fprintf(stderr, "unexpected extra arguments to command\n");
222 * Additional sanity checks
224 if (aopt + dopt + lopt + mopt + ropt + mimplied == 0) {
225 fprintf(stderr, "no action or implied action options were specified\n");
228 if (mimplied && aopt + dopt + lopt + ropt == 0)
230 if ((wopt || xopt) && !(aopt || ropt || mopt)) {
231 fprintf(stderr, "-w/-x/path/fd options may only be used with -m/-a/-r\n");
234 if (aopt && (keyword == NULL || mountpt == NULL)) {
235 fprintf(stderr, "a keyword AND a mountpt must be specified "
236 "when adding a journal\n");
239 if (fopt == 0 && mopt + dopt && keyword == NULL && mountpt == NULL) {
240 fprintf(stderr, "a keyword, a mountpt, or both must be specified "
241 "when modifying or deleting a journal, unless "
242 "-f is also specified for safety\n");
247 * Open the journaling file descriptor if required.
250 fprintf(stderr, "you must specify only one of -w/-x/path/fd\n");
253 if ((fd = open(wopt, O_RDWR|O_CREAT|O_APPEND, 0666)) < 0) {
254 fprintf(stderr, "unable to create %s: %s\n", wopt, strerror(errno));
258 fd = strtol(xopt, NULL, 0);
259 } else if (aopt || ropt) {
260 fd = 1; /* stdout default for -a */
266 * And finally execute the core command.
269 mountctl_scan(mountctl_list, keyword, mountpt, fd);
271 mountctl_add(keyword, mountpt, fd);
273 ch = mountctl_scan(mountctl_restart, keyword, mountpt, fd);
275 fprintf(stderr, "%d journals restarted\n", ch);
277 fprintf(stderr, "Unable to locate any matching journals\n");
280 ch = mountctl_scan(mountctl_delete, keyword, mountpt, -1);
282 fprintf(stderr, "%d journals deleted\n", ch);
284 fprintf(stderr, "Unable to locate any matching journals\n");
287 ch = mountctl_scan(mountctl_modify, keyword, mountpt, fd);
289 fprintf(stderr, "%d journals modified\n", ch);
291 fprintf(stderr, "Unable to locate any matching journals\n");
298 parse_option_keyword(const char *opt, const char **wopt, const char **xopt)
300 char *str = strdup(opt);
308 * multiple comma delimited options may be specified.
310 while ((name = strsep(&str, ",")) != NULL) {
312 * some options have associated data.
314 if ((val = strchr(name, '=')) != NULL)
318 * options beginning with 'no' or 'non' are negated. A positive
319 * number means not negated, a negative number means negated.
324 if (strncmp(name, "non", 3) == 0) {
327 } else if (strncmp(name, "no", 2) == 0) {
333 * Parse supported options
335 if (strcmp(name, "undo") == 0) {
336 reversable_opt = negate;
337 } else if (strcmp(name, "reversable") == 0) {
338 reversable_opt = negate;
339 } else if (strcmp(name, "twoway") == 0) {
341 } else if (strcmp(name, "memfifo") == 0) {
345 if ((memfifo_opt = getsize(val)) == 0)
348 } else if (strcmp(name, "swapfifo") == 0) {
351 if ((swapfifo_opt = getsize(val)) == 0)
353 } else if (negate < 0) {
356 hasval = 1; /* force error */
358 } else if (strcmp(name, "fd") == 0) {
363 } else if (strcmp(name, "path") == 0) {
368 } else if (strcmp(name, "freeze") == 0 || strcmp(name, "stop") == 0) {
373 } else if (strcmp(name, "start") == 0) {
375 freeze_opt = -negate;
378 } else if (strcmp(name, "close") == 0) {
380 } else if (strcmp(name, "abort") == 0) {
382 } else if (strcmp(name, "flush") == 0) {
385 fprintf(stderr, "unknown option keyword: %s\n", name);
392 if (cannotnegate && negate < 0) {
393 fprintf(stderr, "option %s may not be negated\n", name);
396 if (hasval && val == NULL) {
397 fprintf(stderr, "option %s requires assigned data\n", name);
400 if (hasval == 0 && val) {
401 fprintf(stderr, "option %s does not take an assignment\n", name);
409 mountctl_scan(void (*func)(const char *, const char *, int, void *),
410 const char *keyword, const char *mountpt, int fd)
416 struct mountctl_status_journal statreq;
417 struct mountctl_journal_ret_status rstat[4]; /* BIG */
421 bzero(&statreq, sizeof(statreq));
423 statreq.index = MC_JOURNAL_INDEX_ID;
424 count = strlen(keyword);
427 bcopy(keyword, statreq.id, count);
429 statreq.index = MC_JOURNAL_INDEX_ALL;
431 count = mountctl(mountpt, MOUNTCTL_STATUS_VFS_JOURNAL, -1,
432 &statreq, sizeof(statreq), &rstat, sizeof(rstat));
433 if (count > 0 && rstat[0].recsize != sizeof(rstat[0])) {
434 fprintf(stderr, "Unable to access status, "
435 "structure size mismatch\n");
439 count /= sizeof(rstat[0]);
440 for (i = 0; i < count; ++i) {
441 func(rstat[i].id, mountpt, fd, &rstat[i]);
446 if ((count = getmntinfo(&sfs, MNT_WAIT)) > 0) {
447 for (i = 0; i < count; ++i) {
448 calls += mountctl_scan(func, keyword, sfs[i].f_mntonname, fd);
450 } else if (count < 0) {
458 mountctl_list(const char *keyword, const char *mountpt, int __unused fd, void *info)
460 struct mountctl_journal_ret_status *rstat = info;
462 printf("%s:%s\n", mountpt, rstat->id[0] ? rstat->id : "<NOID>");
463 printf(" membufsize=%s\n", numtostr(rstat->membufsize));
464 printf(" membufused=%s\n", numtostr(rstat->membufused));
465 printf(" membufunacked=%s\n", numtostr(rstat->membufunacked));
466 printf(" total_bytes=%s\n", numtostr(rstat->bytessent));
467 printf(" fifo_stalls=%lld\n", rstat->fifostalls);
471 mountctl_add(const char *keyword, const char *mountpt, int fd)
473 struct mountctl_install_journal joinfo;
479 * Make sure the file descriptor is not on the same filesystem as the
480 * mount point. This isn't a perfect test, but it should catch most
483 if (output_safety_override_opt == 0 &&
484 fstat(fd, &st1) == 0 && S_ISREG(st1.st_mode) &&
485 stat(mountpt, &st2) == 0 && st1.st_dev == st2.st_dev
487 fprintf(stderr, "%s:%s failed to add, the journal cannot be on the "
488 "same filesystem being journaled!\n",
495 * Setup joinfo and issue the add
497 bzero(&joinfo, sizeof(joinfo));
498 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
500 joinfo.membufsize = memfifo_opt;
502 joinfo.flags |= MC_JOURNAL_WANT_FULLDUPLEX;
503 if (reversable_opt > 0)
504 joinfo.flags |= MC_JOURNAL_WANT_REVERSABLE;
506 error = mountctl(mountpt, MOUNTCTL_INSTALL_VFS_JOURNAL, fd,
507 &joinfo, sizeof(joinfo), NULL, 0);
509 fprintf(stderr, "%s:%s added\n", mountpt, joinfo.id);
511 fprintf(stderr, "%s:%s failed to add, error %s\n", mountpt, joinfo.id, strerror(errno));
517 mountctl_restart(const char *keyword, const char *mountpt,
518 int fd, void __unused *info)
520 struct mountctl_restart_journal joinfo;
523 /* XXX make sure descriptor is not on same filesystem as journal */
525 bzero(&joinfo, sizeof(joinfo));
527 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
529 joinfo.flags |= MC_JOURNAL_WANT_FULLDUPLEX;
530 if (reversable_opt > 0)
531 joinfo.flags |= MC_JOURNAL_WANT_REVERSABLE;
533 error = mountctl(mountpt, MOUNTCTL_RESTART_VFS_JOURNAL, fd,
534 &joinfo, sizeof(joinfo), NULL, 0);
536 fprintf(stderr, "%s:%s restarted\n", mountpt, joinfo.id);
538 fprintf(stderr, "%s:%s restart failed, error %s\n", mountpt, joinfo.id, strerror(errno));
543 mountctl_delete(const char *keyword, const char *mountpt,
544 int __unused fd, void __unused *info)
546 struct mountctl_remove_journal joinfo;
549 bzero(&joinfo, sizeof(joinfo));
550 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
551 error = mountctl(mountpt, MOUNTCTL_REMOVE_VFS_JOURNAL, -1,
552 &joinfo, sizeof(joinfo), NULL, 0);
554 fprintf(stderr, "%s:%s deleted\n", mountpt, joinfo.id);
556 fprintf(stderr, "%s:%s deletion failed, error %s\n", mountpt, joinfo.id, strerror(errno));
561 mountctl_modify(const char *keyword, const char *mountpt, int fd, void __unused *info)
563 fprintf(stderr, "modify not yet implemented\n");
571 " mountctl -l [tag/mountpt | mountpt:tag]\n"
572 " mountctl -a [-w output_path] [-x filedesc]\n"
573 " [-o option] [-o option ...] mountpt:tag\n"
574 " mountctl -d [tag/mountpt | mountpt:tag]\n"
575 " mountctl -m [-o option] [-o option ...] [tag/mountpt | mountpt:tag]\n"
576 " mountctl -FZSCA [tag/mountpt | mountpt:tag]\n"
582 getsize(const char *str)
587 val = strtoll(str, &suffix, 0);
606 fprintf(stderr, "data value '%s' has unknown suffix\n", str);
614 numtostr(int64_t num)
621 snprintf(buf, sizeof(buf), "%lld", num);
622 else if (num < 10 * 1024)
623 snprintf(buf, sizeof(buf), "%3.2fK", num / 1024.0);
624 else if (num < 1024 * 1024)
625 snprintf(buf, sizeof(buf), "%3.0fK", num / 1024.0);
626 else if (num < 10 * 1024 * 1024)
627 snprintf(buf, sizeof(buf), "%3.2fM", num / (1024.0 * 1024.0));
628 else if (num < 1024 * 1024 * 1024)
629 snprintf(buf, sizeof(buf), "%3.0fM", num / (1024.0 * 1024.0));
630 else if (num < 10LL * 1024 * 1024 * 1024)
631 snprintf(buf, sizeof(buf), "%3.2fG", num / (1024.0 * 1024.0 * 1024.0));
633 snprintf(buf, sizeof(buf), "%3.0fG", num / (1024.0 * 1024.0 * 1024.0));