2 * linux/fs/jbd2/checkpoint.c
4 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
6 * Copyright 1999 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 * Checkpoint routines for the generic filesystem journaling code.
13 * Part of the ext2fs journaling system.
15 * Checkpointing is the process of ensuring that a section of the log is
16 * committed fully to disk, so that that portion of the log can be
20 #include <linux/time.h>
22 #include <linux/jbd2.h>
23 #include <linux/marker.h>
24 #include <linux/errno.h>
25 #include <linux/slab.h>
28 * Unlink a buffer from a transaction checkpoint list.
30 * Called with j_list_lock held.
32 static inline void __buffer_unlink_first(struct journal_head *jh)
34 transaction_t *transaction = jh->b_cp_transaction;
36 jh->b_cpnext->b_cpprev = jh->b_cpprev;
37 jh->b_cpprev->b_cpnext = jh->b_cpnext;
38 if (transaction->t_checkpoint_list == jh) {
39 transaction->t_checkpoint_list = jh->b_cpnext;
40 if (transaction->t_checkpoint_list == jh)
41 transaction->t_checkpoint_list = NULL;
46 * Unlink a buffer from a transaction checkpoint(io) list.
48 * Called with j_list_lock held.
50 static inline void __buffer_unlink(struct journal_head *jh)
52 transaction_t *transaction = jh->b_cp_transaction;
54 __buffer_unlink_first(jh);
55 if (transaction->t_checkpoint_io_list == jh) {
56 transaction->t_checkpoint_io_list = jh->b_cpnext;
57 if (transaction->t_checkpoint_io_list == jh)
58 transaction->t_checkpoint_io_list = NULL;
63 * Move a buffer from the checkpoint list to the checkpoint io list
65 * Called with j_list_lock held
67 static inline void __buffer_relink_io(struct journal_head *jh)
69 transaction_t *transaction = jh->b_cp_transaction;
71 __buffer_unlink_first(jh);
73 if (!transaction->t_checkpoint_io_list) {
74 jh->b_cpnext = jh->b_cpprev = jh;
76 jh->b_cpnext = transaction->t_checkpoint_io_list;
77 jh->b_cpprev = transaction->t_checkpoint_io_list->b_cpprev;
78 jh->b_cpprev->b_cpnext = jh;
79 jh->b_cpnext->b_cpprev = jh;
81 transaction->t_checkpoint_io_list = jh;
85 * Try to release a checkpointed buffer from its transaction.
86 * Returns 1 if we released it and 2 if we also released the
89 * Requires j_list_lock
90 * Called under jbd_lock_bh_state(jh2bh(jh)), and drops it
92 static int __try_to_free_cp_buf(struct journal_head *jh)
95 struct buffer_head *bh = jh2bh(jh);
97 if (jh->b_jlist == BJ_None && !buffer_locked(bh) &&
98 !buffer_dirty(bh) && !buffer_write_io_error(bh)) {
99 JBUFFER_TRACE(jh, "remove from checkpoint list");
100 ret = __jbd2_journal_remove_checkpoint(jh) + 1;
101 jbd_unlock_bh_state(bh);
102 jbd2_journal_remove_journal_head(bh);
103 BUFFER_TRACE(bh, "release");
106 jbd_unlock_bh_state(bh);
112 * __jbd2_log_wait_for_space: wait until there is space in the journal.
114 * Called under j-state_lock *only*. It will be unlocked if we have to wait
115 * for a checkpoint to free up some space in the log.
117 void __jbd2_log_wait_for_space(journal_t *journal)
119 int nblocks, space_left;
120 assert_spin_locked(&journal->j_state_lock);
122 nblocks = jbd_space_needed(journal);
123 while (__jbd2_log_space_left(journal) < nblocks) {
124 if (journal->j_flags & JBD2_ABORT)
126 spin_unlock(&journal->j_state_lock);
127 mutex_lock(&journal->j_checkpoint_mutex);
130 * Test again, another process may have checkpointed while we
131 * were waiting for the checkpoint lock. If there are no
132 * transactions ready to be checkpointed, try to recover
133 * journal space by calling cleanup_journal_tail(), and if
134 * that doesn't work, by waiting for the currently committing
135 * transaction to complete. If there is absolutely no way
136 * to make progress, this is either a BUG or corrupted
137 * filesystem, so abort the journal and leave a stack
138 * trace for forensic evidence.
140 spin_lock(&journal->j_state_lock);
141 spin_lock(&journal->j_list_lock);
142 nblocks = jbd_space_needed(journal);
143 space_left = __jbd2_log_space_left(journal);
144 if (space_left < nblocks) {
145 int chkpt = journal->j_checkpoint_transactions != NULL;
148 if (journal->j_committing_transaction)
149 tid = journal->j_committing_transaction->t_tid;
150 spin_unlock(&journal->j_list_lock);
151 spin_unlock(&journal->j_state_lock);
153 jbd2_log_do_checkpoint(journal);
154 } else if (jbd2_cleanup_journal_tail(journal) == 0) {
155 /* We were able to recover space; yay! */
158 jbd2_log_wait_commit(journal, tid);
160 printk(KERN_ERR "%s: needed %d blocks and "
161 "only had %d space available\n",
162 __func__, nblocks, space_left);
163 printk(KERN_ERR "%s: no way to get more "
164 "journal space in %s\n", __func__,
167 jbd2_journal_abort(journal, 0);
169 spin_lock(&journal->j_state_lock);
171 spin_unlock(&journal->j_list_lock);
173 mutex_unlock(&journal->j_checkpoint_mutex);
178 * We were unable to perform jbd_trylock_bh_state() inside j_list_lock.
179 * The caller must restart a list walk. Wait for someone else to run
180 * jbd_unlock_bh_state().
182 static void jbd_sync_bh(journal_t *journal, struct buffer_head *bh)
183 __releases(journal->j_list_lock)
186 spin_unlock(&journal->j_list_lock);
187 jbd_lock_bh_state(bh);
188 jbd_unlock_bh_state(bh);
193 * Clean up transaction's list of buffers submitted for io.
194 * We wait for any pending IO to complete and remove any clean
195 * buffers. Note that we take the buffers in the opposite ordering
196 * from the one in which they were submitted for IO.
198 * Return 0 on success, and return <0 if some buffers have failed
201 * Called with j_list_lock held.
203 static int __wait_cp_io(journal_t *journal, transaction_t *transaction)
205 struct journal_head *jh;
206 struct buffer_head *bh;
211 this_tid = transaction->t_tid;
213 /* Did somebody clean up the transaction in the meanwhile? */
214 if (journal->j_checkpoint_transactions != transaction ||
215 transaction->t_tid != this_tid)
217 while (!released && transaction->t_checkpoint_io_list) {
218 jh = transaction->t_checkpoint_io_list;
220 if (!jbd_trylock_bh_state(bh)) {
221 jbd_sync_bh(journal, bh);
222 spin_lock(&journal->j_list_lock);
225 if (buffer_locked(bh)) {
226 atomic_inc(&bh->b_count);
227 spin_unlock(&journal->j_list_lock);
228 jbd_unlock_bh_state(bh);
230 /* the journal_head may have gone by now */
231 BUFFER_TRACE(bh, "brelse");
233 spin_lock(&journal->j_list_lock);
236 if (unlikely(buffer_write_io_error(bh)))
240 * Now in whatever state the buffer currently is, we know that
241 * it has been written out and so we can drop it from the list
243 released = __jbd2_journal_remove_checkpoint(jh);
244 jbd_unlock_bh_state(bh);
245 jbd2_journal_remove_journal_head(bh);
253 __flush_batch(journal_t *journal, int *batch_count)
257 ll_rw_block(SWRITE, *batch_count, journal->j_chkpt_bhs);
258 for (i = 0; i < *batch_count; i++) {
259 struct buffer_head *bh = journal->j_chkpt_bhs[i];
260 clear_buffer_jwrite(bh);
261 BUFFER_TRACE(bh, "brelse");
268 * Try to flush one buffer from the checkpoint list to disk.
270 * Return 1 if something happened which requires us to abort the current
271 * scan of the checkpoint list. Return <0 if the buffer has failed to
274 * Called with j_list_lock held and drops it if 1 is returned
275 * Called under jbd_lock_bh_state(jh2bh(jh)), and drops it
277 static int __process_buffer(journal_t *journal, struct journal_head *jh,
278 int *batch_count, transaction_t *transaction)
280 struct buffer_head *bh = jh2bh(jh);
283 if (buffer_locked(bh)) {
284 atomic_inc(&bh->b_count);
285 spin_unlock(&journal->j_list_lock);
286 jbd_unlock_bh_state(bh);
288 /* the journal_head may have gone by now */
289 BUFFER_TRACE(bh, "brelse");
292 } else if (jh->b_transaction != NULL) {
293 transaction_t *t = jh->b_transaction;
294 tid_t tid = t->t_tid;
296 transaction->t_chp_stats.cs_forced_to_close++;
297 spin_unlock(&journal->j_list_lock);
298 jbd_unlock_bh_state(bh);
299 jbd2_log_start_commit(journal, tid);
300 jbd2_log_wait_commit(journal, tid);
302 } else if (!buffer_dirty(bh)) {
304 if (unlikely(buffer_write_io_error(bh)))
306 J_ASSERT_JH(jh, !buffer_jbddirty(bh));
307 BUFFER_TRACE(bh, "remove from checkpoint");
308 __jbd2_journal_remove_checkpoint(jh);
309 spin_unlock(&journal->j_list_lock);
310 jbd_unlock_bh_state(bh);
311 jbd2_journal_remove_journal_head(bh);
315 * Important: we are about to write the buffer, and
316 * possibly block, while still holding the journal lock.
317 * We cannot afford to let the transaction logic start
318 * messing around with this buffer before we write it to
319 * disk, as that would break recoverability.
321 BUFFER_TRACE(bh, "queue");
323 J_ASSERT_BH(bh, !buffer_jwrite(bh));
324 set_buffer_jwrite(bh);
325 journal->j_chkpt_bhs[*batch_count] = bh;
326 __buffer_relink_io(jh);
327 jbd_unlock_bh_state(bh);
328 transaction->t_chp_stats.cs_written++;
330 if (*batch_count == JBD2_NR_BATCH) {
331 spin_unlock(&journal->j_list_lock);
332 __flush_batch(journal, batch_count);
340 * Perform an actual checkpoint. We take the first transaction on the
341 * list of transactions to be checkpointed and send all its buffers
342 * to disk. We submit larger chunks of data at once.
344 * The journal should be locked before calling this function.
345 * Called with j_checkpoint_mutex held.
347 int jbd2_log_do_checkpoint(journal_t *journal)
349 transaction_t *transaction;
353 jbd_debug(1, "Start checkpoint\n");
356 * First thing: if there are any transactions in the log which
357 * don't need checkpointing, just eliminate them from the
358 * journal straight away.
360 result = jbd2_cleanup_journal_tail(journal);
361 trace_mark(jbd2_checkpoint, "dev %s need_checkpoint %d",
362 journal->j_devname, result);
363 jbd_debug(1, "cleanup_journal_tail returned %d\n", result);
368 * OK, we need to start writing disk blocks. Take one transaction
372 spin_lock(&journal->j_list_lock);
373 if (!journal->j_checkpoint_transactions)
375 transaction = journal->j_checkpoint_transactions;
376 if (transaction->t_chp_stats.cs_chp_time == 0)
377 transaction->t_chp_stats.cs_chp_time = jiffies;
378 this_tid = transaction->t_tid;
381 * If someone cleaned up this transaction while we slept, we're
382 * done (maybe it's a new transaction, but it fell at the same
385 if (journal->j_checkpoint_transactions == transaction &&
386 transaction->t_tid == this_tid) {
388 struct journal_head *jh;
391 while (!retry && transaction->t_checkpoint_list) {
392 struct buffer_head *bh;
394 jh = transaction->t_checkpoint_list;
396 if (!jbd_trylock_bh_state(bh)) {
397 jbd_sync_bh(journal, bh);
401 retry = __process_buffer(journal, jh, &batch_count,
403 if (retry < 0 && !result)
405 if (!retry && (need_resched() ||
406 spin_needbreak(&journal->j_list_lock))) {
407 spin_unlock(&journal->j_list_lock);
415 spin_unlock(&journal->j_list_lock);
418 __flush_batch(journal, &batch_count);
422 spin_lock(&journal->j_list_lock);
426 * Now we have cleaned up the first transaction's checkpoint
427 * list. Let's clean up the second one
429 err = __wait_cp_io(journal, transaction);
434 spin_unlock(&journal->j_list_lock);
436 jbd2_journal_abort(journal, result);
438 result = jbd2_cleanup_journal_tail(journal);
440 return (result < 0) ? result : 0;
444 * Check the list of checkpoint transactions for the journal to see if
445 * we have already got rid of any since the last update of the log tail
446 * in the journal superblock. If so, we can instantly roll the
447 * superblock forward to remove those transactions from the log.
449 * Return <0 on error, 0 on success, 1 if there was nothing to clean up.
451 * Called with the journal lock held.
453 * This is the only part of the journaling code which really needs to be
454 * aware of transaction aborts. Checkpointing involves writing to the
455 * main filesystem area rather than to the journal, so it can proceed
456 * even in abort state, but we must not update the super block if
457 * checkpointing may have failed. Otherwise, we would lose some metadata
458 * buffers which should be written-back to the filesystem.
461 int jbd2_cleanup_journal_tail(journal_t *journal)
463 transaction_t * transaction;
465 unsigned long blocknr, freed;
467 if (is_journal_aborted(journal))
470 /* OK, work out the oldest transaction remaining in the log, and
471 * the log block it starts at.
473 * If the log is now empty, we need to work out which is the
474 * next transaction ID we will write, and where it will
477 spin_lock(&journal->j_state_lock);
478 spin_lock(&journal->j_list_lock);
479 transaction = journal->j_checkpoint_transactions;
481 first_tid = transaction->t_tid;
482 blocknr = transaction->t_log_start;
483 } else if ((transaction = journal->j_committing_transaction) != NULL) {
484 first_tid = transaction->t_tid;
485 blocknr = transaction->t_log_start;
486 } else if ((transaction = journal->j_running_transaction) != NULL) {
487 first_tid = transaction->t_tid;
488 blocknr = journal->j_head;
490 first_tid = journal->j_transaction_sequence;
491 blocknr = journal->j_head;
493 spin_unlock(&journal->j_list_lock);
494 J_ASSERT(blocknr != 0);
496 /* If the oldest pinned transaction is at the tail of the log
497 already then there's not much we can do right now. */
498 if (journal->j_tail_sequence == first_tid) {
499 spin_unlock(&journal->j_state_lock);
503 /* OK, update the superblock to recover the freed space.
504 * Physical blocks come first: have we wrapped beyond the end of
506 freed = blocknr - journal->j_tail;
507 if (blocknr < journal->j_tail)
508 freed = freed + journal->j_last - journal->j_first;
511 "Cleaning journal tail from %d to %d (offset %lu), "
513 journal->j_tail_sequence, first_tid, blocknr, freed);
515 journal->j_free += freed;
516 journal->j_tail_sequence = first_tid;
517 journal->j_tail = blocknr;
518 spin_unlock(&journal->j_state_lock);
519 if (!(journal->j_flags & JBD2_ABORT))
520 jbd2_journal_update_superblock(journal, 1);
525 /* Checkpoint list management */
528 * journal_clean_one_cp_list
530 * Find all the written-back checkpoint buffers in the given list and release them.
532 * Called with the journal locked.
533 * Called with j_list_lock held.
534 * Returns number of bufers reaped (for debug)
537 static int journal_clean_one_cp_list(struct journal_head *jh, int *released)
539 struct journal_head *last_jh;
540 struct journal_head *next_jh = jh;
547 last_jh = jh->b_cpprev;
550 next_jh = jh->b_cpnext;
551 /* Use trylock because of the ranking */
552 if (jbd_trylock_bh_state(jh2bh(jh))) {
553 ret = __try_to_free_cp_buf(jh);
563 * This function only frees up some memory
564 * if possible so we dont have an obligation
565 * to finish processing. Bail out if preemption
570 } while (jh != last_jh);
576 * journal_clean_checkpoint_list
578 * Find all the written-back checkpoint buffers in the journal and release them.
580 * Called with the journal locked.
581 * Called with j_list_lock held.
582 * Returns number of buffers reaped (for debug)
585 int __jbd2_journal_clean_checkpoint_list(journal_t *journal)
587 transaction_t *transaction, *last_transaction, *next_transaction;
591 transaction = journal->j_checkpoint_transactions;
595 last_transaction = transaction->t_cpprev;
596 next_transaction = transaction;
598 transaction = next_transaction;
599 next_transaction = transaction->t_cpnext;
600 ret += journal_clean_one_cp_list(transaction->
601 t_checkpoint_list, &released);
603 * This function only frees up some memory if possible so we
604 * dont have an obligation to finish processing. Bail out if
605 * preemption requested:
612 * It is essential that we are as careful as in the case of
613 * t_checkpoint_list with removing the buffer from the list as
614 * we can possibly see not yet submitted buffers on io_list
616 ret += journal_clean_one_cp_list(transaction->
617 t_checkpoint_io_list, &released);
620 } while (transaction != last_transaction);
626 * journal_remove_checkpoint: called after a buffer has been committed
627 * to disk (either by being write-back flushed to disk, or being
628 * committed to the log).
630 * We cannot safely clean a transaction out of the log until all of the
631 * buffer updates committed in that transaction have safely been stored
632 * elsewhere on disk. To achieve this, all of the buffers in a
633 * transaction need to be maintained on the transaction's checkpoint
634 * lists until they have been rewritten, at which point this function is
635 * called to remove the buffer from the existing transaction's
638 * The function returns 1 if it frees the transaction, 0 otherwise.
640 * This function is called with the journal locked.
641 * This function is called with j_list_lock held.
642 * This function is called with jbd_lock_bh_state(jh2bh(jh))
645 int __jbd2_journal_remove_checkpoint(struct journal_head *jh)
647 transaction_t *transaction;
651 JBUFFER_TRACE(jh, "entry");
653 if ((transaction = jh->b_cp_transaction) == NULL) {
654 JBUFFER_TRACE(jh, "not on transaction");
657 journal = transaction->t_journal;
660 jh->b_cp_transaction = NULL;
662 if (transaction->t_checkpoint_list != NULL ||
663 transaction->t_checkpoint_io_list != NULL)
665 JBUFFER_TRACE(jh, "transaction has no more buffers");
668 * There is one special case to worry about: if we have just pulled the
669 * buffer off a running or committing transaction's checkpoing list,
670 * then even if the checkpoint list is empty, the transaction obviously
673 * The locking here around t_state is a bit sleazy.
674 * See the comment at the end of jbd2_journal_commit_transaction().
676 if (transaction->t_state != T_FINISHED) {
677 JBUFFER_TRACE(jh, "belongs to running/committing transaction");
681 /* OK, that was the last buffer for the transaction: we can now
682 safely remove this transaction from the log */
684 __jbd2_journal_drop_transaction(journal, transaction);
687 /* Just in case anybody was waiting for more transactions to be
689 wake_up(&journal->j_wait_logspace);
692 JBUFFER_TRACE(jh, "exit");
697 * journal_insert_checkpoint: put a committed buffer onto a checkpoint
698 * list so that we know when it is safe to clean the transaction out of
701 * Called with the journal locked.
702 * Called with j_list_lock held.
704 void __jbd2_journal_insert_checkpoint(struct journal_head *jh,
705 transaction_t *transaction)
707 JBUFFER_TRACE(jh, "entry");
708 J_ASSERT_JH(jh, buffer_dirty(jh2bh(jh)) || buffer_jbddirty(jh2bh(jh)));
709 J_ASSERT_JH(jh, jh->b_cp_transaction == NULL);
711 jh->b_cp_transaction = transaction;
713 if (!transaction->t_checkpoint_list) {
714 jh->b_cpnext = jh->b_cpprev = jh;
716 jh->b_cpnext = transaction->t_checkpoint_list;
717 jh->b_cpprev = transaction->t_checkpoint_list->b_cpprev;
718 jh->b_cpprev->b_cpnext = jh;
719 jh->b_cpnext->b_cpprev = jh;
721 transaction->t_checkpoint_list = jh;
725 * We've finished with this transaction structure: adios...
727 * The transaction must have no links except for the checkpoint by this
730 * Called with the journal locked.
731 * Called with j_list_lock held.
734 void __jbd2_journal_drop_transaction(journal_t *journal, transaction_t *transaction)
736 assert_spin_locked(&journal->j_list_lock);
737 if (transaction->t_cpnext) {
738 transaction->t_cpnext->t_cpprev = transaction->t_cpprev;
739 transaction->t_cpprev->t_cpnext = transaction->t_cpnext;
740 if (journal->j_checkpoint_transactions == transaction)
741 journal->j_checkpoint_transactions =
742 transaction->t_cpnext;
743 if (journal->j_checkpoint_transactions == transaction)
744 journal->j_checkpoint_transactions = NULL;
747 J_ASSERT(transaction->t_state == T_FINISHED);
748 J_ASSERT(transaction->t_buffers == NULL);
749 J_ASSERT(transaction->t_forget == NULL);
750 J_ASSERT(transaction->t_iobuf_list == NULL);
751 J_ASSERT(transaction->t_shadow_list == NULL);
752 J_ASSERT(transaction->t_log_list == NULL);
753 J_ASSERT(transaction->t_checkpoint_list == NULL);
754 J_ASSERT(transaction->t_checkpoint_io_list == NULL);
755 J_ASSERT(transaction->t_updates == 0);
756 J_ASSERT(journal->j_committing_transaction != transaction);
757 J_ASSERT(journal->j_running_transaction != transaction);
759 jbd_debug(1, "Dropping transaction %d, all done\n", transaction->t_tid);