e2fsck/recovery.c

   1 /*
   2  * linux/fs/recovery.c
   3  *
   4  * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
   5  *
   6  * Copyright 1999-2000 Red Hat Software --- All Rights Reserved
   7  *
   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.
  11  *
  12  * Journal recovery routines for the generic filesystem journaling code;
  13  * part of the ext2fs journaling system.
  14  */
  15
  16 #ifndef __KERNEL__
  17 #include "jfs_user.h"
  18 #else
  19 #include <linux/sched.h>
  20 #include <linux/fs.h>
  21 #include <linux/jfs.h>
  22 #include <linux/errno.h>
  23 #include <linux/malloc.h>
  24 #include <linux/locks.h>
  25 #include <linux/buffer.h>
  26 #endif
  27
  28 /*
  29  * Maintain information about the progress of the recovery job, so that
  30  * the different passes can carry information between them.
  31  */
  32 struct recovery_info
  33 {
  34         tid_t           start_transaction;
  35         tid_t           end_transaction;
  36
  37         int             nr_replays;
  38         int             nr_revokes;
  39         int             nr_revoke_hits;
  40 };
  41
  42 enum passtype {PASS_SCAN, PASS_REVOKE, PASS_REPLAY};
  43 static int do_one_pass(journal_t *, struct recovery_info *, enum passtype);
  44 static int scan_revoke_records(journal_t *, struct buffer_head *, tid_t, struct recovery_info *);
  45
  46 #ifdef __KERNEL__
  47
  48 /* Release readahead buffers after use */
  49 static void brelse_array(struct buffer_head *b[], int n)
  50 {
  51         while (--n >= 0)
  52                 brelse (b[n]);
  53 }
  54
  55
  56 /*
  57  * When reading from the journal, we are going through the block device
  58  * layer directly and so there is no readahead being done for us.  We
  59  * need to implement any readahead ourselves if we want it to happen at
  60  * all.  Recovery is basically one long sequential read, so make sure we
  61  * do the IO in reasonably large chunks.
  62  *
  63  * This is not so critical that we need to be enormously clever about
  64  * the readahead size, though.  128K is a purely arbitrary, good-enough
  65  * fixed value.
  66  */
  67
  68 #define MAXBUF 8
  69 static int do_readahead(journal_t *journal, unsigned int start)
  70 {
  71         int err;
  72         unsigned int max, nbufs, next, blocknr;
  73         struct buffer_head *bh;
  74
  75         struct buffer_head * bufs[MAXBUF];
  76
  77         /* Do up to 128K of readahead */
  78         max = start + (128 * 1024 / journal->j_blocksize);
  79         if (max > journal->j_maxlen)
  80                 max = journal->j_maxlen;
  81
  82         /* Do the readahead itself.  We'll submit MAXBUF buffer_heads at
  83          * a time to the block device IO layer. */
  84
  85         nbufs = 0;
  86
  87         for (next = start; next < max; next++) {
  88                 blocknr = next;
  89                 if (journal->j_inode)
  90                         blocknr = bmap(journal->j_inode, next);
  91                 if (!blocknr) {
  92                         printk (KERN_ERR "JFS: bad block at offset %u\n",
  93                                 next);
  94                         err = -EIO;
  95                         goto failed;
  96                 }
  97
  98                 bh = getblk(journal->j_dev, blocknr, journal->j_blocksize);
  99                 if (!bh) {
 100                         err = -ENOMEM;
 101                         goto failed;
 102                 }
 103
 104                 if (!buffer_uptodate(bh) && !buffer_locked(bh)) {
 105                         bufs[nbufs++] = bh;
 106                         if (nbufs == MAXBUF) {
 107                                 ll_rw_block(READ, nbufs, bufs);
 108                                 brelse_array(bufs, nbufs);
 109                                 nbufs = 0;
 110                         }
 111                 } else
 112                         brelse(bh);
 113         }
 114
 115         if (nbufs)
 116                 ll_rw_block(READ, nbufs, bufs);
 117         err = 0;
 118
 119 failed:
 120         if (nbufs)
 121                 brelse_array(bufs, nbufs);
 122         return err;
 123 }
 124
 125 #endif /* __KERNEL__ */
 126
 127
 128 /*
 129  * Read a block from the journal
 130  */
 131
 132 static int jread(struct buffer_head **bhp, journal_t *journal,
 133                  unsigned int offset)
 134 {
 135         unsigned int blocknr;
 136         struct buffer_head *bh;
 137
 138         *bhp = NULL;
 139
 140         J_ASSERT (offset < journal->j_maxlen);
 141
 142         blocknr = offset;
 143         if (journal->j_inode)
 144                 blocknr = bmap(journal->j_inode, offset);
 145
 146         if (!blocknr) {
 147                 printk (KERN_ERR "JFS: bad block at offset %u\n",
 148                         offset);
 149                 return -EIO;
 150         }
 151
 152         bh = getblk(journal->j_dev, blocknr, journal->j_blocksize);
 153         if (!bh)
 154                 return -ENOMEM;
 155
 156         if (!buffer_uptodate(bh)) {
 157                 /* If this is a brand new buffer, start readahead.
 158                    Otherwise, we assume we are already reading it.  */
 159                 if (!buffer_req(bh))
 160                         do_readahead(journal, offset);
 161                 wait_on_buffer(bh);
 162         }
 163
 164         if (!buffer_uptodate(bh)) {
 165                 printk (KERN_ERR "JFS: Failed to read block at offset %u\n",
 166                         offset);
 167                 brelse(bh);
 168                 return -EIO;
 169         }
 170
 171         *bhp = bh;
 172         return 0;
 173 }
 174
 175
 176 /*
 177  * Count the number of in-use tags in a journal descriptor block.
 178  */
 179
 180 static int count_tags(struct buffer_head *bh, int size)
 181 {
 182         char *                  tagp;
 183         journal_block_tag_t *   tag;
 184         int                     nr = 0;
 185
 186         tagp = &bh->b_data[sizeof(journal_header_t)];
 187
 188         while ((tagp - bh->b_data + sizeof(journal_block_tag_t)) <= size) {
 189                 tag = (journal_block_tag_t *) tagp;
 190
 191                 nr++;
 192                 tagp += sizeof(journal_block_tag_t);
 193                 if (!(tag->t_flags & htonl(JFS_FLAG_SAME_UUID)))
 194                         tagp += 16;
 195
 196                 if (tag->t_flags & htonl(JFS_FLAG_LAST_TAG))
 197                         break;
 198         }
 199
 200         return nr;
 201 }
 202
 203
 204 /* Make sure we wrap around the log correctly! */
 205 #define wrap(journal, var)                                              \
 206 do {                                                                    \
 207         if (var >= (journal)->j_last)                                   \
 208                 var -= ((journal)->j_last - (journal)->j_first);        \
 209 } while (0)
 210
 211 /*
 212  * journal_recover
 213  *
 214  * The primary function for recovering the log contents when mounting a
 215  * journaled device.
 216  *
 217  * Recovery is done in three passes.  In the first pass, we look for the
 218  * end of the log.  In the second, we assemble the list of revoke
 219  * blocks.  In the third and final pass, we replay any un-revoked blocks
 220  * in the log.
 221  */
 222
 223 int journal_recover(journal_t *journal)
 224 {
 225         int                     err;
 226         journal_superblock_t *  sb;
 227
 228         struct recovery_info    info;
 229
 230         memset(&info, 0, sizeof(info));
 231         sb = journal->j_superblock;
 232
 233         /*
 234          * The journal superblock's s_start field (the current log head)
 235          * is always zero if, and only if, the journal was cleanly
 236          * unmounted.
 237          */
 238
 239         if (!sb->s_start) {
 240                 jfs_debug(1, "No recovery required, last transaction %d\n",
 241                           ntohl(sb->s_sequence));
 242                 journal->j_transaction_sequence = ntohl(sb->s_sequence) + 1;
 243                 return 0;
 244         }
 245
 246
 247         err = do_one_pass(journal, &info, PASS_SCAN);
 248         if (!err)
 249                 err = do_one_pass(journal, &info, PASS_REVOKE);
 250         if (!err)
 251                 err = do_one_pass(journal, &info, PASS_REPLAY);
 252
 253         jfs_debug(0, "JFS: recovery, exit status %d, "
 254                   "recovered transactions %u to %u\n",
 255                   err, info.start_transaction, info.end_transaction);
 256         jfs_debug(0, "JFS: Replayed %d and revoked %d/%d blocks\n",
 257                   info.nr_replays, info.nr_revoke_hits, info.nr_revokes);
 258
 259         /* Restart the log at the next transaction ID, thus invalidating
 260          * any existing commit records in the log. */
 261         journal->j_transaction_sequence = ++info.end_transaction;
 262
 263         journal_clear_revoke(journal);
 264         fsync_dev(journal->j_dev);
 265         return err;
 266 }
 267
 268 /*
 269  * journal_skip_recovery
 270  *
 271  * Locate any valid recovery information from the journal and set up the
 272  * journal structures in memory to ignore it (presumably because the
 273  * caller has evidence that it is out of date).
 274  *
 275  * We perform one pass over the journal to allow us to tell the user how
 276  * much recovery information is being erased, and to let us initialise
 277  * the journal transaction sequence numbers to the next unused ID.
 278  */
 279
 280 int journal_skip_recovery(journal_t *journal)
 281 {
 282         int                     err;
 283         journal_superblock_t *  sb;
 284
 285         struct recovery_info    info;
 286
 287         memset(&info, 0, sizeof(info));
 288         sb = journal->j_superblock;
 289
 290         err = do_one_pass(journal, &info, PASS_SCAN);
 291
 292         if (err) {
 293                 printk(KERN_ERR "JFS: error %d scanning journal\n", err);
 294                 ++journal->j_transaction_sequence;
 295         } else {
 296                 int dropped = info.end_transaction - ntohl(sb->s_sequence);
 297
 298                 jfs_debug(0,
 299                           "JFS: ignoring %d transaction%s from the journal.\n",
 300                           dropped, (dropped == 1) ? "" : "s");
 301                 journal->j_transaction_sequence = ++info.end_transaction;
 302         }
 303
 304         journal->j_tail = 0;
 305
 306         return err;
 307 }
 308
 309 static int do_one_pass(journal_t *journal, struct recovery_info *info,
 310                        enum passtype pass)
 311 {
 312
 313         unsigned int            first_commit_ID, next_commit_ID;
 314         unsigned long           next_log_block;
 315         int                     err, success = 0;
 316         journal_superblock_t *  sb;
 317         journal_header_t *      tmp;
 318         struct buffer_head *    bh;
 319         unsigned int            sequence;
 320         int                     blocktype;
 321
 322         /* Precompute the maximum metadata descriptors in a descriptor block */
 323         int                     MAX_BLOCKS_PER_DESC;
 324         MAX_BLOCKS_PER_DESC = ((journal->j_blocksize-sizeof(journal_header_t))
 325                                / sizeof(journal_block_tag_t));
 326
 327         /*
 328          * First thing is to establish what we expect to find in the log
 329          * (in terms of transaction IDs), and where (in terms of log
 330          * block offsets): query the superblock.
 331          */
 332
 333         sb = journal->j_superblock;
 334         next_commit_ID = ntohl(sb->s_sequence);
 335         next_log_block = ntohl(sb->s_start);
 336
 337         first_commit_ID = next_commit_ID;
 338         if (pass == PASS_SCAN)
 339                 info->start_transaction = first_commit_ID;
 340
 341         jfs_debug(1, "Starting recovery pass %d\n", pass);
 342
 343         /*
 344          * Now we walk through the log, transaction by transaction,
 345          * making sure that each transaction has a commit block in the
 346          * expected place.  Each complete transaction gets replayed back
 347          * into the main filesystem.
 348          */
 349
 350         while (1) {
 351                 int                     flags;
 352                 char *                  tagp;
 353                 journal_block_tag_t *   tag;
 354                 struct buffer_head *    obh;
 355                 struct buffer_head *    nbh;
 356
 357                 /* If we already know where to stop the log traversal,
 358                  * check right now that we haven't gone past the end of
 359                  * the log. */
 360
 361                 if (pass != PASS_SCAN)
 362                         if (tid_geq(next_commit_ID, info->end_transaction))
 363                                 break;
 364
 365                 jfs_debug(2, "Scanning for sequence ID %u at %lu/%lu\n",
 366                           next_commit_ID, next_log_block, journal->j_last);
 367
 368                 /* Skip over each chunk of the transaction looking
 369                  * either the next descriptor block or the final commit
 370                  * record. */
 371
 372                 jfs_debug(3, "JFS: checking block %ld\n", next_log_block);
 373                 err = jread(&bh, journal, next_log_block);
 374                 if (err)
 375                         goto failed;
 376
 377                 next_log_block++;
 378                 wrap(journal, next_log_block);
 379
 380                 /* What kind of buffer is it?
 381                  *
 382                  * If it is a descriptor block, check that it has the
 383                  * expected sequence number.  Otherwise, we're all done
 384                  * here. */
 385
 386                 tmp = (journal_header_t *) bh->b_data;
 387
 388                 if (tmp->h_magic != htonl(JFS_MAGIC_NUMBER)) {
 389                         brelse(bh);
 390                         break;
 391                 }
 392
 393                 blocktype = ntohl(tmp->h_blocktype);
 394                 sequence = ntohl(tmp->h_sequence);
 395                 jfs_debug(3, "Found magic %d, sequence %d\n",
 396                           blocktype, sequence);
 397
 398                 if (sequence != next_commit_ID) {
 399                         brelse(bh);
 400                         break;
 401                 }
 402
 403                 /* OK, we have a valid descriptor block which matches
 404                  * all of the sequence number checks.  What are we going
 405                  * to do with it?  That depends on the pass... */
 406
 407                 switch(blocktype) {
 408                 case JFS_DESCRIPTOR_BLOCK:
 409                         /* If it is a valid descriptor block, replay it
 410                          * in pass REPLAY; otherwise, just skip over the
 411                          * blocks it describes. */
 412                         if (pass != PASS_REPLAY) {
 413                                 next_log_block += count_tags(bh, journal->j_blocksize);
 414                                 wrap(journal, next_log_block);
 415                                 brelse(bh);
 416                                 continue;
 417                         }
 418
 419                         /* A descriptor block: we can now write all of
 420                          * the data blocks.  Yay, useful work is finally
 421                          * getting done here! */
 422
 423                         tagp = &bh->b_data[sizeof(journal_header_t)];
 424                         while ((tagp - bh->b_data +sizeof(journal_block_tag_t))
 425                                <= journal->j_blocksize) {
 426                                 unsigned long io_block;
 427
 428                                 tag = (journal_block_tag_t *) tagp;
 429                                 flags = ntohl(tag->t_flags);
 430
 431                                 io_block = next_log_block++;
 432                                 wrap(journal, next_log_block);
 433                                 err = jread(&obh, journal, io_block);
 434                                 if (err) {
 435                                         /* Recover what we can, but
 436                                          * report failure at the end. */
 437                                         success = err;
 438                                         printk (KERN_ERR
 439                                                 "JFS: IO error %d recovering "
 440                                                 "block %ld in log\n",
 441                                                 err, io_block);
 442                                 } else {
 443                                         unsigned long blocknr;
 444
 445                                         J_ASSERT(obh != NULL);
 446                                         blocknr = ntohl(tag->t_blocknr);
 447
 448                                         /* If the block has been
 449                                          * revoked, then we're all done
 450                                          * here. */
 451                                         if (journal_test_revoke
 452                                             (journal, blocknr,
 453                                              next_commit_ID)) {
 454                                                 brelse(obh);
 455                                                 ++info->nr_revoke_hits;
 456                                                 goto skip_write;
 457                                         }
 458
 459                                         /* Find a buffer for the new
 460                                          * data being restored */
 461                                         nbh = getblk(journal->j_dev, blocknr,
 462                                                      journal->j_blocksize);
 463                                         if (nbh == NULL) {
 464                                                 printk(KERN_ERR
 465                                                        "JFS: Out of memory "
 466                                                        "during recovery.\n");
 467                                                 err = -ENOMEM;
 468                                                 brelse(bh);
 469                                                 brelse(obh);
 470                                                 goto failed;
 471                                         }
 472
 473                                         memcpy(nbh->b_data, obh->b_data,
 474                                                journal->j_blocksize);
 475                                         if (flags & JFS_FLAG_ESCAPE) {
 476                                                 * ((unsigned int *) bh->b_data) = htonl(JFS_MAGIC_NUMBER);
 477                                         }
 478
 479                                         mark_buffer_dirty(nbh, 1);
 480                                         mark_buffer_uptodate(nbh, 1);
 481                                         ++info->nr_replays;
 482                                         /* ll_rw_block(WRITE, 1, &nbh); */
 483                                         brelse(obh);
 484                                         brelse(nbh);
 485                                 }
 486
 487                         skip_write:
 488                                 tagp += sizeof(journal_block_tag_t);
 489                                 if (!(flags & JFS_FLAG_SAME_UUID))
 490                                         tagp += 16;
 491
 492                                 if (flags & JFS_FLAG_LAST_TAG)
 493                                         break;
 494                         }
 495
 496                         brelse(bh);
 497                         continue;
 498
 499                 case JFS_COMMIT_BLOCK:
 500                         /* Found an expected commit block: not much to
 501                          * do other than move on to the next sequence
 502                          * number. */
 503                         brelse(bh);
 504                         next_commit_ID++;
 505                         continue;
 506
 507                 case JFS_REVOKE_BLOCK:
 508                         /* If we aren't in the REVOKE pass, then we can
 509                          * just skip over this block. */
 510                         if (pass != PASS_REVOKE) {
 511                                 brelse(bh);
 512                                 continue;
 513                         }
 514
 515                         err = scan_revoke_records(journal, bh,
 516                                                   next_commit_ID, info);
 517                         brelse(bh);
 518                         if (err)
 519                                 goto failed;
 520                         continue;
 521
 522                 default:
 523                         jfs_debug(3, "Unrecognised magic %d, end of scan.\n",
 524                                   blocktype);
 525                         goto done;
 526                 }
 527         }
 528
 529  done:
 530         /*
 531          * We broke out of the log scan loop: either we came to the
 532          * known end of the log or we found an unexpected block in the
 533          * log.  If the latter happened, then we know that the "current"
 534          * transaction marks the end of the valid log.
 535          */
 536
 537         if (pass == PASS_SCAN)
 538                 info->end_transaction = next_commit_ID;
 539         else {
 540                 /* It's really bad news if different passes end up at
 541                  * different places (but possible due to IO errors). */
 542                 if (info->end_transaction != next_commit_ID) {
 543                         printk (KERN_ERR "JFS: recovery pass %d ended at "
 544                                 "transaction %u, expected %u\n",
 545                                 pass, next_commit_ID, info->end_transaction);
 546                         if (!success)
 547                                 success = -EIO;
 548                 }
 549         }
 550
 551         return success;
 552
 553  failed:
 554         return err;
 555 }
 556
 557
 558 /* Scan a revoke record, marking all blocks mentioned as revoked. */
 559
 560 static int scan_revoke_records(journal_t *journal, struct buffer_head *bh,
 561                                tid_t sequence, struct recovery_info *info)
 562 {
 563         journal_revoke_header_t *header;
 564         int offset, max;
 565
 566         header = (journal_revoke_header_t *) bh->b_data;
 567         offset = sizeof(journal_revoke_header_t);
 568         max = ntohl(header->r_count);
 569
 570         while (offset < max) {
 571                 unsigned long blocknr;
 572                 int err;
 573
 574                 blocknr = ntohl(* ((unsigned int *) (bh->b_data+offset)));
 575                 offset += 4;
 576                 err = journal_set_revoke(journal, blocknr, sequence);
 577                 if (err)
 578                         return err;
 579                 ++info->nr_revokes;
 580         }
 581         return 0;
 582 }