1 // SPDX-License-Identifier: GPL-2.0+
3 * linux/fs/jbd2/recovery.c
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;
38 enum passtype {PASS_SCAN, PASS_REVOKE, PASS_REPLAY};
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_maxlen)
79 max = journal->j_maxlen;
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 ll_rw_block(REQ_OP_READ, 0, nbufs, bufs);
105 journal_brelse_array(bufs, nbufs);
113 ll_rw_block(REQ_OP_READ, 0, nbufs, bufs);
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_maxlen) {
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)) {
156 /* If this is a brand new buffer, start readahead.
157 Otherwise, we assume we are already reading it. */
159 do_readahead(journal, offset);
163 if (!buffer_uptodate(bh)) {
164 printk(KERN_ERR "JBD2: Failed to read block at offset %u\n",
174 static int jbd2_descriptor_block_csum_verify(journal_t *j, void *buf)
176 struct jbd2_journal_block_tail *tail;
180 if (!jbd2_journal_has_csum_v2or3(j))
183 tail = (struct jbd2_journal_block_tail *)(buf + j->j_blocksize -
184 sizeof(struct jbd2_journal_block_tail));
185 provided = tail->t_checksum;
186 tail->t_checksum = 0;
187 calculated = jbd2_chksum(j, j->j_csum_seed, buf, j->j_blocksize);
188 tail->t_checksum = provided;
190 return provided == cpu_to_be32(calculated);
194 * Count the number of in-use tags in a journal descriptor block.
197 static int count_tags(journal_t *journal, struct buffer_head *bh)
200 journal_block_tag_t * tag;
201 int nr = 0, size = journal->j_blocksize;
202 int tag_bytes = journal_tag_bytes(journal);
204 if (jbd2_journal_has_csum_v2or3(journal))
205 size -= sizeof(struct jbd2_journal_block_tail);
207 tagp = &bh->b_data[sizeof(journal_header_t)];
209 while ((tagp - bh->b_data + tag_bytes) <= size) {
210 tag = (journal_block_tag_t *) tagp;
214 if (!(tag->t_flags & cpu_to_be16(JBD2_FLAG_SAME_UUID)))
217 if (tag->t_flags & cpu_to_be16(JBD2_FLAG_LAST_TAG))
225 /* Make sure we wrap around the log correctly! */
226 #define wrap(journal, var) \
228 if (var >= (journal)->j_last) \
229 var -= ((journal)->j_last - (journal)->j_first); \
233 * jbd2_journal_recover - recovers a on-disk journal
234 * @journal: the journal to recover
236 * The primary function for recovering the log contents when mounting a
239 * Recovery is done in three passes. In the first pass, we look for the
240 * end of the log. In the second, we assemble the list of revoke
241 * blocks. In the third and final pass, we replay any un-revoked blocks
244 int jbd2_journal_recover(journal_t *journal)
247 journal_superblock_t * sb;
249 struct recovery_info info;
251 memset(&info, 0, sizeof(info));
252 sb = journal->j_superblock;
255 * The journal superblock's s_start field (the current log head)
256 * is always zero if, and only if, the journal was cleanly
261 jbd_debug(1, "No recovery required, last transaction %d\n",
262 be32_to_cpu(sb->s_sequence));
263 journal->j_transaction_sequence = be32_to_cpu(sb->s_sequence) + 1;
267 err = do_one_pass(journal, &info, PASS_SCAN);
269 err = do_one_pass(journal, &info, PASS_REVOKE);
271 err = do_one_pass(journal, &info, PASS_REPLAY);
273 jbd_debug(1, "JBD2: recovery, exit status %d, "
274 "recovered transactions %u to %u\n",
275 err, info.start_transaction, info.end_transaction);
276 jbd_debug(1, "JBD2: Replayed %d and revoked %d/%d blocks\n",
277 info.nr_replays, info.nr_revoke_hits, info.nr_revokes);
279 /* Restart the log at the next transaction ID, thus invalidating
280 * any existing commit records in the log. */
281 journal->j_transaction_sequence = ++info.end_transaction;
283 jbd2_journal_clear_revoke(journal);
284 err2 = sync_blockdev(journal->j_fs_dev);
287 /* Make sure all replayed data is on permanent storage */
288 if (journal->j_flags & JBD2_BARRIER) {
289 err2 = blkdev_issue_flush(journal->j_fs_dev, GFP_KERNEL, NULL);
297 * jbd2_journal_skip_recovery - Start journal and wipe exiting records
298 * @journal: journal to startup
300 * Locate any valid recovery information from the journal and set up the
301 * journal structures in memory to ignore it (presumably because the
302 * caller has evidence that it is out of date).
303 * This function doesn't appear to be exported..
305 * We perform one pass over the journal to allow us to tell the user how
306 * much recovery information is being erased, and to let us initialise
307 * the journal transaction sequence numbers to the next unused ID.
309 int jbd2_journal_skip_recovery(journal_t *journal)
313 struct recovery_info info;
315 memset (&info, 0, sizeof(info));
317 err = do_one_pass(journal, &info, PASS_SCAN);
320 printk(KERN_ERR "JBD2: error %d scanning journal\n", err);
321 ++journal->j_transaction_sequence;
323 #ifdef CONFIG_JBD2_DEBUG
324 int dropped = info.end_transaction -
325 be32_to_cpu(journal->j_superblock->s_sequence);
327 "JBD2: ignoring %d transaction%s from the journal.\n",
328 dropped, (dropped == 1) ? "" : "s");
330 journal->j_transaction_sequence = ++info.end_transaction;
337 static inline unsigned long long read_tag_block(journal_t *journal,
338 journal_block_tag_t *tag)
340 unsigned long long block = be32_to_cpu(tag->t_blocknr);
341 if (jbd2_has_feature_64bit(journal))
342 block |= (u64)be32_to_cpu(tag->t_blocknr_high) << 32;
347 * calc_chksums calculates the checksums for the blocks described in the
350 static int calc_chksums(journal_t *journal, struct buffer_head *bh,
351 unsigned long *next_log_block, __u32 *crc32_sum)
353 int i, num_blks, err;
354 unsigned long io_block;
355 struct buffer_head *obh;
357 num_blks = count_tags(journal, bh);
358 /* Calculate checksum of the descriptor block. */
359 *crc32_sum = crc32_be(*crc32_sum, (void *)bh->b_data, bh->b_size);
361 for (i = 0; i < num_blks; i++) {
362 io_block = (*next_log_block)++;
363 wrap(journal, *next_log_block);
364 err = jread(&obh, journal, io_block);
366 printk(KERN_ERR "JBD2: IO error %d recovering block "
367 "%lu in log\n", err, io_block);
370 *crc32_sum = crc32_be(*crc32_sum, (void *)obh->b_data,
378 static int jbd2_commit_block_csum_verify(journal_t *j, void *buf)
380 struct commit_header *h;
384 if (!jbd2_journal_has_csum_v2or3(j))
388 provided = h->h_chksum[0];
390 calculated = jbd2_chksum(j, j->j_csum_seed, buf, j->j_blocksize);
391 h->h_chksum[0] = provided;
393 return provided == cpu_to_be32(calculated);
396 static int jbd2_block_tag_csum_verify(journal_t *j, journal_block_tag_t *tag,
397 void *buf, __u32 sequence)
399 journal_block_tag3_t *tag3 = (journal_block_tag3_t *)tag;
403 if (!jbd2_journal_has_csum_v2or3(j))
406 seq = cpu_to_be32(sequence);
407 csum32 = jbd2_chksum(j, j->j_csum_seed, (__u8 *)&seq, sizeof(seq));
408 csum32 = jbd2_chksum(j, csum32, buf, j->j_blocksize);
410 if (jbd2_has_feature_csum3(j))
411 return tag3->t_checksum == cpu_to_be32(csum32);
413 return tag->t_checksum == cpu_to_be16(csum32);
416 static int do_one_pass(journal_t *journal,
417 struct recovery_info *info, enum passtype pass)
419 unsigned int first_commit_ID, next_commit_ID;
420 unsigned long next_log_block;
421 int err, success = 0;
422 journal_superblock_t * sb;
423 journal_header_t * tmp;
424 struct buffer_head * bh;
425 unsigned int sequence;
427 int tag_bytes = journal_tag_bytes(journal);
428 __u32 crc32_sum = ~0; /* Transactional Checksums */
429 int descr_csum_size = 0;
433 * First thing is to establish what we expect to find in the log
434 * (in terms of transaction IDs), and where (in terms of log
435 * block offsets): query the superblock.
438 sb = journal->j_superblock;
439 next_commit_ID = be32_to_cpu(sb->s_sequence);
440 next_log_block = be32_to_cpu(sb->s_start);
442 first_commit_ID = next_commit_ID;
443 if (pass == PASS_SCAN)
444 info->start_transaction = first_commit_ID;
446 jbd_debug(1, "Starting recovery pass %d\n", pass);
449 * Now we walk through the log, transaction by transaction,
450 * making sure that each transaction has a commit block in the
451 * expected place. Each complete transaction gets replayed back
452 * into the main filesystem.
458 journal_block_tag_t * tag;
459 struct buffer_head * obh;
460 struct buffer_head * nbh;
464 /* If we already know where to stop the log traversal,
465 * check right now that we haven't gone past the end of
468 if (pass != PASS_SCAN)
469 if (tid_geq(next_commit_ID, info->end_transaction))
472 jbd_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
473 next_commit_ID, next_log_block, journal->j_last);
475 /* Skip over each chunk of the transaction looking
476 * either the next descriptor block or the final commit
479 jbd_debug(3, "JBD2: checking block %ld\n", next_log_block);
480 err = jread(&bh, journal, next_log_block);
485 wrap(journal, next_log_block);
487 /* What kind of buffer is it?
489 * If it is a descriptor block, check that it has the
490 * expected sequence number. Otherwise, we're all done
493 tmp = (journal_header_t *)bh->b_data;
495 if (tmp->h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER)) {
500 blocktype = be32_to_cpu(tmp->h_blocktype);
501 sequence = be32_to_cpu(tmp->h_sequence);
502 jbd_debug(3, "Found magic %d, sequence %d\n",
503 blocktype, sequence);
505 if (sequence != next_commit_ID) {
510 /* OK, we have a valid descriptor block which matches
511 * all of the sequence number checks. What are we going
512 * to do with it? That depends on the pass... */
515 case JBD2_DESCRIPTOR_BLOCK:
516 /* Verify checksum first */
517 if (jbd2_journal_has_csum_v2or3(journal))
519 sizeof(struct jbd2_journal_block_tail);
520 if (descr_csum_size > 0 &&
521 !jbd2_descriptor_block_csum_verify(journal,
523 printk(KERN_ERR "JBD2: Invalid checksum "
524 "recovering block %lu in log\n",
531 /* If it is a valid descriptor block, replay it
532 * in pass REPLAY; if journal_checksums enabled, then
533 * calculate checksums in PASS_SCAN, otherwise,
534 * just skip over the blocks it describes. */
535 if (pass != PASS_REPLAY) {
536 if (pass == PASS_SCAN &&
537 jbd2_has_feature_checksum(journal) &&
538 !info->end_transaction) {
539 if (calc_chksums(journal, bh,
548 next_log_block += count_tags(journal, bh);
549 wrap(journal, next_log_block);
554 /* A descriptor block: we can now write all of
555 * the data blocks. Yay, useful work is finally
556 * getting done here! */
558 tagp = &bh->b_data[sizeof(journal_header_t)];
559 while ((tagp - bh->b_data + tag_bytes)
560 <= journal->j_blocksize - descr_csum_size) {
561 unsigned long io_block;
563 tag = (journal_block_tag_t *) tagp;
564 flags = be16_to_cpu(tag->t_flags);
566 io_block = next_log_block++;
567 wrap(journal, next_log_block);
568 err = jread(&obh, journal, io_block);
570 /* Recover what we can, but
571 * report failure at the end. */
574 "JBD2: IO error %d recovering "
575 "block %ld in log\n",
578 unsigned long long blocknr;
580 J_ASSERT(obh != NULL);
581 blocknr = read_tag_block(journal,
584 /* If the block has been
585 * revoked, then we're all done
587 if (jbd2_journal_test_revoke
591 ++info->nr_revoke_hits;
595 /* Look for block corruption */
596 if (!jbd2_block_tag_csum_verify(
597 journal, tag, obh->b_data,
598 be32_to_cpu(tmp->h_sequence))) {
600 success = -EFSBADCRC;
601 printk(KERN_ERR "JBD2: Invalid "
602 "checksum recovering "
603 "data block %llu in "
609 /* Find a buffer for the new
610 * data being restored */
611 nbh = __getblk(journal->j_fs_dev,
613 journal->j_blocksize);
616 "JBD2: Out of memory "
617 "during recovery.\n");
625 memcpy(nbh->b_data, obh->b_data,
626 journal->j_blocksize);
627 if (flags & JBD2_FLAG_ESCAPE) {
628 *((__be32 *)nbh->b_data) =
629 cpu_to_be32(JBD2_MAGIC_NUMBER);
632 BUFFER_TRACE(nbh, "marking dirty");
633 set_buffer_uptodate(nbh);
634 mark_buffer_dirty(nbh);
635 BUFFER_TRACE(nbh, "marking uptodate");
637 /* ll_rw_block(WRITE, 1, &nbh); */
645 if (!(flags & JBD2_FLAG_SAME_UUID))
648 if (flags & JBD2_FLAG_LAST_TAG)
655 case JBD2_COMMIT_BLOCK:
656 /* How to differentiate between interrupted commit
657 * and journal corruption ?
660 * Checksum Verification Failed
662 * ____________________
664 * async_commit sync_commit
666 * | GO TO NEXT "Journal Corruption"
669 * {(n+1)th transanction}
671 * _______|______________
673 * Commit block found Commit block not found
675 * "Journal Corruption" |
676 * _____________|_________
678 * nth trans corrupt OR nth trans
679 * and (n+1)th interrupted interrupted
680 * before commit block
681 * could reach the disk.
682 * (Cannot find the difference in above
683 * mentioned conditions. Hence assume
684 * "Interrupted Commit".)
687 /* Found an expected commit block: if checksums
688 * are present verify them in PASS_SCAN; else not
689 * much to do other than move on to the next sequence
691 if (pass == PASS_SCAN &&
692 jbd2_has_feature_checksum(journal)) {
693 int chksum_err, chksum_seen;
694 struct commit_header *cbh =
695 (struct commit_header *)bh->b_data;
696 unsigned found_chksum =
697 be32_to_cpu(cbh->h_chksum[0]);
699 chksum_err = chksum_seen = 0;
701 if (info->end_transaction) {
702 journal->j_failed_commit =
703 info->end_transaction;
708 if (crc32_sum == found_chksum &&
709 cbh->h_chksum_type == JBD2_CRC32_CHKSUM &&
710 cbh->h_chksum_size ==
711 JBD2_CRC32_CHKSUM_SIZE)
713 else if (!(cbh->h_chksum_type == 0 &&
714 cbh->h_chksum_size == 0 &&
718 * If fs is mounted using an old kernel and then
719 * kernel with journal_chksum is used then we
720 * get a situation where the journal flag has
721 * checksum flag set but checksums are not
722 * present i.e chksum = 0, in the individual
724 * Hence to avoid checksum failures, in this
725 * situation, this extra check is added.
730 info->end_transaction = next_commit_ID;
732 if (!jbd2_has_feature_async_commit(journal)) {
733 journal->j_failed_commit =
741 if (pass == PASS_SCAN &&
742 !jbd2_commit_block_csum_verify(journal,
744 info->end_transaction = next_commit_ID;
746 if (!jbd2_has_feature_async_commit(journal)) {
747 journal->j_failed_commit =
757 case JBD2_REVOKE_BLOCK:
758 /* If we aren't in the REVOKE pass, then we can
759 * just skip over this block. */
760 if (pass != PASS_REVOKE) {
765 err = scan_revoke_records(journal, bh,
766 next_commit_ID, info);
773 jbd_debug(3, "Unrecognised magic %d, end of scan.\n",
782 * We broke out of the log scan loop: either we came to the
783 * known end of the log or we found an unexpected block in the
784 * log. If the latter happened, then we know that the "current"
785 * transaction marks the end of the valid log.
788 if (pass == PASS_SCAN) {
789 if (!info->end_transaction)
790 info->end_transaction = next_commit_ID;
792 /* It's really bad news if different passes end up at
793 * different places (but possible due to IO errors). */
794 if (info->end_transaction != next_commit_ID) {
795 printk(KERN_ERR "JBD2: recovery pass %d ended at "
796 "transaction %u, expected %u\n",
797 pass, next_commit_ID, info->end_transaction);
802 if (block_error && success == 0)
810 /* Scan a revoke record, marking all blocks mentioned as revoked. */
812 static int scan_revoke_records(journal_t *journal, struct buffer_head *bh,
813 tid_t sequence, struct recovery_info *info)
815 jbd2_journal_revoke_header_t *header;
821 header = (jbd2_journal_revoke_header_t *) bh->b_data;
822 offset = sizeof(jbd2_journal_revoke_header_t);
823 rcount = be32_to_cpu(header->r_count);
825 if (!jbd2_descriptor_block_csum_verify(journal, header))
828 if (jbd2_journal_has_csum_v2or3(journal))
829 csum_size = sizeof(struct jbd2_journal_block_tail);
830 if (rcount > journal->j_blocksize - csum_size)
834 if (jbd2_has_feature_64bit(journal))
837 while (offset + record_len <= max) {
838 unsigned long long blocknr;
842 blocknr = be32_to_cpu(* ((__be32 *) (bh->b_data+offset)));
844 blocknr = be64_to_cpu(* ((__be64 *) (bh->b_data+offset)));
845 offset += record_len;
846 err = jbd2_journal_set_revoke(journal, blocknr, sequence);