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
;
260 if (lstat(path
, &st
) == 0) {
261 errx(1, "Cannot create %s, file exists!", path
);
263 } else if (path
[strlen(path
) - 1] == '/') {
264 errx(1, "Invalid PFS path %s with trailing /", path
);
269 * Figure out the directory prefix, taking care of degenerate
272 dirpath
= dirname(path
);
273 fd
= open(dirpath
, O_RDONLY
);
275 err(1, "Cannot open directory %s", dirpath
);
280 * Avoid foot-shooting. Don't let the user create a PFS
281 * softlink via a PFS. PFS softlinks may only be accessed
282 * via the master filesystem. Checking it here ensures
283 * other PFS commands access PFS under the master filesystem.
285 clrpfs(&pfs
, &pfsd
, -1);
287 ioctl(fd
, HAMMERIOC_GET_PSEUDOFS
, &pfs
);
288 if (pfs
.pfs_id
!= HAMMER_ROOT_PFSID
) {
290 "You are attempting to access a PFS softlink "
291 "from a PFS. It may not represent the PFS\n"
292 "on the main filesystem mount that you "
293 "expect! You may only access PFS softlinks\n"
294 "via the main filesystem mount!\n");
298 for (pfs_id
= 0; pfs_id
< HAMMER_MAX_PFS
; ++pfs_id
) {
299 clrpfs(&pfs
, &pfsd
, pfs_id
);
300 if (ioctl(fd
, HAMMERIOC_GET_PSEUDOFS
, &pfs
) < 0) {
301 if (errno
!= ENOENT
) {
302 err(1, "Cannot create %s", path
);
308 if (pfs_id
== HAMMER_MAX_PFS
) {
309 errx(1, "Cannot create %s, all PFSs in use", path
);
311 } else if (pfs_id
== HAMMER_ROOT_PFSID
) {
312 errx(1, "Fatal error: PFS#%d must exist", HAMMER_ROOT_PFSID
);
319 printf("Creating PFS#%d\t", pfs_id
);
320 clrpfs(&pfs
, &pfsd
, pfs_id
);
321 init_pfsd(&pfsd
, is_slave
);
323 if (ioctl(fd
, HAMMERIOC_SET_PSEUDOFS
, &pfs
) < 0) {
324 printf("failed: %s\n", strerror(errno
));
326 /* special symlink, must be exactly 10 characters */
327 asprintf(&linkpath
, "@@PFS%05d", pfs_id
);
328 if (symlink(linkpath
, path
) < 0) {
329 printf("failed: cannot create symlink: %s\n",
332 printf("succeeded!\n");
333 hammer_cmd_pseudofs_update(av
, ac
);
341 hammer_cmd_pseudofs_destroy(char **av
, int ac
)
343 struct hammer_ioc_pseudofs_rw pfs
;
352 fd
= getpfs(&pfs
, av
[0]);
354 if (pfs
.pfs_id
== HAMMER_ROOT_PFSID
) {
355 errx(1, "You cannot destroy PFS#%d", HAMMER_ROOT_PFSID
);
359 printf("You have requested that PFS#%d (%s) be destroyed\n",
360 pfs
.pfs_id
, pfs
.ondisk
->label
);
361 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
362 printf("Do you really want to do this? [y/n] ");
365 errx(1, "No action taken on PFS#%d", pfs
.pfs_id
);
369 if (hammer_is_pfs_master(pfs
.ondisk
)) {
370 printf("This PFS is currently setup as a MASTER!\n");
371 printf("Are you absolutely sure you want to destroy it? [y/n] ");
374 errx(1, "No action taken on PFS#%d", pfs
.pfs_id
);
379 printf("Destroying PFS#%d (%s)", pfs
.pfs_id
, pfs
.ondisk
->label
);
384 for (i
= 5; i
; --i
) {
389 printf(".. starting destruction pass\n");
393 * Remove the softlink on success.
395 if (ioctl(fd
, HAMMERIOC_RMR_PSEUDOFS
, &pfs
) == 0) {
396 printf("pfs-destroy of PFS#%d succeeded!\n", pfs
.pfs_id
);
397 linkpath
= getlink(av
[0]);
399 if (remove(linkpath
) < 0) {
400 err(1, "Unable to remove softlink %s", linkpath
);
406 printf("pfs-destroy of PFS#%d failed: %s\n",
407 pfs
.pfs_id
, strerror(errno
));
413 hammer_cmd_pseudofs_upgrade(char **av
, int ac
)
415 struct hammer_ioc_pseudofs_rw pfs
;
422 fd
= getpfs(&pfs
, av
[0]);
424 if (pfs
.pfs_id
== HAMMER_ROOT_PFSID
) {
425 errx(1, "You cannot upgrade PFS#%d"
426 " (It should already be a master)",
429 } else if (hammer_is_pfs_master(pfs
.ondisk
)) {
430 errx(1, "It is already a master");
434 if (ioctl(fd
, HAMMERIOC_UPG_PSEUDOFS
, &pfs
) == 0) {
435 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
436 pfs
.pfs_id
, pfs
.ondisk
->label
);
438 err(1, "pfs-upgrade of PFS#%d (%s) failed",
439 pfs
.pfs_id
, pfs
.ondisk
->label
);
446 hammer_cmd_pseudofs_downgrade(char **av
, int ac
)
448 struct hammer_ioc_pseudofs_rw pfs
;
455 fd
= getpfs(&pfs
, av
[0]);
457 if (pfs
.pfs_id
== HAMMER_ROOT_PFSID
) {
458 errx(1, "You cannot downgrade PFS#%d", HAMMER_ROOT_PFSID
);
460 } else if (hammer_is_pfs_slave(pfs
.ondisk
)) {
461 errx(1, "It is already a slave");
465 if (ioctl(fd
, HAMMERIOC_DGD_PSEUDOFS
, &pfs
) == 0) {
466 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
467 pfs
.pfs_id
, pfs
.ondisk
->label
);
469 err(1, "pfs-downgrade of PFS#%d (%s) failed",
470 pfs
.pfs_id
, pfs
.ondisk
->label
);
477 hammer_cmd_pseudofs_update(char **av
, int ac
)
479 struct hammer_ioc_pseudofs_rw pfs
;
486 fd
= getpfs(&pfs
, av
[0]);
488 printf("%s\n", av
[0]);
491 if (ioctl(fd
, HAMMERIOC_GET_PSEUDOFS
, &pfs
) == 0) {
492 parse_pfsd_options(av
+ 1, ac
- 1, pfs
.ondisk
);
493 if (hammer_is_pfs_slave(pfs
.ondisk
) &&
494 pfs
.pfs_id
== HAMMER_ROOT_PFSID
) {
495 errx(1, "The real mount point cannot be made a PFS "
496 "slave, only PFS sub-directories can be made "
500 pfs
.bytes
= sizeof(*pfs
.ondisk
);
501 if (ioctl(fd
, HAMMERIOC_SET_PSEUDOFS
, &pfs
) == 0) {
502 if (ioctl(fd
, HAMMERIOC_GET_PSEUDOFS
, &pfs
) == 0) {
503 dump_pfsd(pfs
.ondisk
, fd
);
505 err(1, "Unable to retrieve PFS configuration "
506 "after successful update");
510 err(1, "Unable to adjust PFS configuration");
518 init_pfsd(hammer_pseudofs_data_t pfsd
, int is_slave
)
522 bzero(pfsd
, sizeof(*pfsd
));
523 pfsd
->sync_beg_tid
= 1;
524 pfsd
->sync_end_tid
= 1;
525 pfsd
->sync_beg_ts
= 0;
526 pfsd
->sync_end_ts
= 0;
527 uuid_create(&pfsd
->shared_uuid
, &status
);
528 uuid_create(&pfsd
->unique_uuid
, &status
);
530 pfsd
->mirror_flags
|= HAMMER_PFSD_SLAVE
;
534 dump_pfsd(hammer_pseudofs_data_t pfsd
, int fd
)
536 struct hammer_ioc_version version
;
540 printf(" sync-beg-tid=0x%016jx\n", (uintmax_t)pfsd
->sync_beg_tid
);
541 printf(" sync-end-tid=0x%016jx\n", (uintmax_t)pfsd
->sync_end_tid
);
542 uuid_to_string(&pfsd
->shared_uuid
, &str
, &status
);
543 printf(" shared-uuid=%s\n", str
);
545 uuid_to_string(&pfsd
->unique_uuid
, &str
, &status
);
546 printf(" unique-uuid=%s\n", str
);
548 printf(" label=\"%s\"\n", pfsd
->label
);
549 if (pfsd
->snapshots
[0])
550 printf(" snapshots=\"%s\"\n", pfsd
->snapshots
);
551 if (pfsd
->prune_min
< (60 * 60 * 24)) {
552 printf(" prune-min=%02d:%02d:%02d\n",
553 pfsd
->prune_min
/ 60 / 60 % 24,
554 pfsd
->prune_min
/ 60 % 60,
555 pfsd
->prune_min
% 60);
556 } else if (pfsd
->prune_min
% (60 * 60 * 24)) {
557 printf(" prune-min=%dd/%02d:%02d:%02d\n",
558 pfsd
->prune_min
/ 60 / 60 / 24,
559 pfsd
->prune_min
/ 60 / 60 % 24,
560 pfsd
->prune_min
/ 60 % 60,
561 pfsd
->prune_min
% 60);
563 printf(" prune-min=%dd\n", pfsd
->prune_min
/ 60 / 60 / 24);
566 if (hammer_is_pfs_slave(pfsd
))
567 printf(" operating as a SLAVE\n");
569 printf(" operating as a MASTER\n");
572 * Snapshots directory cannot be shown when there is no fd since
573 * hammer version can't be retrieved. mirror-dump passes -1 because
574 * its input came from mirror-read output thus no path is available
577 if (fd
>= 0 && pfsd
->snapshots
[0] == 0) {
578 bzero(&version
, sizeof(version
));
579 if (ioctl(fd
, HAMMERIOC_GET_VERSION
, &version
) < 0)
581 HammerVersion
= version
.cur_version
;
582 if (version
.cur_version
< 3) {
583 if (hammer_is_pfs_slave(pfsd
)) {
584 printf(" snapshots directory not set for "
587 printf(" snapshots directory for master "
588 "defaults to <pfs>/snapshots\n");
591 printf(" snapshots directory defaults to "
592 "/var/hammer/<pfs>\n");
598 parse_pfsd_options(char **av
, int ac
, hammer_pseudofs_data_t pfsd
)
607 if ((ptr
= strchr(cmd
, '=')) != NULL
)
611 * Basic assignment value test
614 errx(1, "option %s requires an assignment", cmd
);
619 if (strcmp(cmd
, "sync-beg-tid") == 0) {
620 pfsd
->sync_beg_tid
= strtoull(ptr
, NULL
, 16);
621 } else if (strcmp(cmd
, "sync-end-tid") == 0) {
622 pfsd
->sync_end_tid
= strtoull(ptr
, NULL
, 16);
623 } else if (strcmp(cmd
, "shared-uuid") == 0) {
624 uuid_from_string(ptr
, &pfsd
->shared_uuid
, &status
);
625 } else if (strcmp(cmd
, "unique-uuid") == 0) {
626 uuid_from_string(ptr
, &pfsd
->unique_uuid
, &status
);
627 } else if (strcmp(cmd
, "label") == 0) {
629 if (ptr
[0] == '"' && ptr
[len
-1] == '"') {
632 } else if (ptr
[0] == '"') {
633 errx(1, "option %s: malformed string", cmd
);
636 snprintf(pfsd
->label
, sizeof(pfsd
->label
), "%s", ptr
);
637 } else if (strcmp(cmd
, "snapshots") == 0) {
641 "option %s: '%s' must be an "
642 "absolute path\n", cmd
, ptr
);
645 "use 'snapshots-clear' "
646 "to unset snapshots dir\n");
650 if (len
>= (int)sizeof(pfsd
->snapshots
)) {
651 errx(1, "option %s: path too long, %d "
652 "character limit", cmd
, len
);
655 snprintf(pfsd
->snapshots
, sizeof(pfsd
->snapshots
),
657 } else if (strcmp(cmd
, "snapshots-clear") == 0) {
658 pfsd
->snapshots
[0] = 0;
659 } else if (strcmp(cmd
, "prune-min") == 0) {
660 pfsd
->prune_min
= timetosecs(ptr
);
661 if (pfsd
->prune_min
< 0) {
662 errx(1, "option %s: illegal time spec, "
663 "use Nd or [Nd/]hh[:mm[:ss]]", ptr
);
667 errx(1, "invalid option: %s", cmd
);
670 if (status
!= uuid_s_ok
) {
671 errx(1, "option %s: error parsing uuid %s", cmd
, ptr
);
681 pseudofs_usage(int code
)
684 "hammer pfs-status <dirpath> ...\n"
685 "hammer pfs-master <dirpath> [options]\n"
686 "hammer pfs-slave <dirpath> [options]\n"
687 "hammer pfs-update <dirpath> [options]\n"
688 "hammer pfs-upgrade <dirpath>\n"
689 "hammer pfs-downgrade <dirpath>\n"
690 "hammer pfs-destroy <dirpath>\n"
693 " sync-beg-tid=0x16llx\n"
694 " sync-end-tid=0x16llx\n"
695 " shared-uuid=0x16llx\n"
696 " unique-uuid=0x16llx\n"
697 " label=\"string\"\n"
698 " snapshots=\"/path\"\n"
701 " prune-min=[Nd/]hh[:mm[:ss]]\n"
707 * Convert time in the form [Nd/]hh[:mm[:ss]] to seconds.
709 * Return -1 if a parse error occurs.
710 * Return 0x7FFFFFFF if the time exceeds the maximum allowed.
714 timetosecs(char *str
)
724 n
= strtol(str
, &ptr
, 10);
731 n
= strtol(ptr
+ 1, &ptr
, 10);
739 n
= strtol(ptr
+ 1, &ptr
, 10);
744 n
= strtol(ptr
+ 1, &ptr
, 10);
752 v
= days
* 24 * 60 * 60 + hrs
* 60 * 60 + mins
* 60 + secs
;