2 * logdump.c --- dump the contents of the journal out to a file
4 * Author: 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
22 #include <sys/types.h>
34 #include "blkid/blkid.h"
36 #include "ext2fs/fast_commit.h"
37 #include <uuid/uuid.h>
39 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
41 #define ANY_BLOCK ((blk64_t) -1)
43 static int dump_all, dump_super, dump_old, dump_contents, dump_descriptors;
44 static blk64_t block_to_dump, bitmap_to_dump, inode_block_to_dump;
45 static unsigned int group_to_dump, inode_offset_to_dump;
46 static ext2_ino_t inode_to_dump;
50 enum journal_location where;
55 static void dump_journal(char *, FILE *, struct journal_source *);
57 static void dump_descriptor_block(FILE *, struct journal_source *,
58 char *, journal_superblock_t *,
59 unsigned int *, int, __u32, tid_t);
61 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
62 unsigned int, int, tid_t);
64 static void dump_metadata_block(FILE *, struct journal_source *,
65 journal_superblock_t*,
66 unsigned int, unsigned int, unsigned int,
69 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
70 int transaction, int *fc_done, int dump_old);
72 static void do_hexdump (FILE *, char *, int);
74 #define WRAP(jsb, blocknr, maxlen) \
75 if (blocknr >= (maxlen)) \
76 blocknr -= (maxlen - be32_to_cpu((jsb)->s_first));
78 void do_logdump(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
79 void *infop EXT2FS_ATTR((unused)))
86 char *inode_spec = NULL;
87 char *journal_fn = NULL;
90 ext2_ino_t journal_inum;
91 struct ext2_inode journal_inode;
92 ext2_file_t journal_file = NULL;
94 struct journal_source journal_source;
95 struct ext2_super_block *es = NULL;
97 journal_source.where = JOURNAL_IS_INTERNAL;
98 journal_source.fd = 0;
99 journal_source.file = 0;
104 dump_descriptors = 1;
105 block_to_dump = ANY_BLOCK;
107 inode_block_to_dump = ANY_BLOCK;
111 while ((c = getopt (argc, argv, "ab:ci:f:OsS")) != EOF) {
117 block_to_dump = strtoul(optarg, &tmp, 0);
120 "Bad block number - %s", optarg);
123 dump_descriptors = 0;
133 dump_descriptors = 0;
148 if (optind != argc && optind != argc-1) {
153 int inode_group, group_offset, inodes_per_block;
155 if (check_fs_open(argv[0]))
158 inode_to_dump = string_to_inode(inode_spec);
162 es = current_fs->super;
163 inode_group = ((inode_to_dump - 1)
164 / es->s_inodes_per_group);
165 group_offset = ((inode_to_dump - 1)
166 % es->s_inodes_per_group);
167 inodes_per_block = (current_fs->blocksize
168 / sizeof(struct ext2_inode));
170 inode_block_to_dump =
171 ext2fs_inode_table_loc(current_fs, inode_group) +
172 (group_offset / inodes_per_block);
173 inode_offset_to_dump = ((group_offset % inodes_per_block)
174 * sizeof(struct ext2_inode));
175 printf("Inode %u is at group %u, block %llu, offset %u\n",
176 inode_to_dump, inode_group,
177 (unsigned long long) inode_block_to_dump,
178 inode_offset_to_dump);
181 if (optind == argc) {
184 out_fn = argv[optind];
185 out_file = fopen(out_fn, "w");
187 com_err(argv[0], errno, "while opening %s for logdump",
193 if (block_to_dump != ANY_BLOCK) {
194 if (check_fs_open(argv[0]))
196 es = current_fs->super;
197 group_to_dump = ((block_to_dump -
198 es->s_first_data_block)
199 / es->s_blocks_per_group);
200 bitmap_to_dump = ext2fs_block_bitmap_loc(current_fs, group_to_dump);
204 /* Set up to read journal from a regular file somewhere */
205 journal_fd = open(journal_fn, O_RDONLY, 0);
206 if (journal_fd < 0) {
207 com_err(argv[0], errno, "while opening %s for logdump",
211 journal_source.where = JOURNAL_IS_EXTERNAL;
212 journal_source.fd = journal_fd;
213 dump_journal(argv[0], out_file, &journal_source);
217 if (check_fs_open(argv[0]))
219 es = current_fs->super;
221 if ((journal_inum = es->s_journal_inum)) {
223 if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
225 "no journal backup in super block\n");
228 memset(&journal_inode, 0, sizeof(struct ext2_inode));
229 memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
231 journal_inode.i_size_high = es->s_jnl_blocks[15];
232 journal_inode.i_size = es->s_jnl_blocks[16];
233 journal_inode.i_links_count = 1;
234 journal_inode.i_mode = LINUX_S_IFREG | 0600;
236 if (debugfs_read_inode(journal_inum, &journal_inode,
241 retval = ext2fs_file_open2(current_fs, journal_inum,
242 &journal_inode, 0, &journal_file);
244 com_err(argv[0], retval, "while opening ext2 file");
247 journal_source.where = JOURNAL_IS_INTERNAL;
248 journal_source.file = journal_file;
252 uuid_unparse(es->s_journal_uuid, uuid);
253 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
255 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
257 com_err(argv[0], 0, "filesystem has no journal");
260 journal_fd = open(journal_fn, O_RDONLY, 0);
261 if (journal_fd < 0) {
262 com_err(argv[0], errno, "while opening %s for logdump",
267 fprintf(out_file, "Using external journal found at %s\n",
270 journal_source.where = JOURNAL_IS_EXTERNAL;
271 journal_source.fd = journal_fd;
273 dump_journal(argv[0], out_file, &journal_source);
278 ext2fs_file_close(journal_file);
279 if (out_file && (out_file != stdout))
285 fprintf(stderr, "%s: Usage: logdump [-acsOS] [-b<block>] [-i<filespec>]\n\t"
286 "[-f<journal_file>] [output_file]\n", argv[0]);
290 static int read_journal_block(const char *cmd, struct journal_source *source,
291 ext2_loff_t offset, char *buf, unsigned int size)
296 if (source->where == JOURNAL_IS_EXTERNAL) {
297 if (lseek(source->fd, offset, SEEK_SET) < 0) {
301 retval = read(source->fd, buf, size);
309 retval = ext2fs_file_llseek(source->file, offset,
310 EXT2_SEEK_SET, NULL);
313 com_err(cmd, retval, "while seeking in reading journal");
316 retval = ext2fs_file_read(source->file, buf, size, &got);
319 com_err(cmd, retval, "while reading journal");
324 com_err(cmd, 0, "short read (read %u, expected %u) "
325 "while reading journal", got, size);
331 static const char *type_to_name(int btype)
334 case JBD2_DESCRIPTOR_BLOCK:
335 return "descriptor block";
336 case JBD2_COMMIT_BLOCK:
337 return "commit block";
338 case JBD2_SUPERBLOCK_V1:
339 return "V1 superblock";
340 case JBD2_SUPERBLOCK_V2:
341 return "V2 superblock";
342 case JBD2_REVOKE_BLOCK:
343 return "revoke table";
345 return "unrecognised type";
349 static void dump_journal(char *cmdname, FILE *out_file,
350 struct journal_source *source)
352 struct ext2_super_block *sb;
353 char jsb_buffer[1024];
354 char buf[EXT2_MAX_BLOCK_SIZE];
355 journal_superblock_t *jsb;
356 unsigned int blocksize = 1024;
358 __u32 magic, sequence, blocktype;
359 journal_header_t *header;
361 unsigned int blocknr = 0;
366 /* First, check to see if there's an ext2 superblock header */
367 retval = read_journal_block(cmdname, source, 0, buf, 2048);
371 jsb = (journal_superblock_t *) buf;
372 sb = (struct ext2_super_block *) (buf+1024);
373 #ifdef WORDS_BIGENDIAN
374 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
375 ext2fs_swap_super(sb);
378 if ((be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) &&
379 (sb->s_magic == EXT2_SUPER_MAGIC) &&
380 ext2fs_has_feature_journal_dev(sb)) {
381 blocksize = EXT2_BLOCK_SIZE(sb);
382 blocknr = (blocksize == 1024) ? 2 : 1;
383 uuid_unparse(sb->s_uuid, jsb_buffer);
384 fprintf(out_file, "Ext2 superblock header found.\n");
386 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
387 fprintf(out_file, "\tblocksize=%d\n", blocksize);
388 fprintf(out_file, "\tjournal data size %lu\n",
389 (unsigned long) ext2fs_blocks_count(sb));
393 /* Next, read the journal superblock */
394 retval = read_journal_block(cmdname, source,
395 ((ext2_loff_t) blocknr) * blocksize,
401 e2p_list_journal_super(out_file, jsb_buffer,
402 current_fs->blocksize, 0);
403 fputc('\n', out_file);
406 jsb = (journal_superblock_t *) jsb_buffer;
407 if (be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) {
409 "Journal superblock magic number invalid!\n");
412 blocksize = be32_to_cpu(jsb->s_blocksize);
413 if ((current_fs && (blocksize != current_fs->blocksize)) ||
414 (!current_fs && (!blocksize || (blocksize & (blocksize - 1)) ||
415 (blocksize > EXT2_MAX_BLOCK_SIZE)))) {
417 "Journal block size invalid: %u (%u)\n",
418 be32_to_cpu(jsb->s_blocksize), blocksize);
421 transaction = be32_to_cpu(jsb->s_sequence);
422 blocknr = be32_to_cpu(jsb->s_start);
423 if (source->where == JOURNAL_IS_INTERNAL) {
424 retval = ext2fs_file_get_lsize(source->file, &total_len);
427 com_err("dump_journal", retval,
428 "while getting journal inode size");
431 total_len /= blocksize;
435 if (fstat(source->fd, &st) < 0)
437 total_len = st.st_size / blocksize;
439 maxlen = be32_to_cpu(jsb->s_maxlen);
440 if (maxlen > total_len)
443 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
444 blocknr, transaction);
447 /* Empty journal, nothing to do. */
455 retval = read_journal_block(cmdname, source,
456 ((ext2_loff_t) blocknr) * blocksize,
461 header = (journal_header_t *) buf;
463 magic = be32_to_cpu(header->h_magic);
464 sequence = be32_to_cpu(header->h_sequence);
465 blocktype = be32_to_cpu(header->h_blocktype);
467 if (magic != JBD2_MAGIC_NUMBER) {
468 fprintf (out_file, "No magic number at block %u: "
469 "end of journal.\n", blocknr);
473 if (sequence != transaction) {
474 fprintf (out_file, "Found sequence %u (not %u) at "
475 "block %u: end of journal.\n",
476 sequence, transaction, blocknr);
481 if (dump_descriptors) {
482 fprintf (out_file, "Found expected sequence %u, "
483 "type %u (%s) at block %u\n",
485 type_to_name(blocktype), blocknr);
489 case JBD2_DESCRIPTOR_BLOCK:
490 dump_descriptor_block(out_file, source, buf, jsb,
491 &blocknr, blocksize, maxlen,
495 case JBD2_COMMIT_BLOCK:
498 WRAP(jsb, blocknr, maxlen);
501 case JBD2_REVOKE_BLOCK:
502 dump_revoke_block(out_file, buf, jsb,
506 WRAP(jsb, blocknr, maxlen);
510 fprintf (out_file, "Unexpected block type %u at "
511 "block %u.\n", blocktype, blocknr);
517 blocknr = maxlen - jbd2_journal_get_num_fc_blks(jsb) + 1;
518 while (blocknr <= maxlen) {
519 retval = read_journal_block(cmdname, source,
520 ((ext2_loff_t) blocknr) * blocksize,
525 dump_fc_block(out_file, buf, blocksize, transaction, &fc_done,
527 if (!dump_old && fc_done)
533 static inline size_t journal_super_tag_bytes(journal_superblock_t *jsb)
537 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3))
538 return sizeof(journal_block_tag3_t);
540 sz = sizeof(journal_block_tag_t);
542 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
545 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_64BIT))
548 return sz - sizeof(__u32);
551 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
552 int transaction, int *fc_done, int dump_old)
554 struct ext4_fc_tl tl;
555 struct ext4_fc_head *head;
556 struct ext4_fc_add_range *add_range;
557 struct ext4_fc_del_range *del_range;
558 struct ext4_fc_dentry_info *dentry_info;
559 struct ext4_fc_tail *tail;
560 struct ext3_extent *ex;
564 for (cur = (__u8 *)buf; cur < (__u8 *)buf + blocksize;
565 cur = cur + sizeof(tl) + le16_to_cpu(tl.fc_len)) {
566 memcpy(&tl, cur, sizeof(tl));
567 val = cur + sizeof(tl);
569 switch (le16_to_cpu(tl.fc_tag)) {
570 case EXT4_FC_TAG_ADD_RANGE:
571 add_range = (struct ext4_fc_add_range *)val;
572 ex = (struct ext3_extent *)add_range->fc_ex;
574 "tag %s, inode %d, lblk %u, pblk %llu, len %lu\n",
576 le32_to_cpu(add_range->fc_ino),
577 le32_to_cpu(ex->ee_block),
578 le32_to_cpu(ex->ee_start) +
579 (((unsigned long long) le16_to_cpu(ex->ee_start_hi)) << 32),
580 le16_to_cpu(ex->ee_len) > EXT_INIT_MAX_LEN ?
581 le16_to_cpu(ex->ee_len) - EXT_INIT_MAX_LEN :
582 le16_to_cpu(ex->ee_len));
584 case EXT4_FC_TAG_DEL_RANGE:
585 del_range = (struct ext4_fc_del_range *)val;
586 fprintf(out_file, "tag %s, inode %d, lblk %d, len %d\n",
588 le32_to_cpu(del_range->fc_ino),
589 le32_to_cpu(del_range->fc_lblk),
590 le32_to_cpu(del_range->fc_len));
592 case EXT4_FC_TAG_LINK:
593 case EXT4_FC_TAG_UNLINK:
594 case EXT4_FC_TAG_CREAT:
595 dentry_info = (struct ext4_fc_dentry_info *)val;
597 "tag %s, parent %d, ino %d, name \"%s\"\n",
599 le32_to_cpu(dentry_info->fc_parent_ino),
600 le32_to_cpu(dentry_info->fc_ino),
601 dentry_info->fc_dname);
603 case EXT4_FC_TAG_INODE:
604 fprintf(out_file, "tag %s, inode %d\n",
606 le32_to_cpu(((struct ext4_fc_inode *)val)->fc_ino));
608 case EXT4_FC_TAG_PAD:
609 fprintf(out_file, "tag %s\n", tag2str(tl.fc_tag));
611 case EXT4_FC_TAG_TAIL:
612 tail = (struct ext4_fc_tail *)val;
613 fprintf(out_file, "tag %s, tid %d\n",
615 le32_to_cpu(tail->fc_tid));
617 le32_to_cpu(tail->fc_tid) < transaction) {
622 case EXT4_FC_TAG_HEAD:
623 fprintf(out_file, "\n*** Fast Commit Area ***\n");
624 head = (struct ext4_fc_head *)val;
625 fprintf(out_file, "tag %s, features 0x%x, tid %d\n",
627 le32_to_cpu(head->fc_features),
628 le32_to_cpu(head->fc_tid));
630 le32_to_cpu(head->fc_tid) < transaction) {
642 static void dump_descriptor_block(FILE *out_file,
643 struct journal_source *source,
645 journal_superblock_t *jsb,
646 unsigned int *blockp, int blocksize,
650 int offset, tag_size, csum_size = 0;
652 journal_block_tag_t *tag;
653 unsigned int blocknr;
657 tag_size = journal_super_tag_bytes(jsb);
658 offset = sizeof(journal_header_t);
661 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3) ||
662 JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
663 csum_size = sizeof(struct jbd2_journal_block_tail);
666 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
667 "block %u:\n", transaction, blocknr);
670 WRAP(jsb, blocknr, maxlen);
673 /* Work out the location of the current tag, and skip to
676 tag = (journal_block_tag_t *) tagp;
679 /* ... and if we have gone too far, then we've reached the
680 end of this block. */
681 if (offset > blocksize - csum_size)
684 tag_block = be32_to_cpu(tag->t_blocknr);
685 tag_flags = be16_to_cpu(tag->t_flags);
687 if (!(tag_flags & JBD2_FLAG_SAME_UUID))
690 dump_metadata_block(out_file, source, jsb,
691 blocknr, tag_block, tag_flags, blocksize,
695 WRAP(jsb, blocknr, maxlen);
697 } while (!(tag_flags & JBD2_FLAG_LAST_TAG));
703 static void dump_revoke_block(FILE *out_file, char *buf,
704 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
705 unsigned int blocknr,
706 int blocksize EXT2FS_ATTR((unused)),
710 jbd2_journal_revoke_header_t *header;
711 unsigned long long rblock;
712 int tag_size = sizeof(__u32);
715 fprintf(out_file, "Dumping revoke block, sequence %u, at "
716 "block %u:\n", transaction, blocknr);
718 if (be32_to_cpu(jsb->s_feature_incompat) & JBD2_FEATURE_INCOMPAT_64BIT)
719 tag_size = sizeof(__u64);
721 header = (jbd2_journal_revoke_header_t *) buf;
722 offset = sizeof(jbd2_journal_revoke_header_t);
723 max = be32_to_cpu(header->r_count);
724 if (max > jsb->s_blocksize) {
725 fprintf(out_file, "Revoke block's r_count invalid: %u\b",
727 max = jsb->s_blocksize;
730 while (offset < max) {
731 if (tag_size == sizeof(__u32)) {
732 __u32 *entry = (__u32 *) (buf + offset);
733 rblock = be32_to_cpu(*entry);
735 __u64 *entry = (__u64 *) (buf + offset);
736 rblock = ext2fs_be64_to_cpu(*entry);
738 if (dump_all || rblock == block_to_dump) {
739 fprintf(out_file, " Revoke FS block %llu",
740 (unsigned long long) rblock);
742 fprintf(out_file, "\n");
744 fprintf(out_file," at block %u, sequence %u\n",
745 blocknr, transaction);
752 static void show_extent(FILE *out_file, int start_extent, int end_extent,
755 if (start_extent >= 0 && first_block != 0)
756 fprintf(out_file, "(%d+%u): %u ",
757 start_extent, end_extent-start_extent, first_block);
760 static void show_indirect(FILE *out_file, const char *name, __u32 where)
763 fprintf(out_file, "(%s): %u ", name, where);
767 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
768 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
769 unsigned int log_blocknr,
770 unsigned int fs_blocknr,
771 unsigned int log_tag_flags,
776 char buf[EXT2_MAX_BLOCK_SIZE];
779 || (fs_blocknr == block_to_dump)
780 || (fs_blocknr == inode_block_to_dump)
781 || (fs_blocknr == bitmap_to_dump)))
784 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
786 fprintf(out_file, "sequence %u, ", transaction);
787 fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
790 /* There are two major special cases to parse:
792 * If this block is a block
793 * bitmap block, we need to give it special treatment so that we
794 * can log any allocates and deallocates which affect the
795 * block_to_dump query block.
797 * If the block is an inode block for the inode being searched
798 * for, then we need to dump the contents of that inode
799 * structure symbolically.
802 if (!(dump_contents && dump_all)
803 && fs_blocknr != block_to_dump
804 && fs_blocknr != bitmap_to_dump
805 && fs_blocknr != inode_block_to_dump)
808 retval = read_journal_block("logdump", source,
809 ((ext2_loff_t) log_blocknr) * blocksize,
814 if (fs_blocknr == bitmap_to_dump) {
815 struct ext2_super_block *super;
818 super = current_fs->super;
819 offset = ((block_to_dump - super->s_first_data_block) %
820 super->s_blocks_per_group);
822 fprintf(out_file, " (block bitmap for block %llu: "
824 (unsigned long long) block_to_dump,
825 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
828 if (fs_blocknr == inode_block_to_dump) {
829 struct ext2_inode *inode;
830 int first, prev, this, start_extent, i;
832 fprintf(out_file, " (inode block for inode %u):\n",
835 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
836 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
838 /* Dump out the direct/indirect blocks here:
839 * internal_dump_inode can only dump them from the main
840 * on-disk inode, not from the journaled copy of the
843 fprintf (out_file, " Blocks: ");
844 first = prev = start_extent = -1;
846 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
847 this = inode->i_block[i];
848 if (start_extent >= 0 && this == prev+1) {
852 show_extent(out_file, start_extent, i, first);
857 show_extent(out_file, start_extent, i, first);
858 show_indirect(out_file, "IND", inode->i_block[i++]);
859 show_indirect(out_file, "DIND", inode->i_block[i++]);
860 show_indirect(out_file, "TIND", inode->i_block[i++]);
862 fprintf(out_file, "\n");
866 do_hexdump(out_file, buf, blocksize);
870 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
878 charp = (char *) buf;
880 for (i=0; i<blocksize; i+=16) {
881 fprintf(out_file, " %04x: ", i);
882 for (j=0; j<16; j+=4)
883 fprintf(out_file, "%08x ", *intp++);
884 for (j=0; j<16; j++) {
886 if (c < ' ' || c >= 127)
888 fprintf(out_file, "%c", c);
890 fprintf(out_file, "\n");