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/usr.bin/undo/undo.c,v 1.6 2008/07/17 21:34:47 thomas Exp $
37 * UNDO - retrieve an older version of a file.
40 #include <sys/types.h>
51 #include <vfs/hammer/hammer_disk.h>
52 #include <vfs/hammer/hammer_ioctl.h>
55 * Sorted list of transaction ids
57 struct undo_hist_entry;
58 RB_HEAD(undo_hist_entry_rb_tree, undo_hist_entry);
59 RB_PROTOTYPE2(undo_hist_entry_rb_tree, undo_hist_entry, rbnode,
60 undo_hist_entry_compare, hammer_tid_t);
62 struct undo_hist_entry {
63 RB_ENTRY(undo_hist_entry) rbnode;
64 struct hammer_ioc_hist_entry tse;
68 enum undo_type { TYPE_FILE, TYPE_DIFF, TYPE_RDIFF, TYPE_HISTORY };
69 enum undo_cmd { CMD_DUMP, CMD_ITERATEALL };
71 #define UNDO_FLAG_MULT 0x0001
72 #define UNDO_FLAG_INOCHG 0x0002
73 #define UNDO_FLAG_SETTID1 0x0004
74 #define UNDO_FLAG_SETTID2 0x0008
76 static int undo_hist_entry_compare(struct undo_hist_entry *he1,
77 struct undo_hist_entry *he2);
78 static void doiterate(const char *filename, const char *outFileName,
79 const char *outFilePostfix, int flags,
80 struct hammer_ioc_hist_entry ts1,
81 struct hammer_ioc_hist_entry ts2,
82 enum undo_cmd cmd, enum undo_type type);
83 static void dogenerate(const char *filename, const char *outFileName,
84 const char *outFilePostfix,
85 int flags, int idx, enum undo_type type,
86 struct hammer_ioc_hist_entry ts1,
87 struct hammer_ioc_hist_entry ts2);
88 static void collect_history(int fd, int *error,
89 struct undo_hist_entry_rb_tree *tse_tree);
90 static void collect_dir_history(const char *filename, int *error,
91 struct undo_hist_entry_rb_tree *dir_tree);
92 static void clean_tree(struct undo_hist_entry_rb_tree *tree);
93 static hammer_tid_t parse_delta_time(const char *timeStr, int *flags,
95 static void runcmd(int fd, const char *cmd, ...);
96 static char *timestamp(hammer_ioc_hist_entry_t hen);
97 static void usage(void);
99 static int VerboseOpt;
101 RB_GENERATE2(undo_hist_entry_rb_tree, undo_hist_entry, rbnode,
102 undo_hist_entry_compare, hammer_tid_t, tse.tid);
106 main(int ac, char **av)
108 const char *outFileName = NULL;
109 const char *outFilePostfix = NULL;
112 struct hammer_ioc_hist_entry ts1;
113 struct hammer_ioc_hist_entry ts2;
118 bzero(&ts1, sizeof(ts1));
119 bzero(&ts2, sizeof(ts2));
126 while ((c = getopt(ac, av, "adDiuvo:t:")) != -1) {
135 if (type != TYPE_FILE)
138 cmd = CMD_ITERATEALL;
141 cmd = CMD_ITERATEALL;
144 outFilePostfix = ".undo";
150 outFileName = optarg;
154 * Parse one or two -t options. If two are specified
155 * -d is implied (but may be overridden)
159 ts1.tid = parse_delta_time(optarg, &flags,
161 } else if (count_t == 2) {
162 ts2.tid = parse_delta_time(optarg, &flags,
164 if (type == TYPE_FILE)
180 if (outFileName && outFilePostfix) {
181 fprintf(stderr, "The -o option may not be combined with -u\n");
188 flags |= UNDO_FLAG_MULT;
194 * Validate the output template, if specified.
196 if (outFileName && (flags & UNDO_FLAG_MULT)) {
197 const char *ptr = outFileName;
200 while ((ptr = strchr(ptr, '%')) != NULL) {
203 fprintf(stderr, "Malformed output "
209 } else if (ptr[1] != '%') {
210 fprintf(stderr, "Malformed output template\n");
219 doiterate(*av, outFileName, outFilePostfix,
220 flags, ts1, ts2, cmd, type);
228 * Iterate through a file's history. If cmd == CMD_DUMP we take the
229 * next-to-last transaction id, unless another given. Otherwise if
230 * cmd == CMD_ITERATEALL we scan all transaction ids.
232 * Also iterate through the directory's history to locate other inodes that
233 * used the particular file name.
237 doiterate(const char *filename, const char *outFileName,
238 const char *outFilePostfix, int flags,
239 struct hammer_ioc_hist_entry ts1,
240 struct hammer_ioc_hist_entry ts2,
241 enum undo_cmd cmd, enum undo_type type)
243 struct undo_hist_entry_rb_tree dir_tree;
244 struct undo_hist_entry_rb_tree tse_tree;
245 struct undo_hist_entry *tse1;
246 struct undo_hist_entry *tse2;
247 struct hammer_ioc_hist_entry tid_max;
256 tid_max.tid = HAMMER_MAX_TID;
260 * Use the directory history to locate all possible versions of
263 collect_dir_history(filename, &error, &dir_tree);
264 RB_FOREACH(tse1, undo_hist_entry_rb_tree, &dir_tree) {
265 asprintf(&path, "%s@@0x%016jx", filename, (uintmax_t)tse1->tse.tid);
266 if ((fd = open(path, O_RDONLY)) > 0) {
267 collect_history(fd, &error, &tse_tree);
272 if ((fd = open(filename, O_RDONLY)) > 0) {
273 collect_history(fd, &error, &tse_tree);
276 if (cmd == CMD_DUMP) {
278 flags & (UNDO_FLAG_SETTID1|UNDO_FLAG_SETTID2)) &&
279 RB_EMPTY(&tse_tree)) {
280 if ((fd = open(filename, O_RDONLY)) > 0) {
281 collect_history(fd, &error, &tse_tree);
286 * Find entry if tid set to placeholder index
288 if (flags & UNDO_FLAG_SETTID1){
289 tse1 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
290 while (tse1 && ts1.tid--) {
291 tse1 = RB_PREV(undo_hist_entry_rb_tree,
299 if (flags & UNDO_FLAG_SETTID2){
300 tse2 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
301 while (tse2 && ts2.tid--) {
302 tse2 = RB_PREV(undo_hist_entry_rb_tree,
312 * Single entry, most recent prior to current
315 tse2 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
318 tse1 = RB_PREV(undo_hist_entry_rb_tree,
325 printf("%s: No UNDO history found\n", filename);
328 outFileName, outFilePostfix,
332 } else if (RB_ROOT(&tse_tree)) {
334 * Iterate entire history
336 printf("%s: ITERATE ENTIRE HISTORY\n", filename);
340 RB_FOREACH(tse2, undo_hist_entry_rb_tree, &tse_tree) {
343 outFileName, outFilePostfix,
345 tse1->tse, tse2->tse);
347 if (tse1 && tse2->inum != tse1->inum)
348 flags |= UNDO_FLAG_INOCHG;
350 flags &= ~UNDO_FLAG_INOCHG;
355 * There is no delta to print for the last pair,
356 * because they are identical.
358 if (type != TYPE_DIFF && type != TYPE_RDIFF) {
360 outFileName, outFilePostfix,
365 printf("%s: ITERATE ENTIRE HISTORY: %s\n",
366 filename, strerror(error));
368 clean_tree(&dir_tree);
369 clean_tree(&tse_tree);
373 * Generate output for a file as-of ts1 (ts1 may be 0!), if diffing then
378 dogenerate(const char *filename, const char *outFileName,
379 const char *outFilePostfix,
380 int flags, int idx, enum undo_type type,
381 struct hammer_ioc_hist_entry ts1,
382 struct hammer_ioc_hist_entry ts2)
400 * Open the input file. If ts1 is 0 try to locate the most recent
401 * version of the file prior to the current version.
404 asprintf(&ipath1, "%s", filename);
406 asprintf(&ipath1, "%s@@0x%016jx", filename, (uintmax_t)ts1.tid);
409 asprintf(&ipath2, "%s", filename);
411 asprintf(&ipath2, "%s@@0x%016jx", filename, (uintmax_t)ts2.tid);
413 if (lstat(ipath1, &st) < 0 && lstat(ipath2, &st) < 0) {
414 if (idx == 0 || VerboseOpt) {
415 fprintf(stderr, "Unable to access either %s or %s\n",
424 * elm is the last component of the input file name
426 if ((elm = strrchr(filename, '/')) != NULL)
432 * Where do we stuff our output?
435 if (flags & UNDO_FLAG_MULT) {
436 asprintf(&path, outFileName, elm);
437 fp = fopen(path, "w");
444 fp = fopen(outFileName, "w");
450 } else if (outFilePostfix) {
452 asprintf(&path, "%s%s.%04d", filename,
453 outFilePostfix, idx);
455 asprintf(&path, "%s%s", filename, outFilePostfix);
457 fp = fopen(path, "w");
464 if ((flags & UNDO_FLAG_MULT) && type == TYPE_FILE) {
466 printf("\n>>> %s %04d 0x%016jx %s\n\n",
467 filename, idx, (uintmax_t)ts1.tid,
470 printf("\n>>> %s ---- 0x%016jx %s\n\n",
471 filename, (uintmax_t)ts1.tid,
474 } else if (idx >= 0 && type == TYPE_FILE) {
475 printf("\n>>> %s %04d 0x%016jx %s\n\n",
476 filename, idx, (uintmax_t)ts1.tid,
484 if ((fi = fopen(ipath1, "r")) != NULL) {
485 while ((n = fread(buf, 1, 8192, fi)) > 0)
486 fwrite(buf, 1, n, fp);
491 printf("diff -N -r -u %s %s (to %s)\n",
492 ipath1, ipath2, timestamp(&ts2));
494 runcmd(fileno(fp), "/usr/bin/diff", "diff", "-N", "-r", "-u", ipath1, ipath2, NULL);
497 printf("diff -N -r -u %s %s\n", ipath2, ipath1);
499 runcmd(fileno(fp), "/usr/bin/diff", "diff", "-N", "-r", "-u", ipath2, ipath1, NULL);
502 t = (time_t)ts1.time32;
504 strftime(datestr, sizeof(datestr), "%d-%b-%Y %H:%M:%S", tp);
505 printf("\t0x%016jx %s", (uintmax_t)ts1.tid, datestr);
506 if (flags & UNDO_FLAG_INOCHG)
507 printf(" inode-change");
508 if (lstat(ipath1, &st) < 0)
509 printf(" file-deleted");
522 clean_tree(struct undo_hist_entry_rb_tree *tree)
524 struct undo_hist_entry *tse;
526 while ((tse = RB_ROOT(tree)) != NULL) {
527 RB_REMOVE(undo_hist_entry_rb_tree, tree, tse);
534 collect_history(int fd, int *errorp, struct undo_hist_entry_rb_tree *tse_tree)
536 struct hammer_ioc_history hist;
537 struct undo_hist_entry *tse;
545 bzero(&hist, sizeof(hist));
546 hist.beg_tid = HAMMER_MIN_TID;
547 hist.end_tid = HAMMER_MAX_TID;
548 hist.head.flags |= HAMMER_IOC_HISTORY_ATKEY;
550 hist.nxt_key = HAMMER_MAX_KEY;
554 if (tse_tree == NULL) {
555 tse_tree = malloc(sizeof(*tse_tree));
563 * Save the inode so inode changes can be reported.
569 * Collect a unique set of transaction ids
571 if (ioctl(fd, HAMMERIOC_GETHISTORY, &hist) < 0) {
576 for (i = 0; i < hist.count; ++i) {
577 tse = malloc(sizeof(*tse));
578 tse->tse = hist.hist_ary[i];
579 tse->inum = st.st_ino;
580 if (RB_INSERT(undo_hist_entry_rb_tree, tse_tree, tse)) {
584 if (hist.head.flags & HAMMER_IOC_HISTORY_EOF)
586 if (hist.head.flags & HAMMER_IOC_HISTORY_NEXT_KEY) {
587 hist.key = hist.nxt_key;
588 hist.nxt_key = HAMMER_MAX_KEY;
590 if (hist.head.flags & HAMMER_IOC_HISTORY_NEXT_TID)
591 hist.beg_tid = hist.nxt_tid;
592 if (ioctl(fd, HAMMERIOC_GETHISTORY, &hist) < 0) {
603 clean_tree(tse_tree);
610 collect_dir_history(const char *filename, int *errorp,
611 struct undo_hist_entry_rb_tree *dir_tree)
618 if (strrchr(filename, '/')) {
619 dirname = strdup(filename);
620 *strrchr(dirname, '/') = 0;
622 dirname = strdup(".");
624 if ((fd = open(dirname, O_RDONLY)) > 0) {
625 collect_history(fd, &error, dir_tree);
632 parse_delta_time(const char *timeStr, int *flags, int ind_flag)
636 tid = strtoull(timeStr, NULL, 0);
637 if (timeStr[0] == '+')
639 if (timeStr[0] >= '0' && timeStr[0] <= '9' && timeStr[1] != 'x')
645 runcmd(int fd, const char *cmd, ...)
654 for (ac = 0; va_arg(va, void *) != NULL; ++ac)
658 av = malloc((ac + 1) * sizeof(char *));
660 for (i = 0; i < ac; ++i)
661 av[i] = va_arg(va, char *);
665 if ((pid = fork()) < 0) {
668 } else if (pid == 0) {
676 while (waitpid(pid, NULL, 0) != pid)
683 * Convert tid to timestamp.
686 timestamp(hammer_ioc_hist_entry_t hen)
688 static char timebuf[64];
689 time_t t = (time_t)hen->time32;
693 strftime(timebuf, sizeof(timebuf), "%d-%b-%Y %H:%M:%S", tp);
699 undo_hist_entry_compare(struct undo_hist_entry *he1,
700 struct undo_hist_entry *he2)
702 if (he1->tse.tid < he2->tse.tid)
704 if (he1->tse.tid > he2->tse.tid)
712 fprintf(stderr, "undo [-adDiuv] [-o outfile] "
713 "[-t transaction-id] [-t transaction-id] path...\n"
714 " -a Iterate all historical segments\n"
717 " -i Dump history transaction ids\n"
718 " -u Generate .undo files\n"
720 " -o file Output to the specified file\n"
721 " -t TID Retrieve as of transaction-id, TID\n"
722 " (a second `-t TID' to diff two)\n"
723 " transaction ids must be prefixed with 0x, and\n"
724 " otherwise may specify an index starting at 0\n"
725 " and iterating backwards through the history.\n"