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, 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) \
75 if (blocknr >= be32_to_cpu((jsb)->s_maxlen)) \
76 blocknr -= (be32_to_cpu((jsb)->s_maxlen) - \
77 be32_to_cpu((jsb)->s_first));
79 void do_logdump(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
80 void *infop EXT2FS_ATTR((unused)))
87 char *inode_spec = NULL;
88 char *journal_fn = NULL;
91 ext2_ino_t journal_inum;
92 struct ext2_inode journal_inode;
93 ext2_file_t journal_file;
95 struct journal_source journal_source;
96 struct ext2_super_block *es = NULL;
98 journal_source.where = JOURNAL_IS_INTERNAL;
99 journal_source.fd = 0;
100 journal_source.file = 0;
105 dump_descriptors = 1;
106 block_to_dump = ANY_BLOCK;
108 inode_block_to_dump = ANY_BLOCK;
112 while ((c = getopt (argc, argv, "ab:ci:f:OsS")) != EOF) {
118 block_to_dump = strtoul(optarg, &tmp, 0);
121 "Bad block number - %s", optarg);
124 dump_descriptors = 0;
134 dump_descriptors = 0;
149 if (optind != argc && optind != argc-1) {
154 es = current_fs->super;
157 int inode_group, group_offset, inodes_per_block;
159 if (check_fs_open(argv[0]))
162 inode_to_dump = string_to_inode(inode_spec);
166 inode_group = ((inode_to_dump - 1)
167 / es->s_inodes_per_group);
168 group_offset = ((inode_to_dump - 1)
169 % es->s_inodes_per_group);
170 inodes_per_block = (current_fs->blocksize
171 / sizeof(struct ext2_inode));
173 inode_block_to_dump =
174 ext2fs_inode_table_loc(current_fs, inode_group) +
175 (group_offset / inodes_per_block);
176 inode_offset_to_dump = ((group_offset % inodes_per_block)
177 * sizeof(struct ext2_inode));
178 printf("Inode %u is at group %u, block %llu, offset %u\n",
179 inode_to_dump, inode_group,
180 (unsigned long long) inode_block_to_dump,
181 inode_offset_to_dump);
184 if (optind == argc) {
187 out_fn = argv[optind];
188 out_file = fopen(out_fn, "w");
190 com_err(argv[0], errno, "while opening %s for logdump",
196 if (block_to_dump != ANY_BLOCK && current_fs != NULL) {
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);
203 if (!journal_fn && check_fs_open(argv[0]))
207 /* Set up to read journal from a regular file somewhere */
208 journal_fd = open(journal_fn, O_RDONLY, 0);
209 if (journal_fd < 0) {
210 com_err(argv[0], errno, "while opening %s for logdump",
215 journal_source.where = JOURNAL_IS_EXTERNAL;
216 journal_source.fd = journal_fd;
217 } else if ((journal_inum = es->s_journal_inum)) {
219 if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
221 "no journal backup in super block\n");
224 memset(&journal_inode, 0, sizeof(struct ext2_inode));
225 memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
227 journal_inode.i_size_high = es->s_jnl_blocks[15];
228 journal_inode.i_size = es->s_jnl_blocks[16];
229 journal_inode.i_links_count = 1;
230 journal_inode.i_mode = LINUX_S_IFREG | 0600;
232 if (debugfs_read_inode(journal_inum, &journal_inode,
237 retval = ext2fs_file_open2(current_fs, journal_inum,
238 &journal_inode, 0, &journal_file);
240 com_err(argv[0], retval, "while opening ext2 file");
243 journal_source.where = JOURNAL_IS_INTERNAL;
244 journal_source.file = journal_file;
248 uuid_unparse(es->s_journal_uuid, uuid);
249 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
251 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
253 com_err(argv[0], 0, "filesystem has no journal");
256 journal_fd = open(journal_fn, O_RDONLY, 0);
257 if (journal_fd < 0) {
258 com_err(argv[0], errno, "while opening %s for logdump",
263 fprintf(out_file, "Using external journal found at %s\n",
266 journal_source.where = JOURNAL_IS_EXTERNAL;
267 journal_source.fd = journal_fd;
270 dump_journal(argv[0], out_file, &journal_source);
272 if (journal_source.where == JOURNAL_IS_INTERNAL)
273 ext2fs_file_close(journal_file);
278 if (out_file && (out_file != stdout))
284 fprintf(stderr, "%s: Usage: logdump [-acsOS] [-b<block>] [-i<filespec>]\n\t"
285 "[-f<journal_file>] [output_file]\n", argv[0]);
289 static int read_journal_block(const char *cmd, struct journal_source *source,
290 ext2_loff_t offset, char *buf, unsigned int size)
295 if (source->where == JOURNAL_IS_EXTERNAL) {
296 if (lseek(source->fd, offset, SEEK_SET) < 0) {
300 retval = read(source->fd, buf, size);
308 retval = ext2fs_file_llseek(source->file, offset,
309 EXT2_SEEK_SET, NULL);
312 com_err(cmd, retval, "while seeking in reading journal");
315 retval = ext2fs_file_read(source->file, buf, size, &got);
318 com_err(cmd, retval, "while reading journal");
323 com_err(cmd, 0, "short read (read %u, expected %u) "
324 "while reading journal", got, size);
330 static const char *type_to_name(int btype)
333 case JBD2_DESCRIPTOR_BLOCK:
334 return "descriptor block";
335 case JBD2_COMMIT_BLOCK:
336 return "commit block";
337 case JBD2_SUPERBLOCK_V1:
338 return "V1 superblock";
339 case JBD2_SUPERBLOCK_V2:
340 return "V2 superblock";
341 case JBD2_REVOKE_BLOCK:
342 return "revoke table";
344 return "unrecognised type";
348 static void dump_journal(char *cmdname, FILE *out_file,
349 struct journal_source *source)
351 struct ext2_super_block *sb;
352 char jsb_buffer[1024];
354 journal_superblock_t *jsb;
355 unsigned int blocksize = 1024;
357 __u32 magic, sequence, blocktype;
358 journal_header_t *header;
360 unsigned int blocknr = 0;
363 /* First, check to see if there's an ext2 superblock header */
364 retval = read_journal_block(cmdname, source, 0, buf, 2048);
368 jsb = (journal_superblock_t *) buf;
369 sb = (struct ext2_super_block *) (buf+1024);
370 #ifdef WORDS_BIGENDIAN
371 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
372 ext2fs_swap_super(sb);
375 if ((be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) &&
376 (sb->s_magic == EXT2_SUPER_MAGIC) &&
377 ext2fs_has_feature_journal_dev(sb)) {
378 blocksize = EXT2_BLOCK_SIZE(sb);
379 blocknr = (blocksize == 1024) ? 2 : 1;
380 uuid_unparse(sb->s_uuid, jsb_buffer);
381 fprintf(out_file, "Ext2 superblock header found.\n");
383 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
384 fprintf(out_file, "\tblocksize=%d\n", blocksize);
385 fprintf(out_file, "\tjournal data size %lu\n",
386 (unsigned long) ext2fs_blocks_count(sb));
390 /* Next, read the journal superblock */
391 retval = read_journal_block(cmdname, source,
392 ((ext2_loff_t) blocknr) * blocksize,
398 e2p_list_journal_super(out_file, jsb_buffer,
399 current_fs->blocksize, 0);
400 fputc('\n', out_file);
403 jsb = (journal_superblock_t *) jsb_buffer;
404 if (be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) {
406 "Journal superblock magic number invalid!\n");
409 if (be32_to_cpu(jsb->s_blocksize) != blocksize) {
411 "Journal block size invalid: %u\n",
412 be32_to_cpu(jsb->s_blocksize));
415 transaction = be32_to_cpu(jsb->s_sequence);
416 blocknr = be32_to_cpu(jsb->s_start);
418 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
419 blocknr, transaction);
422 /* Empty journal, nothing to do. */
430 retval = read_journal_block(cmdname, source,
431 ((ext2_loff_t) blocknr) * blocksize,
436 header = (journal_header_t *) buf;
438 magic = be32_to_cpu(header->h_magic);
439 sequence = be32_to_cpu(header->h_sequence);
440 blocktype = be32_to_cpu(header->h_blocktype);
442 if (magic != JBD2_MAGIC_NUMBER) {
443 fprintf (out_file, "No magic number at block %u: "
444 "end of journal.\n", blocknr);
448 if (sequence != transaction) {
449 fprintf (out_file, "Found sequence %u (not %u) at "
450 "block %u: end of journal.\n",
451 sequence, transaction, blocknr);
456 if (dump_descriptors) {
457 fprintf (out_file, "Found expected sequence %u, "
458 "type %u (%s) at block %u\n",
460 type_to_name(blocktype), blocknr);
464 case JBD2_DESCRIPTOR_BLOCK:
465 dump_descriptor_block(out_file, source, buf, jsb,
470 case JBD2_COMMIT_BLOCK:
476 case JBD2_REVOKE_BLOCK:
477 dump_revoke_block(out_file, buf, jsb,
485 fprintf (out_file, "Unexpected block type %u at "
486 "block %u.\n", blocktype, blocknr);
492 blocknr = be32_to_cpu(jsb->s_maxlen) - jbd2_journal_get_num_fc_blks(jsb) + 1;
493 while (blocknr <= be32_to_cpu(jsb->s_maxlen)) {
494 retval = read_journal_block(cmdname, source,
495 ((ext2_loff_t) blocknr) * blocksize,
500 dump_fc_block(out_file, buf, blocksize, transaction, &fc_done,
502 if (!dump_old && fc_done)
508 static inline size_t journal_super_tag_bytes(journal_superblock_t *jsb)
512 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3))
513 return sizeof(journal_block_tag3_t);
515 sz = sizeof(journal_block_tag_t);
517 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
520 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_64BIT))
523 return sz - sizeof(__u32);
526 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
527 int transaction, int *fc_done, int dump_old)
529 struct ext4_fc_tl *tl;
530 struct ext4_fc_head *head;
531 struct ext4_fc_add_range *add_range;
532 struct ext4_fc_del_range *del_range;
533 struct ext4_fc_dentry_info *dentry_info;
534 struct ext4_fc_tail *tail;
535 struct ext3_extent *ex;
538 fc_for_each_tl(buf, buf + blocksize, tl) {
539 switch (le16_to_cpu(tl->fc_tag)) {
540 case EXT4_FC_TAG_ADD_RANGE:
542 (struct ext4_fc_add_range *)ext4_fc_tag_val(tl);
543 ex = (struct ext3_extent *)add_range->fc_ex;
545 "tag %s, inode %d, lblk %u, pblk %llu, len %lu\n",
547 le32_to_cpu(add_range->fc_ino),
548 le32_to_cpu(ex->ee_block),
549 le32_to_cpu(ex->ee_start) +
550 (((unsigned long long) le16_to_cpu(ex->ee_start_hi)) << 32),
551 le16_to_cpu(ex->ee_len) > EXT_INIT_MAX_LEN ?
552 le16_to_cpu(ex->ee_len) - EXT_INIT_MAX_LEN :
553 le16_to_cpu(ex->ee_len));
555 case EXT4_FC_TAG_DEL_RANGE:
557 (struct ext4_fc_del_range *)ext4_fc_tag_val(tl);
558 fprintf(out_file, "tag %s, inode %d, lblk %d, len %d\n",
560 le32_to_cpu(del_range->fc_ino),
561 le32_to_cpu(del_range->fc_lblk),
562 le32_to_cpu(del_range->fc_len));
564 case EXT4_FC_TAG_LINK:
565 case EXT4_FC_TAG_UNLINK:
566 case EXT4_FC_TAG_CREAT:
568 (struct ext4_fc_dentry_info *)
571 "tag %s, parent %d, ino %d, name \"%s\"\n",
573 le32_to_cpu(dentry_info->fc_parent_ino),
574 le32_to_cpu(dentry_info->fc_ino),
575 dentry_info->fc_dname);
577 case EXT4_FC_TAG_INODE:
578 fprintf(out_file, "tag %s, inode %d\n",
580 le32_to_cpu(((struct ext4_fc_inode *)
581 ext4_fc_tag_val(tl))->fc_ino));
583 case EXT4_FC_TAG_PAD:
584 fprintf(out_file, "tag %s\n", tag2str(tl->fc_tag));
586 case EXT4_FC_TAG_TAIL:
587 tail = (struct ext4_fc_tail *)ext4_fc_tag_val(tl);
588 fprintf(out_file, "tag %s, tid %d\n",
590 le32_to_cpu(tail->fc_tid));
592 le32_to_cpu(tail->fc_tid) < transaction) {
597 case EXT4_FC_TAG_HEAD:
598 fprintf(out_file, "\n*** Fast Commit Area ***\n");
599 head = (struct ext4_fc_head *)ext4_fc_tag_val(tl);
600 fprintf(out_file, "tag %s, features 0x%x, tid %d\n",
602 le32_to_cpu(head->fc_features),
603 le32_to_cpu(head->fc_tid));
605 le32_to_cpu(head->fc_tid) < transaction) {
617 static void dump_descriptor_block(FILE *out_file,
618 struct journal_source *source,
620 journal_superblock_t *jsb,
621 unsigned int *blockp, int blocksize,
624 int offset, tag_size, csum_size = 0;
626 journal_block_tag_t *tag;
627 unsigned int blocknr;
631 tag_size = journal_super_tag_bytes(jsb);
632 offset = sizeof(journal_header_t);
635 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3) ||
636 JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
637 csum_size = sizeof(struct jbd2_journal_block_tail);
640 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
641 "block %u:\n", transaction, blocknr);
647 /* Work out the location of the current tag, and skip to
650 tag = (journal_block_tag_t *) tagp;
653 /* ... and if we have gone too far, then we've reached the
654 end of this block. */
655 if (offset > blocksize - csum_size)
658 tag_block = be32_to_cpu(tag->t_blocknr);
659 tag_flags = be16_to_cpu(tag->t_flags);
661 if (!(tag_flags & JBD2_FLAG_SAME_UUID))
664 dump_metadata_block(out_file, source, jsb,
665 blocknr, tag_block, tag_flags, blocksize,
671 } while (!(tag_flags & JBD2_FLAG_LAST_TAG));
677 static void dump_revoke_block(FILE *out_file, char *buf,
678 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
679 unsigned int blocknr,
680 int blocksize EXT2FS_ATTR((unused)),
684 jbd2_journal_revoke_header_t *header;
685 unsigned long long rblock;
686 int tag_size = sizeof(__u32);
689 fprintf(out_file, "Dumping revoke block, sequence %u, at "
690 "block %u:\n", transaction, blocknr);
692 if (be32_to_cpu(jsb->s_feature_incompat) & JBD2_FEATURE_INCOMPAT_64BIT)
693 tag_size = sizeof(__u64);
695 header = (jbd2_journal_revoke_header_t *) buf;
696 offset = sizeof(jbd2_journal_revoke_header_t);
697 max = be32_to_cpu(header->r_count);
698 if (max > jsb->s_blocksize) {
699 fprintf(out_file, "Revoke block's r_count invalid: %u\b",
701 max = jsb->s_blocksize;
704 while (offset < max) {
705 if (tag_size == sizeof(__u32)) {
706 __u32 *entry = (__u32 *) (buf + offset);
707 rblock = be32_to_cpu(*entry);
709 __u64 *entry = (__u64 *) (buf + offset);
710 rblock = ext2fs_be64_to_cpu(*entry);
712 if (dump_all || rblock == block_to_dump) {
713 fprintf(out_file, " Revoke FS block %llu",
714 (unsigned long long) rblock);
716 fprintf(out_file, "\n");
718 fprintf(out_file," at block %u, sequence %u\n",
719 blocknr, transaction);
726 static void show_extent(FILE *out_file, int start_extent, int end_extent,
729 if (start_extent >= 0 && first_block != 0)
730 fprintf(out_file, "(%d+%u): %u ",
731 start_extent, end_extent-start_extent, first_block);
734 static void show_indirect(FILE *out_file, const char *name, __u32 where)
737 fprintf(out_file, "(%s): %u ", name, where);
741 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
742 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
743 unsigned int log_blocknr,
744 unsigned int fs_blocknr,
745 unsigned int log_tag_flags,
753 || (fs_blocknr == block_to_dump)
754 || (fs_blocknr == inode_block_to_dump)
755 || (fs_blocknr == bitmap_to_dump)))
758 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
760 fprintf(out_file, "sequence %u, ", transaction);
761 fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
764 /* There are two major special cases to parse:
766 * If this block is a block
767 * bitmap block, we need to give it special treatment so that we
768 * can log any allocates and deallocates which affect the
769 * block_to_dump query block.
771 * If the block is an inode block for the inode being searched
772 * for, then we need to dump the contents of that inode
773 * structure symbolically.
776 if (!(dump_contents && dump_all)
777 && fs_blocknr != block_to_dump
778 && fs_blocknr != bitmap_to_dump
779 && fs_blocknr != inode_block_to_dump)
782 retval = read_journal_block("logdump", source,
783 ((ext2_loff_t) log_blocknr) * blocksize,
788 if (fs_blocknr == bitmap_to_dump) {
789 struct ext2_super_block *super;
792 super = current_fs->super;
793 offset = ((block_to_dump - super->s_first_data_block) %
794 super->s_blocks_per_group);
796 fprintf(out_file, " (block bitmap for block %llu: "
798 (unsigned long long) block_to_dump,
799 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
802 if (fs_blocknr == inode_block_to_dump) {
803 struct ext2_inode *inode;
804 int first, prev, this, start_extent, i;
806 fprintf(out_file, " (inode block for inode %u):\n",
809 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
810 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
812 /* Dump out the direct/indirect blocks here:
813 * internal_dump_inode can only dump them from the main
814 * on-disk inode, not from the journaled copy of the
817 fprintf (out_file, " Blocks: ");
818 first = prev = start_extent = -1;
820 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
821 this = inode->i_block[i];
822 if (start_extent >= 0 && this == prev+1) {
826 show_extent(out_file, start_extent, i, first);
831 show_extent(out_file, start_extent, i, first);
832 show_indirect(out_file, "IND", inode->i_block[i++]);
833 show_indirect(out_file, "DIND", inode->i_block[i++]);
834 show_indirect(out_file, "TIND", inode->i_block[i++]);
836 fprintf(out_file, "\n");
840 do_hexdump(out_file, buf, blocksize);
844 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
852 charp = (char *) buf;
854 for (i=0; i<blocksize; i+=16) {
855 fprintf(out_file, " %04x: ", i);
856 for (j=0; j<16; j+=4)
857 fprintf(out_file, "%08x ", *intp++);
858 for (j=0; j<16; j++) {
860 if (c < ' ' || c >= 127)
862 fprintf(out_file, "%c", c);
864 fprintf(out_file, "\n");