1 // SPDX-License-Identifier: GPL-2.0+
3 * linux/fs/jbd2/checkpoint.c
5 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
7 * Copyright 1999 Red Hat Software --- All Rights Reserved
9 * Checkpoint routines for the generic filesystem journaling code.
10 * Part of the ext2fs journaling system.
12 * Checkpointing is the process of ensuring that a section of the log is
13 * committed fully to disk, so that that portion of the log can be
17 #include <linux/time.h>
19 #include <linux/jbd2.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/blkdev.h>
23 #include <trace/events/jbd2.h>
26 * Unlink a buffer from a transaction checkpoint list.
28 * Called with j_list_lock held.
30 static inline void __buffer_unlink(struct journal_head *jh)
32 transaction_t *transaction = jh->b_cp_transaction;
34 jh->b_cpnext->b_cpprev = jh->b_cpprev;
35 jh->b_cpprev->b_cpnext = jh->b_cpnext;
36 if (transaction->t_checkpoint_list == jh) {
37 transaction->t_checkpoint_list = jh->b_cpnext;
38 if (transaction->t_checkpoint_list == jh)
39 transaction->t_checkpoint_list = NULL;
44 * Check a checkpoint buffer could be release or not.
46 * Requires j_list_lock
48 static inline bool __cp_buffer_busy(struct journal_head *jh)
50 struct buffer_head *bh = jh2bh(jh);
52 return (jh->b_transaction || buffer_locked(bh) || buffer_dirty(bh));
56 * __jbd2_log_wait_for_space: wait until there is space in the journal.
58 * Called under j-state_lock *only*. It will be unlocked if we have to wait
59 * for a checkpoint to free up some space in the log.
61 void __jbd2_log_wait_for_space(journal_t *journal)
62 __acquires(&journal->j_state_lock)
63 __releases(&journal->j_state_lock)
65 int nblocks, space_left;
66 /* assert_spin_locked(&journal->j_state_lock); */
68 nblocks = journal->j_max_transaction_buffers;
69 while (jbd2_log_space_left(journal) < nblocks) {
70 write_unlock(&journal->j_state_lock);
71 mutex_lock_io(&journal->j_checkpoint_mutex);
74 * Test again, another process may have checkpointed while we
75 * were waiting for the checkpoint lock. If there are no
76 * transactions ready to be checkpointed, try to recover
77 * journal space by calling cleanup_journal_tail(), and if
78 * that doesn't work, by waiting for the currently committing
79 * transaction to complete. If there is absolutely no way
80 * to make progress, this is either a BUG or corrupted
81 * filesystem, so abort the journal and leave a stack
82 * trace for forensic evidence.
84 write_lock(&journal->j_state_lock);
85 if (journal->j_flags & JBD2_ABORT) {
86 mutex_unlock(&journal->j_checkpoint_mutex);
89 spin_lock(&journal->j_list_lock);
90 space_left = jbd2_log_space_left(journal);
91 if (space_left < nblocks) {
92 int chkpt = journal->j_checkpoint_transactions != NULL;
95 if (journal->j_committing_transaction)
96 tid = journal->j_committing_transaction->t_tid;
97 spin_unlock(&journal->j_list_lock);
98 write_unlock(&journal->j_state_lock);
100 jbd2_log_do_checkpoint(journal);
101 } else if (jbd2_cleanup_journal_tail(journal) == 0) {
102 /* We were able to recover space; yay! */
106 * jbd2_journal_commit_transaction() may want
107 * to take the checkpoint_mutex if JBD2_FLUSHED
108 * is set. So we need to temporarily drop it.
110 mutex_unlock(&journal->j_checkpoint_mutex);
111 jbd2_log_wait_commit(journal, tid);
112 write_lock(&journal->j_state_lock);
115 printk(KERN_ERR "%s: needed %d blocks and "
116 "only had %d space available\n",
117 __func__, nblocks, space_left);
118 printk(KERN_ERR "%s: no way to get more "
119 "journal space in %s\n", __func__,
122 jbd2_journal_abort(journal, -EIO);
124 write_lock(&journal->j_state_lock);
126 spin_unlock(&journal->j_list_lock);
128 mutex_unlock(&journal->j_checkpoint_mutex);
133 __flush_batch(journal_t *journal, int *batch_count)
136 struct blk_plug plug;
138 blk_start_plug(&plug);
139 for (i = 0; i < *batch_count; i++)
140 write_dirty_buffer(journal->j_chkpt_bhs[i], REQ_SYNC);
141 blk_finish_plug(&plug);
143 for (i = 0; i < *batch_count; i++) {
144 struct buffer_head *bh = journal->j_chkpt_bhs[i];
145 BUFFER_TRACE(bh, "brelse");
147 journal->j_chkpt_bhs[i] = NULL;
153 * Perform an actual checkpoint. We take the first transaction on the
154 * list of transactions to be checkpointed and send all its buffers
155 * to disk. We submit larger chunks of data at once.
157 * The journal should be locked before calling this function.
158 * Called with j_checkpoint_mutex held.
160 int jbd2_log_do_checkpoint(journal_t *journal)
162 struct journal_head *jh;
163 struct buffer_head *bh;
164 transaction_t *transaction;
166 int result, batch_count = 0;
168 jbd2_debug(1, "Start checkpoint\n");
171 * First thing: if there are any transactions in the log which
172 * don't need checkpointing, just eliminate them from the
173 * journal straight away.
175 result = jbd2_cleanup_journal_tail(journal);
176 trace_jbd2_checkpoint(journal, result);
177 jbd2_debug(1, "cleanup_journal_tail returned %d\n", result);
182 * OK, we need to start writing disk blocks. Take one transaction
185 spin_lock(&journal->j_list_lock);
186 if (!journal->j_checkpoint_transactions)
188 transaction = journal->j_checkpoint_transactions;
189 if (transaction->t_chp_stats.cs_chp_time == 0)
190 transaction->t_chp_stats.cs_chp_time = jiffies;
191 this_tid = transaction->t_tid;
194 * If someone cleaned up this transaction while we slept, we're
195 * done (maybe it's a new transaction, but it fell at the same
198 if (journal->j_checkpoint_transactions != transaction ||
199 transaction->t_tid != this_tid)
202 /* checkpoint all of the transaction's buffers */
203 while (transaction->t_checkpoint_list) {
204 jh = transaction->t_checkpoint_list;
207 if (jh->b_transaction != NULL) {
208 transaction_t *t = jh->b_transaction;
209 tid_t tid = t->t_tid;
211 transaction->t_chp_stats.cs_forced_to_close++;
212 spin_unlock(&journal->j_list_lock);
213 if (unlikely(journal->j_flags & JBD2_UNMOUNT))
215 * The journal thread is dead; so
216 * starting and waiting for a commit
217 * to finish will cause us to wait for
218 * a _very_ long time.
221 "JBD2: %s: Waiting for Godot: block %llu\n",
222 journal->j_devname, (unsigned long long) bh->b_blocknr);
225 __flush_batch(journal, &batch_count);
226 jbd2_log_start_commit(journal, tid);
228 * jbd2_journal_commit_transaction() may want
229 * to take the checkpoint_mutex if JBD2_FLUSHED
230 * is set, jbd2_update_log_tail() called by
231 * jbd2_journal_commit_transaction() may also take
232 * checkpoint_mutex. So we need to temporarily
235 mutex_unlock(&journal->j_checkpoint_mutex);
236 jbd2_log_wait_commit(journal, tid);
237 mutex_lock_io(&journal->j_checkpoint_mutex);
238 spin_lock(&journal->j_list_lock);
241 if (!trylock_buffer(bh)) {
243 * The buffer is locked, it may be writing back, or
244 * flushing out in the last couple of cycles, or
245 * re-adding into a new transaction, need to check
246 * it again until it's unlocked.
249 spin_unlock(&journal->j_list_lock);
251 /* the journal_head may have gone by now */
252 BUFFER_TRACE(bh, "brelse");
255 } else if (!buffer_dirty(bh)) {
257 BUFFER_TRACE(bh, "remove from checkpoint");
259 * If the transaction was released or the checkpoint
260 * list was empty, we're done.
262 if (__jbd2_journal_remove_checkpoint(jh) ||
263 !transaction->t_checkpoint_list)
268 * We are about to write the buffer, it could be
269 * raced by some other transaction shrink or buffer
270 * re-log logic once we release the j_list_lock,
271 * leave it on the checkpoint list and check status
272 * again to make sure it's clean.
274 BUFFER_TRACE(bh, "queue");
276 J_ASSERT_BH(bh, !buffer_jwrite(bh));
277 journal->j_chkpt_bhs[batch_count++] = bh;
278 transaction->t_chp_stats.cs_written++;
279 transaction->t_checkpoint_list = jh->b_cpnext;
282 if ((batch_count == JBD2_NR_BATCH) ||
283 need_resched() || spin_needbreak(&journal->j_list_lock) ||
284 jh2bh(transaction->t_checkpoint_list) == journal->j_chkpt_bhs[0])
285 goto unlock_and_flush;
290 spin_unlock(&journal->j_list_lock);
293 __flush_batch(journal, &batch_count);
294 spin_lock(&journal->j_list_lock);
299 spin_unlock(&journal->j_list_lock);
300 result = jbd2_cleanup_journal_tail(journal);
302 return (result < 0) ? result : 0;
306 * Check the list of checkpoint transactions for the journal to see if
307 * we have already got rid of any since the last update of the log tail
308 * in the journal superblock. If so, we can instantly roll the
309 * superblock forward to remove those transactions from the log.
311 * Return <0 on error, 0 on success, 1 if there was nothing to clean up.
313 * Called with the journal lock held.
315 * This is the only part of the journaling code which really needs to be
316 * aware of transaction aborts. Checkpointing involves writing to the
317 * main filesystem area rather than to the journal, so it can proceed
318 * even in abort state, but we must not update the super block if
319 * checkpointing may have failed. Otherwise, we would lose some metadata
320 * buffers which should be written-back to the filesystem.
323 int jbd2_cleanup_journal_tail(journal_t *journal)
326 unsigned long blocknr;
328 if (is_journal_aborted(journal))
331 if (!jbd2_journal_get_log_tail(journal, &first_tid, &blocknr))
333 J_ASSERT(blocknr != 0);
336 * We need to make sure that any blocks that were recently written out
337 * --- perhaps by jbd2_log_do_checkpoint() --- are flushed out before
338 * we drop the transactions from the journal. It's unlikely this will
339 * be necessary, especially with an appropriately sized journal, but we
340 * need this to guarantee correctness. Fortunately
341 * jbd2_cleanup_journal_tail() doesn't get called all that often.
343 if (journal->j_flags & JBD2_BARRIER)
344 blkdev_issue_flush(journal->j_fs_dev);
346 return __jbd2_update_log_tail(journal, first_tid, blocknr);
350 /* Checkpoint list management */
353 * journal_shrink_one_cp_list
355 * Find all the written-back checkpoint buffers in the given list
356 * and try to release them. If the whole transaction is released, set
357 * the 'released' parameter. Return the number of released checkpointed
360 * Called with j_list_lock held.
362 static unsigned long journal_shrink_one_cp_list(struct journal_head *jh,
363 bool destroy, bool *released)
365 struct journal_head *last_jh;
366 struct journal_head *next_jh = jh;
367 unsigned long nr_freed = 0;
374 last_jh = jh->b_cpprev;
377 next_jh = jh->b_cpnext;
380 ret = __jbd2_journal_remove_checkpoint(jh);
382 ret = jbd2_journal_try_remove_checkpoint(jh);
395 } while (jh != last_jh);
401 * jbd2_journal_shrink_checkpoint_list
403 * Find 'nr_to_scan' written-back checkpoint buffers in the journal
404 * and try to release them. Return the number of released checkpointed
407 * Called with j_list_lock held.
409 unsigned long jbd2_journal_shrink_checkpoint_list(journal_t *journal,
410 unsigned long *nr_to_scan)
412 transaction_t *transaction, *last_transaction, *next_transaction;
413 bool __maybe_unused released;
414 tid_t first_tid = 0, last_tid = 0, next_tid = 0;
416 unsigned long nr_freed = 0;
420 spin_lock(&journal->j_list_lock);
421 if (!journal->j_checkpoint_transactions) {
422 spin_unlock(&journal->j_list_lock);
427 * Get next shrink transaction, resume previous scan or start
428 * over again. If some others do checkpoint and drop transaction
429 * from the checkpoint list, we ignore saved j_shrink_transaction
430 * and start over unconditionally.
432 if (journal->j_shrink_transaction)
433 transaction = journal->j_shrink_transaction;
435 transaction = journal->j_checkpoint_transactions;
438 first_tid = transaction->t_tid;
439 last_transaction = journal->j_checkpoint_transactions->t_cpprev;
440 next_transaction = transaction;
441 last_tid = last_transaction->t_tid;
443 transaction = next_transaction;
444 next_transaction = transaction->t_cpnext;
445 tid = transaction->t_tid;
447 freed = journal_shrink_one_cp_list(transaction->t_checkpoint_list,
450 (*nr_to_scan) -= min(*nr_to_scan, freed);
451 if (*nr_to_scan == 0)
453 if (need_resched() || spin_needbreak(&journal->j_list_lock))
455 } while (transaction != last_transaction);
457 if (transaction != last_transaction) {
458 journal->j_shrink_transaction = next_transaction;
459 next_tid = next_transaction->t_tid;
461 journal->j_shrink_transaction = NULL;
465 spin_unlock(&journal->j_list_lock);
468 if (*nr_to_scan && next_tid)
471 trace_jbd2_shrink_checkpoint_list(journal, first_tid, tid, last_tid,
478 * journal_clean_checkpoint_list
480 * Find all the written-back checkpoint buffers in the journal and release them.
481 * If 'destroy' is set, release all buffers unconditionally.
483 * Called with j_list_lock held.
485 void __jbd2_journal_clean_checkpoint_list(journal_t *journal, bool destroy)
487 transaction_t *transaction, *last_transaction, *next_transaction;
490 transaction = journal->j_checkpoint_transactions;
494 last_transaction = transaction->t_cpprev;
495 next_transaction = transaction;
497 transaction = next_transaction;
498 next_transaction = transaction->t_cpnext;
499 journal_shrink_one_cp_list(transaction->t_checkpoint_list,
502 * This function only frees up some memory if possible so we
503 * dont have an obligation to finish processing. Bail out if
504 * preemption requested:
509 * Stop scanning if we couldn't free the transaction. This
510 * avoids pointless scanning of transactions which still
511 * weren't checkpointed.
515 } while (transaction != last_transaction);
519 * Remove buffers from all checkpoint lists as journal is aborted and we just
520 * need to free memory
522 void jbd2_journal_destroy_checkpoint(journal_t *journal)
525 * We loop because __jbd2_journal_clean_checkpoint_list() may abort
526 * early due to a need of rescheduling.
529 spin_lock(&journal->j_list_lock);
530 if (!journal->j_checkpoint_transactions) {
531 spin_unlock(&journal->j_list_lock);
534 __jbd2_journal_clean_checkpoint_list(journal, true);
535 spin_unlock(&journal->j_list_lock);
541 * journal_remove_checkpoint: called after a buffer has been committed
542 * to disk (either by being write-back flushed to disk, or being
543 * committed to the log).
545 * We cannot safely clean a transaction out of the log until all of the
546 * buffer updates committed in that transaction have safely been stored
547 * elsewhere on disk. To achieve this, all of the buffers in a
548 * transaction need to be maintained on the transaction's checkpoint
549 * lists until they have been rewritten, at which point this function is
550 * called to remove the buffer from the existing transaction's
553 * The function returns 1 if it frees the transaction, 0 otherwise.
554 * The function can free jh and bh.
556 * This function is called with j_list_lock held.
558 int __jbd2_journal_remove_checkpoint(struct journal_head *jh)
560 struct transaction_chp_stats_s *stats;
561 transaction_t *transaction;
563 struct buffer_head *bh = jh2bh(jh);
565 JBUFFER_TRACE(jh, "entry");
567 transaction = jh->b_cp_transaction;
569 JBUFFER_TRACE(jh, "not on transaction");
572 journal = transaction->t_journal;
574 JBUFFER_TRACE(jh, "removing from transaction");
577 * If we have failed to write the buffer out to disk, the filesystem
578 * may become inconsistent. We cannot abort the journal here since
579 * we hold j_list_lock and we have to be careful about races with
580 * jbd2_journal_destroy(). So mark the writeback IO error in the
581 * journal here and we abort the journal later from a better context.
583 if (buffer_write_io_error(bh))
584 set_bit(JBD2_CHECKPOINT_IO_ERROR, &journal->j_atomic_flags);
587 jh->b_cp_transaction = NULL;
588 percpu_counter_dec(&journal->j_checkpoint_jh_count);
589 jbd2_journal_put_journal_head(jh);
591 /* Is this transaction empty? */
592 if (transaction->t_checkpoint_list)
596 * There is one special case to worry about: if we have just pulled the
597 * buffer off a running or committing transaction's checkpoing list,
598 * then even if the checkpoint list is empty, the transaction obviously
601 * The locking here around t_state is a bit sleazy.
602 * See the comment at the end of jbd2_journal_commit_transaction().
604 if (transaction->t_state != T_FINISHED)
608 * OK, that was the last buffer for the transaction, we can now
609 * safely remove this transaction from the log.
611 stats = &transaction->t_chp_stats;
612 if (stats->cs_chp_time)
613 stats->cs_chp_time = jbd2_time_diff(stats->cs_chp_time,
615 trace_jbd2_checkpoint_stats(journal->j_fs_dev->bd_dev,
616 transaction->t_tid, stats);
618 __jbd2_journal_drop_transaction(journal, transaction);
619 jbd2_journal_free_transaction(transaction);
624 * Check the checkpoint buffer and try to remove it from the checkpoint
625 * list if it's clean. Returns -EBUSY if it is not clean, returns 1 if
626 * it frees the transaction, 0 otherwise.
628 * This function is called with j_list_lock held.
630 int jbd2_journal_try_remove_checkpoint(struct journal_head *jh)
632 struct buffer_head *bh = jh2bh(jh);
634 if (!trylock_buffer(bh))
636 if (buffer_dirty(bh)) {
643 * Buffer is clean and the IO has finished (we held the buffer
644 * lock) so the checkpoint is done. We can safely remove the
645 * buffer from this transaction.
647 JBUFFER_TRACE(jh, "remove from checkpoint list");
648 return __jbd2_journal_remove_checkpoint(jh);
652 * journal_insert_checkpoint: put a committed buffer onto a checkpoint
653 * list so that we know when it is safe to clean the transaction out of
656 * Called with the journal locked.
657 * Called with j_list_lock held.
659 void __jbd2_journal_insert_checkpoint(struct journal_head *jh,
660 transaction_t *transaction)
662 JBUFFER_TRACE(jh, "entry");
663 J_ASSERT_JH(jh, buffer_dirty(jh2bh(jh)) || buffer_jbddirty(jh2bh(jh)));
664 J_ASSERT_JH(jh, jh->b_cp_transaction == NULL);
666 /* Get reference for checkpointing transaction */
667 jbd2_journal_grab_journal_head(jh2bh(jh));
668 jh->b_cp_transaction = transaction;
670 if (!transaction->t_checkpoint_list) {
671 jh->b_cpnext = jh->b_cpprev = jh;
673 jh->b_cpnext = transaction->t_checkpoint_list;
674 jh->b_cpprev = transaction->t_checkpoint_list->b_cpprev;
675 jh->b_cpprev->b_cpnext = jh;
676 jh->b_cpnext->b_cpprev = jh;
678 transaction->t_checkpoint_list = jh;
679 percpu_counter_inc(&transaction->t_journal->j_checkpoint_jh_count);
683 * We've finished with this transaction structure: adios...
685 * The transaction must have no links except for the checkpoint by this
688 * Called with the journal locked.
689 * Called with j_list_lock held.
692 void __jbd2_journal_drop_transaction(journal_t *journal, transaction_t *transaction)
694 assert_spin_locked(&journal->j_list_lock);
696 journal->j_shrink_transaction = NULL;
697 if (transaction->t_cpnext) {
698 transaction->t_cpnext->t_cpprev = transaction->t_cpprev;
699 transaction->t_cpprev->t_cpnext = transaction->t_cpnext;
700 if (journal->j_checkpoint_transactions == transaction)
701 journal->j_checkpoint_transactions =
702 transaction->t_cpnext;
703 if (journal->j_checkpoint_transactions == transaction)
704 journal->j_checkpoint_transactions = NULL;
707 J_ASSERT(transaction->t_state == T_FINISHED);
708 J_ASSERT(transaction->t_buffers == NULL);
709 J_ASSERT(transaction->t_forget == NULL);
710 J_ASSERT(transaction->t_shadow_list == NULL);
711 J_ASSERT(transaction->t_checkpoint_list == NULL);
712 J_ASSERT(atomic_read(&transaction->t_updates) == 0);
713 J_ASSERT(journal->j_committing_transaction != transaction);
714 J_ASSERT(journal->j_running_transaction != transaction);
716 trace_jbd2_drop_transaction(journal, transaction);
718 jbd2_debug(1, "Dropping transaction %d, all done\n", transaction->t_tid);