Whamcloud - gitweb
debugfs: teach logdump the -n <num_trans> option
[tools/e2fsprogs.git] / debugfs / logdump.c
1 /*
2  * logdump.c --- dump the contents of the journal out to a file
3  *
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.
7  *
8  * This file may be redistributed under the terms of the GNU Public
9  * License.
10  */
11
12 #include "config.h"
13 #include <stdio.h>
14 #include <unistd.h>
15 #include <stdlib.h>
16 #include <ctype.h>
17 #include <string.h>
18 #include <time.h>
19 #ifdef HAVE_ERRNO_H
20 #include <errno.h>
21 #endif
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <fcntl.h>
25 #include <utime.h>
26 #ifdef HAVE_GETOPT_H
27 #include <getopt.h>
28 #else
29 extern int optind;
30 extern char *optarg;
31 #endif
32
33 #include "debugfs.h"
34 #include "blkid/blkid.h"
35 #include "jfs_user.h"
36 #if __GNUC_PREREQ (4, 6)
37 #pragma GCC diagnostic push
38 #pragma GCC diagnostic ignored "-Wunused-function"
39 #endif
40 #include "ext2fs/fast_commit.h"
41 #if __GNUC_PREREQ (4, 6)
42 #pragma GCC diagnostic pop
43 #endif
44 #include <uuid/uuid.h>
45
46 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
47
48 #define ANY_BLOCK ((blk64_t) -1)
49
50 static int              dump_all, dump_super, dump_old, dump_contents, dump_descriptors;
51 static int64_t          dump_counts;
52 static blk64_t          block_to_dump, bitmap_to_dump, inode_block_to_dump;
53 static unsigned int     group_to_dump, inode_offset_to_dump;
54 static ext2_ino_t       inode_to_dump;
55
56 struct journal_source
57 {
58         enum journal_location where;
59         int fd;
60         ext2_file_t file;
61 };
62
63 static void dump_journal(char *, FILE *, struct journal_source *);
64
65 static void dump_descriptor_block(FILE *, struct journal_source *,
66                                   char *, journal_superblock_t *,
67                                   unsigned int *, unsigned int, __u32, tid_t);
68
69 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
70                                   unsigned int, unsigned int, tid_t);
71
72 static void dump_metadata_block(FILE *, struct journal_source *,
73                                 journal_superblock_t*,
74                                 unsigned int, unsigned int, unsigned int,
75                                 unsigned int, tid_t);
76
77 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
78                           tid_t transaction, int *fc_done);
79
80 static void do_hexdump (FILE *, char *, int);
81
82 #define WRAP(jsb, blocknr, maxlen)                                      \
83         if (blocknr >= (maxlen))                                        \
84             blocknr -= (maxlen - be32_to_cpu((jsb)->s_first));
85
86 void do_logdump(int argc, char **argv, int sci_idx EXT2FS_ATTR((unused)),
87                     void *infop EXT2FS_ATTR((unused)))
88 {
89         int             c;
90         int             retval;
91         char            *out_fn;
92         FILE            *out_file;
93
94         char            *inode_spec = NULL;
95         char            *journal_fn = NULL;
96         int             journal_fd = -1;
97         int             use_sb = 0;
98         ext2_ino_t      journal_inum;
99         struct ext2_inode journal_inode;
100         ext2_file_t     journal_file = NULL;
101         char            *tmp;
102         struct journal_source journal_source;
103         struct ext2_super_block *es = NULL;
104
105         journal_source.where = JOURNAL_IS_INTERNAL;
106         journal_source.fd = 0;
107         journal_source.file = 0;
108         dump_all = 0;
109         dump_old = 0;
110         dump_contents = 0;
111         dump_super = 0;
112         dump_descriptors = 1;
113         block_to_dump = ANY_BLOCK;
114         bitmap_to_dump = -1;
115         inode_block_to_dump = ANY_BLOCK;
116         inode_to_dump = -1;
117         dump_counts = -1;
118
119         reset_getopt();
120         while ((c = getopt (argc, argv, "ab:ci:f:OsSn:")) != EOF) {
121                 switch (c) {
122                 case 'a':
123                         dump_all++;
124                         break;
125                 case 'b':
126                         block_to_dump = strtoul(optarg, &tmp, 0);
127                         if (*tmp) {
128                                 com_err(argv[0], 0,
129                                         "Bad block number - %s", optarg);
130                                 return;
131                         }
132                         dump_descriptors = 0;
133                         break;
134                 case 'c':
135                         dump_contents++;
136                         break;
137                 case 'f':
138                         journal_fn = optarg;
139                         break;
140                 case 'i':
141                         inode_spec = optarg;
142                         dump_descriptors = 0;
143                         break;
144                 case 'O':
145                         dump_old++;
146                         break;
147                 case 's':
148                         use_sb++;
149                         break;
150                 case 'S':
151                         dump_super++;
152                         break;
153                 case 'n':
154                         dump_counts = strtol(optarg, &tmp, 10);
155                         if (*tmp) {
156                                 com_err(argv[0], 0,
157                                         "Bad log counts number - %s", optarg);
158                                 return;
159                         }
160                         break;
161                 default:
162                         goto print_usage;
163                 }
164         }
165         if (optind != argc && optind != argc-1) {
166                 goto print_usage;
167         }
168
169         if (inode_spec) {
170                 int inode_group, group_offset, inodes_per_block;
171
172                 if (check_fs_open(argv[0]))
173                         return;
174
175                 inode_to_dump = string_to_inode(inode_spec);
176                 if (!inode_to_dump)
177                         return;
178
179                 es = current_fs->super;
180                 inode_group = ((inode_to_dump - 1)
181                                / es->s_inodes_per_group);
182                 group_offset = ((inode_to_dump - 1)
183                                 % es->s_inodes_per_group);
184                 inodes_per_block = (current_fs->blocksize
185                                     / sizeof(struct ext2_inode));
186
187                 inode_block_to_dump =
188                         ext2fs_inode_table_loc(current_fs, inode_group) +
189                         (group_offset / inodes_per_block);
190                 inode_offset_to_dump = ((group_offset % inodes_per_block)
191                                         * sizeof(struct ext2_inode));
192                 printf("Inode %u is at group %u, block %llu, offset %u\n",
193                        inode_to_dump, inode_group,
194                        (unsigned long long) inode_block_to_dump,
195                        inode_offset_to_dump);
196         }
197
198         if (optind == argc) {
199                 out_file = stdout;
200         } else {
201                 out_fn = argv[optind];
202                 out_file = fopen(out_fn, "w");
203                 if (!out_file) {
204                         com_err(argv[0], errno, "while opening %s for logdump",
205                                 out_fn);
206                         goto cleanup;
207                 }
208         }
209
210         if (block_to_dump != ANY_BLOCK) {
211                 if (check_fs_open(argv[0]))
212                         goto cleanup;
213                 es = current_fs->super;
214                 group_to_dump = ((block_to_dump -
215                                   es->s_first_data_block)
216                                  / es->s_blocks_per_group);
217                 bitmap_to_dump = ext2fs_block_bitmap_loc(current_fs, group_to_dump);
218         }
219
220         if (journal_fn) {
221                 /* Set up to read journal from a regular file somewhere */
222                 journal_fd = open(journal_fn, O_RDONLY, 0);
223                 if (journal_fd < 0) {
224                         com_err(argv[0], errno, "while opening %s for logdump",
225                                 journal_fn);
226                         goto cleanup;
227                 }
228                 journal_source.where = JOURNAL_IS_EXTERNAL;
229                 journal_source.fd = journal_fd;
230                 dump_journal(argv[0], out_file, &journal_source);
231                 goto cleanup;
232
233         }
234         if (check_fs_open(argv[0]))
235                 goto cleanup;
236         es = current_fs->super;
237
238         if ((journal_inum = es->s_journal_inum)) {
239                 if (use_sb) {
240                         if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
241                                 com_err(argv[0], 0,
242                                         "no journal backup in super block\n");
243                                 goto cleanup;
244                         }
245                         memset(&journal_inode, 0, sizeof(struct ext2_inode));
246                         memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
247                                EXT2_N_BLOCKS*4);
248                         journal_inode.i_size_high = es->s_jnl_blocks[15];
249                         journal_inode.i_size = es->s_jnl_blocks[16];
250                         journal_inode.i_links_count = 1;
251                         journal_inode.i_mode = LINUX_S_IFREG | 0600;
252                 } else {
253                         if (debugfs_read_inode(journal_inum, &journal_inode,
254                                                argv[0]))
255                                 goto cleanup;
256                 }
257
258                 retval = ext2fs_file_open2(current_fs, journal_inum,
259                                            &journal_inode, 0, &journal_file);
260                 if (retval) {
261                         com_err(argv[0], retval, "while opening ext2 file");
262                         goto cleanup;
263                 }
264                 journal_source.where = JOURNAL_IS_INTERNAL;
265                 journal_source.file = journal_file;
266         } else {
267                 char uuid[37];
268
269                 uuid_unparse(es->s_journal_uuid, uuid);
270                 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
271                 if (!journal_fn)
272                                 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
273                 if (!journal_fn) {
274                         com_err(argv[0], 0, "filesystem has no journal");
275                         goto cleanup;
276                 }
277                 journal_fd = open(journal_fn, O_RDONLY, 0);
278                 if (journal_fd < 0) {
279                         com_err(argv[0], errno, "while opening %s for logdump",
280                                 journal_fn);
281                         free(journal_fn);
282                         goto cleanup;
283                 }
284                 fprintf(out_file, "Using external journal found at %s\n",
285                         journal_fn);
286                 free(journal_fn);
287                 journal_source.where = JOURNAL_IS_EXTERNAL;
288                 journal_source.fd = journal_fd;
289         }
290         dump_journal(argv[0], out_file, &journal_source);
291 cleanup:
292         if (journal_fd >= 0)
293                 close(journal_fd);
294         if (journal_file)
295                 ext2fs_file_close(journal_file);
296         if (out_file && (out_file != stdout))
297                 fclose(out_file);
298
299         return;
300
301 print_usage:
302         fprintf(stderr, "%s: Usage: logdump [-acsOS] [-n<num_trans>] [-b<block>] [-i<filespec>]\n\t"
303                 "[-f<journal_file>] [output_file]\n", argv[0]);
304 }
305
306
307 static int read_journal_block(const char *cmd, struct journal_source *source,
308                               ext2_loff_t offset, char *buf, unsigned int size)
309 {
310         int retval;
311         unsigned int got;
312
313         if (source->where == JOURNAL_IS_EXTERNAL) {
314                 if (lseek(source->fd, offset, SEEK_SET) < 0) {
315                         retval = errno;
316                         goto seek_err;
317                 }
318                 retval = read(source->fd, buf, size);
319                 if (retval < 0) {
320                         retval = errno;
321                         goto read_err;
322                 }
323                 got = retval;
324                 retval = 0;
325         } else {
326                 retval = ext2fs_file_llseek(source->file, offset,
327                                             EXT2_SEEK_SET, NULL);
328                 if (retval) {
329                 seek_err:
330                         com_err(cmd, retval, "while seeking in reading journal");
331                         return retval;
332                 }
333                 retval = ext2fs_file_read(source->file, buf, size, &got);
334                 if (retval) {
335                 read_err:
336                         com_err(cmd, retval, "while reading journal");
337                         return retval;
338                 }
339         }
340         if (got != size) {
341                 com_err(cmd, 0, "short read (read %u, expected %u) "
342                         "while reading journal", got, size);
343                 retval = -1;
344         }
345         return retval;
346 }
347
348 static const char *type_to_name(int btype)
349 {
350         switch (btype) {
351         case JBD2_DESCRIPTOR_BLOCK:
352                 return "descriptor block";
353         case JBD2_COMMIT_BLOCK:
354                 return "commit block";
355         case JBD2_SUPERBLOCK_V1:
356                 return "V1 superblock";
357         case JBD2_SUPERBLOCK_V2:
358                 return "V2 superblock";
359         case JBD2_REVOKE_BLOCK:
360                 return "revoke table";
361         }
362         return "unrecognised type";
363 }
364
365
366 static void dump_journal(char *cmdname, FILE *out_file,
367                          struct journal_source *source)
368 {
369         struct ext2_super_block *sb;
370         char                    jsb_buffer[1024];
371         char                    buf[EXT2_MAX_BLOCK_SIZE];
372         journal_superblock_t    *jsb;
373         unsigned int            blocksize = 1024;
374         int                     retval;
375         __u32                   magic, sequence, blocktype;
376         journal_header_t        *header;
377         tid_t                   transaction;
378         unsigned int            blocknr = 0;
379         int                     fc_done;
380         __u64                   total_len;
381         __u32                   maxlen;
382         int64_t                 cur_counts = 0;
383         bool                    exist_no_magic = false;
384
385         /* First, check to see if there's an ext2 superblock header */
386         retval = read_journal_block(cmdname, source, 0, buf, 2048);
387         if (retval)
388                 return;
389
390         jsb = (journal_superblock_t *) buf;
391         sb = (struct ext2_super_block *) (buf+1024);
392 #ifdef WORDS_BIGENDIAN
393         if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
394                 ext2fs_swap_super(sb);
395 #endif
396
397         if ((be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) &&
398             (sb->s_magic == EXT2_SUPER_MAGIC) &&
399             ext2fs_has_feature_journal_dev(sb)) {
400                 blocksize = EXT2_BLOCK_SIZE(sb);
401                 blocknr = (blocksize == 1024) ? 2 : 1;
402                 uuid_unparse(sb->s_uuid, jsb_buffer);
403                 fprintf(out_file, "Ext2 superblock header found.\n");
404                 if (dump_all) {
405                         fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
406                         fprintf(out_file, "\tblocksize=%d\n", blocksize);
407                         fprintf(out_file, "\tjournal data size %lu\n",
408                                 (unsigned long) ext2fs_blocks_count(sb));
409                 }
410         }
411
412         /* Next, read the journal superblock */
413         retval = read_journal_block(cmdname, source,
414                                     ((ext2_loff_t) blocknr) * blocksize,
415                                     jsb_buffer, 1024);
416         if (retval)
417                 return;
418
419         if (dump_super) {
420                 e2p_list_journal_super(out_file, jsb_buffer,
421                                        current_fs->blocksize, 0);
422                 fputc('\n', out_file);
423         }
424
425         jsb = (journal_superblock_t *) jsb_buffer;
426         if (be32_to_cpu(jsb->s_header.h_magic) != JBD2_MAGIC_NUMBER) {
427                 fprintf(out_file,
428                         "Journal superblock magic number invalid!\n");
429                 return;
430         }
431         blocksize = be32_to_cpu(jsb->s_blocksize);
432         if ((current_fs && (blocksize != current_fs->blocksize)) ||
433             (!current_fs && (!blocksize || (blocksize & (blocksize - 1)) ||
434                              (blocksize > EXT2_MAX_BLOCK_SIZE)))) {
435                 fprintf(out_file,
436                         "Journal block size invalid: %u (%u)\n",
437                         be32_to_cpu(jsb->s_blocksize), blocksize);
438                 return;
439         }
440         transaction = be32_to_cpu(jsb->s_sequence);
441         blocknr = be32_to_cpu(jsb->s_start);
442         if (source->where == JOURNAL_IS_INTERNAL) {
443                 retval = ext2fs_file_get_lsize(source->file, &total_len);
444                 if (retval) {
445                 stat_err:
446                         com_err("dump_journal", retval,
447                                 "while getting journal inode size");
448                         return;
449                 }
450                 total_len /= blocksize;
451         } else {
452                         struct stat st;
453
454                         if (fstat(source->fd, &st) < 0)
455                                 goto stat_err;
456                         total_len = st.st_size / blocksize;
457         }
458         maxlen = be32_to_cpu(jsb->s_maxlen);
459         if (maxlen > total_len)
460                 maxlen = total_len;
461
462         fprintf(out_file, "Journal starts at block %u, transaction %u\n",
463                 blocknr, transaction);
464
465         if (!blocknr) {
466                 /* Empty journal, nothing to do. */
467                 if (!dump_old)
468                         goto fc;
469                 else
470                         blocknr = 1;
471         }
472
473         while (1) {
474                 if (dump_old && (dump_counts != -1) && (cur_counts >= dump_counts))
475                         break;
476
477                 retval = read_journal_block(cmdname, source,
478                                 ((ext2_loff_t) blocknr) * blocksize,
479                                 buf, blocksize);
480                 if (retval)
481                         break;
482
483                 header = (journal_header_t *) buf;
484
485                 magic = be32_to_cpu(header->h_magic);
486                 sequence = be32_to_cpu(header->h_sequence);
487                 blocktype = be32_to_cpu(header->h_blocktype);
488
489                 if (magic != JBD2_MAGIC_NUMBER) {
490                         if (exist_no_magic == false) {
491                                 exist_no_magic = true;
492                                 fprintf(out_file, "No magic number at block %u: "
493                                         "end of journal.\n", blocknr);
494                         }
495                         if (dump_old && (dump_counts != -1)) {
496                                 blocknr++;
497                                 WRAP(jsb, blocknr, maxlen);
498                                 continue;
499                         }
500                         break;
501                 }
502
503                 if (sequence != transaction) {
504                         fprintf (out_file, "Found sequence %u (not %u) at "
505                                  "block %u: end of journal.\n",
506                                  sequence, transaction, blocknr);
507                         if (!dump_old)
508                                 break;
509                 }
510
511                 if (dump_descriptors) {
512                         fprintf (out_file, "Found expected sequence %u, "
513                                  "type %u (%s) at block %u\n",
514                                  sequence, blocktype,
515                                  type_to_name(blocktype), blocknr);
516                 }
517
518                 switch (blocktype) {
519                 case JBD2_DESCRIPTOR_BLOCK:
520                         dump_descriptor_block(out_file, source, buf, jsb,
521                                               &blocknr, blocksize, maxlen,
522                                               transaction);
523                         continue;
524
525                 case JBD2_COMMIT_BLOCK:
526                         cur_counts++;
527                         transaction++;
528                         blocknr++;
529                         WRAP(jsb, blocknr, maxlen);
530                         continue;
531
532                 case JBD2_REVOKE_BLOCK:
533                         dump_revoke_block(out_file, buf, jsb,
534                                           blocknr, blocksize,
535                                           transaction);
536                         blocknr++;
537                         WRAP(jsb, blocknr, maxlen);
538                         continue;
539
540                 default:
541                         fprintf (out_file, "Unexpected block type %u at "
542                                  "block %u.\n", blocktype, blocknr);
543                         break;
544                 }
545         }
546
547 fc:
548         blocknr = maxlen - jbd2_journal_get_num_fc_blks(jsb) + 1;
549         while (blocknr <= maxlen) {
550                 retval = read_journal_block(cmdname, source,
551                                 ((ext2_loff_t) blocknr) * blocksize,
552                                 buf, blocksize);
553                 if (retval)
554                         return;
555
556                 dump_fc_block(out_file, buf, blocksize, transaction, &fc_done);
557                 if (!dump_old && fc_done)
558                         break;
559                 blocknr++;
560         }
561 }
562
563 static inline size_t journal_super_tag_bytes(journal_superblock_t *jsb)
564 {
565         size_t sz;
566
567         if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3))
568                 return sizeof(journal_block_tag3_t);
569
570         sz = sizeof(journal_block_tag_t);
571
572         if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
573                 sz += sizeof(__u16);
574
575         if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_64BIT))
576                 return sz;
577
578         return sz - sizeof(__u32);
579 }
580
581 static void dump_fc_block(FILE *out_file, char *buf, int blocksize,
582                           tid_t transaction, int *fc_done)
583 {
584         struct ext4_fc_tl       tl;
585         struct ext4_fc_head     *head;
586         struct ext4_fc_add_range        *add_range;
587         struct ext4_fc_del_range        *del_range;
588         struct ext4_fc_dentry_info      *dentry_info;
589         struct ext4_fc_tail             *tail;
590         struct ext3_extent      *ex;
591         __u8                    *cur, *val;
592
593         *fc_done = 0;
594         for (cur = (__u8 *)buf; cur < (__u8 *)buf + blocksize;
595              cur = cur + sizeof(tl) + le16_to_cpu(tl.fc_len)) {
596                 memcpy(&tl, cur, sizeof(tl));
597                 val = cur + sizeof(tl);
598
599                 switch (le16_to_cpu(tl.fc_tag)) {
600                 case EXT4_FC_TAG_ADD_RANGE:
601                         add_range = (struct ext4_fc_add_range *)val;
602                         ex = (struct ext3_extent *)add_range->fc_ex;
603                         fprintf(out_file,
604                                 "tag %s, inode %d, lblk %u, pblk %llu, len %lu\n",
605                                 tag2str(tl.fc_tag),
606                                 le32_to_cpu(add_range->fc_ino),
607                                 le32_to_cpu(ex->ee_block),
608                                 le32_to_cpu(ex->ee_start) +
609                                 (((unsigned long long) le16_to_cpu(ex->ee_start_hi)) << 32),
610                                 le16_to_cpu(ex->ee_len) > EXT_INIT_MAX_LEN ?
611                                 le16_to_cpu(ex->ee_len) - EXT_INIT_MAX_LEN :
612                                 le16_to_cpu(ex->ee_len));
613                         break;
614                 case EXT4_FC_TAG_DEL_RANGE:
615                         del_range = (struct ext4_fc_del_range *)val;
616                         fprintf(out_file, "tag %s, inode %d, lblk %d, len %d\n",
617                                 tag2str(tl.fc_tag),
618                                 le32_to_cpu(del_range->fc_ino),
619                                 le32_to_cpu(del_range->fc_lblk),
620                                 le32_to_cpu(del_range->fc_len));
621                         break;
622                 case EXT4_FC_TAG_LINK:
623                 case EXT4_FC_TAG_UNLINK:
624                 case EXT4_FC_TAG_CREAT:
625                         dentry_info = (struct ext4_fc_dentry_info *)val;
626                         fprintf(out_file,
627                                 "tag %s, parent %d, ino %d, name \"%s\"\n",
628                                 tag2str(tl.fc_tag),
629                                 le32_to_cpu(dentry_info->fc_parent_ino),
630                                 le32_to_cpu(dentry_info->fc_ino),
631                                 dentry_info->fc_dname);
632                         break;
633                 case EXT4_FC_TAG_INODE:
634                         fprintf(out_file, "tag %s, inode %d\n",
635                                 tag2str(tl.fc_tag),
636                                 le32_to_cpu(((struct ext4_fc_inode *)val)->fc_ino));
637                         break;
638                 case EXT4_FC_TAG_PAD:
639                         fprintf(out_file, "tag %s\n", tag2str(tl.fc_tag));
640                         break;
641                 case EXT4_FC_TAG_TAIL:
642                         tail = (struct ext4_fc_tail *)val;
643                         fprintf(out_file, "tag %s, tid %d\n",
644                                 tag2str(tl.fc_tag),
645                                 le32_to_cpu(tail->fc_tid));
646                         if (!dump_old &&
647                                 le32_to_cpu(tail->fc_tid) < transaction) {
648                                 *fc_done = 1;
649                                 return;
650                         }
651                         break;
652                 case EXT4_FC_TAG_HEAD:
653                         fprintf(out_file, "\n*** Fast Commit Area ***\n");
654                         head = (struct ext4_fc_head *)val;
655                         fprintf(out_file, "tag %s, features 0x%x, tid %d\n",
656                                 tag2str(tl.fc_tag),
657                                 le32_to_cpu(head->fc_features),
658                                 le32_to_cpu(head->fc_tid));
659                         if (!dump_old &&
660                                 le32_to_cpu(head->fc_tid) < transaction) {
661                                 *fc_done = 1;
662                                 return;
663                         }
664                         break;
665                 default:
666                         *fc_done = 1;
667                         break;
668                 }
669         }
670 }
671
672 static void dump_descriptor_block(FILE *out_file,
673                                   struct journal_source *source,
674                                   char *buf,
675                                   journal_superblock_t *jsb,
676                                   unsigned int *blockp, unsigned blocksize,
677                                   __u32 maxlen,
678                                   tid_t transaction)
679 {
680         unsigned                offset, tag_size, csum_size = 0;
681         char                    *tagp;
682         journal_block_tag_t     *tag;
683         unsigned int            blocknr;
684         __u32                   tag_block;
685         __u32                   tag_flags;
686
687         tag_size = journal_super_tag_bytes(jsb);
688         offset = sizeof(journal_header_t);
689         blocknr = *blockp;
690
691         if (JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V3) ||
692             JSB_HAS_INCOMPAT_FEATURE(jsb, JBD2_FEATURE_INCOMPAT_CSUM_V2))
693                 csum_size = sizeof(struct jbd2_journal_block_tail);
694
695         if (dump_all)
696                 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
697                         "block %u:\n", transaction, blocknr);
698
699         ++blocknr;
700         WRAP(jsb, blocknr, maxlen);
701
702         do {
703                 /* Work out the location of the current tag, and skip to
704                  * the next one... */
705                 tagp = &buf[offset];
706                 tag = (journal_block_tag_t *) tagp;
707                 offset += tag_size;
708
709                 /* ... and if we have gone too far, then we've reached the
710                    end of this block. */
711                 if (offset > blocksize - csum_size)
712                         break;
713
714                 tag_block = be32_to_cpu(tag->t_blocknr);
715                 tag_flags = be16_to_cpu(tag->t_flags);
716
717                 if (!(tag_flags & JBD2_FLAG_SAME_UUID))
718                         offset += 16;
719
720                 dump_metadata_block(out_file, source, jsb,
721                                     blocknr, tag_block, tag_flags, blocksize,
722                                     transaction);
723
724                 ++blocknr;
725                 WRAP(jsb, blocknr, maxlen);
726
727         } while (!(tag_flags & JBD2_FLAG_LAST_TAG));
728
729         *blockp = blocknr;
730 }
731
732
733 static void dump_revoke_block(FILE *out_file, char *buf,
734                               journal_superblock_t *jsb EXT2FS_ATTR((unused)),
735                               unsigned int blocknr,
736                               unsigned int blocksize,
737                               tid_t transaction)
738 {
739         unsigned int            offset, max;
740         jbd2_journal_revoke_header_t *header;
741         unsigned long long      rblock;
742         int                     tag_size = sizeof(__u32);
743
744         if (dump_all)
745                 fprintf(out_file, "Dumping revoke block, sequence %u, at "
746                         "block %u:\n", transaction, blocknr);
747
748         if (be32_to_cpu(jsb->s_feature_incompat) & JBD2_FEATURE_INCOMPAT_64BIT)
749                 tag_size = sizeof(__u64);
750
751         header = (jbd2_journal_revoke_header_t *) buf;
752         offset = sizeof(jbd2_journal_revoke_header_t);
753         max = be32_to_cpu(header->r_count);
754         if (max > blocksize) {
755                 fprintf(out_file, "Revoke block's r_count invalid: %u\b",
756                         max);
757                 max = blocksize;
758         }
759
760         while (offset < max) {
761                 if (tag_size == sizeof(__u32)) {
762                         __u32 *entry = (__u32 *) (buf + offset);
763                         rblock = be32_to_cpu(*entry);
764                 } else {
765                         __u64 *entry = (__u64 *) (buf + offset);
766                         rblock = ext2fs_be64_to_cpu(*entry);
767                 }
768                 if (dump_all || rblock == block_to_dump) {
769                         fprintf(out_file, "  Revoke FS block %llu",
770                                 (unsigned long long) rblock);
771                         if (dump_all)
772                                 fprintf(out_file, "\n");
773                         else
774                                 fprintf(out_file," at block %u, sequence %u\n",
775                                         blocknr, transaction);
776                 }
777                 offset += tag_size;
778         }
779 }
780
781
782 static void show_extent(FILE *out_file, int start_extent, int end_extent,
783                         __u32 first_block)
784 {
785         if (start_extent >= 0 && first_block != 0)
786                 fprintf(out_file, "(%d+%u): %u ",
787                         start_extent, end_extent-start_extent, first_block);
788 }
789
790 static void show_indirect(FILE *out_file, const char *name, __u32 where)
791 {
792         if (where)
793                 fprintf(out_file, "(%s): %u ", name, where);
794 }
795
796
797 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
798                                 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
799                                 unsigned int log_blocknr,
800                                 unsigned int fs_blocknr,
801                                 unsigned int log_tag_flags,
802                                 unsigned int blocksize,
803                                 tid_t transaction)
804 {
805         int             retval;
806         char            buf[EXT2_MAX_BLOCK_SIZE];
807
808         if (!(dump_all
809               || (fs_blocknr == block_to_dump)
810               || (fs_blocknr == inode_block_to_dump)
811               || (fs_blocknr == bitmap_to_dump)))
812                 return;
813
814         fprintf(out_file, "  FS block %u logged at ", fs_blocknr);
815         if (!dump_all)
816                 fprintf(out_file, "sequence %u, ", transaction);
817         fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
818                 log_tag_flags);
819
820         /* There are two major special cases to parse:
821          *
822          * If this block is a block
823          * bitmap block, we need to give it special treatment so that we
824          * can log any allocates and deallocates which affect the
825          * block_to_dump query block.
826          *
827          * If the block is an inode block for the inode being searched
828          * for, then we need to dump the contents of that inode
829          * structure symbolically.
830          */
831
832         if (!(dump_contents && dump_all)
833             && fs_blocknr != block_to_dump
834             && fs_blocknr != bitmap_to_dump
835             && fs_blocknr != inode_block_to_dump)
836                 return;
837
838         retval = read_journal_block("logdump", source,
839                                     ((ext2_loff_t) log_blocknr) * blocksize,
840                                     buf, blocksize);
841         if (retval)
842                 return;
843
844         if (fs_blocknr == bitmap_to_dump) {
845                 struct ext2_super_block *super;
846                 int offset;
847
848                 super = current_fs->super;
849                 offset = ((block_to_dump - super->s_first_data_block) %
850                           super->s_blocks_per_group);
851
852                 fprintf(out_file, "    (block bitmap for block %llu: "
853                         "block is %s)\n",
854                         (unsigned long long) block_to_dump,
855                         ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
856         }
857
858         if (fs_blocknr == inode_block_to_dump) {
859                 struct ext2_inode *inode;
860                 int first, prev, this, start_extent, i;
861
862                 fprintf(out_file, "    (inode block for inode %u):\n",
863                         inode_to_dump);
864
865                 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
866                 internal_dump_inode(out_file, "    ", inode_to_dump, inode, 0);
867
868                 /* Dump out the direct/indirect blocks here:
869                  * internal_dump_inode can only dump them from the main
870                  * on-disk inode, not from the journaled copy of the
871                  * inode. */
872
873                 fprintf (out_file, "    Blocks:  ");
874                 first = prev = start_extent = -1;
875
876                 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
877                         this = inode->i_block[i];
878                         if (start_extent >= 0  && this == prev+1) {
879                                 prev = this;
880                                 continue;
881                         } else {
882                                 show_extent(out_file, start_extent, i, first);
883                                 start_extent = i;
884                                 first = prev = this;
885                         }
886                 }
887                 show_extent(out_file, start_extent, i, first);
888                 show_indirect(out_file, "IND", inode->i_block[i++]);
889                 show_indirect(out_file, "DIND", inode->i_block[i++]);
890                 show_indirect(out_file, "TIND", inode->i_block[i++]);
891
892                 fprintf(out_file, "\n");
893         }
894
895         if (dump_contents)
896                 do_hexdump(out_file, buf, blocksize);
897
898 }
899
900 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
901 {
902         int i,j;
903         int *intp;
904         char *charp;
905         unsigned char c;
906
907         intp = (int *) buf;
908         charp = (char *) buf;
909
910         for (i=0; i<blocksize; i+=16) {
911                 fprintf(out_file, "    %04x:  ", i);
912                 for (j=0; j<16; j+=4)
913                         fprintf(out_file, "%08x ", *intp++);
914                 for (j=0; j<16; j++) {
915                         c = *charp++;
916                         if (c < ' ' || c >= 127)
917                                 c = '.';
918                         fprintf(out_file, "%c", c);
919                 }
920                 fprintf(out_file, "\n");
921         }
922 }
923