2 * logdump.c --- dump the contents of the journal out to a file
4 * Authro: Stephen C. Tweedie, 2001 <sct@redhat.com>
5 * Copyright (C) 2001 Red Hat, Inc.
6 * Based on portions Copyright (C) 1994 Theodore Ts'o.
8 * This file may be redistributed under the terms of the GNU Public
21 #include <sys/types.h>
33 #include "blkid/blkid.h"
35 #include <uuid/uuid.h>
37 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
39 #define ANY_BLOCK ((unsigned int) -1)
41 int dump_all, dump_contents, dump_descriptors;
42 unsigned int block_to_dump, group_to_dump, bitmap_to_dump;
43 unsigned int inode_block_to_dump, inode_offset_to_dump, bitmap_to_dump;
44 ext2_ino_t inode_to_dump;
48 enum journal_location where;
53 static void dump_journal(char *, FILE *, struct journal_source *);
55 static void dump_descriptor_block(FILE *, struct journal_source *,
56 char *, journal_superblock_t *,
57 unsigned int *, int, tid_t);
59 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
60 unsigned int, int, tid_t);
62 static void dump_metadata_block(FILE *, struct journal_source *,
63 journal_superblock_t*,
64 unsigned int, unsigned int, int, tid_t);
66 static void do_hexdump (FILE *, char *, int);
68 #define WRAP(jsb, blocknr) \
69 if (blocknr >= be32_to_cpu((jsb)->s_maxlen)) \
70 blocknr -= (be32_to_cpu((jsb)->s_maxlen) - \
71 be32_to_cpu((jsb)->s_first));
74 void do_logdump(int argc, char **argv)
81 char *inode_spec = NULL;
82 char *journal_fn = NULL;
85 ext2_ino_t journal_inum;
86 struct ext2_inode journal_inode;
87 ext2_file_t journal_file;
89 const char *logdump_usage = ("Usage: logdump "
90 "[-ac] [-b<block>] [-i<inode>] "
91 "[-f<journal_file>] [output_file]");
92 struct journal_source journal_source;
93 struct ext2_super_block *es = NULL;
95 journal_source.where = 0;
96 journal_source.fd = 0;
97 journal_source.file = 0;
100 dump_descriptors = 1;
101 block_to_dump = ANY_BLOCK;
103 inode_block_to_dump = ANY_BLOCK;
107 while ((c = getopt (argc, argv, "ab:ci:f:s")) != EOF) {
113 block_to_dump = strtoul(optarg, &tmp, 0);
116 "Bad block number - %s", optarg);
119 dump_descriptors = 0;
129 dump_descriptors = 0;
135 com_err(argv[0], 0, logdump_usage);
139 if (optind != argc && optind != argc-1) {
140 com_err(argv[0], 0, logdump_usage);
145 es = current_fs->super;
148 int inode_group, group_offset, inodes_per_block;
150 if (check_fs_open(argv[0]))
153 inode_to_dump = string_to_inode(inode_spec);
157 inode_group = ((inode_to_dump - 1)
158 / es->s_inodes_per_group);
159 group_offset = ((inode_to_dump - 1)
160 % es->s_inodes_per_group);
161 inodes_per_block = (current_fs->blocksize
162 / sizeof(struct ext2_inode));
164 inode_block_to_dump =
165 current_fs->group_desc[inode_group].bg_inode_table +
166 (group_offset / inodes_per_block);
167 inode_offset_to_dump = ((group_offset % inodes_per_block)
168 * sizeof(struct ext2_inode));
169 printf("Inode %u is at group %u, block %u, offset %u\n",
170 inode_to_dump, inode_group,
171 inode_block_to_dump, inode_offset_to_dump);
174 if (optind == argc) {
177 out_fn = argv[optind];
178 out_file = fopen(out_fn, "w");
180 com_err(argv[0], errno, "while opening %s for logdump",
186 if (block_to_dump != ANY_BLOCK && current_fs != NULL) {
187 group_to_dump = ((block_to_dump -
188 es->s_first_data_block)
189 / es->s_blocks_per_group);
190 bitmap_to_dump = current_fs->group_desc[group_to_dump].bg_block_bitmap;
193 if (!journal_fn && check_fs_open(argv[0]))
197 /* Set up to read journal from a regular file somewhere */
198 journal_fd = open(journal_fn, O_RDONLY, 0);
199 if (journal_fd < 0) {
200 com_err(argv[0], errno, "while opening %s for logdump",
205 journal_source.where = JOURNAL_IS_EXTERNAL;
206 journal_source.fd = journal_fd;
207 } else if ((journal_inum = es->s_journal_inum)) {
209 if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
211 "no journal backup in super block\n");
214 memset(&journal_inode, 0, sizeof(struct ext2_inode));
215 memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
217 journal_inode.i_size = es->s_jnl_blocks[16];
218 journal_inode.i_links_count = 1;
219 journal_inode.i_mode = LINUX_S_IFREG | 0600;
221 if (debugfs_read_inode(journal_inum, &journal_inode,
226 retval = ext2fs_file_open2(current_fs, journal_inum,
227 &journal_inode, 0, &journal_file);
229 com_err(argv[0], retval, "while opening ext2 file");
232 journal_source.where = JOURNAL_IS_INTERNAL;
233 journal_source.file = journal_file;
237 uuid_unparse(es->s_journal_uuid, uuid);
238 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
240 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
242 com_err(argv[0], 0, "filesystem has no journal");
245 journal_fd = open(journal_fn, O_RDONLY, 0);
246 if (journal_fd < 0) {
247 com_err(argv[0], errno, "while opening %s for logdump",
252 fprintf(out_file, "Using external journal found at %s\n",
255 journal_source.where = JOURNAL_IS_EXTERNAL;
256 journal_source.fd = journal_fd;
259 dump_journal(argv[0], out_file, &journal_source);
261 if (journal_source.where == JOURNAL_IS_INTERNAL)
262 ext2fs_file_close(journal_file);
266 if (out_file != stdout)
273 static int read_journal_block(const char *cmd, struct journal_source *source,
274 off_t offset, char *buf, int size,
279 if (source->where == JOURNAL_IS_EXTERNAL) {
280 if (lseek(source->fd, offset, SEEK_SET) < 0) {
282 com_err(cmd, retval, "while seeking in reading journal");
285 retval = read(source->fd, buf, size);
292 retval = ext2fs_file_lseek(source->file, offset,
293 EXT2_SEEK_SET, NULL);
295 com_err(cmd, retval, "while seeking in reading journal");
299 retval = ext2fs_file_read(source->file, buf, size, got);
303 com_err(cmd, retval, "while while reading journal");
304 else if (*got != (unsigned int) size) {
305 com_err(cmd, 0, "short read (read %d, expected %d) while while reading journal", *got, size);
312 static const char *type_to_name(int btype)
315 case JFS_DESCRIPTOR_BLOCK:
316 return "descriptor block";
317 case JFS_COMMIT_BLOCK:
318 return "commit block";
319 case JFS_SUPERBLOCK_V1:
320 return "V1 superblock";
321 case JFS_SUPERBLOCK_V2:
322 return "V2 superblock";
323 case JFS_REVOKE_BLOCK:
324 return "revoke table";
326 return "unrecognised type";
330 static void dump_journal(char *cmdname, FILE *out_file,
331 struct journal_source *source)
333 struct ext2_super_block *sb;
334 char jsb_buffer[1024];
336 journal_superblock_t *jsb;
337 unsigned int blocksize = 1024;
340 __u32 magic, sequence, blocktype;
341 journal_header_t *header;
344 unsigned int blocknr = 0;
346 /* First, check to see if there's an ext2 superblock header */
347 retval = read_journal_block(cmdname, source, 0,
352 jsb = (journal_superblock_t *) buf;
353 sb = (struct ext2_super_block *) (buf+1024);
355 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
356 ext2fs_swap_super(sb);
359 if ((be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) &&
360 (sb->s_magic == EXT2_SUPER_MAGIC) &&
361 (sb->s_feature_incompat & EXT3_FEATURE_INCOMPAT_JOURNAL_DEV)) {
362 blocksize = EXT2_BLOCK_SIZE(sb);
363 blocknr = (blocksize == 1024) ? 2 : 1;
364 uuid_unparse(sb->s_uuid, jsb_buffer);
365 fprintf(out_file, "Ext2 superblock header found.\n");
367 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
368 fprintf(out_file, "\tblocksize=%d\n", blocksize);
369 fprintf(out_file, "\tjournal data size %ld\n",
370 (long) sb->s_blocks_count);
374 /* Next, read the journal superblock */
376 retval = read_journal_block(cmdname, source, blocknr*blocksize,
377 jsb_buffer, 1024, &got);
381 jsb = (journal_superblock_t *) jsb_buffer;
382 if (be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) {
384 "Journal superblock magic number invalid!\n");
387 blocksize = be32_to_cpu(jsb->s_blocksize);
388 transaction = be32_to_cpu(jsb->s_sequence);
389 blocknr = be32_to_cpu(jsb->s_start);
391 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
392 blocknr, transaction);
395 /* Empty journal, nothing to do. */
399 retval = read_journal_block(cmdname, source,
400 blocknr*blocksize, buf,
402 if (retval || got != blocksize)
405 header = (journal_header_t *) buf;
407 magic = be32_to_cpu(header->h_magic);
408 sequence = be32_to_cpu(header->h_sequence);
409 blocktype = be32_to_cpu(header->h_blocktype);
411 if (magic != JFS_MAGIC_NUMBER) {
412 fprintf (out_file, "No magic number at block %u: "
413 "end of journal.\n", blocknr);
417 if (sequence != transaction) {
418 fprintf (out_file, "Found sequence %u (not %u) at "
419 "block %u: end of journal.\n",
420 sequence, transaction, blocknr);
424 if (dump_descriptors) {
425 fprintf (out_file, "Found expected sequence %u, "
426 "type %u (%s) at block %u\n",
428 type_to_name(blocktype), blocknr);
432 case JFS_DESCRIPTOR_BLOCK:
433 dump_descriptor_block(out_file, source, buf, jsb,
438 case JFS_COMMIT_BLOCK:
444 case JFS_REVOKE_BLOCK:
445 dump_revoke_block(out_file, buf, jsb,
453 fprintf (out_file, "Unexpected block type %u at "
454 "block %u.\n", blocktype, blocknr);
461 static void dump_descriptor_block(FILE *out_file,
462 struct journal_source *source,
464 journal_superblock_t *jsb,
465 unsigned int *blockp, int blocksize,
470 journal_block_tag_t *tag;
471 unsigned int blocknr;
476 offset = sizeof(journal_header_t);
480 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
481 "block %u:\n", transaction, blocknr);
487 /* Work out the location of the current tag, and skip to
490 tag = (journal_block_tag_t *) tagp;
491 offset += sizeof(journal_block_tag_t);
493 /* ... and if we have gone too far, then we've reached the
494 end of this block. */
495 if (offset > blocksize)
498 tag_block = be32_to_cpu(tag->t_blocknr);
499 tag_flags = be32_to_cpu(tag->t_flags);
501 if (!(tag_flags & JFS_FLAG_SAME_UUID))
504 dump_metadata_block(out_file, source, jsb,
505 blocknr, tag_block, blocksize,
511 } while (!(tag_flags & JFS_FLAG_LAST_TAG));
517 static void dump_revoke_block(FILE *out_file, char *buf,
518 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
519 unsigned int blocknr,
520 int blocksize EXT2FS_ATTR((unused)),
524 journal_revoke_header_t *header;
525 unsigned int *entry, rblock;
528 fprintf(out_file, "Dumping revoke block, sequence %u, at "
529 "block %u:\n", transaction, blocknr);
531 header = (journal_revoke_header_t *) buf;
532 offset = sizeof(journal_revoke_header_t);
533 max = be32_to_cpu(header->r_count);
535 while (offset < max) {
536 entry = (unsigned int *) (buf + offset);
537 rblock = be32_to_cpu(*entry);
538 if (dump_all || rblock == block_to_dump) {
539 fprintf(out_file, " Revoke FS block %u", rblock);
541 fprintf(out_file, "\n");
543 fprintf(out_file," at block %u, sequence %u\n",
544 blocknr, transaction);
551 static void show_extent(FILE *out_file, int start_extent, int end_extent,
554 if (start_extent >= 0 && first_block != 0)
555 fprintf(out_file, "(%d+%u): %u ",
556 start_extent, end_extent-start_extent, first_block);
559 static void show_indirect(FILE *out_file, const char *name, __u32 where)
562 fprintf(out_file, "(%s): %u ", name, where);
566 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
567 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
568 unsigned int log_blocknr,
569 unsigned int fs_blocknr,
578 || (fs_blocknr == block_to_dump)
579 || (fs_blocknr == inode_block_to_dump)
580 || (fs_blocknr == bitmap_to_dump)))
583 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
585 fprintf(out_file, "sequence %u, ", transaction);
586 fprintf(out_file, "journal block %u\n", log_blocknr);
588 /* There are two major special cases to parse:
590 * If this block is a block
591 * bitmap block, we need to give it special treatment so that we
592 * can log any allocates and deallocates which affect the
593 * block_to_dump query block.
595 * If the block is an inode block for the inode being searched
596 * for, then we need to dump the contents of that inode
597 * structure symbolically.
600 if (!(dump_contents && dump_all)
601 && fs_blocknr != block_to_dump
602 && fs_blocknr != bitmap_to_dump
603 && fs_blocknr != inode_block_to_dump)
606 retval = read_journal_block("logdump", source,
607 blocksize * log_blocknr,
608 buf, blocksize, &got);
612 if (fs_blocknr == bitmap_to_dump) {
613 struct ext2_super_block *super;
616 super = current_fs->super;
617 offset = ((fs_blocknr - super->s_first_data_block) %
618 super->s_blocks_per_group);
620 fprintf(out_file, " (block bitmap for block %u: "
623 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
626 if (fs_blocknr == inode_block_to_dump) {
627 struct ext2_inode *inode;
628 int first, prev, this, start_extent, i;
630 fprintf(out_file, " (inode block for inode %u):\n",
633 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
634 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
636 /* Dump out the direct/indirect blocks here:
637 * internal_dump_inode can only dump them from the main
638 * on-disk inode, not from the journaled copy of the
641 fprintf (out_file, " Blocks: ");
642 first = prev = start_extent = -1;
644 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
645 this = inode->i_block[i];
646 if (start_extent >= 0 && this == prev+1) {
650 show_extent(out_file, start_extent, i, first);
655 show_extent(out_file, start_extent, i, first);
656 show_indirect(out_file, "IND", inode->i_block[i++]);
657 show_indirect(out_file, "DIND", inode->i_block[i++]);
658 show_indirect(out_file, "TIND", inode->i_block[i++]);
660 fprintf(out_file, "\n");
664 do_hexdump(out_file, buf, blocksize);
668 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
676 charp = (char *) buf;
678 for (i=0; i<blocksize; i+=16) {
679 fprintf(out_file, " %04x: ", i);
680 for (j=0; j<16; j+=4)
681 fprintf(out_file, "%08x ", *intp++);
682 for (j=0; j<16; j++) {
684 if (c < ' ' || c >= 127)
686 fprintf(out_file, "%c", c);
688 fprintf(out_file, "\n");