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_descriptor_block_csum_verify(journal_t
*j
, void *buf
)
179 struct jbd2_journal_block_tail
*tail
;
183 if (!jbd2_journal_has_csum_v2or3(j
))
186 tail
= (struct jbd2_journal_block_tail
*)(buf
+ j
->j_blocksize
-
187 sizeof(struct jbd2_journal_block_tail
));
188 provided
= tail
->t_checksum
;
189 tail
->t_checksum
= 0;
190 calculated
= jbd2_chksum(j
, j
->j_csum_seed
, buf
, j
->j_blocksize
);
191 tail
->t_checksum
= provided
;
193 return provided
== cpu_to_be32(calculated
);
197 * Count the number of in-use tags in a journal descriptor block.
200 static int count_tags(journal_t
*journal
, struct buffer_head
*bh
)
203 journal_block_tag_t
* tag
;
204 int nr
= 0, size
= journal
->j_blocksize
;
205 int tag_bytes
= journal_tag_bytes(journal
);
207 if (jbd2_journal_has_csum_v2or3(journal
))
208 size
-= sizeof(struct jbd2_journal_block_tail
);
210 tagp
= &bh
->b_data
[sizeof(journal_header_t
)];
212 while ((tagp
- bh
->b_data
+ tag_bytes
) <= size
) {
213 tag
= (journal_block_tag_t
*) tagp
;
217 if (!(tag
->t_flags
& cpu_to_be16(JBD2_FLAG_SAME_UUID
)))
220 if (tag
->t_flags
& cpu_to_be16(JBD2_FLAG_LAST_TAG
))
228 /* Make sure we wrap around the log correctly! */
229 #define wrap(journal, var) \
231 if (var >= (journal)->j_last) \
232 var -= ((journal)->j_last - (journal)->j_first); \
236 * jbd2_journal_recover - recovers a on-disk journal
237 * @journal: the journal to recover
239 * The primary function for recovering the log contents when mounting a
242 * Recovery is done in three passes. In the first pass, we look for the
243 * end of the log. In the second, we assemble the list of revoke
244 * blocks. In the third and final pass, we replay any un-revoked blocks
247 int jbd2_journal_recover(journal_t
*journal
)
250 journal_superblock_t
* sb
;
252 struct recovery_info info
;
254 memset(&info
, 0, sizeof(info
));
255 sb
= journal
->j_superblock
;
258 * The journal superblock's s_start field (the current log head)
259 * is always zero if, and only if, the journal was cleanly
264 jbd_debug(1, "No recovery required, last transaction %d\n",
265 be32_to_cpu(sb
->s_sequence
));
266 journal
->j_transaction_sequence
= be32_to_cpu(sb
->s_sequence
) + 1;
270 err
= do_one_pass(journal
, &info
, PASS_SCAN
);
272 err
= do_one_pass(journal
, &info
, PASS_REVOKE
);
274 err
= do_one_pass(journal
, &info
, PASS_REPLAY
);
276 jbd_debug(1, "JBD2: recovery, exit status %d, "
277 "recovered transactions %u to %u\n",
278 err
, info
.start_transaction
, info
.end_transaction
);
279 jbd_debug(1, "JBD2: Replayed %d and revoked %d/%d blocks\n",
280 info
.nr_replays
, info
.nr_revoke_hits
, info
.nr_revokes
);
282 /* Restart the log at the next transaction ID, thus invalidating
283 * any existing commit records in the log. */
284 journal
->j_transaction_sequence
= ++info
.end_transaction
;
286 jbd2_journal_clear_revoke(journal
);
287 err2
= sync_blockdev(journal
->j_fs_dev
);
290 /* Make sure all replayed data is on permanent storage */
291 if (journal
->j_flags
& JBD2_BARRIER
) {
292 err2
= blkdev_issue_flush(journal
->j_fs_dev
, GFP_KERNEL
, NULL
);
300 * jbd2_journal_skip_recovery - Start journal and wipe exiting records
301 * @journal: journal to startup
303 * Locate any valid recovery information from the journal and set up the
304 * journal structures in memory to ignore it (presumably because the
305 * caller has evidence that it is out of date).
306 * This function doesn't appear to be exported..
308 * We perform one pass over the journal to allow us to tell the user how
309 * much recovery information is being erased, and to let us initialise
310 * the journal transaction sequence numbers to the next unused ID.
312 int jbd2_journal_skip_recovery(journal_t
*journal
)
316 struct recovery_info info
;
318 memset (&info
, 0, sizeof(info
));
320 err
= do_one_pass(journal
, &info
, PASS_SCAN
);
323 printk(KERN_ERR
"JBD2: error %d scanning journal\n", err
);
324 ++journal
->j_transaction_sequence
;
326 #ifdef CONFIG_JBD2_DEBUG
327 int dropped
= info
.end_transaction
-
328 be32_to_cpu(journal
->j_superblock
->s_sequence
);
330 "JBD2: ignoring %d transaction%s from the journal.\n",
331 dropped
, (dropped
== 1) ? "" : "s");
333 journal
->j_transaction_sequence
= ++info
.end_transaction
;
340 static inline unsigned long long read_tag_block(journal_t
*journal
,
341 journal_block_tag_t
*tag
)
343 unsigned long long block
= be32_to_cpu(tag
->t_blocknr
);
344 if (jbd2_has_feature_64bit(journal
))
345 block
|= (u64
)be32_to_cpu(tag
->t_blocknr_high
) << 32;
350 * calc_chksums calculates the checksums for the blocks described in the
353 static int calc_chksums(journal_t
*journal
, struct buffer_head
*bh
,
354 unsigned long *next_log_block
, __u32
*crc32_sum
)
356 int i
, num_blks
, err
;
357 unsigned long io_block
;
358 struct buffer_head
*obh
;
360 num_blks
= count_tags(journal
, bh
);
361 /* Calculate checksum of the descriptor block. */
362 *crc32_sum
= crc32_be(*crc32_sum
, (void *)bh
->b_data
, bh
->b_size
);
364 for (i
= 0; i
< num_blks
; i
++) {
365 io_block
= (*next_log_block
)++;
366 wrap(journal
, *next_log_block
);
367 err
= jread(&obh
, journal
, io_block
);
369 printk(KERN_ERR
"JBD2: IO error %d recovering block "
370 "%lu in log\n", err
, io_block
);
373 *crc32_sum
= crc32_be(*crc32_sum
, (void *)obh
->b_data
,
381 static int jbd2_commit_block_csum_verify(journal_t
*j
, void *buf
)
383 struct commit_header
*h
;
387 if (!jbd2_journal_has_csum_v2or3(j
))
391 provided
= h
->h_chksum
[0];
393 calculated
= jbd2_chksum(j
, j
->j_csum_seed
, buf
, j
->j_blocksize
);
394 h
->h_chksum
[0] = provided
;
396 return provided
== cpu_to_be32(calculated
);
399 static int jbd2_block_tag_csum_verify(journal_t
*j
, journal_block_tag_t
*tag
,
400 void *buf
, __u32 sequence
)
402 journal_block_tag3_t
*tag3
= (journal_block_tag3_t
*)tag
;
406 if (!jbd2_journal_has_csum_v2or3(j
))
409 seq
= cpu_to_be32(sequence
);
410 csum32
= jbd2_chksum(j
, j
->j_csum_seed
, (__u8
*)&seq
, sizeof(seq
));
411 csum32
= jbd2_chksum(j
, csum32
, buf
, j
->j_blocksize
);
413 if (jbd2_has_feature_csum3(j
))
414 return tag3
->t_checksum
== cpu_to_be32(csum32
);
416 return tag
->t_checksum
== cpu_to_be16(csum32
);
419 static int do_one_pass(journal_t
*journal
,
420 struct recovery_info
*info
, enum passtype pass
)
422 unsigned int first_commit_ID
, next_commit_ID
;
423 unsigned long next_log_block
;
424 int err
, success
= 0;
425 journal_superblock_t
* sb
;
426 journal_header_t
* tmp
;
427 struct buffer_head
* bh
;
428 unsigned int sequence
;
430 int tag_bytes
= journal_tag_bytes(journal
);
431 __u32 crc32_sum
= ~0; /* Transactional Checksums */
432 int descr_csum_size
= 0;
436 * First thing is to establish what we expect to find in the log
437 * (in terms of transaction IDs), and where (in terms of log
438 * block offsets): query the superblock.
441 sb
= journal
->j_superblock
;
442 next_commit_ID
= be32_to_cpu(sb
->s_sequence
);
443 next_log_block
= be32_to_cpu(sb
->s_start
);
445 first_commit_ID
= next_commit_ID
;
446 if (pass
== PASS_SCAN
)
447 info
->start_transaction
= first_commit_ID
;
449 jbd_debug(1, "Starting recovery pass %d\n", pass
);
452 * Now we walk through the log, transaction by transaction,
453 * making sure that each transaction has a commit block in the
454 * expected place. Each complete transaction gets replayed back
455 * into the main filesystem.
461 journal_block_tag_t
* tag
;
462 struct buffer_head
* obh
;
463 struct buffer_head
* nbh
;
467 /* If we already know where to stop the log traversal,
468 * check right now that we haven't gone past the end of
471 if (pass
!= PASS_SCAN
)
472 if (tid_geq(next_commit_ID
, info
->end_transaction
))
475 jbd_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
476 next_commit_ID
, next_log_block
, journal
->j_last
);
478 /* Skip over each chunk of the transaction looking
479 * either the next descriptor block or the final commit
482 jbd_debug(3, "JBD2: checking block %ld\n", next_log_block
);
483 err
= jread(&bh
, journal
, next_log_block
);
488 wrap(journal
, next_log_block
);
490 /* What kind of buffer is it?
492 * If it is a descriptor block, check that it has the
493 * expected sequence number. Otherwise, we're all done
496 tmp
= (journal_header_t
*)bh
->b_data
;
498 if (tmp
->h_magic
!= cpu_to_be32(JBD2_MAGIC_NUMBER
)) {
503 blocktype
= be32_to_cpu(tmp
->h_blocktype
);
504 sequence
= be32_to_cpu(tmp
->h_sequence
);
505 jbd_debug(3, "Found magic %d, sequence %d\n",
506 blocktype
, sequence
);
508 if (sequence
!= next_commit_ID
) {
513 /* OK, we have a valid descriptor block which matches
514 * all of the sequence number checks. What are we going
515 * to do with it? That depends on the pass... */
518 case JBD2_DESCRIPTOR_BLOCK
:
519 /* Verify checksum first */
520 if (jbd2_journal_has_csum_v2or3(journal
))
522 sizeof(struct jbd2_journal_block_tail
);
523 if (descr_csum_size
> 0 &&
524 !jbd2_descriptor_block_csum_verify(journal
,
526 printk(KERN_ERR
"JBD2: Invalid checksum "
527 "recovering block %lu in log\n",
534 /* If it is a valid descriptor block, replay it
535 * in pass REPLAY; if journal_checksums enabled, then
536 * calculate checksums in PASS_SCAN, otherwise,
537 * just skip over the blocks it describes. */
538 if (pass
!= PASS_REPLAY
) {
539 if (pass
== PASS_SCAN
&&
540 jbd2_has_feature_checksum(journal
) &&
541 !info
->end_transaction
) {
542 if (calc_chksums(journal
, bh
,
551 next_log_block
+= count_tags(journal
, bh
);
552 wrap(journal
, next_log_block
);
557 /* A descriptor block: we can now write all of
558 * the data blocks. Yay, useful work is finally
559 * getting done here! */
561 tagp
= &bh
->b_data
[sizeof(journal_header_t
)];
562 while ((tagp
- bh
->b_data
+ tag_bytes
)
563 <= journal
->j_blocksize
- descr_csum_size
) {
564 unsigned long io_block
;
566 tag
= (journal_block_tag_t
*) tagp
;
567 flags
= be16_to_cpu(tag
->t_flags
);
569 io_block
= next_log_block
++;
570 wrap(journal
, next_log_block
);
571 err
= jread(&obh
, journal
, io_block
);
573 /* Recover what we can, but
574 * report failure at the end. */
577 "JBD2: IO error %d recovering "
578 "block %ld in log\n",
581 unsigned long long blocknr
;
583 J_ASSERT(obh
!= NULL
);
584 blocknr
= read_tag_block(journal
,
587 /* If the block has been
588 * revoked, then we're all done
590 if (jbd2_journal_test_revoke
594 ++info
->nr_revoke_hits
;
598 /* Look for block corruption */
599 if (!jbd2_block_tag_csum_verify(
600 journal
, tag
, obh
->b_data
,
601 be32_to_cpu(tmp
->h_sequence
))) {
603 success
= -EFSBADCRC
;
604 printk(KERN_ERR
"JBD2: Invalid "
605 "checksum recovering "
606 "block %llu in log\n",
612 /* Find a buffer for the new
613 * data being restored */
614 nbh
= __getblk(journal
->j_fs_dev
,
616 journal
->j_blocksize
);
619 "JBD2: Out of memory "
620 "during recovery.\n");
628 memcpy(nbh
->b_data
, obh
->b_data
,
629 journal
->j_blocksize
);
630 if (flags
& JBD2_FLAG_ESCAPE
) {
631 *((__be32
*)nbh
->b_data
) =
632 cpu_to_be32(JBD2_MAGIC_NUMBER
);
635 BUFFER_TRACE(nbh
, "marking dirty");
636 set_buffer_uptodate(nbh
);
637 mark_buffer_dirty(nbh
);
638 BUFFER_TRACE(nbh
, "marking uptodate");
640 /* ll_rw_block(WRITE, 1, &nbh); */
648 if (!(flags
& JBD2_FLAG_SAME_UUID
))
651 if (flags
& JBD2_FLAG_LAST_TAG
)
658 case JBD2_COMMIT_BLOCK
:
659 /* How to differentiate between interrupted commit
660 * and journal corruption ?
663 * Checksum Verification Failed
665 * ____________________
667 * async_commit sync_commit
669 * | GO TO NEXT "Journal Corruption"
672 * {(n+1)th transanction}
674 * _______|______________
676 * Commit block found Commit block not found
678 * "Journal Corruption" |
679 * _____________|_________
681 * nth trans corrupt OR nth trans
682 * and (n+1)th interrupted interrupted
683 * before commit block
684 * could reach the disk.
685 * (Cannot find the difference in above
686 * mentioned conditions. Hence assume
687 * "Interrupted Commit".)
690 /* Found an expected commit block: if checksums
691 * are present verify them in PASS_SCAN; else not
692 * much to do other than move on to the next sequence
694 if (pass
== PASS_SCAN
&&
695 jbd2_has_feature_checksum(journal
)) {
696 int chksum_err
, chksum_seen
;
697 struct commit_header
*cbh
=
698 (struct commit_header
*)bh
->b_data
;
699 unsigned found_chksum
=
700 be32_to_cpu(cbh
->h_chksum
[0]);
702 chksum_err
= chksum_seen
= 0;
704 if (info
->end_transaction
) {
705 journal
->j_failed_commit
=
706 info
->end_transaction
;
711 if (crc32_sum
== found_chksum
&&
712 cbh
->h_chksum_type
== JBD2_CRC32_CHKSUM
&&
713 cbh
->h_chksum_size
==
714 JBD2_CRC32_CHKSUM_SIZE
)
716 else if (!(cbh
->h_chksum_type
== 0 &&
717 cbh
->h_chksum_size
== 0 &&
721 * If fs is mounted using an old kernel and then
722 * kernel with journal_chksum is used then we
723 * get a situation where the journal flag has
724 * checksum flag set but checksums are not
725 * present i.e chksum = 0, in the individual
727 * Hence to avoid checksum failures, in this
728 * situation, this extra check is added.
733 info
->end_transaction
= next_commit_ID
;
735 if (!jbd2_has_feature_async_commit(journal
)) {
736 journal
->j_failed_commit
=
744 if (pass
== PASS_SCAN
&&
745 !jbd2_commit_block_csum_verify(journal
,
747 info
->end_transaction
= next_commit_ID
;
749 if (!jbd2_has_feature_async_commit(journal
)) {
750 journal
->j_failed_commit
=
760 case JBD2_REVOKE_BLOCK
:
761 /* If we aren't in the REVOKE pass, then we can
762 * just skip over this block. */
763 if (pass
!= PASS_REVOKE
) {
768 err
= scan_revoke_records(journal
, bh
,
769 next_commit_ID
, info
);
776 jbd_debug(3, "Unrecognised magic %d, end of scan.\n",
785 * We broke out of the log scan loop: either we came to the
786 * known end of the log or we found an unexpected block in the
787 * log. If the latter happened, then we know that the "current"
788 * transaction marks the end of the valid log.
791 if (pass
== PASS_SCAN
) {
792 if (!info
->end_transaction
)
793 info
->end_transaction
= next_commit_ID
;
795 /* It's really bad news if different passes end up at
796 * different places (but possible due to IO errors). */
797 if (info
->end_transaction
!= next_commit_ID
) {
798 printk(KERN_ERR
"JBD2: recovery pass %d ended at "
799 "transaction %u, expected %u\n",
800 pass
, next_commit_ID
, info
->end_transaction
);
805 if (block_error
&& success
== 0)
813 /* Scan a revoke record, marking all blocks mentioned as revoked. */
815 static int scan_revoke_records(journal_t
*journal
, struct buffer_head
*bh
,
816 tid_t sequence
, struct recovery_info
*info
)
818 jbd2_journal_revoke_header_t
*header
;
824 header
= (jbd2_journal_revoke_header_t
*) bh
->b_data
;
825 offset
= sizeof(jbd2_journal_revoke_header_t
);
826 rcount
= be32_to_cpu(header
->r_count
);
828 if (!jbd2_descriptor_block_csum_verify(journal
, header
))
831 if (jbd2_journal_has_csum_v2or3(journal
))
832 csum_size
= sizeof(struct jbd2_journal_block_tail
);
833 if (rcount
> journal
->j_blocksize
- csum_size
)
837 if (jbd2_has_feature_64bit(journal
))
840 while (offset
+ record_len
<= max
) {
841 unsigned long long blocknr
;
845 blocknr
= be32_to_cpu(* ((__be32
*) (bh
->b_data
+offset
)));
847 blocknr
= be64_to_cpu(* ((__be64
*) (bh
->b_data
+offset
)));
848 offset
+= record_len
;
849 err
= jbd2_journal_set_revoke(journal
, blocknr
, sequence
);