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 clrpfs(struct hammer_ioc_pseudofs_rw *pfs, hammer_pseudofs_data_t pfsd,
51 bzero(pfs, sizeof(*pfs));
56 pfs->ondisk = malloc(sizeof(*pfs->ondisk));
57 bzero(pfs->ondisk, sizeof(*pfs->ondisk));
60 pfs->bytes = sizeof(*pfs->ondisk);
61 pfs->version = HAMMER_IOC_PSEUDOFS_VERSION;
65 * If path is a symlink, return strdup'd path.
66 * If it's a directory via symlink, strip trailing /
67 * from strdup'd path and return the symlink.
70 getlink(const char *path)
78 linkpath = strdup(path);
80 if (S_ISDIR(st.st_mode)) {
81 i = strlen(linkpath) - 1;
82 while (i > 0 && linkpath[i] == '/')
86 if (S_ISLNK(st.st_mode))
94 * Calculate the PFS id given a path to a file/directory or
95 * a @@%llx:%d softlink.
98 getpfs(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
102 clrpfs(pfs, NULL, -1);
105 * Extract the PFS id.
106 * dirname(path) is supposed to be a directory in root PFS.
108 if (scanpfsid(pfs, path) == 0)
109 path = dirname(path); /* strips trailing / first if any */
112 * Open the path regardless of scanpfsid() result, since some
113 * commands can take a regular file/directory (e.g. pfs-status).
115 fd = open(path, O_RDONLY);
117 err(1, "Failed to open %s", path);
122 * If pfs.pfs_id has been set to non -1, the file descriptor fd
123 * could be any fd of HAMMER inodes since HAMMERIOC_GET_PSEUDOFS
124 * doesn't depend on inode attributes if it's set to a valid id.
126 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs) < 0) {
127 err(1, "Cannot access %s", path);
135 * Extract the PFS id from path.
138 scanpfsid(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
146 ; /* possibly slave PFS */
147 else if (S_ISDIR(st.st_mode))
148 ; /* possibly master or slave PFS */
150 return(-1); /* neither */
152 linkpath = getlink(path);
155 * Read the symlink assuming it's a link to PFS.
157 bzero(buf, sizeof(buf));
158 if (readlink(linkpath, buf, sizeof(buf) - 1) < 0) {
167 * The symlink created by pfs-master|slave is just a symlink.
168 * One could happen to remove a symlink and relink PFS as
169 * # ln -s ./@@-1:00001 ./link
170 * which results PFS having something extra before @@.
171 * One could also directly use the PFS and results the same.
172 * Get rid of it before we extract the PFS id.
174 if (strchr(path, '/')) {
175 path = basename(path); /* strips trailing / first if any */
183 * Test and extract the PFS id from the link.
184 * "@@%jx:%d" covers both "@@-1:%05d" format for master PFS
185 * and "@@0x%016jx:%05d" format for slave PFS.
187 if (sscanf(path, "@@%jx:%d", &dummy_tid, &pfs->pfs_id) == 2) {
188 assert(pfs->pfs_id > 0);
196 relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs)
207 print_pfs_status(char *path)
209 struct hammer_ioc_pseudofs_rw pfs;
212 fd = getpfs(&pfs, path);
213 printf("%s\t", path);
214 if (fd < 0 || ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
215 printf("Invalid PFS path %s\n", path);
217 printf("PFS#%d {\n", pfs.pfs_id);
218 dump_pfsd(pfs.ondisk, fd);
229 hammer_cmd_pseudofs_status(char **av, int ac)
234 char buf[2] = "."; /* can't be readonly string */
235 print_pfs_status(buf);
239 for (i = 0; i < ac; ++i)
240 print_pfs_status(av[i]);
244 hammer_cmd_pseudofs_create(char **av, int ac, int is_slave)
246 struct hammer_ioc_pseudofs_rw pfs;
247 struct hammer_pseudofs_data pfsd;
258 if (lstat(path, &st) == 0) {
259 errx(1, "Cannot create %s, file exists!", path);
261 } else if (path[strlen(path) - 1] == '/') {
262 errx(1, "Invalid PFS path %s with trailing /", path);
267 * Figure out the directory prefix, taking care of degenerate
270 dirpath = dirname(path);
271 fd = open(dirpath, O_RDONLY);
273 err(1, "Cannot open directory %s", dirpath);
278 * Avoid foot-shooting. Don't let the user create a PFS
279 * softlink via a PFS. PFS softlinks may only be accessed
280 * via the master filesystem. Checking it here ensures
281 * other PFS commands access PFS under the master filesystem.
283 clrpfs(&pfs, &pfsd, -1);
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");
296 for (pfs_id = 0; pfs_id < HAMMER_MAX_PFS; ++pfs_id) {
297 clrpfs(&pfs, &pfsd, pfs_id);
298 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
299 if (errno != ENOENT) {
300 err(1, "Cannot create %s", path);
306 if (pfs_id == HAMMER_MAX_PFS) {
307 errx(1, "Cannot create %s, all PFSs in use", path);
309 } else if (pfs_id == HAMMER_ROOT_PFSID) {
310 errx(1, "Fatal error: PFS#%d must exist", HAMMER_ROOT_PFSID);
317 printf("Creating PFS#%d\t", pfs_id);
318 clrpfs(&pfs, &pfsd, pfs_id);
319 init_pfsd(&pfsd, is_slave);
321 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
322 printf("failed: %s\n", strerror(errno));
324 /* special symlink, must be exactly 10 characters */
325 asprintf(&linkpath, "@@PFS%05d", pfs_id);
326 if (symlink(linkpath, path) < 0) {
327 printf("failed: cannot create symlink: %s\n",
330 printf("succeeded!\n");
331 hammer_cmd_pseudofs_update(av, ac);
339 hammer_cmd_pseudofs_destroy(char **av, int ac)
341 struct hammer_ioc_pseudofs_rw pfs;
348 fd = getpfs(&pfs, av[0]);
350 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
351 errx(1, "You cannot destroy PFS#%d", HAMMER_ROOT_PFSID);
355 printf("You have requested that PFS#%d (%s) be destroyed\n",
356 pfs.pfs_id, pfs.ondisk->label);
357 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
358 printf("Do you really want to do this? [y/n] ");
361 errx(1, "No action taken on PFS#%d", pfs.pfs_id);
365 if (hammer_is_pfs_master(pfs.ondisk)) {
366 printf("This PFS is currently setup as a MASTER!\n");
367 printf("Are you absolutely sure you want to destroy it? [y/n] ");
370 errx(1, "No action taken on PFS#%d", pfs.pfs_id);
375 printf("Destroying PFS#%d (%s)", pfs.pfs_id, pfs.ondisk->label);
380 for (i = 5; i; --i) {
385 printf(".. starting destruction pass\n");
389 * Remove the softlink on success.
391 if (ioctl(fd, HAMMERIOC_RMR_PSEUDOFS, &pfs) == 0) {
392 printf("pfs-destroy of PFS#%d succeeded!\n", pfs.pfs_id);
393 linkpath = getlink(av[0]);
395 if (remove(linkpath) < 0) {
396 err(1, "Unable to remove softlink %s", linkpath);
402 printf("pfs-destroy of PFS#%d failed: %s\n",
403 pfs.pfs_id, strerror(errno));
409 hammer_cmd_pseudofs_upgrade(char **av, int ac)
411 struct hammer_ioc_pseudofs_rw pfs;
416 fd = getpfs(&pfs, av[0]);
418 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
419 errx(1, "You cannot upgrade PFS#%d"
420 " (It should already be a master)",
423 } else if (hammer_is_pfs_master(pfs.ondisk)) {
424 errx(1, "It is already a master");
428 if (ioctl(fd, HAMMERIOC_UPG_PSEUDOFS, &pfs) == 0) {
429 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
430 pfs.pfs_id, pfs.ondisk->label);
432 err(1, "pfs-upgrade of PFS#%d (%s) failed",
433 pfs.pfs_id, pfs.ondisk->label);
440 hammer_cmd_pseudofs_downgrade(char **av, int ac)
442 struct hammer_ioc_pseudofs_rw pfs;
447 fd = getpfs(&pfs, av[0]);
449 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
450 errx(1, "You cannot downgrade PFS#%d", HAMMER_ROOT_PFSID);
452 } else if (hammer_is_pfs_slave(pfs.ondisk)) {
453 errx(1, "It is already a slave");
457 if (ioctl(fd, HAMMERIOC_DGD_PSEUDOFS, &pfs) == 0) {
458 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
459 pfs.pfs_id, pfs.ondisk->label);
461 err(1, "pfs-downgrade of PFS#%d (%s) failed",
462 pfs.pfs_id, pfs.ondisk->label);
469 hammer_cmd_pseudofs_update(char **av, int ac)
471 struct hammer_ioc_pseudofs_rw pfs;
476 fd = getpfs(&pfs, av[0]);
478 printf("%s\n", av[0]);
481 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
482 parse_pfsd_options(av + 1, ac - 1, pfs.ondisk);
483 if (hammer_is_pfs_slave(pfs.ondisk) &&
484 pfs.pfs_id == HAMMER_ROOT_PFSID) {
485 errx(1, "The real mount point cannot be made a PFS "
486 "slave, only PFS sub-directories can be made "
490 pfs.bytes = sizeof(*pfs.ondisk);
491 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) == 0) {
492 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
493 dump_pfsd(pfs.ondisk, fd);
495 err(1, "Unable to retrieve PFS configuration "
496 "after successful update");
500 err(1, "Unable to adjust PFS configuration");
508 init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave)
512 bzero(pfsd, sizeof(*pfsd));
513 pfsd->sync_beg_tid = 1;
514 pfsd->sync_end_tid = 1;
515 pfsd->sync_beg_ts = 0;
516 pfsd->sync_end_ts = 0;
517 uuid_create(&pfsd->shared_uuid, &status);
518 uuid_create(&pfsd->unique_uuid, &status);
520 pfsd->mirror_flags |= HAMMER_PFSD_SLAVE;
524 dump_pfsd(hammer_pseudofs_data_t pfsd, int fd)
526 struct hammer_ioc_version version;
530 printf(" sync-beg-tid=0x%016jx\n", (uintmax_t)pfsd->sync_beg_tid);
531 printf(" sync-end-tid=0x%016jx\n", (uintmax_t)pfsd->sync_end_tid);
532 uuid_to_string(&pfsd->shared_uuid, &str, &status);
533 printf(" shared-uuid=%s\n", str);
535 uuid_to_string(&pfsd->unique_uuid, &str, &status);
536 printf(" unique-uuid=%s\n", str);
538 printf(" label=\"%s\"\n", pfsd->label);
539 if (pfsd->snapshots[0])
540 printf(" snapshots=\"%s\"\n", pfsd->snapshots);
541 if (pfsd->prune_min < (60 * 60 * 24)) {
542 printf(" prune-min=%02d:%02d:%02d\n",
543 pfsd->prune_min / 60 / 60 % 24,
544 pfsd->prune_min / 60 % 60,
545 pfsd->prune_min % 60);
546 } else if (pfsd->prune_min % (60 * 60 * 24)) {
547 printf(" prune-min=%dd/%02d:%02d:%02d\n",
548 pfsd->prune_min / 60 / 60 / 24,
549 pfsd->prune_min / 60 / 60 % 24,
550 pfsd->prune_min / 60 % 60,
551 pfsd->prune_min % 60);
553 printf(" prune-min=%dd\n", pfsd->prune_min / 60 / 60 / 24);
556 if (hammer_is_pfs_slave(pfsd))
557 printf(" operating as a SLAVE\n");
559 printf(" operating as a MASTER\n");
562 * Snapshots directory cannot be shown when there is no fd since
563 * hammer version can't be retrieved. mirror-dump passes -1 because
564 * its input came from mirror-read output thus no path is available
567 if (fd >= 0 && pfsd->snapshots[0] == 0) {
568 bzero(&version, sizeof(version));
569 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
571 HammerVersion = version.cur_version;
572 if (version.cur_version < 3) {
573 if (hammer_is_pfs_slave(pfsd)) {
574 printf(" snapshots directory not set for "
577 printf(" snapshots directory for master "
578 "defaults to <pfs>/snapshots\n");
581 printf(" snapshots directory defaults to "
582 "/var/hammer/<pfs>\n");
588 parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd)
597 if ((ptr = strchr(cmd, '=')) != NULL)
601 * Basic assignment value test
604 errx(1, "option %s requires an assignment", cmd);
609 if (strcmp(cmd, "sync-beg-tid") == 0) {
610 pfsd->sync_beg_tid = strtoull(ptr, NULL, 16);
611 } else if (strcmp(cmd, "sync-end-tid") == 0) {
612 pfsd->sync_end_tid = strtoull(ptr, NULL, 16);
613 } else if (strcmp(cmd, "shared-uuid") == 0) {
614 uuid_from_string(ptr, &pfsd->shared_uuid, &status);
615 } else if (strcmp(cmd, "unique-uuid") == 0) {
616 uuid_from_string(ptr, &pfsd->unique_uuid, &status);
617 } else if (strcmp(cmd, "label") == 0) {
619 if (ptr[0] == '"' && ptr[len-1] == '"') {
622 } else if (ptr[0] == '"') {
623 errx(1, "option %s: malformed string", cmd);
626 snprintf(pfsd->label, sizeof(pfsd->label), "%s", ptr);
627 } else if (strcmp(cmd, "snapshots") == 0) {
631 "option %s: '%s' must be an "
632 "absolute path\n", cmd, ptr);
635 "use 'snapshots-clear' "
636 "to unset snapshots dir\n");
640 if (len >= (int)sizeof(pfsd->snapshots)) {
641 errx(1, "option %s: path too long, %d "
642 "character limit", cmd, len);
645 snprintf(pfsd->snapshots, sizeof(pfsd->snapshots),
647 } else if (strcmp(cmd, "snapshots-clear") == 0) {
648 pfsd->snapshots[0] = 0;
649 } else if (strcmp(cmd, "prune-min") == 0) {
650 pfsd->prune_min = timetosecs(ptr);
651 if (pfsd->prune_min < 0) {
652 errx(1, "option %s: illegal time spec, "
653 "use Nd or [Nd/]hh[:mm[:ss]]", ptr);
657 errx(1, "invalid option: %s", cmd);
660 if (status != uuid_s_ok) {
661 errx(1, "option %s: error parsing uuid %s", cmd, ptr);
671 pseudofs_usage(int code)
674 "hammer pfs-status <dirpath> ...\n"
675 "hammer pfs-master <dirpath> [options]\n"
676 "hammer pfs-slave <dirpath> [options]\n"
677 "hammer pfs-update <dirpath> [options]\n"
678 "hammer pfs-upgrade <dirpath>\n"
679 "hammer pfs-downgrade <dirpath>\n"
680 "hammer pfs-destroy <dirpath>\n"
683 " sync-beg-tid=0x16llx\n"
684 " sync-end-tid=0x16llx\n"
685 " shared-uuid=0x16llx\n"
686 " unique-uuid=0x16llx\n"
687 " label=\"string\"\n"
688 " snapshots=\"/path\"\n"
691 " prune-min=[Nd/]hh[:mm[:ss]]\n"
697 * Convert time in the form [Nd/]hh[:mm[:ss]] to seconds.
699 * Return -1 if a parse error occurs.
700 * Return 0x7FFFFFFF if the time exceeds the maximum allowed.
704 timetosecs(char *str)
714 n = strtol(str, &ptr, 10);
721 n = strtol(ptr + 1, &ptr, 10);
729 n = strtol(ptr + 1, &ptr, 10);
734 n = strtol(ptr + 1, &ptr, 10);
742 v = days * 24 * 60 * 60 + hrs * 60 * 60 + mins * 60 + secs;