Whamcloud - gitweb
TT-177 build: add .spec file for SLES11 packaging
[tools/e2fsprogs.git] / debugfs / logdump.c
1 /*
2  * logdump.c --- dump the contents of the journal out to a file
3  *
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.
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 <uuid/uuid.h>
37
38 enum journal_location {JOURNAL_IS_INTERNAL, JOURNAL_IS_EXTERNAL};
39
40 #define ANY_BLOCK ((blk64_t) -1)
41
42 static int              dump_all, 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;
46
47 struct journal_source
48 {
49         enum journal_location where;
50         int fd;
51         ext2_file_t file;
52 };
53
54 static void dump_journal(char *, FILE *, struct journal_source *);
55
56 static void dump_descriptor_block(FILE *, struct journal_source *,
57                                   char *, journal_superblock_t *,
58                                   unsigned int *, int, tid_t);
59
60 static void dump_revoke_block(FILE *, char *, journal_superblock_t *,
61                                   unsigned int, int, tid_t);
62
63 static void dump_metadata_block(FILE *, struct journal_source *,
64                                 journal_superblock_t*,
65                                 unsigned int, unsigned int, unsigned int,
66                                 int, tid_t);
67
68 static void do_hexdump (FILE *, char *, int);
69
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));
74
75 void do_logdump(int argc, char **argv)
76 {
77         int             c;
78         int             retval;
79         char            *out_fn;
80         FILE            *out_file;
81
82         char            *inode_spec = NULL;
83         char            *journal_fn = NULL;
84         int             journal_fd = 0;
85         int             use_sb = 0;
86         ext2_ino_t      journal_inum;
87         struct ext2_inode journal_inode;
88         ext2_file_t     journal_file;
89         char            *tmp;
90         struct journal_source journal_source;
91         struct ext2_super_block *es = NULL;
92
93         journal_source.where = JOURNAL_IS_INTERNAL;
94         journal_source.fd = 0;
95         journal_source.file = 0;
96         dump_all = 0;
97         dump_contents = 0;
98         dump_descriptors = 1;
99         block_to_dump = ANY_BLOCK;
100         bitmap_to_dump = -1;
101         inode_block_to_dump = ANY_BLOCK;
102         inode_to_dump = -1;
103
104         reset_getopt();
105         while ((c = getopt (argc, argv, "ab:ci:f:s")) != EOF) {
106                 switch (c) {
107                 case 'a':
108                         dump_all++;
109                         break;
110                 case 'b':
111                         block_to_dump = strtoul(optarg, &tmp, 0);
112                         if (*tmp) {
113                                 com_err(argv[0], 0,
114                                         "Bad block number - %s", optarg);
115                                 return;
116                         }
117                         dump_descriptors = 0;
118                         break;
119                 case 'c':
120                         dump_contents++;
121                         break;
122                 case 'f':
123                         journal_fn = optarg;
124                         break;
125                 case 'i':
126                         inode_spec = optarg;
127                         dump_descriptors = 0;
128                         break;
129                 case 's':
130                         use_sb++;
131                         break;
132                 default:
133                         goto print_usage;
134                 }
135         }
136         if (optind != argc && optind != argc-1) {
137                 goto print_usage;
138         }
139
140         if (current_fs)
141                 es = current_fs->super;
142
143         if (inode_spec) {
144                 int inode_group, group_offset, inodes_per_block;
145
146                 if (check_fs_open(argv[0]))
147                         return;
148
149                 inode_to_dump = string_to_inode(inode_spec);
150                 if (!inode_to_dump)
151                         return;
152
153                 inode_group = ((inode_to_dump - 1)
154                                / es->s_inodes_per_group);
155                 group_offset = ((inode_to_dump - 1)
156                                 % es->s_inodes_per_group);
157                 inodes_per_block = (current_fs->blocksize
158                                     / sizeof(struct ext2_inode));
159
160                 inode_block_to_dump =
161                         ext2fs_inode_table_loc(current_fs, inode_group) +
162                         (group_offset / inodes_per_block);
163                 inode_offset_to_dump = ((group_offset % inodes_per_block)
164                                         * sizeof(struct ext2_inode));
165                 printf("Inode %u is at group %u, block %llu, offset %u\n",
166                        inode_to_dump, inode_group,
167                        inode_block_to_dump, inode_offset_to_dump);
168         }
169
170         if (optind == argc) {
171                 out_file = stdout;
172         } else {
173                 out_fn = argv[optind];
174                 out_file = fopen(out_fn, "w");
175                 if (!out_file) {
176                         com_err(argv[0], errno, "while opening %s for logdump",
177                                 out_fn);
178                         goto errout;
179                 }
180         }
181
182         if (block_to_dump != ANY_BLOCK && current_fs != NULL) {
183                 group_to_dump = ((block_to_dump -
184                                   es->s_first_data_block)
185                                  / es->s_blocks_per_group);
186                 bitmap_to_dump = ext2fs_block_bitmap_loc(current_fs, group_to_dump);
187         }
188
189         if (!journal_fn && check_fs_open(argv[0]))
190                 goto errout;
191
192         if (journal_fn) {
193                 /* Set up to read journal from a regular file somewhere */
194                 journal_fd = open(journal_fn, O_RDONLY, 0);
195                 if (journal_fd < 0) {
196                         com_err(argv[0], errno, "while opening %s for logdump",
197                                 journal_fn);
198                         goto errout;
199                 }
200
201                 journal_source.where = JOURNAL_IS_EXTERNAL;
202                 journal_source.fd = journal_fd;
203         } else if ((journal_inum = es->s_journal_inum)) {
204                 if (use_sb) {
205                         if (es->s_jnl_backup_type != EXT3_JNL_BACKUP_BLOCKS) {
206                                 com_err(argv[0], 0,
207                                         "no journal backup in super block\n");
208                                 goto errout;
209                         }
210                         memset(&journal_inode, 0, sizeof(struct ext2_inode));
211                         memcpy(&journal_inode.i_block[0], es->s_jnl_blocks,
212                                EXT2_N_BLOCKS*4);
213                         journal_inode.i_size_high = es->s_jnl_blocks[15];
214                         journal_inode.i_size = es->s_jnl_blocks[16];
215                         journal_inode.i_links_count = 1;
216                         journal_inode.i_mode = LINUX_S_IFREG | 0600;
217                 } else {
218                         if (debugfs_read_inode(journal_inum, &journal_inode,
219                                                argv[0]))
220                                 goto errout;
221                 }
222
223                 retval = ext2fs_file_open2(current_fs, journal_inum,
224                                            &journal_inode, 0, &journal_file);
225                 if (retval) {
226                         com_err(argv[0], retval, "while opening ext2 file");
227                         goto errout;
228                 }
229                 journal_source.where = JOURNAL_IS_INTERNAL;
230                 journal_source.file = journal_file;
231         } else {
232                 char uuid[37];
233
234                 uuid_unparse(es->s_journal_uuid, uuid);
235                 journal_fn = blkid_get_devname(NULL, "UUID", uuid);
236                 if (!journal_fn)
237                                 journal_fn = blkid_devno_to_devname(es->s_journal_dev);
238                 if (!journal_fn) {
239                         com_err(argv[0], 0, "filesystem has no journal");
240                         goto errout;
241                 }
242                 journal_fd = open(journal_fn, O_RDONLY, 0);
243                 if (journal_fd < 0) {
244                         com_err(argv[0], errno, "while opening %s for logdump",
245                                 journal_fn);
246                         free(journal_fn);
247                         goto errout;
248                 }
249                 fprintf(out_file, "Using external journal found at %s\n",
250                         journal_fn);
251                 free(journal_fn);
252                 journal_source.where = JOURNAL_IS_EXTERNAL;
253                 journal_source.fd = journal_fd;
254         }
255
256         dump_journal(argv[0], out_file, &journal_source);
257
258         if (journal_source.where == JOURNAL_IS_INTERNAL)
259                 ext2fs_file_close(journal_file);
260         else
261                 close(journal_fd);
262
263 errout:
264         if (out_file && (out_file != stdout))
265                 fclose(out_file);
266
267         return;
268
269 print_usage:
270         fprintf(stderr, "%s: Usage: logdump [-acs] [-b<block>] [-i<filespec>]\n\t"
271                 "[-f<journal_file>] [output_file]\n", argv[0]);
272 }
273
274
275 static int read_journal_block(const char *cmd, struct journal_source *source,
276                               off_t offset, char *buf, unsigned int size)
277 {
278         int retval;
279         unsigned int got;
280
281         if (source->where == JOURNAL_IS_EXTERNAL) {
282                 if (lseek(source->fd, offset, SEEK_SET) < 0) {
283                         retval = errno;
284                         goto seek_err;
285                 }
286                 retval = read(source->fd, buf, size);
287                 if (retval < 0) {
288                         retval = errno;
289                         goto read_err;
290                 }
291                 got = retval;
292                 retval = 0;
293         } else {
294                 retval = ext2fs_file_lseek(source->file, offset,
295                                            EXT2_SEEK_SET, NULL);
296                 if (retval) {
297                 seek_err:
298                         com_err(cmd, retval, "while seeking in reading journal");
299                         return retval;
300                 }
301                 retval = ext2fs_file_read(source->file, buf, size, &got);
302                 if (retval) {
303                 read_err:
304                         com_err(cmd, retval, "while reading journal");
305                         return retval;
306                 }
307         }
308         if (got != size) {
309                 com_err(cmd, 0, "short read (read %u, expected %u) "
310                         "while reading journal", got, size);
311                 retval = -1;
312         }
313         return retval;
314 }
315
316 static const char *type_to_name(int btype)
317 {
318         switch (btype) {
319         case JFS_DESCRIPTOR_BLOCK:
320                 return "descriptor block";
321         case JFS_COMMIT_BLOCK:
322                 return "commit block";
323         case JFS_SUPERBLOCK_V1:
324                 return "V1 superblock";
325         case JFS_SUPERBLOCK_V2:
326                 return "V2 superblock";
327         case JFS_REVOKE_BLOCK:
328                 return "revoke table";
329         }
330         return "unrecognised type";
331 }
332
333
334 static void dump_journal(char *cmdname, FILE *out_file,
335                          struct journal_source *source)
336 {
337         struct ext2_super_block *sb;
338         char                    jsb_buffer[1024];
339         char                    buf[8192];
340         journal_superblock_t    *jsb;
341         unsigned int            blocksize = 1024;
342         int                     retval;
343         __u32                   magic, sequence, blocktype;
344         journal_header_t        *header;
345
346         tid_t                   transaction;
347         unsigned int            blocknr = 0;
348
349         /* First, check to see if there's an ext2 superblock header */
350         retval = read_journal_block(cmdname, source, 0, buf, 2048);
351         if (retval)
352                 return;
353
354         jsb = (journal_superblock_t *) buf;
355         sb = (struct ext2_super_block *) (buf+1024);
356 #ifdef WORDS_BIGENDIAN
357         if (sb->s_magic == ext2fs_swab16(EXT2_SUPER_MAGIC))
358                 ext2fs_swap_super(sb);
359 #endif
360
361         if ((be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) &&
362             (sb->s_magic == EXT2_SUPER_MAGIC) &&
363             (sb->s_feature_incompat & EXT3_FEATURE_INCOMPAT_JOURNAL_DEV)) {
364                 blocksize = EXT2_BLOCK_SIZE(sb);
365                 blocknr = (blocksize == 1024) ? 2 : 1;
366                 uuid_unparse(sb->s_uuid, jsb_buffer);
367                 fprintf(out_file, "Ext2 superblock header found.\n");
368                 if (dump_all) {
369                         fprintf(out_file, "\tuuid=%s\n", jsb_buffer);
370                         fprintf(out_file, "\tblocksize=%d\n", blocksize);
371                         fprintf(out_file, "\tjournal data size %lu\n",
372                                 (unsigned long) ext2fs_blocks_count(sb));
373                 }
374         }
375
376         /* Next, read the journal superblock */
377
378         retval = read_journal_block(cmdname, source, blocknr*blocksize,
379                                     jsb_buffer, 1024);
380         if (retval)
381                 return;
382
383         jsb = (journal_superblock_t *) jsb_buffer;
384         if (be32_to_cpu(jsb->s_header.h_magic) != JFS_MAGIC_NUMBER) {
385                 fprintf(out_file,
386                         "Journal superblock magic number invalid!\n");
387                 return;
388         }
389         blocksize = be32_to_cpu(jsb->s_blocksize);
390         transaction = be32_to_cpu(jsb->s_sequence);
391         blocknr = be32_to_cpu(jsb->s_start);
392
393         fprintf(out_file, "Journal starts at block %u, transaction %u\n",
394                 blocknr, transaction);
395
396         if (!blocknr)
397                 /* Empty journal, nothing to do. */
398                 return;
399
400         while (1) {
401                 retval = read_journal_block(cmdname, source,
402                                             blocknr*blocksize, buf,
403                                             blocksize);
404                 if (retval)
405                         return;
406
407                 header = (journal_header_t *) buf;
408
409                 magic = be32_to_cpu(header->h_magic);
410                 sequence = be32_to_cpu(header->h_sequence);
411                 blocktype = be32_to_cpu(header->h_blocktype);
412
413                 if (magic != JFS_MAGIC_NUMBER) {
414                         fprintf (out_file, "No magic number at block %u: "
415                                  "end of journal.\n", blocknr);
416                         return;
417                 }
418
419                 if (sequence != transaction) {
420                         fprintf (out_file, "Found sequence %u (not %u) at "
421                                  "block %u: end of journal.\n",
422                                  sequence, transaction, blocknr);
423                         return;
424                 }
425
426                 if (dump_descriptors) {
427                         fprintf (out_file, "Found expected sequence %u, "
428                                  "type %u (%s) at block %u\n",
429                                  sequence, blocktype,
430                                  type_to_name(blocktype), blocknr);
431                 }
432
433                 switch (blocktype) {
434                 case JFS_DESCRIPTOR_BLOCK:
435                         dump_descriptor_block(out_file, source, buf, jsb,
436                                               &blocknr, blocksize,
437                                               transaction);
438                         continue;
439
440                 case JFS_COMMIT_BLOCK:
441                         transaction++;
442                         blocknr++;
443                         WRAP(jsb, blocknr);
444                         continue;
445
446                 case JFS_REVOKE_BLOCK:
447                         dump_revoke_block(out_file, buf, jsb,
448                                           blocknr, blocksize,
449                                           transaction);
450                         blocknr++;
451                         WRAP(jsb, blocknr);
452                         continue;
453
454                 default:
455                         fprintf (out_file, "Unexpected block type %u at "
456                                  "block %u.\n", blocktype, blocknr);
457                         return;
458                 }
459         }
460 }
461
462
463 static void dump_descriptor_block(FILE *out_file,
464                                   struct journal_source *source,
465                                   char *buf,
466                                   journal_superblock_t *jsb,
467                                   unsigned int *blockp, int blocksize,
468                                   tid_t transaction)
469 {
470         int                     offset, tag_size = JBD_TAG_SIZE32;
471         char                    *tagp;
472         journal_block_tag_t     *tag;
473         unsigned int            blocknr;
474         __u32                   tag_block;
475         __u32                   tag_flags;
476
477         if (be32_to_cpu(jsb->s_feature_incompat) & JFS_FEATURE_INCOMPAT_64BIT)
478                 tag_size = JBD_TAG_SIZE64;
479
480         offset = sizeof(journal_header_t);
481         blocknr = *blockp;
482
483         if (dump_all)
484                 fprintf(out_file, "Dumping descriptor block, sequence %u, at "
485                         "block %u:\n", transaction, blocknr);
486
487         ++blocknr;
488         WRAP(jsb, blocknr);
489
490         do {
491                 /* Work out the location of the current tag, and skip to
492                  * the next one... */
493                 tagp = &buf[offset];
494                 tag = (journal_block_tag_t *) tagp;
495                 offset += tag_size;
496
497                 /* ... and if we have gone too far, then we've reached the
498                    end of this block. */
499                 if (offset > blocksize)
500                         break;
501
502                 tag_block = be32_to_cpu(tag->t_blocknr);
503                 tag_flags = be32_to_cpu(tag->t_flags);
504
505                 if (!(tag_flags & JFS_FLAG_SAME_UUID))
506                         offset += 16;
507
508                 dump_metadata_block(out_file, source, jsb,
509                                     blocknr, tag_block, tag_flags, blocksize,
510                                     transaction);
511
512                 ++blocknr;
513                 WRAP(jsb, blocknr);
514
515         } while (!(tag_flags & JFS_FLAG_LAST_TAG));
516
517         *blockp = blocknr;
518 }
519
520
521 static void dump_revoke_block(FILE *out_file, char *buf,
522                               journal_superblock_t *jsb EXT2FS_ATTR((unused)),
523                               unsigned int blocknr,
524                               int blocksize EXT2FS_ATTR((unused)),
525                               tid_t transaction)
526 {
527         int                     offset, max;
528         journal_revoke_header_t *header;
529         unsigned int            *entry, rblock;
530
531         if (dump_all)
532                 fprintf(out_file, "Dumping revoke block, sequence %u, at "
533                         "block %u:\n", transaction, blocknr);
534
535         header = (journal_revoke_header_t *) buf;
536         offset = sizeof(journal_revoke_header_t);
537         max = be32_to_cpu(header->r_count);
538
539         while (offset < max) {
540                 entry = (unsigned int *) (buf + offset);
541                 rblock = be32_to_cpu(*entry);
542                 if (dump_all || rblock == block_to_dump) {
543                         fprintf(out_file, "  Revoke FS block %u", rblock);
544                         if (dump_all)
545                                 fprintf(out_file, "\n");
546                         else
547                                 fprintf(out_file," at block %u, sequence %u\n",
548                                         blocknr, transaction);
549                 }
550                 offset += 4;
551         }
552 }
553
554
555 static void show_extent(FILE *out_file, int start_extent, int end_extent,
556                         __u32 first_block)
557 {
558         if (start_extent >= 0 && first_block != 0)
559                 fprintf(out_file, "(%d+%u): %u ",
560                         start_extent, end_extent-start_extent, first_block);
561 }
562
563 static void show_indirect(FILE *out_file, const char *name, __u32 where)
564 {
565         if (where)
566                 fprintf(out_file, "(%s): %u ", name, where);
567 }
568
569
570 static void dump_metadata_block(FILE *out_file, struct journal_source *source,
571                                 journal_superblock_t *jsb EXT2FS_ATTR((unused)),
572                                 unsigned int log_blocknr,
573                                 unsigned int fs_blocknr,
574                                 unsigned int log_tag_flags,
575                                 int blocksize,
576                                 tid_t transaction)
577 {
578         int             retval;
579         char            buf[8192];
580
581         if (!(dump_all
582               || (fs_blocknr == block_to_dump)
583               || (fs_blocknr == inode_block_to_dump)
584               || (fs_blocknr == bitmap_to_dump)))
585                 return;
586
587         fprintf(out_file, "  FS block %u logged at ", fs_blocknr);
588         if (!dump_all)
589                 fprintf(out_file, "sequence %u, ", transaction);
590         fprintf(out_file, "journal block %u (flags 0x%x)\n", log_blocknr,
591                 log_tag_flags);
592
593         /* There are two major special cases to parse:
594          *
595          * If this block is a block
596          * bitmap block, we need to give it special treatment so that we
597          * can log any allocates and deallocates which affect the
598          * block_to_dump query block.
599          *
600          * If the block is an inode block for the inode being searched
601          * for, then we need to dump the contents of that inode
602          * structure symbolically.
603          */
604
605         if (!(dump_contents && dump_all)
606             && fs_blocknr != block_to_dump
607             && fs_blocknr != bitmap_to_dump
608             && fs_blocknr != inode_block_to_dump)
609                 return;
610
611         retval = read_journal_block("logdump", source,
612                                     blocksize * log_blocknr,
613                                     buf, blocksize);
614         if (retval)
615                 return;
616
617         if (fs_blocknr == bitmap_to_dump) {
618                 struct ext2_super_block *super;
619                 int offset;
620
621                 super = current_fs->super;
622                 offset = ((block_to_dump - super->s_first_data_block) %
623                           super->s_blocks_per_group);
624
625                 fprintf(out_file, "    (block bitmap for block %llu: "
626                         "block is %s)\n",
627                         block_to_dump,
628                         ext2fs_test_bit(offset, buf) ? "SET" : "CLEAR");
629         }
630
631         if (fs_blocknr == inode_block_to_dump) {
632                 struct ext2_inode *inode;
633                 int first, prev, this, start_extent, i;
634
635                 fprintf(out_file, "    (inode block for inode %u):\n",
636                         inode_to_dump);
637
638                 inode = (struct ext2_inode *) (buf + inode_offset_to_dump);
639                 internal_dump_inode(out_file, "    ", inode_to_dump, inode, 0);
640
641                 /* Dump out the direct/indirect blocks here:
642                  * internal_dump_inode can only dump them from the main
643                  * on-disk inode, not from the journaled copy of the
644                  * inode. */
645
646                 fprintf (out_file, "    Blocks:  ");
647                 first = prev = start_extent = -1;
648
649                 for (i=0; i<EXT2_NDIR_BLOCKS; i++) {
650                         this = inode->i_block[i];
651                         if (start_extent >= 0  && this == prev+1) {
652                                 prev = this;
653                                 continue;
654                         } else {
655                                 show_extent(out_file, start_extent, i, first);
656                                 start_extent = i;
657                                 first = prev = this;
658                         }
659                 }
660                 show_extent(out_file, start_extent, i, first);
661                 show_indirect(out_file, "IND", inode->i_block[i++]);
662                 show_indirect(out_file, "DIND", inode->i_block[i++]);
663                 show_indirect(out_file, "TIND", inode->i_block[i++]);
664
665                 fprintf(out_file, "\n");
666         }
667
668         if (dump_contents)
669                 do_hexdump(out_file, buf, blocksize);
670
671 }
672
673 static void do_hexdump (FILE *out_file, char *buf, int blocksize)
674 {
675         int i,j;
676         int *intp;
677         char *charp;
678         unsigned char c;
679
680         intp = (int *) buf;
681         charp = (char *) buf;
682
683         for (i=0; i<blocksize; i+=16) {
684                 fprintf(out_file, "    %04x:  ", i);
685                 for (j=0; j<16; j+=4)
686                         fprintf(out_file, "%08x ", *intp++);
687                 for (j=0; j<16; j++) {
688                         c = *charp++;
689                         if (c < ' ' || c >= 127)
690                                 c = '.';
691                         fprintf(out_file, "%c", c);
692                 }
693                 fprintf(out_file, "\n");
694         }
695 }
696