Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / fs / jbd2 / transaction.c
blobac311037d7a59b03d6403a65c56c7978697463c6
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * linux/fs/jbd2/transaction.c
5 * Written by Stephen C. Tweedie <sct@redhat.com>, 1998
7 * Copyright 1998 Red Hat corp --- All Rights Reserved
9 * Generic filesystem transaction handling code; part of the ext2fs
10 * journaling system.
12 * This file manages transactions (compound commits managed by the
13 * journaling code) and handles (individual atomic operations by the
14 * filesystem).
17 #include <linux/time.h>
18 #include <linux/fs.h>
19 #include <linux/jbd2.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/timer.h>
23 #include <linux/mm.h>
24 #include <linux/highmem.h>
25 #include <linux/hrtimer.h>
26 #include <linux/backing-dev.h>
27 #include <linux/bug.h>
28 #include <linux/module.h>
29 #include <linux/sched/mm.h>
31 #include <trace/events/jbd2.h>
33 static void __jbd2_journal_temp_unlink_buffer(struct journal_head *jh);
34 static void __jbd2_journal_unfile_buffer(struct journal_head *jh);
36 static struct kmem_cache *transaction_cache;
37 int __init jbd2_journal_init_transaction_cache(void)
39 J_ASSERT(!transaction_cache);
40 transaction_cache = kmem_cache_create("jbd2_transaction_s",
41 sizeof(transaction_t),
43 SLAB_HWCACHE_ALIGN|SLAB_TEMPORARY,
44 NULL);
45 if (transaction_cache)
46 return 0;
47 return -ENOMEM;
50 void jbd2_journal_destroy_transaction_cache(void)
52 if (transaction_cache) {
53 kmem_cache_destroy(transaction_cache);
54 transaction_cache = NULL;
58 void jbd2_journal_free_transaction(transaction_t *transaction)
60 if (unlikely(ZERO_OR_NULL_PTR(transaction)))
61 return;
62 kmem_cache_free(transaction_cache, transaction);
66 * jbd2_get_transaction: obtain a new transaction_t object.
68 * Simply allocate and initialise a new transaction. Create it in
69 * RUNNING state and add it to the current journal (which should not
70 * have an existing running transaction: we only make a new transaction
71 * once we have started to commit the old one).
73 * Preconditions:
74 * The journal MUST be locked. We don't perform atomic mallocs on the
75 * new transaction and we can't block without protecting against other
76 * processes trying to touch the journal while it is in transition.
80 static transaction_t *
81 jbd2_get_transaction(journal_t *journal, transaction_t *transaction)
83 transaction->t_journal = journal;
84 transaction->t_state = T_RUNNING;
85 transaction->t_start_time = ktime_get();
86 transaction->t_tid = journal->j_transaction_sequence++;
87 transaction->t_expires = jiffies + journal->j_commit_interval;
88 spin_lock_init(&transaction->t_handle_lock);
89 atomic_set(&transaction->t_updates, 0);
90 atomic_set(&transaction->t_outstanding_credits,
91 atomic_read(&journal->j_reserved_credits));
92 atomic_set(&transaction->t_handle_count, 0);
93 INIT_LIST_HEAD(&transaction->t_inode_list);
94 INIT_LIST_HEAD(&transaction->t_private_list);
96 /* Set up the commit timer for the new transaction. */
97 journal->j_commit_timer.expires = round_jiffies_up(transaction->t_expires);
98 add_timer(&journal->j_commit_timer);
100 J_ASSERT(journal->j_running_transaction == NULL);
101 journal->j_running_transaction = transaction;
102 transaction->t_max_wait = 0;
103 transaction->t_start = jiffies;
104 transaction->t_requested = 0;
106 return transaction;
110 * Handle management.
112 * A handle_t is an object which represents a single atomic update to a
113 * filesystem, and which tracks all of the modifications which form part
114 * of that one update.
118 * Update transaction's maximum wait time, if debugging is enabled.
120 * In order for t_max_wait to be reliable, it must be protected by a
121 * lock. But doing so will mean that start_this_handle() can not be
122 * run in parallel on SMP systems, which limits our scalability. So
123 * unless debugging is enabled, we no longer update t_max_wait, which
124 * means that maximum wait time reported by the jbd2_run_stats
125 * tracepoint will always be zero.
127 static inline void update_t_max_wait(transaction_t *transaction,
128 unsigned long ts)
130 #ifdef CONFIG_JBD2_DEBUG
131 if (jbd2_journal_enable_debug &&
132 time_after(transaction->t_start, ts)) {
133 ts = jbd2_time_diff(ts, transaction->t_start);
134 spin_lock(&transaction->t_handle_lock);
135 if (ts > transaction->t_max_wait)
136 transaction->t_max_wait = ts;
137 spin_unlock(&transaction->t_handle_lock);
139 #endif
143 * Wait until running transaction passes T_LOCKED state. Also starts the commit
144 * if needed. The function expects running transaction to exist and releases
145 * j_state_lock.
147 static void wait_transaction_locked(journal_t *journal)
148 __releases(journal->j_state_lock)
150 DEFINE_WAIT(wait);
151 int need_to_start;
152 tid_t tid = journal->j_running_transaction->t_tid;
154 prepare_to_wait(&journal->j_wait_transaction_locked, &wait,
155 TASK_UNINTERRUPTIBLE);
156 need_to_start = !tid_geq(journal->j_commit_request, tid);
157 read_unlock(&journal->j_state_lock);
158 if (need_to_start)
159 jbd2_log_start_commit(journal, tid);
160 jbd2_might_wait_for_commit(journal);
161 schedule();
162 finish_wait(&journal->j_wait_transaction_locked, &wait);
165 static void sub_reserved_credits(journal_t *journal, int blocks)
167 atomic_sub(blocks, &journal->j_reserved_credits);
168 wake_up(&journal->j_wait_reserved);
172 * Wait until we can add credits for handle to the running transaction. Called
173 * with j_state_lock held for reading. Returns 0 if handle joined the running
174 * transaction. Returns 1 if we had to wait, j_state_lock is dropped, and
175 * caller must retry.
177 static int add_transaction_credits(journal_t *journal, int blocks,
178 int rsv_blocks)
180 transaction_t *t = journal->j_running_transaction;
181 int needed;
182 int total = blocks + rsv_blocks;
185 * If the current transaction is locked down for commit, wait
186 * for the lock to be released.
188 if (t->t_state == T_LOCKED) {
189 wait_transaction_locked(journal);
190 return 1;
194 * If there is not enough space left in the log to write all
195 * potential buffers requested by this operation, we need to
196 * stall pending a log checkpoint to free some more log space.
198 needed = atomic_add_return(total, &t->t_outstanding_credits);
199 if (needed > journal->j_max_transaction_buffers) {
201 * If the current transaction is already too large,
202 * then start to commit it: we can then go back and
203 * attach this handle to a new transaction.
205 atomic_sub(total, &t->t_outstanding_credits);
208 * Is the number of reserved credits in the current transaction too
209 * big to fit this handle? Wait until reserved credits are freed.
211 if (atomic_read(&journal->j_reserved_credits) + total >
212 journal->j_max_transaction_buffers) {
213 read_unlock(&journal->j_state_lock);
214 jbd2_might_wait_for_commit(journal);
215 wait_event(journal->j_wait_reserved,
216 atomic_read(&journal->j_reserved_credits) + total <=
217 journal->j_max_transaction_buffers);
218 return 1;
221 wait_transaction_locked(journal);
222 return 1;
226 * The commit code assumes that it can get enough log space
227 * without forcing a checkpoint. This is *critical* for
228 * correctness: a checkpoint of a buffer which is also
229 * associated with a committing transaction creates a deadlock,
230 * so commit simply cannot force through checkpoints.
232 * We must therefore ensure the necessary space in the journal
233 * *before* starting to dirty potentially checkpointed buffers
234 * in the new transaction.
236 if (jbd2_log_space_left(journal) < jbd2_space_needed(journal)) {
237 atomic_sub(total, &t->t_outstanding_credits);
238 read_unlock(&journal->j_state_lock);
239 jbd2_might_wait_for_commit(journal);
240 write_lock(&journal->j_state_lock);
241 if (jbd2_log_space_left(journal) < jbd2_space_needed(journal))
242 __jbd2_log_wait_for_space(journal);
243 write_unlock(&journal->j_state_lock);
244 return 1;
247 /* No reservation? We are done... */
248 if (!rsv_blocks)
249 return 0;
251 needed = atomic_add_return(rsv_blocks, &journal->j_reserved_credits);
252 /* We allow at most half of a transaction to be reserved */
253 if (needed > journal->j_max_transaction_buffers / 2) {
254 sub_reserved_credits(journal, rsv_blocks);
255 atomic_sub(total, &t->t_outstanding_credits);
256 read_unlock(&journal->j_state_lock);
257 jbd2_might_wait_for_commit(journal);
258 wait_event(journal->j_wait_reserved,
259 atomic_read(&journal->j_reserved_credits) + rsv_blocks
260 <= journal->j_max_transaction_buffers / 2);
261 return 1;
263 return 0;
267 * start_this_handle: Given a handle, deal with any locking or stalling
268 * needed to make sure that there is enough journal space for the handle
269 * to begin. Attach the handle to a transaction and set up the
270 * transaction's buffer credits.
273 static int start_this_handle(journal_t *journal, handle_t *handle,
274 gfp_t gfp_mask)
276 transaction_t *transaction, *new_transaction = NULL;
277 int blocks = handle->h_buffer_credits;
278 int rsv_blocks = 0;
279 unsigned long ts = jiffies;
281 if (handle->h_rsv_handle)
282 rsv_blocks = handle->h_rsv_handle->h_buffer_credits;
285 * Limit the number of reserved credits to 1/2 of maximum transaction
286 * size and limit the number of total credits to not exceed maximum
287 * transaction size per operation.
289 if ((rsv_blocks > journal->j_max_transaction_buffers / 2) ||
290 (rsv_blocks + blocks > journal->j_max_transaction_buffers)) {
291 printk(KERN_ERR "JBD2: %s wants too many credits "
292 "credits:%d rsv_credits:%d max:%d\n",
293 current->comm, blocks, rsv_blocks,
294 journal->j_max_transaction_buffers);
295 WARN_ON(1);
296 return -ENOSPC;
299 alloc_transaction:
300 if (!journal->j_running_transaction) {
302 * If __GFP_FS is not present, then we may be being called from
303 * inside the fs writeback layer, so we MUST NOT fail.
305 if ((gfp_mask & __GFP_FS) == 0)
306 gfp_mask |= __GFP_NOFAIL;
307 new_transaction = kmem_cache_zalloc(transaction_cache,
308 gfp_mask);
309 if (!new_transaction)
310 return -ENOMEM;
313 jbd_debug(3, "New handle %p going live.\n", handle);
316 * We need to hold j_state_lock until t_updates has been incremented,
317 * for proper journal barrier handling
319 repeat:
320 read_lock(&journal->j_state_lock);
321 BUG_ON(journal->j_flags & JBD2_UNMOUNT);
322 if (is_journal_aborted(journal) ||
323 (journal->j_errno != 0 && !(journal->j_flags & JBD2_ACK_ERR))) {
324 read_unlock(&journal->j_state_lock);
325 jbd2_journal_free_transaction(new_transaction);
326 return -EROFS;
330 * Wait on the journal's transaction barrier if necessary. Specifically
331 * we allow reserved handles to proceed because otherwise commit could
332 * deadlock on page writeback not being able to complete.
334 if (!handle->h_reserved && journal->j_barrier_count) {
335 read_unlock(&journal->j_state_lock);
336 wait_event(journal->j_wait_transaction_locked,
337 journal->j_barrier_count == 0);
338 goto repeat;
341 if (!journal->j_running_transaction) {
342 read_unlock(&journal->j_state_lock);
343 if (!new_transaction)
344 goto alloc_transaction;
345 write_lock(&journal->j_state_lock);
346 if (!journal->j_running_transaction &&
347 (handle->h_reserved || !journal->j_barrier_count)) {
348 jbd2_get_transaction(journal, new_transaction);
349 new_transaction = NULL;
351 write_unlock(&journal->j_state_lock);
352 goto repeat;
355 transaction = journal->j_running_transaction;
357 if (!handle->h_reserved) {
358 /* We may have dropped j_state_lock - restart in that case */
359 if (add_transaction_credits(journal, blocks, rsv_blocks))
360 goto repeat;
361 } else {
363 * We have handle reserved so we are allowed to join T_LOCKED
364 * transaction and we don't have to check for transaction size
365 * and journal space.
367 sub_reserved_credits(journal, blocks);
368 handle->h_reserved = 0;
371 /* OK, account for the buffers that this operation expects to
372 * use and add the handle to the running transaction.
374 update_t_max_wait(transaction, ts);
375 handle->h_transaction = transaction;
376 handle->h_requested_credits = blocks;
377 handle->h_start_jiffies = jiffies;
378 atomic_inc(&transaction->t_updates);
379 atomic_inc(&transaction->t_handle_count);
380 jbd_debug(4, "Handle %p given %d credits (total %d, free %lu)\n",
381 handle, blocks,
382 atomic_read(&transaction->t_outstanding_credits),
383 jbd2_log_space_left(journal));
384 read_unlock(&journal->j_state_lock);
385 current->journal_info = handle;
387 rwsem_acquire_read(&journal->j_trans_commit_map, 0, 0, _THIS_IP_);
388 jbd2_journal_free_transaction(new_transaction);
390 * Ensure that no allocations done while the transaction is open are
391 * going to recurse back to the fs layer.
393 handle->saved_alloc_context = memalloc_nofs_save();
394 return 0;
397 /* Allocate a new handle. This should probably be in a slab... */
398 static handle_t *new_handle(int nblocks)
400 handle_t *handle = jbd2_alloc_handle(GFP_NOFS);
401 if (!handle)
402 return NULL;
403 handle->h_buffer_credits = nblocks;
404 handle->h_ref = 1;
406 return handle;
409 handle_t *jbd2__journal_start(journal_t *journal, int nblocks, int rsv_blocks,
410 gfp_t gfp_mask, unsigned int type,
411 unsigned int line_no)
413 handle_t *handle = journal_current_handle();
414 int err;
416 if (!journal)
417 return ERR_PTR(-EROFS);
419 if (handle) {
420 J_ASSERT(handle->h_transaction->t_journal == journal);
421 handle->h_ref++;
422 return handle;
425 handle = new_handle(nblocks);
426 if (!handle)
427 return ERR_PTR(-ENOMEM);
428 if (rsv_blocks) {
429 handle_t *rsv_handle;
431 rsv_handle = new_handle(rsv_blocks);
432 if (!rsv_handle) {
433 jbd2_free_handle(handle);
434 return ERR_PTR(-ENOMEM);
436 rsv_handle->h_reserved = 1;
437 rsv_handle->h_journal = journal;
438 handle->h_rsv_handle = rsv_handle;
441 err = start_this_handle(journal, handle, gfp_mask);
442 if (err < 0) {
443 if (handle->h_rsv_handle)
444 jbd2_free_handle(handle->h_rsv_handle);
445 jbd2_free_handle(handle);
446 return ERR_PTR(err);
448 handle->h_type = type;
449 handle->h_line_no = line_no;
450 trace_jbd2_handle_start(journal->j_fs_dev->bd_dev,
451 handle->h_transaction->t_tid, type,
452 line_no, nblocks);
454 return handle;
456 EXPORT_SYMBOL(jbd2__journal_start);
460 * handle_t *jbd2_journal_start() - Obtain a new handle.
461 * @journal: Journal to start transaction on.
462 * @nblocks: number of block buffer we might modify
464 * We make sure that the transaction can guarantee at least nblocks of
465 * modified buffers in the log. We block until the log can guarantee
466 * that much space. Additionally, if rsv_blocks > 0, we also create another
467 * handle with rsv_blocks reserved blocks in the journal. This handle is
468 * is stored in h_rsv_handle. It is not attached to any particular transaction
469 * and thus doesn't block transaction commit. If the caller uses this reserved
470 * handle, it has to set h_rsv_handle to NULL as otherwise jbd2_journal_stop()
471 * on the parent handle will dispose the reserved one. Reserved handle has to
472 * be converted to a normal handle using jbd2_journal_start_reserved() before
473 * it can be used.
475 * Return a pointer to a newly allocated handle, or an ERR_PTR() value
476 * on failure.
478 handle_t *jbd2_journal_start(journal_t *journal, int nblocks)
480 return jbd2__journal_start(journal, nblocks, 0, GFP_NOFS, 0, 0);
482 EXPORT_SYMBOL(jbd2_journal_start);
484 void jbd2_journal_free_reserved(handle_t *handle)
486 journal_t *journal = handle->h_journal;
488 WARN_ON(!handle->h_reserved);
489 sub_reserved_credits(journal, handle->h_buffer_credits);
490 jbd2_free_handle(handle);
492 EXPORT_SYMBOL(jbd2_journal_free_reserved);
495 * int jbd2_journal_start_reserved() - start reserved handle
496 * @handle: handle to start
497 * @type: for handle statistics
498 * @line_no: for handle statistics
500 * Start handle that has been previously reserved with jbd2_journal_reserve().
501 * This attaches @handle to the running transaction (or creates one if there's
502 * not transaction running). Unlike jbd2_journal_start() this function cannot
503 * block on journal commit, checkpointing, or similar stuff. It can block on
504 * memory allocation or frozen journal though.
506 * Return 0 on success, non-zero on error - handle is freed in that case.
508 int jbd2_journal_start_reserved(handle_t *handle, unsigned int type,
509 unsigned int line_no)
511 journal_t *journal = handle->h_journal;
512 int ret = -EIO;
514 if (WARN_ON(!handle->h_reserved)) {
515 /* Someone passed in normal handle? Just stop it. */
516 jbd2_journal_stop(handle);
517 return ret;
520 * Usefulness of mixing of reserved and unreserved handles is
521 * questionable. So far nobody seems to need it so just error out.
523 if (WARN_ON(current->journal_info)) {
524 jbd2_journal_free_reserved(handle);
525 return ret;
528 handle->h_journal = NULL;
530 * GFP_NOFS is here because callers are likely from writeback or
531 * similarly constrained call sites
533 ret = start_this_handle(journal, handle, GFP_NOFS);
534 if (ret < 0) {
535 jbd2_journal_free_reserved(handle);
536 return ret;
538 handle->h_type = type;
539 handle->h_line_no = line_no;
540 return 0;
542 EXPORT_SYMBOL(jbd2_journal_start_reserved);
545 * int jbd2_journal_extend() - extend buffer credits.
546 * @handle: handle to 'extend'
547 * @nblocks: nr blocks to try to extend by.
549 * Some transactions, such as large extends and truncates, can be done
550 * atomically all at once or in several stages. The operation requests
551 * a credit for a number of buffer modifications in advance, but can
552 * extend its credit if it needs more.
554 * jbd2_journal_extend tries to give the running handle more buffer credits.
555 * It does not guarantee that allocation - this is a best-effort only.
556 * The calling process MUST be able to deal cleanly with a failure to
557 * extend here.
559 * Return 0 on success, non-zero on failure.
561 * return code < 0 implies an error
562 * return code > 0 implies normal transaction-full status.
564 int jbd2_journal_extend(handle_t *handle, int nblocks)
566 transaction_t *transaction = handle->h_transaction;
567 journal_t *journal;
568 int result;
569 int wanted;
571 if (is_handle_aborted(handle))
572 return -EROFS;
573 journal = transaction->t_journal;
575 result = 1;
577 read_lock(&journal->j_state_lock);
579 /* Don't extend a locked-down transaction! */
580 if (transaction->t_state != T_RUNNING) {
581 jbd_debug(3, "denied handle %p %d blocks: "
582 "transaction not running\n", handle, nblocks);
583 goto error_out;
586 spin_lock(&transaction->t_handle_lock);
587 wanted = atomic_add_return(nblocks,
588 &transaction->t_outstanding_credits);
590 if (wanted > journal->j_max_transaction_buffers) {
591 jbd_debug(3, "denied handle %p %d blocks: "
592 "transaction too large\n", handle, nblocks);
593 atomic_sub(nblocks, &transaction->t_outstanding_credits);
594 goto unlock;
597 if (wanted + (wanted >> JBD2_CONTROL_BLOCKS_SHIFT) >
598 jbd2_log_space_left(journal)) {
599 jbd_debug(3, "denied handle %p %d blocks: "
600 "insufficient log space\n", handle, nblocks);
601 atomic_sub(nblocks, &transaction->t_outstanding_credits);
602 goto unlock;
605 trace_jbd2_handle_extend(journal->j_fs_dev->bd_dev,
606 transaction->t_tid,
607 handle->h_type, handle->h_line_no,
608 handle->h_buffer_credits,
609 nblocks);
611 handle->h_buffer_credits += nblocks;
612 handle->h_requested_credits += nblocks;
613 result = 0;
615 jbd_debug(3, "extended handle %p by %d\n", handle, nblocks);
616 unlock:
617 spin_unlock(&transaction->t_handle_lock);
618 error_out:
619 read_unlock(&journal->j_state_lock);
620 return result;
625 * int jbd2_journal_restart() - restart a handle .
626 * @handle: handle to restart
627 * @nblocks: nr credits requested
628 * @gfp_mask: memory allocation flags (for start_this_handle)
630 * Restart a handle for a multi-transaction filesystem
631 * operation.
633 * If the jbd2_journal_extend() call above fails to grant new buffer credits
634 * to a running handle, a call to jbd2_journal_restart will commit the
635 * handle's transaction so far and reattach the handle to a new
636 * transaction capable of guaranteeing the requested number of
637 * credits. We preserve reserved handle if there's any attached to the
638 * passed in handle.
640 int jbd2__journal_restart(handle_t *handle, int nblocks, gfp_t gfp_mask)
642 transaction_t *transaction = handle->h_transaction;
643 journal_t *journal;
644 tid_t tid;
645 int need_to_start, ret;
647 /* If we've had an abort of any type, don't even think about
648 * actually doing the restart! */
649 if (is_handle_aborted(handle))
650 return 0;
651 journal = transaction->t_journal;
654 * First unlink the handle from its current transaction, and start the
655 * commit on that.
657 J_ASSERT(atomic_read(&transaction->t_updates) > 0);
658 J_ASSERT(journal_current_handle() == handle);
660 read_lock(&journal->j_state_lock);
661 spin_lock(&transaction->t_handle_lock);
662 atomic_sub(handle->h_buffer_credits,
663 &transaction->t_outstanding_credits);
664 if (handle->h_rsv_handle) {
665 sub_reserved_credits(journal,
666 handle->h_rsv_handle->h_buffer_credits);
668 if (atomic_dec_and_test(&transaction->t_updates))
669 wake_up(&journal->j_wait_updates);
670 tid = transaction->t_tid;
671 spin_unlock(&transaction->t_handle_lock);
672 handle->h_transaction = NULL;
673 current->journal_info = NULL;
675 jbd_debug(2, "restarting handle %p\n", handle);
676 need_to_start = !tid_geq(journal->j_commit_request, tid);
677 read_unlock(&journal->j_state_lock);
678 if (need_to_start)
679 jbd2_log_start_commit(journal, tid);
681 rwsem_release(&journal->j_trans_commit_map, 1, _THIS_IP_);
682 handle->h_buffer_credits = nblocks;
684 * Restore the original nofs context because the journal restart
685 * is basically the same thing as journal stop and start.
686 * start_this_handle will start a new nofs context.
688 memalloc_nofs_restore(handle->saved_alloc_context);
689 ret = start_this_handle(journal, handle, gfp_mask);
690 return ret;
692 EXPORT_SYMBOL(jbd2__journal_restart);
695 int jbd2_journal_restart(handle_t *handle, int nblocks)
697 return jbd2__journal_restart(handle, nblocks, GFP_NOFS);
699 EXPORT_SYMBOL(jbd2_journal_restart);
702 * void jbd2_journal_lock_updates () - establish a transaction barrier.
703 * @journal: Journal to establish a barrier on.
705 * This locks out any further updates from being started, and blocks
706 * until all existing updates have completed, returning only once the
707 * journal is in a quiescent state with no updates running.
709 * The journal lock should not be held on entry.
711 void jbd2_journal_lock_updates(journal_t *journal)
713 DEFINE_WAIT(wait);
715 jbd2_might_wait_for_commit(journal);
717 write_lock(&journal->j_state_lock);
718 ++journal->j_barrier_count;
720 /* Wait until there are no reserved handles */
721 if (atomic_read(&journal->j_reserved_credits)) {
722 write_unlock(&journal->j_state_lock);
723 wait_event(journal->j_wait_reserved,
724 atomic_read(&journal->j_reserved_credits) == 0);
725 write_lock(&journal->j_state_lock);
728 /* Wait until there are no running updates */
729 while (1) {
730 transaction_t *transaction = journal->j_running_transaction;
732 if (!transaction)
733 break;
735 spin_lock(&transaction->t_handle_lock);
736 prepare_to_wait(&journal->j_wait_updates, &wait,
737 TASK_UNINTERRUPTIBLE);
738 if (!atomic_read(&transaction->t_updates)) {
739 spin_unlock(&transaction->t_handle_lock);
740 finish_wait(&journal->j_wait_updates, &wait);
741 break;
743 spin_unlock(&transaction->t_handle_lock);
744 write_unlock(&journal->j_state_lock);
745 schedule();
746 finish_wait(&journal->j_wait_updates, &wait);
747 write_lock(&journal->j_state_lock);
749 write_unlock(&journal->j_state_lock);
752 * We have now established a barrier against other normal updates, but
753 * we also need to barrier against other jbd2_journal_lock_updates() calls
754 * to make sure that we serialise special journal-locked operations
755 * too.
757 mutex_lock(&journal->j_barrier);
761 * void jbd2_journal_unlock_updates (journal_t* journal) - release barrier
762 * @journal: Journal to release the barrier on.
764 * Release a transaction barrier obtained with jbd2_journal_lock_updates().
766 * Should be called without the journal lock held.
768 void jbd2_journal_unlock_updates (journal_t *journal)
770 J_ASSERT(journal->j_barrier_count != 0);
772 mutex_unlock(&journal->j_barrier);
773 write_lock(&journal->j_state_lock);
774 --journal->j_barrier_count;
775 write_unlock(&journal->j_state_lock);
776 wake_up(&journal->j_wait_transaction_locked);
779 static void warn_dirty_buffer(struct buffer_head *bh)
781 printk(KERN_WARNING
782 "JBD2: Spotted dirty metadata buffer (dev = %pg, blocknr = %llu). "
783 "There's a risk of filesystem corruption in case of system "
784 "crash.\n",
785 bh->b_bdev, (unsigned long long)bh->b_blocknr);
788 /* Call t_frozen trigger and copy buffer data into jh->b_frozen_data. */
789 static void jbd2_freeze_jh_data(struct journal_head *jh)
791 struct page *page;
792 int offset;
793 char *source;
794 struct buffer_head *bh = jh2bh(jh);
796 J_EXPECT_JH(jh, buffer_uptodate(bh), "Possible IO failure.\n");
797 page = bh->b_page;
798 offset = offset_in_page(bh->b_data);
799 source = kmap_atomic(page);
800 /* Fire data frozen trigger just before we copy the data */
801 jbd2_buffer_frozen_trigger(jh, source + offset, jh->b_triggers);
802 memcpy(jh->b_frozen_data, source + offset, bh->b_size);
803 kunmap_atomic(source);
806 * Now that the frozen data is saved off, we need to store any matching
807 * triggers.
809 jh->b_frozen_triggers = jh->b_triggers;
813 * If the buffer is already part of the current transaction, then there
814 * is nothing we need to do. If it is already part of a prior
815 * transaction which we are still committing to disk, then we need to
816 * make sure that we do not overwrite the old copy: we do copy-out to
817 * preserve the copy going to disk. We also account the buffer against
818 * the handle's metadata buffer credits (unless the buffer is already
819 * part of the transaction, that is).
822 static int
823 do_get_write_access(handle_t *handle, struct journal_head *jh,
824 int force_copy)
826 struct buffer_head *bh;
827 transaction_t *transaction = handle->h_transaction;
828 journal_t *journal;
829 int error;
830 char *frozen_buffer = NULL;
831 unsigned long start_lock, time_lock;
833 if (is_handle_aborted(handle))
834 return -EROFS;
835 journal = transaction->t_journal;
837 jbd_debug(5, "journal_head %p, force_copy %d\n", jh, force_copy);
839 JBUFFER_TRACE(jh, "entry");
840 repeat:
841 bh = jh2bh(jh);
843 /* @@@ Need to check for errors here at some point. */
845 start_lock = jiffies;
846 lock_buffer(bh);
847 jbd_lock_bh_state(bh);
849 /* If it takes too long to lock the buffer, trace it */
850 time_lock = jbd2_time_diff(start_lock, jiffies);
851 if (time_lock > HZ/10)
852 trace_jbd2_lock_buffer_stall(bh->b_bdev->bd_dev,
853 jiffies_to_msecs(time_lock));
855 /* We now hold the buffer lock so it is safe to query the buffer
856 * state. Is the buffer dirty?
858 * If so, there are two possibilities. The buffer may be
859 * non-journaled, and undergoing a quite legitimate writeback.
860 * Otherwise, it is journaled, and we don't expect dirty buffers
861 * in that state (the buffers should be marked JBD_Dirty
862 * instead.) So either the IO is being done under our own
863 * control and this is a bug, or it's a third party IO such as
864 * dump(8) (which may leave the buffer scheduled for read ---
865 * ie. locked but not dirty) or tune2fs (which may actually have
866 * the buffer dirtied, ugh.) */
868 if (buffer_dirty(bh)) {
870 * First question: is this buffer already part of the current
871 * transaction or the existing committing transaction?
873 if (jh->b_transaction) {
874 J_ASSERT_JH(jh,
875 jh->b_transaction == transaction ||
876 jh->b_transaction ==
877 journal->j_committing_transaction);
878 if (jh->b_next_transaction)
879 J_ASSERT_JH(jh, jh->b_next_transaction ==
880 transaction);
881 warn_dirty_buffer(bh);
884 * In any case we need to clean the dirty flag and we must
885 * do it under the buffer lock to be sure we don't race
886 * with running write-out.
888 JBUFFER_TRACE(jh, "Journalling dirty buffer");
889 clear_buffer_dirty(bh);
890 set_buffer_jbddirty(bh);
893 unlock_buffer(bh);
895 error = -EROFS;
896 if (is_handle_aborted(handle)) {
897 jbd_unlock_bh_state(bh);
898 goto out;
900 error = 0;
903 * The buffer is already part of this transaction if b_transaction or
904 * b_next_transaction points to it
906 if (jh->b_transaction == transaction ||
907 jh->b_next_transaction == transaction)
908 goto done;
911 * this is the first time this transaction is touching this buffer,
912 * reset the modified flag
914 jh->b_modified = 0;
917 * If the buffer is not journaled right now, we need to make sure it
918 * doesn't get written to disk before the caller actually commits the
919 * new data
921 if (!jh->b_transaction) {
922 JBUFFER_TRACE(jh, "no transaction");
923 J_ASSERT_JH(jh, !jh->b_next_transaction);
924 JBUFFER_TRACE(jh, "file as BJ_Reserved");
926 * Make sure all stores to jh (b_modified, b_frozen_data) are
927 * visible before attaching it to the running transaction.
928 * Paired with barrier in jbd2_write_access_granted()
930 smp_wmb();
931 spin_lock(&journal->j_list_lock);
932 __jbd2_journal_file_buffer(jh, transaction, BJ_Reserved);
933 spin_unlock(&journal->j_list_lock);
934 goto done;
937 * If there is already a copy-out version of this buffer, then we don't
938 * need to make another one
940 if (jh->b_frozen_data) {
941 JBUFFER_TRACE(jh, "has frozen data");
942 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
943 goto attach_next;
946 JBUFFER_TRACE(jh, "owned by older transaction");
947 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
948 J_ASSERT_JH(jh, jh->b_transaction == journal->j_committing_transaction);
951 * There is one case we have to be very careful about. If the
952 * committing transaction is currently writing this buffer out to disk
953 * and has NOT made a copy-out, then we cannot modify the buffer
954 * contents at all right now. The essence of copy-out is that it is
955 * the extra copy, not the primary copy, which gets journaled. If the
956 * primary copy is already going to disk then we cannot do copy-out
957 * here.
959 if (buffer_shadow(bh)) {
960 JBUFFER_TRACE(jh, "on shadow: sleep");
961 jbd_unlock_bh_state(bh);
962 wait_on_bit_io(&bh->b_state, BH_Shadow, TASK_UNINTERRUPTIBLE);
963 goto repeat;
967 * Only do the copy if the currently-owning transaction still needs it.
968 * If buffer isn't on BJ_Metadata list, the committing transaction is
969 * past that stage (here we use the fact that BH_Shadow is set under
970 * bh_state lock together with refiling to BJ_Shadow list and at this
971 * point we know the buffer doesn't have BH_Shadow set).
973 * Subtle point, though: if this is a get_undo_access, then we will be
974 * relying on the frozen_data to contain the new value of the
975 * committed_data record after the transaction, so we HAVE to force the
976 * frozen_data copy in that case.
978 if (jh->b_jlist == BJ_Metadata || force_copy) {
979 JBUFFER_TRACE(jh, "generate frozen data");
980 if (!frozen_buffer) {
981 JBUFFER_TRACE(jh, "allocate memory for buffer");
982 jbd_unlock_bh_state(bh);
983 frozen_buffer = jbd2_alloc(jh2bh(jh)->b_size,
984 GFP_NOFS | __GFP_NOFAIL);
985 goto repeat;
987 jh->b_frozen_data = frozen_buffer;
988 frozen_buffer = NULL;
989 jbd2_freeze_jh_data(jh);
991 attach_next:
993 * Make sure all stores to jh (b_modified, b_frozen_data) are visible
994 * before attaching it to the running transaction. Paired with barrier
995 * in jbd2_write_access_granted()
997 smp_wmb();
998 jh->b_next_transaction = transaction;
1000 done:
1001 jbd_unlock_bh_state(bh);
1004 * If we are about to journal a buffer, then any revoke pending on it is
1005 * no longer valid
1007 jbd2_journal_cancel_revoke(handle, jh);
1009 out:
1010 if (unlikely(frozen_buffer)) /* It's usually NULL */
1011 jbd2_free(frozen_buffer, bh->b_size);
1013 JBUFFER_TRACE(jh, "exit");
1014 return error;
1017 /* Fast check whether buffer is already attached to the required transaction */
1018 static bool jbd2_write_access_granted(handle_t *handle, struct buffer_head *bh,
1019 bool undo)
1021 struct journal_head *jh;
1022 bool ret = false;
1024 /* Dirty buffers require special handling... */
1025 if (buffer_dirty(bh))
1026 return false;
1029 * RCU protects us from dereferencing freed pages. So the checks we do
1030 * are guaranteed not to oops. However the jh slab object can get freed
1031 * & reallocated while we work with it. So we have to be careful. When
1032 * we see jh attached to the running transaction, we know it must stay
1033 * so until the transaction is committed. Thus jh won't be freed and
1034 * will be attached to the same bh while we run. However it can
1035 * happen jh gets freed, reallocated, and attached to the transaction
1036 * just after we get pointer to it from bh. So we have to be careful
1037 * and recheck jh still belongs to our bh before we return success.
1039 rcu_read_lock();
1040 if (!buffer_jbd(bh))
1041 goto out;
1042 /* This should be bh2jh() but that doesn't work with inline functions */
1043 jh = READ_ONCE(bh->b_private);
1044 if (!jh)
1045 goto out;
1046 /* For undo access buffer must have data copied */
1047 if (undo && !jh->b_committed_data)
1048 goto out;
1049 if (jh->b_transaction != handle->h_transaction &&
1050 jh->b_next_transaction != handle->h_transaction)
1051 goto out;
1053 * There are two reasons for the barrier here:
1054 * 1) Make sure to fetch b_bh after we did previous checks so that we
1055 * detect when jh went through free, realloc, attach to transaction
1056 * while we were checking. Paired with implicit barrier in that path.
1057 * 2) So that access to bh done after jbd2_write_access_granted()
1058 * doesn't get reordered and see inconsistent state of concurrent
1059 * do_get_write_access().
1061 smp_mb();
1062 if (unlikely(jh->b_bh != bh))
1063 goto out;
1064 ret = true;
1065 out:
1066 rcu_read_unlock();
1067 return ret;
1071 * int jbd2_journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update.
1072 * @handle: transaction to add buffer modifications to
1073 * @bh: bh to be used for metadata writes
1075 * Returns: error code or 0 on success.
1077 * In full data journalling mode the buffer may be of type BJ_AsyncData,
1078 * because we're ``write()ing`` a buffer which is also part of a shared mapping.
1081 int jbd2_journal_get_write_access(handle_t *handle, struct buffer_head *bh)
1083 struct journal_head *jh;
1084 int rc;
1086 if (jbd2_write_access_granted(handle, bh, false))
1087 return 0;
1089 jh = jbd2_journal_add_journal_head(bh);
1090 /* We do not want to get caught playing with fields which the
1091 * log thread also manipulates. Make sure that the buffer
1092 * completes any outstanding IO before proceeding. */
1093 rc = do_get_write_access(handle, jh, 0);
1094 jbd2_journal_put_journal_head(jh);
1095 return rc;
1100 * When the user wants to journal a newly created buffer_head
1101 * (ie. getblk() returned a new buffer and we are going to populate it
1102 * manually rather than reading off disk), then we need to keep the
1103 * buffer_head locked until it has been completely filled with new
1104 * data. In this case, we should be able to make the assertion that
1105 * the bh is not already part of an existing transaction.
1107 * The buffer should already be locked by the caller by this point.
1108 * There is no lock ranking violation: it was a newly created,
1109 * unlocked buffer beforehand. */
1112 * int jbd2_journal_get_create_access () - notify intent to use newly created bh
1113 * @handle: transaction to new buffer to
1114 * @bh: new buffer.
1116 * Call this if you create a new bh.
1118 int jbd2_journal_get_create_access(handle_t *handle, struct buffer_head *bh)
1120 transaction_t *transaction = handle->h_transaction;
1121 journal_t *journal;
1122 struct journal_head *jh = jbd2_journal_add_journal_head(bh);
1123 int err;
1125 jbd_debug(5, "journal_head %p\n", jh);
1126 err = -EROFS;
1127 if (is_handle_aborted(handle))
1128 goto out;
1129 journal = transaction->t_journal;
1130 err = 0;
1132 JBUFFER_TRACE(jh, "entry");
1134 * The buffer may already belong to this transaction due to pre-zeroing
1135 * in the filesystem's new_block code. It may also be on the previous,
1136 * committing transaction's lists, but it HAS to be in Forget state in
1137 * that case: the transaction must have deleted the buffer for it to be
1138 * reused here.
1140 jbd_lock_bh_state(bh);
1141 J_ASSERT_JH(jh, (jh->b_transaction == transaction ||
1142 jh->b_transaction == NULL ||
1143 (jh->b_transaction == journal->j_committing_transaction &&
1144 jh->b_jlist == BJ_Forget)));
1146 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
1147 J_ASSERT_JH(jh, buffer_locked(jh2bh(jh)));
1149 if (jh->b_transaction == NULL) {
1151 * Previous jbd2_journal_forget() could have left the buffer
1152 * with jbddirty bit set because it was being committed. When
1153 * the commit finished, we've filed the buffer for
1154 * checkpointing and marked it dirty. Now we are reallocating
1155 * the buffer so the transaction freeing it must have
1156 * committed and so it's safe to clear the dirty bit.
1158 clear_buffer_dirty(jh2bh(jh));
1159 /* first access by this transaction */
1160 jh->b_modified = 0;
1162 JBUFFER_TRACE(jh, "file as BJ_Reserved");
1163 spin_lock(&journal->j_list_lock);
1164 __jbd2_journal_file_buffer(jh, transaction, BJ_Reserved);
1165 spin_unlock(&journal->j_list_lock);
1166 } else if (jh->b_transaction == journal->j_committing_transaction) {
1167 /* first access by this transaction */
1168 jh->b_modified = 0;
1170 JBUFFER_TRACE(jh, "set next transaction");
1171 spin_lock(&journal->j_list_lock);
1172 jh->b_next_transaction = transaction;
1173 spin_unlock(&journal->j_list_lock);
1175 jbd_unlock_bh_state(bh);
1178 * akpm: I added this. ext3_alloc_branch can pick up new indirect
1179 * blocks which contain freed but then revoked metadata. We need
1180 * to cancel the revoke in case we end up freeing it yet again
1181 * and the reallocating as data - this would cause a second revoke,
1182 * which hits an assertion error.
1184 JBUFFER_TRACE(jh, "cancelling revoke");
1185 jbd2_journal_cancel_revoke(handle, jh);
1186 out:
1187 jbd2_journal_put_journal_head(jh);
1188 return err;
1192 * int jbd2_journal_get_undo_access() - Notify intent to modify metadata with
1193 * non-rewindable consequences
1194 * @handle: transaction
1195 * @bh: buffer to undo
1197 * Sometimes there is a need to distinguish between metadata which has
1198 * been committed to disk and that which has not. The ext3fs code uses
1199 * this for freeing and allocating space, we have to make sure that we
1200 * do not reuse freed space until the deallocation has been committed,
1201 * since if we overwrote that space we would make the delete
1202 * un-rewindable in case of a crash.
1204 * To deal with that, jbd2_journal_get_undo_access requests write access to a
1205 * buffer for parts of non-rewindable operations such as delete
1206 * operations on the bitmaps. The journaling code must keep a copy of
1207 * the buffer's contents prior to the undo_access call until such time
1208 * as we know that the buffer has definitely been committed to disk.
1210 * We never need to know which transaction the committed data is part
1211 * of, buffers touched here are guaranteed to be dirtied later and so
1212 * will be committed to a new transaction in due course, at which point
1213 * we can discard the old committed data pointer.
1215 * Returns error number or 0 on success.
1217 int jbd2_journal_get_undo_access(handle_t *handle, struct buffer_head *bh)
1219 int err;
1220 struct journal_head *jh;
1221 char *committed_data = NULL;
1223 JBUFFER_TRACE(jh, "entry");
1224 if (jbd2_write_access_granted(handle, bh, true))
1225 return 0;
1227 jh = jbd2_journal_add_journal_head(bh);
1229 * Do this first --- it can drop the journal lock, so we want to
1230 * make sure that obtaining the committed_data is done
1231 * atomically wrt. completion of any outstanding commits.
1233 err = do_get_write_access(handle, jh, 1);
1234 if (err)
1235 goto out;
1237 repeat:
1238 if (!jh->b_committed_data)
1239 committed_data = jbd2_alloc(jh2bh(jh)->b_size,
1240 GFP_NOFS|__GFP_NOFAIL);
1242 jbd_lock_bh_state(bh);
1243 if (!jh->b_committed_data) {
1244 /* Copy out the current buffer contents into the
1245 * preserved, committed copy. */
1246 JBUFFER_TRACE(jh, "generate b_committed data");
1247 if (!committed_data) {
1248 jbd_unlock_bh_state(bh);
1249 goto repeat;
1252 jh->b_committed_data = committed_data;
1253 committed_data = NULL;
1254 memcpy(jh->b_committed_data, bh->b_data, bh->b_size);
1256 jbd_unlock_bh_state(bh);
1257 out:
1258 jbd2_journal_put_journal_head(jh);
1259 if (unlikely(committed_data))
1260 jbd2_free(committed_data, bh->b_size);
1261 return err;
1265 * void jbd2_journal_set_triggers() - Add triggers for commit writeout
1266 * @bh: buffer to trigger on
1267 * @type: struct jbd2_buffer_trigger_type containing the trigger(s).
1269 * Set any triggers on this journal_head. This is always safe, because
1270 * triggers for a committing buffer will be saved off, and triggers for
1271 * a running transaction will match the buffer in that transaction.
1273 * Call with NULL to clear the triggers.
1275 void jbd2_journal_set_triggers(struct buffer_head *bh,
1276 struct jbd2_buffer_trigger_type *type)
1278 struct journal_head *jh = jbd2_journal_grab_journal_head(bh);
1280 if (WARN_ON(!jh))
1281 return;
1282 jh->b_triggers = type;
1283 jbd2_journal_put_journal_head(jh);
1286 void jbd2_buffer_frozen_trigger(struct journal_head *jh, void *mapped_data,
1287 struct jbd2_buffer_trigger_type *triggers)
1289 struct buffer_head *bh = jh2bh(jh);
1291 if (!triggers || !triggers->t_frozen)
1292 return;
1294 triggers->t_frozen(triggers, bh, mapped_data, bh->b_size);
1297 void jbd2_buffer_abort_trigger(struct journal_head *jh,
1298 struct jbd2_buffer_trigger_type *triggers)
1300 if (!triggers || !triggers->t_abort)
1301 return;
1303 triggers->t_abort(triggers, jh2bh(jh));
1307 * int jbd2_journal_dirty_metadata() - mark a buffer as containing dirty metadata
1308 * @handle: transaction to add buffer to.
1309 * @bh: buffer to mark
1311 * mark dirty metadata which needs to be journaled as part of the current
1312 * transaction.
1314 * The buffer must have previously had jbd2_journal_get_write_access()
1315 * called so that it has a valid journal_head attached to the buffer
1316 * head.
1318 * The buffer is placed on the transaction's metadata list and is marked
1319 * as belonging to the transaction.
1321 * Returns error number or 0 on success.
1323 * Special care needs to be taken if the buffer already belongs to the
1324 * current committing transaction (in which case we should have frozen
1325 * data present for that commit). In that case, we don't relink the
1326 * buffer: that only gets done when the old transaction finally
1327 * completes its commit.
1329 int jbd2_journal_dirty_metadata(handle_t *handle, struct buffer_head *bh)
1331 transaction_t *transaction = handle->h_transaction;
1332 journal_t *journal;
1333 struct journal_head *jh;
1334 int ret = 0;
1336 if (is_handle_aborted(handle))
1337 return -EROFS;
1338 if (!buffer_jbd(bh)) {
1339 ret = -EUCLEAN;
1340 goto out;
1343 * We don't grab jh reference here since the buffer must be part
1344 * of the running transaction.
1346 jh = bh2jh(bh);
1348 * This and the following assertions are unreliable since we may see jh
1349 * in inconsistent state unless we grab bh_state lock. But this is
1350 * crucial to catch bugs so let's do a reliable check until the
1351 * lockless handling is fully proven.
1353 if (jh->b_transaction != transaction &&
1354 jh->b_next_transaction != transaction) {
1355 jbd_lock_bh_state(bh);
1356 J_ASSERT_JH(jh, jh->b_transaction == transaction ||
1357 jh->b_next_transaction == transaction);
1358 jbd_unlock_bh_state(bh);
1360 if (jh->b_modified == 1) {
1361 /* If it's in our transaction it must be in BJ_Metadata list. */
1362 if (jh->b_transaction == transaction &&
1363 jh->b_jlist != BJ_Metadata) {
1364 jbd_lock_bh_state(bh);
1365 J_ASSERT_JH(jh, jh->b_transaction != transaction ||
1366 jh->b_jlist == BJ_Metadata);
1367 jbd_unlock_bh_state(bh);
1369 goto out;
1372 journal = transaction->t_journal;
1373 jbd_debug(5, "journal_head %p\n", jh);
1374 JBUFFER_TRACE(jh, "entry");
1376 jbd_lock_bh_state(bh);
1378 if (jh->b_modified == 0) {
1380 * This buffer's got modified and becoming part
1381 * of the transaction. This needs to be done
1382 * once a transaction -bzzz
1384 jh->b_modified = 1;
1385 if (handle->h_buffer_credits <= 0) {
1386 ret = -ENOSPC;
1387 goto out_unlock_bh;
1389 handle->h_buffer_credits--;
1393 * fastpath, to avoid expensive locking. If this buffer is already
1394 * on the running transaction's metadata list there is nothing to do.
1395 * Nobody can take it off again because there is a handle open.
1396 * I _think_ we're OK here with SMP barriers - a mistaken decision will
1397 * result in this test being false, so we go in and take the locks.
1399 if (jh->b_transaction == transaction && jh->b_jlist == BJ_Metadata) {
1400 JBUFFER_TRACE(jh, "fastpath");
1401 if (unlikely(jh->b_transaction !=
1402 journal->j_running_transaction)) {
1403 printk(KERN_ERR "JBD2: %s: "
1404 "jh->b_transaction (%llu, %p, %u) != "
1405 "journal->j_running_transaction (%p, %u)\n",
1406 journal->j_devname,
1407 (unsigned long long) bh->b_blocknr,
1408 jh->b_transaction,
1409 jh->b_transaction ? jh->b_transaction->t_tid : 0,
1410 journal->j_running_transaction,
1411 journal->j_running_transaction ?
1412 journal->j_running_transaction->t_tid : 0);
1413 ret = -EINVAL;
1415 goto out_unlock_bh;
1418 set_buffer_jbddirty(bh);
1421 * Metadata already on the current transaction list doesn't
1422 * need to be filed. Metadata on another transaction's list must
1423 * be committing, and will be refiled once the commit completes:
1424 * leave it alone for now.
1426 if (jh->b_transaction != transaction) {
1427 JBUFFER_TRACE(jh, "already on other transaction");
1428 if (unlikely(((jh->b_transaction !=
1429 journal->j_committing_transaction)) ||
1430 (jh->b_next_transaction != transaction))) {
1431 printk(KERN_ERR "jbd2_journal_dirty_metadata: %s: "
1432 "bad jh for block %llu: "
1433 "transaction (%p, %u), "
1434 "jh->b_transaction (%p, %u), "
1435 "jh->b_next_transaction (%p, %u), jlist %u\n",
1436 journal->j_devname,
1437 (unsigned long long) bh->b_blocknr,
1438 transaction, transaction->t_tid,
1439 jh->b_transaction,
1440 jh->b_transaction ?
1441 jh->b_transaction->t_tid : 0,
1442 jh->b_next_transaction,
1443 jh->b_next_transaction ?
1444 jh->b_next_transaction->t_tid : 0,
1445 jh->b_jlist);
1446 WARN_ON(1);
1447 ret = -EINVAL;
1449 /* And this case is illegal: we can't reuse another
1450 * transaction's data buffer, ever. */
1451 goto out_unlock_bh;
1454 /* That test should have eliminated the following case: */
1455 J_ASSERT_JH(jh, jh->b_frozen_data == NULL);
1457 JBUFFER_TRACE(jh, "file as BJ_Metadata");
1458 spin_lock(&journal->j_list_lock);
1459 __jbd2_journal_file_buffer(jh, transaction, BJ_Metadata);
1460 spin_unlock(&journal->j_list_lock);
1461 out_unlock_bh:
1462 jbd_unlock_bh_state(bh);
1463 out:
1464 JBUFFER_TRACE(jh, "exit");
1465 return ret;
1469 * void jbd2_journal_forget() - bforget() for potentially-journaled buffers.
1470 * @handle: transaction handle
1471 * @bh: bh to 'forget'
1473 * We can only do the bforget if there are no commits pending against the
1474 * buffer. If the buffer is dirty in the current running transaction we
1475 * can safely unlink it.
1477 * bh may not be a journalled buffer at all - it may be a non-JBD
1478 * buffer which came off the hashtable. Check for this.
1480 * Decrements bh->b_count by one.
1482 * Allow this call even if the handle has aborted --- it may be part of
1483 * the caller's cleanup after an abort.
1485 int jbd2_journal_forget (handle_t *handle, struct buffer_head *bh)
1487 transaction_t *transaction = handle->h_transaction;
1488 journal_t *journal;
1489 struct journal_head *jh;
1490 int drop_reserve = 0;
1491 int err = 0;
1492 int was_modified = 0;
1494 if (is_handle_aborted(handle))
1495 return -EROFS;
1496 journal = transaction->t_journal;
1498 BUFFER_TRACE(bh, "entry");
1500 jbd_lock_bh_state(bh);
1502 if (!buffer_jbd(bh))
1503 goto not_jbd;
1504 jh = bh2jh(bh);
1506 /* Critical error: attempting to delete a bitmap buffer, maybe?
1507 * Don't do any jbd operations, and return an error. */
1508 if (!J_EXPECT_JH(jh, !jh->b_committed_data,
1509 "inconsistent data on disk")) {
1510 err = -EIO;
1511 goto not_jbd;
1514 /* keep track of whether or not this transaction modified us */
1515 was_modified = jh->b_modified;
1518 * The buffer's going from the transaction, we must drop
1519 * all references -bzzz
1521 jh->b_modified = 0;
1523 if (jh->b_transaction == transaction) {
1524 J_ASSERT_JH(jh, !jh->b_frozen_data);
1526 /* If we are forgetting a buffer which is already part
1527 * of this transaction, then we can just drop it from
1528 * the transaction immediately. */
1529 clear_buffer_dirty(bh);
1530 clear_buffer_jbddirty(bh);
1532 JBUFFER_TRACE(jh, "belongs to current transaction: unfile");
1535 * we only want to drop a reference if this transaction
1536 * modified the buffer
1538 if (was_modified)
1539 drop_reserve = 1;
1542 * We are no longer going to journal this buffer.
1543 * However, the commit of this transaction is still
1544 * important to the buffer: the delete that we are now
1545 * processing might obsolete an old log entry, so by
1546 * committing, we can satisfy the buffer's checkpoint.
1548 * So, if we have a checkpoint on the buffer, we should
1549 * now refile the buffer on our BJ_Forget list so that
1550 * we know to remove the checkpoint after we commit.
1553 spin_lock(&journal->j_list_lock);
1554 if (jh->b_cp_transaction) {
1555 __jbd2_journal_temp_unlink_buffer(jh);
1556 __jbd2_journal_file_buffer(jh, transaction, BJ_Forget);
1557 } else {
1558 __jbd2_journal_unfile_buffer(jh);
1559 if (!buffer_jbd(bh)) {
1560 spin_unlock(&journal->j_list_lock);
1561 jbd_unlock_bh_state(bh);
1562 __bforget(bh);
1563 goto drop;
1566 spin_unlock(&journal->j_list_lock);
1567 } else if (jh->b_transaction) {
1568 J_ASSERT_JH(jh, (jh->b_transaction ==
1569 journal->j_committing_transaction));
1570 /* However, if the buffer is still owned by a prior
1571 * (committing) transaction, we can't drop it yet... */
1572 JBUFFER_TRACE(jh, "belongs to older transaction");
1573 /* ... but we CAN drop it from the new transaction if we
1574 * have also modified it since the original commit. */
1576 if (jh->b_next_transaction) {
1577 J_ASSERT(jh->b_next_transaction == transaction);
1578 spin_lock(&journal->j_list_lock);
1579 jh->b_next_transaction = NULL;
1580 spin_unlock(&journal->j_list_lock);
1583 * only drop a reference if this transaction modified
1584 * the buffer
1586 if (was_modified)
1587 drop_reserve = 1;
1591 not_jbd:
1592 jbd_unlock_bh_state(bh);
1593 __brelse(bh);
1594 drop:
1595 if (drop_reserve) {
1596 /* no need to reserve log space for this block -bzzz */
1597 handle->h_buffer_credits++;
1599 return err;
1603 * int jbd2_journal_stop() - complete a transaction
1604 * @handle: transaction to complete.
1606 * All done for a particular handle.
1608 * There is not much action needed here. We just return any remaining
1609 * buffer credits to the transaction and remove the handle. The only
1610 * complication is that we need to start a commit operation if the
1611 * filesystem is marked for synchronous update.
1613 * jbd2_journal_stop itself will not usually return an error, but it may
1614 * do so in unusual circumstances. In particular, expect it to
1615 * return -EIO if a jbd2_journal_abort has been executed since the
1616 * transaction began.
1618 int jbd2_journal_stop(handle_t *handle)
1620 transaction_t *transaction = handle->h_transaction;
1621 journal_t *journal;
1622 int err = 0, wait_for_commit = 0;
1623 tid_t tid;
1624 pid_t pid;
1626 if (!transaction) {
1628 * Handle is already detached from the transaction so
1629 * there is nothing to do other than decrease a refcount,
1630 * or free the handle if refcount drops to zero
1632 if (--handle->h_ref > 0) {
1633 jbd_debug(4, "h_ref %d -> %d\n", handle->h_ref + 1,
1634 handle->h_ref);
1635 return err;
1636 } else {
1637 if (handle->h_rsv_handle)
1638 jbd2_free_handle(handle->h_rsv_handle);
1639 goto free_and_exit;
1642 journal = transaction->t_journal;
1644 J_ASSERT(journal_current_handle() == handle);
1646 if (is_handle_aborted(handle))
1647 err = -EIO;
1648 else
1649 J_ASSERT(atomic_read(&transaction->t_updates) > 0);
1651 if (--handle->h_ref > 0) {
1652 jbd_debug(4, "h_ref %d -> %d\n", handle->h_ref + 1,
1653 handle->h_ref);
1654 return err;
1657 jbd_debug(4, "Handle %p going down\n", handle);
1658 trace_jbd2_handle_stats(journal->j_fs_dev->bd_dev,
1659 transaction->t_tid,
1660 handle->h_type, handle->h_line_no,
1661 jiffies - handle->h_start_jiffies,
1662 handle->h_sync, handle->h_requested_credits,
1663 (handle->h_requested_credits -
1664 handle->h_buffer_credits));
1667 * Implement synchronous transaction batching. If the handle
1668 * was synchronous, don't force a commit immediately. Let's
1669 * yield and let another thread piggyback onto this
1670 * transaction. Keep doing that while new threads continue to
1671 * arrive. It doesn't cost much - we're about to run a commit
1672 * and sleep on IO anyway. Speeds up many-threaded, many-dir
1673 * operations by 30x or more...
1675 * We try and optimize the sleep time against what the
1676 * underlying disk can do, instead of having a static sleep
1677 * time. This is useful for the case where our storage is so
1678 * fast that it is more optimal to go ahead and force a flush
1679 * and wait for the transaction to be committed than it is to
1680 * wait for an arbitrary amount of time for new writers to
1681 * join the transaction. We achieve this by measuring how
1682 * long it takes to commit a transaction, and compare it with
1683 * how long this transaction has been running, and if run time
1684 * < commit time then we sleep for the delta and commit. This
1685 * greatly helps super fast disks that would see slowdowns as
1686 * more threads started doing fsyncs.
1688 * But don't do this if this process was the most recent one
1689 * to perform a synchronous write. We do this to detect the
1690 * case where a single process is doing a stream of sync
1691 * writes. No point in waiting for joiners in that case.
1693 * Setting max_batch_time to 0 disables this completely.
1695 pid = current->pid;
1696 if (handle->h_sync && journal->j_last_sync_writer != pid &&
1697 journal->j_max_batch_time) {
1698 u64 commit_time, trans_time;
1700 journal->j_last_sync_writer = pid;
1702 read_lock(&journal->j_state_lock);
1703 commit_time = journal->j_average_commit_time;
1704 read_unlock(&journal->j_state_lock);
1706 trans_time = ktime_to_ns(ktime_sub(ktime_get(),
1707 transaction->t_start_time));
1709 commit_time = max_t(u64, commit_time,
1710 1000*journal->j_min_batch_time);
1711 commit_time = min_t(u64, commit_time,
1712 1000*journal->j_max_batch_time);
1714 if (trans_time < commit_time) {
1715 ktime_t expires = ktime_add_ns(ktime_get(),
1716 commit_time);
1717 set_current_state(TASK_UNINTERRUPTIBLE);
1718 schedule_hrtimeout(&expires, HRTIMER_MODE_ABS);
1722 if (handle->h_sync)
1723 transaction->t_synchronous_commit = 1;
1724 current->journal_info = NULL;
1725 atomic_sub(handle->h_buffer_credits,
1726 &transaction->t_outstanding_credits);
1729 * If the handle is marked SYNC, we need to set another commit
1730 * going! We also want to force a commit if the current
1731 * transaction is occupying too much of the log, or if the
1732 * transaction is too old now.
1734 if (handle->h_sync ||
1735 (atomic_read(&transaction->t_outstanding_credits) >
1736 journal->j_max_transaction_buffers) ||
1737 time_after_eq(jiffies, transaction->t_expires)) {
1738 /* Do this even for aborted journals: an abort still
1739 * completes the commit thread, it just doesn't write
1740 * anything to disk. */
1742 jbd_debug(2, "transaction too old, requesting commit for "
1743 "handle %p\n", handle);
1744 /* This is non-blocking */
1745 jbd2_log_start_commit(journal, transaction->t_tid);
1748 * Special case: JBD2_SYNC synchronous updates require us
1749 * to wait for the commit to complete.
1751 if (handle->h_sync && !(current->flags & PF_MEMALLOC))
1752 wait_for_commit = 1;
1756 * Once we drop t_updates, if it goes to zero the transaction
1757 * could start committing on us and eventually disappear. So
1758 * once we do this, we must not dereference transaction
1759 * pointer again.
1761 tid = transaction->t_tid;
1762 if (atomic_dec_and_test(&transaction->t_updates)) {
1763 wake_up(&journal->j_wait_updates);
1764 if (journal->j_barrier_count)
1765 wake_up(&journal->j_wait_transaction_locked);
1768 rwsem_release(&journal->j_trans_commit_map, 1, _THIS_IP_);
1770 if (wait_for_commit)
1771 err = jbd2_log_wait_commit(journal, tid);
1773 if (handle->h_rsv_handle)
1774 jbd2_journal_free_reserved(handle->h_rsv_handle);
1775 free_and_exit:
1777 * Scope of the GFP_NOFS context is over here and so we can restore the
1778 * original alloc context.
1780 memalloc_nofs_restore(handle->saved_alloc_context);
1781 jbd2_free_handle(handle);
1782 return err;
1787 * List management code snippets: various functions for manipulating the
1788 * transaction buffer lists.
1793 * Append a buffer to a transaction list, given the transaction's list head
1794 * pointer.
1796 * j_list_lock is held.
1798 * jbd_lock_bh_state(jh2bh(jh)) is held.
1801 static inline void
1802 __blist_add_buffer(struct journal_head **list, struct journal_head *jh)
1804 if (!*list) {
1805 jh->b_tnext = jh->b_tprev = jh;
1806 *list = jh;
1807 } else {
1808 /* Insert at the tail of the list to preserve order */
1809 struct journal_head *first = *list, *last = first->b_tprev;
1810 jh->b_tprev = last;
1811 jh->b_tnext = first;
1812 last->b_tnext = first->b_tprev = jh;
1817 * Remove a buffer from a transaction list, given the transaction's list
1818 * head pointer.
1820 * Called with j_list_lock held, and the journal may not be locked.
1822 * jbd_lock_bh_state(jh2bh(jh)) is held.
1825 static inline void
1826 __blist_del_buffer(struct journal_head **list, struct journal_head *jh)
1828 if (*list == jh) {
1829 *list = jh->b_tnext;
1830 if (*list == jh)
1831 *list = NULL;
1833 jh->b_tprev->b_tnext = jh->b_tnext;
1834 jh->b_tnext->b_tprev = jh->b_tprev;
1838 * Remove a buffer from the appropriate transaction list.
1840 * Note that this function can *change* the value of
1841 * bh->b_transaction->t_buffers, t_forget, t_shadow_list, t_log_list or
1842 * t_reserved_list. If the caller is holding onto a copy of one of these
1843 * pointers, it could go bad. Generally the caller needs to re-read the
1844 * pointer from the transaction_t.
1846 * Called under j_list_lock.
1848 static void __jbd2_journal_temp_unlink_buffer(struct journal_head *jh)
1850 struct journal_head **list = NULL;
1851 transaction_t *transaction;
1852 struct buffer_head *bh = jh2bh(jh);
1854 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
1855 transaction = jh->b_transaction;
1856 if (transaction)
1857 assert_spin_locked(&transaction->t_journal->j_list_lock);
1859 J_ASSERT_JH(jh, jh->b_jlist < BJ_Types);
1860 if (jh->b_jlist != BJ_None)
1861 J_ASSERT_JH(jh, transaction != NULL);
1863 switch (jh->b_jlist) {
1864 case BJ_None:
1865 return;
1866 case BJ_Metadata:
1867 transaction->t_nr_buffers--;
1868 J_ASSERT_JH(jh, transaction->t_nr_buffers >= 0);
1869 list = &transaction->t_buffers;
1870 break;
1871 case BJ_Forget:
1872 list = &transaction->t_forget;
1873 break;
1874 case BJ_Shadow:
1875 list = &transaction->t_shadow_list;
1876 break;
1877 case BJ_Reserved:
1878 list = &transaction->t_reserved_list;
1879 break;
1882 __blist_del_buffer(list, jh);
1883 jh->b_jlist = BJ_None;
1884 if (transaction && is_journal_aborted(transaction->t_journal))
1885 clear_buffer_jbddirty(bh);
1886 else if (test_clear_buffer_jbddirty(bh))
1887 mark_buffer_dirty(bh); /* Expose it to the VM */
1891 * Remove buffer from all transactions.
1893 * Called with bh_state lock and j_list_lock
1895 * jh and bh may be already freed when this function returns.
1897 static void __jbd2_journal_unfile_buffer(struct journal_head *jh)
1899 __jbd2_journal_temp_unlink_buffer(jh);
1900 jh->b_transaction = NULL;
1901 jbd2_journal_put_journal_head(jh);
1904 void jbd2_journal_unfile_buffer(journal_t *journal, struct journal_head *jh)
1906 struct buffer_head *bh = jh2bh(jh);
1908 /* Get reference so that buffer cannot be freed before we unlock it */
1909 get_bh(bh);
1910 jbd_lock_bh_state(bh);
1911 spin_lock(&journal->j_list_lock);
1912 __jbd2_journal_unfile_buffer(jh);
1913 spin_unlock(&journal->j_list_lock);
1914 jbd_unlock_bh_state(bh);
1915 __brelse(bh);
1919 * Called from jbd2_journal_try_to_free_buffers().
1921 * Called under jbd_lock_bh_state(bh)
1923 static void
1924 __journal_try_to_free_buffer(journal_t *journal, struct buffer_head *bh)
1926 struct journal_head *jh;
1928 jh = bh2jh(bh);
1930 if (buffer_locked(bh) || buffer_dirty(bh))
1931 goto out;
1933 if (jh->b_next_transaction != NULL || jh->b_transaction != NULL)
1934 goto out;
1936 spin_lock(&journal->j_list_lock);
1937 if (jh->b_cp_transaction != NULL) {
1938 /* written-back checkpointed metadata buffer */
1939 JBUFFER_TRACE(jh, "remove from checkpoint list");
1940 __jbd2_journal_remove_checkpoint(jh);
1942 spin_unlock(&journal->j_list_lock);
1943 out:
1944 return;
1948 * int jbd2_journal_try_to_free_buffers() - try to free page buffers.
1949 * @journal: journal for operation
1950 * @page: to try and free
1951 * @gfp_mask: we use the mask to detect how hard should we try to release
1952 * buffers. If __GFP_DIRECT_RECLAIM and __GFP_FS is set, we wait for commit
1953 * code to release the buffers.
1956 * For all the buffers on this page,
1957 * if they are fully written out ordered data, move them onto BUF_CLEAN
1958 * so try_to_free_buffers() can reap them.
1960 * This function returns non-zero if we wish try_to_free_buffers()
1961 * to be called. We do this if the page is releasable by try_to_free_buffers().
1962 * We also do it if the page has locked or dirty buffers and the caller wants
1963 * us to perform sync or async writeout.
1965 * This complicates JBD locking somewhat. We aren't protected by the
1966 * BKL here. We wish to remove the buffer from its committing or
1967 * running transaction's ->t_datalist via __jbd2_journal_unfile_buffer.
1969 * This may *change* the value of transaction_t->t_datalist, so anyone
1970 * who looks at t_datalist needs to lock against this function.
1972 * Even worse, someone may be doing a jbd2_journal_dirty_data on this
1973 * buffer. So we need to lock against that. jbd2_journal_dirty_data()
1974 * will come out of the lock with the buffer dirty, which makes it
1975 * ineligible for release here.
1977 * Who else is affected by this? hmm... Really the only contender
1978 * is do_get_write_access() - it could be looking at the buffer while
1979 * journal_try_to_free_buffer() is changing its state. But that
1980 * cannot happen because we never reallocate freed data as metadata
1981 * while the data is part of a transaction. Yes?
1983 * Return 0 on failure, 1 on success
1985 int jbd2_journal_try_to_free_buffers(journal_t *journal,
1986 struct page *page, gfp_t gfp_mask)
1988 struct buffer_head *head;
1989 struct buffer_head *bh;
1990 int ret = 0;
1992 J_ASSERT(PageLocked(page));
1994 head = page_buffers(page);
1995 bh = head;
1996 do {
1997 struct journal_head *jh;
2000 * We take our own ref against the journal_head here to avoid
2001 * having to add tons of locking around each instance of
2002 * jbd2_journal_put_journal_head().
2004 jh = jbd2_journal_grab_journal_head(bh);
2005 if (!jh)
2006 continue;
2008 jbd_lock_bh_state(bh);
2009 __journal_try_to_free_buffer(journal, bh);
2010 jbd2_journal_put_journal_head(jh);
2011 jbd_unlock_bh_state(bh);
2012 if (buffer_jbd(bh))
2013 goto busy;
2014 } while ((bh = bh->b_this_page) != head);
2016 ret = try_to_free_buffers(page);
2018 busy:
2019 return ret;
2023 * This buffer is no longer needed. If it is on an older transaction's
2024 * checkpoint list we need to record it on this transaction's forget list
2025 * to pin this buffer (and hence its checkpointing transaction) down until
2026 * this transaction commits. If the buffer isn't on a checkpoint list, we
2027 * release it.
2028 * Returns non-zero if JBD no longer has an interest in the buffer.
2030 * Called under j_list_lock.
2032 * Called under jbd_lock_bh_state(bh).
2034 static int __dispose_buffer(struct journal_head *jh, transaction_t *transaction)
2036 int may_free = 1;
2037 struct buffer_head *bh = jh2bh(jh);
2039 if (jh->b_cp_transaction) {
2040 JBUFFER_TRACE(jh, "on running+cp transaction");
2041 __jbd2_journal_temp_unlink_buffer(jh);
2043 * We don't want to write the buffer anymore, clear the
2044 * bit so that we don't confuse checks in
2045 * __journal_file_buffer
2047 clear_buffer_dirty(bh);
2048 __jbd2_journal_file_buffer(jh, transaction, BJ_Forget);
2049 may_free = 0;
2050 } else {
2051 JBUFFER_TRACE(jh, "on running transaction");
2052 __jbd2_journal_unfile_buffer(jh);
2054 return may_free;
2058 * jbd2_journal_invalidatepage
2060 * This code is tricky. It has a number of cases to deal with.
2062 * There are two invariants which this code relies on:
2064 * i_size must be updated on disk before we start calling invalidatepage on the
2065 * data.
2067 * This is done in ext3 by defining an ext3_setattr method which
2068 * updates i_size before truncate gets going. By maintaining this
2069 * invariant, we can be sure that it is safe to throw away any buffers
2070 * attached to the current transaction: once the transaction commits,
2071 * we know that the data will not be needed.
2073 * Note however that we can *not* throw away data belonging to the
2074 * previous, committing transaction!
2076 * Any disk blocks which *are* part of the previous, committing
2077 * transaction (and which therefore cannot be discarded immediately) are
2078 * not going to be reused in the new running transaction
2080 * The bitmap committed_data images guarantee this: any block which is
2081 * allocated in one transaction and removed in the next will be marked
2082 * as in-use in the committed_data bitmap, so cannot be reused until
2083 * the next transaction to delete the block commits. This means that
2084 * leaving committing buffers dirty is quite safe: the disk blocks
2085 * cannot be reallocated to a different file and so buffer aliasing is
2086 * not possible.
2089 * The above applies mainly to ordered data mode. In writeback mode we
2090 * don't make guarantees about the order in which data hits disk --- in
2091 * particular we don't guarantee that new dirty data is flushed before
2092 * transaction commit --- so it is always safe just to discard data
2093 * immediately in that mode. --sct
2097 * The journal_unmap_buffer helper function returns zero if the buffer
2098 * concerned remains pinned as an anonymous buffer belonging to an older
2099 * transaction.
2101 * We're outside-transaction here. Either or both of j_running_transaction
2102 * and j_committing_transaction may be NULL.
2104 static int journal_unmap_buffer(journal_t *journal, struct buffer_head *bh,
2105 int partial_page)
2107 transaction_t *transaction;
2108 struct journal_head *jh;
2109 int may_free = 1;
2111 BUFFER_TRACE(bh, "entry");
2114 * It is safe to proceed here without the j_list_lock because the
2115 * buffers cannot be stolen by try_to_free_buffers as long as we are
2116 * holding the page lock. --sct
2119 if (!buffer_jbd(bh))
2120 goto zap_buffer_unlocked;
2122 /* OK, we have data buffer in journaled mode */
2123 write_lock(&journal->j_state_lock);
2124 jbd_lock_bh_state(bh);
2125 spin_lock(&journal->j_list_lock);
2127 jh = jbd2_journal_grab_journal_head(bh);
2128 if (!jh)
2129 goto zap_buffer_no_jh;
2132 * We cannot remove the buffer from checkpoint lists until the
2133 * transaction adding inode to orphan list (let's call it T)
2134 * is committed. Otherwise if the transaction changing the
2135 * buffer would be cleaned from the journal before T is
2136 * committed, a crash will cause that the correct contents of
2137 * the buffer will be lost. On the other hand we have to
2138 * clear the buffer dirty bit at latest at the moment when the
2139 * transaction marking the buffer as freed in the filesystem
2140 * structures is committed because from that moment on the
2141 * block can be reallocated and used by a different page.
2142 * Since the block hasn't been freed yet but the inode has
2143 * already been added to orphan list, it is safe for us to add
2144 * the buffer to BJ_Forget list of the newest transaction.
2146 * Also we have to clear buffer_mapped flag of a truncated buffer
2147 * because the buffer_head may be attached to the page straddling
2148 * i_size (can happen only when blocksize < pagesize) and thus the
2149 * buffer_head can be reused when the file is extended again. So we end
2150 * up keeping around invalidated buffers attached to transactions'
2151 * BJ_Forget list just to stop checkpointing code from cleaning up
2152 * the transaction this buffer was modified in.
2154 transaction = jh->b_transaction;
2155 if (transaction == NULL) {
2156 /* First case: not on any transaction. If it
2157 * has no checkpoint link, then we can zap it:
2158 * it's a writeback-mode buffer so we don't care
2159 * if it hits disk safely. */
2160 if (!jh->b_cp_transaction) {
2161 JBUFFER_TRACE(jh, "not on any transaction: zap");
2162 goto zap_buffer;
2165 if (!buffer_dirty(bh)) {
2166 /* bdflush has written it. We can drop it now */
2167 __jbd2_journal_remove_checkpoint(jh);
2168 goto zap_buffer;
2171 /* OK, it must be in the journal but still not
2172 * written fully to disk: it's metadata or
2173 * journaled data... */
2175 if (journal->j_running_transaction) {
2176 /* ... and once the current transaction has
2177 * committed, the buffer won't be needed any
2178 * longer. */
2179 JBUFFER_TRACE(jh, "checkpointed: add to BJ_Forget");
2180 may_free = __dispose_buffer(jh,
2181 journal->j_running_transaction);
2182 goto zap_buffer;
2183 } else {
2184 /* There is no currently-running transaction. So the
2185 * orphan record which we wrote for this file must have
2186 * passed into commit. We must attach this buffer to
2187 * the committing transaction, if it exists. */
2188 if (journal->j_committing_transaction) {
2189 JBUFFER_TRACE(jh, "give to committing trans");
2190 may_free = __dispose_buffer(jh,
2191 journal->j_committing_transaction);
2192 goto zap_buffer;
2193 } else {
2194 /* The orphan record's transaction has
2195 * committed. We can cleanse this buffer */
2196 clear_buffer_jbddirty(bh);
2197 __jbd2_journal_remove_checkpoint(jh);
2198 goto zap_buffer;
2201 } else if (transaction == journal->j_committing_transaction) {
2202 JBUFFER_TRACE(jh, "on committing transaction");
2204 * The buffer is committing, we simply cannot touch
2205 * it. If the page is straddling i_size we have to wait
2206 * for commit and try again.
2208 if (partial_page) {
2209 jbd2_journal_put_journal_head(jh);
2210 spin_unlock(&journal->j_list_lock);
2211 jbd_unlock_bh_state(bh);
2212 write_unlock(&journal->j_state_lock);
2213 return -EBUSY;
2216 * OK, buffer won't be reachable after truncate. We just set
2217 * j_next_transaction to the running transaction (if there is
2218 * one) and mark buffer as freed so that commit code knows it
2219 * should clear dirty bits when it is done with the buffer.
2221 set_buffer_freed(bh);
2222 if (journal->j_running_transaction && buffer_jbddirty(bh))
2223 jh->b_next_transaction = journal->j_running_transaction;
2224 jbd2_journal_put_journal_head(jh);
2225 spin_unlock(&journal->j_list_lock);
2226 jbd_unlock_bh_state(bh);
2227 write_unlock(&journal->j_state_lock);
2228 return 0;
2229 } else {
2230 /* Good, the buffer belongs to the running transaction.
2231 * We are writing our own transaction's data, not any
2232 * previous one's, so it is safe to throw it away
2233 * (remember that we expect the filesystem to have set
2234 * i_size already for this truncate so recovery will not
2235 * expose the disk blocks we are discarding here.) */
2236 J_ASSERT_JH(jh, transaction == journal->j_running_transaction);
2237 JBUFFER_TRACE(jh, "on running transaction");
2238 may_free = __dispose_buffer(jh, transaction);
2241 zap_buffer:
2243 * This is tricky. Although the buffer is truncated, it may be reused
2244 * if blocksize < pagesize and it is attached to the page straddling
2245 * EOF. Since the buffer might have been added to BJ_Forget list of the
2246 * running transaction, journal_get_write_access() won't clear
2247 * b_modified and credit accounting gets confused. So clear b_modified
2248 * here.
2250 jh->b_modified = 0;
2251 jbd2_journal_put_journal_head(jh);
2252 zap_buffer_no_jh:
2253 spin_unlock(&journal->j_list_lock);
2254 jbd_unlock_bh_state(bh);
2255 write_unlock(&journal->j_state_lock);
2256 zap_buffer_unlocked:
2257 clear_buffer_dirty(bh);
2258 J_ASSERT_BH(bh, !buffer_jbddirty(bh));
2259 clear_buffer_mapped(bh);
2260 clear_buffer_req(bh);
2261 clear_buffer_new(bh);
2262 clear_buffer_delay(bh);
2263 clear_buffer_unwritten(bh);
2264 bh->b_bdev = NULL;
2265 return may_free;
2269 * void jbd2_journal_invalidatepage()
2270 * @journal: journal to use for flush...
2271 * @page: page to flush
2272 * @offset: start of the range to invalidate
2273 * @length: length of the range to invalidate
2275 * Reap page buffers containing data after in the specified range in page.
2276 * Can return -EBUSY if buffers are part of the committing transaction and
2277 * the page is straddling i_size. Caller then has to wait for current commit
2278 * and try again.
2280 int jbd2_journal_invalidatepage(journal_t *journal,
2281 struct page *page,
2282 unsigned int offset,
2283 unsigned int length)
2285 struct buffer_head *head, *bh, *next;
2286 unsigned int stop = offset + length;
2287 unsigned int curr_off = 0;
2288 int partial_page = (offset || length < PAGE_SIZE);
2289 int may_free = 1;
2290 int ret = 0;
2292 if (!PageLocked(page))
2293 BUG();
2294 if (!page_has_buffers(page))
2295 return 0;
2297 BUG_ON(stop > PAGE_SIZE || stop < length);
2299 /* We will potentially be playing with lists other than just the
2300 * data lists (especially for journaled data mode), so be
2301 * cautious in our locking. */
2303 head = bh = page_buffers(page);
2304 do {
2305 unsigned int next_off = curr_off + bh->b_size;
2306 next = bh->b_this_page;
2308 if (next_off > stop)
2309 return 0;
2311 if (offset <= curr_off) {
2312 /* This block is wholly outside the truncation point */
2313 lock_buffer(bh);
2314 ret = journal_unmap_buffer(journal, bh, partial_page);
2315 unlock_buffer(bh);
2316 if (ret < 0)
2317 return ret;
2318 may_free &= ret;
2320 curr_off = next_off;
2321 bh = next;
2323 } while (bh != head);
2325 if (!partial_page) {
2326 if (may_free && try_to_free_buffers(page))
2327 J_ASSERT(!page_has_buffers(page));
2329 return 0;
2333 * File a buffer on the given transaction list.
2335 void __jbd2_journal_file_buffer(struct journal_head *jh,
2336 transaction_t *transaction, int jlist)
2338 struct journal_head **list = NULL;
2339 int was_dirty = 0;
2340 struct buffer_head *bh = jh2bh(jh);
2342 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
2343 assert_spin_locked(&transaction->t_journal->j_list_lock);
2345 J_ASSERT_JH(jh, jh->b_jlist < BJ_Types);
2346 J_ASSERT_JH(jh, jh->b_transaction == transaction ||
2347 jh->b_transaction == NULL);
2349 if (jh->b_transaction && jh->b_jlist == jlist)
2350 return;
2352 if (jlist == BJ_Metadata || jlist == BJ_Reserved ||
2353 jlist == BJ_Shadow || jlist == BJ_Forget) {
2355 * For metadata buffers, we track dirty bit in buffer_jbddirty
2356 * instead of buffer_dirty. We should not see a dirty bit set
2357 * here because we clear it in do_get_write_access but e.g.
2358 * tune2fs can modify the sb and set the dirty bit at any time
2359 * so we try to gracefully handle that.
2361 if (buffer_dirty(bh))
2362 warn_dirty_buffer(bh);
2363 if (test_clear_buffer_dirty(bh) ||
2364 test_clear_buffer_jbddirty(bh))
2365 was_dirty = 1;
2368 if (jh->b_transaction)
2369 __jbd2_journal_temp_unlink_buffer(jh);
2370 else
2371 jbd2_journal_grab_journal_head(bh);
2372 jh->b_transaction = transaction;
2374 switch (jlist) {
2375 case BJ_None:
2376 J_ASSERT_JH(jh, !jh->b_committed_data);
2377 J_ASSERT_JH(jh, !jh->b_frozen_data);
2378 return;
2379 case BJ_Metadata:
2380 transaction->t_nr_buffers++;
2381 list = &transaction->t_buffers;
2382 break;
2383 case BJ_Forget:
2384 list = &transaction->t_forget;
2385 break;
2386 case BJ_Shadow:
2387 list = &transaction->t_shadow_list;
2388 break;
2389 case BJ_Reserved:
2390 list = &transaction->t_reserved_list;
2391 break;
2394 __blist_add_buffer(list, jh);
2395 jh->b_jlist = jlist;
2397 if (was_dirty)
2398 set_buffer_jbddirty(bh);
2401 void jbd2_journal_file_buffer(struct journal_head *jh,
2402 transaction_t *transaction, int jlist)
2404 jbd_lock_bh_state(jh2bh(jh));
2405 spin_lock(&transaction->t_journal->j_list_lock);
2406 __jbd2_journal_file_buffer(jh, transaction, jlist);
2407 spin_unlock(&transaction->t_journal->j_list_lock);
2408 jbd_unlock_bh_state(jh2bh(jh));
2412 * Remove a buffer from its current buffer list in preparation for
2413 * dropping it from its current transaction entirely. If the buffer has
2414 * already started to be used by a subsequent transaction, refile the
2415 * buffer on that transaction's metadata list.
2417 * Called under j_list_lock
2418 * Called under jbd_lock_bh_state(jh2bh(jh))
2420 * jh and bh may be already free when this function returns
2422 void __jbd2_journal_refile_buffer(struct journal_head *jh)
2424 int was_dirty, jlist;
2425 struct buffer_head *bh = jh2bh(jh);
2427 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
2428 if (jh->b_transaction)
2429 assert_spin_locked(&jh->b_transaction->t_journal->j_list_lock);
2431 /* If the buffer is now unused, just drop it. */
2432 if (jh->b_next_transaction == NULL) {
2433 __jbd2_journal_unfile_buffer(jh);
2434 return;
2438 * It has been modified by a later transaction: add it to the new
2439 * transaction's metadata list.
2442 was_dirty = test_clear_buffer_jbddirty(bh);
2443 __jbd2_journal_temp_unlink_buffer(jh);
2445 * We set b_transaction here because b_next_transaction will inherit
2446 * our jh reference and thus __jbd2_journal_file_buffer() must not
2447 * take a new one.
2449 jh->b_transaction = jh->b_next_transaction;
2450 jh->b_next_transaction = NULL;
2451 if (buffer_freed(bh))
2452 jlist = BJ_Forget;
2453 else if (jh->b_modified)
2454 jlist = BJ_Metadata;
2455 else
2456 jlist = BJ_Reserved;
2457 __jbd2_journal_file_buffer(jh, jh->b_transaction, jlist);
2458 J_ASSERT_JH(jh, jh->b_transaction->t_state == T_RUNNING);
2460 if (was_dirty)
2461 set_buffer_jbddirty(bh);
2465 * __jbd2_journal_refile_buffer() with necessary locking added. We take our
2466 * bh reference so that we can safely unlock bh.
2468 * The jh and bh may be freed by this call.
2470 void jbd2_journal_refile_buffer(journal_t *journal, struct journal_head *jh)
2472 struct buffer_head *bh = jh2bh(jh);
2474 /* Get reference so that buffer cannot be freed before we unlock it */
2475 get_bh(bh);
2476 jbd_lock_bh_state(bh);
2477 spin_lock(&journal->j_list_lock);
2478 __jbd2_journal_refile_buffer(jh);
2479 jbd_unlock_bh_state(bh);
2480 spin_unlock(&journal->j_list_lock);
2481 __brelse(bh);
2485 * File inode in the inode list of the handle's transaction
2487 static int jbd2_journal_file_inode(handle_t *handle, struct jbd2_inode *jinode,
2488 unsigned long flags)
2490 transaction_t *transaction = handle->h_transaction;
2491 journal_t *journal;
2493 if (is_handle_aborted(handle))
2494 return -EROFS;
2495 journal = transaction->t_journal;
2497 jbd_debug(4, "Adding inode %lu, tid:%d\n", jinode->i_vfs_inode->i_ino,
2498 transaction->t_tid);
2501 * First check whether inode isn't already on the transaction's
2502 * lists without taking the lock. Note that this check is safe
2503 * without the lock as we cannot race with somebody removing inode
2504 * from the transaction. The reason is that we remove inode from the
2505 * transaction only in journal_release_jbd_inode() and when we commit
2506 * the transaction. We are guarded from the first case by holding
2507 * a reference to the inode. We are safe against the second case
2508 * because if jinode->i_transaction == transaction, commit code
2509 * cannot touch the transaction because we hold reference to it,
2510 * and if jinode->i_next_transaction == transaction, commit code
2511 * will only file the inode where we want it.
2513 if ((jinode->i_transaction == transaction ||
2514 jinode->i_next_transaction == transaction) &&
2515 (jinode->i_flags & flags) == flags)
2516 return 0;
2518 spin_lock(&journal->j_list_lock);
2519 jinode->i_flags |= flags;
2520 /* Is inode already attached where we need it? */
2521 if (jinode->i_transaction == transaction ||
2522 jinode->i_next_transaction == transaction)
2523 goto done;
2526 * We only ever set this variable to 1 so the test is safe. Since
2527 * t_need_data_flush is likely to be set, we do the test to save some
2528 * cacheline bouncing
2530 if (!transaction->t_need_data_flush)
2531 transaction->t_need_data_flush = 1;
2532 /* On some different transaction's list - should be
2533 * the committing one */
2534 if (jinode->i_transaction) {
2535 J_ASSERT(jinode->i_next_transaction == NULL);
2536 J_ASSERT(jinode->i_transaction ==
2537 journal->j_committing_transaction);
2538 jinode->i_next_transaction = transaction;
2539 goto done;
2541 /* Not on any transaction list... */
2542 J_ASSERT(!jinode->i_next_transaction);
2543 jinode->i_transaction = transaction;
2544 list_add(&jinode->i_list, &transaction->t_inode_list);
2545 done:
2546 spin_unlock(&journal->j_list_lock);
2548 return 0;
2551 int jbd2_journal_inode_add_write(handle_t *handle, struct jbd2_inode *jinode)
2553 return jbd2_journal_file_inode(handle, jinode,
2554 JI_WRITE_DATA | JI_WAIT_DATA);
2557 int jbd2_journal_inode_add_wait(handle_t *handle, struct jbd2_inode *jinode)
2559 return jbd2_journal_file_inode(handle, jinode, JI_WAIT_DATA);
2563 * File truncate and transaction commit interact with each other in a
2564 * non-trivial way. If a transaction writing data block A is
2565 * committing, we cannot discard the data by truncate until we have
2566 * written them. Otherwise if we crashed after the transaction with
2567 * write has committed but before the transaction with truncate has
2568 * committed, we could see stale data in block A. This function is a
2569 * helper to solve this problem. It starts writeout of the truncated
2570 * part in case it is in the committing transaction.
2572 * Filesystem code must call this function when inode is journaled in
2573 * ordered mode before truncation happens and after the inode has been
2574 * placed on orphan list with the new inode size. The second condition
2575 * avoids the race that someone writes new data and we start
2576 * committing the transaction after this function has been called but
2577 * before a transaction for truncate is started (and furthermore it
2578 * allows us to optimize the case where the addition to orphan list
2579 * happens in the same transaction as write --- we don't have to write
2580 * any data in such case).
2582 int jbd2_journal_begin_ordered_truncate(journal_t *journal,
2583 struct jbd2_inode *jinode,
2584 loff_t new_size)
2586 transaction_t *inode_trans, *commit_trans;
2587 int ret = 0;
2589 /* This is a quick check to avoid locking if not necessary */
2590 if (!jinode->i_transaction)
2591 goto out;
2592 /* Locks are here just to force reading of recent values, it is
2593 * enough that the transaction was not committing before we started
2594 * a transaction adding the inode to orphan list */
2595 read_lock(&journal->j_state_lock);
2596 commit_trans = journal->j_committing_transaction;
2597 read_unlock(&journal->j_state_lock);
2598 spin_lock(&journal->j_list_lock);
2599 inode_trans = jinode->i_transaction;
2600 spin_unlock(&journal->j_list_lock);
2601 if (inode_trans == commit_trans) {
2602 ret = filemap_fdatawrite_range(jinode->i_vfs_inode->i_mapping,
2603 new_size, LLONG_MAX);
2604 if (ret)
2605 jbd2_journal_abort(journal, ret);
2607 out:
2608 return ret;