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
22 #include <sys/types.h>
34 #include "blkid/blkid.h"
36 #include <uuid/uuid.h>
38 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
40 #define ANY_BLOCK ((blk64_t) -1)
42 static int dump_all, dump_old, dump_contents, dump_descriptors;
43 static blk64_t block_to_dump, bitmap_to_dump, inode_block_to_dump;
44 static unsigned int group_to_dump, inode_offset_to_dump;
45 static ext2_ino_t inode_to_dump;
49 enum journal_location where;
54 static void dump_journal(char *, FILE *, struct journal_source *);
56 static void dump_descriptor_block(FILE *, struct journal_source *,
57 char *, journal_superblock_t *,
58 unsigned int *, int, tid_t);
60 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
61 unsigned int, int, tid_t);
63 static void dump_metadata_block(FILE *, struct journal_source *,
64 journal_superblock_t*,
65 unsigned int, unsigned int, unsigned int,
68 static void do_hexdump (FILE *, char *, int);
70 #define WRAP(jsb, blocknr) \
71 if (blocknr >= be32_to_cpu((jsb)->s_maxlen)) \
72 blocknr -= (be32_to_cpu((jsb)->s_maxlen) - \
73 be32_to_cpu((jsb)->s_first));
75 void do_logdump(int argc, char **argv)
82 char *inode_spec = NULL;
83 char *journal_fn = NULL;
86 ext2_ino_t journal_inum;
87 struct ext2_inode journal_inode;
88 ext2_file_t journal_file;
90 struct journal_source journal_source;
91 struct ext2_super_block *es = NULL;
93 journal_source.where = JOURNAL_IS_INTERNAL;
94 journal_source.fd = 0;
95 journal_source.file = 0;
100 block_to_dump = ANY_BLOCK;
102 inode_block_to_dump = ANY_BLOCK;
106 while ((c = getopt (argc, argv, "ab:ci:f:Os")) != EOF) {
112 block_to_dump = strtoul(optarg, &tmp, 0);
115 "Bad block number - %s", optarg);
118 dump_descriptors = 0;
128 dump_descriptors = 0;
140 if (optind != argc && optind != argc-1) {
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 ext2fs_inode_table_loc(current_fs, inode_group) +
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 %llu, 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 = ext2fs_block_bitmap_loc(current_fs, group_to_dump);
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_high = es->s_jnl_blocks[15];
218 journal_inode.i_size = es->s_jnl_blocks[16];
219 journal_inode.i_links_count = 1;
220 journal_inode.i_mode = LINUX_S_IFREG | 0600;
222 if (debugfs_read_inode(journal_inum, &journal_inode,
227 retval = ext2fs_file_open2(current_fs, journal_inum,
228 &journal_inode, 0, &journal_file);
230 com_err(argv[0], retval, "while opening ext2 file");
233 journal_source.where = JOURNAL_IS_INTERNAL;
234 journal_source.file = journal_file;
238 uuid_unparse(es->s_journal_uuid, uuid);
239 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
241 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
243 com_err(argv[0], 0, "filesystem has no journal");
246 journal_fd = open(journal_fn, O_RDONLY, 0);
247 if (journal_fd < 0) {
248 com_err(argv[0], errno, "while opening %s for logdump",
253 fprintf(out_file, "Using external journal found at %s\n",
256 journal_source.where = JOURNAL_IS_EXTERNAL;
257 journal_source.fd = journal_fd;
260 dump_journal(argv[0], out_file, &journal_source);
262 if (journal_source.where == JOURNAL_IS_INTERNAL)
263 ext2fs_file_close(journal_file);
268 if (out_file && (out_file != stdout))
274 fprintf(stderr, "%s: Usage: logdump [-acsO] [-b<block>] [-i<filespec>]\n\t"
275 "[-f<journal_file>] [output_file]\n", argv[0]);
279 static int read_journal_block(const char *cmd, struct journal_source *source,
280 off_t offset, char *buf, unsigned int size)
285 if (source->where == JOURNAL_IS_EXTERNAL) {
286 if (lseek(source->fd, offset, SEEK_SET) < 0) {
290 retval = read(source->fd, buf, size);
298 retval = ext2fs_file_lseek(source->file, offset,
299 EXT2_SEEK_SET, NULL);
302 com_err(cmd, retval, "while seeking in reading journal");
305 retval = ext2fs_file_read(source->file, buf, size, &got);
308 com_err(cmd, retval, "while reading journal");
313 com_err(cmd, 0, "short read (read %u, expected %u) "
314 "while reading journal", got, size);
320 static const char *type_to_name(int btype)
323 case JFS_DESCRIPTOR_BLOCK:
324 return "descriptor block";
325 case JFS_COMMIT_BLOCK:
326 return "commit block";
327 case JFS_SUPERBLOCK_V1:
328 return "V1 superblock";
329 case JFS_SUPERBLOCK_V2:
330 return "V2 superblock";
331 case JFS_REVOKE_BLOCK:
332 return "revoke table";
334 return "unrecognised type";
338 static void dump_journal(char *cmdname, FILE *out_file,
339 struct journal_source *source)
341 struct ext2_super_block *sb;
342 char jsb_buffer[1024];
344 journal_superblock_t *jsb;
345 unsigned int blocksize = 1024;
347 __u32 magic, sequence, blocktype;
348 journal_header_t *header;
351 unsigned int blocknr = 0;
353 /* First, check to see if there's an ext2 superblock header */
354 retval = read_journal_block(cmdname, source, 0, buf, 2048);
358 jsb = (journal_superblock_t *) buf;
359 sb = (struct ext2_super_block *) (buf+1024);
360 #ifdef WORDS_BIGENDIAN
361 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
362 ext2fs_swap_super(sb);
365 if ((be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) &&
366 (sb->s_magic == EXT2_SUPER_MAGIC) &&
367 (sb->s_feature_incompat & EXT3_FEATURE_INCOMPAT_JOURNAL_DEV)) {
368 blocksize = EXT2_BLOCK_SIZE(sb);
369 blocknr = (blocksize == 1024) ? 2 : 1;
370 uuid_unparse(sb->s_uuid, jsb_buffer);
371 fprintf(out_file, "Ext2 superblock header found.\n");
373 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
374 fprintf(out_file, "\tblocksize=%d\n", blocksize);
375 fprintf(out_file, "\tjournal data size %lu\n",
376 (unsigned long) ext2fs_blocks_count(sb));
380 /* Next, read the journal superblock */
382 retval = read_journal_block(cmdname, source, blocknr*blocksize,
387 jsb = (journal_superblock_t *) jsb_buffer;
388 if (be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) {
390 "Journal superblock magic number invalid!\n");
393 blocksize = be32_to_cpu(jsb->s_blocksize);
394 transaction = be32_to_cpu(jsb->s_sequence);
395 blocknr = be32_to_cpu(jsb->s_start);
397 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
398 blocknr, transaction);
401 /* Empty journal, nothing to do. */
409 retval = read_journal_block(cmdname, source,
410 blocknr*blocksize, buf,
415 header = (journal_header_t *) buf;
417 magic = be32_to_cpu(header->h_magic);
418 sequence = be32_to_cpu(header->h_sequence);
419 blocktype = be32_to_cpu(header->h_blocktype);
421 if (magic != JFS_MAGIC_NUMBER) {
422 fprintf (out_file, "No magic number at block %u: "
423 "end of journal.\n", blocknr);
427 if (sequence != transaction) {
428 fprintf (out_file, "Found sequence %u (not %u) at "
429 "block %u: end of journal.\n",
430 sequence, transaction, blocknr);
435 if (dump_descriptors) {
436 fprintf (out_file, "Found expected sequence %u, "
437 "type %u (%s) at block %u\n",
439 type_to_name(blocktype), blocknr);
443 case JFS_DESCRIPTOR_BLOCK:
444 dump_descriptor_block(out_file, source, buf, jsb,
449 case JFS_COMMIT_BLOCK:
455 case JFS_REVOKE_BLOCK:
456 dump_revoke_block(out_file, buf, jsb,
464 fprintf (out_file, "Unexpected block type %u at "
465 "block %u.\n", blocktype, blocknr);
471 static inline size_t journal_super_tag_bytes(journal_superblock_t *jsb)
475 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JFS_FEATURE_INCOMPAT_CSUM_V3))
476 return sizeof(journal_block_tag3_t);
478 sz = sizeof(journal_block_tag_t);
480 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JFS_FEATURE_INCOMPAT_CSUM_V2))
483 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JFS_FEATURE_INCOMPAT_64BIT))
486 return sz - sizeof(__u32);
489 static void dump_descriptor_block(FILE *out_file,
490 struct journal_source *source,
492 journal_superblock_t *jsb,
493 unsigned int *blockp, int blocksize,
496 int offset, tag_size, csum_size = 0;
498 journal_block_tag_t *tag;
499 unsigned int blocknr;
503 tag_size = journal_super_tag_bytes(jsb);
504 offset = sizeof(journal_header_t);
507 if (JSB_HAS_INCOMPAT_FEATURE(jsb, JFS_FEATURE_INCOMPAT_CSUM_V3) ||
508 JSB_HAS_INCOMPAT_FEATURE(jsb, JFS_FEATURE_INCOMPAT_CSUM_V2))
509 csum_size = sizeof(struct journal_block_tail);
512 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
513 "block %u:\n", transaction, blocknr);
519 /* Work out the location of the current tag, and skip to
522 tag = (journal_block_tag_t *) tagp;
525 /* ... and if we have gone too far, then we've reached the
526 end of this block. */
527 if (offset > blocksize - csum_size)
530 tag_block = be32_to_cpu(tag->t_blocknr);
531 tag_flags = be16_to_cpu(tag->t_flags);
533 if (!(tag_flags & JFS_FLAG_SAME_UUID))
536 dump_metadata_block(out_file, source, jsb,
537 blocknr, tag_block, tag_flags, blocksize,
543 } while (!(tag_flags & JFS_FLAG_LAST_TAG));
549 static void dump_revoke_block(FILE *out_file, char *buf,
550 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
551 unsigned int blocknr,
552 int blocksize EXT2FS_ATTR((unused)),
556 journal_revoke_header_t *header;
557 unsigned long long rblock;
558 int tag_size = sizeof(__u32);
561 fprintf(out_file, "Dumping revoke block, sequence %u, at "
562 "block %u:\n", transaction, blocknr);
564 if (be32_to_cpu(jsb->s_feature_incompat) & JFS_FEATURE_INCOMPAT_64BIT)
565 tag_size = sizeof(__u64);
567 header = (journal_revoke_header_t *) buf;
568 offset = sizeof(journal_revoke_header_t);
569 max = be32_to_cpu(header->r_count);
571 while (offset < max) {
572 if (tag_size == sizeof(__u32)) {
573 __u32 *entry = (__u32 *) (buf + offset);
574 rblock = be32_to_cpu(*entry);
576 __u64 *entry = (__u64 *) (buf + offset);
577 rblock = ext2fs_be64_to_cpu(*entry);
579 if (dump_all || rblock == block_to_dump) {
580 fprintf(out_file, " Revoke FS block %llu", rblock);
582 fprintf(out_file, "\n");
584 fprintf(out_file," at block %u, sequence %u\n",
585 blocknr, transaction);
592 static void show_extent(FILE *out_file, int start_extent, int end_extent,
595 if (start_extent >= 0 && first_block != 0)
596 fprintf(out_file, "(%d+%u): %u ",
597 start_extent, end_extent-start_extent, first_block);
600 static void show_indirect(FILE *out_file, const char *name, __u32 where)
603 fprintf(out_file, "(%s): %u ", name, where);
607 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
608 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
609 unsigned int log_blocknr,
610 unsigned int fs_blocknr,
611 unsigned int log_tag_flags,
619 || (fs_blocknr == block_to_dump)
620 || (fs_blocknr == inode_block_to_dump)
621 || (fs_blocknr == bitmap_to_dump)))
624 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
626 fprintf(out_file, "sequence %u, ", transaction);
627 fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
630 /* There are two major special cases to parse:
632 * If this block is a block
633 * bitmap block, we need to give it special treatment so that we
634 * can log any allocates and deallocates which affect the
635 * block_to_dump query block.
637 * If the block is an inode block for the inode being searched
638 * for, then we need to dump the contents of that inode
639 * structure symbolically.
642 if (!(dump_contents && dump_all)
643 && fs_blocknr != block_to_dump
644 && fs_blocknr != bitmap_to_dump
645 && fs_blocknr != inode_block_to_dump)
648 retval = read_journal_block("logdump", source,
649 blocksize * log_blocknr,
654 if (fs_blocknr == bitmap_to_dump) {
655 struct ext2_super_block *super;
658 super = current_fs->super;
659 offset = ((block_to_dump - super->s_first_data_block) %
660 super->s_blocks_per_group);
662 fprintf(out_file, " (block bitmap for block %llu: "
665 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
668 if (fs_blocknr == inode_block_to_dump) {
669 struct ext2_inode *inode;
670 int first, prev, this, start_extent, i;
672 fprintf(out_file, " (inode block for inode %u):\n",
675 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
676 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
678 /* Dump out the direct/indirect blocks here:
679 * internal_dump_inode can only dump them from the main
680 * on-disk inode, not from the journaled copy of the
683 fprintf (out_file, " Blocks: ");
684 first = prev = start_extent = -1;
686 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
687 this = inode->i_block[i];
688 if (start_extent >= 0 && this == prev+1) {
692 show_extent(out_file, start_extent, i, first);
697 show_extent(out_file, start_extent, i, first);
698 show_indirect(out_file, "IND", inode->i_block[i++]);
699 show_indirect(out_file, "DIND", inode->i_block[i++]);
700 show_indirect(out_file, "TIND", inode->i_block[i++]);
702 fprintf(out_file, "\n");
706 do_hexdump(out_file, buf, blocksize);
710 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
718 charp = (char *) buf;
720 for (i=0; i<blocksize; i+=16) {
721 fprintf(out_file, " %04x: ", i);
722 for (j=0; j<16; j+=4)
723 fprintf(out_file, "%08x ", *intp++);
724 for (j=0; j<16; j++) {
726 if (c < ' ' || c >= 127)
728 fprintf(out_file, "%c", c);
730 fprintf(out_file, "\n");