2 * linux/fs/jbd/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.
20 #include <linux/time.h>
22 #include <linux/jbd.h>
23 #include <linux/errno.h>
24 #include <linux/slab.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 = journal_bmap(journal, next, &blocknr);
93 printk (KERN_ERR "JBD: 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 "JBD: corrupted journal superblock\n");
146 err = journal_bmap(journal, offset, &blocknr);
149 printk (KERN_ERR "JBD: 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 "JBD: Failed to read block at offset %u\n",
177 static int jbd2_descr_block_csum_verify(journal_t *j,
180 struct journal_block_tail *tail;
181 __u32 provided, calculated;
183 if (!JFS_HAS_INCOMPAT_FEATURE(j, JFS_FEATURE_INCOMPAT_CSUM_V2))
186 tail = (struct journal_block_tail *)(buf + j->j_blocksize -
187 sizeof(struct journal_block_tail));
188 provided = tail->t_checksum;
189 tail->t_checksum = 0;
190 calculated = ext2fs_crc32c_le(~0, j->j_superblock->s_uuid,
191 sizeof(j->j_superblock->s_uuid));
192 calculated = ext2fs_crc32c_le(calculated, buf, j->j_blocksize);
193 tail->t_checksum = provided;
195 provided = ext2fs_be32_to_cpu(provided);
196 return provided == calculated;
200 * Count the number of in-use tags in a journal descriptor block.
203 static int count_tags(journal_t *journal, struct buffer_head *bh)
206 journal_block_tag_t * tag;
207 int nr = 0, size = journal->j_blocksize;
208 int tag_bytes = journal_tag_bytes(journal);
210 if (JFS_HAS_INCOMPAT_FEATURE(journal, JFS_FEATURE_INCOMPAT_CSUM_V2))
211 size -= sizeof(struct journal_block_tail);
213 tagp = &bh->b_data[sizeof(journal_header_t)];
215 while ((tagp - bh->b_data + tag_bytes) <= size) {
216 tag = (journal_block_tag_t *) tagp;
220 if (!(tag->t_flags & cpu_to_be16(JFS_FLAG_SAME_UUID)))
223 if (tag->t_flags & cpu_to_be16(JFS_FLAG_LAST_TAG))
231 /* Make sure we wrap around the log correctly! */
232 #define wrap(journal, var) \
234 if (var >= (journal)->j_last) \
235 var -= ((journal)->j_last - (journal)->j_first); \
239 * journal_recover - recovers a on-disk journal
240 * @journal: the journal to recover
242 * The primary function for recovering the log contents when mounting a
245 * Recovery is done in three passes. In the first pass, we look for the
246 * end of the log. In the second, we assemble the list of revoke
247 * blocks. In the third and final pass, we replay any un-revoked blocks
250 int journal_recover(journal_t *journal)
253 journal_superblock_t * sb;
255 struct recovery_info info;
257 memset(&info, 0, sizeof(info));
258 sb = journal->j_superblock;
261 * The journal superblock's s_start field (the current log head)
262 * is always zero if, and only if, the journal was cleanly
267 jbd_debug(1, "No recovery required, last transaction %d\n",
268 be32_to_cpu(sb->s_sequence));
269 journal->j_transaction_sequence = be32_to_cpu(sb->s_sequence) + 1;
273 err = do_one_pass(journal, &info, PASS_SCAN);
275 err = do_one_pass(journal, &info, PASS_REVOKE);
277 err = do_one_pass(journal, &info, PASS_REPLAY);
279 jbd_debug(1, "JBD: recovery, exit status %d, "
280 "recovered transactions %u to %u\n",
281 err, info.start_transaction, info.end_transaction);
282 jbd_debug(1, "JBD: Replayed %d and revoked %d/%d blocks\n",
283 info.nr_replays, info.nr_revoke_hits, info.nr_revokes);
285 /* Restart the log at the next transaction ID, thus invalidating
286 * any existing commit records in the log. */
287 journal->j_transaction_sequence = ++info.end_transaction;
289 journal_clear_revoke(journal);
290 sync_blockdev(journal->j_fs_dev);
295 * journal_skip_recovery - Start journal and wipe exiting records
296 * @journal: journal to startup
298 * Locate any valid recovery information from the journal and set up the
299 * journal structures in memory to ignore it (presumably because the
300 * caller has evidence that it is out of date).
301 * This function does'nt appear to be exorted..
303 * We perform one pass over the journal to allow us to tell the user how
304 * much recovery information is being erased, and to let us initialise
305 * the journal transaction sequence numbers to the next unused ID.
307 int journal_skip_recovery(journal_t *journal)
310 journal_superblock_t * sb;
312 struct recovery_info info;
314 memset (&info, 0, sizeof(info));
315 sb = journal->j_superblock;
317 err = do_one_pass(journal, &info, PASS_SCAN);
320 printk(KERN_ERR "JBD: error %d scanning journal\n", err);
321 ++journal->j_transaction_sequence;
323 #ifdef CONFIG_JBD_DEBUG
324 int dropped = info.end_transaction - be32_to_cpu(sb->s_sequence);
327 "JBD: ignoring %d transaction%s from the journal.\n",
328 dropped, (dropped == 1) ? "" : "s");
329 journal->j_transaction_sequence = ++info.end_transaction;
336 static inline unsigned long long read_tag_block(int tag_bytes, journal_block_tag_t *tag)
338 unsigned long long block = be32_to_cpu(tag->t_blocknr);
339 if (tag_bytes > JBD_TAG_SIZE32)
340 block |= (__u64)be32_to_cpu(tag->t_blocknr_high) << 32;
345 * calc_chksums calculates the checksums for the blocks described in the
348 static int calc_chksums(journal_t *journal, struct buffer_head *bh,
349 unsigned long long *next_log_block, __u32 *crc32_sum)
351 int i, num_blks, err;
352 unsigned long long io_block;
353 struct buffer_head *obh;
355 num_blks = count_tags(journal, bh);
356 /* Calculate checksum of the descriptor block. */
357 *crc32_sum = crc32_be(*crc32_sum, (void *)bh->b_data, bh->b_size);
359 for (i = 0; i < num_blks; i++) {
360 io_block = (*next_log_block)++;
361 wrap(journal, *next_log_block);
362 err = jread(&obh, journal, io_block);
364 printk(KERN_ERR "JBD: IO error %d recovering block "
365 "%llu in log\n", err, io_block);
368 *crc32_sum = crc32_be(*crc32_sum, (void *)obh->b_data,
376 static int do_one_pass(journal_t *journal,
377 struct recovery_info *info, enum passtype pass)
379 unsigned int first_commit_ID, next_commit_ID;
380 unsigned long long next_log_block;
381 int err, success = 0;
382 journal_superblock_t * sb;
383 journal_header_t * tmp;
384 struct buffer_head * bh;
385 unsigned int sequence;
387 int tag_bytes = journal_tag_bytes(journal);
388 __u32 crc32_sum = ~0; /* Transactional Checksums */
389 int descr_csum_size = 0;
391 /* Precompute the maximum metadata descriptors in a descriptor block */
392 int MAX_BLOCKS_PER_DESC;
393 MAX_BLOCKS_PER_DESC = ((journal->j_blocksize-sizeof(journal_header_t))
397 * First thing is to establish what we expect to find in the log
398 * (in terms of transaction IDs), and where (in terms of log
399 * block offsets): query the superblock.
402 sb = journal->j_superblock;
403 next_commit_ID = be32_to_cpu(sb->s_sequence);
404 next_log_block = be32_to_cpu(sb->s_start);
406 first_commit_ID = next_commit_ID;
407 if (pass == PASS_SCAN)
408 info->start_transaction = first_commit_ID;
410 jbd_debug(1, "Starting recovery pass %d\n", pass);
413 * Now we walk through the log, transaction by transaction,
414 * making sure that each transaction has a commit block in the
415 * expected place. Each complete transaction gets replayed back
416 * into the main filesystem.
422 journal_block_tag_t * tag;
423 struct buffer_head * obh;
424 struct buffer_head * nbh;
428 /* If we already know where to stop the log traversal,
429 * check right now that we haven't gone past the end of
432 if (pass != PASS_SCAN)
433 if (tid_geq(next_commit_ID, info->end_transaction))
436 jbd_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
437 next_commit_ID, next_log_block, journal->j_last);
439 /* Skip over each chunk of the transaction looking
440 * either the next descriptor block or the final commit
443 jbd_debug(3, "JBD: checking block %ld\n", next_log_block);
444 err = jread(&bh, journal, next_log_block);
449 wrap(journal, next_log_block);
451 /* What kind of buffer is it?
453 * If it is a descriptor block, check that it has the
454 * expected sequence number. Otherwise, we're all done
457 tmp = (journal_header_t *)bh->b_data;
459 if (tmp->h_magic != cpu_to_be32(JFS_MAGIC_NUMBER)) {
464 blocktype = be32_to_cpu(tmp->h_blocktype);
465 sequence = be32_to_cpu(tmp->h_sequence);
466 jbd_debug(3, "Found magic %d, sequence %d\n",
467 blocktype, sequence);
469 if (sequence != next_commit_ID) {
474 /* OK, we have a valid descriptor block which matches
475 * all of the sequence number checks. What are we going
476 * to do with it? That depends on the pass... */
479 case JFS_DESCRIPTOR_BLOCK:
480 /* Verify checksum first */
481 if (JFS_HAS_INCOMPAT_FEATURE(journal,
482 JFS_FEATURE_INCOMPAT_CSUM_V2))
484 sizeof(struct journal_block_tail);
485 if (descr_csum_size > 0 &&
486 !jbd2_descr_block_csum_verify(journal,
492 /* If it is a valid descriptor block, replay it
493 * in pass REPLAY; if journal_checksums enabled, then
494 * calculate checksums in PASS_SCAN, otherwise,
495 * just skip over the blocks it describes. */
496 if (pass != PASS_REPLAY) {
497 if (pass == PASS_SCAN &&
498 JFS_HAS_COMPAT_FEATURE(journal,
499 JFS_FEATURE_COMPAT_CHECKSUM) &&
500 !info->end_transaction) {
501 if (calc_chksums(journal, bh,
510 next_log_block += count_tags(journal, bh);
511 wrap(journal, next_log_block);
516 /* A descriptor block: we can now write all of
517 * the data blocks. Yay, useful work is finally
518 * getting done here! */
520 tagp = &bh->b_data[sizeof(journal_header_t)];
521 while ((tagp - bh->b_data + tag_bytes)
522 <= journal->j_blocksize - descr_csum_size) {
523 unsigned long long io_block;
525 tag = (journal_block_tag_t *) tagp;
526 flags = be16_to_cpu(tag->t_flags);
528 io_block = next_log_block++;
529 wrap(journal, next_log_block);
530 err = jread(&obh, journal, io_block);
532 /* Recover what we can, but
533 * report failure at the end. */
536 "JBD: IO error %d recovering "
537 "block %llu in log\n",
540 unsigned long long blocknr;
542 J_ASSERT(obh != NULL);
543 blocknr = read_tag_block(tag_bytes,
546 /* If the block has been
547 * revoked, then we're all done
549 if (journal_test_revoke
553 ++info->nr_revoke_hits;
557 /* Find a buffer for the new
558 * data being restored */
559 nbh = __getblk(journal->j_fs_dev,
561 journal->j_blocksize);
564 "JBD: Out of memory "
565 "during recovery.\n");
573 memcpy(nbh->b_data, obh->b_data,
574 journal->j_blocksize);
575 if (flags & JFS_FLAG_ESCAPE) {
576 journal_header_t *header;
578 header = (journal_header_t *) &nbh->b_data[0];
579 header->h_magic = cpu_to_be32(JFS_MAGIC_NUMBER);
582 BUFFER_TRACE(nbh, "marking dirty");
583 set_buffer_uptodate(nbh);
584 mark_buffer_dirty(nbh);
585 BUFFER_TRACE(nbh, "marking uptodate");
587 /* ll_rw_block(WRITE, 1, &nbh); */
595 if (!(flags & JFS_FLAG_SAME_UUID))
598 if (flags & JFS_FLAG_LAST_TAG)
605 case JFS_COMMIT_BLOCK:
606 jbd_debug(3, "Commit block for #%u found\n",
608 /* How to differentiate between interrupted commit
609 * and journal corruption ?
612 * Checksum Verification Failed
614 * ____________________
616 * async_commit sync_commit
618 * | GO TO NEXT "Journal Corruption"
621 * {(n+1)th transanction}
623 * _______|______________
625 * Commit block found Commit block not found
627 * "Journal Corruption" |
628 * _____________|_________
630 * nth trans corrupt OR nth trans
631 * and (n+1)th interrupted interrupted
632 * before commit block
633 * could reach the disk.
634 * (Cannot find the difference in above
635 * mentioned conditions. Hence assume
636 * "Interrupted Commit".)
639 /* Found an expected commit block: if checksums
640 * are present verify them in PASS_SCAN; else not
641 * much to do other than move on to the next sequence
643 if (pass == PASS_SCAN &&
644 JFS_HAS_COMPAT_FEATURE(journal,
645 JFS_FEATURE_COMPAT_CHECKSUM)) {
646 int chksum_err, chksum_seen;
647 struct commit_header *cbh =
648 (struct commit_header *)bh->b_data;
649 unsigned found_chksum =
650 be32_to_cpu(cbh->h_chksum[0]);
652 chksum_err = chksum_seen = 0;
654 jbd_debug(3, "Checksums %x %x\n",
655 crc32_sum, found_chksum);
656 if (info->end_transaction) {
657 journal->j_failed_commit =
658 info->end_transaction;
663 if (crc32_sum == found_chksum &&
664 cbh->h_chksum_type == JBD2_CRC32_CHKSUM &&
665 cbh->h_chksum_size ==
666 JBD2_CRC32_CHKSUM_SIZE)
668 else if (!(cbh->h_chksum_type == 0 &&
669 cbh->h_chksum_size == 0 &&
673 * If fs is mounted using an old kernel and then
674 * kernel with journal_chksum is used then we
675 * get a situation where the journal flag has
676 * checksum flag set but checksums are not
677 * present i.e chksum = 0, in the individual
679 * Hence to avoid checksum failures, in this
680 * situation, this extra check is added.
685 info->end_transaction = next_commit_ID;
686 jbd_debug(1, "Checksum_err %x %x\n",
687 crc32_sum, found_chksum);
688 if (!JFS_HAS_INCOMPAT_FEATURE(journal,
689 JFS_FEATURE_INCOMPAT_ASYNC_COMMIT)){
690 journal->j_failed_commit =
702 case JFS_REVOKE_BLOCK:
703 /* If we aren't in the REVOKE pass, then we can
704 * just skip over this block. */
705 if (pass != PASS_REVOKE) {
710 err = scan_revoke_records(journal, bh,
711 next_commit_ID, info);
718 jbd_debug(3, "Unrecognised magic %d, end of scan.\n",
727 * We broke out of the log scan loop: either we came to the
728 * known end of the log or we found an unexpected block in the
729 * log. If the latter happened, then we know that the "current"
730 * transaction marks the end of the valid log.
733 if (pass == PASS_SCAN) {
734 if (!info->end_transaction)
735 info->end_transaction = next_commit_ID;
737 /* It's really bad news if different passes end up at
738 * different places (but possible due to IO errors). */
739 if (info->end_transaction != next_commit_ID) {
740 printk (KERN_ERR "JBD: recovery pass %d ended at "
741 "transaction %u, expected %u\n",
742 pass, next_commit_ID, info->end_transaction);
754 static int jbd2_revoke_block_csum_verify(journal_t *j,
757 struct journal_revoke_tail *tail;
758 __u32 provided, calculated;
760 if (!JFS_HAS_INCOMPAT_FEATURE(j, JFS_FEATURE_INCOMPAT_CSUM_V2))
763 tail = (struct journal_revoke_tail *)(buf + j->j_blocksize -
764 sizeof(struct journal_revoke_tail));
765 provided = tail->r_checksum;
766 tail->r_checksum = 0;
767 calculated = ext2fs_crc32c_le(~0, j->j_superblock->s_uuid,
768 sizeof(j->j_superblock->s_uuid));
769 calculated = ext2fs_crc32c_le(calculated, buf, j->j_blocksize);
770 tail->r_checksum = provided;
772 provided = ext2fs_be32_to_cpu(provided);
773 return provided == calculated;
776 /* Scan a revoke record, marking all blocks mentioned as revoked. */
778 static int scan_revoke_records(journal_t *journal, struct buffer_head *bh,
779 tid_t sequence, struct recovery_info *info)
781 journal_revoke_header_t *header;
785 header = (journal_revoke_header_t *) bh->b_data;
786 offset = sizeof(journal_revoke_header_t);
787 max = be32_to_cpu(header->r_count);
789 if (!jbd2_revoke_block_csum_verify(journal, header))
792 if (JFS_HAS_INCOMPAT_FEATURE(journal, JFS_FEATURE_INCOMPAT_64BIT))
795 while (offset < max) {
796 unsigned long long blocknr;
800 blocknr = ext2fs_be32_to_cpu(*((__be32 *)(bh->b_data +
803 blocknr = ext2fs_be64_to_cpu(*((__be64 *)(bh->b_data +
805 offset += record_len;
806 err = journal_set_revoke(journal, blocknr, sequence);