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 $
39 #define DEFAULT_SNAPSHOT_NAME "snap-%Y%m%d-%H%M"
41 static void snapshot_usage(int exit_code);
42 static void snapshot_add(int fd, const char *fsym, const char *tsym,
43 const char *label, hammer_tid_t tid);
44 static void snapshot_ls(const char *path);
45 static void snapshot_del(int fsfd, hammer_tid_t tid);
46 static char *dirpart(const char *path);
49 * hammer snap <path> [<note>]
51 * Path may be a directory, softlink, or non-existent (a softlink will be
55 hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase)
57 struct hammer_ioc_synctid synctid;
58 struct hammer_ioc_version version;
66 if (ac == 0 || ac > 2) {
72 snprintf(note, sizeof(note), "%s", av[1]);
77 * Figure out the softlink path and directory path
79 if (stat(av[0], &st) < 0) {
80 dirpath = dirpart(av[0]);
82 } else if (S_ISDIR(st.st_mode)) {
83 time_t t = time(NULL);
88 strftime(extbuf, sizeof(extbuf), DEFAULT_SNAPSHOT_NAME, tp);
90 dirpath = strdup(av[0]);
91 asprintf(&tsym, "%s/%s", dirpath, extbuf);
93 err(2, "hammer snap: File %s exists and is not a directory\n",
99 * Get a handle on some directory in the filesystem for the
100 * ioctl (so it is stored in the correct PFS).
102 fsfd = open(dirpath, O_RDONLY);
104 err(2, "hammer snap: Cannot open directory %s\n", dirpath);
109 * Must be at least version 3 to use this command.
111 bzero(&version, sizeof(version));
113 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
114 err(2, "Unable to create snapshot");
116 } else if (version.cur_version < 3) {
117 errx(2, "Unable to create snapshot: This directive requires "
119 "the filesystem to version 3. "
120 "Use 'hammer snapshot' for legacy operation.");
125 * Synctid to get a transaction id for the snapshot.
127 bzero(&synctid, sizeof(synctid));
128 synctid.op = HAMMER_SYNCTID_SYNC2;
129 if (ioctl(fsfd, HAMMERIOC_SYNCTID, &synctid) < 0) {
130 err(2, "hammer snap: Synctid %s failed",
134 if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) {
135 printf("%s/@@0x%016jx\n",
136 dirpath, (uintmax_t)synctid.tid);
138 printf("%s@@0x%016jx\n",
139 dirpath, (uintmax_t)synctid.tid);
146 * Contents of the symlink being created.
151 if (statfs(dirpath, &buf) < 0) {
152 err(2, "hammer snap: Cannot determine mount for %s",
155 asprintf(&fsym, "%s/@@0x%016jx",
156 buf.f_mntonname, (uintmax_t)synctid.tid);
157 } else if (strcmp(dirpath, ".") == 0 || strcmp(dirpath, "..") == 0) {
158 asprintf(&fsym, "%s/@@0x%016jx",
159 dirpath, (uintmax_t)synctid.tid);
161 asprintf(&fsym, "%s@@0x%016jx",
162 dirpath, (uintmax_t)synctid.tid);
166 * Create the snapshot.
168 snapshot_add(fsfd, fsym, tsym, note, synctid.tid);
175 * hammer snapls [<path> ...]
177 * If no arguments are specified snapshots for the PFS containing the
178 * current directory are listed.
181 hammer_cmd_snapls(char **av, int ac)
185 for (i = 0; i < ac; ++i)
192 * hammer snaprm <path> ...
193 * hammer snaprm <transid> ...
194 * hammer snaprm <filesystem> <transid> ...
197 hammer_cmd_snaprm(char **av, int ac)
205 enum snaprm_mode { none_m, path_m, tid_m } mode = none_m;
214 for (i = 0; i < ac; ++i) {
215 if (lstat(av[i], &st) < 0) {
216 tid = strtoull(av[i], &ptr, 16);
218 err(2, "hammer snaprm: not a file or tid: %s",
222 if (mode == path_m) {
228 fsfd = open(".", O_RDONLY);
229 snapshot_del(fsfd, tid);
230 } else if (S_ISDIR(st.st_mode)) {
231 if (i != 0 || ac < 2) {
237 fsfd = open(av[i], O_RDONLY);
239 err(2, "hammer snaprm: cannot open dir %s",
244 } else if (S_ISLNK(st.st_mode)) {
245 dirpath = dirpart(av[i]);
246 bzero(linkbuf, sizeof(linkbuf));
247 if (readlink(av[i], linkbuf, sizeof(linkbuf) - 1) < 0) {
248 err(2, "hammer snaprm: cannot read softlink: "
252 if (linkbuf[0] == '/') {
254 dirpath = dirpart(linkbuf);
256 asprintf(&ptr, "%s/%s", dirpath, linkbuf);
258 dirpath = dirpart(ptr);
264 fsfd = open(dirpath, O_RDONLY);
266 err(2, "hammer snaprm: cannot open dir %s",
272 if (i == 0 && ac > 1) {
274 if (lstat(av[1], &st) < 0) {
275 tid = strtoull(av[1], &ptr, 16);
288 if (delete && (ptr = strrchr(linkbuf, '@')) &&
289 ptr > linkbuf && ptr[-1] == '@' && ptr[1]) {
290 tid = strtoull(ptr + 1, &ptr2, 16);
292 snapshot_del(fsfd, tid);
298 err(2, "hammer snaprm: not directory or snapshot "
299 "softlink: %s", av[i]);
308 * snapshot <softlink-dir>
309 * snapshot <filesystem> <softlink-dir> [<note>]
312 hammer_cmd_snapshot(char **av, int ac)
314 const char *filesystem;
315 const char *softlink_dir;
319 struct hammer_ioc_synctid synctid;
326 softlink_dir = av[0];
327 } else if (ac == 2) {
329 softlink_dir = av[1];
330 } else if (ac == 3) {
332 softlink_dir = av[1];
339 if (stat(softlink_dir, &st) == 0) {
340 if (!S_ISDIR(st.st_mode))
341 err(2, "File %s already exists", softlink_dir);
343 if (filesystem == NULL) {
344 if (statfs(softlink_dir, &buf) != 0) {
345 err(2, "Unable to determine filesystem of %s",
348 filesystem = buf.f_mntonname;
351 softlink_fmt = malloc(strlen(softlink_dir) + 1 + 1 +
352 sizeof(DEFAULT_SNAPSHOT_NAME));
353 if (softlink_fmt == NULL)
354 err(2, "Failed to allocate string");
356 strcpy(softlink_fmt, softlink_dir);
357 if (softlink_fmt[strlen(softlink_fmt)-1] != '/')
358 strcat(softlink_fmt, "/");
359 strcat(softlink_fmt, DEFAULT_SNAPSHOT_NAME);
361 softlink_fmt = strdup(softlink_dir);
363 if (filesystem == NULL) {
365 * strip-off last '/path' segment to get the softlink
366 * directory, which we need to determine the filesystem
369 char *pos = strrchr(softlink_fmt, '/');
373 if (stat(softlink_fmt, &st) != 0 ||
374 !S_ISDIR(st.st_mode)) {
375 err(2, "Unable to determine softlink dir %s",
378 if (statfs(softlink_fmt, &buf) != 0) {
379 err(2, "Unable to determine filesystem of %s",
382 filesystem = buf.f_mntonname;
393 bzero(&synctid, sizeof(synctid));
394 synctid.op = HAMMER_SYNCTID_SYNC2;
396 int fd = open(filesystem, O_RDONLY);
398 err(2, "Unable to open %s", filesystem);
399 if (ioctl(fd, HAMMERIOC_SYNCTID, &synctid) < 0)
400 err(2, "Synctid %s failed", filesystem);
402 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
404 err(2, "Couldn't generate string");
406 int sz = strlen(softlink_fmt) + 50;
409 err(2, "Failed to allocate string");
411 time_t t = time(NULL);
412 if (strftime(to, sz, softlink_fmt, localtime(&t)) == 0)
413 err(2, "String buffer too small");
415 asprintf(&from, "%s/@@0x%016jx", filesystem, (uintmax_t)synctid.tid);
417 snapshot_add(fd, from, to, note, synctid.tid);
429 snapshot_add(int fd, const char *fsym, const char *tsym, const char *label,
432 struct hammer_ioc_version version;
433 struct hammer_ioc_snapshot snapshot;
435 bzero(&version, sizeof(version));
436 bzero(&snapshot, sizeof(snapshot));
439 * For HAMMER filesystem v3+ the snapshot is recorded in meta-data.
441 if (ioctl(fd, HAMMERIOC_GET_VERSION, &version) == 0 &&
442 version.cur_version >= 3) {
445 snapshot.snaps[0].tid = tid;
446 snapshot.snaps[0].ts = time(NULL) * 1000000ULL;
448 snprintf(snapshot.snaps[0].label,
449 sizeof(snapshot.snaps[0].label),
453 if (ioctl(fd, HAMMERIOC_ADD_SNAPSHOT, &snapshot) < 0) {
454 err(2, "Unable to create snapshot");
455 } else if (snapshot.head.error &&
456 snapshot.head.error != EEXIST) {
457 errx(2, "Unable to create snapshot: %s\n",
458 strerror(snapshot.head.error));
463 * Create a symlink for the snapshot. If a file exists with the same
464 * name the new symlink will replace it.
468 if (symlink(fsym, tsym) < 0) {
469 err(2, "Unable to create symlink %s", tsym);
476 snapshot_ls(const char *path)
478 struct hammer_ioc_info info;
479 struct hammer_ioc_snapshot snapshot;
480 struct hammer_ioc_pseudofs_rw pfs;
481 struct hammer_pseudofs_data pfs_od;
482 hammer_snapshot_data_t snap;
489 fd = open(path, O_RDONLY);
491 err(2, "hammer snapls: cannot open %s", path);
495 clrpfs(&pfs, &pfs_od, -1);
496 if (ioctl(fd, HAMMERIOC_GET_PSEUDOFS, &pfs) < 0) {
497 err(2, "hammer snapls: cannot retrieve PFS info on %s", path);
501 bzero(&info, sizeof(info));
502 if ((ioctl(fd, HAMMERIOC_GET_INFO, &info)) < 0) {
503 err(2, "hammer snapls: cannot retrieve HAMMER info");
507 printf("Snapshots on %s\tPFS#%d\n", path, pfs.pfs_id);
508 printf("Transaction ID\t\tTimestamp\t\tNote\n");
510 bzero(&snapshot, sizeof(snapshot));
512 if (ioctl(fd, HAMMERIOC_GET_SNAPSHOT, &snapshot) < 0) {
513 err(2, "hammer snapls: %s: not HAMMER fs or "
514 "version < 3", path);
517 for (i = 0; i < snapshot.count; ++i) {
518 snap = &snapshot.snaps[i];
520 t = snap->ts / 1000000ULL;
522 strftime(snapts, sizeof(snapts),
523 "%Y-%m-%d %H:%M:%S %Z", tp);
524 printf("0x%016jx\t%s\t%s\n",
525 (uintmax_t)snap->tid, snapts,
526 strlen(snap->label) ? snap->label : "-");
528 } while (snapshot.head.error == 0 && snapshot.count);
533 snapshot_del(int fsfd, hammer_tid_t tid)
535 struct hammer_ioc_snapshot snapshot;
536 struct hammer_ioc_version version;
538 bzero(&version, sizeof(version));
540 if (ioctl(fsfd, HAMMERIOC_GET_VERSION, &version) < 0) {
541 err(2, "hammer snaprm 0x%016jx", (uintmax_t)tid);
543 if (version.cur_version < 3) {
544 errx(2, "hammer snaprm 0x%016jx: You must upgrade to version "
545 " 3 to use this directive", (uintmax_t)tid);
548 bzero(&snapshot, sizeof(snapshot));
550 snapshot.snaps[0].tid = tid;
553 * Do not abort if we are unable to remove the meta-data.
555 if (ioctl(fsfd, HAMMERIOC_DEL_SNAPSHOT, &snapshot) < 0) {
556 err(2, "hammer snaprm 0x%016jx",
558 } else if (snapshot.head.error == ENOENT) {
559 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: "
560 "meta-data not found\n",
562 } else if (snapshot.head.error) {
563 fprintf(stderr, "Warning: hammer snaprm 0x%016jx: %s\n",
564 (uintmax_t)tid, strerror(snapshot.head.error));
570 snapshot_usage(int exit_code)
573 "hammer snap <path> [<note>]\t\tcreate snapshot & link, points to\n"
574 "\t\t\t\t\tbase of PFS mount\n"
575 "hammer snaplo <path> [<note>]\t\tcreate snapshot & link, points to\n"
576 "\t\t\t\t\ttarget dir\n"
577 "hammer snapq <dir> [<note>]\t\tcreate snapshot, output path to stdout\n"
578 "hammer snaprm <path> ...\t\tdelete snapshots; filesystem is CWD\n"
579 "hammer snaprm <transid> ...\t\tdelete snapshots\n"
580 "hammer snaprm <filesystem> <transid> ...\tdelete snapshots\n"
581 "hammer snapls [<path> ...]\t\tlist available snapshots\n"
583 "NOTE: Snapshots are created in filesystem meta-data, any directory\n"
584 " in a HAMMER filesystem or PFS may be specified. If the path\n"
585 " specified does not exist this function will also create a\n"
588 " When deleting snapshots transaction ids may be directly specified\n"
589 " or file paths to snapshot softlinks may be specified. If a\n"
590 " softlink is specified the softlink will also be deleted.\n"
592 "NOTE: The old 'hammer snapshot [<filesystem>] <snapshot-dir>' form\n"
593 " is still accepted but is a deprecated form. This form will\n"
594 " work for older hammer versions. The new forms only work for\n"
595 " HAMMER version 3 or later filesystems. HAMMER can be upgraded\n"
596 " to version 3 in-place.\n"
603 dirpart(const char *path)
608 ptr = strrchr(path, '/');
610 while (ptr > path && ptr[-1] == '/')
619 res = malloc(ptr - path + 1);
620 bcopy(path, res, ptr - path);