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 ((blk_t) -1)
41 int dump_all, dump_contents, dump_descriptors;
42 blk_t block_to_dump, bitmap_to_dump, inode_block_to_dump;
43 unsigned int group_to_dump, inode_offset_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));
73 void do_logdump(int argc, char **argv)
80 char *inode_spec = NULL;
81 char *journal_fn = NULL;
84 ext2_ino_t journal_inum;
85 struct ext2_inode journal_inode;
86 ext2_file_t journal_file;
88 struct journal_source journal_source;
89 struct ext2_super_block *es = NULL;
91 journal_source.where = 0;
92 journal_source.fd = 0;
93 journal_source.file = 0;
97 block_to_dump = ANY_BLOCK;
99 inode_block_to_dump = ANY_BLOCK;
103 while ((c = getopt (argc, argv, "ab:ci:f:s")) != EOF) {
109 block_to_dump = strtoul(optarg, &tmp, 0);
112 "Bad block number - %s", optarg);
115 dump_descriptors = 0;
125 dump_descriptors = 0;
134 if (optind != argc && optind != argc-1) {
139 es = current_fs->super;
142 int inode_group, group_offset, inodes_per_block;
144 if (check_fs_open(argv[0]))
147 inode_to_dump = string_to_inode(inode_spec);
151 inode_group = ((inode_to_dump - 1)
152 / es->s_inodes_per_group);
153 group_offset = ((inode_to_dump - 1)
154 % es->s_inodes_per_group);
155 inodes_per_block = (current_fs->blocksize
156 / sizeof(struct ext2_inode));
158 inode_block_to_dump =
159 current_fs->group_desc[inode_group].bg_inode_table +
160 (group_offset / inodes_per_block);
161 inode_offset_to_dump = ((group_offset % inodes_per_block)
162 * sizeof(struct ext2_inode));
163 printf("Inode %u is at group %u, block %u, offset %u\n",
164 inode_to_dump, inode_group,
165 inode_block_to_dump, inode_offset_to_dump);
168 if (optind == argc) {
171 out_fn = argv[optind];
172 out_file = fopen(out_fn, "w");
174 com_err(argv[0], errno, "while opening %s for logdump",
180 if (block_to_dump != ANY_BLOCK && current_fs != NULL) {
181 group_to_dump = ((block_to_dump -
182 es->s_first_data_block)
183 / es->s_blocks_per_group);
184 bitmap_to_dump = current_fs->group_desc[group_to_dump].bg_block_bitmap;
187 if (!journal_fn && check_fs_open(argv[0]))
191 /* Set up to read journal from a regular file somewhere */
192 journal_fd = open(journal_fn, O_RDONLY, 0);
193 if (journal_fd < 0) {
194 com_err(argv[0], errno, "while opening %s for logdump",
199 journal_source.where = JOURNAL_IS_EXTERNAL;
200 journal_source.fd = journal_fd;
201 } else if ((journal_inum = es->s_journal_inum)) {
203 if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
205 "no journal backup in super block\n");
208 memset(&journal_inode, 0, sizeof(struct ext2_inode));
209 memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
211 journal_inode.i_size = es->s_jnl_blocks[16];
212 journal_inode.i_links_count = 1;
213 journal_inode.i_mode = LINUX_S_IFREG | 0600;
215 if (debugfs_read_inode(journal_inum, &journal_inode,
220 retval = ext2fs_file_open2(current_fs, journal_inum,
221 &journal_inode, 0, &journal_file);
223 com_err(argv[0], retval, "while opening ext2 file");
226 journal_source.where = JOURNAL_IS_INTERNAL;
227 journal_source.file = journal_file;
231 uuid_unparse(es->s_journal_uuid, uuid);
232 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
234 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
236 com_err(argv[0], 0, "filesystem has no journal");
239 journal_fd = open(journal_fn, O_RDONLY, 0);
240 if (journal_fd < 0) {
241 com_err(argv[0], errno, "while opening %s for logdump",
246 fprintf(out_file, "Using external journal found at %s\n",
249 journal_source.where = JOURNAL_IS_EXTERNAL;
250 journal_source.fd = journal_fd;
253 dump_journal(argv[0], out_file, &journal_source);
255 if (journal_source.where == JOURNAL_IS_INTERNAL)
256 ext2fs_file_close(journal_file);
261 if (out_file != stdout)
267 fprintf(stderr, "%s: Usage: logdump [-ac] [-b<block>] [-i<inode>]\n\t"
268 "[-f<journal_file>] [output_file]\n", argv[0]);
272 static int read_journal_block(const char *cmd, struct journal_source *source,
273 off_t offset, char *buf, int size,
278 if (source->where == JOURNAL_IS_EXTERNAL) {
279 if (lseek(source->fd, offset, SEEK_SET) < 0) {
281 com_err(cmd, retval, "while seeking in reading journal");
284 retval = read(source->fd, buf, size);
291 retval = ext2fs_file_lseek(source->file, offset,
292 EXT2_SEEK_SET, NULL);
294 com_err(cmd, retval, "while seeking in reading journal");
298 retval = ext2fs_file_read(source->file, buf, size, got);
302 com_err(cmd, retval, "while while reading journal");
303 else if (*got != (unsigned int) size) {
304 com_err(cmd, 0, "short read (read %d, expected %d) while while reading journal", *got, size);
311 static const char *type_to_name(int btype)
314 case JFS_DESCRIPTOR_BLOCK:
315 return "descriptor block";
316 case JFS_COMMIT_BLOCK:
317 return "commit block";
318 case JFS_SUPERBLOCK_V1:
319 return "V1 superblock";
320 case JFS_SUPERBLOCK_V2:
321 return "V2 superblock";
322 case JFS_REVOKE_BLOCK:
323 return "revoke table";
325 return "unrecognised type";
329 static void dump_journal(char *cmdname, FILE *out_file,
330 struct journal_source *source)
332 struct ext2_super_block *sb;
333 char jsb_buffer[1024];
335 journal_superblock_t *jsb;
336 unsigned int blocksize = 1024;
339 __u32 magic, sequence, blocktype;
340 journal_header_t *header;
343 unsigned int blocknr = 0;
345 /* First, check to see if there's an ext2 superblock header */
346 retval = read_journal_block(cmdname, source, 0,
351 jsb = (journal_superblock_t *) buf;
352 sb = (struct ext2_super_block *) (buf+1024);
353 #ifdef WORDS_BIGENDIAN
354 if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
355 ext2fs_swap_super(sb);
358 if ((be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) &&
359 (sb->s_magic == EXT2_SUPER_MAGIC) &&
360 (sb->s_feature_incompat & EXT3_FEATURE_INCOMPAT_JOURNAL_DEV)) {
361 blocksize = EXT2_BLOCK_SIZE(sb);
362 blocknr = (blocksize == 1024) ? 2 : 1;
363 uuid_unparse(sb->s_uuid, jsb_buffer);
364 fprintf(out_file, "Ext2 superblock header found.\n");
366 fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
367 fprintf(out_file, "\tblocksize=%d\n", blocksize);
368 fprintf(out_file, "\tjournal data size %lu\n",
369 (unsigned long) sb->s_blocks_count);
373 /* Next, read the journal superblock */
375 retval = read_journal_block(cmdname, source, blocknr*blocksize,
376 jsb_buffer, 1024, &got);
380 jsb = (journal_superblock_t *) jsb_buffer;
381 if (be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) {
383 "Journal superblock magic number invalid!\n");
386 blocksize = be32_to_cpu(jsb->s_blocksize);
387 transaction = be32_to_cpu(jsb->s_sequence);
388 blocknr = be32_to_cpu(jsb->s_start);
390 fprintf(out_file, "Journal starts at block %u, transaction %u\n",
391 blocknr, transaction);
394 /* Empty journal, nothing to do. */
398 retval = read_journal_block(cmdname, source,
399 blocknr*blocksize, buf,
401 if (retval || got != blocksize)
404 header = (journal_header_t *) buf;
406 magic = be32_to_cpu(header->h_magic);
407 sequence = be32_to_cpu(header->h_sequence);
408 blocktype = be32_to_cpu(header->h_blocktype);
410 if (magic != JFS_MAGIC_NUMBER) {
411 fprintf (out_file, "No magic number at block %u: "
412 "end of journal.\n", blocknr);
416 if (sequence != transaction) {
417 fprintf (out_file, "Found sequence %u (not %u) at "
418 "block %u: end of journal.\n",
419 sequence, transaction, blocknr);
423 if (dump_descriptors) {
424 fprintf (out_file, "Found expected sequence %u, "
425 "type %u (%s) at block %u\n",
427 type_to_name(blocktype), blocknr);
431 case JFS_DESCRIPTOR_BLOCK:
432 dump_descriptor_block(out_file, source, buf, jsb,
437 case JFS_COMMIT_BLOCK:
443 case JFS_REVOKE_BLOCK:
444 dump_revoke_block(out_file, buf, jsb,
452 fprintf (out_file, "Unexpected block type %u at "
453 "block %u.\n", blocktype, blocknr);
460 static void dump_descriptor_block(FILE *out_file,
461 struct journal_source *source,
463 journal_superblock_t *jsb,
464 unsigned int *blockp, int blocksize,
469 journal_block_tag_t *tag;
470 unsigned int blocknr;
475 offset = sizeof(journal_header_t);
479 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
480 "block %u:\n", transaction, blocknr);
486 /* Work out the location of the current tag, and skip to
489 tag = (journal_block_tag_t *) tagp;
490 offset += sizeof(journal_block_tag_t);
492 /* ... and if we have gone too far, then we've reached the
493 end of this block. */
494 if (offset > blocksize)
497 tag_block = be32_to_cpu(tag->t_blocknr);
498 tag_flags = be32_to_cpu(tag->t_flags);
500 if (!(tag_flags & JFS_FLAG_SAME_UUID))
503 dump_metadata_block(out_file, source, jsb,
504 blocknr, tag_block, blocksize,
510 } while (!(tag_flags & JFS_FLAG_LAST_TAG));
516 static void dump_revoke_block(FILE *out_file, char *buf,
517 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
518 unsigned int blocknr,
519 int blocksize EXT2FS_ATTR((unused)),
523 journal_revoke_header_t *header;
524 unsigned int *entry, rblock;
527 fprintf(out_file, "Dumping revoke block, sequence %u, at "
528 "block %u:\n", transaction, blocknr);
530 header = (journal_revoke_header_t *) buf;
531 offset = sizeof(journal_revoke_header_t);
532 max = be32_to_cpu(header->r_count);
534 while (offset < max) {
535 entry = (unsigned int *) (buf + offset);
536 rblock = be32_to_cpu(*entry);
537 if (dump_all || rblock == block_to_dump) {
538 fprintf(out_file, " Revoke FS block %u", rblock);
540 fprintf(out_file, "\n");
542 fprintf(out_file," at block %u, sequence %u\n",
543 blocknr, transaction);
550 static void show_extent(FILE *out_file, int start_extent, int end_extent,
553 if (start_extent >= 0 && first_block != 0)
554 fprintf(out_file, "(%d+%u): %u ",
555 start_extent, end_extent-start_extent, first_block);
558 static void show_indirect(FILE *out_file, const char *name, __u32 where)
561 fprintf(out_file, "(%s): %u ", name, where);
565 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
566 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
567 unsigned int log_blocknr,
568 unsigned int fs_blocknr,
577 || (fs_blocknr == block_to_dump)
578 || (fs_blocknr == inode_block_to_dump)
579 || (fs_blocknr == bitmap_to_dump)))
582 fprintf(out_file, " FS block %u logged at ", fs_blocknr);
584 fprintf(out_file, "sequence %u, ", transaction);
585 fprintf(out_file, "journal block %u\n", log_blocknr);
587 /* There are two major special cases to parse:
589 * If this block is a block
590 * bitmap block, we need to give it special treatment so that we
591 * can log any allocates and deallocates which affect the
592 * block_to_dump query block.
594 * If the block is an inode block for the inode being searched
595 * for, then we need to dump the contents of that inode
596 * structure symbolically.
599 if (!(dump_contents && dump_all)
600 && fs_blocknr != block_to_dump
601 && fs_blocknr != bitmap_to_dump
602 && fs_blocknr != inode_block_to_dump)
605 retval = read_journal_block("logdump", source,
606 blocksize * log_blocknr,
607 buf, blocksize, &got);
611 if (fs_blocknr == bitmap_to_dump) {
612 struct ext2_super_block *super;
615 super = current_fs->super;
616 offset = ((fs_blocknr - super->s_first_data_block) %
617 super->s_blocks_per_group);
619 fprintf(out_file, " (block bitmap for block %u: "
622 ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
625 if (fs_blocknr == inode_block_to_dump) {
626 struct ext2_inode *inode;
627 int first, prev, this, start_extent, i;
629 fprintf(out_file, " (inode block for inode %u):\n",
632 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
633 internal_dump_inode(out_file, " ", inode_to_dump, inode, 0);
635 /* Dump out the direct/indirect blocks here:
636 * internal_dump_inode can only dump them from the main
637 * on-disk inode, not from the journaled copy of the
640 fprintf (out_file, " Blocks: ");
641 first = prev = start_extent = -1;
643 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
644 this = inode->i_block[i];
645 if (start_extent >= 0 && this == prev+1) {
649 show_extent(out_file, start_extent, i, first);
654 show_extent(out_file, start_extent, i, first);
655 show_indirect(out_file, "IND", inode->i_block[i++]);
656 show_indirect(out_file, "DIND", inode->i_block[i++]);
657 show_indirect(out_file, "TIND", inode->i_block[i++]);
659 fprintf(out_file, "\n");
663 do_hexdump(out_file, buf, blocksize);
667 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
675 charp = (char *) buf;
677 for (i=0; i<blocksize; i+=16) {
678 fprintf(out_file, " %04x: ", i);
679 for (j=0; j<16; j+=4)
680 fprintf(out_file, "%08x ", *intp++);
681 for (j=0; j<16; j++) {
683 if (c < ' ' || c >= 127)
685 fprintf(out_file, "%c", c);
687 fprintf(out_file, "\n");