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);
120 * If pfs.pfs_id has been set to non -1, the file descriptor fd
121 * could be any fd of HAMMER inodes since HAMMERIOC_GET_PSEUDOFS
122 * doesn't depend on inode attributes if it's set to a valid id.
124 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs) < 0)
125 err(1, "Cannot access %s", path);
131 * Extract the PFS id from path.
134 scanpfsid(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
142 ; /* possibly slave PFS */
143 else if (S_ISDIR(st.st_mode))
144 ; /* possibly master or slave PFS */
146 return(-1); /* neither */
148 linkpath = getlink(path);
151 * Read the symlink assuming it's a link to PFS.
153 bzero(buf, sizeof(buf));
154 if (readlink(linkpath, buf, sizeof(buf) - 1) < 0) {
163 * The symlink created by pfs-master|slave is just a symlink.
164 * One could happen to remove a symlink and relink PFS as
165 * # ln -s ./@@-1:00001 ./link
166 * which results PFS having something extra before @@.
167 * One could also directly use the PFS and results the same.
168 * Get rid of it before we extract the PFS id.
170 if (strchr(path, '/')) {
171 path = basename(path); /* strips trailing / first if any */
177 * Test and extract the PFS id from the link.
178 * "@@%jx:%d" covers both "@@-1:%05d" format for master PFS
179 * and "@@0x%016jx:%05d" format for slave PFS.
181 if (sscanf(path, "@@%jx:%d", &dummy_tid, &pfs->pfs_id) == 2) {
182 assert(pfs->pfs_id > 0);
190 relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs)
201 print_pfs_status(char *path)
203 struct hammer_ioc_pseudofs_rw pfs;
206 fd = getpfs(&pfs, path);
207 printf("%s\t", path);
208 if (fd < 0 || ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
209 printf("Invalid PFS path %s\n", path);
211 printf("PFS#%d {\n", pfs.pfs_id);
212 dump_pfsd(pfs.ondisk, fd);
223 hammer_cmd_pseudofs_status(char **av, int ac)
228 char buf[2] = "."; /* can't be readonly string */
229 print_pfs_status(buf);
233 for (i = 0; i < ac; ++i)
234 print_pfs_status(av[i]);
238 hammer_cmd_pseudofs_create(char **av, int ac, int is_slave)
240 struct hammer_ioc_pseudofs_rw pfs;
241 struct hammer_pseudofs_data pfsd;
252 if (lstat(path, &st) == 0)
253 errx(1, "Cannot create %s, file exists!", path);
254 else if (path[strlen(path) - 1] == '/')
255 errx(1, "Invalid PFS path %s with trailing /", path);
258 * Figure out the directory prefix, taking care of degenerate
261 dirpath = dirname(path);
262 fd = open(dirpath, O_RDONLY);
264 err(1, "Cannot open directory %s", dirpath);
267 * Avoid foot-shooting. Don't let the user create a PFS
268 * softlink via a PFS. PFS softlinks may only be accessed
269 * via the master filesystem. Checking it here ensures
270 * other PFS commands access PFS under the master filesystem.
272 clrpfs(&pfs, &pfsd, -1);
274 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs);
275 if (pfs.pfs_id != HAMMER_ROOT_PFSID) {
277 "You are attempting to access a PFS softlink "
278 "from a PFS. It may not represent the PFS\n"
279 "on the main filesystem mount that you "
280 "expect! You may only access PFS softlinks\n"
281 "via the main filesystem mount!\n");
285 for (pfs_id = 0; pfs_id < HAMMER_MAX_PFS; ++pfs_id) {
286 clrpfs(&pfs, &pfsd, pfs_id);
287 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
289 err(1, "Cannot create %s", path);
293 if (pfs_id == HAMMER_MAX_PFS)
294 errx(1, "Cannot create %s, all PFSs in use", path);
295 else if (pfs_id == HAMMER_ROOT_PFSID)
296 errx(1, "Fatal error: PFS#%d must exist", HAMMER_ROOT_PFSID);
301 printf("Creating PFS#%d\t", pfs_id);
302 clrpfs(&pfs, &pfsd, pfs_id);
303 init_pfsd(&pfsd, is_slave);
305 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
306 printf("failed: %s\n", strerror(errno));
308 /* special symlink, must be exactly 10 characters */
309 asprintf(&linkpath, "@@PFS%05d", pfs_id);
310 if (symlink(linkpath, path) < 0) {
311 printf("failed: cannot create symlink: %s\n",
314 printf("succeeded!\n");
315 hammer_cmd_pseudofs_update(av, ac);
323 hammer_cmd_pseudofs_destroy(char **av, int ac)
325 struct hammer_ioc_pseudofs_rw pfs;
332 fd = getpfs(&pfs, av[0]);
334 if (pfs.pfs_id == HAMMER_ROOT_PFSID)
335 errx(1, "You cannot destroy PFS#%d", HAMMER_ROOT_PFSID);
337 printf("You have requested that PFS#%d (%s) be destroyed\n",
338 pfs.pfs_id, pfs.ondisk->label);
339 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
340 printf("Do you really want to do this? [y/n] ");
343 errx(1, "No action taken on PFS#%d", pfs.pfs_id);
345 if (hammer_is_pfs_master(pfs.ondisk)) {
346 printf("This PFS is currently setup as a MASTER!\n");
347 printf("Are you absolutely sure you want to destroy it? [y/n] ");
350 errx(1, "No action taken on PFS#%d", pfs.pfs_id);
353 printf("Destroying PFS#%d (%s)", pfs.pfs_id, pfs.ondisk->label);
358 for (i = 5; i; --i) {
363 printf(".. starting destruction pass\n");
367 * Remove the softlink on success.
369 if (ioctl(fd, HAMMERIOC_RMR_PSEUDOFS, &pfs) == 0) {
370 printf("pfs-destroy of PFS#%d succeeded!\n", pfs.pfs_id);
371 linkpath = getlink(av[0]);
373 if (remove(linkpath) < 0)
374 err(1, "Unable to remove softlink %s", linkpath);
378 printf("pfs-destroy of PFS#%d failed: %s\n",
379 pfs.pfs_id, strerror(errno));
385 hammer_cmd_pseudofs_upgrade(char **av, int ac)
387 struct hammer_ioc_pseudofs_rw pfs;
392 fd = getpfs(&pfs, av[0]);
394 if (pfs.pfs_id == HAMMER_ROOT_PFSID) {
395 errx(1, "You cannot upgrade PFS#%d"
396 " (It should already be a master)",
398 } else if (hammer_is_pfs_master(pfs.ondisk)) {
399 errx(1, "It is already a master");
402 if (ioctl(fd, HAMMERIOC_UPG_PSEUDOFS, &pfs) == 0) {
403 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
404 pfs.pfs_id, pfs.ondisk->label);
406 err(1, "pfs-upgrade of PFS#%d (%s) failed",
407 pfs.pfs_id, pfs.ondisk->label);
413 hammer_cmd_pseudofs_downgrade(char **av, int ac)
415 struct hammer_ioc_pseudofs_rw pfs;
420 fd = getpfs(&pfs, av[0]);
422 if (pfs.pfs_id == HAMMER_ROOT_PFSID)
423 errx(1, "You cannot downgrade PFS#%d", HAMMER_ROOT_PFSID);
424 else if (hammer_is_pfs_slave(pfs.ondisk))
425 errx(1, "It is already a slave");
427 if (ioctl(fd, HAMMERIOC_DGD_PSEUDOFS, &pfs) == 0) {
428 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
429 pfs.pfs_id, pfs.ondisk->label);
431 err(1, "pfs-downgrade of PFS#%d (%s) failed",
432 pfs.pfs_id, pfs.ondisk->label);
438 hammer_cmd_pseudofs_update(char **av, int ac)
440 struct hammer_ioc_pseudofs_rw pfs;
445 fd = getpfs(&pfs, av[0]);
447 printf("%s\n", av[0]);
450 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
451 parse_pfsd_options(av + 1, ac - 1, pfs.ondisk);
452 if (hammer_is_pfs_slave(pfs.ondisk) &&
453 pfs.pfs_id == HAMMER_ROOT_PFSID) {
454 errx(1, "The real mount point cannot be made a PFS "
455 "slave, only PFS sub-directories can be made "
458 pfs.bytes = sizeof(*pfs.ondisk);
459 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) == 0) {
460 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
461 dump_pfsd(pfs.ondisk, fd);
463 err(1, "Unable to retrieve PFS configuration "
464 "after successful update");
467 err(1, "Unable to adjust PFS configuration");
474 init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave)
478 bzero(pfsd, sizeof(*pfsd));
479 pfsd->sync_beg_tid = 1;
480 pfsd->sync_end_tid = 1;
481 pfsd->sync_beg_ts = 0;
482 pfsd->sync_end_ts = 0;
483 uuid_create(&pfsd->shared_uuid, &status);
484 uuid_create(&pfsd->unique_uuid, &status);
486 pfsd->mirror_flags |= HAMMER_PFSD_SLAVE;
490 dump_pfsd(hammer_pseudofs_data_t pfsd, int fd)
492 struct hammer_ioc_version version;
496 printf(" sync-beg-tid=0x%016jx\n", (uintmax_t)pfsd->sync_beg_tid);
497 printf(" sync-end-tid=0x%016jx\n", (uintmax_t)pfsd->sync_end_tid);
498 uuid_to_string(&pfsd->shared_uuid, &str, &status);
499 printf(" shared-uuid=%s\n", str);
501 uuid_to_string(&pfsd->unique_uuid, &str, &status);
502 printf(" unique-uuid=%s\n", str);
504 printf(" label=\"%s\"\n", pfsd->label);
505 if (pfsd->snapshots[0])
506 printf(" snapshots=\"%s\"\n", pfsd->snapshots);
507 if (pfsd->prune_min < (60 * 60 * 24)) {
508 printf(" prune-min=%02d:%02d:%02d\n",
509 pfsd->prune_min / 60 / 60 % 24,
510 pfsd->prune_min / 60 % 60,
511 pfsd->prune_min % 60);
512 } else if (pfsd->prune_min % (60 * 60 * 24)) {
513 printf(" prune-min=%dd/%02d:%02d:%02d\n",
514 pfsd->prune_min / 60 / 60 / 24,
515 pfsd->prune_min / 60 / 60 % 24,
516 pfsd->prune_min / 60 % 60,
517 pfsd->prune_min % 60);
519 printf(" prune-min=%dd\n", pfsd->prune_min / 60 / 60 / 24);
522 if (hammer_is_pfs_slave(pfsd))
523 printf(" operating as a SLAVE\n");
525 printf(" operating as a MASTER\n");
528 * Snapshots directory cannot be shown when there is no fd since
529 * hammer version can't be retrieved. mirror-dump passes -1 because
530 * its input came from mirror-read output thus no path is available
533 if (fd >= 0 && pfsd->snapshots[0] == 0) {
534 bzero(&version, sizeof(version));
535 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) < 0)
537 HammerVersion = version.cur_version;
538 if (version.cur_version < 3) {
539 if (hammer_is_pfs_slave(pfsd)) {
540 printf(" snapshots directory not set for "
543 printf(" snapshots directory for master "
544 "defaults to <pfs>/snapshots\n");
547 printf(" snapshots directory defaults to "
548 "/var/hammer/<pfs>\n");
554 parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd)
563 if ((ptr = strchr(cmd, '=')) != NULL)
567 * Basic assignment value test
570 errx(1, "option %s requires an assignment", cmd);
573 if (strcmp(cmd, "sync-beg-tid") == 0) {
574 pfsd->sync_beg_tid = strtoull(ptr, NULL, 16);
575 } else if (strcmp(cmd, "sync-end-tid") == 0) {
576 pfsd->sync_end_tid = strtoull(ptr, NULL, 16);
577 } else if (strcmp(cmd, "shared-uuid") == 0) {
578 uuid_from_string(ptr, &pfsd->shared_uuid, &status);
579 } else if (strcmp(cmd, "unique-uuid") == 0) {
580 uuid_from_string(ptr, &pfsd->unique_uuid, &status);
581 } else if (strcmp(cmd, "label") == 0) {
583 if (ptr[0] == '"' && ptr[len-1] == '"') {
586 } else if (ptr[0] == '"') {
587 errx(1, "option %s: malformed string", cmd);
589 snprintf(pfsd->label, sizeof(pfsd->label), "%s", ptr);
590 } else if (strcmp(cmd, "snapshots") == 0) {
594 "option %s: '%s' must be an "
595 "absolute path\n", cmd, ptr);
598 "use 'snapshots-clear' "
599 "to unset snapshots dir\n");
603 if (len >= (int)sizeof(pfsd->snapshots)) {
604 errx(1, "option %s: path too long, %d "
605 "character limit", cmd, len);
607 snprintf(pfsd->snapshots, sizeof(pfsd->snapshots),
609 } else if (strcmp(cmd, "snapshots-clear") == 0) {
610 pfsd->snapshots[0] = 0;
611 } else if (strcmp(cmd, "prune-min") == 0) {
612 pfsd->prune_min = timetosecs(ptr);
613 if (pfsd->prune_min < 0) {
614 errx(1, "option %s: illegal time spec, "
615 "use Nd or [Nd/]hh[:mm[:ss]]", ptr);
618 errx(1, "invalid option: %s", cmd);
620 if (status != uuid_s_ok)
621 errx(1, "option %s: error parsing uuid %s", cmd, ptr);
629 pseudofs_usage(int code)
632 "hammer pfs-status <dirpath> ...\n"
633 "hammer pfs-master <dirpath> [options]\n"
634 "hammer pfs-slave <dirpath> [options]\n"
635 "hammer pfs-update <dirpath> [options]\n"
636 "hammer pfs-upgrade <dirpath>\n"
637 "hammer pfs-downgrade <dirpath>\n"
638 "hammer pfs-destroy <dirpath>\n"
641 " sync-beg-tid=0x16llx\n"
642 " sync-end-tid=0x16llx\n"
643 " shared-uuid=0x16llx\n"
644 " unique-uuid=0x16llx\n"
645 " label=\"string\"\n"
646 " snapshots=\"/path\"\n"
649 " prune-min=[Nd/]hh[:mm[:ss]]\n"
655 * Convert time in the form [Nd/]hh[:mm[:ss]] to seconds.
657 * Return -1 if a parse error occurs.
658 * Return 0x7FFFFFFF if the time exceeds the maximum allowed.
662 timetosecs(char *str)
672 n = strtol(str, &ptr, 10);
679 n = strtol(ptr + 1, &ptr, 10);
687 n = strtol(ptr + 1, &ptr, 10);
692 n = strtol(ptr + 1, &ptr, 10);
700 v = days * 24 * 60 * 60 + hrs * 60 * 60 + mins * 60 + secs;