2 * linux/fs/jbd2/recovery.c
4 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
6 * Copyright 1999-2000 Red Hat Software --- All Rights Reserved
8 * This file is part of the Linux kernel and is made available under
9 * the terms of the GNU General Public License, version 2, or at your
10 * option, any later version, incorporated herein by reference.
12 * Journal recovery routines for the generic filesystem journaling code;
13 * part of the ext2fs journaling system.
19 #include <linux/time.h>
21 #include <linux/jbd2.h>
22 #include <linux/errno.h>
23 #include <linux/crc32.h>
24 #include <linux/blkdev.h>
28 * Maintain information about the progress of the recovery job, so that
29 * the different passes can carry information between them.
33 tid_t start_transaction
;
34 tid_t end_transaction
;
41 enum passtype
{PASS_SCAN
, PASS_REVOKE
, PASS_REPLAY
};
42 static int do_one_pass(journal_t
*journal
,
43 struct recovery_info
*info
, enum passtype pass
);
44 static int scan_revoke_records(journal_t
*, struct buffer_head
*,
45 tid_t
, struct recovery_info
*);
49 /* Release readahead buffers after use */
50 static void journal_brelse_array(struct buffer_head
*b
[], int n
)
58 * When reading from the journal, we are going through the block device
59 * layer directly and so there is no readahead being done for us. We
60 * need to implement any readahead ourselves if we want it to happen at
61 * all. Recovery is basically one long sequential read, so make sure we
62 * do the IO in reasonably large chunks.
64 * This is not so critical that we need to be enormously clever about
65 * the readahead size, though. 128K is a purely arbitrary, good-enough
70 static int do_readahead(journal_t
*journal
, unsigned int start
)
73 unsigned int max
, nbufs
, next
;
74 unsigned long long blocknr
;
75 struct buffer_head
*bh
;
77 struct buffer_head
* bufs
[MAXBUF
];
79 /* Do up to 128K of readahead */
80 max
= start
+ (128 * 1024 / journal
->j_blocksize
);
81 if (max
> journal
->j_maxlen
)
82 max
= journal
->j_maxlen
;
84 /* Do the readahead itself. We'll submit MAXBUF buffer_heads at
85 * a time to the block device IO layer. */
89 for (next
= start
; next
< max
; next
++) {
90 err
= jbd2_journal_bmap(journal
, next
, &blocknr
);
93 printk(KERN_ERR
"JBD2: bad block at offset %u\n",
98 bh
= __getblk(journal
->j_dev
, blocknr
, journal
->j_blocksize
);
104 if (!buffer_uptodate(bh
) && !buffer_locked(bh
)) {
106 if (nbufs
== MAXBUF
) {
107 ll_rw_block(READ
, nbufs
, bufs
);
108 journal_brelse_array(bufs
, nbufs
);
116 ll_rw_block(READ
, nbufs
, bufs
);
121 journal_brelse_array(bufs
, nbufs
);
125 #endif /* __KERNEL__ */
129 * Read a block from the journal
132 static int jread(struct buffer_head
**bhp
, journal_t
*journal
,
136 unsigned long long blocknr
;
137 struct buffer_head
*bh
;
141 if (offset
>= journal
->j_maxlen
) {
142 printk(KERN_ERR
"JBD2: corrupted journal superblock\n");
143 return -EFSCORRUPTED
;
146 err
= jbd2_journal_bmap(journal
, offset
, &blocknr
);
149 printk(KERN_ERR
"JBD2: bad block at offset %u\n",
154 bh
= __getblk(journal
->j_dev
, blocknr
, journal
->j_blocksize
);
158 if (!buffer_uptodate(bh
)) {
159 /* If this is a brand new buffer, start readahead.
160 Otherwise, we assume we are already reading it. */
162 do_readahead(journal
, offset
);
166 if (!buffer_uptodate(bh
)) {
167 printk(KERN_ERR
"JBD2: Failed to read block at offset %u\n",
177 static int jbd2_descr_block_csum_verify(journal_t
*j
,
180 struct jbd2_journal_block_tail
*tail
;
184 if (!jbd2_journal_has_csum_v2or3(j
))
187 tail
= (struct jbd2_journal_block_tail
*)(buf
+ j
->j_blocksize
-
188 sizeof(struct jbd2_journal_block_tail
));
189 provided
= tail
->t_checksum
;
190 tail
->t_checksum
= 0;
191 calculated
= jbd2_chksum(j
, j
->j_csum_seed
, buf
, j
->j_blocksize
);
192 tail
->t_checksum
= provided
;
194 return provided
== cpu_to_be32(calculated
);
198 * Count the number of in-use tags in a journal descriptor block.
201 static int count_tags(journal_t
*journal
, struct buffer_head
*bh
)
204 journal_block_tag_t
* tag
;
205 int nr
= 0, size
= journal
->j_blocksize
;
206 int tag_bytes
= journal_tag_bytes(journal
);
208 if (jbd2_journal_has_csum_v2or3(journal
))
209 size
-= sizeof(struct jbd2_journal_block_tail
);
211 tagp
= &bh
->b_data
[sizeof(journal_header_t
)];
213 while ((tagp
- bh
->b_data
+ tag_bytes
) <= size
) {
214 tag
= (journal_block_tag_t
*) tagp
;
218 if (!(tag
->t_flags
& cpu_to_be16(JBD2_FLAG_SAME_UUID
)))
221 if (tag
->t_flags
& cpu_to_be16(JBD2_FLAG_LAST_TAG
))
229 /* Make sure we wrap around the log correctly! */
230 #define wrap(journal, var) \
232 if (var >= (journal)->j_last) \
233 var -= ((journal)->j_last - (journal)->j_first); \
237 * jbd2_journal_recover - recovers a on-disk journal
238 * @journal: the journal to recover
240 * The primary function for recovering the log contents when mounting a
243 * Recovery is done in three passes. In the first pass, we look for the
244 * end of the log. In the second, we assemble the list of revoke
245 * blocks. In the third and final pass, we replay any un-revoked blocks
248 int jbd2_journal_recover(journal_t
*journal
)
251 journal_superblock_t
* sb
;
253 struct recovery_info info
;
255 memset(&info
, 0, sizeof(info
));
256 sb
= journal
->j_superblock
;
259 * The journal superblock's s_start field (the current log head)
260 * is always zero if, and only if, the journal was cleanly
265 jbd_debug(1, "No recovery required, last transaction %d\n",
266 be32_to_cpu(sb
->s_sequence
));
267 journal
->j_transaction_sequence
= be32_to_cpu(sb
->s_sequence
) + 1;
271 err
= do_one_pass(journal
, &info
, PASS_SCAN
);
273 err
= do_one_pass(journal
, &info
, PASS_REVOKE
);
275 err
= do_one_pass(journal
, &info
, PASS_REPLAY
);
277 jbd_debug(1, "JBD2: recovery, exit status %d, "
278 "recovered transactions %u to %u\n",
279 err
, info
.start_transaction
, info
.end_transaction
);
280 jbd_debug(1, "JBD2: Replayed %d and revoked %d/%d blocks\n",
281 info
.nr_replays
, info
.nr_revoke_hits
, info
.nr_revokes
);
283 /* Restart the log at the next transaction ID, thus invalidating
284 * any existing commit records in the log. */
285 journal
->j_transaction_sequence
= ++info
.end_transaction
;
287 jbd2_journal_clear_revoke(journal
);
288 err2
= sync_blockdev(journal
->j_fs_dev
);
291 /* Make sure all replayed data is on permanent storage */
292 if (journal
->j_flags
& JBD2_BARRIER
) {
293 err2
= blkdev_issue_flush(journal
->j_fs_dev
, GFP_KERNEL
, NULL
);
301 * jbd2_journal_skip_recovery - Start journal and wipe exiting records
302 * @journal: journal to startup
304 * Locate any valid recovery information from the journal and set up the
305 * journal structures in memory to ignore it (presumably because the
306 * caller has evidence that it is out of date).
307 * This function does'nt appear to be exorted..
309 * We perform one pass over the journal to allow us to tell the user how
310 * much recovery information is being erased, and to let us initialise
311 * the journal transaction sequence numbers to the next unused ID.
313 int jbd2_journal_skip_recovery(journal_t
*journal
)
317 struct recovery_info info
;
319 memset (&info
, 0, sizeof(info
));
321 err
= do_one_pass(journal
, &info
, PASS_SCAN
);
324 printk(KERN_ERR
"JBD2: error %d scanning journal\n", err
);
325 ++journal
->j_transaction_sequence
;
327 #ifdef CONFIG_JBD2_DEBUG
328 int dropped
= info
.end_transaction
-
329 be32_to_cpu(journal
->j_superblock
->s_sequence
);
331 "JBD2: ignoring %d transaction%s from the journal.\n",
332 dropped
, (dropped
== 1) ? "" : "s");
334 journal
->j_transaction_sequence
= ++info
.end_transaction
;
341 static inline unsigned long long read_tag_block(journal_t
*journal
,
342 journal_block_tag_t
*tag
)
344 unsigned long long block
= be32_to_cpu(tag
->t_blocknr
);
345 if (jbd2_has_feature_64bit(journal
))
346 block
|= (u64
)be32_to_cpu(tag
->t_blocknr_high
) << 32;
351 * calc_chksums calculates the checksums for the blocks described in the
354 static int calc_chksums(journal_t
*journal
, struct buffer_head
*bh
,
355 unsigned long *next_log_block
, __u32
*crc32_sum
)
357 int i
, num_blks
, err
;
358 unsigned long io_block
;
359 struct buffer_head
*obh
;
361 num_blks
= count_tags(journal
, bh
);
362 /* Calculate checksum of the descriptor block. */
363 *crc32_sum
= crc32_be(*crc32_sum
, (void *)bh
->b_data
, bh
->b_size
);
365 for (i
= 0; i
< num_blks
; i
++) {
366 io_block
= (*next_log_block
)++;
367 wrap(journal
, *next_log_block
);
368 err
= jread(&obh
, journal
, io_block
);
370 printk(KERN_ERR
"JBD2: IO error %d recovering block "
371 "%lu in log\n", err
, io_block
);
374 *crc32_sum
= crc32_be(*crc32_sum
, (void *)obh
->b_data
,
382 static int jbd2_commit_block_csum_verify(journal_t
*j
, void *buf
)
384 struct commit_header
*h
;
388 if (!jbd2_journal_has_csum_v2or3(j
))
392 provided
= h
->h_chksum
[0];
394 calculated
= jbd2_chksum(j
, j
->j_csum_seed
, buf
, j
->j_blocksize
);
395 h
->h_chksum
[0] = provided
;
397 return provided
== cpu_to_be32(calculated
);
400 static int jbd2_block_tag_csum_verify(journal_t
*j
, journal_block_tag_t
*tag
,
401 void *buf
, __u32 sequence
)
403 journal_block_tag3_t
*tag3
= (journal_block_tag3_t
*)tag
;
407 if (!jbd2_journal_has_csum_v2or3(j
))
410 seq
= cpu_to_be32(sequence
);
411 csum32
= jbd2_chksum(j
, j
->j_csum_seed
, (__u8
*)&seq
, sizeof(seq
));
412 csum32
= jbd2_chksum(j
, csum32
, buf
, j
->j_blocksize
);
414 if (jbd2_has_feature_csum3(j
))
415 return tag3
->t_checksum
== cpu_to_be32(csum32
);
417 return tag
->t_checksum
== cpu_to_be16(csum32
);
420 static int do_one_pass(journal_t
*journal
,
421 struct recovery_info
*info
, enum passtype pass
)
423 unsigned int first_commit_ID
, next_commit_ID
;
424 unsigned long next_log_block
;
425 int err
, success
= 0;
426 journal_superblock_t
* sb
;
427 journal_header_t
* tmp
;
428 struct buffer_head
* bh
;
429 unsigned int sequence
;
431 int tag_bytes
= journal_tag_bytes(journal
);
432 __u32 crc32_sum
= ~0; /* Transactional Checksums */
433 int descr_csum_size
= 0;
437 * First thing is to establish what we expect to find in the log
438 * (in terms of transaction IDs), and where (in terms of log
439 * block offsets): query the superblock.
442 sb
= journal
->j_superblock
;
443 next_commit_ID
= be32_to_cpu(sb
->s_sequence
);
444 next_log_block
= be32_to_cpu(sb
->s_start
);
446 first_commit_ID
= next_commit_ID
;
447 if (pass
== PASS_SCAN
)
448 info
->start_transaction
= first_commit_ID
;
450 jbd_debug(1, "Starting recovery pass %d\n", pass
);
453 * Now we walk through the log, transaction by transaction,
454 * making sure that each transaction has a commit block in the
455 * expected place. Each complete transaction gets replayed back
456 * into the main filesystem.
462 journal_block_tag_t
* tag
;
463 struct buffer_head
* obh
;
464 struct buffer_head
* nbh
;
468 /* If we already know where to stop the log traversal,
469 * check right now that we haven't gone past the end of
472 if (pass
!= PASS_SCAN
)
473 if (tid_geq(next_commit_ID
, info
->end_transaction
))
476 jbd_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
477 next_commit_ID
, next_log_block
, journal
->j_last
);
479 /* Skip over each chunk of the transaction looking
480 * either the next descriptor block or the final commit
483 jbd_debug(3, "JBD2: checking block %ld\n", next_log_block
);
484 err
= jread(&bh
, journal
, next_log_block
);
489 wrap(journal
, next_log_block
);
491 /* What kind of buffer is it?
493 * If it is a descriptor block, check that it has the
494 * expected sequence number. Otherwise, we're all done
497 tmp
= (journal_header_t
*)bh
->b_data
;
499 if (tmp
->h_magic
!= cpu_to_be32(JBD2_MAGIC_NUMBER
)) {
504 blocktype
= be32_to_cpu(tmp
->h_blocktype
);
505 sequence
= be32_to_cpu(tmp
->h_sequence
);
506 jbd_debug(3, "Found magic %d, sequence %d\n",
507 blocktype
, sequence
);
509 if (sequence
!= next_commit_ID
) {
514 /* OK, we have a valid descriptor block which matches
515 * all of the sequence number checks. What are we going
516 * to do with it? That depends on the pass... */
519 case JBD2_DESCRIPTOR_BLOCK
:
520 /* Verify checksum first */
521 if (jbd2_journal_has_csum_v2or3(journal
))
523 sizeof(struct jbd2_journal_block_tail
);
524 if (descr_csum_size
> 0 &&
525 !jbd2_descr_block_csum_verify(journal
,
527 printk(KERN_ERR
"JBD2: Invalid checksum "
528 "recovering block %lu in log\n",
535 /* If it is a valid descriptor block, replay it
536 * in pass REPLAY; if journal_checksums enabled, then
537 * calculate checksums in PASS_SCAN, otherwise,
538 * just skip over the blocks it describes. */
539 if (pass
!= PASS_REPLAY
) {
540 if (pass
== PASS_SCAN
&&
541 jbd2_has_feature_checksum(journal
) &&
542 !info
->end_transaction
) {
543 if (calc_chksums(journal
, bh
,
552 next_log_block
+= count_tags(journal
, bh
);
553 wrap(journal
, next_log_block
);
558 /* A descriptor block: we can now write all of
559 * the data blocks. Yay, useful work is finally
560 * getting done here! */
562 tagp
= &bh
->b_data
[sizeof(journal_header_t
)];
563 while ((tagp
- bh
->b_data
+ tag_bytes
)
564 <= journal
->j_blocksize
- descr_csum_size
) {
565 unsigned long io_block
;
567 tag
= (journal_block_tag_t
*) tagp
;
568 flags
= be16_to_cpu(tag
->t_flags
);
570 io_block
= next_log_block
++;
571 wrap(journal
, next_log_block
);
572 err
= jread(&obh
, journal
, io_block
);
574 /* Recover what we can, but
575 * report failure at the end. */
578 "JBD2: IO error %d recovering "
579 "block %ld in log\n",
582 unsigned long long blocknr
;
584 J_ASSERT(obh
!= NULL
);
585 blocknr
= read_tag_block(journal
,
588 /* If the block has been
589 * revoked, then we're all done
591 if (jbd2_journal_test_revoke
595 ++info
->nr_revoke_hits
;
599 /* Look for block corruption */
600 if (!jbd2_block_tag_csum_verify(
601 journal
, tag
, obh
->b_data
,
602 be32_to_cpu(tmp
->h_sequence
))) {
604 success
= -EFSBADCRC
;
605 printk(KERN_ERR
"JBD2: Invalid "
606 "checksum recovering "
607 "block %llu in log\n",
613 /* Find a buffer for the new
614 * data being restored */
615 nbh
= __getblk(journal
->j_fs_dev
,
617 journal
->j_blocksize
);
620 "JBD2: Out of memory "
621 "during recovery.\n");
629 memcpy(nbh
->b_data
, obh
->b_data
,
630 journal
->j_blocksize
);
631 if (flags
& JBD2_FLAG_ESCAPE
) {
632 *((__be32
*)nbh
->b_data
) =
633 cpu_to_be32(JBD2_MAGIC_NUMBER
);
636 BUFFER_TRACE(nbh
, "marking dirty");
637 set_buffer_uptodate(nbh
);
638 mark_buffer_dirty(nbh
);
639 BUFFER_TRACE(nbh
, "marking uptodate");
641 /* ll_rw_block(WRITE, 1, &nbh); */
649 if (!(flags
& JBD2_FLAG_SAME_UUID
))
652 if (flags
& JBD2_FLAG_LAST_TAG
)
659 case JBD2_COMMIT_BLOCK
:
660 /* How to differentiate between interrupted commit
661 * and journal corruption ?
664 * Checksum Verification Failed
666 * ____________________
668 * async_commit sync_commit
670 * | GO TO NEXT "Journal Corruption"
673 * {(n+1)th transanction}
675 * _______|______________
677 * Commit block found Commit block not found
679 * "Journal Corruption" |
680 * _____________|_________
682 * nth trans corrupt OR nth trans
683 * and (n+1)th interrupted interrupted
684 * before commit block
685 * could reach the disk.
686 * (Cannot find the difference in above
687 * mentioned conditions. Hence assume
688 * "Interrupted Commit".)
691 /* Found an expected commit block: if checksums
692 * are present verify them in PASS_SCAN; else not
693 * much to do other than move on to the next sequence
695 if (pass
== PASS_SCAN
&&
696 jbd2_has_feature_checksum(journal
)) {
697 int chksum_err
, chksum_seen
;
698 struct commit_header
*cbh
=
699 (struct commit_header
*)bh
->b_data
;
700 unsigned found_chksum
=
701 be32_to_cpu(cbh
->h_chksum
[0]);
703 chksum_err
= chksum_seen
= 0;
705 if (info
->end_transaction
) {
706 journal
->j_failed_commit
=
707 info
->end_transaction
;
712 if (crc32_sum
== found_chksum
&&
713 cbh
->h_chksum_type
== JBD2_CRC32_CHKSUM
&&
714 cbh
->h_chksum_size
==
715 JBD2_CRC32_CHKSUM_SIZE
)
717 else if (!(cbh
->h_chksum_type
== 0 &&
718 cbh
->h_chksum_size
== 0 &&
722 * If fs is mounted using an old kernel and then
723 * kernel with journal_chksum is used then we
724 * get a situation where the journal flag has
725 * checksum flag set but checksums are not
726 * present i.e chksum = 0, in the individual
728 * Hence to avoid checksum failures, in this
729 * situation, this extra check is added.
734 info
->end_transaction
= next_commit_ID
;
736 if (!jbd2_has_feature_async_commit(journal
)) {
737 journal
->j_failed_commit
=
745 if (pass
== PASS_SCAN
&&
746 !jbd2_commit_block_csum_verify(journal
,
748 info
->end_transaction
= next_commit_ID
;
750 if (!jbd2_has_feature_async_commit(journal
)) {
751 journal
->j_failed_commit
=
761 case JBD2_REVOKE_BLOCK
:
762 /* If we aren't in the REVOKE pass, then we can
763 * just skip over this block. */
764 if (pass
!= PASS_REVOKE
) {
769 err
= scan_revoke_records(journal
, bh
,
770 next_commit_ID
, info
);
777 jbd_debug(3, "Unrecognised magic %d, end of scan.\n",
786 * We broke out of the log scan loop: either we came to the
787 * known end of the log or we found an unexpected block in the
788 * log. If the latter happened, then we know that the "current"
789 * transaction marks the end of the valid log.
792 if (pass
== PASS_SCAN
) {
793 if (!info
->end_transaction
)
794 info
->end_transaction
= next_commit_ID
;
796 /* It's really bad news if different passes end up at
797 * different places (but possible due to IO errors). */
798 if (info
->end_transaction
!= next_commit_ID
) {
799 printk(KERN_ERR
"JBD2: recovery pass %d ended at "
800 "transaction %u, expected %u\n",
801 pass
, next_commit_ID
, info
->end_transaction
);
806 if (block_error
&& success
== 0)
814 static int jbd2_revoke_block_csum_verify(journal_t
*j
,
817 struct jbd2_journal_revoke_tail
*tail
;
821 if (!jbd2_journal_has_csum_v2or3(j
))
824 tail
= (struct jbd2_journal_revoke_tail
*)(buf
+ j
->j_blocksize
-
825 sizeof(struct jbd2_journal_revoke_tail
));
826 provided
= tail
->r_checksum
;
827 tail
->r_checksum
= 0;
828 calculated
= jbd2_chksum(j
, j
->j_csum_seed
, buf
, j
->j_blocksize
);
829 tail
->r_checksum
= provided
;
831 return provided
== cpu_to_be32(calculated
);
834 /* Scan a revoke record, marking all blocks mentioned as revoked. */
836 static int scan_revoke_records(journal_t
*journal
, struct buffer_head
*bh
,
837 tid_t sequence
, struct recovery_info
*info
)
839 jbd2_journal_revoke_header_t
*header
;
845 header
= (jbd2_journal_revoke_header_t
*) bh
->b_data
;
846 offset
= sizeof(jbd2_journal_revoke_header_t
);
847 rcount
= be32_to_cpu(header
->r_count
);
849 if (!jbd2_revoke_block_csum_verify(journal
, header
))
852 if (jbd2_journal_has_csum_v2or3(journal
))
853 csum_size
= sizeof(struct jbd2_journal_revoke_tail
);
854 if (rcount
> journal
->j_blocksize
- csum_size
)
858 if (jbd2_has_feature_64bit(journal
))
861 while (offset
+ record_len
<= max
) {
862 unsigned long long blocknr
;
866 blocknr
= be32_to_cpu(* ((__be32
*) (bh
->b_data
+offset
)));
868 blocknr
= be64_to_cpu(* ((__be64
*) (bh
->b_data
+offset
)));
869 offset
+= record_len
;
870 err
= jbd2_journal_set_revoke(journal
, blocknr
, sequence
);