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 #if __GNUC_PREREQ (4, 6)
37 #pragma GCC diagnostic push
38 #pragma GCC diagnostic ignored "-Wunused-function"
40 #include "ext2fs/fast_commit.h"
41 #if __GNUC_PREREQ (4, 6)
42 #pragma GCC diagnostic pop
44 #include <uuid/uuid.h>
46 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
48 #define ANY_BLOCK ((blk64_t) -1)
50 static int dump_all, dump_super, dump_old, dump_contents, dump_descriptors;
51 static blk64_t block_to_dump, bitmap_to_dump, inode_block_to_dump;
52 static unsigned int group_to_dump, inode_offset_to_dump;
53 static ext2_ino_t inode_to_dump;
57 enum journal_location where;
62 static void dump_journal(char *, FILE *, struct journal_source *);
64 static void dump_descriptor_block(FILE *, struct journal_source *,
65 char *, journal_superblock_t *,
66 unsigned int *, unsigned int, __u32, tid_t);
68 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
69 unsigned int, unsigned int, tid_t);
71 static void dump_metadata_block(FILE *, struct journal_source *,
72 journal_superblock_t*,
73 unsigned int, unsigned int, unsigned int,
76 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
77 tid_t transaction, int *fc_done);
79 static void do_hexdump (FILE *, char *, int);
81 #define WRAP(jsb, blocknr, maxlen) \
82 if (blocknr >= (maxlen)) \
83 blocknr -= (maxlen - be32_to_cpu((jsb)->s_first));
85 void do_logdump(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
86 void *infop EXT2FS_ATTR((unused)))
93 char *inode_spec = NULL;
94 char *journal_fn = NULL;
97 ext2_ino_t journal_inum;
98 struct ext2_inode journal_inode;
99 ext2_file_t journal_file = NULL;
101 struct journal_source journal_source;
102 struct ext2_super_block *es = NULL;
104 journal_source.where = JOURNAL_IS_INTERNAL;
105 journal_source.fd = 0;
106 journal_source.file = 0;
111 dump_descriptors = 1;
112 block_to_dump = ANY_BLOCK;
114 inode_block_to_dump = ANY_BLOCK;
118 while ((c = getopt (argc, argv, "ab:ci:f:OsS")) != EOF) {
124 block_to_dump = strtoul(optarg, &tmp, 0);
127 "Bad block number - %s", optarg);
130 dump_descriptors = 0;
140 dump_descriptors = 0;
155 if (optind != argc && optind != argc-1) {
160 int inode_group, group_offset, inodes_per_block;
162 if (check_fs_open(argv[0]))
165 inode_to_dump = string_to_inode(inode_spec);
169 es = current_fs->super;
170 inode_group = ((inode_to_dump - 1)
171 / es->s_inodes_per_group);
172 group_offset = ((inode_to_dump - 1)
173 % es->s_inodes_per_group);
174 inodes_per_block = (current_fs->blocksize
175 / sizeof(struct ext2_inode));
177 inode_block_to_dump =
178 ext2fs_inode_table_loc(current_fs, inode_group) +
179 (group_offset / inodes_per_block);
180 inode_offset_to_dump = ((group_offset % inodes_per_block)
181 * sizeof(struct ext2_inode));
182 printf("Inode %u is at group %u, block %llu, offset %u\n",
183 inode_to_dump, inode_group,
184 (unsigned long long) inode_block_to_dump,
185 inode_offset_to_dump);
188 if (optind == argc) {
191 out_fn = argv[optind];
192 out_file = fopen(out_fn, "w");
194 com_err(argv[0], errno, "while opening %s for logdump",
200 if (block_to_dump != ANY_BLOCK) {
201 if (check_fs_open(argv[0]))
203 es = current_fs->super;
204 group_to_dump = ((block_to_dump -
205 es->s_first_data_block)
206 / es->s_blocks_per_group);
207 bitmap_to_dump = ext2fs_block_bitmap_loc(current_fs, group_to_dump);
211 /* Set up to read journal from a regular file somewhere */
212 journal_fd = open(journal_fn, O_RDONLY, 0);
213 if (journal_fd < 0) {
214 com_err(argv[0], errno, "while opening %s for logdump",
218 journal_source.where = JOURNAL_IS_EXTERNAL;
219 journal_source.fd = journal_fd;
220 dump_journal(argv[0], out_file, &journal_source);
224 if (check_fs_open(argv[0]))
226 es = current_fs->super;
228 if ((journal_inum = es->s_journal_inum)) {
230 if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
232 "no journal backup in super block\n");
235 memset(&journal_inode, 0, sizeof(struct ext2_inode));
236 memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
238 journal_inode.i_size_high = es->s_jnl_blocks[15];
239 journal_inode.i_size = es->s_jnl_blocks[16];
240 journal_inode.i_links_count = 1;
241 journal_inode.i_mode = LINUX_S_IFREG | 0600;
243 if (debugfs_read_inode(journal_inum, &journal_inode,
248 retval = ext2fs_file_open2(current_fs, journal_inum,
249 &journal_inode, 0, &journal_file);
251 com_err(argv[0], retval, "while opening ext2 file");
254 journal_source.where = JOURNAL_IS_INTERNAL;
255 journal_source.file = journal_file;
259 uuid_unparse(es->s_journal_uuid, uuid);
260 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
262 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
264 com_err(argv[0], 0, "filesystem has no journal");
267 journal_fd = open(journal_fn, O_RDONLY, 0);
268 if (journal_fd < 0) {
269 com_err(argv[0], errno, "while opening %s for logdump",
274 fprintf(out_file, "Using external journal found at %s\n",
277 journal_source.where = JOURNAL_IS_EXTERNAL;
278 journal_source.fd = journal_fd;
280 dump_journal(argv[0], out_file, &journal_source);
285 ext2fs_file_close(journal_file);
286 if (out_file && (out_file != stdout))
292 fprintf(stderr, "%s: Usage: logdump [-acsOS] [-b<block>] [-i<filespec>]\n\t"
293 "[-f<journal_file>] [output_file]\n", argv[0]);
297 static int read_journal_block(const char *cmd, struct journal_source *source,
298 ext2_loff_t offset, char *buf, unsigned int size)
303 if (source->where == JOURNAL_IS_EXTERNAL) {
304 if (lseek(source->fd, offset, SEEK_SET) < 0) {
308 retval = read(source->fd, buf, size);
316 retval = ext2fs_file_llseek(source->file, offset,
317 EXT2_SEEK_SET, NULL);
320 com_err(cmd, retval, "while seeking in reading journal");
323 retval = ext2fs_file_read(source->file, buf, size, &got);
326 com_err(cmd, retval, "while reading journal");
331 com_err(cmd, 0, "short read (read %u, expected %u) "
332 "while reading journal", got, size);
338 static const char *type_to_name(int btype)
341 case JBD2_DESCRIPTOR_BLOCK:
342 return "descriptor block";
343 case JBD2_COMMIT_BLOCK:
344 return "commit block";
345 case JBD2_SUPERBLOCK_V1:
346 return "V1 superblock";
347 case JBD2_SUPERBLOCK_V2:
348 return "V2 superblock";
349 case JBD2_REVOKE_BLOCK:
350 return "revoke table";
352 return "unrecognised type";
356 static void dump_journal(char *cmdname, FILE *out_file,
357 struct journal_source *source)
359 struct ext2_super_block *sb;
360 char jsb_buffer[1024];
361 char buf[EXT2_MAX_BLOCK_SIZE];
362 journal_superblock_t *jsb;
363 unsigned int blocksize = 1024;
365 __u32 magic, sequence, blocktype;
366 journal_header_t *header;
368 unsigned int blocknr = 0;
373 /* First, check to see if there's an ext2 superblock header */
374 retval = read_journal_block(cmdname, source, 0, buf, 2048);
378 jsb = (journal_superblock_t *) buf;
379 sb = (struct ext2_super_block *) (buf+1024);
380 #ifdef WORDS_BIGENDIAN
381 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
382 ext2fs_swap_super(sb);
385 if ((be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) &&
386 (sb->s_magic == EXT2_SUPER_MAGIC) &&
387 ext2fs_has_feature_journal_dev(sb)) {
388 blocksize = EXT2_BLOCK_SIZE(sb);
389 blocknr = (blocksize == 1024) ? 2 : 1;
390 uuid_unparse(sb->s_uuid, jsb_buffer);
391 fprintf(out_file, "Ext2 superblock header found.\n");
393 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
394 fprintf(out_file, "\tblocksize=%d\n", blocksize);
395 fprintf(out_file, "\tjournal data size %lu\n",
396 (unsigned long) ext2fs_blocks_count(sb));
400 /* Next, read the journal superblock */
401 retval = read_journal_block(cmdname, source,
402 ((ext2_loff_t) blocknr) * blocksize,
408 e2p_list_journal_super(out_file, jsb_buffer,
409 current_fs->blocksize, 0);
410 fputc('\n', out_file);
413 jsb = (journal_superblock_t *) jsb_buffer;
414 if (be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) {
416 "Journal superblock magic number invalid!\n");
419 blocksize = be32_to_cpu(jsb->s_blocksize);
420 if ((current_fs && (blocksize != current_fs->blocksize)) ||
421 (!current_fs && (!blocksize || (blocksize & (blocksize - 1)) ||
422 (blocksize > EXT2_MAX_BLOCK_SIZE)))) {
424 "Journal block size invalid: %u (%u)\n",
425 be32_to_cpu(jsb->s_blocksize), blocksize);
428 transaction = be32_to_cpu(jsb->s_sequence);
429 blocknr = be32_to_cpu(jsb->s_start);
430 if (source->where == JOURNAL_IS_INTERNAL) {
431 retval = ext2fs_file_get_lsize(source->file, &total_len);
434 com_err("dump_journal", retval,
435 "while getting journal inode size");
438 total_len /= blocksize;
442 if (fstat(source->fd, &st) < 0)
444 total_len = st.st_size / blocksize;
446 maxlen = be32_to_cpu(jsb->s_maxlen);
447 if (maxlen > total_len)
450 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
451 blocknr, transaction);
454 /* Empty journal, nothing to do. */
462 retval = read_journal_block(cmdname, source,
463 ((ext2_loff_t) blocknr) * blocksize,
468 header = (journal_header_t *) buf;
470 magic = be32_to_cpu(header->h_magic);
471 sequence = be32_to_cpu(header->h_sequence);
472 blocktype = be32_to_cpu(header->h_blocktype);
474 if (magic != JBD2_MAGIC_NUMBER) {
475 fprintf (out_file, "No magic number at block %u: "
476 "end of journal.\n", blocknr);
480 if (sequence != transaction) {
481 fprintf (out_file, "Found sequence %u (not %u) at "
482 "block %u: end of journal.\n",
483 sequence, transaction, blocknr);
488 if (dump_descriptors) {
489 fprintf (out_file, "Found expected sequence %u, "
490 "type %u (%s) at block %u\n",
492 type_to_name(blocktype), blocknr);
496 case JBD2_DESCRIPTOR_BLOCK:
497 dump_descriptor_block(out_file, source, buf, jsb,
498 &blocknr, blocksize, maxlen,
502 case JBD2_COMMIT_BLOCK:
505 WRAP(jsb, blocknr, maxlen);
508 case JBD2_REVOKE_BLOCK:
509 dump_revoke_block(out_file, buf, jsb,
513 WRAP(jsb, blocknr, maxlen);
517 fprintf (out_file, "Unexpected block type %u at "
518 "block %u.\n", blocktype, blocknr);
524 blocknr = maxlen - jbd2_journal_get_num_fc_blks(jsb) + 1;
525 while (blocknr <= maxlen) {
526 retval = read_journal_block(cmdname, source,
527 ((ext2_loff_t) blocknr) * blocksize,
532 dump_fc_block(out_file, buf, blocksize, transaction, &fc_done);
533 if (!dump_old && fc_done)
539 static inline size_t journal_super_tag_bytes(journal_superblock_t *jsb)
543 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3))
544 return sizeof(journal_block_tag3_t);
546 sz = sizeof(journal_block_tag_t);
548 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
551 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_64BIT))
554 return sz - sizeof(__u32);
557 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
558 tid_t transaction, int *fc_done)
560 struct ext4_fc_tl tl;
561 struct ext4_fc_head *head;
562 struct ext4_fc_add_range *add_range;
563 struct ext4_fc_del_range *del_range;
564 struct ext4_fc_dentry_info *dentry_info;
565 struct ext4_fc_tail *tail;
566 struct ext3_extent *ex;
570 for (cur = (__u8 *)buf; cur < (__u8 *)buf + blocksize;
571 cur = cur + sizeof(tl) + le16_to_cpu(tl.fc_len)) {
572 memcpy(&tl, cur, sizeof(tl));
573 val = cur + sizeof(tl);
575 switch (le16_to_cpu(tl.fc_tag)) {
576 case EXT4_FC_TAG_ADD_RANGE:
577 add_range = (struct ext4_fc_add_range *)val;
578 ex = (struct ext3_extent *)add_range->fc_ex;
580 "tag %s, inode %d, lblk %u, pblk %llu, len %lu\n",
582 le32_to_cpu(add_range->fc_ino),
583 le32_to_cpu(ex->ee_block),
584 le32_to_cpu(ex->ee_start) +
585 (((unsigned long long) le16_to_cpu(ex->ee_start_hi)) << 32),
586 le16_to_cpu(ex->ee_len) > EXT_INIT_MAX_LEN ?
587 le16_to_cpu(ex->ee_len) - EXT_INIT_MAX_LEN :
588 le16_to_cpu(ex->ee_len));
590 case EXT4_FC_TAG_DEL_RANGE:
591 del_range = (struct ext4_fc_del_range *)val;
592 fprintf(out_file, "tag %s, inode %d, lblk %d, len %d\n",
594 le32_to_cpu(del_range->fc_ino),
595 le32_to_cpu(del_range->fc_lblk),
596 le32_to_cpu(del_range->fc_len));
598 case EXT4_FC_TAG_LINK:
599 case EXT4_FC_TAG_UNLINK:
600 case EXT4_FC_TAG_CREAT:
601 dentry_info = (struct ext4_fc_dentry_info *)val;
603 "tag %s, parent %d, ino %d, name \"%s\"\n",
605 le32_to_cpu(dentry_info->fc_parent_ino),
606 le32_to_cpu(dentry_info->fc_ino),
607 dentry_info->fc_dname);
609 case EXT4_FC_TAG_INODE:
610 fprintf(out_file, "tag %s, inode %d\n",
612 le32_to_cpu(((struct ext4_fc_inode *)val)->fc_ino));
614 case EXT4_FC_TAG_PAD:
615 fprintf(out_file, "tag %s\n", tag2str(tl.fc_tag));
617 case EXT4_FC_TAG_TAIL:
618 tail = (struct ext4_fc_tail *)val;
619 fprintf(out_file, "tag %s, tid %d\n",
621 le32_to_cpu(tail->fc_tid));
623 le32_to_cpu(tail->fc_tid) < transaction) {
628 case EXT4_FC_TAG_HEAD:
629 fprintf(out_file, "\n*** Fast Commit Area ***\n");
630 head = (struct ext4_fc_head *)val;
631 fprintf(out_file, "tag %s, features 0x%x, tid %d\n",
633 le32_to_cpu(head->fc_features),
634 le32_to_cpu(head->fc_tid));
636 le32_to_cpu(head->fc_tid) < transaction) {
648 static void dump_descriptor_block(FILE *out_file,
649 struct journal_source *source,
651 journal_superblock_t *jsb,
652 unsigned int *blockp, unsigned blocksize,
656 unsigned offset, tag_size, csum_size = 0;
658 journal_block_tag_t *tag;
659 unsigned int blocknr;
663 tag_size = journal_super_tag_bytes(jsb);
664 offset = sizeof(journal_header_t);
667 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3) ||
668 JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
669 csum_size = sizeof(struct jbd2_journal_block_tail);
672 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
673 "block %u:\n", transaction, blocknr);
676 WRAP(jsb, blocknr, maxlen);
679 /* Work out the location of the current tag, and skip to
682 tag = (journal_block_tag_t *) tagp;
685 /* ... and if we have gone too far, then we've reached the
686 end of this block. */
687 if (offset > blocksize - csum_size)
690 tag_block = be32_to_cpu(tag->t_blocknr);
691 tag_flags = be16_to_cpu(tag->t_flags);
693 if (!(tag_flags & JBD2_FLAG_SAME_UUID))
696 dump_metadata_block(out_file, source, jsb,
697 blocknr, tag_block, tag_flags, blocksize,
701 WRAP(jsb, blocknr, maxlen);
703 } while (!(tag_flags & JBD2_FLAG_LAST_TAG));
709 static void dump_revoke_block(FILE *out_file, char *buf,
710 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
711 unsigned int blocknr,
712 unsigned int blocksize,
715 unsigned int offset, max;
716 jbd2_journal_revoke_header_t *header;
717 unsigned long long rblock;
718 int tag_size = sizeof(__u32);
721 fprintf(out_file, "Dumping revoke block, sequence %u, at "
722 "block %u:\n", transaction, blocknr);
724 if (be32_to_cpu(jsb->s_feature_incompat) & JBD2_FEATURE_INCOMPAT_64BIT)
725 tag_size = sizeof(__u64);
727 header = (jbd2_journal_revoke_header_t *) buf;
728 offset = sizeof(jbd2_journal_revoke_header_t);
729 max = be32_to_cpu(header->r_count);
730 if (max > blocksize) {
731 fprintf(out_file, "Revoke block's r_count invalid: %u\b",
736 while (offset < max) {
737 if (tag_size == sizeof(__u32)) {
738 __u32 *entry = (__u32 *) (buf + offset);
739 rblock = be32_to_cpu(*entry);
741 __u64 *entry = (__u64 *) (buf + offset);
742 rblock = ext2fs_be64_to_cpu(*entry);
744 if (dump_all || rblock == block_to_dump) {
745 fprintf(out_file, " Revoke FS block %llu",
746 (unsigned long long) rblock);
748 fprintf(out_file, "\n");
750 fprintf(out_file," at block %u, sequence %u\n",
751 blocknr, transaction);
758 static void show_extent(FILE *out_file, int start_extent, int end_extent,
761 if (start_extent >= 0 && first_block != 0)
762 fprintf(out_file, "(%d+%u): %u ",
763 start_extent, end_extent-start_extent, first_block);
766 static void show_indirect(FILE *out_file, const char *name, __u32 where)
769 fprintf(out_file, "(%s): %u ", name, where);
773 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
774 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
775 unsigned int log_blocknr,
776 unsigned int fs_blocknr,
777 unsigned int log_tag_flags,
778 unsigned int blocksize,
782 char buf[EXT2_MAX_BLOCK_SIZE];
785 || (fs_blocknr == block_to_dump)
786 || (fs_blocknr == inode_block_to_dump)
787 || (fs_blocknr == bitmap_to_dump)))
790 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
792 fprintf(out_file, "sequence %u, ", transaction);
793 fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
796 /* There are two major special cases to parse:
798 * If this block is a block
799 * bitmap block, we need to give it special treatment so that we
800 * can log any allocates and deallocates which affect the
801 * block_to_dump query block.
803 * If the block is an inode block for the inode being searched
804 * for, then we need to dump the contents of that inode
805 * structure symbolically.
808 if (!(dump_contents && dump_all)
809 && fs_blocknr != block_to_dump
810 && fs_blocknr != bitmap_to_dump
811 && fs_blocknr != inode_block_to_dump)
814 retval = read_journal_block("logdump", source,
815 ((ext2_loff_t) log_blocknr) * blocksize,
820 if (fs_blocknr == bitmap_to_dump) {
821 struct ext2_super_block *super;
824 super = current_fs->super;
825 offset = ((block_to_dump - super->s_first_data_block) %
826 super->s_blocks_per_group);
828 fprintf(out_file, " (block bitmap for block %llu: "
830 (unsigned long long) block_to_dump,
831 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
834 if (fs_blocknr == inode_block_to_dump) {
835 struct ext2_inode *inode;
836 int first, prev, this, start_extent, i;
838 fprintf(out_file, " (inode block for inode %u):\n",
841 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
842 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
844 /* Dump out the direct/indirect blocks here:
845 * internal_dump_inode can only dump them from the main
846 * on-disk inode, not from the journaled copy of the
849 fprintf (out_file, " Blocks: ");
850 first = prev = start_extent = -1;
852 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
853 this = inode->i_block[i];
854 if (start_extent >= 0 && this == prev+1) {
858 show_extent(out_file, start_extent, i, first);
863 show_extent(out_file, start_extent, i, first);
864 show_indirect(out_file, "IND", inode->i_block[i++]);
865 show_indirect(out_file, "DIND", inode->i_block[i++]);
866 show_indirect(out_file, "TIND", inode->i_block[i++]);
868 fprintf(out_file, "\n");
872 do_hexdump(out_file, buf, blocksize);
876 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
884 charp = (char *) buf;
886 for (i=0; i<blocksize; i+=16) {
887 fprintf(out_file, " %04x: ", i);
888 for (j=0; j<16; j+=4)
889 fprintf(out_file, "%08x ", *intp++);
890 for (j=0; j<16; j++) {
892 if (c < ' ' || c >= 127)
894 fprintf(out_file, "%c", c);
896 fprintf(out_file, "\n");