2 * Copyright (c) 2008 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/hammer/cmd_pseudofs.c,v 1.12 2008/10/08 21:01:54 thomas Exp $
41 static int scanpfsid(struct hammer_ioc_pseudofs_rw *pfs, const char *path);
42 static void parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd);
43 static void init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave);
44 static void pseudofs_usage(int code);
45 static int timetosecs(char *str);
48 * Return a directory that contains path.
49 * If '/' is not found in the path then '.' is returned.
50 * A caller need to free the returned pointer.
53 getdir(const char *path)
57 dirpath = strdup(path);
58 if (strrchr(dirpath, '/')) {
59 *strrchr(dirpath, '/') = 0;
60 if (strlen(dirpath) == 0) {
62 dirpath = strdup("/");
66 dirpath = strdup(".");
73 * Calculate the pfs_id given a path to a directory or a @@PFS or @@%llx:%d
77 getpfs(struct hammer_ioc_pseudofs_rw *pfs, char *path)
82 bzero(pfs, sizeof(*pfs));
83 pfs->ondisk = malloc(sizeof(*pfs->ondisk));
84 bzero(pfs->ondisk, sizeof(*pfs->ondisk));
85 pfs->bytes = sizeof(*pfs->ondisk);
88 * Trailing '/' must be removed so that upon pfs-destroy
89 * the symlink can be deleted without problems.
90 * Root directory (/) must be excluded from this.
92 p = path + (int)strlen(path) - 1;
94 while (p != path && *p == '/')
97 fd = scanpfsid(pfs, path);
100 * Once it comes here the hammer command may fail even if
101 * this function returns valid file descriptor.
103 fd = open(path, O_RDONLY);
106 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs);
107 if (pfs->pfs_id == -1) {
112 fprintf(stderr, "Cannot access PFS %s: %s\n",
113 path, strerror(errno));
119 * pfs.pfs_id should have been set to non -1. In this case fd
120 * could be any fd of HAMMER inodes since HAMMERIOC_GET_PSEUDOFS
121 * doesn't depend on inode attributes if it's set to a valid id.
123 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs) < 0) {
124 fprintf(stderr, "Cannot access PFS %s: %s\n",
125 path, strerror(errno));
132 * Extract the PFS id from path. Return a file descriptor of
133 * the parent directory which is expected to be located under
134 * the root filesystem (not another PFS).
137 scanpfsid(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
147 if (stat(path, &st)) {
148 /* possibly slave PFS */
149 } else if (S_ISDIR(st.st_mode)) {
150 /* possibly master or slave PFS */
152 return -1; /* neither */
156 * If the path is a link read the link.
158 if (lstat(path, &st) == 0 && S_ISLNK(st.st_mode)) {
159 n = readlink(path, buf, sizeof(buf) - 1);
169 * The symlink created by pfs-master|slave is just a symlink.
170 * One could happen to remove a symlink and relink PFS as
171 * # ln -s ./@@-1:00001 ./link
172 * which results PFS having something extra before @@.
173 * One could also directly use the PFS and results the same.
174 * Get rid of it before we extract the PFS id.
176 if (strchr(p, '/')) {
183 * Extract the PFS from the link. HAMMER will automatically
184 * convert @@PFS%05d links so if actually see one in that
185 * form the target PFS may not exist or may be corrupt. But
186 * we can extract the PFS id anyway.
188 dirpath = getdir(path);
189 if (sscanf(p, "@@PFS%d", &pfs->pfs_id) == 1) {
190 fd = open(dirpath, O_RDONLY);
191 } else if (sscanf(p, "@@%jx:%d", &dummy_tid, &pfs->pfs_id) == 2) {
192 fd = open(dirpath, O_RDONLY);
194 fd = -1; /* Failed to scan PFS id */
201 relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs)
212 print_pfs_status(char *path)
214 struct hammer_ioc_pseudofs_rw pfs;
217 fd = getpfs(&pfs, path);
218 printf("%s\t", path);
219 if (fd < 0 || ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
220 printf("Invalid PFS path %s\n", path);
222 printf("PFS #%d {\n", pfs.pfs_id);
223 dump_pfsd(pfs.ondisk, fd);
234 hammer_cmd_pseudofs_status(char **av, int ac)
239 char buf[2] = "."; /* can't be readonly string */
240 print_pfs_status(buf);
244 for (i = 0; i < ac; ++i)
245 print_pfs_status(av[i]);
249 hammer_cmd_pseudofs_create(char **av, int ac, int is_slave)
251 struct hammer_ioc_pseudofs_rw pfs;
252 struct hammer_pseudofs_data pfsd;
264 if (lstat(path, &st) == 0) {
265 fprintf(stderr, "Cannot create %s, file exists!\n", path);
270 * Figure out the directory prefix, taking care of degenerate
273 dirpath = getdir(path);
274 fd = open(dirpath, O_RDONLY);
276 fprintf(stderr, "Cannot open directory %s\n", dirpath);
281 * Avoid foot-shooting. Don't let the user create a PFS
282 * softlink via a PFS. PFS softlinks may only be accessed
283 * via the master filesystem. Checking it here ensures
284 * other PFS commands access PFS under the master filesystem.
286 bzero(&pfs, sizeof(pfs));
287 bzero(&pfsd, sizeof(pfsd));
290 pfs.bytes = sizeof(pfsd);
292 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs);
293 if (pfs.pfs_id != HAMMER_ROOT_PFSID) {
295 "You are attempting to access a PFS softlink "
296 "from a PFS. It may not represent the PFS\n"
297 "on the main filesystem mount that you "
298 "expect! You may only access PFS softlinks\n"
299 "via the main filesystem mount!\n");
304 for (pfs_id = 0; pfs_id < HAMMER_MAX_PFS; ++pfs_id) {
305 bzero(&pfs, sizeof(pfs));
306 bzero(&pfsd, sizeof(pfsd));
309 pfs.bytes = sizeof(pfsd);
310 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
311 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
316 if (pfs_id == HAMMER_MAX_PFS) {
317 fprintf(stderr, "Cannot create %s, all PFSs in use\n", path);
319 } else if (pfs_id == HAMMER_ROOT_PFSID) {
320 fprintf(stderr, "Fatal error: PFS#%d must exist\n",
325 if (error != ENOENT) {
326 fprintf(stderr, "Cannot create %s, got %s during scan\n",
327 path, strerror(error));
334 printf("Creating PFS #%d\t", pfs_id);
335 init_pfsd(&pfsd, is_slave);
338 pfs.bytes = sizeof(pfsd);
339 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
341 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
342 printf("failed: %s\n", strerror(errno));
344 /* special symlink, must be exactly 10 characters */
345 asprintf(&linkpath, "@@PFS%05d", pfs_id);
346 if (symlink(linkpath, path) < 0) {
347 printf("failed: cannot create symlink: %s\n",
350 printf("succeeded!\n");
351 hammer_cmd_pseudofs_update(av, ac);
359 hammer_cmd_pseudofs_destroy(char **av, int ac)
361 struct hammer_ioc_pseudofs_rw pfs;
368 fd = getpfs(&pfs, av[0]);
370 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
371 fprintf(stderr, "You cannot destroy PFS#0\n");
374 printf("You have requested that PFS#%d (%s) be destroyed\n",
375 pfs.pfs_id, pfs.ondisk->label);
376 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
377 printf("Do you really want to do this? ");
380 fprintf(stderr, "No action taken on PFS#%d\n", pfs.pfs_id);
384 if (hammer_is_pfs_master(pfs.ondisk)) {
385 printf("This PFS is currently setup as a MASTER!\n");
386 printf("Are you absolutely sure you want to destroy it? ");
389 fprintf(stderr, "No action taken on PFS#%d\n",
395 printf("Destroying PFS #%d (%s) in ", pfs.pfs_id, pfs.ondisk->label);
396 for (i = 5; i; --i) {
401 printf(".. starting destruction pass\n");
405 * Remove the softlink on success.
407 if (ioctl(fd, HAMMERIOC_RMR_PSEUDOFS, &pfs) == 0) {
408 printf("pfs-destroy of PFS#%d succeeded!\n", pfs.pfs_id);
409 if (lstat(av[0], &st) == 0 && S_ISLNK(st.st_mode)) {
410 if (remove(av[0]) < 0) {
411 fprintf(stderr, "Unable to remove softlink: %s "
412 "(but the PFS has been destroyed)\n",
414 /* exit status 0 anyway */
418 printf("pfs-destroy of PFS#%d failed: %s\n",
419 pfs.pfs_id, strerror(errno));
425 hammer_cmd_pseudofs_upgrade(char **av, int ac)
427 struct hammer_ioc_pseudofs_rw pfs;
432 fd = getpfs(&pfs, av[0]);
434 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
435 fprintf(stderr, "You cannot upgrade PFS#0"
436 " (It should already be a master)\n");
438 } else if (hammer_is_pfs_master(pfs.ondisk)) {
439 printf("It is already a master\n");
443 if (ioctl(fd, HAMMERIOC_UPG_PSEUDOFS, &pfs) == 0) {
444 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
445 pfs.pfs_id, pfs.ondisk->label);
447 fprintf(stderr, "pfs-upgrade of PFS#%d (%s) failed: %s\n",
448 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
454 hammer_cmd_pseudofs_downgrade(char **av, int ac)
456 struct hammer_ioc_pseudofs_rw pfs;
461 fd = getpfs(&pfs, av[0]);
463 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
464 fprintf(stderr, "You cannot downgrade PFS#0\n");
466 } else if (hammer_is_pfs_slave(pfs.ondisk)) {
467 printf("It is already a slave\n");
471 if (ioctl(fd, HAMMERIOC_DGD_PSEUDOFS, &pfs) == 0) {
472 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
473 pfs.pfs_id, pfs.ondisk->label);
475 fprintf(stderr, "pfs-downgrade of PFS#%d (%s) failed: %s\n",
476 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
482 hammer_cmd_pseudofs_update(char **av, int ac)
484 struct hammer_ioc_pseudofs_rw pfs;
489 fd = getpfs(&pfs, av[0]);
491 printf("%s\n", av[0]);
494 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
495 parse_pfsd_options(av + 1, ac - 1, pfs.ondisk);
496 if (hammer_is_pfs_slave(pfs.ondisk) &&
497 pfs.pfs_id == HAMMER_ROOT_PFSID) {
498 printf("The real mount point cannot be made a PFS "
499 "slave, only PFS sub-directories can be made "
503 pfs.bytes = sizeof(*pfs.ondisk);
504 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) == 0) {
505 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
506 dump_pfsd(pfs.ondisk, fd);
508 printf("Unable to retrieve PFS configuration "
509 "after successful update: %s\n",
514 printf("Unable to adjust PFS configuration: %s\n",
523 init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave)
527 bzero(pfsd, sizeof(*pfsd));
528 pfsd->sync_beg_tid = 1;
529 pfsd->sync_end_tid = 1;
530 pfsd->sync_beg_ts = 0;
531 pfsd->sync_end_ts = 0;
532 uuid_create(&pfsd->shared_uuid, &status);
533 uuid_create(&pfsd->unique_uuid, &status);
535 pfsd->mirror_flags |= HAMMER_PFSD_SLAVE;
539 dump_pfsd(hammer_pseudofs_data_t pfsd, int fd)
541 struct hammer_ioc_version version;
545 printf(" sync-beg-tid=0x%016jx\n", (uintmax_t)pfsd->sync_beg_tid);
546 printf(" sync-end-tid=0x%016jx\n", (uintmax_t)pfsd->sync_end_tid);
547 uuid_to_string(&pfsd->shared_uuid, &str, &status);
548 printf(" shared-uuid=%s\n", str);
550 uuid_to_string(&pfsd->unique_uuid, &str, &status);
551 printf(" unique-uuid=%s\n", str);
553 printf(" label=\"%s\"\n", pfsd->label);
554 if (pfsd->snapshots[0])
555 printf(" snapshots=\"%s\"\n", pfsd->snapshots);
556 if (pfsd->prune_min < (60 * 60 * 24)) {
557 printf(" prune-min=%02d:%02d:%02d\n",
558 pfsd->prune_min / 60 / 60 % 24,
559 pfsd->prune_min / 60 % 60,
560 pfsd->prune_min % 60);
561 } else if (pfsd->prune_min % (60 * 60 * 24)) {
562 printf(" prune-min=%dd/%02d:%02d:%02d\n",
563 pfsd->prune_min / 60 / 60 / 24,
564 pfsd->prune_min / 60 / 60 % 24,
565 pfsd->prune_min / 60 % 60,
566 pfsd->prune_min % 60);
568 printf(" prune-min=%dd\n", pfsd->prune_min / 60 / 60 / 24);
571 if (hammer_is_pfs_slave(pfsd)) {
572 printf(" operating as a SLAVE\n");
574 printf(" operating as a MASTER\n");
578 * Snapshots directory cannot be shown when there is no fd since
579 * hammer version can't be retrieved. mirror-dump passes -1 because
580 * its input came from mirror-read output thus no path is available
583 if (fd >= 0 && pfsd->snapshots[0] == 0) {
584 bzero(&version, sizeof(version));
585 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
587 if (version.cur_version < 3) {
588 if (hammer_is_pfs_slave(pfsd)) {
589 printf(" snapshots directory not set for "
592 printf(" snapshots directory for master "
593 "defaults to <pfs>/snapshots\n");
596 printf(" snapshots directory defaults to "
597 "/var/hammer/<pfs>\n");
603 parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd)
612 if ((ptr = strchr(cmd, '=')) != NULL)
616 * Basic assignment value test
620 "option %s requires an assignment\n",
626 if (strcmp(cmd, "sync-beg-tid") == 0) {
627 pfsd->sync_beg_tid = strtoull(ptr, NULL, 16);
628 } else if (strcmp(cmd, "sync-end-tid") == 0) {
629 pfsd->sync_end_tid = strtoull(ptr, NULL, 16);
630 } else if (strcmp(cmd, "shared-uuid") == 0) {
631 uuid_from_string(ptr, &pfsd->shared_uuid, &status);
632 } else if (strcmp(cmd, "unique-uuid") == 0) {
633 uuid_from_string(ptr, &pfsd->unique_uuid, &status);
634 } else if (strcmp(cmd, "label") == 0) {
636 if (ptr[0] == '"' && ptr[len-1] == '"') {
639 } else if (ptr[0] == '"') {
641 "option %s: malformed string\n",
645 snprintf(pfsd->label, sizeof(pfsd->label), "%s", ptr);
646 } else if (strcmp(cmd, "snapshots") == 0) {
650 "option %s: '%s' must be an "
651 "absolute path\n", cmd, ptr);
654 "use 'snapshots-clear' "
655 "to unset snapshots dir\n");
659 if (len >= (int)sizeof(pfsd->snapshots)) {
661 "option %s: path too long, %d "
662 "character limit\n", cmd, len);
665 snprintf(pfsd->snapshots, sizeof(pfsd->snapshots),
667 } else if (strcmp(cmd, "snapshots-clear") == 0) {
668 pfsd->snapshots[0] = 0;
669 } else if (strcmp(cmd, "prune-min") == 0) {
670 pfsd->prune_min = timetosecs(ptr);
671 if (pfsd->prune_min < 0) {
673 "option %s: illegal time spec, "
674 "use Nd or [Nd/]hh[:mm[:ss]]\n", ptr);
678 fprintf(stderr, "invalid option: %s\n", cmd);
681 if (status != uuid_s_ok) {
682 fprintf(stderr, "option %s: error parsing uuid %s\n",
693 pseudofs_usage(int code)
696 "hammer pfs-status <dirpath> ...\n"
697 "hammer pfs-master <dirpath> [options]\n"
698 "hammer pfs-slave <dirpath> [options]\n"
699 "hammer pfs-update <dirpath> [options]\n"
700 "hammer pfs-upgrade <dirpath>\n"
701 "hammer pfs-downgrade <dirpath>\n"
702 "hammer pfs-destroy <dirpath>\n"
705 " sync-beg-tid=0x16llx\n"
706 " sync-end-tid=0x16llx\n"
707 " shared-uuid=0x16llx\n"
708 " unique-uuid=0x16llx\n"
709 " label=\"string\"\n"
710 " snapshots=\"/path\"\n"
713 " prune-min=[Nd/]hh[:mm[:ss]]\n"
719 * Convert time in the form [Nd/]hh[:mm[:ss]] to seconds.
721 * Return -1 if a parse error occurs.
722 * Return 0x7FFFFFFF if the time exceeds the maximum allowed.
726 timetosecs(char *str)
736 n = strtol(str, &ptr, 10);
743 n = strtol(ptr + 1, &ptr, 10);
751 n = strtol(ptr + 1, &ptr, 10);
756 n = strtol(ptr + 1, &ptr, 10);
764 v = days * 24 * 60 * 60 + hrs * 60 * 60 + mins * 60 + secs;