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.5 2005/07/06 06:04:32 dillon 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_delete(const char *keyword, const char *mountpt,
65 int __unused fd, void __unused *);
66 static void mountctl_modify(const char *keyword, const char *mountpt, int fd, void __unused *);
69 * For all options 0 means unspecified, -1 means noOPT or nonOPT, and a
70 * positive number indicates enabling or execution of the option.
73 static int freeze_opt;
78 static int reversable_opt;
79 static int twoway_opt;
80 static int64_t memfifo_opt;
81 static int64_t swapfifo_opt;
84 main(int ac, char **av)
94 const char *wopt = NULL;
95 const char *xopt = NULL;
96 const char *keyword = NULL;
97 const char *mountpt = NULL;
100 while ((ch = getopt(ac, av, "2adflo:mw:x:ACFSZ")) != -1) {
107 if (aopt + dopt + lopt + mopt != 1) {
108 fprintf(stderr, "too many action options specified\n");
114 if (aopt + dopt + lopt + mopt != 1) {
115 fprintf(stderr, "too many action options specified\n");
124 if (aopt + dopt + lopt + mopt != 1) {
125 fprintf(stderr, "too many action options specified\n");
130 parse_option_keyword(optarg, &wopt, &xopt);
134 if (aopt + dopt + lopt + mopt != 1) {
135 fprintf(stderr, "too many action options specified\n");
168 fprintf(stderr, "unknown option: -%c\n", optopt);
176 * Parse the keyword and/or mount point.
181 fprintf(stderr, "action requires a tag and/or mount "
182 "point to be specified\n");
187 if (av[0][0] == '/') {
189 if ((keyword = strchr(mountpt, ':')) != NULL) {
191 tmp = strdup(mountpt);
192 *strchr(tmp, ':') = 0;
200 fprintf(stderr, "unexpected extra arguments to command\n");
205 * Additional sanity checks
207 if (aopt + dopt + lopt + mopt + mimplied == 0) {
208 fprintf(stderr, "no action or implied action options were specified\n");
211 if (mimplied && aopt + dopt + lopt == 0)
213 if ((wopt || xopt) && !(aopt || mopt)) {
214 fprintf(stderr, "-w/-x/path/fd options may only be used with -m/-a\n");
217 if (aopt && (keyword == NULL || mountpt == NULL)) {
218 fprintf(stderr, "a keyword AND a mountpt must be specified "
219 "when adding a journal\n");
222 if (fopt == 0 && mopt + dopt && keyword == NULL && mountpt == NULL) {
223 fprintf(stderr, "a keyword, a mountpt, or both must be specified "
224 "when modifying or deleting a journal, unless "
225 "-f is also specified for safety\n");
230 * Open the journaling file descriptor if required.
233 fprintf(stderr, "you must specify only one of -w/-x/path/fd\n");
236 if ((fd = open(wopt, O_RDWR|O_CREAT|O_APPEND, 0666)) < 0) {
237 fprintf(stderr, "unable to create %s: %s\n", wopt, strerror(errno));
241 fd = strtol(xopt, NULL, 0);
243 fd = 1; /* stdout default for -a */
249 * And finally execute the core command.
252 mountctl_scan(mountctl_list, keyword, mountpt, fd);
254 mountctl_add(keyword, mountpt, fd);
256 ch = mountctl_scan(mountctl_delete, keyword, mountpt, -1);
258 printf("%d journals deleted\n", ch);
260 printf("Unable to locate any matching journals\n");
263 ch = mountctl_scan(mountctl_modify, keyword, mountpt, fd);
265 printf("%d journals modified\n", ch);
267 printf("Unable to locate any matching journals\n");
274 parse_option_keyword(const char *opt, const char **wopt, const char **xopt)
276 char *str = strdup(opt);
284 * multiple comma delimited options may be specified.
286 while ((name = strsep(&str, ",")) != NULL) {
288 * some options have associated data.
290 if ((val = strchr(name, '=')) != NULL)
294 * options beginning with 'no' or 'non' are negated. A positive
295 * number means not negated, a negative number means negated.
300 if (strncmp(name, "non", 3) == 0) {
303 } else if (strncmp(name, "no", 2) == 0) {
309 * Parse supported options
311 if (strcmp(name, "reversable") == 0) {
312 reversable_opt = negate;
313 } else if (strcmp(name, "twoway") == 0) {
315 } else if (strcmp(name, "memfifo") == 0) {
319 if ((memfifo_opt = getsize(val)) == 0)
322 } else if (strcmp(name, "swapfifo") == 0) {
325 if ((swapfifo_opt = getsize(val)) == 0)
327 } else if (negate < 0) {
330 hasval = 1; /* force error */
332 } else if (strcmp(name, "fd") == 0) {
337 } else if (strcmp(name, "path") == 0) {
342 } else if (strcmp(name, "freeze") == 0 || strcmp(name, "stop") == 0) {
347 } else if (strcmp(name, "start") == 0) {
349 freeze_opt = -negate;
352 } else if (strcmp(name, "close") == 0) {
354 } else if (strcmp(name, "abort") == 0) {
356 } else if (strcmp(name, "flush") == 0) {
359 fprintf(stderr, "unknown option keyword: %s\n", name);
366 if (cannotnegate && negate < 0) {
367 fprintf(stderr, "option %s may not be negated\n", name);
370 if (hasval && val == NULL) {
371 fprintf(stderr, "option %s requires assigned data\n", name);
374 if (hasval == 0 && val) {
375 fprintf(stderr, "option %s does not take an assignment\n", name);
383 mountctl_scan(void (*func)(const char *, const char *, int, void *),
384 const char *keyword, const char *mountpt, int fd)
390 struct mountctl_status_journal statreq;
391 struct mountctl_journal_ret_status rstat[4]; /* BIG */
395 bzero(&statreq, sizeof(statreq));
397 statreq.index = MC_JOURNAL_INDEX_ID;
398 count = strlen(keyword);
401 bcopy(keyword, statreq.id, count);
403 statreq.index = MC_JOURNAL_INDEX_ALL;
405 count = mountctl(mountpt, MOUNTCTL_STATUS_VFS_JOURNAL, -1,
406 &statreq, sizeof(statreq), &rstat, sizeof(rstat));
407 if (count > 0 && rstat[0].recsize != sizeof(rstat[0])) {
408 fprintf(stderr, "Unable to access status, "
409 "structure size mismatch\n");
413 count /= sizeof(rstat[0]);
414 for (i = 0; i < count; ++i) {
415 func(rstat[i].id, mountpt, fd, &rstat[i]);
420 if ((count = getmntinfo(&sfs, MNT_WAIT)) > 0) {
421 for (i = 0; i < count; ++i) {
422 calls += mountctl_scan(func, keyword, sfs[i].f_mntonname, fd);
424 } else if (count < 0) {
432 mountctl_list(const char *keyword, const char *mountpt, int __unused fd, void *info)
434 struct mountctl_journal_ret_status *rstat = info;
436 printf("%s:%s\n", mountpt, rstat->id[0] ? rstat->id : "<NOID>");
437 printf(" membufsize=%s\n", numtostr(rstat->membufsize));
438 printf(" membufused=%s\n", numtostr(rstat->membufused));
439 printf(" membufunacked=%s\n", numtostr(rstat->membufunacked));
440 printf(" total_bytes=%s\n", numtostr(rstat->bytessent));
441 printf(" fifo_stalls=%lld\n", rstat->fifostalls);
445 mountctl_add(const char *keyword, const char *mountpt, int fd)
447 struct mountctl_install_journal joinfo;
453 * Make sure the file descriptor is not on the same filesystem as the
454 * mount point. This isn't a perfect test, but it should catch most
457 if (fstat(fd, &st1) == 0 && S_ISREG(st1.st_mode) &&
458 stat(mountpt, &st2) == 0 && st1.st_dev == st2.st_dev
460 fprintf(stderr, "%s:%s failed to add, the journal cannot be on the "
461 "same filesystem being journaled!\n",
468 * Setup joinfo and issue the add
470 bzero(&joinfo, sizeof(joinfo));
471 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
473 joinfo.membufsize = memfifo_opt;
475 joinfo.flags |= MC_JOURNAL_WANT_FULLDUPLEX;
476 if (reversable_opt > 0)
477 joinfo.flags |= MC_JOURNAL_WANT_REVERSABLE;
479 error = mountctl(mountpt, MOUNTCTL_INSTALL_VFS_JOURNAL, fd,
480 &joinfo, sizeof(joinfo), NULL, 0);
482 fprintf(stderr, "%s:%s added\n", mountpt, joinfo.id);
484 fprintf(stderr, "%s:%s failed to add, error %s\n", mountpt, joinfo.id, strerror(errno));
490 mountctl_delete(const char *keyword, const char *mountpt, int __unused fd, void __unused *info)
492 struct mountctl_remove_journal joinfo;
495 bzero(&joinfo, sizeof(joinfo));
496 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
497 error = mountctl(mountpt, MOUNTCTL_REMOVE_VFS_JOURNAL, -1,
498 &joinfo, sizeof(joinfo), NULL, 0);
500 fprintf(stderr, "%s:%s deleted\n", mountpt, joinfo.id);
502 fprintf(stderr, "%s:%s deletion failed, error %s\n", mountpt, joinfo.id, strerror(errno));
507 mountctl_modify(const char *keyword, const char *mountpt, int fd, void __unused *info)
509 fprintf(stderr, "modify not yet implemented\n");
518 " mountctl -l [tag/mountpt | mountpt:tag]\n"
519 " mountctl -a [-w output_path] [-x filedesc]\n"
520 " [-o option] [-o option ...] mountpt:tag\n"
521 " mountctl -d [tag/mountpt | mountpt:tag]\n"
522 " mountctl -m [-o option] [-o option ...] [tag/mountpt | mountpt:tag]\n"
523 " mountctl -FZSCA [tag/mountpt | mountpt:tag]\n"
530 getsize(const char *str)
535 val = strtoll(str, &suffix, 0);
554 fprintf(stderr, "data value '%s' has unknown suffix\n", str);
563 numtostr(int64_t num)
570 snprintf(buf, sizeof(buf), "%lld", num);
571 else if (num < 10 * 1024)
572 snprintf(buf, sizeof(buf), "%3.2fK", num / 1024.0);
573 else if (num < 1024 * 1024)
574 snprintf(buf, sizeof(buf), "%3.0fK", num / 1024.0);
575 else if (num < 10 * 1024 * 1024)
576 snprintf(buf, sizeof(buf), "%3.2fM", num / (1024.0 * 1024.0));
577 else if (num < 1024 * 1024 * 1024)
578 snprintf(buf, sizeof(buf), "%3.0fM", num / (1024.0 * 1024.0));
579 else if (num < 10LL * 1024 * 1024 * 1024)
580 snprintf(buf, sizeof(buf), "%3.2fG", num / (1024.0 * 1024.0 * 1024.0));
582 snprintf(buf, sizeof(buf), "%3.0fG", num / (1024.0 * 1024.0 * 1024.0));