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_snapshot.c,v 1.7 2008/07/10 18:47:22 mneumann Exp $
38 #include <sys/param.h>
39 #include <sys/mount.h>
40 #include <sys/types.h>
46 #define DEFAULT_SNAPSHOT_NAME "snap-%Y%m%d-%H%M"
48 static void snapshot_usage(int exit_code);
49 static void snapshot_add(int fd, const char *fsym, const char *tsym,
50 const char *label, hammer_tid_t tid);
51 static void snapshot_ls(const char *path);
52 static void snapshot_del(int fsfd, hammer_tid_t tid);
53 static char *dirpart(const char *path);
56 * hammer snap <path> [<note>]
58 * Path may be a directory, softlink, or non-existent (a softlink will be
62 hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase)
64 struct hammer_ioc_synctid synctid;
65 struct hammer_ioc_version version;
73 if (ac == 0 || ac > 2) {
80 snprintf(note, sizeof(note), "%s", av[1]);
85 * Figure out the softlink path and directory path
87 if (stat(av[0], &st) < 0) {
88 dirpath = dirpart(av[0]);
90 } else if (S_ISLNK(st.st_mode)) {
91 dirpath = dirpart(av[0]);
93 } else if (S_ISDIR(st.st_mode)) {
94 time_t t = time(NULL);
99 strftime(extbuf, sizeof(extbuf), DEFAULT_SNAPSHOT_NAME, tp);
101 dirpath = strdup(av[0]);
102 asprintf(&tsym, "%s/%s", dirpath, extbuf);
104 err(2, "hammer snap: File %s exists and is not a softlink\n",
110 * Get a handle on some directory in the filesystem for the
111 * ioctl (so it is stored in the correct PFS).
113 fsfd = open(dirpath, O_RDONLY);
115 err(2, "hammer snap: Cannot open directory %s\n", dirpath);
120 * Must be at least version 3 to use this command.
122 bzero(&version, sizeof(version));
124 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
125 err(2, "Unable to create snapshot");
127 } else if (version.cur_version < 3) {
128 errx(2, "Unable to create snapshot: This directive requires "
130 "the filesystem to version 3. "
131 "Use 'hammer snapshot' for legacy operation.");
136 * Synctid to get a transaction id for the snapshot.
138 bzero(&synctid, sizeof(synctid));
139 synctid.op = HAMMER_SYNCTID_SYNC2;
140 if (ioctl(fsfd, HAMMERIOC_SYNCTID, &synctid) < 0) {
141 err(2, "hammer snap: Synctid %s failed",
145 if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) {
146 printf("%s/@@0x%016jx\n",
147 dirpath, (uintmax_t)synctid.tid);
149 printf("%s@@0x%016jx\n",
150 dirpath, (uintmax_t)synctid.tid);
157 * Contents of the symlink being created.
162 if (statfs(dirpath, &buf) < 0) {
163 err(2, "hammer snap: Cannot determine mount for %s",
166 asprintf(&fsym, "%s/@@0x%016jx",
167 buf.f_mntonname, (uintmax_t)synctid.tid);
168 } else if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) {
169 asprintf(&fsym, "%s/@@0x%016jx",
170 dirpath, (uintmax_t)synctid.tid);
172 asprintf(&fsym, "%s@@0x%016jx",
173 dirpath, (uintmax_t)synctid.tid);
177 * Create the snapshot.
179 snapshot_add(fsfd, fsym, tsym, note, synctid.tid);
184 * hammer snapls [<path> ...]
186 * If no arguments are specified snapshots for the PFS containing the
187 * current directory are listed.
190 hammer_cmd_snapls(char **av, int ac)
194 for (i = 0; i < ac; ++i)
201 * hammer snaprm <path> ...
202 * hammer snaprm <transid> ...
203 * hammer snaprm <filesystem> <transid> ...
206 hammer_cmd_snaprm(char **av, int ac)
214 enum snaprm_mode { none_m, path_m, tid_m } mode = none_m;
223 for (i = 0; i < ac; ++i) {
224 if (lstat(av[i], &st) < 0) {
225 tid = strtoull(av[i], &ptr, 16);
227 err(2, "hammer snaprm: not a file or tid: %s",
231 if (mode == path_m) {
237 fsfd = open(".", O_RDONLY);
238 snapshot_del(fsfd, tid);
239 } else if (S_ISDIR(st.st_mode)) {
240 if (i != 0 || ac < 2) {
246 fsfd = open(av[i], O_RDONLY);
248 err(2, "hammer snaprm: cannot open dir %s",
253 } else if (S_ISLNK(st.st_mode)) {
254 dirpath = dirpart(av[i]);
255 bzero(linkbuf, sizeof(linkbuf));
256 if (readlink(av[i], linkbuf, sizeof(linkbuf) - 1) < 0) {
257 err(2, "hammer snaprm: cannot read softlink: "
261 if (linkbuf[0] == '/') {
263 dirpath = dirpart(linkbuf);
265 asprintf(&ptr, "%s/%s", dirpath, linkbuf);
267 dirpath = dirpart(ptr);
272 fsfd = open(dirpath, O_RDONLY);
274 err(2, "hammer snaprm: cannot open dir %s",
280 if (i == 0 && ac > 1) {
282 if (lstat(av[1], &st) < 0) {
283 tid = strtoull(av[1], &ptr, 16);
296 if (delete && (ptr = strrchr(linkbuf, '@')) &&
297 ptr > linkbuf && ptr[-1] == '@' && ptr[1]) {
298 tid = strtoull(ptr + 1, &ptr2, 16);
300 snapshot_del(fsfd, tid);
306 err(2, "hammer snaprm: not directory or snapshot "
307 "softlink: %s", av[i]);
316 * snapshot <softlink-dir>
317 * snapshot <filesystem> <softlink-dir> [<note>]
320 hammer_cmd_snapshot(char **av, int ac)
322 const char *filesystem;
323 const char *softlink_dir;
327 struct hammer_ioc_synctid synctid;
334 softlink_dir = av[0];
335 } else if (ac == 2) {
337 softlink_dir = av[1];
338 } else if (ac == 3) {
340 softlink_dir = av[1];
349 if (stat(softlink_dir, &st) == 0) {
350 if (!S_ISDIR(st.st_mode))
351 err(2, "File %s already exists", softlink_dir);
353 if (filesystem == NULL) {
354 if (statfs(softlink_dir, &buf) != 0) {
355 err(2, "Unable to determine filesystem of %s",
358 filesystem = buf.f_mntonname;
361 softlink_fmt = malloc(strlen(softlink_dir) + 1 + 1 +
362 sizeof(DEFAULT_SNAPSHOT_NAME));
363 if (softlink_fmt == NULL)
364 err(2, "Failed to allocate string");
366 strcpy(softlink_fmt, softlink_dir);
367 if (softlink_fmt[strlen(softlink_fmt)-1] != '/')
368 strcat(softlink_fmt, "/");
369 strcat(softlink_fmt, DEFAULT_SNAPSHOT_NAME);
371 softlink_fmt = strdup(softlink_dir);
373 if (filesystem == NULL) {
375 * strip-off last '/path' segment to get the softlink
376 * directory, which we need to determine the filesystem
379 char *pos = strrchr(softlink_fmt, '/');
383 if (stat(softlink_fmt, &st) != 0 ||
384 !S_ISDIR(st.st_mode)) {
385 err(2, "Unable to determine softlink dir %s",
388 if (statfs(softlink_fmt, &buf) != 0) {
389 err(2, "Unable to determine filesystem of %s",
392 filesystem = buf.f_mntonname;
403 bzero(&synctid, sizeof(synctid));
404 synctid.op = HAMMER_SYNCTID_SYNC2;
406 int fd = open(filesystem, O_RDONLY);
408 err(2, "Unable to open %s", filesystem);
409 if (ioctl(fd, HAMMERIOC_SYNCTID, &synctid) < 0)
410 err(2, "Synctid %s failed", filesystem);
412 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
414 err(2, "Couldn't generate string");
416 int sz = strlen(softlink_fmt) + 50;
419 err(2, "Failed to allocate string");
421 time_t t = time(NULL);
422 if (strftime(to, sz, softlink_fmt, localtime(&t)) == 0)
423 err(2, "String buffer too small");
425 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
427 snapshot_add(fd, from, to, note, synctid.tid);
439 snapshot_add(int fd, const char *fsym, const char *tsym, const char *label,
442 struct hammer_ioc_version version;
443 struct hammer_ioc_snapshot snapshot;
445 bzero(&version, sizeof(version));
446 bzero(&snapshot, sizeof(snapshot));
449 * For HAMMER filesystem v3+ the snapshot is recorded in meta-data.
451 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) == 0 &&
452 version.cur_version >= 3) {
455 snapshot.snaps[0].tid = tid;
456 snapshot.snaps[0].ts = time(NULL) * 1000000ULL;
458 snprintf(snapshot.snaps[0].label,
459 sizeof(snapshot.snaps[0].label),
463 if (ioctl(fd, HAMMERIOC_ADD_SNAPSHOT, &snapshot) < 0) {
464 err(2, "Unable to create snapshot");
465 } else if (snapshot.head.error &&
466 snapshot.head.error != EEXIST) {
467 errx(2, "Unable to create snapshot: %s\n",
468 strerror(snapshot.head.error));
473 * Create a symlink for the snapshot. If a file exists with the same
474 * name the new symlink will replace it.
478 if (symlink(fsym, tsym) < 0) {
479 err(2, "Unable to create symlink %s", tsym);
486 snapshot_ls(const char *path)
488 /*struct hammer_ioc_version version;*/
489 struct hammer_ioc_info info;
490 struct hammer_ioc_snapshot snapshot;
491 struct hammer_ioc_pseudofs_rw pfs;
492 struct hammer_pseudofs_data pfs_od;
493 struct hammer_snapshot_data *snap;
501 fd = open(path, O_RDONLY);
503 err(2, "hammer snapls: cannot open %s", path);
507 bzero(&pfs, sizeof(pfs));
508 bzero(&pfs_od, sizeof(pfs_od));
510 pfs.ondisk = &pfs_od;
511 pfs.bytes = sizeof(struct hammer_pseudofs_data);
512 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
513 err(2, "hammer snapls: cannot retrieve PFS info on %s", path);
517 bzero(&info, sizeof(info));
518 if ((ioctl(fd, HAMMERIOC_GET_INFO, &info)) < 0) {
519 err(2, "hammer snapls: cannot retrieve HAMMER info");
523 mntpoint = libhammer_find_pfs_mount(&pfs.ondisk->unique_uuid);
525 printf("Snapshots on %s\tPFS #%d\n",
526 mntpoint ? mntpoint : path, pfs.pfs_id);
527 printf("Transaction ID\t\tTimestamp\t\tNote\n");
532 bzero(&snapshot, sizeof(snapshot));
534 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) {
535 err(2, "hammer snapls: %s: not HAMMER fs or "
536 "version < 3", path);
539 for (i = 0; i < snapshot.count; ++i) {
540 snap = &snapshot.snaps[i];
542 t = snap->ts / 1000000ULL;
544 strftime(snapts, sizeof(snapts),
545 "%Y-%m-%d %H:%M:%S %Z", tp);
546 printf("0x%016jx\t%s\t%s\n",
547 (uintmax_t)snap->tid, snapts,
548 strlen(snap->label) ? snap->label : "-");
550 } while (snapshot.head.error == 0 && snapshot.count);
555 snapshot_del(int fsfd, hammer_tid_t tid)
557 struct hammer_ioc_snapshot snapshot;
558 struct hammer_ioc_version version;
560 bzero(&version, sizeof(version));
562 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
563 err(2, "hammer snaprm 0x%016jx", (uintmax_t)tid);
565 if (version.cur_version < 3) {
566 errx(2, "hammer snaprm 0x%016jx: You must upgrade to version "
567 " 3 to use this directive", (uintmax_t)tid);
570 bzero(&snapshot, sizeof(snapshot));
572 snapshot.snaps[0].tid = tid;
575 * Do not abort if we are unable to remove the meta-data.
577 if (ioctl(fsfd, HAMMERIOC_DEL_SNAPSHOT, &snapshot) < 0) {
578 err(2, "hammer snaprm 0x%016jx",
580 } else if (snapshot.head.error == ENOENT) {
581 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: "
582 "meta-data not found\n",
584 } else if (snapshot.head.error) {
585 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: %s\n",
586 (uintmax_t)tid, strerror(snapshot.head.error));
592 snapshot_usage(int exit_code)
595 "hammer snap <path> [<note>]\t\tcreate snapshot & link, points to\n"
596 "\t\t\t\t\tbase of PFS mount\n"
597 "hammer snaplo <path> [<note>]\t\tcreate snapshot & link, points to\n"
598 "\t\t\t\t\ttarget dir\n"
599 "hammer snapq <dir> [<note>]\t\tcreate snapshot, output path to stdout\n"
600 "hammer snaprm <path> ...\t\tdelete snapshots; filesystem is CWD\n"
601 "hammer snaprm <transid> ...\t\tdelete snapshots\n"
602 "hammer snaprm <filesystem> <transid> ...\tdelete snapshots\n"
603 "hammer snapls [<path> ...]\t\tlist available snapshots\n"
605 "NOTE: Snapshots are created in filesystem meta-data, any directory\n"
606 " in a HAMMER filesystem or PFS may be specified. If the path\n"
607 " specified does not exist this function will also create a\n"
610 " When deleting snapshots transaction ids may be directly specified\n"
611 " or file paths to snapshot softlinks may be specified. If a\n"
612 " softlink is specified the softlink will also be deleted.\n"
614 "NOTE: The old 'hammer snapshot [<filesystem>] <snapshot-dir>' form\n"
615 " is still accepted but is a deprecated form. This form will\n"
616 " work for older hammer versions. The new forms only work for\n"
617 " HAMMER version 3 or later filesystems. HAMMER can be upgraded\n"
618 " to version 3 in-place.\n"
625 dirpart(const char *path)
630 ptr = strrchr(path, '/');
632 while (ptr > path && ptr[-1] == '/')
641 res = malloc(ptr - path + 1);
642 bcopy(path, res, ptr - path);