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 $
39 static void parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd);
40 static void init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave);
41 static void dump_pfsd(hammer_pseudofs_data_t pfsd);
42 static void pseudofs_usage(int code);
43 static int getyn(void);
46 * Calculate the pfs_id given a path to a directory or a @@PFS or @@%llx:%d
50 getpfs(struct hammer_ioc_pseudofs_rw *pfs, const char *path)
52 hammer_tid_t dummy_tid;
59 bzero(pfs, sizeof(*pfs));
60 pfs->ondisk = malloc(sizeof(*pfs->ondisk));
61 bzero(pfs->ondisk, sizeof(*pfs->ondisk));
62 pfs->bytes = sizeof(*pfs->ondisk);
65 * Calculate the directory containing the softlink
67 dirpath = strdup(path);
68 if (strrchr(dirpath, '/')) {
69 *strrchr(dirpath, '/') = 0;
70 if (strlen(dirpath) == 0) {
72 dirpath = strdup("/");
76 dirpath = strdup(".");
79 if (lstat(path, &st) == 0 && S_ISLNK(st.st_mode)) {
81 * Avoid foot-shooting. Don't let the user access a PFS
82 * softlink via a PFS. PFS softlinks may only be accessed
83 * via the master filesystem.
85 fd = open(dirpath, O_RDONLY);
89 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs);
90 if (pfs->pfs_id != 0) {
92 "You are attempting to access a PFS softlink "
93 "from a PFS. It may not represent the PFS\n"
94 "on the main filesystem mount that you "
95 "expect! You may only access PFS softlinks\n"
96 "via the main filesystem mount!\n");
102 * Extract the PFS from the link. HAMMER will automatically
103 * convert @@PFS%05d links so if actually see one in that
104 * form the target PFS may not exist or may be corrupt. But
105 * we can extract the PFS id anyway.
107 n = readlink(path, buf, sizeof(buf) - 1);
111 if (sscanf(buf, "@@PFS%d", &pfs->pfs_id) == 1) {
112 fd = open(dirpath, O_RDONLY);
115 if (sscanf(buf, "@@%llx:%d", &dummy_tid, &pfs->pfs_id) == 2) {
116 fd = open(dirpath, O_RDONLY);
122 * Try to open the path and request the pfs_id that way.
124 fd = open(path, O_RDONLY);
127 ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs);
128 if (pfs->pfs_id == -1) {
139 fprintf(stderr, "Cannot access PFS %s: %s\n",
140 path, strerror(errno));
143 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, pfs) < 0) {
144 fprintf(stderr, "Cannot access PFS %s: %s\n",
145 path, strerror(errno));
153 relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs)
163 hammer_cmd_pseudofs_status(char **av, int ac)
165 struct hammer_ioc_pseudofs_rw pfs;
172 for (i = 0; i < ac; ++i) {
173 printf("%s\t", av[i]);
174 fd = getpfs(&pfs, av[i]);
175 if (fd < 0 || ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
176 printf("Not a HAMMER root\n");
178 printf("PFS #%d {\n", pfs.pfs_id);
179 dump_pfsd(pfs.ondisk);
190 hammer_cmd_pseudofs_create(char **av, int ac, int is_slave)
192 struct hammer_ioc_pseudofs_rw pfs;
193 struct hammer_pseudofs_data pfsd;
205 if (lstat(path, &st) == 0) {
206 fprintf(stderr, "Cannot create %s, file exists!\n", path);
211 * Figure out the directory prefix, taking care of degenerate
214 dirpath = strdup(path);
215 if (strrchr(dirpath, '/') != NULL) {
216 *strrchr(dirpath, '/') = 0;
217 if (dirpath[0] == 0) {
219 dirpath = strdup("/");
223 dirpath = strdup(".");
225 fd = open(dirpath, O_RDONLY);
227 fprintf(stderr, "Cannot open directory %s\n", dirpath);
232 for (pfs_id = 0; pfs_id < HAMMER_MAX_PFS; ++pfs_id) {
233 bzero(&pfs, sizeof(pfs));
234 bzero(&pfsd, sizeof(pfsd));
237 pfs.bytes = sizeof(pfsd);
238 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
239 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
244 if (pfs_id == HAMMER_MAX_PFS) {
245 fprintf(stderr, "Cannot create %s, all PFSs in use\n", path);
248 if (error != ENOENT) {
249 fprintf(stderr, "Cannot create %s, got %s during scan\n",
250 path, strerror(error));
257 printf("Creating PFS #%d\t", pfs_id);
258 bzero(&pfsd, sizeof(pfsd));
259 init_pfsd(&pfsd, is_slave);
262 pfs.bytes = sizeof(pfsd);
263 pfs.version = HAMMER_IOC_PSEUDOFS_VERSION;
265 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
266 printf("failed: %s\n", strerror(errno));
268 /* special symlink, must be exactly 10 characters */
269 asprintf(&linkpath, "@@PFS%05d", pfs_id);
270 if (symlink(linkpath, path) < 0) {
271 printf("failed: cannot create symlink: %s\n",
274 printf("succeeded!\n");
275 hammer_cmd_pseudofs_update(av, ac);
282 hammer_cmd_pseudofs_destroy(char **av, int ac)
284 struct hammer_ioc_pseudofs_rw pfs;
291 bzero(&pfs, sizeof(pfs));
292 fd = getpfs(&pfs, av[0]);
294 if (pfs.pfs_id == 0) {
295 fprintf(stderr, "You cannot destroy PFS#0\n");
298 printf("You have requested that PFS#%d (%s) be destroyed\n",
299 pfs.pfs_id, pfs.ondisk->label);
300 printf("This will irrevocably destroy all data on this PFS!!!!!\n");
301 printf("Do you really want to do this? ");
304 fprintf(stderr, "No action taken on PFS#%d\n", pfs.pfs_id);
308 if ((pfs.ondisk->mirror_flags & HAMMER_PFSD_SLAVE) == 0) {
309 printf("This PFS is currently setup as a MASTER!\n");
310 printf("Are you absolutely sure you want to destroy it? ");
313 fprintf(stderr, "No action taken on PFS#%d\n",
319 printf("Destroying PFS #%d (%s) in ", pfs.pfs_id, pfs.ondisk->label);
320 for (i = 5; i; --i) {
325 printf(".. starting destruction pass\n");
329 * Set the sync_beg_tid and sync_end_tid's to 1, once we start the
330 * RMR the PFS is basically destroyed even if someone ^C's it.
332 pfs.ondisk->mirror_flags |= HAMMER_PFSD_SLAVE;
333 pfs.ondisk->reserved01 = -1;
334 pfs.ondisk->sync_beg_tid = 1;
335 pfs.ondisk->sync_end_tid = 1;
337 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) < 0) {
338 fprintf(stderr, "Unable to update the PFS configuration: %s\n",
344 * Ok, do it. Remove the softlink on success.
346 if (ioctl(fd, HAMMERIOC_RMR_PSEUDOFS, &pfs) == 0) {
347 printf("pfs-destroy of PFS#%d succeeded!\n", pfs.pfs_id);
348 if (lstat(av[0], &st) == 0 && S_ISLNK(st.st_mode)) {
349 if (remove(av[0]) < 0) {
350 fprintf(stderr, "Unable to remove softlink: %s "
351 "(but the PFS has been destroyed)\n",
353 /* exit status 0 anyway */
357 printf("pfs-destroy of PFS#%d failed: %s\n",
358 pfs.pfs_id, strerror(errno));
363 hammer_cmd_pseudofs_upgrade(char **av, int ac)
365 struct hammer_ioc_pseudofs_rw pfs;
370 bzero(&pfs, sizeof(pfs));
371 fd = getpfs(&pfs, av[0]);
373 if (pfs.pfs_id == 0) {
374 fprintf(stderr, "You cannot upgrade PFS#0"
375 " (It should already be a master)\n");
378 if (ioctl(fd, HAMMERIOC_UPG_PSEUDOFS, &pfs) == 0) {
379 printf("pfs-upgrade of PFS#%d (%s) succeeded\n",
380 pfs.pfs_id, pfs.ondisk->label);
382 fprintf(stderr, "pfs-upgrade of PFS#%d (%s) failed: %s\n",
383 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
388 hammer_cmd_pseudofs_downgrade(char **av, int ac)
390 struct hammer_ioc_pseudofs_rw pfs;
395 bzero(&pfs, sizeof(pfs));
396 fd = getpfs(&pfs, av[0]);
398 if (pfs.pfs_id == 0) {
399 fprintf(stderr, "You cannot downgrade PFS#0\n");
403 if (ioctl(fd, HAMMERIOC_DGD_PSEUDOFS, &pfs) == 0) {
404 printf("pfs-downgrade of PFS#%d (%s) succeeded\n",
405 pfs.pfs_id, pfs.ondisk->label);
407 fprintf(stderr, "pfs-upgrade of PFS#%d (%s) failed: %s\n",
408 pfs.pfs_id, pfs.ondisk->label, strerror(errno));
413 hammer_cmd_pseudofs_update(char **av, int ac)
415 struct hammer_ioc_pseudofs_rw pfs;
420 bzero(&pfs, sizeof(pfs));
421 fd = getpfs(&pfs, av[0]);
423 printf("%s\n", av[0]);
426 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
427 parse_pfsd_options(av + 1, ac - 1, pfs.ondisk);
428 if ((pfs.ondisk->mirror_flags & HAMMER_PFSD_SLAVE) &&
430 printf("The real mount point cannot be made a PFS "
431 "slave, only PFS sub-directories can be made "
435 pfs.bytes = sizeof(*pfs.ondisk);
436 if (ioctl(fd, HAMMERIOC_SET_PSEUDOFS, &pfs) == 0) {
437 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) == 0) {
438 dump_pfsd(pfs.ondisk);
440 printf("Unable to retrieve pfs configuration "
441 "after successful update: %s\n",
446 printf("Unable to adjust pfs configuration: %s\n",
454 init_pfsd(hammer_pseudofs_data_t pfsd, int is_slave)
458 pfsd->sync_beg_tid = 1;
459 pfsd->sync_end_tid = 1;
460 pfsd->sync_beg_ts = 0;
461 pfsd->sync_end_ts = 0;
462 uuid_create(&pfsd->shared_uuid, &status);
463 uuid_create(&pfsd->unique_uuid, &status);
465 pfsd->mirror_flags |= HAMMER_PFSD_SLAVE;
470 dump_pfsd(hammer_pseudofs_data_t pfsd)
475 printf(" sync-beg-tid=0x%016llx\n", pfsd->sync_beg_tid);
476 printf(" sync-end-tid=0x%016llx\n", pfsd->sync_end_tid);
477 uuid_to_string(&pfsd->shared_uuid, &str, &status);
478 printf(" shared-uuid=%s\n", str);
479 uuid_to_string(&pfsd->unique_uuid, &str, &status);
480 printf(" unique-uuid=%s\n", str);
481 if (pfsd->mirror_flags & HAMMER_PFSD_SLAVE) {
484 printf(" label=\"%s\"\n", pfsd->label);
485 if (pfsd->snapshots[0])
486 printf(" snapshots=\"%s\"\n", pfsd->snapshots);
487 if (pfsd->mirror_flags & HAMMER_PFSD_SLAVE) {
488 printf(" operating as a SLAVE\n");
489 if (pfsd->snapshots[0] == 0)
490 printf(" snapshots directory not set for slave\n");
492 printf(" operating as a MASTER\n");
493 if (pfsd->snapshots[0] == 0) {
494 printf(" snapshots dir for master "
495 "defaults to <fs>/snapshots\n");
501 parse_pfsd_options(char **av, int ac, hammer_pseudofs_data_t pfsd)
510 if ((ptr = strchr(cmd, '=')) != NULL)
514 * Basic assignment value test
518 "option %s requires an assignment\n",
524 if (strcmp(cmd, "sync-beg-tid") == 0) {
525 pfsd->sync_beg_tid = strtoull(ptr, NULL, 16);
526 } else if (strcmp(cmd, "sync-end-tid") == 0) {
527 pfsd->sync_end_tid = strtoull(ptr, NULL, 16);
528 } else if (strcmp(cmd, "shared-uuid") == 0) {
529 uuid_from_string(ptr, &pfsd->shared_uuid, &status);
530 } else if (strcmp(cmd, "unique-uuid") == 0) {
531 uuid_from_string(ptr, &pfsd->unique_uuid, &status);
532 } else if (strcmp(cmd, "label") == 0) {
534 if (ptr[0] == '"' && ptr[len-1] == '"') {
537 } else if (ptr[0] == '"') {
539 "option %s: malformed string\n",
543 snprintf(pfsd->label, sizeof(pfsd->label), "%s", ptr);
544 } else if (strcmp(cmd, "snapshots") == 0) {
548 "option %s: '%s' must be an "
549 "absolute path\n", cmd, ptr);
552 "use 'snapshots-clear' "
553 "to unset snapshots dir\n");
557 if (len >= (int)sizeof(pfsd->snapshots)) {
559 "option %s: path too long, %d "
560 "character limit\n", cmd, len);
563 snprintf(pfsd->snapshots, sizeof(pfsd->snapshots),
565 } else if (strcmp(cmd, "snapshots-clear") == 0) {
566 pfsd->snapshots[0] = 0;
568 fprintf(stderr, "invalid option: %s\n", cmd);
571 if (status != uuid_s_ok) {
572 fprintf(stderr, "option %s: error parsing uuid %s\n",
583 pseudofs_usage(int code)
586 "hammer pfs-status <dirpath> ...\n"
587 "hammer pfs-master <dirpath> [options]\n"
588 "hammer pfs-slave <dirpath> [options]\n"
589 "hammer pfs-update <dirpath> [options]\n"
590 "hammer pfs-upgrade <dirpath>\n"
591 "hammer pfs-downgrade <dirpath>\n"
592 "hammer pfs-destroy <dirpath>\n"
595 " sync-beg-tid=0x16llx\n"
596 " sync-end-tid=0x16llx\n"
597 " shared-uuid=0x16llx\n"
598 " unique-uuid=0x16llx\n"
599 " label=\"string\"\n"
600 " snapshots=\"/path\"\n"
613 if (fgets(buf, sizeof(buf), stdin) == NULL)
616 while (len && (buf[len-1] == '\n' || buf[len-1] == '\r'))
619 if (strcmp(buf, "y") == 0 ||
620 strcmp(buf, "yes") == 0 ||
621 strcmp(buf, "Y") == 0 ||
622 strcmp(buf, "YES") == 0) {