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.2 2005/01/09 03:06:14 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.
72 static int freeze_opt;
77 static int reversable_opt;
78 static int twoway_opt;
79 static int64_t memfifo_opt;
80 static int64_t swapfifo_opt;
83 main(int ac, char **av)
93 const char *wopt = NULL;
94 const char *xopt = NULL;
95 const char *keyword = NULL;
96 const char *mountpt = NULL;
99 while ((ch = getopt(ac, av, "adflo:mw:x:ACFSZ")) != -1) {
103 if (aopt + dopt + lopt + mopt != 1) {
104 fprintf(stderr, "too many action options specified\n");
110 if (aopt + dopt + lopt + mopt != 1) {
111 fprintf(stderr, "too many action options specified\n");
120 if (aopt + dopt + lopt + mopt != 1) {
121 fprintf(stderr, "too many action options specified\n");
126 parse_option_keyword(optarg, &wopt, &xopt);
130 if (aopt + dopt + lopt + mopt != 1) {
131 fprintf(stderr, "too many action options specified\n");
164 fprintf(stderr, "unknown option: -%c\n", optopt);
172 * Parse the keyword and/or mount point.
177 fprintf(stderr, "action requires a tag and/or mount "
178 "point to be specified\n");
183 if (av[0][0] == '/') {
185 if ((keyword = strchr(mountpt, ':')) != NULL) {
187 tmp = strdup(mountpt);
188 *strchr(tmp, ':') = 0;
196 fprintf(stderr, "unexpected extra arguments to command\n");
201 * Additional sanity checks
203 if (aopt + dopt + lopt + mopt + mimplied == 0) {
204 fprintf(stderr, "no action or implied action options were specified\n");
207 if (mimplied && aopt + dopt + lopt == 0)
209 if ((wopt || xopt) && !(aopt || mopt)) {
210 fprintf(stderr, "-w/-x/path/fd options may only be used with -m/-a\n");
213 if (aopt && (keyword == NULL || mountpt == NULL)) {
214 fprintf(stderr, "a keyword AND a mountpt must be specified "
215 "when adding a journal\n");
218 if (fopt == 0 && mopt + dopt && keyword == NULL && mountpt == NULL) {
219 fprintf(stderr, "a keyword, a mountpt, or both must be specified "
220 "when modifying or deleting a journal, unless "
221 "-f is also specified for safety\n");
226 * Open the journaling file descriptor if required.
229 fprintf(stderr, "you must specify only one of -w/-x/path/fd\n");
232 if ((fd = open(wopt, O_RDWR|O_CREAT|O_APPEND, 0666)) < 0) {
233 fprintf(stderr, "unable to create %s: %s\n", wopt, strerror(errno));
237 fd = strtol(xopt, NULL, 0);
239 fd = 1; /* stdout default for -a */
245 * And finally execute the core command.
248 mountctl_scan(mountctl_list, keyword, mountpt, fd);
250 mountctl_add(keyword, mountpt, fd);
252 ch = mountctl_scan(mountctl_delete, keyword, mountpt, -1);
254 printf("%d journals deleted\n", ch);
256 printf("Unable to locate any matching journals\n");
259 ch = mountctl_scan(mountctl_modify, keyword, mountpt, fd);
261 printf("%d journals modified\n", ch);
263 printf("Unable to locate any matching journals\n");
270 parse_option_keyword(const char *opt, const char **wopt, const char **xopt)
272 char *str = strdup(opt);
280 * multiple comma delimited options may be specified.
282 while ((name = strsep(&str, ",")) != NULL) {
284 * some options have associated data.
286 if ((val = strchr(name, '=')) != NULL)
290 * options beginning with 'no' or 'non' are negated. A positive
291 * number means not negated, a negative number means negated.
296 if (strncmp(name, "non", 3) == 0) {
299 } else if (strncmp(name, "no", 2) == 0) {
305 * Parse supported options
307 if (strcmp(name, "reversable") == 0) {
308 reversable_opt = negate;
309 } else if (strcmp(name, "twoway") == 0) {
311 } else if (strcmp(name, "memfifo") == 0) {
315 if ((memfifo_opt = getsize(val)) == 0)
318 } else if (strcmp(name, "swapfifo") == 0) {
321 if ((swapfifo_opt = getsize(val)) == 0)
323 } else if (negate < 0) {
326 hasval = 1; /* force error */
328 } else if (strcmp(name, "fd") == 0) {
333 } else if (strcmp(name, "path") == 0) {
338 } else if (strcmp(name, "freeze") == 0 || strcmp(name, "stop") == 0) {
343 } else if (strcmp(name, "start") == 0) {
345 freeze_opt = -negate;
348 } else if (strcmp(name, "close") == 0) {
350 } else if (strcmp(name, "abort") == 0) {
352 } else if (strcmp(name, "flush") == 0) {
355 fprintf(stderr, "unknown option keyword: %s\n", name);
362 if (cannotnegate && negate < 0) {
363 fprintf(stderr, "option %s may not be negated\n", name);
366 if (hasval && val == NULL) {
367 fprintf(stderr, "option %s requires assigned data\n", name);
370 if (hasval == 0 && val) {
371 fprintf(stderr, "option %s does not take an assignment\n", name);
379 mountctl_scan(void (*func)(const char *, const char *, int, void *),
380 const char *keyword, const char *mountpt, int fd)
386 struct mountctl_status_journal statreq;
387 struct mountctl_journal_ret_status rstat[4]; /* BIG */
391 bzero(&statreq, sizeof(statreq));
393 statreq.index = MC_JOURNAL_INDEX_ID;
394 count = strlen(keyword);
397 bcopy(keyword, statreq.id, count);
399 statreq.index = MC_JOURNAL_INDEX_ALL;
401 count = mountctl(mountpt, MOUNTCTL_STATUS_VFS_JOURNAL, -1,
402 &statreq, sizeof(statreq), &rstat, sizeof(rstat));
403 if (count > 0 && rstat[0].recsize != sizeof(rstat[0])) {
404 fprintf(stderr, "Unable to access status, "
405 "structure size mismatch\n");
409 count /= sizeof(rstat[0]);
410 for (i = 0; i < count; ++i) {
411 func(rstat[i].id, mountpt, fd, &rstat[i]);
416 if ((count = getmntinfo(&sfs, MNT_WAIT)) > 0) {
417 for (i = 0; i < count; ++i) {
418 calls += mountctl_scan(func, keyword, sfs[i].f_mntonname, fd);
420 } else if (count < 0) {
428 mountctl_list(const char *keyword, const char *mountpt, int __unused fd, void *info)
430 struct mountctl_journal_ret_status *rstat = info;
432 printf("%s:%s\n", mountpt, rstat->id[0] ? rstat->id : "<NOID>");
433 printf(" membufsize=%s\n", numtostr(rstat->membufsize));
434 printf(" membufused=%s\n", numtostr(rstat->membufused));
435 printf(" membufiopend=%s\n", numtostr(rstat->membufiopend));
436 printf(" total_bytes=%s\n", numtostr(rstat->bytessent));
440 mountctl_add(const char *keyword, const char *mountpt, int fd)
442 struct mountctl_install_journal joinfo;
445 bzero(&joinfo, sizeof(joinfo));
446 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
448 error = mountctl(mountpt, MOUNTCTL_INSTALL_VFS_JOURNAL, fd,
449 &joinfo, sizeof(joinfo), NULL, 0);
451 fprintf(stderr, "%s:%s added\n", mountpt, joinfo.id);
453 fprintf(stderr, "%s:%s failed to add, error %s\n", mountpt, joinfo.id, strerror(errno));
458 mountctl_delete(const char *keyword, const char *mountpt, int __unused fd, void __unused *info)
460 struct mountctl_remove_journal joinfo;
463 bzero(&joinfo, sizeof(joinfo));
464 snprintf(joinfo.id, sizeof(joinfo.id), "%s", keyword);
465 error = mountctl(mountpt, MOUNTCTL_REMOVE_VFS_JOURNAL, -1,
466 &joinfo, sizeof(joinfo), NULL, 0);
468 fprintf(stderr, "%s:%s deleted\n", mountpt, joinfo.id);
470 fprintf(stderr, "%s:%s deletion failed, error %s\n", mountpt, joinfo.id, strerror(errno));
475 mountctl_modify(const char *keyword, const char *mountpt, int fd, void __unused *info)
477 fprintf(stderr, "modify not yet implemented\n");
486 " mountctl -l [tag/mountpt | mountpt:tag]\n"
487 " mountctl -a [-w output_path] [-x filedesc]\n"
488 " [-o option] [-o option ...] mountpt:tag\n"
489 " mountctl -d [tag/mountpt | mountpt:tag]\n"
490 " mountctl -m [-o option] [-o option ...] [tag/mountpt | mountpt:tag]\n"
491 " mountctl -FZSCA [tag/mountpt | mountpt:tag]\n"
498 getsize(const char *str)
503 val = strtoll(str, &suffix, 0);
522 fprintf(stderr, "data value '%s' has unknown suffix\n", str);
531 numtostr(int64_t num)
538 snprintf(buf, sizeof(buf), "%lld", num);
539 else if (num < 10 * 1024)
540 snprintf(buf, sizeof(buf), "%3.2fK", num / 1024.0);
541 else if (num < 1024 * 1024)
542 snprintf(buf, sizeof(buf), "%3.0fK", num / 1024.0);
543 else if (num < 10 * 1024 * 1024)
544 snprintf(buf, sizeof(buf), "%3.2fM", num / (1024.0 * 1024.0));
545 else if (num < 1024 * 1024 * 1024)
546 snprintf(buf, sizeof(buf), "%3.0fM", num / (1024.0 * 1024.0));
547 else if (num < 10LL * 1024 * 1024 * 1024)
548 snprintf(buf, sizeof(buf), "%3.2fG", num / (1024.0 * 1024.0 * 1024.0));
550 snprintf(buf, sizeof(buf), "%3.0fG", num / (1024.0 * 1024.0 * 1024.0));