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) {
115 fprintf(stderr, "Cannot access PFS %s: %s\n",
116 path, strerror(errno));
121 * pfs.pfs_id should have been set to non -1. In this case fd
122 * could be any fd of HAMMER inodes since HAMMERIOC_GET_PSEUDOFS
123 * doesn't depend on inode attributes if it's set to a valid id.
125 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs) < 0) {
126 fprintf(stderr, "Cannot access PFS %s: %s\n",
127 path, strerror(errno));
134 * Extract the PFS id from path. Return a file descriptor of
135 * the parent directory which is expected to be located under
136 * the root filesystem (not another PFS).
139 scanpfsid(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
149 if (stat(path, &st)) {
150 /* possibly slave PFS */
151 } else if (S_ISDIR(st.st_mode)) {
152 /* possibly master or slave PFS */
154 return -1; /* neither */
158 * If the path is a link read the link.
160 if (lstat(path, &st) == 0 && S_ISLNK(st.st_mode)) {
161 n = readlink(path, buf, sizeof(buf) - 1);
171 * The symlink created by pfs-master|slave is just a symlink.
172 * One could happen to remove a symlink and relink PFS as
173 * # ln -s ./@@-1:00001 ./link
174 * which results PFS having something extra before @@.
175 * One could also directly use the PFS and results the same.
176 * Get rid of it before we extract the PFS id.
178 if (strchr(p, '/')) {
185 * Extract the PFS from the link. HAMMER will automatically
186 * convert @@PFS%05d links so if actually see one in that
187 * form the target PFS may not exist or may be corrupt. But
188 * we can extract the PFS id anyway.
190 dirpath = getdir(path);
191 if (sscanf(p, "@@PFS%d", &pfs->pfs_id) == 1) {
192 fd = open(dirpath, O_RDONLY);
193 } else if (sscanf(p, "@@%jx:%d", &dummy_tid, &pfs->pfs_id) == 2) {
194 fd = open(dirpath, O_RDONLY);
196 fd = -1; /* Failed to scan PFS id */
203 relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs)
214 hammer_cmd_pseudofs_status(char **av, int ac)
216 struct hammer_ioc_pseudofs_rw pfs;
223 for (i = 0; i < ac; ++i) {
224 fd = getpfs(&pfs, av[i]);
225 printf("%s\t", av[i]);
226 if (fd < 0 || ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
227 printf("Invalid PFS path %s\n", av[i]);
229 printf("PFS #%d {\n", pfs.pfs_id);
230 dump_pfsd(pfs.ondisk, fd);
242 hammer_cmd_pseudofs_create(char **av, int ac, int is_slave)
244 struct hammer_ioc_pseudofs_rw pfs;
245 struct hammer_pseudofs_data pfsd;
257 if (lstat(path, &st) == 0) {
258 fprintf(stderr, "Cannot create %s, file exists!\n", path);
263 * Figure out the directory prefix, taking care of degenerate
266 dirpath = getdir(path);
267 fd = open(dirpath, O_RDONLY);
269 fprintf(stderr, "Cannot open directory %s\n", dirpath);
274 * Avoid foot-shooting. Don't let the user create a PFS
275 * softlink via a PFS. PFS softlinks may only be accessed
276 * via the master filesystem. Checking it here ensures
277 * other PFS commands access PFS under the master filesystem.
279 bzero(&pfs, sizeof(pfs));
280 bzero(&pfsd, sizeof(pfsd));
283 pfs.bytes = sizeof(pfsd);
285 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs);
286 if (pfs.pfs_id != HAMMER_ROOT_PFSID) {
288 "You are attempting to access a PFS softlink "
289 "from a PFS. It may not represent the PFS\n"
290 "on the main filesystem mount that you "
291 "expect! You may only access PFS softlinks\n"
292 "via the main filesystem mount!\n");
297 for (pfs_id = 0; pfs_id < HAMMER_MAX_PFS; ++pfs_id) {
298 bzero(&pfs, sizeof(pfs));
299 bzero(&pfsd, sizeof(pfsd));
302 pfs.bytes = sizeof(pfsd);
303 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
304 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
309 if (pfs_id == HAMMER_MAX_PFS) {
310 fprintf(stderr, "Cannot create %s, all PFSs in use\n", path);
312 } else if (pfs_id == HAMMER_ROOT_PFSID) {
313 fprintf(stderr, "Fatal error: PFS#%d must exist\n",
318 if (error != ENOENT) {
319 fprintf(stderr, "Cannot create %s, got %s during scan\n",
320 path, strerror(error));
327 printf("Creating PFS #%d\t", pfs_id);
328 init_pfsd(&pfsd, is_slave);
331 pfs.bytes = sizeof(pfsd);
332 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
334 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
335 printf("failed: %s\n", strerror(errno));
337 /* special symlink, must be exactly 10 characters */
338 asprintf(&linkpath, "@@PFS%05d", pfs_id);
339 if (symlink(linkpath, path) < 0) {
340 printf("failed: cannot create symlink: %s\n",
343 printf("succeeded!\n");
344 hammer_cmd_pseudofs_update(av, ac);
352 hammer_cmd_pseudofs_destroy(char **av, int ac)
354 struct hammer_ioc_pseudofs_rw pfs;
355 struct hammer_pseudofs_data pfsd;
362 fd = getpfs(&pfs, av[0]);
364 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
365 fprintf(stderr, "You cannot destroy PFS#0\n");
368 printf("You have requested that PFS#%d (%s) be destroyed\n",
369 pfs.pfs_id, pfs.ondisk->label);
370 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
371 printf("Do you really want to do this? ");
374 fprintf(stderr, "No action taken on PFS#%d\n", pfs.pfs_id);
378 if (hammer_is_pfs_master(pfs.ondisk)) {
379 printf("This PFS is currently setup as a MASTER!\n");
380 printf("Are you absolutely sure you want to destroy it? ");
383 fprintf(stderr, "No action taken on PFS#%d\n",
389 printf("Destroying PFS #%d (%s) in ", pfs.pfs_id, pfs.ondisk->label);
390 for (i = 5; i; --i) {
395 printf(".. starting destruction pass\n");
399 * Save the original PFS data so we can restore if on failure.
400 * It fails to destroy, for example, if the PFS is still mounted.
402 bcopy(pfs.ondisk, &pfsd, sizeof(pfsd));
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));
421 * Restore the pfsd as we don't want to keep it downgraded.
422 * This simply restores ondisk PFS with the original data
423 * without creating a new root inode as it already exists.
425 bcopy(&pfsd, pfs.ondisk, sizeof(pfsd));
426 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
427 printf("Failed to restore the original PFS#%d data\n",
436 hammer_cmd_pseudofs_upgrade(char **av, int ac)
438 struct hammer_ioc_pseudofs_rw pfs;
443 fd = getpfs(&pfs, av[0]);
445 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
446 fprintf(stderr, "You cannot upgrade PFS#0"
447 " (It should already be a master)\n");
449 } else if (hammer_is_pfs_master(pfs.ondisk)) {
450 printf("It is already a master\n");
454 if (ioctl(fd, HAMMERIOC_UPG_PSEUDOFS, &pfs) == 0) {
455 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
456 pfs.pfs_id, pfs.ondisk->label);
458 fprintf(stderr, "pfs-upgrade of PFS#%d (%s) failed: %s\n",
459 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
465 hammer_cmd_pseudofs_downgrade(char **av, int ac)
467 struct hammer_ioc_pseudofs_rw pfs;
472 fd = getpfs(&pfs, av[0]);
474 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
475 fprintf(stderr, "You cannot downgrade PFS#0\n");
477 } else if (hammer_is_pfs_slave(pfs.ondisk)) {
478 printf("It is already a slave\n");
482 if (ioctl(fd, HAMMERIOC_DGD_PSEUDOFS, &pfs) == 0) {
483 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
484 pfs.pfs_id, pfs.ondisk->label);
486 fprintf(stderr, "pfs-downgrade of PFS#%d (%s) failed: %s\n",
487 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
493 hammer_cmd_pseudofs_update(char **av, int ac)
495 struct hammer_ioc_pseudofs_rw pfs;
500 fd = getpfs(&pfs, av[0]);
502 printf("%s\n", av[0]);
505 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
506 parse_pfsd_options(av + 1, ac - 1, pfs.ondisk);
507 if (hammer_is_pfs_slave(pfs.ondisk) &&
508 pfs.pfs_id == HAMMER_ROOT_PFSID) {
509 printf("The real mount point cannot be made a PFS "
510 "slave, only PFS sub-directories can be made "
514 pfs.bytes = sizeof(*pfs.ondisk);
515 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) == 0) {
516 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
517 dump_pfsd(pfs.ondisk, fd);
519 printf("Unable to retrieve PFS configuration "
520 "after successful update: %s\n",
525 printf("Unable to adjust PFS configuration: %s\n",
534 init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave)
538 bzero(pfsd, sizeof(*pfsd));
539 pfsd->sync_beg_tid = 1;
540 pfsd->sync_end_tid = 1;
541 pfsd->sync_beg_ts = 0;
542 pfsd->sync_end_ts = 0;
543 uuid_create(&pfsd->shared_uuid, &status);
544 uuid_create(&pfsd->unique_uuid, &status);
546 pfsd->mirror_flags |= HAMMER_PFSD_SLAVE;
550 dump_pfsd(hammer_pseudofs_data_t pfsd, int fd)
552 struct hammer_ioc_version version;
556 printf(" sync-beg-tid=0x%016jx\n", (uintmax_t)pfsd->sync_beg_tid);
557 printf(" sync-end-tid=0x%016jx\n", (uintmax_t)pfsd->sync_end_tid);
558 uuid_to_string(&pfsd->shared_uuid, &str, &status);
559 printf(" shared-uuid=%s\n", str);
561 uuid_to_string(&pfsd->unique_uuid, &str, &status);
562 printf(" unique-uuid=%s\n", str);
564 printf(" label=\"%s\"\n", pfsd->label);
565 if (pfsd->snapshots[0])
566 printf(" snapshots=\"%s\"\n", pfsd->snapshots);
567 if (pfsd->prune_min < (60 * 60 * 24)) {
568 printf(" prune-min=%02d:%02d:%02d\n",
569 pfsd->prune_min / 60 / 60 % 24,
570 pfsd->prune_min / 60 % 60,
571 pfsd->prune_min % 60);
572 } else if (pfsd->prune_min % (60 * 60 * 24)) {
573 printf(" prune-min=%dd/%02d:%02d:%02d\n",
574 pfsd->prune_min / 60 / 60 / 24,
575 pfsd->prune_min / 60 / 60 % 24,
576 pfsd->prune_min / 60 % 60,
577 pfsd->prune_min % 60);
579 printf(" prune-min=%dd\n", pfsd->prune_min / 60 / 60 / 24);
582 if (hammer_is_pfs_slave(pfsd)) {
583 printf(" operating as a SLAVE\n");
585 printf(" operating as a MASTER\n");
589 * Snapshots directory cannot be shown when there is no fd since
590 * hammer version can't be retrieved. mirror-dump passes -1 because
591 * its input came from mirror-read output thus no path is available
594 if (fd >= 0 && pfsd->snapshots[0] == 0) {
595 bzero(&version, sizeof(version));
596 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
598 if (version.cur_version < 3) {
599 if (hammer_is_pfs_slave(pfsd)) {
600 printf(" snapshots directory not set for "
603 printf(" snapshots directory for master "
604 "defaults to <pfs>/snapshots\n");
607 printf(" snapshots directory defaults to "
608 "/var/hammer/<pfs>\n");
614 parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd)
623 if ((ptr = strchr(cmd, '=')) != NULL)
627 * Basic assignment value test
631 "option %s requires an assignment\n",
637 if (strcmp(cmd, "sync-beg-tid") == 0) {
638 pfsd->sync_beg_tid = strtoull(ptr, NULL, 16);
639 } else if (strcmp(cmd, "sync-end-tid") == 0) {
640 pfsd->sync_end_tid = strtoull(ptr, NULL, 16);
641 } else if (strcmp(cmd, "shared-uuid") == 0) {
642 uuid_from_string(ptr, &pfsd->shared_uuid, &status);
643 } else if (strcmp(cmd, "unique-uuid") == 0) {
644 uuid_from_string(ptr, &pfsd->unique_uuid, &status);
645 } else if (strcmp(cmd, "label") == 0) {
647 if (ptr[0] == '"' && ptr[len-1] == '"') {
650 } else if (ptr[0] == '"') {
652 "option %s: malformed string\n",
656 snprintf(pfsd->label, sizeof(pfsd->label), "%s", ptr);
657 } else if (strcmp(cmd, "snapshots") == 0) {
661 "option %s: '%s' must be an "
662 "absolute path\n", cmd, ptr);
665 "use 'snapshots-clear' "
666 "to unset snapshots dir\n");
670 if (len >= (int)sizeof(pfsd->snapshots)) {
672 "option %s: path too long, %d "
673 "character limit\n", cmd, len);
676 snprintf(pfsd->snapshots, sizeof(pfsd->snapshots),
678 } else if (strcmp(cmd, "snapshots-clear") == 0) {
679 pfsd->snapshots[0] = 0;
680 } else if (strcmp(cmd, "prune-min") == 0) {
681 pfsd->prune_min = timetosecs(ptr);
682 if (pfsd->prune_min < 0) {
684 "option %s: illegal time spec, "
685 "use Nd or [Nd/]hh[:mm[:ss]]\n", ptr);
689 fprintf(stderr, "invalid option: %s\n", cmd);
692 if (status != uuid_s_ok) {
693 fprintf(stderr, "option %s: error parsing uuid %s\n",
704 pseudofs_usage(int code)
707 "hammer pfs-status <dirpath> ...\n"
708 "hammer pfs-master <dirpath> [options]\n"
709 "hammer pfs-slave <dirpath> [options]\n"
710 "hammer pfs-update <dirpath> [options]\n"
711 "hammer pfs-upgrade <dirpath>\n"
712 "hammer pfs-downgrade <dirpath>\n"
713 "hammer pfs-destroy <dirpath>\n"
716 " sync-beg-tid=0x16llx\n"
717 " sync-end-tid=0x16llx\n"
718 " shared-uuid=0x16llx\n"
719 " unique-uuid=0x16llx\n"
720 " label=\"string\"\n"
721 " snapshots=\"/path\"\n"
724 " prune-min=[Nd/]hh[:mm[:ss]]\n"
730 * Convert time in the form [Nd/]hh[:mm[:ss]] to seconds.
732 * Return -1 if a parse error occurs.
733 * Return 0x7FFFFFFF if the time exceeds the maximum allowed.
737 timetosecs(char *str)
747 n = strtol(str, &ptr, 10);
754 n = strtol(ptr + 1, &ptr, 10);
762 n = strtol(ptr + 1, &ptr, 10);
767 n = strtol(ptr + 1, &ptr, 10);
775 v = days * 24 * 60 * 60 + hrs * 60 * 60 + mins * 60 + secs;