undo: always collect history of the file
[dragonfly.git] / usr.bin / undo / undo.c
blob10f9ae9ece58386a4ba6b0032f04929148e1e320
1 /*
2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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
16 * distribution.
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
32 * SUCH DAMAGE.
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>
41 #include <sys/stat.h>
42 #include <sys/wait.h>
43 #include <sys/tree.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <stdarg.h>
47 #include <string.h>
48 #include <unistd.h>
49 #include <fcntl.h>
50 #include <errno.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;
65 ino_t inum;
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,
94 int ind_flag);
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;
110 enum undo_cmd cmd;
111 enum undo_type type;
112 struct hammer_ioc_hist_entry ts1;
113 struct hammer_ioc_hist_entry ts2;
114 int c;
115 int count_t;
116 int flags;
118 bzero(&ts1, sizeof(ts1));
119 bzero(&ts2, sizeof(ts2));
121 cmd = CMD_DUMP;
122 type = TYPE_FILE;
123 count_t = 0;
124 flags = 0;
126 while ((c = getopt(ac, av, "adDiuvo:t:")) != -1) {
127 switch(c) {
128 case 'd':
129 type = TYPE_DIFF;
130 break;
131 case 'D':
132 type = TYPE_RDIFF;
133 break;
134 case 'i':
135 if (type != TYPE_FILE)
136 usage();
137 type = TYPE_HISTORY;
138 cmd = CMD_ITERATEALL;
139 break;
140 case 'a':
141 cmd = CMD_ITERATEALL;
142 break;
143 case 'u':
144 outFilePostfix = ".undo";
145 break;
146 case 'v':
147 ++VerboseOpt;
148 break;
149 case 'o':
150 outFileName = optarg;
151 break;
152 case 't':
154 * Parse one or two -t options. If two are specified
155 * -d is implied (but may be overridden)
157 ++count_t;
158 if (count_t == 1) {
159 ts1.tid = parse_delta_time(optarg, &flags,
160 UNDO_FLAG_SETTID1);
161 } else if (count_t == 2) {
162 ts2.tid = parse_delta_time(optarg, &flags,
163 UNDO_FLAG_SETTID2);
164 if (type == TYPE_FILE)
165 type = TYPE_DIFF;
166 } else {
167 usage();
169 break;
170 default:
171 usage();
172 /* NOT REACHED */
173 break;
178 * Option validation
180 if (outFileName && outFilePostfix) {
181 fprintf(stderr, "The -o option may not be combined with -u\n");
182 usage();
185 ac -= optind;
186 av += optind;
187 if (ac > 1)
188 flags |= UNDO_FLAG_MULT;
190 if (ac == 0)
191 usage();
194 * Validate the output template, if specified.
196 if (outFileName && (flags & UNDO_FLAG_MULT)) {
197 const char *ptr = outFileName;
198 int didStr = 0;
200 while ((ptr = strchr(ptr, '%')) != NULL) {
201 if (ptr[1] == 's') {
202 if (didStr) {
203 fprintf(stderr, "Malformed output "
204 "template\n");
205 usage();
207 didStr = 1;
208 ++ptr;
209 } else if (ptr[1] != '%') {
210 fprintf(stderr, "Malformed output template\n");
211 usage();
212 } else {
213 ptr += 2;
218 while (ac) {
219 doiterate(*av, outFileName, outFilePostfix,
220 flags, ts1, ts2, cmd, type);
221 ++av;
222 --ac;
224 return(0);
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.
235 static
236 void
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;
248 char *path = NULL;
249 int i;
250 int fd;
251 int error;
253 RB_INIT(&dir_tree);
254 RB_INIT(&tse_tree);
256 tid_max.tid = HAMMER_MAX_TID;
257 tid_max.time32 = 0;
260 * Use the directory history to locate all possible versions of
261 * the file.
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);
268 close(fd);
271 if ((fd = open(filename, O_RDONLY)) > 0) {
272 collect_history(fd, &error, &tse_tree);
273 close(fd);
275 if (cmd == CMD_DUMP) {
276 if ((ts1.tid == 0 ||
277 flags & (UNDO_FLAG_SETTID1|UNDO_FLAG_SETTID2)) &&
278 RB_EMPTY(&tse_tree)) {
279 if ((fd = open(filename, O_RDONLY)) > 0) {
280 collect_history(fd, &error, &tse_tree);
281 close(fd);
285 * Find entry if tid set to placeholder index
287 if (flags & UNDO_FLAG_SETTID1){
288 tse1 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
289 while (tse1 && ts1.tid--) {
290 tse1 = RB_PREV(undo_hist_entry_rb_tree,
291 &tse_tree, tse1);
293 if (tse1)
294 ts1 = tse1->tse;
295 else
296 ts1.tid = 0;
298 if (flags & UNDO_FLAG_SETTID2){
299 tse2 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
300 while (tse2 && ts2.tid--) {
301 tse2 = RB_PREV(undo_hist_entry_rb_tree,
302 &tse_tree, tse2);
304 if (tse2)
305 ts2 = tse2->tse;
306 else
307 ts2.tid = 0;
311 * Single entry, most recent prior to current
313 if (ts1.tid == 0) {
314 tse2 = RB_MAX(undo_hist_entry_rb_tree, &tse_tree);
315 if (tse2) {
316 ts2 = tse2->tse;
317 tse1 = RB_PREV(undo_hist_entry_rb_tree,
318 &tse_tree, tse2);
319 if (tse1)
320 ts1 = tse1->tse;
323 if (ts1.tid == 0) {
324 printf("%s: No UNDO history found\n", filename);
325 } else {
326 dogenerate(filename,
327 outFileName, outFilePostfix,
328 0, 0, type,
329 ts1, ts2);
331 } else if (RB_ROOT(&tse_tree)) {
333 * Iterate entire history
335 printf("%s: ITERATE ENTIRE HISTORY\n", filename);
337 tse1 = NULL;
338 i = 0;
339 RB_FOREACH(tse2, undo_hist_entry_rb_tree, &tse_tree) {
340 if (tse1) {
341 dogenerate(filename,
342 outFileName, outFilePostfix,
343 flags, i, type,
344 tse1->tse, tse2->tse);
346 if (tse1 && tse2->inum != tse1->inum)
347 flags |= UNDO_FLAG_INOCHG;
348 else
349 flags &= ~UNDO_FLAG_INOCHG;
350 tse1 = tse2;
351 ++i;
354 * There is no delta to print for the last pair,
355 * because they are identical.
357 if (type != TYPE_DIFF && type != TYPE_RDIFF) {
358 dogenerate(filename,
359 outFileName, outFilePostfix,
360 flags, i, type,
361 tse1->tse, tid_max);
363 } else {
364 printf("%s: ITERATE ENTIRE HISTORY: %s\n",
365 filename, strerror(error));
367 if (path)
368 free(path);
369 clean_tree(&dir_tree);
370 clean_tree(&tse_tree);
374 * Generate output for a file as-of ts1 (ts1 may be 0!), if diffing then
375 * through ts2.
377 static
378 void
379 dogenerate(const char *filename, const char *outFileName,
380 const char *outFilePostfix,
381 int flags, int idx, enum undo_type type,
382 struct hammer_ioc_hist_entry ts1,
383 struct hammer_ioc_hist_entry ts2)
385 struct stat st;
386 const char *elm;
387 char *ipath1 = NULL;
388 char *ipath2 = NULL;
389 FILE *fi;
390 FILE *fp;
391 char *buf;
392 char *path;
393 time_t t;
394 struct tm *tp;
395 char datestr[64];
396 int n;
398 buf = malloc(8192);
401 * Open the input file. If ts1 is 0 try to locate the most recent
402 * version of the file prior to the current version.
404 if (ts1.tid == 0)
405 asprintf(&ipath1, "%s", filename);
406 else
407 asprintf(&ipath1, "%s@@0x%016jx", filename, (uintmax_t)ts1.tid);
409 if (ts2.tid == 0)
410 asprintf(&ipath2, "%s", filename);
411 else
412 asprintf(&ipath2, "%s@@0x%016jx", filename, (uintmax_t)ts2.tid);
414 if (lstat(ipath1, &st) < 0 && lstat(ipath2, &st) < 0) {
415 if (idx == 0 || VerboseOpt) {
416 fprintf(stderr, "Unable to access either %s or %s\n",
417 ipath1, ipath2);
419 free(ipath1);
420 free(ipath2);
421 goto done;
425 * elm is the last component of the input file name
427 if ((elm = strrchr(filename, '/')) != NULL)
428 ++elm;
429 else
430 elm = filename;
433 * Where do we stuff our output?
435 if (outFileName) {
436 if (flags & UNDO_FLAG_MULT) {
437 asprintf(&path, outFileName, elm);
438 fp = fopen(path, "w");
439 if (fp == NULL) {
440 perror(path);
441 exit(1);
443 free(path);
444 } else {
445 fp = fopen(outFileName, "w");
446 if (fp == NULL) {
447 perror(outFileName);
448 exit(1);
451 } else if (outFilePostfix) {
452 if (idx >= 0) {
453 asprintf(&path, "%s%s.%04d", filename,
454 outFilePostfix, idx);
455 } else {
456 asprintf(&path, "%s%s", filename, outFilePostfix);
458 fp = fopen(path, "w");
459 if (fp == NULL) {
460 perror(path);
461 exit(1);
463 free(path);
464 } else {
465 if ((flags & UNDO_FLAG_MULT) && type == TYPE_FILE) {
466 if (idx >= 0) {
467 printf("\n>>> %s %04d 0x%016jx %s\n\n",
468 filename, idx, (uintmax_t)ts1.tid,
469 timestamp(&ts1));
470 } else {
471 printf("\n>>> %s ---- 0x%016jx %s\n\n",
472 filename, (uintmax_t)ts1.tid,
473 timestamp(&ts1));
475 } else if (idx >= 0 && type == TYPE_FILE) {
476 printf("\n>>> %s %04d 0x%016jx %s\n\n",
477 filename, idx, (uintmax_t)ts1.tid,
478 timestamp(&ts1));
480 fp = stdout;
483 switch(type) {
484 case TYPE_FILE:
485 if ((fi = fopen(ipath1, "r")) != NULL) {
486 while ((n = fread(buf, 1, 8192, fi)) > 0)
487 fwrite(buf, 1, n, fp);
488 fclose(fi);
490 break;
491 case TYPE_DIFF:
492 printf("diff -N -r -u %s %s (to %s)\n",
493 ipath1, ipath2, timestamp(&ts2));
494 fflush(stdout);
495 runcmd(fileno(fp), "/usr/bin/diff", "diff", "-N", "-r", "-u", ipath1, ipath2, NULL);
496 break;
497 case TYPE_RDIFF:
498 printf("diff -N -r -u %s %s\n", ipath2, ipath1);
499 fflush(stdout);
500 runcmd(fileno(fp), "/usr/bin/diff", "diff", "-N", "-r", "-u", ipath2, ipath1, NULL);
501 break;
502 case TYPE_HISTORY:
503 t = (time_t)ts1.time32;
504 tp = localtime(&t);
505 strftime(datestr, sizeof(datestr), "%d-%b-%Y %H:%M:%S", tp);
506 printf("\t0x%016jx %s", (uintmax_t)ts1.tid, datestr);
507 if (flags & UNDO_FLAG_INOCHG)
508 printf(" inode-change");
509 if (lstat(ipath1, &st) < 0)
510 printf(" file-deleted");
511 printf("\n");
512 break;
515 if (fp != stdout)
516 fclose(fp);
517 done:
518 free(buf);
521 static
522 void
523 clean_tree(struct undo_hist_entry_rb_tree *tree)
525 struct undo_hist_entry *tse;
527 while ((tse = RB_ROOT(tree)) != NULL) {
528 RB_REMOVE(undo_hist_entry_rb_tree, tree, tse);
529 free(tse);
533 static
534 void
535 collect_history(int fd, int *errorp, struct undo_hist_entry_rb_tree *tse_tree)
537 struct hammer_ioc_history hist;
538 struct undo_hist_entry *tse;
539 struct stat st;
540 int istmp;
541 int i;
544 * Setup
546 bzero(&hist, sizeof(hist));
547 hist.beg_tid = HAMMER_MIN_TID;
548 hist.end_tid = HAMMER_MAX_TID;
549 hist.head.flags |= HAMMER_IOC_HISTORY_ATKEY;
550 hist.key = 0;
551 hist.nxt_key = HAMMER_MAX_KEY;
553 *errorp = 0;
555 if (tse_tree == NULL) {
556 tse_tree = malloc(sizeof(*tse_tree));
557 RB_INIT(tse_tree);
558 istmp = 1;
559 } else {
560 istmp = 0;
564 * Save the inode so inode changes can be reported.
566 st.st_ino = 0;
567 fstat(fd, &st);
570 * Collect a unique set of transaction ids
572 if (ioctl(fd, HAMMERIOC_GETHISTORY, &hist) < 0) {
573 *errorp = errno;
574 goto done;
576 for (;;) {
577 for (i = 0; i < hist.count; ++i) {
578 tse = malloc(sizeof(*tse));
579 tse->tse = hist.hist_ary[i];
580 tse->inum = st.st_ino;
581 if (RB_INSERT(undo_hist_entry_rb_tree, tse_tree, tse)) {
582 free(tse);
585 if (hist.head.flags & HAMMER_IOC_HISTORY_EOF)
586 break;
587 if (hist.head.flags & HAMMER_IOC_HISTORY_NEXT_KEY) {
588 hist.key = hist.nxt_key;
589 hist.nxt_key = HAMMER_MAX_KEY;
591 if (hist.head.flags & HAMMER_IOC_HISTORY_NEXT_TID)
592 hist.beg_tid = hist.nxt_tid;
593 if (ioctl(fd, HAMMERIOC_GETHISTORY, &hist) < 0) {
594 *errorp = errno;
595 break;
600 * Cleanup
602 done:
603 if (istmp) {
604 clean_tree(tse_tree);
605 free(tse_tree);
609 static
610 void
611 collect_dir_history(const char *filename, int *errorp,
612 struct undo_hist_entry_rb_tree *dir_tree)
614 char *dirname;
615 int fd;
616 int error;
618 *errorp = 0;
619 if (strrchr(filename, '/')) {
620 dirname = strdup(filename);
621 *strrchr(dirname, '/') = 0;
622 } else {
623 dirname = strdup(".");
625 if ((fd = open(dirname, O_RDONLY)) > 0) {
626 collect_history(fd, &error, dir_tree);
627 close(fd);
631 static
632 hammer_tid_t
633 parse_delta_time(const char *timeStr, int *flags, int ind_flag)
635 hammer_tid_t tid;
637 tid = strtoull(timeStr, NULL, 0);
638 if (timeStr[0] == '+')
639 ++timeStr;
640 if (timeStr[0] >= '0' && timeStr[0] <= '9' && timeStr[1] != 'x')
641 *flags |= ind_flag;
642 return(tid);
645 static void
646 runcmd(int fd, const char *cmd, ...)
648 va_list va;
649 pid_t pid;
650 char **av;
651 int ac;
652 int i;
654 va_start(va, cmd);
655 for (ac = 0; va_arg(va, void *) != NULL; ++ac)
657 va_end(va);
659 av = malloc((ac + 1) * sizeof(char *));
660 va_start(va, cmd);
661 for (i = 0; i < ac; ++i)
662 av[i] = va_arg(va, char *);
663 va_end(va);
664 av[i] = NULL;
666 if ((pid = fork()) < 0) {
667 perror("fork");
668 exit(1);
669 } else if (pid == 0) {
670 if (fd != 1) {
671 dup2(fd, 1);
672 close(fd);
674 execv(cmd, av);
675 _exit(1);
676 } else {
677 while (waitpid(pid, NULL, 0) != pid)
680 free(av);
684 * Convert tid to timestamp.
686 static char *
687 timestamp(hammer_ioc_hist_entry_t hen)
689 static char timebuf[64];
690 time_t t = (time_t)hen->time32;
691 struct tm *tp;
693 tp = localtime(&t);
694 strftime(timebuf, sizeof(timebuf), "%d-%b-%Y %H:%M:%S", tp);
695 return(timebuf);
698 static
700 undo_hist_entry_compare(struct undo_hist_entry *he1,
701 struct undo_hist_entry *he2)
703 if (he1->tse.tid < he2->tse.tid)
704 return(-1);
705 if (he1->tse.tid > he2->tse.tid)
706 return(1);
707 return(0);
710 static void
711 usage(void)
713 fprintf(stderr, "undo [-adDiuv] [-o outfile] "
714 "[-t transaction-id] [-t transaction-id] path...\n"
715 " -a Iterate all historical segments\n"
716 " -d Forward diff\n"
717 " -D Reverse diff\n"
718 " -i Dump history transaction ids\n"
719 " -u Generate .undo files\n"
720 " -v Verbose\n"
721 " -o file Output to the specified file\n"
722 " -t TID Retrieve as of transaction-id, TID\n"
723 " (a second `-t TID' to diff two)\n"
724 " transaction ids must be prefixed with 0x, and\n"
725 " otherwise may specify an index starting at 0\n"
726 " and iterating backwards through the history.\n"
728 exit(1);