2 * e2undo.c - Replay an undo log onto an ext2/3/4 filesystem
4 * Copyright IBM Corporation, 2007
5 * Author Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
8 * This file may be redistributed under the terms of the GNU Public
25 #include "ext2fs/ext2fs.h"
26 #include "support/nls-enable.h"
31 # define dbg_printf(f, a...) do {printf(f, ## a); fflush(stdout); } while (0)
33 # define dbg_printf(f, a...)
37 * Undo file format: The file is cut up into undo_header.block_size blocks.
38 * The first block contains the header.
39 * The second block contains the superblock.
40 * There is then a repeating series of blocks as follows:
41 * A key block, which contains undo_keys to map the following data blocks.
43 * (Note that there are pointers to the first key block and the sb, so this
44 * order isn't strictly necessary.)
46 #define E2UNDO_MAGIC "E2UNDO02"
47 #define KEYBLOCK_MAGIC 0xCADECADE
49 #define E2UNDO_STATE_FINISHED 0x1 /* undo file is complete */
51 #define E2UNDO_MIN_BLOCK_SIZE 1024 /* undo blocks are no less than 1KB */
52 #define E2UNDO_MAX_BLOCK_SIZE 1048576 /* undo blocks are no more than 1MB */
55 char magic[8]; /* "E2UNDO02" */
56 __le64 num_keys; /* how many keys? */
57 __le64 super_offset; /* where in the file is the superblock copy? */
58 __le64 key_offset; /* where do the key/data block chunks start? */
59 __le32 block_size; /* block size of the undo file */
60 __le32 fs_block_size; /* block size of the target device */
61 __le32 sb_crc; /* crc32c of the superblock */
62 __le32 state; /* e2undo state flags */
63 __le32 f_compat; /* compatible features (none so far) */
64 __le32 f_incompat; /* incompatible features (none so far) */
65 __le32 f_rocompat; /* ro compatible features (none so far) */
66 __le32 pad32; /* padding for fs_offset */
67 __le64 fs_offset; /* filesystem offset */
68 __u8 padding[436]; /* padding */
69 __le32 header_crc; /* crc32c of the header (but not this field) */
72 #define E2UNDO_MAX_EXTENT_BLOCKS 512 /* max extent size, in blocks */
75 __le64 fsblk; /* where in the fs does the block go */
76 __le32 blk_crc; /* crc32c of the block */
77 __le32 size; /* how many bytes in this block? */
80 struct undo_key_block {
81 __le32 magic; /* KEYBLOCK_MAGIC number */
82 __le32 crc; /* block checksum */
83 __le64 reserved; /* zero */
84 #pragma GCC diagnostic push
85 #pragma GCC diagnostic ignored "-Wpedantic"
86 struct undo_key keys[0]; /* keys, which come immediately after */
87 #pragma GCC diagnostic pop
90 struct undo_key_info {
98 struct undo_header hdr;
100 unsigned int blocksize, fs_blocksize;
103 struct undo_key_info *keys;
105 #define KEYS_PER_BLOCK(d) (((d)->blocksize / sizeof(struct undo_key)) - 1)
107 #define E2UNDO_FEATURE_COMPAT_FS_OFFSET 0x1 /* the filesystem offset */
109 static inline int e2undo_has_feature_fs_offset(struct undo_header *header) {
110 return ext2fs_le32_to_cpu(header->f_compat) &
111 E2UNDO_FEATURE_COMPAT_FS_OFFSET;
114 static char *prg_name;
115 static char *undo_file;
117 static void usage(void)
120 _("Usage: %s [-f] [-h] [-n] [-o offset] [-v] [-z undo_file] <transaction file> <filesystem>\n"), prg_name);
124 static void dump_header(struct undo_header *hdr)
126 printf("nr keys:\t%llu\n", ext2fs_le64_to_cpu(hdr->num_keys));
127 printf("super block:\t%llu\n", ext2fs_le64_to_cpu(hdr->super_offset));
128 printf("key block:\t%llu\n", ext2fs_le64_to_cpu(hdr->key_offset));
129 printf("block size:\t%u\n", ext2fs_le32_to_cpu(hdr->block_size));
130 printf("fs block size:\t%u\n", ext2fs_le32_to_cpu(hdr->fs_block_size));
131 printf("super crc:\t0x%x\n", ext2fs_le32_to_cpu(hdr->sb_crc));
132 printf("state:\t\t0x%x\n", ext2fs_le32_to_cpu(hdr->state));
133 printf("compat:\t\t0x%x\n", ext2fs_le32_to_cpu(hdr->f_compat));
134 printf("incompat:\t0x%x\n", ext2fs_le32_to_cpu(hdr->f_incompat));
135 printf("rocompat:\t0x%x\n", ext2fs_le32_to_cpu(hdr->f_rocompat));
136 if (e2undo_has_feature_fs_offset(hdr))
137 printf("fs offset:\t%llu\n", ext2fs_le64_to_cpu(hdr->fs_offset));
138 printf("header crc:\t0x%x\n", ext2fs_le32_to_cpu(hdr->header_crc));
141 static void print_undo_mismatch(struct ext2_super_block *fs_super,
142 struct ext2_super_block *undo_super)
145 _("The file system superblock doesn't match the undo file.\n"));
146 if (memcmp(fs_super->s_uuid, undo_super->s_uuid,
147 sizeof(fs_super->s_uuid)))
148 printf("%s", _("UUID does not match.\n"));
149 if (fs_super->s_mtime != undo_super->s_mtime)
150 printf("%s", _("Last mount time does not match.\n"));
151 if (fs_super->s_wtime != undo_super->s_wtime)
152 printf("%s", _("Last write time does not match.\n"));
153 if (fs_super->s_kbytes_written != undo_super->s_kbytes_written)
154 printf("%s", _("Lifetime write counter does not match.\n"));
157 static int check_filesystem(struct undo_context *ctx, io_channel channel)
159 struct ext2_super_block super, *sb;
164 io_channel_set_blksize(channel, SUPERBLOCK_OFFSET);
165 retval = io_channel_read_blk64(channel, 1, -SUPERBLOCK_SIZE, &super);
167 com_err(prg_name, retval,
168 "%s", _("while reading filesystem superblock."));
173 * Compare the FS and the undo file superblock so that we can't apply
174 * e2undo "patches" out of order.
176 retval = ext2fs_get_mem(ctx->blocksize, &buf);
178 com_err(prg_name, retval, "%s", _("while allocating memory"));
181 retval = io_channel_read_blk64(ctx->undo_file, ctx->super_block,
182 -SUPERBLOCK_SIZE, buf);
184 com_err(prg_name, retval, "%s", _("while fetching superblock"));
187 sb = (struct ext2_super_block *)buf;
188 sb->s_magic = ~sb->s_magic;
189 if (memcmp(&super, buf, sizeof(super))) {
190 print_undo_mismatch(&super, (struct ext2_super_block *)buf);
194 sb_crc = ext2fs_crc32c_le(~0, (unsigned char *)buf, SUPERBLOCK_SIZE);
195 if (ext2fs_le32_to_cpu(ctx->hdr.sb_crc) != sb_crc) {
197 _("Undo file superblock checksum doesn't match.\n"));
203 ext2fs_free_mem(&buf);
207 static int key_compare(const void *a, const void *b)
209 const struct undo_key_info *ka, *kb;
213 return ka->fsblk - kb->fsblk;
216 static int e2undo_setup_tdb(const char *name, io_manager *io_ptr)
218 errcode_t retval = 0;
220 char *tdb_file = NULL;
221 char *dev_name, *tmp_name;
223 /* (re)open a specific undo file */
224 if (undo_file && undo_file[0] != 0) {
225 retval = set_undo_io_backing_manager(*io_ptr);
228 *io_ptr = undo_io_manager;
229 retval = set_undo_io_backup_file(undo_file);
232 printf(_("Overwriting existing filesystem; this can be undone "
233 "using the command:\n"
234 " e2undo %s %s\n\n"),
240 * Configuration via a conf file would be
243 tdb_dir = getenv("E2FSPROGS_UNDO_DIR");
245 tdb_dir = "/var/lib/e2fsprogs";
247 if (!strcmp(tdb_dir, "none") || (tdb_dir[0] == 0) ||
248 access(tdb_dir, W_OK))
251 tmp_name = strdup(name);
254 dev_name = basename(tmp_name);
255 tdb_file = malloc(strlen(tdb_dir) + 8 + strlen(dev_name) + 7 + 1);
260 sprintf(tdb_file, "%s/e2undo-%s.e2undo", tdb_dir, dev_name);
263 if ((unlink(tdb_file) < 0) && (errno != ENOENT)) {
265 com_err(prg_name, retval,
266 _("while trying to delete %s"), tdb_file);
270 retval = set_undo_io_backing_manager(*io_ptr);
273 *io_ptr = undo_io_manager;
274 retval = set_undo_io_backup_file(tdb_file);
277 printf(_("Overwriting existing filesystem; this can be undone "
278 "using the command:\n"
279 " e2undo %s %s\n\n"),
287 com_err(prg_name, retval, "while trying to setup undo file\n");
291 int main(int argc, char *argv[])
293 int c, force = 0, dry_run = 0, verbose = 0, dump = 0;
296 int mount_flags, csum_error = 0, io_error = 0;
297 size_t i, keys_per_block;
298 char *device_name, *tdb_file;
299 io_manager manager = unix_io_manager;
300 struct undo_context undo_ctx;
302 struct undo_key_block *keyb;
303 struct undo_key *dkey;
304 struct undo_key_info *ikey;
305 __u32 key_crc, blk_crc, hdr_crc;
309 char opt_offset_string[40] = { 0 };
312 setlocale(LC_MESSAGES, "");
313 setlocale(LC_CTYPE, "");
314 bindtextdomain(NLS_CAT_NAME, LOCALEDIR);
315 textdomain(NLS_CAT_NAME);
316 set_com_err_gettext(gettext);
318 add_error_table(&et_ext2_error_table);
321 while ((c = getopt(argc, argv, "fhno:vz:")) != EOF) {
333 offset = strtoull(optarg, &buf, 0);
336 _("illegal offset - %s"), optarg);
339 /* used to indicate that an offset was specified */
340 opt_offset_string[0] = 1;
353 if (argc != optind + 2)
356 tdb_file = argv[optind];
357 device_name = argv[optind+1];
359 if (undo_file && strcmp(tdb_file, undo_file) == 0) {
360 printf(_("Will not write to an undo file while replaying it.\n"));
364 /* Interpret the undo file */
365 retval = manager->open(tdb_file, IO_FLAG_EXCLUSIVE,
366 &undo_ctx.undo_file);
368 com_err(prg_name, errno,
369 _("while opening undo file `%s'\n"), tdb_file);
372 retval = io_channel_read_blk64(undo_ctx.undo_file, 0,
373 -(int)sizeof(undo_ctx.hdr),
376 com_err(prg_name, retval, _("while reading undo file"));
379 if (memcmp(undo_ctx.hdr.magic, E2UNDO_MAGIC,
380 sizeof(undo_ctx.hdr.magic))) {
381 fprintf(stderr, _("%s: Not an undo file.\n"), tdb_file);
385 dump_header(&undo_ctx.hdr);
388 hdr_crc = ext2fs_crc32c_le(~0, (unsigned char *)&undo_ctx.hdr,
389 sizeof(struct undo_header) -
391 if (!force && ext2fs_le32_to_cpu(undo_ctx.hdr.header_crc) != hdr_crc) {
392 fprintf(stderr, _("%s: Header checksum doesn't match.\n"),
396 undo_ctx.blocksize = ext2fs_le32_to_cpu(undo_ctx.hdr.block_size);
397 undo_ctx.fs_blocksize = ext2fs_le32_to_cpu(undo_ctx.hdr.fs_block_size);
398 if (undo_ctx.blocksize == 0 || undo_ctx.fs_blocksize == 0) {
399 fprintf(stderr, _("%s: Corrupt undo file header.\n"), tdb_file);
402 if (!force && undo_ctx.blocksize > E2UNDO_MAX_BLOCK_SIZE) {
403 fprintf(stderr, _("%s: Undo block size too large.\n"),
407 if (!force && undo_ctx.blocksize < E2UNDO_MIN_BLOCK_SIZE) {
408 fprintf(stderr, _("%s: Undo block size too small.\n"),
412 undo_ctx.super_block = ext2fs_le64_to_cpu(undo_ctx.hdr.super_offset);
413 undo_ctx.num_keys = ext2fs_le64_to_cpu(undo_ctx.hdr.num_keys);
414 io_channel_set_blksize(undo_ctx.undo_file, undo_ctx.blocksize);
416 * Do not compare undo_ctx.hdr.f_compat with the available compatible
417 * features set, because a "missing" compatible feature should
418 * not cause any problems.
420 if (!force && (undo_ctx.hdr.f_incompat || undo_ctx.hdr.f_rocompat)) {
421 fprintf(stderr, _("%s: Unknown undo file feature set.\n"),
427 retval = ext2fs_check_if_mounted(device_name, &mount_flags);
429 com_err(prg_name, retval, _("Error while determining whether "
430 "%s is mounted."), device_name);
434 if (mount_flags & EXT2_MF_MOUNTED) {
435 com_err(prg_name, retval, "%s", _("e2undo should only be run "
436 "on unmounted filesystems"));
441 retval = e2undo_setup_tdb(device_name, &manager);
446 retval = manager->open(device_name,
447 IO_FLAG_EXCLUSIVE | (dry_run ? 0 : IO_FLAG_RW),
450 com_err(prg_name, retval,
451 _("while opening `%s'"), device_name);
455 if (*opt_offset_string || e2undo_has_feature_fs_offset(&undo_ctx.hdr)) {
456 if (!*opt_offset_string)
457 offset = ext2fs_le64_to_cpu(undo_ctx.hdr.fs_offset);
458 retval = snprintf(opt_offset_string, sizeof(opt_offset_string),
459 "offset=%llu", offset);
460 if ((size_t) retval >= sizeof(opt_offset_string)) {
461 /* should not happen... */
462 com_err(prg_name, 0, _("specified offset is too large"));
465 io_channel_set_options(channel, opt_offset_string);
468 if (!force && check_filesystem(&undo_ctx, channel))
471 /* prepare to read keys */
472 retval = ext2fs_get_mem(sizeof(struct undo_key_info) * undo_ctx.num_keys,
475 com_err(prg_name, retval, "%s", _("while allocating memory"));
478 ikey = undo_ctx.keys;
479 retval = ext2fs_get_mem(undo_ctx.blocksize, &keyb);
481 com_err(prg_name, retval, "%s", _("while allocating memory"));
484 retval = ext2fs_get_mem(E2UNDO_MAX_EXTENT_BLOCKS * undo_ctx.blocksize,
487 com_err(prg_name, retval, "%s", _("while allocating memory"));
492 keys_per_block = KEYS_PER_BLOCK(&undo_ctx);
493 lblk = ext2fs_le64_to_cpu(undo_ctx.hdr.key_offset);
494 dbg_printf("nr_keys=%lu, kpb=%zu, blksz=%u\n",
495 undo_ctx.num_keys, keys_per_block, undo_ctx.blocksize);
496 for (i = 0; i < undo_ctx.num_keys; i += keys_per_block) {
500 retval = io_channel_read_blk64(undo_ctx.undo_file,
503 com_err(prg_name, retval, "%s", _("while reading keys"));
506 undo_ctx.num_keys = i - 1;
514 ext2fs_le32_to_cpu(keyb->magic) != KEYBLOCK_MAGIC) {
515 fprintf(stderr, _("%s: wrong key magic at %llu\n"),
521 key_crc = ext2fs_crc32c_le(~0, (unsigned char *)keyb,
523 if (!force && ext2fs_le32_to_cpu(crc) != key_crc) {
525 _("%s: key block checksum error at %llu.\n"),
530 /* load keys from key block */
532 max_j = undo_ctx.num_keys - i;
533 if (max_j > keys_per_block)
534 max_j = keys_per_block;
535 for (j = 0, dkey = keyb->keys;
537 j++, ikey++, dkey++) {
538 ikey->fsblk = ext2fs_le64_to_cpu(dkey->fsblk);
539 ikey->fileblk = lblk;
540 ikey->blk_crc = ext2fs_le32_to_cpu(dkey->blk_crc);
541 ikey->size = ext2fs_le32_to_cpu(dkey->size);
542 lblk += (ikey->size + undo_ctx.blocksize - 1) /
545 if (E2UNDO_MAX_EXTENT_BLOCKS * undo_ctx.blocksize <
547 com_err(prg_name, retval,
548 _("%s: block %llu is too long."),
549 tdb_file, ikey->fsblk);
553 /* check each block's crc */
554 retval = io_channel_read_blk64(undo_ctx.undo_file,
559 com_err(prg_name, retval,
560 _("while fetching block %llu."),
568 blk_crc = ext2fs_crc32c_le(~0, (unsigned char *)buf,
570 if (blk_crc != ikey->blk_crc) {
572 _("checksum error in filesystem block "
573 "%llu (undo blk %llu)\n"),
574 ikey->fsblk, ikey->fileblk);
581 ext2fs_free_mem(&keyb);
583 /* sort keys in fs block order */
584 qsort(undo_ctx.keys, undo_ctx.num_keys, sizeof(struct undo_key_info),
588 io_channel_set_blksize(channel, undo_ctx.fs_blocksize);
589 for (i = 0, ikey = undo_ctx.keys; i < undo_ctx.num_keys; i++, ikey++) {
590 retval = io_channel_read_blk64(undo_ctx.undo_file,
595 com_err(prg_name, retval,
596 _("while fetching block %llu."),
603 printf("Replayed block of size %u from %llu to %llu\n",
604 ikey->size, ikey->fileblk, ikey->fsblk);
607 retval = io_channel_write_blk64(channel, ikey->fsblk,
608 -(int)ikey->size, buf);
610 com_err(prg_name, retval,
611 _("while writing block %llu."), ikey->fsblk);
617 fprintf(stderr, _("Undo file corruption; run e2fsck NOW!\n"));
619 fprintf(stderr, _("IO error during replay; run e2fsck NOW!\n"));
620 if (!(ext2fs_le32_to_cpu(undo_ctx.hdr.state) & E2UNDO_STATE_FINISHED)) {
622 fprintf(stderr, _("Incomplete undo record; run e2fsck.\n"));
624 ext2fs_free_mem(&buf);
625 ext2fs_free_mem(&undo_ctx.keys);
626 io_channel_close(channel);
628 /* If there were problems, try to force a fsck */
629 if (!dry_run && (force || csum_error || io_error)) {
630 retval = ext2fs_open2(device_name, NULL,
631 EXT2_FLAG_RW | EXT2_FLAG_64BITS, 0, 0,
635 fs->super->s_state &= ~EXT2_VALID_FS;
636 if (csum_error || io_error)
637 fs->super->s_state |= EXT2_ERROR_FS;
638 ext2fs_mark_super_dirty(fs);
639 ext2fs_close_free(&fs);
643 io_channel_close(undo_ctx.undo_file);