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