1 // SPDX-License-Identifier: GPL-2.0+
3 * linux/fs/jbd2/recovery.c
5 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
7 * Copyright 1999-2000 Red Hat Software --- All Rights Reserved
9 * Journal recovery routines for the generic filesystem journaling code;
10 * part of the ext2fs journaling system.
16 #include <linux/time.h>
18 #include <linux/jbd2.h>
19 #include <linux/errno.h>
20 #include <linux/crc32.h>
21 #include <linux/blkdev.h>
25 * Maintain information about the progress of the recovery job, so that
26 * the different passes can carry information between them.
30 tid_t start_transaction;
31 tid_t end_transaction;
32 unsigned long head_block;
39 static int do_one_pass(journal_t *journal,
40 struct recovery_info *info, enum passtype pass);
41 static int scan_revoke_records(journal_t *, struct buffer_head *,
42 tid_t, struct recovery_info *);
46 /* Release readahead buffers after use */
47 static void journal_brelse_array(struct buffer_head *b[], int n)
55 * When reading from the journal, we are going through the block device
56 * layer directly and so there is no readahead being done for us. We
57 * need to implement any readahead ourselves if we want it to happen at
58 * all. Recovery is basically one long sequential read, so make sure we
59 * do the IO in reasonably large chunks.
61 * This is not so critical that we need to be enormously clever about
62 * the readahead size, though. 128K is a purely arbitrary, good-enough
67 static int do_readahead(journal_t *journal, unsigned int start)
70 unsigned int max, nbufs, next;
71 unsigned long long blocknr;
72 struct buffer_head *bh;
74 struct buffer_head * bufs[MAXBUF];
76 /* Do up to 128K of readahead */
77 max = start + (128 * 1024 / journal->j_blocksize);
78 if (max > journal->j_total_len)
79 max = journal->j_total_len;
81 /* Do the readahead itself. We'll submit MAXBUF buffer_heads at
82 * a time to the block device IO layer. */
86 for (next = start; next < max; next++) {
87 err = jbd2_journal_bmap(journal, next, &blocknr);
90 printk(KERN_ERR "JBD2: bad block at offset %u\n",
95 bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
101 if (!buffer_uptodate(bh) && !buffer_locked(bh)) {
103 if (nbufs == MAXBUF) {
104 bh_readahead_batch(nbufs, bufs, 0);
105 journal_brelse_array(bufs, nbufs);
113 bh_readahead_batch(nbufs, bufs, 0);
118 journal_brelse_array(bufs, nbufs);
122 #endif /* __KERNEL__ */
126 * Read a block from the journal
129 static int jread(struct buffer_head **bhp, journal_t *journal,
133 unsigned long long blocknr;
134 struct buffer_head *bh;
138 if (offset >= journal->j_total_len) {
139 printk(KERN_ERR "JBD2: corrupted journal superblock\n");
140 return -EFSCORRUPTED;
143 err = jbd2_journal_bmap(journal, offset, &blocknr);
146 printk(KERN_ERR "JBD2: bad block at offset %u\n",
151 bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
155 if (!buffer_uptodate(bh)) {
157 * If this is a brand new buffer, start readahead.
158 * Otherwise, we assume we are already reading it.
160 bool need_readahead = !buffer_req(bh);
162 bh_read_nowait(bh, 0);
164 do_readahead(journal, offset);
168 if (!buffer_uptodate(bh)) {
169 printk(KERN_ERR "JBD2: Failed to read block at offset %u\n",
179 static int jbd2_descriptor_block_csum_verify(journal_t *j, void *buf)
181 struct jbd2_journal_block_tail *tail;
185 if (!jbd2_journal_has_csum_v2or3(j))
188 tail = (struct jbd2_journal_block_tail *)((char *)buf +
189 j->j_blocksize - sizeof(struct jbd2_journal_block_tail));
190 provided = tail->t_checksum;
191 tail->t_checksum = 0;
192 calculated = jbd2_chksum(j, j->j_csum_seed, buf, j->j_blocksize);
193 tail->t_checksum = provided;
195 return provided == cpu_to_be32(calculated);
199 * Count the number of in-use tags in a journal descriptor block.
202 static int count_tags(journal_t *journal, struct buffer_head *bh)
205 journal_block_tag_t tag;
206 int nr = 0, size = journal->j_blocksize;
207 int tag_bytes = journal_tag_bytes(journal);
209 if (jbd2_journal_has_csum_v2or3(journal))
210 size -= sizeof(struct jbd2_journal_block_tail);
212 tagp = &bh->b_data[sizeof(journal_header_t)];
214 while ((tagp - bh->b_data + tag_bytes) <= size) {
215 memcpy(&tag, tagp, sizeof(tag));
219 if (!(tag.t_flags & cpu_to_be16(JBD2_FLAG_SAME_UUID)))
222 if (tag.t_flags & cpu_to_be16(JBD2_FLAG_LAST_TAG))
230 /* Make sure we wrap around the log correctly! */
231 #define wrap(journal, var) \
233 if (var >= (journal)->j_last) \
234 var -= ((journal)->j_last - (journal)->j_first); \
237 static int fc_do_one_pass(journal_t *journal,
238 struct recovery_info *info, enum passtype pass)
240 unsigned int expected_commit_id = info->end_transaction;
241 unsigned long next_fc_block;
242 struct buffer_head *bh;
245 next_fc_block = journal->j_fc_first;
246 if (!journal->j_fc_replay_callback)
249 while (next_fc_block <= journal->j_fc_last) {
250 jbd2_debug(3, "Fast commit replay: next block %ld\n",
252 err = jread(&bh, journal, next_fc_block);
254 jbd2_debug(3, "Fast commit replay: read error\n");
258 err = journal->j_fc_replay_callback(journal, bh, pass,
259 next_fc_block - journal->j_fc_first,
263 if (err < 0 || err == JBD2_FC_REPLAY_STOP)
269 jbd2_debug(3, "Fast commit replay failed, err = %d\n", err);
275 * jbd2_journal_recover - recovers a on-disk journal
276 * @journal: the journal to recover
278 * The primary function for recovering the log contents when mounting a
281 * Recovery is done in three passes. In the first pass, we look for the
282 * end of the log. In the second, we assemble the list of revoke
283 * blocks. In the third and final pass, we replay any un-revoked blocks
286 int jbd2_journal_recover(journal_t *journal)
289 journal_superblock_t * sb;
291 struct recovery_info info;
293 memset(&info, 0, sizeof(info));
294 sb = journal->j_superblock;
297 * The journal superblock's s_start field (the current log head)
298 * is always zero if, and only if, the journal was cleanly
302 jbd2_debug(1, "No recovery required, last transaction %d, head block %u\n",
303 be32_to_cpu(sb->s_sequence), be32_to_cpu(sb->s_head));
304 journal->j_transaction_sequence = be32_to_cpu(sb->s_sequence) + 1;
305 journal->j_head = be32_to_cpu(sb->s_head);
309 err = do_one_pass(journal, &info, PASS_SCAN);
311 err = do_one_pass(journal, &info, PASS_REVOKE);
313 err = do_one_pass(journal, &info, PASS_REPLAY);
315 jbd2_debug(1, "JBD2: recovery, exit status %d, "
316 "recovered transactions %u to %u\n",
317 err, info.start_transaction, info.end_transaction);
318 jbd2_debug(1, "JBD2: Replayed %d and revoked %d/%d blocks\n",
319 info.nr_replays, info.nr_revoke_hits, info.nr_revokes);
321 /* Restart the log at the next transaction ID, thus invalidating
322 * any existing commit records in the log. */
323 journal->j_transaction_sequence = ++info.end_transaction;
324 journal->j_head = info.head_block;
325 jbd2_debug(1, "JBD2: last transaction %d, head block %lu\n",
326 journal->j_transaction_sequence, journal->j_head);
328 jbd2_journal_clear_revoke(journal);
329 err2 = sync_blockdev(journal->j_fs_dev);
332 /* Make sure all replayed data is on permanent storage */
333 if (journal->j_flags & JBD2_BARRIER) {
334 err2 = blkdev_issue_flush(journal->j_fs_dev);
342 * jbd2_journal_skip_recovery - Start journal and wipe exiting records
343 * @journal: journal to startup
345 * Locate any valid recovery information from the journal and set up the
346 * journal structures in memory to ignore it (presumably because the
347 * caller has evidence that it is out of date).
348 * This function doesn't appear to be exported..
350 * We perform one pass over the journal to allow us to tell the user how
351 * much recovery information is being erased, and to let us initialise
352 * the journal transaction sequence numbers to the next unused ID.
354 int jbd2_journal_skip_recovery(journal_t *journal)
358 struct recovery_info info;
360 memset (&info, 0, sizeof(info));
362 err = do_one_pass(journal, &info, PASS_SCAN);
365 printk(KERN_ERR "JBD2: error %d scanning journal\n", err);
366 ++journal->j_transaction_sequence;
367 journal->j_head = journal->j_first;
369 #ifdef CONFIG_JBD2_DEBUG
370 int dropped = info.end_transaction -
371 be32_to_cpu(journal->j_superblock->s_sequence);
373 "JBD2: ignoring %d transaction%s from the journal.\n",
374 dropped, (dropped == 1) ? "" : "s");
376 journal->j_transaction_sequence = ++info.end_transaction;
377 journal->j_head = info.head_block;
384 static inline unsigned long long read_tag_block(journal_t *journal,
385 journal_block_tag_t *tag)
387 unsigned long long block = be32_to_cpu(tag->t_blocknr);
388 if (jbd2_has_feature_64bit(journal))
389 block |= (u64)be32_to_cpu(tag->t_blocknr_high) << 32;
394 * calc_chksums calculates the checksums for the blocks described in the
397 static int calc_chksums(journal_t *journal, struct buffer_head *bh,
398 unsigned long *next_log_block, __u32 *crc32_sum)
400 int i, num_blks, err;
401 unsigned long io_block;
402 struct buffer_head *obh;
404 num_blks = count_tags(journal, bh);
405 /* Calculate checksum of the descriptor block. */
406 *crc32_sum = crc32_be(*crc32_sum, (void *)bh->b_data, bh->b_size);
408 for (i = 0; i < num_blks; i++) {
409 io_block = (*next_log_block)++;
410 wrap(journal, *next_log_block);
411 err = jread(&obh, journal, io_block);
413 printk(KERN_ERR "JBD2: IO error %d recovering block "
414 "%lu in log\n", err, io_block);
417 *crc32_sum = crc32_be(*crc32_sum, (void *)obh->b_data,
425 static int jbd2_commit_block_csum_verify(journal_t *j, void *buf)
427 struct commit_header *h;
431 if (!jbd2_journal_has_csum_v2or3(j))
435 provided = h->h_chksum[0];
437 calculated = jbd2_chksum(j, j->j_csum_seed, buf, j->j_blocksize);
438 h->h_chksum[0] = provided;
440 return provided == cpu_to_be32(calculated);
443 static int jbd2_block_tag_csum_verify(journal_t *j, journal_block_tag_t *tag,
444 journal_block_tag3_t *tag3,
445 void *buf, __u32 sequence)
450 if (!jbd2_journal_has_csum_v2or3(j))
453 seq = cpu_to_be32(sequence);
454 csum32 = jbd2_chksum(j, j->j_csum_seed, (__u8 *)&seq, sizeof(seq));
455 csum32 = jbd2_chksum(j, csum32, buf, j->j_blocksize);
457 if (jbd2_has_feature_csum3(j))
458 return tag3->t_checksum == cpu_to_be32(csum32);
460 return tag->t_checksum == cpu_to_be16(csum32);
463 static int do_one_pass(journal_t *journal,
464 struct recovery_info *info, enum passtype pass)
466 unsigned int first_commit_ID, next_commit_ID;
467 unsigned long next_log_block, head_block;
468 int err, success = 0;
469 journal_superblock_t * sb;
470 journal_header_t * tmp;
471 struct buffer_head * bh;
472 unsigned int sequence;
474 int tag_bytes = journal_tag_bytes(journal);
475 __u32 crc32_sum = ~0; /* Transactional Checksums */
476 int descr_csum_size = 0;
478 bool need_check_commit_time = false;
479 __u64 last_trans_commit_time = 0, commit_time;
482 * First thing is to establish what we expect to find in the log
483 * (in terms of transaction IDs), and where (in terms of log
484 * block offsets): query the superblock.
487 sb = journal->j_superblock;
488 next_commit_ID = be32_to_cpu(sb->s_sequence);
489 next_log_block = be32_to_cpu(sb->s_start);
490 head_block = next_log_block;
492 first_commit_ID = next_commit_ID;
493 if (pass == PASS_SCAN)
494 info->start_transaction = first_commit_ID;
496 jbd2_debug(1, "Starting recovery pass %d\n", pass);
499 * Now we walk through the log, transaction by transaction,
500 * making sure that each transaction has a commit block in the
501 * expected place. Each complete transaction gets replayed back
502 * into the main filesystem.
508 journal_block_tag_t tag;
509 struct buffer_head * obh;
510 struct buffer_head * nbh;
514 /* If we already know where to stop the log traversal,
515 * check right now that we haven't gone past the end of
518 if (pass != PASS_SCAN)
519 if (tid_geq(next_commit_ID, info->end_transaction))
522 jbd2_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
523 next_commit_ID, next_log_block, journal->j_last);
525 /* Skip over each chunk of the transaction looking
526 * either the next descriptor block or the final commit
529 jbd2_debug(3, "JBD2: checking block %ld\n", next_log_block);
530 err = jread(&bh, journal, next_log_block);
535 wrap(journal, next_log_block);
537 /* What kind of buffer is it?
539 * If it is a descriptor block, check that it has the
540 * expected sequence number. Otherwise, we're all done
543 tmp = (journal_header_t *)bh->b_data;
545 if (tmp->h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER)) {
550 blocktype = be32_to_cpu(tmp->h_blocktype);
551 sequence = be32_to_cpu(tmp->h_sequence);
552 jbd2_debug(3, "Found magic %d, sequence %d\n",
553 blocktype, sequence);
555 if (sequence != next_commit_ID) {
560 /* OK, we have a valid descriptor block which matches
561 * all of the sequence number checks. What are we going
562 * to do with it? That depends on the pass... */
565 case JBD2_DESCRIPTOR_BLOCK:
566 /* Verify checksum first */
567 if (jbd2_journal_has_csum_v2or3(journal))
569 sizeof(struct jbd2_journal_block_tail);
570 if (descr_csum_size > 0 &&
571 !jbd2_descriptor_block_csum_verify(journal,
574 * PASS_SCAN can see stale blocks due to lazy
575 * journal init. Don't error out on those yet.
577 if (pass != PASS_SCAN) {
578 pr_err("JBD2: Invalid checksum recovering block %lu in log\n",
584 need_check_commit_time = true;
586 "invalid descriptor block found in %lu\n",
590 /* If it is a valid descriptor block, replay it
591 * in pass REPLAY; if journal_checksums enabled, then
592 * calculate checksums in PASS_SCAN, otherwise,
593 * just skip over the blocks it describes. */
594 if (pass != PASS_REPLAY) {
595 if (pass == PASS_SCAN &&
596 jbd2_has_feature_checksum(journal) &&
597 !need_check_commit_time &&
598 !info->end_transaction) {
599 if (calc_chksums(journal, bh,
608 next_log_block += count_tags(journal, bh);
609 wrap(journal, next_log_block);
614 /* A descriptor block: we can now write all of
615 * the data blocks. Yay, useful work is finally
616 * getting done here! */
618 tagp = &bh->b_data[sizeof(journal_header_t)];
619 while ((tagp - bh->b_data + tag_bytes)
620 <= journal->j_blocksize - descr_csum_size) {
621 unsigned long io_block;
623 memcpy(&tag, tagp, sizeof(tag));
624 flags = be16_to_cpu(tag.t_flags);
626 io_block = next_log_block++;
627 wrap(journal, next_log_block);
628 err = jread(&obh, journal, io_block);
630 /* Recover what we can, but
631 * report failure at the end. */
634 "JBD2: IO error %d recovering "
635 "block %ld in log\n",
638 unsigned long long blocknr;
640 J_ASSERT(obh != NULL);
641 blocknr = read_tag_block(journal,
644 /* If the block has been
645 * revoked, then we're all done
647 if (jbd2_journal_test_revoke
651 ++info->nr_revoke_hits;
655 /* Look for block corruption */
656 if (!jbd2_block_tag_csum_verify(
657 journal, &tag, (journal_block_tag3_t *)tagp,
658 obh->b_data, be32_to_cpu(tmp->h_sequence))) {
660 success = -EFSBADCRC;
661 printk(KERN_ERR "JBD2: Invalid "
662 "checksum recovering "
663 "data block %llu in "
669 /* Find a buffer for the new
670 * data being restored */
671 nbh = __getblk(journal->j_fs_dev,
673 journal->j_blocksize);
676 "JBD2: Out of memory "
677 "during recovery.\n");
685 memcpy(nbh->b_data, obh->b_data,
686 journal->j_blocksize);
687 if (flags & JBD2_FLAG_ESCAPE) {
688 *((__be32 *)nbh->b_data) =
689 cpu_to_be32(JBD2_MAGIC_NUMBER);
692 BUFFER_TRACE(nbh, "marking dirty");
693 set_buffer_uptodate(nbh);
694 mark_buffer_dirty(nbh);
695 BUFFER_TRACE(nbh, "marking uptodate");
704 if (!(flags & JBD2_FLAG_SAME_UUID))
707 if (flags & JBD2_FLAG_LAST_TAG)
714 case JBD2_COMMIT_BLOCK:
715 /* How to differentiate between interrupted commit
716 * and journal corruption ?
719 * Checksum Verification Failed
721 * ____________________
723 * async_commit sync_commit
725 * | GO TO NEXT "Journal Corruption"
728 * {(n+1)th transanction}
730 * _______|______________
732 * Commit block found Commit block not found
734 * "Journal Corruption" |
735 * _____________|_________
737 * nth trans corrupt OR nth trans
738 * and (n+1)th interrupted interrupted
739 * before commit block
740 * could reach the disk.
741 * (Cannot find the difference in above
742 * mentioned conditions. Hence assume
743 * "Interrupted Commit".)
745 commit_time = be64_to_cpu(
746 ((struct commit_header *)bh->b_data)->h_commit_sec);
748 * If need_check_commit_time is set, it means we are in
749 * PASS_SCAN and csum verify failed before. If
750 * commit_time is increasing, it's the same journal,
751 * otherwise it is stale journal block, just end this
754 if (need_check_commit_time) {
755 if (commit_time >= last_trans_commit_time) {
756 pr_err("JBD2: Invalid checksum found in transaction %u\n",
764 * It likely does not belong to same journal,
765 * just end this recovery with success.
767 jbd2_debug(1, "JBD2: Invalid checksum ignored in transaction %u, likely stale data\n",
774 * Found an expected commit block: if checksums
775 * are present, verify them in PASS_SCAN; else not
776 * much to do other than move on to the next sequence
779 if (pass == PASS_SCAN &&
780 jbd2_has_feature_checksum(journal)) {
781 struct commit_header *cbh =
782 (struct commit_header *)bh->b_data;
783 unsigned found_chksum =
784 be32_to_cpu(cbh->h_chksum[0]);
786 if (info->end_transaction) {
787 journal->j_failed_commit =
788 info->end_transaction;
793 /* Neither checksum match nor unused? */
794 if (!((crc32_sum == found_chksum &&
795 cbh->h_chksum_type ==
797 cbh->h_chksum_size ==
798 JBD2_CRC32_CHKSUM_SIZE) ||
799 (cbh->h_chksum_type == 0 &&
800 cbh->h_chksum_size == 0 &&
806 if (pass == PASS_SCAN &&
807 !jbd2_commit_block_csum_verify(journal,
810 if (commit_time < last_trans_commit_time)
811 goto ignore_crc_mismatch;
812 info->end_transaction = next_commit_ID;
813 info->head_block = head_block;
815 if (!jbd2_has_feature_async_commit(journal)) {
816 journal->j_failed_commit =
822 if (pass == PASS_SCAN) {
823 last_trans_commit_time = commit_time;
824 head_block = next_log_block;
830 case JBD2_REVOKE_BLOCK:
832 * Check revoke block crc in pass_scan, if csum verify
833 * failed, check commit block time later.
835 if (pass == PASS_SCAN &&
836 !jbd2_descriptor_block_csum_verify(journal,
838 jbd2_debug(1, "JBD2: invalid revoke block found in %lu\n",
840 need_check_commit_time = true;
842 /* If we aren't in the REVOKE pass, then we can
843 * just skip over this block. */
844 if (pass != PASS_REVOKE) {
849 err = scan_revoke_records(journal, bh,
850 next_commit_ID, info);
857 jbd2_debug(3, "Unrecognised magic %d, end of scan.\n",
866 * We broke out of the log scan loop: either we came to the
867 * known end of the log or we found an unexpected block in the
868 * log. If the latter happened, then we know that the "current"
869 * transaction marks the end of the valid log.
872 if (pass == PASS_SCAN) {
873 if (!info->end_transaction)
874 info->end_transaction = next_commit_ID;
875 if (!info->head_block)
876 info->head_block = head_block;
878 /* It's really bad news if different passes end up at
879 * different places (but possible due to IO errors). */
880 if (info->end_transaction != next_commit_ID) {
881 printk(KERN_ERR "JBD2: recovery pass %d ended at "
882 "transaction %u, expected %u\n",
883 pass, next_commit_ID, info->end_transaction);
889 if (jbd2_has_feature_fast_commit(journal) && pass != PASS_REVOKE) {
890 err = fc_do_one_pass(journal, info, pass);
895 if (block_error && success == 0)
903 /* Scan a revoke record, marking all blocks mentioned as revoked. */
905 static int scan_revoke_records(journal_t *journal, struct buffer_head *bh,
906 tid_t sequence, struct recovery_info *info)
908 jbd2_journal_revoke_header_t *header;
910 unsigned csum_size = 0;
914 header = (jbd2_journal_revoke_header_t *) bh->b_data;
915 offset = sizeof(jbd2_journal_revoke_header_t);
916 rcount = be32_to_cpu(header->r_count);
918 if (jbd2_journal_has_csum_v2or3(journal))
919 csum_size = sizeof(struct jbd2_journal_block_tail);
920 if (rcount > journal->j_blocksize - csum_size)
924 if (jbd2_has_feature_64bit(journal))
927 while (offset + record_len <= max) {
928 unsigned long long blocknr;
932 blocknr = be32_to_cpu(* ((__be32 *) (bh->b_data+offset)));
934 blocknr = be64_to_cpu(* ((__be64 *) (bh->b_data+offset)));
935 offset += record_len;
936 err = jbd2_journal_set_revoke(journal, blocknr, sequence);