Revert "ASoC: meson: axg-card: fix codec-to-codec link setup"
[linux/fpc-iii.git] / fs / jbd2 / transaction.c
blobde992a70ddfefb43b6557df8394d5d36ebde156d
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 pr_emerg("JBD2: failed to create transaction cache\n");
47 return -ENOMEM;
49 return 0;
52 void jbd2_journal_destroy_transaction_cache(void)
54 kmem_cache_destroy(transaction_cache);
55 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 initialise a new transaction. Initialize 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 void jbd2_get_transaction(journal_t *journal,
81 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;
108 * Handle management.
110 * A handle_t is an object which represents a single atomic update to a
111 * filesystem, and which tracks all of the modifications which form part
112 * of that one update.
116 * Update transaction's maximum wait time, if debugging is enabled.
118 * In order for t_max_wait to be reliable, it must be protected by a
119 * lock. But doing so will mean that start_this_handle() can not be
120 * run in parallel on SMP systems, which limits our scalability. So
121 * unless debugging is enabled, we no longer update t_max_wait, which
122 * means that maximum wait time reported by the jbd2_run_stats
123 * tracepoint will always be zero.
125 static inline void update_t_max_wait(transaction_t *transaction,
126 unsigned long ts)
128 #ifdef CONFIG_JBD2_DEBUG
129 if (jbd2_journal_enable_debug &&
130 time_after(transaction->t_start, ts)) {
131 ts = jbd2_time_diff(ts, transaction->t_start);
132 spin_lock(&transaction->t_handle_lock);
133 if (ts > transaction->t_max_wait)
134 transaction->t_max_wait = ts;
135 spin_unlock(&transaction->t_handle_lock);
137 #endif
141 * Wait until running transaction passes to T_FLUSH state and new transaction
142 * can thus be started. Also starts the commit if needed. The function expects
143 * running transaction to exist and releases j_state_lock.
145 static void wait_transaction_locked(journal_t *journal)
146 __releases(journal->j_state_lock)
148 DEFINE_WAIT(wait);
149 int need_to_start;
150 tid_t tid = journal->j_running_transaction->t_tid;
152 prepare_to_wait(&journal->j_wait_transaction_locked, &wait,
153 TASK_UNINTERRUPTIBLE);
154 need_to_start = !tid_geq(journal->j_commit_request, tid);
155 read_unlock(&journal->j_state_lock);
156 if (need_to_start)
157 jbd2_log_start_commit(journal, tid);
158 jbd2_might_wait_for_commit(journal);
159 schedule();
160 finish_wait(&journal->j_wait_transaction_locked, &wait);
164 * Wait until running transaction transitions from T_SWITCH to T_FLUSH
165 * state and new transaction can thus be started. The function releases
166 * j_state_lock.
168 static void wait_transaction_switching(journal_t *journal)
169 __releases(journal->j_state_lock)
171 DEFINE_WAIT(wait);
173 if (WARN_ON(!journal->j_running_transaction ||
174 journal->j_running_transaction->t_state != T_SWITCH))
175 return;
176 prepare_to_wait(&journal->j_wait_transaction_locked, &wait,
177 TASK_UNINTERRUPTIBLE);
178 read_unlock(&journal->j_state_lock);
180 * We don't call jbd2_might_wait_for_commit() here as there's no
181 * waiting for outstanding handles happening anymore in T_SWITCH state
182 * and handling of reserved handles actually relies on that for
183 * correctness.
185 schedule();
186 finish_wait(&journal->j_wait_transaction_locked, &wait);
189 static void sub_reserved_credits(journal_t *journal, int blocks)
191 atomic_sub(blocks, &journal->j_reserved_credits);
192 wake_up(&journal->j_wait_reserved);
196 * Wait until we can add credits for handle to the running transaction. Called
197 * with j_state_lock held for reading. Returns 0 if handle joined the running
198 * transaction. Returns 1 if we had to wait, j_state_lock is dropped, and
199 * caller must retry.
201 static int add_transaction_credits(journal_t *journal, int blocks,
202 int rsv_blocks)
204 transaction_t *t = journal->j_running_transaction;
205 int needed;
206 int total = blocks + rsv_blocks;
209 * If the current transaction is locked down for commit, wait
210 * for the lock to be released.
212 if (t->t_state != T_RUNNING) {
213 WARN_ON_ONCE(t->t_state >= T_FLUSH);
214 wait_transaction_locked(journal);
215 return 1;
219 * If there is not enough space left in the log to write all
220 * potential buffers requested by this operation, we need to
221 * stall pending a log checkpoint to free some more log space.
223 needed = atomic_add_return(total, &t->t_outstanding_credits);
224 if (needed > journal->j_max_transaction_buffers) {
226 * If the current transaction is already too large,
227 * then start to commit it: we can then go back and
228 * attach this handle to a new transaction.
230 atomic_sub(total, &t->t_outstanding_credits);
233 * Is the number of reserved credits in the current transaction too
234 * big to fit this handle? Wait until reserved credits are freed.
236 if (atomic_read(&journal->j_reserved_credits) + total >
237 journal->j_max_transaction_buffers) {
238 read_unlock(&journal->j_state_lock);
239 jbd2_might_wait_for_commit(journal);
240 wait_event(journal->j_wait_reserved,
241 atomic_read(&journal->j_reserved_credits) + total <=
242 journal->j_max_transaction_buffers);
243 return 1;
246 wait_transaction_locked(journal);
247 return 1;
251 * The commit code assumes that it can get enough log space
252 * without forcing a checkpoint. This is *critical* for
253 * correctness: a checkpoint of a buffer which is also
254 * associated with a committing transaction creates a deadlock,
255 * so commit simply cannot force through checkpoints.
257 * We must therefore ensure the necessary space in the journal
258 * *before* starting to dirty potentially checkpointed buffers
259 * in the new transaction.
261 if (jbd2_log_space_left(journal) < jbd2_space_needed(journal)) {
262 atomic_sub(total, &t->t_outstanding_credits);
263 read_unlock(&journal->j_state_lock);
264 jbd2_might_wait_for_commit(journal);
265 write_lock(&journal->j_state_lock);
266 if (jbd2_log_space_left(journal) < jbd2_space_needed(journal))
267 __jbd2_log_wait_for_space(journal);
268 write_unlock(&journal->j_state_lock);
269 return 1;
272 /* No reservation? We are done... */
273 if (!rsv_blocks)
274 return 0;
276 needed = atomic_add_return(rsv_blocks, &journal->j_reserved_credits);
277 /* We allow at most half of a transaction to be reserved */
278 if (needed > journal->j_max_transaction_buffers / 2) {
279 sub_reserved_credits(journal, rsv_blocks);
280 atomic_sub(total, &t->t_outstanding_credits);
281 read_unlock(&journal->j_state_lock);
282 jbd2_might_wait_for_commit(journal);
283 wait_event(journal->j_wait_reserved,
284 atomic_read(&journal->j_reserved_credits) + rsv_blocks
285 <= journal->j_max_transaction_buffers / 2);
286 return 1;
288 return 0;
292 * start_this_handle: Given a handle, deal with any locking or stalling
293 * needed to make sure that there is enough journal space for the handle
294 * to begin. Attach the handle to a transaction and set up the
295 * transaction's buffer credits.
298 static int start_this_handle(journal_t *journal, handle_t *handle,
299 gfp_t gfp_mask)
301 transaction_t *transaction, *new_transaction = NULL;
302 int blocks = handle->h_buffer_credits;
303 int rsv_blocks = 0;
304 unsigned long ts = jiffies;
306 if (handle->h_rsv_handle)
307 rsv_blocks = handle->h_rsv_handle->h_buffer_credits;
310 * Limit the number of reserved credits to 1/2 of maximum transaction
311 * size and limit the number of total credits to not exceed maximum
312 * transaction size per operation.
314 if ((rsv_blocks > journal->j_max_transaction_buffers / 2) ||
315 (rsv_blocks + blocks > journal->j_max_transaction_buffers)) {
316 printk(KERN_ERR "JBD2: %s wants too many credits "
317 "credits:%d rsv_credits:%d max:%d\n",
318 current->comm, blocks, rsv_blocks,
319 journal->j_max_transaction_buffers);
320 WARN_ON(1);
321 return -ENOSPC;
324 alloc_transaction:
325 if (!journal->j_running_transaction) {
327 * If __GFP_FS is not present, then we may be being called from
328 * inside the fs writeback layer, so we MUST NOT fail.
330 if ((gfp_mask & __GFP_FS) == 0)
331 gfp_mask |= __GFP_NOFAIL;
332 new_transaction = kmem_cache_zalloc(transaction_cache,
333 gfp_mask);
334 if (!new_transaction)
335 return -ENOMEM;
338 jbd_debug(3, "New handle %p going live.\n", handle);
341 * We need to hold j_state_lock until t_updates has been incremented,
342 * for proper journal barrier handling
344 repeat:
345 read_lock(&journal->j_state_lock);
346 BUG_ON(journal->j_flags & JBD2_UNMOUNT);
347 if (is_journal_aborted(journal) ||
348 (journal->j_errno != 0 && !(journal->j_flags & JBD2_ACK_ERR))) {
349 read_unlock(&journal->j_state_lock);
350 jbd2_journal_free_transaction(new_transaction);
351 return -EROFS;
355 * Wait on the journal's transaction barrier if necessary. Specifically
356 * we allow reserved handles to proceed because otherwise commit could
357 * deadlock on page writeback not being able to complete.
359 if (!handle->h_reserved && journal->j_barrier_count) {
360 read_unlock(&journal->j_state_lock);
361 wait_event(journal->j_wait_transaction_locked,
362 journal->j_barrier_count == 0);
363 goto repeat;
366 if (!journal->j_running_transaction) {
367 read_unlock(&journal->j_state_lock);
368 if (!new_transaction)
369 goto alloc_transaction;
370 write_lock(&journal->j_state_lock);
371 if (!journal->j_running_transaction &&
372 (handle->h_reserved || !journal->j_barrier_count)) {
373 jbd2_get_transaction(journal, new_transaction);
374 new_transaction = NULL;
376 write_unlock(&journal->j_state_lock);
377 goto repeat;
380 transaction = journal->j_running_transaction;
382 if (!handle->h_reserved) {
383 /* We may have dropped j_state_lock - restart in that case */
384 if (add_transaction_credits(journal, blocks, rsv_blocks))
385 goto repeat;
386 } else {
388 * We have handle reserved so we are allowed to join T_LOCKED
389 * transaction and we don't have to check for transaction size
390 * and journal space. But we still have to wait while running
391 * transaction is being switched to a committing one as it
392 * won't wait for any handles anymore.
394 if (transaction->t_state == T_SWITCH) {
395 wait_transaction_switching(journal);
396 goto repeat;
398 sub_reserved_credits(journal, blocks);
399 handle->h_reserved = 0;
402 /* OK, account for the buffers that this operation expects to
403 * use and add the handle to the running transaction.
405 update_t_max_wait(transaction, ts);
406 handle->h_transaction = transaction;
407 handle->h_requested_credits = blocks;
408 handle->h_start_jiffies = jiffies;
409 atomic_inc(&transaction->t_updates);
410 atomic_inc(&transaction->t_handle_count);
411 jbd_debug(4, "Handle %p given %d credits (total %d, free %lu)\n",
412 handle, blocks,
413 atomic_read(&transaction->t_outstanding_credits),
414 jbd2_log_space_left(journal));
415 read_unlock(&journal->j_state_lock);
416 current->journal_info = handle;
418 rwsem_acquire_read(&journal->j_trans_commit_map, 0, 0, _THIS_IP_);
419 jbd2_journal_free_transaction(new_transaction);
421 * Ensure that no allocations done while the transaction is open are
422 * going to recurse back to the fs layer.
424 handle->saved_alloc_context = memalloc_nofs_save();
425 return 0;
428 /* Allocate a new handle. This should probably be in a slab... */
429 static handle_t *new_handle(int nblocks)
431 handle_t *handle = jbd2_alloc_handle(GFP_NOFS);
432 if (!handle)
433 return NULL;
434 handle->h_buffer_credits = nblocks;
435 handle->h_ref = 1;
437 return handle;
440 handle_t *jbd2__journal_start(journal_t *journal, int nblocks, int rsv_blocks,
441 gfp_t gfp_mask, unsigned int type,
442 unsigned int line_no)
444 handle_t *handle = journal_current_handle();
445 int err;
447 if (!journal)
448 return ERR_PTR(-EROFS);
450 if (handle) {
451 J_ASSERT(handle->h_transaction->t_journal == journal);
452 handle->h_ref++;
453 return handle;
456 handle = new_handle(nblocks);
457 if (!handle)
458 return ERR_PTR(-ENOMEM);
459 if (rsv_blocks) {
460 handle_t *rsv_handle;
462 rsv_handle = new_handle(rsv_blocks);
463 if (!rsv_handle) {
464 jbd2_free_handle(handle);
465 return ERR_PTR(-ENOMEM);
467 rsv_handle->h_reserved = 1;
468 rsv_handle->h_journal = journal;
469 handle->h_rsv_handle = rsv_handle;
472 err = start_this_handle(journal, handle, gfp_mask);
473 if (err < 0) {
474 if (handle->h_rsv_handle)
475 jbd2_free_handle(handle->h_rsv_handle);
476 jbd2_free_handle(handle);
477 return ERR_PTR(err);
479 handle->h_type = type;
480 handle->h_line_no = line_no;
481 trace_jbd2_handle_start(journal->j_fs_dev->bd_dev,
482 handle->h_transaction->t_tid, type,
483 line_no, nblocks);
485 return handle;
487 EXPORT_SYMBOL(jbd2__journal_start);
491 * handle_t *jbd2_journal_start() - Obtain a new handle.
492 * @journal: Journal to start transaction on.
493 * @nblocks: number of block buffer we might modify
495 * We make sure that the transaction can guarantee at least nblocks of
496 * modified buffers in the log. We block until the log can guarantee
497 * that much space. Additionally, if rsv_blocks > 0, we also create another
498 * handle with rsv_blocks reserved blocks in the journal. This handle is
499 * is stored in h_rsv_handle. It is not attached to any particular transaction
500 * and thus doesn't block transaction commit. If the caller uses this reserved
501 * handle, it has to set h_rsv_handle to NULL as otherwise jbd2_journal_stop()
502 * on the parent handle will dispose the reserved one. Reserved handle has to
503 * be converted to a normal handle using jbd2_journal_start_reserved() before
504 * it can be used.
506 * Return a pointer to a newly allocated handle, or an ERR_PTR() value
507 * on failure.
509 handle_t *jbd2_journal_start(journal_t *journal, int nblocks)
511 return jbd2__journal_start(journal, nblocks, 0, GFP_NOFS, 0, 0);
513 EXPORT_SYMBOL(jbd2_journal_start);
515 void jbd2_journal_free_reserved(handle_t *handle)
517 journal_t *journal = handle->h_journal;
519 WARN_ON(!handle->h_reserved);
520 sub_reserved_credits(journal, handle->h_buffer_credits);
521 jbd2_free_handle(handle);
523 EXPORT_SYMBOL(jbd2_journal_free_reserved);
526 * int jbd2_journal_start_reserved() - start reserved handle
527 * @handle: handle to start
528 * @type: for handle statistics
529 * @line_no: for handle statistics
531 * Start handle that has been previously reserved with jbd2_journal_reserve().
532 * This attaches @handle to the running transaction (or creates one if there's
533 * not transaction running). Unlike jbd2_journal_start() this function cannot
534 * block on journal commit, checkpointing, or similar stuff. It can block on
535 * memory allocation or frozen journal though.
537 * Return 0 on success, non-zero on error - handle is freed in that case.
539 int jbd2_journal_start_reserved(handle_t *handle, unsigned int type,
540 unsigned int line_no)
542 journal_t *journal = handle->h_journal;
543 int ret = -EIO;
545 if (WARN_ON(!handle->h_reserved)) {
546 /* Someone passed in normal handle? Just stop it. */
547 jbd2_journal_stop(handle);
548 return ret;
551 * Usefulness of mixing of reserved and unreserved handles is
552 * questionable. So far nobody seems to need it so just error out.
554 if (WARN_ON(current->journal_info)) {
555 jbd2_journal_free_reserved(handle);
556 return ret;
559 handle->h_journal = NULL;
561 * GFP_NOFS is here because callers are likely from writeback or
562 * similarly constrained call sites
564 ret = start_this_handle(journal, handle, GFP_NOFS);
565 if (ret < 0) {
566 handle->h_journal = journal;
567 jbd2_journal_free_reserved(handle);
568 return ret;
570 handle->h_type = type;
571 handle->h_line_no = line_no;
572 trace_jbd2_handle_start(journal->j_fs_dev->bd_dev,
573 handle->h_transaction->t_tid, type,
574 line_no, handle->h_buffer_credits);
575 return 0;
577 EXPORT_SYMBOL(jbd2_journal_start_reserved);
580 * int jbd2_journal_extend() - extend buffer credits.
581 * @handle: handle to 'extend'
582 * @nblocks: nr blocks to try to extend by.
584 * Some transactions, such as large extends and truncates, can be done
585 * atomically all at once or in several stages. The operation requests
586 * a credit for a number of buffer modifications in advance, but can
587 * extend its credit if it needs more.
589 * jbd2_journal_extend tries to give the running handle more buffer credits.
590 * It does not guarantee that allocation - this is a best-effort only.
591 * The calling process MUST be able to deal cleanly with a failure to
592 * extend here.
594 * Return 0 on success, non-zero on failure.
596 * return code < 0 implies an error
597 * return code > 0 implies normal transaction-full status.
599 int jbd2_journal_extend(handle_t *handle, int nblocks)
601 transaction_t *transaction = handle->h_transaction;
602 journal_t *journal;
603 int result;
604 int wanted;
606 if (is_handle_aborted(handle))
607 return -EROFS;
608 journal = transaction->t_journal;
610 result = 1;
612 read_lock(&journal->j_state_lock);
614 /* Don't extend a locked-down transaction! */
615 if (transaction->t_state != T_RUNNING) {
616 jbd_debug(3, "denied handle %p %d blocks: "
617 "transaction not running\n", handle, nblocks);
618 goto error_out;
621 spin_lock(&transaction->t_handle_lock);
622 wanted = atomic_add_return(nblocks,
623 &transaction->t_outstanding_credits);
625 if (wanted > journal->j_max_transaction_buffers) {
626 jbd_debug(3, "denied handle %p %d blocks: "
627 "transaction too large\n", handle, nblocks);
628 atomic_sub(nblocks, &transaction->t_outstanding_credits);
629 goto unlock;
632 if (wanted + (wanted >> JBD2_CONTROL_BLOCKS_SHIFT) >
633 jbd2_log_space_left(journal)) {
634 jbd_debug(3, "denied handle %p %d blocks: "
635 "insufficient log space\n", handle, nblocks);
636 atomic_sub(nblocks, &transaction->t_outstanding_credits);
637 goto unlock;
640 trace_jbd2_handle_extend(journal->j_fs_dev->bd_dev,
641 transaction->t_tid,
642 handle->h_type, handle->h_line_no,
643 handle->h_buffer_credits,
644 nblocks);
646 handle->h_buffer_credits += nblocks;
647 handle->h_requested_credits += nblocks;
648 result = 0;
650 jbd_debug(3, "extended handle %p by %d\n", handle, nblocks);
651 unlock:
652 spin_unlock(&transaction->t_handle_lock);
653 error_out:
654 read_unlock(&journal->j_state_lock);
655 return result;
660 * int jbd2_journal_restart() - restart a handle .
661 * @handle: handle to restart
662 * @nblocks: nr credits requested
663 * @gfp_mask: memory allocation flags (for start_this_handle)
665 * Restart a handle for a multi-transaction filesystem
666 * operation.
668 * If the jbd2_journal_extend() call above fails to grant new buffer credits
669 * to a running handle, a call to jbd2_journal_restart will commit the
670 * handle's transaction so far and reattach the handle to a new
671 * transaction capable of guaranteeing the requested number of
672 * credits. We preserve reserved handle if there's any attached to the
673 * passed in handle.
675 int jbd2__journal_restart(handle_t *handle, int nblocks, gfp_t gfp_mask)
677 transaction_t *transaction = handle->h_transaction;
678 journal_t *journal;
679 tid_t tid;
680 int need_to_start, ret;
682 /* If we've had an abort of any type, don't even think about
683 * actually doing the restart! */
684 if (is_handle_aborted(handle))
685 return 0;
686 journal = transaction->t_journal;
689 * First unlink the handle from its current transaction, and start the
690 * commit on that.
692 J_ASSERT(atomic_read(&transaction->t_updates) > 0);
693 J_ASSERT(journal_current_handle() == handle);
695 read_lock(&journal->j_state_lock);
696 spin_lock(&transaction->t_handle_lock);
697 atomic_sub(handle->h_buffer_credits,
698 &transaction->t_outstanding_credits);
699 if (handle->h_rsv_handle) {
700 sub_reserved_credits(journal,
701 handle->h_rsv_handle->h_buffer_credits);
703 if (atomic_dec_and_test(&transaction->t_updates))
704 wake_up(&journal->j_wait_updates);
705 tid = transaction->t_tid;
706 spin_unlock(&transaction->t_handle_lock);
707 handle->h_transaction = NULL;
708 current->journal_info = NULL;
710 jbd_debug(2, "restarting handle %p\n", handle);
711 need_to_start = !tid_geq(journal->j_commit_request, tid);
712 read_unlock(&journal->j_state_lock);
713 if (need_to_start)
714 jbd2_log_start_commit(journal, tid);
716 rwsem_release(&journal->j_trans_commit_map, 1, _THIS_IP_);
717 handle->h_buffer_credits = nblocks;
719 * Restore the original nofs context because the journal restart
720 * is basically the same thing as journal stop and start.
721 * start_this_handle will start a new nofs context.
723 memalloc_nofs_restore(handle->saved_alloc_context);
724 ret = start_this_handle(journal, handle, gfp_mask);
725 return ret;
727 EXPORT_SYMBOL(jbd2__journal_restart);
730 int jbd2_journal_restart(handle_t *handle, int nblocks)
732 return jbd2__journal_restart(handle, nblocks, GFP_NOFS);
734 EXPORT_SYMBOL(jbd2_journal_restart);
737 * void jbd2_journal_lock_updates () - establish a transaction barrier.
738 * @journal: Journal to establish a barrier on.
740 * This locks out any further updates from being started, and blocks
741 * until all existing updates have completed, returning only once the
742 * journal is in a quiescent state with no updates running.
744 * The journal lock should not be held on entry.
746 void jbd2_journal_lock_updates(journal_t *journal)
748 DEFINE_WAIT(wait);
750 jbd2_might_wait_for_commit(journal);
752 write_lock(&journal->j_state_lock);
753 ++journal->j_barrier_count;
755 /* Wait until there are no reserved handles */
756 if (atomic_read(&journal->j_reserved_credits)) {
757 write_unlock(&journal->j_state_lock);
758 wait_event(journal->j_wait_reserved,
759 atomic_read(&journal->j_reserved_credits) == 0);
760 write_lock(&journal->j_state_lock);
763 /* Wait until there are no running updates */
764 while (1) {
765 transaction_t *transaction = journal->j_running_transaction;
767 if (!transaction)
768 break;
770 spin_lock(&transaction->t_handle_lock);
771 prepare_to_wait(&journal->j_wait_updates, &wait,
772 TASK_UNINTERRUPTIBLE);
773 if (!atomic_read(&transaction->t_updates)) {
774 spin_unlock(&transaction->t_handle_lock);
775 finish_wait(&journal->j_wait_updates, &wait);
776 break;
778 spin_unlock(&transaction->t_handle_lock);
779 write_unlock(&journal->j_state_lock);
780 schedule();
781 finish_wait(&journal->j_wait_updates, &wait);
782 write_lock(&journal->j_state_lock);
784 write_unlock(&journal->j_state_lock);
787 * We have now established a barrier against other normal updates, but
788 * we also need to barrier against other jbd2_journal_lock_updates() calls
789 * to make sure that we serialise special journal-locked operations
790 * too.
792 mutex_lock(&journal->j_barrier);
796 * void jbd2_journal_unlock_updates (journal_t* journal) - release barrier
797 * @journal: Journal to release the barrier on.
799 * Release a transaction barrier obtained with jbd2_journal_lock_updates().
801 * Should be called without the journal lock held.
803 void jbd2_journal_unlock_updates (journal_t *journal)
805 J_ASSERT(journal->j_barrier_count != 0);
807 mutex_unlock(&journal->j_barrier);
808 write_lock(&journal->j_state_lock);
809 --journal->j_barrier_count;
810 write_unlock(&journal->j_state_lock);
811 wake_up(&journal->j_wait_transaction_locked);
814 static void warn_dirty_buffer(struct buffer_head *bh)
816 printk(KERN_WARNING
817 "JBD2: Spotted dirty metadata buffer (dev = %pg, blocknr = %llu). "
818 "There's a risk of filesystem corruption in case of system "
819 "crash.\n",
820 bh->b_bdev, (unsigned long long)bh->b_blocknr);
823 /* Call t_frozen trigger and copy buffer data into jh->b_frozen_data. */
824 static void jbd2_freeze_jh_data(struct journal_head *jh)
826 struct page *page;
827 int offset;
828 char *source;
829 struct buffer_head *bh = jh2bh(jh);
831 J_EXPECT_JH(jh, buffer_uptodate(bh), "Possible IO failure.\n");
832 page = bh->b_page;
833 offset = offset_in_page(bh->b_data);
834 source = kmap_atomic(page);
835 /* Fire data frozen trigger just before we copy the data */
836 jbd2_buffer_frozen_trigger(jh, source + offset, jh->b_triggers);
837 memcpy(jh->b_frozen_data, source + offset, bh->b_size);
838 kunmap_atomic(source);
841 * Now that the frozen data is saved off, we need to store any matching
842 * triggers.
844 jh->b_frozen_triggers = jh->b_triggers;
848 * If the buffer is already part of the current transaction, then there
849 * is nothing we need to do. If it is already part of a prior
850 * transaction which we are still committing to disk, then we need to
851 * make sure that we do not overwrite the old copy: we do copy-out to
852 * preserve the copy going to disk. We also account the buffer against
853 * the handle's metadata buffer credits (unless the buffer is already
854 * part of the transaction, that is).
857 static int
858 do_get_write_access(handle_t *handle, struct journal_head *jh,
859 int force_copy)
861 struct buffer_head *bh;
862 transaction_t *transaction = handle->h_transaction;
863 journal_t *journal;
864 int error;
865 char *frozen_buffer = NULL;
866 unsigned long start_lock, time_lock;
868 journal = transaction->t_journal;
870 jbd_debug(5, "journal_head %p, force_copy %d\n", jh, force_copy);
872 JBUFFER_TRACE(jh, "entry");
873 repeat:
874 bh = jh2bh(jh);
876 /* @@@ Need to check for errors here at some point. */
878 start_lock = jiffies;
879 lock_buffer(bh);
880 jbd_lock_bh_state(bh);
882 /* If it takes too long to lock the buffer, trace it */
883 time_lock = jbd2_time_diff(start_lock, jiffies);
884 if (time_lock > HZ/10)
885 trace_jbd2_lock_buffer_stall(bh->b_bdev->bd_dev,
886 jiffies_to_msecs(time_lock));
888 /* We now hold the buffer lock so it is safe to query the buffer
889 * state. Is the buffer dirty?
891 * If so, there are two possibilities. The buffer may be
892 * non-journaled, and undergoing a quite legitimate writeback.
893 * Otherwise, it is journaled, and we don't expect dirty buffers
894 * in that state (the buffers should be marked JBD_Dirty
895 * instead.) So either the IO is being done under our own
896 * control and this is a bug, or it's a third party IO such as
897 * dump(8) (which may leave the buffer scheduled for read ---
898 * ie. locked but not dirty) or tune2fs (which may actually have
899 * the buffer dirtied, ugh.) */
901 if (buffer_dirty(bh)) {
903 * First question: is this buffer already part of the current
904 * transaction or the existing committing transaction?
906 if (jh->b_transaction) {
907 J_ASSERT_JH(jh,
908 jh->b_transaction == transaction ||
909 jh->b_transaction ==
910 journal->j_committing_transaction);
911 if (jh->b_next_transaction)
912 J_ASSERT_JH(jh, jh->b_next_transaction ==
913 transaction);
914 warn_dirty_buffer(bh);
917 * In any case we need to clean the dirty flag and we must
918 * do it under the buffer lock to be sure we don't race
919 * with running write-out.
921 JBUFFER_TRACE(jh, "Journalling dirty buffer");
922 clear_buffer_dirty(bh);
923 set_buffer_jbddirty(bh);
926 unlock_buffer(bh);
928 error = -EROFS;
929 if (is_handle_aborted(handle)) {
930 jbd_unlock_bh_state(bh);
931 goto out;
933 error = 0;
936 * The buffer is already part of this transaction if b_transaction or
937 * b_next_transaction points to it
939 if (jh->b_transaction == transaction ||
940 jh->b_next_transaction == transaction)
941 goto done;
944 * this is the first time this transaction is touching this buffer,
945 * reset the modified flag
947 jh->b_modified = 0;
950 * If the buffer is not journaled right now, we need to make sure it
951 * doesn't get written to disk before the caller actually commits the
952 * new data
954 if (!jh->b_transaction) {
955 JBUFFER_TRACE(jh, "no transaction");
956 J_ASSERT_JH(jh, !jh->b_next_transaction);
957 JBUFFER_TRACE(jh, "file as BJ_Reserved");
959 * Make sure all stores to jh (b_modified, b_frozen_data) are
960 * visible before attaching it to the running transaction.
961 * Paired with barrier in jbd2_write_access_granted()
963 smp_wmb();
964 spin_lock(&journal->j_list_lock);
965 __jbd2_journal_file_buffer(jh, transaction, BJ_Reserved);
966 spin_unlock(&journal->j_list_lock);
967 goto done;
970 * If there is already a copy-out version of this buffer, then we don't
971 * need to make another one
973 if (jh->b_frozen_data) {
974 JBUFFER_TRACE(jh, "has frozen data");
975 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
976 goto attach_next;
979 JBUFFER_TRACE(jh, "owned by older transaction");
980 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
981 J_ASSERT_JH(jh, jh->b_transaction == journal->j_committing_transaction);
984 * There is one case we have to be very careful about. If the
985 * committing transaction is currently writing this buffer out to disk
986 * and has NOT made a copy-out, then we cannot modify the buffer
987 * contents at all right now. The essence of copy-out is that it is
988 * the extra copy, not the primary copy, which gets journaled. If the
989 * primary copy is already going to disk then we cannot do copy-out
990 * here.
992 if (buffer_shadow(bh)) {
993 JBUFFER_TRACE(jh, "on shadow: sleep");
994 jbd_unlock_bh_state(bh);
995 wait_on_bit_io(&bh->b_state, BH_Shadow, TASK_UNINTERRUPTIBLE);
996 goto repeat;
1000 * Only do the copy if the currently-owning transaction still needs it.
1001 * If buffer isn't on BJ_Metadata list, the committing transaction is
1002 * past that stage (here we use the fact that BH_Shadow is set under
1003 * bh_state lock together with refiling to BJ_Shadow list and at this
1004 * point we know the buffer doesn't have BH_Shadow set).
1006 * Subtle point, though: if this is a get_undo_access, then we will be
1007 * relying on the frozen_data to contain the new value of the
1008 * committed_data record after the transaction, so we HAVE to force the
1009 * frozen_data copy in that case.
1011 if (jh->b_jlist == BJ_Metadata || force_copy) {
1012 JBUFFER_TRACE(jh, "generate frozen data");
1013 if (!frozen_buffer) {
1014 JBUFFER_TRACE(jh, "allocate memory for buffer");
1015 jbd_unlock_bh_state(bh);
1016 frozen_buffer = jbd2_alloc(jh2bh(jh)->b_size,
1017 GFP_NOFS | __GFP_NOFAIL);
1018 goto repeat;
1020 jh->b_frozen_data = frozen_buffer;
1021 frozen_buffer = NULL;
1022 jbd2_freeze_jh_data(jh);
1024 attach_next:
1026 * Make sure all stores to jh (b_modified, b_frozen_data) are visible
1027 * before attaching it to the running transaction. Paired with barrier
1028 * in jbd2_write_access_granted()
1030 smp_wmb();
1031 jh->b_next_transaction = transaction;
1033 done:
1034 jbd_unlock_bh_state(bh);
1037 * If we are about to journal a buffer, then any revoke pending on it is
1038 * no longer valid
1040 jbd2_journal_cancel_revoke(handle, jh);
1042 out:
1043 if (unlikely(frozen_buffer)) /* It's usually NULL */
1044 jbd2_free(frozen_buffer, bh->b_size);
1046 JBUFFER_TRACE(jh, "exit");
1047 return error;
1050 /* Fast check whether buffer is already attached to the required transaction */
1051 static bool jbd2_write_access_granted(handle_t *handle, struct buffer_head *bh,
1052 bool undo)
1054 struct journal_head *jh;
1055 bool ret = false;
1057 /* Dirty buffers require special handling... */
1058 if (buffer_dirty(bh))
1059 return false;
1062 * RCU protects us from dereferencing freed pages. So the checks we do
1063 * are guaranteed not to oops. However the jh slab object can get freed
1064 * & reallocated while we work with it. So we have to be careful. When
1065 * we see jh attached to the running transaction, we know it must stay
1066 * so until the transaction is committed. Thus jh won't be freed and
1067 * will be attached to the same bh while we run. However it can
1068 * happen jh gets freed, reallocated, and attached to the transaction
1069 * just after we get pointer to it from bh. So we have to be careful
1070 * and recheck jh still belongs to our bh before we return success.
1072 rcu_read_lock();
1073 if (!buffer_jbd(bh))
1074 goto out;
1075 /* This should be bh2jh() but that doesn't work with inline functions */
1076 jh = READ_ONCE(bh->b_private);
1077 if (!jh)
1078 goto out;
1079 /* For undo access buffer must have data copied */
1080 if (undo && !jh->b_committed_data)
1081 goto out;
1082 if (READ_ONCE(jh->b_transaction) != handle->h_transaction &&
1083 READ_ONCE(jh->b_next_transaction) != handle->h_transaction)
1084 goto out;
1086 * There are two reasons for the barrier here:
1087 * 1) Make sure to fetch b_bh after we did previous checks so that we
1088 * detect when jh went through free, realloc, attach to transaction
1089 * while we were checking. Paired with implicit barrier in that path.
1090 * 2) So that access to bh done after jbd2_write_access_granted()
1091 * doesn't get reordered and see inconsistent state of concurrent
1092 * do_get_write_access().
1094 smp_mb();
1095 if (unlikely(jh->b_bh != bh))
1096 goto out;
1097 ret = true;
1098 out:
1099 rcu_read_unlock();
1100 return ret;
1104 * int jbd2_journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update.
1105 * @handle: transaction to add buffer modifications to
1106 * @bh: bh to be used for metadata writes
1108 * Returns: error code or 0 on success.
1110 * In full data journalling mode the buffer may be of type BJ_AsyncData,
1111 * because we're ``write()ing`` a buffer which is also part of a shared mapping.
1114 int jbd2_journal_get_write_access(handle_t *handle, struct buffer_head *bh)
1116 struct journal_head *jh;
1117 int rc;
1119 if (is_handle_aborted(handle))
1120 return -EROFS;
1122 if (jbd2_write_access_granted(handle, bh, false))
1123 return 0;
1125 jh = jbd2_journal_add_journal_head(bh);
1126 /* We do not want to get caught playing with fields which the
1127 * log thread also manipulates. Make sure that the buffer
1128 * completes any outstanding IO before proceeding. */
1129 rc = do_get_write_access(handle, jh, 0);
1130 jbd2_journal_put_journal_head(jh);
1131 return rc;
1136 * When the user wants to journal a newly created buffer_head
1137 * (ie. getblk() returned a new buffer and we are going to populate it
1138 * manually rather than reading off disk), then we need to keep the
1139 * buffer_head locked until it has been completely filled with new
1140 * data. In this case, we should be able to make the assertion that
1141 * the bh is not already part of an existing transaction.
1143 * The buffer should already be locked by the caller by this point.
1144 * There is no lock ranking violation: it was a newly created,
1145 * unlocked buffer beforehand. */
1148 * int jbd2_journal_get_create_access () - notify intent to use newly created bh
1149 * @handle: transaction to new buffer to
1150 * @bh: new buffer.
1152 * Call this if you create a new bh.
1154 int jbd2_journal_get_create_access(handle_t *handle, struct buffer_head *bh)
1156 transaction_t *transaction = handle->h_transaction;
1157 journal_t *journal;
1158 struct journal_head *jh = jbd2_journal_add_journal_head(bh);
1159 int err;
1161 jbd_debug(5, "journal_head %p\n", jh);
1162 err = -EROFS;
1163 if (is_handle_aborted(handle))
1164 goto out;
1165 journal = transaction->t_journal;
1166 err = 0;
1168 JBUFFER_TRACE(jh, "entry");
1170 * The buffer may already belong to this transaction due to pre-zeroing
1171 * in the filesystem's new_block code. It may also be on the previous,
1172 * committing transaction's lists, but it HAS to be in Forget state in
1173 * that case: the transaction must have deleted the buffer for it to be
1174 * reused here.
1176 jbd_lock_bh_state(bh);
1177 J_ASSERT_JH(jh, (jh->b_transaction == transaction ||
1178 jh->b_transaction == NULL ||
1179 (jh->b_transaction == journal->j_committing_transaction &&
1180 jh->b_jlist == BJ_Forget)));
1182 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
1183 J_ASSERT_JH(jh, buffer_locked(jh2bh(jh)));
1185 if (jh->b_transaction == NULL) {
1187 * Previous jbd2_journal_forget() could have left the buffer
1188 * with jbddirty bit set because it was being committed. When
1189 * the commit finished, we've filed the buffer for
1190 * checkpointing and marked it dirty. Now we are reallocating
1191 * the buffer so the transaction freeing it must have
1192 * committed and so it's safe to clear the dirty bit.
1194 clear_buffer_dirty(jh2bh(jh));
1195 /* first access by this transaction */
1196 jh->b_modified = 0;
1198 JBUFFER_TRACE(jh, "file as BJ_Reserved");
1199 spin_lock(&journal->j_list_lock);
1200 __jbd2_journal_file_buffer(jh, transaction, BJ_Reserved);
1201 spin_unlock(&journal->j_list_lock);
1202 } else if (jh->b_transaction == journal->j_committing_transaction) {
1203 /* first access by this transaction */
1204 jh->b_modified = 0;
1206 JBUFFER_TRACE(jh, "set next transaction");
1207 spin_lock(&journal->j_list_lock);
1208 jh->b_next_transaction = transaction;
1209 spin_unlock(&journal->j_list_lock);
1211 jbd_unlock_bh_state(bh);
1214 * akpm: I added this. ext3_alloc_branch can pick up new indirect
1215 * blocks which contain freed but then revoked metadata. We need
1216 * to cancel the revoke in case we end up freeing it yet again
1217 * and the reallocating as data - this would cause a second revoke,
1218 * which hits an assertion error.
1220 JBUFFER_TRACE(jh, "cancelling revoke");
1221 jbd2_journal_cancel_revoke(handle, jh);
1222 out:
1223 jbd2_journal_put_journal_head(jh);
1224 return err;
1228 * int jbd2_journal_get_undo_access() - Notify intent to modify metadata with
1229 * non-rewindable consequences
1230 * @handle: transaction
1231 * @bh: buffer to undo
1233 * Sometimes there is a need to distinguish between metadata which has
1234 * been committed to disk and that which has not. The ext3fs code uses
1235 * this for freeing and allocating space, we have to make sure that we
1236 * do not reuse freed space until the deallocation has been committed,
1237 * since if we overwrote that space we would make the delete
1238 * un-rewindable in case of a crash.
1240 * To deal with that, jbd2_journal_get_undo_access requests write access to a
1241 * buffer for parts of non-rewindable operations such as delete
1242 * operations on the bitmaps. The journaling code must keep a copy of
1243 * the buffer's contents prior to the undo_access call until such time
1244 * as we know that the buffer has definitely been committed to disk.
1246 * We never need to know which transaction the committed data is part
1247 * of, buffers touched here are guaranteed to be dirtied later and so
1248 * will be committed to a new transaction in due course, at which point
1249 * we can discard the old committed data pointer.
1251 * Returns error number or 0 on success.
1253 int jbd2_journal_get_undo_access(handle_t *handle, struct buffer_head *bh)
1255 int err;
1256 struct journal_head *jh;
1257 char *committed_data = NULL;
1259 if (is_handle_aborted(handle))
1260 return -EROFS;
1262 if (jbd2_write_access_granted(handle, bh, true))
1263 return 0;
1265 jh = jbd2_journal_add_journal_head(bh);
1266 JBUFFER_TRACE(jh, "entry");
1269 * Do this first --- it can drop the journal lock, so we want to
1270 * make sure that obtaining the committed_data is done
1271 * atomically wrt. completion of any outstanding commits.
1273 err = do_get_write_access(handle, jh, 1);
1274 if (err)
1275 goto out;
1277 repeat:
1278 if (!jh->b_committed_data)
1279 committed_data = jbd2_alloc(jh2bh(jh)->b_size,
1280 GFP_NOFS|__GFP_NOFAIL);
1282 jbd_lock_bh_state(bh);
1283 if (!jh->b_committed_data) {
1284 /* Copy out the current buffer contents into the
1285 * preserved, committed copy. */
1286 JBUFFER_TRACE(jh, "generate b_committed data");
1287 if (!committed_data) {
1288 jbd_unlock_bh_state(bh);
1289 goto repeat;
1292 jh->b_committed_data = committed_data;
1293 committed_data = NULL;
1294 memcpy(jh->b_committed_data, bh->b_data, bh->b_size);
1296 jbd_unlock_bh_state(bh);
1297 out:
1298 jbd2_journal_put_journal_head(jh);
1299 if (unlikely(committed_data))
1300 jbd2_free(committed_data, bh->b_size);
1301 return err;
1305 * void jbd2_journal_set_triggers() - Add triggers for commit writeout
1306 * @bh: buffer to trigger on
1307 * @type: struct jbd2_buffer_trigger_type containing the trigger(s).
1309 * Set any triggers on this journal_head. This is always safe, because
1310 * triggers for a committing buffer will be saved off, and triggers for
1311 * a running transaction will match the buffer in that transaction.
1313 * Call with NULL to clear the triggers.
1315 void jbd2_journal_set_triggers(struct buffer_head *bh,
1316 struct jbd2_buffer_trigger_type *type)
1318 struct journal_head *jh = jbd2_journal_grab_journal_head(bh);
1320 if (WARN_ON(!jh))
1321 return;
1322 jh->b_triggers = type;
1323 jbd2_journal_put_journal_head(jh);
1326 void jbd2_buffer_frozen_trigger(struct journal_head *jh, void *mapped_data,
1327 struct jbd2_buffer_trigger_type *triggers)
1329 struct buffer_head *bh = jh2bh(jh);
1331 if (!triggers || !triggers->t_frozen)
1332 return;
1334 triggers->t_frozen(triggers, bh, mapped_data, bh->b_size);
1337 void jbd2_buffer_abort_trigger(struct journal_head *jh,
1338 struct jbd2_buffer_trigger_type *triggers)
1340 if (!triggers || !triggers->t_abort)
1341 return;
1343 triggers->t_abort(triggers, jh2bh(jh));
1347 * int jbd2_journal_dirty_metadata() - mark a buffer as containing dirty metadata
1348 * @handle: transaction to add buffer to.
1349 * @bh: buffer to mark
1351 * mark dirty metadata which needs to be journaled as part of the current
1352 * transaction.
1354 * The buffer must have previously had jbd2_journal_get_write_access()
1355 * called so that it has a valid journal_head attached to the buffer
1356 * head.
1358 * The buffer is placed on the transaction's metadata list and is marked
1359 * as belonging to the transaction.
1361 * Returns error number or 0 on success.
1363 * Special care needs to be taken if the buffer already belongs to the
1364 * current committing transaction (in which case we should have frozen
1365 * data present for that commit). In that case, we don't relink the
1366 * buffer: that only gets done when the old transaction finally
1367 * completes its commit.
1369 int jbd2_journal_dirty_metadata(handle_t *handle, struct buffer_head *bh)
1371 transaction_t *transaction = handle->h_transaction;
1372 journal_t *journal;
1373 struct journal_head *jh;
1374 int ret = 0;
1376 if (is_handle_aborted(handle))
1377 return -EROFS;
1378 if (!buffer_jbd(bh))
1379 return -EUCLEAN;
1382 * We don't grab jh reference here since the buffer must be part
1383 * of the running transaction.
1385 jh = bh2jh(bh);
1386 jbd_debug(5, "journal_head %p\n", jh);
1387 JBUFFER_TRACE(jh, "entry");
1390 * This and the following assertions are unreliable since we may see jh
1391 * in inconsistent state unless we grab bh_state lock. But this is
1392 * crucial to catch bugs so let's do a reliable check until the
1393 * lockless handling is fully proven.
1395 if (jh->b_transaction != transaction &&
1396 jh->b_next_transaction != transaction) {
1397 jbd_lock_bh_state(bh);
1398 J_ASSERT_JH(jh, jh->b_transaction == transaction ||
1399 jh->b_next_transaction == transaction);
1400 jbd_unlock_bh_state(bh);
1402 if (jh->b_modified == 1) {
1403 /* If it's in our transaction it must be in BJ_Metadata list. */
1404 if (jh->b_transaction == transaction &&
1405 jh->b_jlist != BJ_Metadata) {
1406 jbd_lock_bh_state(bh);
1407 if (jh->b_transaction == transaction &&
1408 jh->b_jlist != BJ_Metadata)
1409 pr_err("JBD2: assertion failure: h_type=%u "
1410 "h_line_no=%u block_no=%llu jlist=%u\n",
1411 handle->h_type, handle->h_line_no,
1412 (unsigned long long) bh->b_blocknr,
1413 jh->b_jlist);
1414 J_ASSERT_JH(jh, jh->b_transaction != transaction ||
1415 jh->b_jlist == BJ_Metadata);
1416 jbd_unlock_bh_state(bh);
1418 goto out;
1421 journal = transaction->t_journal;
1422 jbd_lock_bh_state(bh);
1424 if (jh->b_modified == 0) {
1426 * This buffer's got modified and becoming part
1427 * of the transaction. This needs to be done
1428 * once a transaction -bzzz
1430 if (handle->h_buffer_credits <= 0) {
1431 ret = -ENOSPC;
1432 goto out_unlock_bh;
1434 jh->b_modified = 1;
1435 handle->h_buffer_credits--;
1439 * fastpath, to avoid expensive locking. If this buffer is already
1440 * on the running transaction's metadata list there is nothing to do.
1441 * Nobody can take it off again because there is a handle open.
1442 * I _think_ we're OK here with SMP barriers - a mistaken decision will
1443 * result in this test being false, so we go in and take the locks.
1445 if (jh->b_transaction == transaction && jh->b_jlist == BJ_Metadata) {
1446 JBUFFER_TRACE(jh, "fastpath");
1447 if (unlikely(jh->b_transaction !=
1448 journal->j_running_transaction)) {
1449 printk(KERN_ERR "JBD2: %s: "
1450 "jh->b_transaction (%llu, %p, %u) != "
1451 "journal->j_running_transaction (%p, %u)\n",
1452 journal->j_devname,
1453 (unsigned long long) bh->b_blocknr,
1454 jh->b_transaction,
1455 jh->b_transaction ? jh->b_transaction->t_tid : 0,
1456 journal->j_running_transaction,
1457 journal->j_running_transaction ?
1458 journal->j_running_transaction->t_tid : 0);
1459 ret = -EINVAL;
1461 goto out_unlock_bh;
1464 set_buffer_jbddirty(bh);
1467 * Metadata already on the current transaction list doesn't
1468 * need to be filed. Metadata on another transaction's list must
1469 * be committing, and will be refiled once the commit completes:
1470 * leave it alone for now.
1472 if (jh->b_transaction != transaction) {
1473 JBUFFER_TRACE(jh, "already on other transaction");
1474 if (unlikely(((jh->b_transaction !=
1475 journal->j_committing_transaction)) ||
1476 (jh->b_next_transaction != transaction))) {
1477 printk(KERN_ERR "jbd2_journal_dirty_metadata: %s: "
1478 "bad jh for block %llu: "
1479 "transaction (%p, %u), "
1480 "jh->b_transaction (%p, %u), "
1481 "jh->b_next_transaction (%p, %u), jlist %u\n",
1482 journal->j_devname,
1483 (unsigned long long) bh->b_blocknr,
1484 transaction, transaction->t_tid,
1485 jh->b_transaction,
1486 jh->b_transaction ?
1487 jh->b_transaction->t_tid : 0,
1488 jh->b_next_transaction,
1489 jh->b_next_transaction ?
1490 jh->b_next_transaction->t_tid : 0,
1491 jh->b_jlist);
1492 WARN_ON(1);
1493 ret = -EINVAL;
1495 /* And this case is illegal: we can't reuse another
1496 * transaction's data buffer, ever. */
1497 goto out_unlock_bh;
1500 /* That test should have eliminated the following case: */
1501 J_ASSERT_JH(jh, jh->b_frozen_data == NULL);
1503 JBUFFER_TRACE(jh, "file as BJ_Metadata");
1504 spin_lock(&journal->j_list_lock);
1505 __jbd2_journal_file_buffer(jh, transaction, BJ_Metadata);
1506 spin_unlock(&journal->j_list_lock);
1507 out_unlock_bh:
1508 jbd_unlock_bh_state(bh);
1509 out:
1510 JBUFFER_TRACE(jh, "exit");
1511 return ret;
1515 * void jbd2_journal_forget() - bforget() for potentially-journaled buffers.
1516 * @handle: transaction handle
1517 * @bh: bh to 'forget'
1519 * We can only do the bforget if there are no commits pending against the
1520 * buffer. If the buffer is dirty in the current running transaction we
1521 * can safely unlink it.
1523 * bh may not be a journalled buffer at all - it may be a non-JBD
1524 * buffer which came off the hashtable. Check for this.
1526 * Decrements bh->b_count by one.
1528 * Allow this call even if the handle has aborted --- it may be part of
1529 * the caller's cleanup after an abort.
1531 int jbd2_journal_forget (handle_t *handle, struct buffer_head *bh)
1533 transaction_t *transaction = handle->h_transaction;
1534 journal_t *journal;
1535 struct journal_head *jh;
1536 int drop_reserve = 0;
1537 int err = 0;
1538 int was_modified = 0;
1540 if (is_handle_aborted(handle))
1541 return -EROFS;
1542 journal = transaction->t_journal;
1544 BUFFER_TRACE(bh, "entry");
1546 jbd_lock_bh_state(bh);
1548 if (!buffer_jbd(bh))
1549 goto not_jbd;
1550 jh = bh2jh(bh);
1552 /* Critical error: attempting to delete a bitmap buffer, maybe?
1553 * Don't do any jbd operations, and return an error. */
1554 if (!J_EXPECT_JH(jh, !jh->b_committed_data,
1555 "inconsistent data on disk")) {
1556 err = -EIO;
1557 goto not_jbd;
1560 /* keep track of whether or not this transaction modified us */
1561 was_modified = jh->b_modified;
1564 * The buffer's going from the transaction, we must drop
1565 * all references -bzzz
1567 jh->b_modified = 0;
1569 if (jh->b_transaction == transaction) {
1570 J_ASSERT_JH(jh, !jh->b_frozen_data);
1572 /* If we are forgetting a buffer which is already part
1573 * of this transaction, then we can just drop it from
1574 * the transaction immediately. */
1575 clear_buffer_dirty(bh);
1576 clear_buffer_jbddirty(bh);
1578 JBUFFER_TRACE(jh, "belongs to current transaction: unfile");
1581 * we only want to drop a reference if this transaction
1582 * modified the buffer
1584 if (was_modified)
1585 drop_reserve = 1;
1588 * We are no longer going to journal this buffer.
1589 * However, the commit of this transaction is still
1590 * important to the buffer: the delete that we are now
1591 * processing might obsolete an old log entry, so by
1592 * committing, we can satisfy the buffer's checkpoint.
1594 * So, if we have a checkpoint on the buffer, we should
1595 * now refile the buffer on our BJ_Forget list so that
1596 * we know to remove the checkpoint after we commit.
1599 spin_lock(&journal->j_list_lock);
1600 if (jh->b_cp_transaction) {
1601 __jbd2_journal_temp_unlink_buffer(jh);
1602 __jbd2_journal_file_buffer(jh, transaction, BJ_Forget);
1603 } else {
1604 __jbd2_journal_unfile_buffer(jh);
1605 if (!buffer_jbd(bh)) {
1606 spin_unlock(&journal->j_list_lock);
1607 goto not_jbd;
1610 spin_unlock(&journal->j_list_lock);
1611 } else if (jh->b_transaction) {
1612 J_ASSERT_JH(jh, (jh->b_transaction ==
1613 journal->j_committing_transaction));
1614 /* However, if the buffer is still owned by a prior
1615 * (committing) transaction, we can't drop it yet... */
1616 JBUFFER_TRACE(jh, "belongs to older transaction");
1617 /* ... but we CAN drop it from the new transaction through
1618 * marking the buffer as freed and set j_next_transaction to
1619 * the new transaction, so that not only the commit code
1620 * knows it should clear dirty bits when it is done with the
1621 * buffer, but also the buffer can be checkpointed only
1622 * after the new transaction commits. */
1624 set_buffer_freed(bh);
1626 if (!jh->b_next_transaction) {
1627 spin_lock(&journal->j_list_lock);
1628 jh->b_next_transaction = transaction;
1629 spin_unlock(&journal->j_list_lock);
1630 } else {
1631 J_ASSERT(jh->b_next_transaction == transaction);
1634 * only drop a reference if this transaction modified
1635 * the buffer
1637 if (was_modified)
1638 drop_reserve = 1;
1640 } else {
1642 * Finally, if the buffer is not belongs to any
1643 * transaction, we can just drop it now if it has no
1644 * checkpoint.
1646 spin_lock(&journal->j_list_lock);
1647 if (!jh->b_cp_transaction) {
1648 JBUFFER_TRACE(jh, "belongs to none transaction");
1649 spin_unlock(&journal->j_list_lock);
1650 goto not_jbd;
1654 * Otherwise, if the buffer has been written to disk,
1655 * it is safe to remove the checkpoint and drop it.
1657 if (!buffer_dirty(bh)) {
1658 __jbd2_journal_remove_checkpoint(jh);
1659 spin_unlock(&journal->j_list_lock);
1660 goto not_jbd;
1664 * The buffer is still not written to disk, we should
1665 * attach this buffer to current transaction so that the
1666 * buffer can be checkpointed only after the current
1667 * transaction commits.
1669 clear_buffer_dirty(bh);
1670 __jbd2_journal_file_buffer(jh, transaction, BJ_Forget);
1671 spin_unlock(&journal->j_list_lock);
1674 jbd_unlock_bh_state(bh);
1675 __brelse(bh);
1676 drop:
1677 if (drop_reserve) {
1678 /* no need to reserve log space for this block -bzzz */
1679 handle->h_buffer_credits++;
1681 return err;
1683 not_jbd:
1684 jbd_unlock_bh_state(bh);
1685 __bforget(bh);
1686 goto drop;
1690 * int jbd2_journal_stop() - complete a transaction
1691 * @handle: transaction to complete.
1693 * All done for a particular handle.
1695 * There is not much action needed here. We just return any remaining
1696 * buffer credits to the transaction and remove the handle. The only
1697 * complication is that we need to start a commit operation if the
1698 * filesystem is marked for synchronous update.
1700 * jbd2_journal_stop itself will not usually return an error, but it may
1701 * do so in unusual circumstances. In particular, expect it to
1702 * return -EIO if a jbd2_journal_abort has been executed since the
1703 * transaction began.
1705 int jbd2_journal_stop(handle_t *handle)
1707 transaction_t *transaction = handle->h_transaction;
1708 journal_t *journal;
1709 int err = 0, wait_for_commit = 0;
1710 tid_t tid;
1711 pid_t pid;
1713 if (!transaction) {
1715 * Handle is already detached from the transaction so
1716 * there is nothing to do other than decrease a refcount,
1717 * or free the handle if refcount drops to zero
1719 if (--handle->h_ref > 0) {
1720 jbd_debug(4, "h_ref %d -> %d\n", handle->h_ref + 1,
1721 handle->h_ref);
1722 return err;
1723 } else {
1724 if (handle->h_rsv_handle)
1725 jbd2_free_handle(handle->h_rsv_handle);
1726 goto free_and_exit;
1729 journal = transaction->t_journal;
1731 J_ASSERT(journal_current_handle() == handle);
1733 if (is_handle_aborted(handle))
1734 err = -EIO;
1735 else
1736 J_ASSERT(atomic_read(&transaction->t_updates) > 0);
1738 if (--handle->h_ref > 0) {
1739 jbd_debug(4, "h_ref %d -> %d\n", handle->h_ref + 1,
1740 handle->h_ref);
1741 return err;
1744 jbd_debug(4, "Handle %p going down\n", handle);
1745 trace_jbd2_handle_stats(journal->j_fs_dev->bd_dev,
1746 transaction->t_tid,
1747 handle->h_type, handle->h_line_no,
1748 jiffies - handle->h_start_jiffies,
1749 handle->h_sync, handle->h_requested_credits,
1750 (handle->h_requested_credits -
1751 handle->h_buffer_credits));
1754 * Implement synchronous transaction batching. If the handle
1755 * was synchronous, don't force a commit immediately. Let's
1756 * yield and let another thread piggyback onto this
1757 * transaction. Keep doing that while new threads continue to
1758 * arrive. It doesn't cost much - we're about to run a commit
1759 * and sleep on IO anyway. Speeds up many-threaded, many-dir
1760 * operations by 30x or more...
1762 * We try and optimize the sleep time against what the
1763 * underlying disk can do, instead of having a static sleep
1764 * time. This is useful for the case where our storage is so
1765 * fast that it is more optimal to go ahead and force a flush
1766 * and wait for the transaction to be committed than it is to
1767 * wait for an arbitrary amount of time for new writers to
1768 * join the transaction. We achieve this by measuring how
1769 * long it takes to commit a transaction, and compare it with
1770 * how long this transaction has been running, and if run time
1771 * < commit time then we sleep for the delta and commit. This
1772 * greatly helps super fast disks that would see slowdowns as
1773 * more threads started doing fsyncs.
1775 * But don't do this if this process was the most recent one
1776 * to perform a synchronous write. We do this to detect the
1777 * case where a single process is doing a stream of sync
1778 * writes. No point in waiting for joiners in that case.
1780 * Setting max_batch_time to 0 disables this completely.
1782 pid = current->pid;
1783 if (handle->h_sync && journal->j_last_sync_writer != pid &&
1784 journal->j_max_batch_time) {
1785 u64 commit_time, trans_time;
1787 journal->j_last_sync_writer = pid;
1789 read_lock(&journal->j_state_lock);
1790 commit_time = journal->j_average_commit_time;
1791 read_unlock(&journal->j_state_lock);
1793 trans_time = ktime_to_ns(ktime_sub(ktime_get(),
1794 transaction->t_start_time));
1796 commit_time = max_t(u64, commit_time,
1797 1000*journal->j_min_batch_time);
1798 commit_time = min_t(u64, commit_time,
1799 1000*journal->j_max_batch_time);
1801 if (trans_time < commit_time) {
1802 ktime_t expires = ktime_add_ns(ktime_get(),
1803 commit_time);
1804 set_current_state(TASK_UNINTERRUPTIBLE);
1805 schedule_hrtimeout(&expires, HRTIMER_MODE_ABS);
1809 if (handle->h_sync)
1810 transaction->t_synchronous_commit = 1;
1811 current->journal_info = NULL;
1812 atomic_sub(handle->h_buffer_credits,
1813 &transaction->t_outstanding_credits);
1816 * If the handle is marked SYNC, we need to set another commit
1817 * going! We also want to force a commit if the current
1818 * transaction is occupying too much of the log, or if the
1819 * transaction is too old now.
1821 if (handle->h_sync ||
1822 (atomic_read(&transaction->t_outstanding_credits) >
1823 journal->j_max_transaction_buffers) ||
1824 time_after_eq(jiffies, transaction->t_expires)) {
1825 /* Do this even for aborted journals: an abort still
1826 * completes the commit thread, it just doesn't write
1827 * anything to disk. */
1829 jbd_debug(2, "transaction too old, requesting commit for "
1830 "handle %p\n", handle);
1831 /* This is non-blocking */
1832 jbd2_log_start_commit(journal, transaction->t_tid);
1835 * Special case: JBD2_SYNC synchronous updates require us
1836 * to wait for the commit to complete.
1838 if (handle->h_sync && !(current->flags & PF_MEMALLOC))
1839 wait_for_commit = 1;
1843 * Once we drop t_updates, if it goes to zero the transaction
1844 * could start committing on us and eventually disappear. So
1845 * once we do this, we must not dereference transaction
1846 * pointer again.
1848 tid = transaction->t_tid;
1849 if (atomic_dec_and_test(&transaction->t_updates)) {
1850 wake_up(&journal->j_wait_updates);
1851 if (journal->j_barrier_count)
1852 wake_up(&journal->j_wait_transaction_locked);
1855 rwsem_release(&journal->j_trans_commit_map, 1, _THIS_IP_);
1857 if (wait_for_commit)
1858 err = jbd2_log_wait_commit(journal, tid);
1860 if (handle->h_rsv_handle)
1861 jbd2_journal_free_reserved(handle->h_rsv_handle);
1862 free_and_exit:
1864 * Scope of the GFP_NOFS context is over here and so we can restore the
1865 * original alloc context.
1867 memalloc_nofs_restore(handle->saved_alloc_context);
1868 jbd2_free_handle(handle);
1869 return err;
1874 * List management code snippets: various functions for manipulating the
1875 * transaction buffer lists.
1880 * Append a buffer to a transaction list, given the transaction's list head
1881 * pointer.
1883 * j_list_lock is held.
1885 * jbd_lock_bh_state(jh2bh(jh)) is held.
1888 static inline void
1889 __blist_add_buffer(struct journal_head **list, struct journal_head *jh)
1891 if (!*list) {
1892 jh->b_tnext = jh->b_tprev = jh;
1893 *list = jh;
1894 } else {
1895 /* Insert at the tail of the list to preserve order */
1896 struct journal_head *first = *list, *last = first->b_tprev;
1897 jh->b_tprev = last;
1898 jh->b_tnext = first;
1899 last->b_tnext = first->b_tprev = jh;
1904 * Remove a buffer from a transaction list, given the transaction's list
1905 * head pointer.
1907 * Called with j_list_lock held, and the journal may not be locked.
1909 * jbd_lock_bh_state(jh2bh(jh)) is held.
1912 static inline void
1913 __blist_del_buffer(struct journal_head **list, struct journal_head *jh)
1915 if (*list == jh) {
1916 *list = jh->b_tnext;
1917 if (*list == jh)
1918 *list = NULL;
1920 jh->b_tprev->b_tnext = jh->b_tnext;
1921 jh->b_tnext->b_tprev = jh->b_tprev;
1925 * Remove a buffer from the appropriate transaction list.
1927 * Note that this function can *change* the value of
1928 * bh->b_transaction->t_buffers, t_forget, t_shadow_list, t_log_list or
1929 * t_reserved_list. If the caller is holding onto a copy of one of these
1930 * pointers, it could go bad. Generally the caller needs to re-read the
1931 * pointer from the transaction_t.
1933 * Called under j_list_lock.
1935 static void __jbd2_journal_temp_unlink_buffer(struct journal_head *jh)
1937 struct journal_head **list = NULL;
1938 transaction_t *transaction;
1939 struct buffer_head *bh = jh2bh(jh);
1941 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
1942 transaction = jh->b_transaction;
1943 if (transaction)
1944 assert_spin_locked(&transaction->t_journal->j_list_lock);
1946 J_ASSERT_JH(jh, jh->b_jlist < BJ_Types);
1947 if (jh->b_jlist != BJ_None)
1948 J_ASSERT_JH(jh, transaction != NULL);
1950 switch (jh->b_jlist) {
1951 case BJ_None:
1952 return;
1953 case BJ_Metadata:
1954 transaction->t_nr_buffers--;
1955 J_ASSERT_JH(jh, transaction->t_nr_buffers >= 0);
1956 list = &transaction->t_buffers;
1957 break;
1958 case BJ_Forget:
1959 list = &transaction->t_forget;
1960 break;
1961 case BJ_Shadow:
1962 list = &transaction->t_shadow_list;
1963 break;
1964 case BJ_Reserved:
1965 list = &transaction->t_reserved_list;
1966 break;
1969 __blist_del_buffer(list, jh);
1970 jh->b_jlist = BJ_None;
1971 if (transaction && is_journal_aborted(transaction->t_journal))
1972 clear_buffer_jbddirty(bh);
1973 else if (test_clear_buffer_jbddirty(bh))
1974 mark_buffer_dirty(bh); /* Expose it to the VM */
1978 * Remove buffer from all transactions.
1980 * Called with bh_state lock and j_list_lock
1982 * jh and bh may be already freed when this function returns.
1984 static void __jbd2_journal_unfile_buffer(struct journal_head *jh)
1986 __jbd2_journal_temp_unlink_buffer(jh);
1987 jh->b_transaction = NULL;
1988 jbd2_journal_put_journal_head(jh);
1991 void jbd2_journal_unfile_buffer(journal_t *journal, struct journal_head *jh)
1993 struct buffer_head *bh = jh2bh(jh);
1995 /* Get reference so that buffer cannot be freed before we unlock it */
1996 get_bh(bh);
1997 jbd_lock_bh_state(bh);
1998 spin_lock(&journal->j_list_lock);
1999 __jbd2_journal_unfile_buffer(jh);
2000 spin_unlock(&journal->j_list_lock);
2001 jbd_unlock_bh_state(bh);
2002 __brelse(bh);
2006 * Called from jbd2_journal_try_to_free_buffers().
2008 * Called under jbd_lock_bh_state(bh)
2010 static void
2011 __journal_try_to_free_buffer(journal_t *journal, struct buffer_head *bh)
2013 struct journal_head *jh;
2015 jh = bh2jh(bh);
2017 if (buffer_locked(bh) || buffer_dirty(bh))
2018 goto out;
2020 if (jh->b_next_transaction != NULL || jh->b_transaction != NULL)
2021 goto out;
2023 spin_lock(&journal->j_list_lock);
2024 if (jh->b_cp_transaction != NULL) {
2025 /* written-back checkpointed metadata buffer */
2026 JBUFFER_TRACE(jh, "remove from checkpoint list");
2027 __jbd2_journal_remove_checkpoint(jh);
2029 spin_unlock(&journal->j_list_lock);
2030 out:
2031 return;
2035 * int jbd2_journal_try_to_free_buffers() - try to free page buffers.
2036 * @journal: journal for operation
2037 * @page: to try and free
2038 * @gfp_mask: we use the mask to detect how hard should we try to release
2039 * buffers. If __GFP_DIRECT_RECLAIM and __GFP_FS is set, we wait for commit
2040 * code to release the buffers.
2043 * For all the buffers on this page,
2044 * if they are fully written out ordered data, move them onto BUF_CLEAN
2045 * so try_to_free_buffers() can reap them.
2047 * This function returns non-zero if we wish try_to_free_buffers()
2048 * to be called. We do this if the page is releasable by try_to_free_buffers().
2049 * We also do it if the page has locked or dirty buffers and the caller wants
2050 * us to perform sync or async writeout.
2052 * This complicates JBD locking somewhat. We aren't protected by the
2053 * BKL here. We wish to remove the buffer from its committing or
2054 * running transaction's ->t_datalist via __jbd2_journal_unfile_buffer.
2056 * This may *change* the value of transaction_t->t_datalist, so anyone
2057 * who looks at t_datalist needs to lock against this function.
2059 * Even worse, someone may be doing a jbd2_journal_dirty_data on this
2060 * buffer. So we need to lock against that. jbd2_journal_dirty_data()
2061 * will come out of the lock with the buffer dirty, which makes it
2062 * ineligible for release here.
2064 * Who else is affected by this? hmm... Really the only contender
2065 * is do_get_write_access() - it could be looking at the buffer while
2066 * journal_try_to_free_buffer() is changing its state. But that
2067 * cannot happen because we never reallocate freed data as metadata
2068 * while the data is part of a transaction. Yes?
2070 * Return 0 on failure, 1 on success
2072 int jbd2_journal_try_to_free_buffers(journal_t *journal,
2073 struct page *page, gfp_t gfp_mask)
2075 struct buffer_head *head;
2076 struct buffer_head *bh;
2077 int ret = 0;
2079 J_ASSERT(PageLocked(page));
2081 head = page_buffers(page);
2082 bh = head;
2083 do {
2084 struct journal_head *jh;
2087 * We take our own ref against the journal_head here to avoid
2088 * having to add tons of locking around each instance of
2089 * jbd2_journal_put_journal_head().
2091 jh = jbd2_journal_grab_journal_head(bh);
2092 if (!jh)
2093 continue;
2095 jbd_lock_bh_state(bh);
2096 __journal_try_to_free_buffer(journal, bh);
2097 jbd2_journal_put_journal_head(jh);
2098 jbd_unlock_bh_state(bh);
2099 if (buffer_jbd(bh))
2100 goto busy;
2101 } while ((bh = bh->b_this_page) != head);
2103 ret = try_to_free_buffers(page);
2105 busy:
2106 return ret;
2110 * This buffer is no longer needed. If it is on an older transaction's
2111 * checkpoint list we need to record it on this transaction's forget list
2112 * to pin this buffer (and hence its checkpointing transaction) down until
2113 * this transaction commits. If the buffer isn't on a checkpoint list, we
2114 * release it.
2115 * Returns non-zero if JBD no longer has an interest in the buffer.
2117 * Called under j_list_lock.
2119 * Called under jbd_lock_bh_state(bh).
2121 static int __dispose_buffer(struct journal_head *jh, transaction_t *transaction)
2123 int may_free = 1;
2124 struct buffer_head *bh = jh2bh(jh);
2126 if (jh->b_cp_transaction) {
2127 JBUFFER_TRACE(jh, "on running+cp transaction");
2128 __jbd2_journal_temp_unlink_buffer(jh);
2130 * We don't want to write the buffer anymore, clear the
2131 * bit so that we don't confuse checks in
2132 * __journal_file_buffer
2134 clear_buffer_dirty(bh);
2135 __jbd2_journal_file_buffer(jh, transaction, BJ_Forget);
2136 may_free = 0;
2137 } else {
2138 JBUFFER_TRACE(jh, "on running transaction");
2139 __jbd2_journal_unfile_buffer(jh);
2141 return may_free;
2145 * jbd2_journal_invalidatepage
2147 * This code is tricky. It has a number of cases to deal with.
2149 * There are two invariants which this code relies on:
2151 * i_size must be updated on disk before we start calling invalidatepage on the
2152 * data.
2154 * This is done in ext3 by defining an ext3_setattr method which
2155 * updates i_size before truncate gets going. By maintaining this
2156 * invariant, we can be sure that it is safe to throw away any buffers
2157 * attached to the current transaction: once the transaction commits,
2158 * we know that the data will not be needed.
2160 * Note however that we can *not* throw away data belonging to the
2161 * previous, committing transaction!
2163 * Any disk blocks which *are* part of the previous, committing
2164 * transaction (and which therefore cannot be discarded immediately) are
2165 * not going to be reused in the new running transaction
2167 * The bitmap committed_data images guarantee this: any block which is
2168 * allocated in one transaction and removed in the next will be marked
2169 * as in-use in the committed_data bitmap, so cannot be reused until
2170 * the next transaction to delete the block commits. This means that
2171 * leaving committing buffers dirty is quite safe: the disk blocks
2172 * cannot be reallocated to a different file and so buffer aliasing is
2173 * not possible.
2176 * The above applies mainly to ordered data mode. In writeback mode we
2177 * don't make guarantees about the order in which data hits disk --- in
2178 * particular we don't guarantee that new dirty data is flushed before
2179 * transaction commit --- so it is always safe just to discard data
2180 * immediately in that mode. --sct
2184 * The journal_unmap_buffer helper function returns zero if the buffer
2185 * concerned remains pinned as an anonymous buffer belonging to an older
2186 * transaction.
2188 * We're outside-transaction here. Either or both of j_running_transaction
2189 * and j_committing_transaction may be NULL.
2191 static int journal_unmap_buffer(journal_t *journal, struct buffer_head *bh,
2192 int partial_page)
2194 transaction_t *transaction;
2195 struct journal_head *jh;
2196 int may_free = 1;
2198 BUFFER_TRACE(bh, "entry");
2201 * It is safe to proceed here without the j_list_lock because the
2202 * buffers cannot be stolen by try_to_free_buffers as long as we are
2203 * holding the page lock. --sct
2206 if (!buffer_jbd(bh))
2207 goto zap_buffer_unlocked;
2209 /* OK, we have data buffer in journaled mode */
2210 write_lock(&journal->j_state_lock);
2211 jbd_lock_bh_state(bh);
2212 spin_lock(&journal->j_list_lock);
2214 jh = jbd2_journal_grab_journal_head(bh);
2215 if (!jh)
2216 goto zap_buffer_no_jh;
2219 * We cannot remove the buffer from checkpoint lists until the
2220 * transaction adding inode to orphan list (let's call it T)
2221 * is committed. Otherwise if the transaction changing the
2222 * buffer would be cleaned from the journal before T is
2223 * committed, a crash will cause that the correct contents of
2224 * the buffer will be lost. On the other hand we have to
2225 * clear the buffer dirty bit at latest at the moment when the
2226 * transaction marking the buffer as freed in the filesystem
2227 * structures is committed because from that moment on the
2228 * block can be reallocated and used by a different page.
2229 * Since the block hasn't been freed yet but the inode has
2230 * already been added to orphan list, it is safe for us to add
2231 * the buffer to BJ_Forget list of the newest transaction.
2233 * Also we have to clear buffer_mapped flag of a truncated buffer
2234 * because the buffer_head may be attached to the page straddling
2235 * i_size (can happen only when blocksize < pagesize) and thus the
2236 * buffer_head can be reused when the file is extended again. So we end
2237 * up keeping around invalidated buffers attached to transactions'
2238 * BJ_Forget list just to stop checkpointing code from cleaning up
2239 * the transaction this buffer was modified in.
2241 transaction = jh->b_transaction;
2242 if (transaction == NULL) {
2243 /* First case: not on any transaction. If it
2244 * has no checkpoint link, then we can zap it:
2245 * it's a writeback-mode buffer so we don't care
2246 * if it hits disk safely. */
2247 if (!jh->b_cp_transaction) {
2248 JBUFFER_TRACE(jh, "not on any transaction: zap");
2249 goto zap_buffer;
2252 if (!buffer_dirty(bh)) {
2253 /* bdflush has written it. We can drop it now */
2254 __jbd2_journal_remove_checkpoint(jh);
2255 goto zap_buffer;
2258 /* OK, it must be in the journal but still not
2259 * written fully to disk: it's metadata or
2260 * journaled data... */
2262 if (journal->j_running_transaction) {
2263 /* ... and once the current transaction has
2264 * committed, the buffer won't be needed any
2265 * longer. */
2266 JBUFFER_TRACE(jh, "checkpointed: add to BJ_Forget");
2267 may_free = __dispose_buffer(jh,
2268 journal->j_running_transaction);
2269 goto zap_buffer;
2270 } else {
2271 /* There is no currently-running transaction. So the
2272 * orphan record which we wrote for this file must have
2273 * passed into commit. We must attach this buffer to
2274 * the committing transaction, if it exists. */
2275 if (journal->j_committing_transaction) {
2276 JBUFFER_TRACE(jh, "give to committing trans");
2277 may_free = __dispose_buffer(jh,
2278 journal->j_committing_transaction);
2279 goto zap_buffer;
2280 } else {
2281 /* The orphan record's transaction has
2282 * committed. We can cleanse this buffer */
2283 clear_buffer_jbddirty(bh);
2284 __jbd2_journal_remove_checkpoint(jh);
2285 goto zap_buffer;
2288 } else if (transaction == journal->j_committing_transaction) {
2289 JBUFFER_TRACE(jh, "on committing transaction");
2291 * The buffer is committing, we simply cannot touch
2292 * it. If the page is straddling i_size we have to wait
2293 * for commit and try again.
2295 if (partial_page) {
2296 jbd2_journal_put_journal_head(jh);
2297 spin_unlock(&journal->j_list_lock);
2298 jbd_unlock_bh_state(bh);
2299 write_unlock(&journal->j_state_lock);
2300 return -EBUSY;
2303 * OK, buffer won't be reachable after truncate. We just clear
2304 * b_modified to not confuse transaction credit accounting, and
2305 * set j_next_transaction to the running transaction (if there
2306 * is one) and mark buffer as freed so that commit code knows
2307 * it should clear dirty bits when it is done with the buffer.
2309 set_buffer_freed(bh);
2310 if (journal->j_running_transaction && buffer_jbddirty(bh))
2311 jh->b_next_transaction = journal->j_running_transaction;
2312 jh->b_modified = 0;
2313 jbd2_journal_put_journal_head(jh);
2314 spin_unlock(&journal->j_list_lock);
2315 jbd_unlock_bh_state(bh);
2316 write_unlock(&journal->j_state_lock);
2317 return 0;
2318 } else {
2319 /* Good, the buffer belongs to the running transaction.
2320 * We are writing our own transaction's data, not any
2321 * previous one's, so it is safe to throw it away
2322 * (remember that we expect the filesystem to have set
2323 * i_size already for this truncate so recovery will not
2324 * expose the disk blocks we are discarding here.) */
2325 J_ASSERT_JH(jh, transaction == journal->j_running_transaction);
2326 JBUFFER_TRACE(jh, "on running transaction");
2327 may_free = __dispose_buffer(jh, transaction);
2330 zap_buffer:
2332 * This is tricky. Although the buffer is truncated, it may be reused
2333 * if blocksize < pagesize and it is attached to the page straddling
2334 * EOF. Since the buffer might have been added to BJ_Forget list of the
2335 * running transaction, journal_get_write_access() won't clear
2336 * b_modified and credit accounting gets confused. So clear b_modified
2337 * here.
2339 jh->b_modified = 0;
2340 jbd2_journal_put_journal_head(jh);
2341 zap_buffer_no_jh:
2342 spin_unlock(&journal->j_list_lock);
2343 jbd_unlock_bh_state(bh);
2344 write_unlock(&journal->j_state_lock);
2345 zap_buffer_unlocked:
2346 clear_buffer_dirty(bh);
2347 J_ASSERT_BH(bh, !buffer_jbddirty(bh));
2348 clear_buffer_mapped(bh);
2349 clear_buffer_req(bh);
2350 clear_buffer_new(bh);
2351 clear_buffer_delay(bh);
2352 clear_buffer_unwritten(bh);
2353 bh->b_bdev = NULL;
2354 return may_free;
2358 * void jbd2_journal_invalidatepage()
2359 * @journal: journal to use for flush...
2360 * @page: page to flush
2361 * @offset: start of the range to invalidate
2362 * @length: length of the range to invalidate
2364 * Reap page buffers containing data after in the specified range in page.
2365 * Can return -EBUSY if buffers are part of the committing transaction and
2366 * the page is straddling i_size. Caller then has to wait for current commit
2367 * and try again.
2369 int jbd2_journal_invalidatepage(journal_t *journal,
2370 struct page *page,
2371 unsigned int offset,
2372 unsigned int length)
2374 struct buffer_head *head, *bh, *next;
2375 unsigned int stop = offset + length;
2376 unsigned int curr_off = 0;
2377 int partial_page = (offset || length < PAGE_SIZE);
2378 int may_free = 1;
2379 int ret = 0;
2381 if (!PageLocked(page))
2382 BUG();
2383 if (!page_has_buffers(page))
2384 return 0;
2386 BUG_ON(stop > PAGE_SIZE || stop < length);
2388 /* We will potentially be playing with lists other than just the
2389 * data lists (especially for journaled data mode), so be
2390 * cautious in our locking. */
2392 head = bh = page_buffers(page);
2393 do {
2394 unsigned int next_off = curr_off + bh->b_size;
2395 next = bh->b_this_page;
2397 if (next_off > stop)
2398 return 0;
2400 if (offset <= curr_off) {
2401 /* This block is wholly outside the truncation point */
2402 lock_buffer(bh);
2403 ret = journal_unmap_buffer(journal, bh, partial_page);
2404 unlock_buffer(bh);
2405 if (ret < 0)
2406 return ret;
2407 may_free &= ret;
2409 curr_off = next_off;
2410 bh = next;
2412 } while (bh != head);
2414 if (!partial_page) {
2415 if (may_free && try_to_free_buffers(page))
2416 J_ASSERT(!page_has_buffers(page));
2418 return 0;
2422 * File a buffer on the given transaction list.
2424 void __jbd2_journal_file_buffer(struct journal_head *jh,
2425 transaction_t *transaction, int jlist)
2427 struct journal_head **list = NULL;
2428 int was_dirty = 0;
2429 struct buffer_head *bh = jh2bh(jh);
2431 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
2432 assert_spin_locked(&transaction->t_journal->j_list_lock);
2434 J_ASSERT_JH(jh, jh->b_jlist < BJ_Types);
2435 J_ASSERT_JH(jh, jh->b_transaction == transaction ||
2436 jh->b_transaction == NULL);
2438 if (jh->b_transaction && jh->b_jlist == jlist)
2439 return;
2441 if (jlist == BJ_Metadata || jlist == BJ_Reserved ||
2442 jlist == BJ_Shadow || jlist == BJ_Forget) {
2444 * For metadata buffers, we track dirty bit in buffer_jbddirty
2445 * instead of buffer_dirty. We should not see a dirty bit set
2446 * here because we clear it in do_get_write_access but e.g.
2447 * tune2fs can modify the sb and set the dirty bit at any time
2448 * so we try to gracefully handle that.
2450 if (buffer_dirty(bh))
2451 warn_dirty_buffer(bh);
2452 if (test_clear_buffer_dirty(bh) ||
2453 test_clear_buffer_jbddirty(bh))
2454 was_dirty = 1;
2457 if (jh->b_transaction)
2458 __jbd2_journal_temp_unlink_buffer(jh);
2459 else
2460 jbd2_journal_grab_journal_head(bh);
2461 jh->b_transaction = transaction;
2463 switch (jlist) {
2464 case BJ_None:
2465 J_ASSERT_JH(jh, !jh->b_committed_data);
2466 J_ASSERT_JH(jh, !jh->b_frozen_data);
2467 return;
2468 case BJ_Metadata:
2469 transaction->t_nr_buffers++;
2470 list = &transaction->t_buffers;
2471 break;
2472 case BJ_Forget:
2473 list = &transaction->t_forget;
2474 break;
2475 case BJ_Shadow:
2476 list = &transaction->t_shadow_list;
2477 break;
2478 case BJ_Reserved:
2479 list = &transaction->t_reserved_list;
2480 break;
2483 __blist_add_buffer(list, jh);
2484 jh->b_jlist = jlist;
2486 if (was_dirty)
2487 set_buffer_jbddirty(bh);
2490 void jbd2_journal_file_buffer(struct journal_head *jh,
2491 transaction_t *transaction, int jlist)
2493 jbd_lock_bh_state(jh2bh(jh));
2494 spin_lock(&transaction->t_journal->j_list_lock);
2495 __jbd2_journal_file_buffer(jh, transaction, jlist);
2496 spin_unlock(&transaction->t_journal->j_list_lock);
2497 jbd_unlock_bh_state(jh2bh(jh));
2501 * Remove a buffer from its current buffer list in preparation for
2502 * dropping it from its current transaction entirely. If the buffer has
2503 * already started to be used by a subsequent transaction, refile the
2504 * buffer on that transaction's metadata list.
2506 * Called under j_list_lock
2507 * Called under jbd_lock_bh_state(jh2bh(jh))
2509 * jh and bh may be already free when this function returns
2511 void __jbd2_journal_refile_buffer(struct journal_head *jh)
2513 int was_dirty, jlist;
2514 struct buffer_head *bh = jh2bh(jh);
2516 J_ASSERT_JH(jh, jbd_is_locked_bh_state(bh));
2517 if (jh->b_transaction)
2518 assert_spin_locked(&jh->b_transaction->t_journal->j_list_lock);
2520 /* If the buffer is now unused, just drop it. */
2521 if (jh->b_next_transaction == NULL) {
2522 __jbd2_journal_unfile_buffer(jh);
2523 return;
2527 * It has been modified by a later transaction: add it to the new
2528 * transaction's metadata list.
2531 was_dirty = test_clear_buffer_jbddirty(bh);
2532 __jbd2_journal_temp_unlink_buffer(jh);
2534 * We set b_transaction here because b_next_transaction will inherit
2535 * our jh reference and thus __jbd2_journal_file_buffer() must not
2536 * take a new one.
2538 WRITE_ONCE(jh->b_transaction, jh->b_next_transaction);
2539 WRITE_ONCE(jh->b_next_transaction, NULL);
2540 if (buffer_freed(bh))
2541 jlist = BJ_Forget;
2542 else if (jh->b_modified)
2543 jlist = BJ_Metadata;
2544 else
2545 jlist = BJ_Reserved;
2546 __jbd2_journal_file_buffer(jh, jh->b_transaction, jlist);
2547 J_ASSERT_JH(jh, jh->b_transaction->t_state == T_RUNNING);
2549 if (was_dirty)
2550 set_buffer_jbddirty(bh);
2554 * __jbd2_journal_refile_buffer() with necessary locking added. We take our
2555 * bh reference so that we can safely unlock bh.
2557 * The jh and bh may be freed by this call.
2559 void jbd2_journal_refile_buffer(journal_t *journal, struct journal_head *jh)
2561 struct buffer_head *bh = jh2bh(jh);
2563 /* Get reference so that buffer cannot be freed before we unlock it */
2564 get_bh(bh);
2565 jbd_lock_bh_state(bh);
2566 spin_lock(&journal->j_list_lock);
2567 __jbd2_journal_refile_buffer(jh);
2568 jbd_unlock_bh_state(bh);
2569 spin_unlock(&journal->j_list_lock);
2570 __brelse(bh);
2574 * File inode in the inode list of the handle's transaction
2576 static int jbd2_journal_file_inode(handle_t *handle, struct jbd2_inode *jinode,
2577 unsigned long flags, loff_t start_byte, loff_t end_byte)
2579 transaction_t *transaction = handle->h_transaction;
2580 journal_t *journal;
2582 if (is_handle_aborted(handle))
2583 return -EROFS;
2584 journal = transaction->t_journal;
2586 jbd_debug(4, "Adding inode %lu, tid:%d\n", jinode->i_vfs_inode->i_ino,
2587 transaction->t_tid);
2589 spin_lock(&journal->j_list_lock);
2590 jinode->i_flags |= flags;
2592 if (jinode->i_dirty_end) {
2593 jinode->i_dirty_start = min(jinode->i_dirty_start, start_byte);
2594 jinode->i_dirty_end = max(jinode->i_dirty_end, end_byte);
2595 } else {
2596 jinode->i_dirty_start = start_byte;
2597 jinode->i_dirty_end = end_byte;
2600 /* Is inode already attached where we need it? */
2601 if (jinode->i_transaction == transaction ||
2602 jinode->i_next_transaction == transaction)
2603 goto done;
2606 * We only ever set this variable to 1 so the test is safe. Since
2607 * t_need_data_flush is likely to be set, we do the test to save some
2608 * cacheline bouncing
2610 if (!transaction->t_need_data_flush)
2611 transaction->t_need_data_flush = 1;
2612 /* On some different transaction's list - should be
2613 * the committing one */
2614 if (jinode->i_transaction) {
2615 J_ASSERT(jinode->i_next_transaction == NULL);
2616 J_ASSERT(jinode->i_transaction ==
2617 journal->j_committing_transaction);
2618 jinode->i_next_transaction = transaction;
2619 goto done;
2621 /* Not on any transaction list... */
2622 J_ASSERT(!jinode->i_next_transaction);
2623 jinode->i_transaction = transaction;
2624 list_add(&jinode->i_list, &transaction->t_inode_list);
2625 done:
2626 spin_unlock(&journal->j_list_lock);
2628 return 0;
2631 int jbd2_journal_inode_ranged_write(handle_t *handle,
2632 struct jbd2_inode *jinode, loff_t start_byte, loff_t length)
2634 return jbd2_journal_file_inode(handle, jinode,
2635 JI_WRITE_DATA | JI_WAIT_DATA, start_byte,
2636 start_byte + length - 1);
2639 int jbd2_journal_inode_ranged_wait(handle_t *handle, struct jbd2_inode *jinode,
2640 loff_t start_byte, loff_t length)
2642 return jbd2_journal_file_inode(handle, jinode, JI_WAIT_DATA,
2643 start_byte, start_byte + length - 1);
2647 * File truncate and transaction commit interact with each other in a
2648 * non-trivial way. If a transaction writing data block A is
2649 * committing, we cannot discard the data by truncate until we have
2650 * written them. Otherwise if we crashed after the transaction with
2651 * write has committed but before the transaction with truncate has
2652 * committed, we could see stale data in block A. This function is a
2653 * helper to solve this problem. It starts writeout of the truncated
2654 * part in case it is in the committing transaction.
2656 * Filesystem code must call this function when inode is journaled in
2657 * ordered mode before truncation happens and after the inode has been
2658 * placed on orphan list with the new inode size. The second condition
2659 * avoids the race that someone writes new data and we start
2660 * committing the transaction after this function has been called but
2661 * before a transaction for truncate is started (and furthermore it
2662 * allows us to optimize the case where the addition to orphan list
2663 * happens in the same transaction as write --- we don't have to write
2664 * any data in such case).
2666 int jbd2_journal_begin_ordered_truncate(journal_t *journal,
2667 struct jbd2_inode *jinode,
2668 loff_t new_size)
2670 transaction_t *inode_trans, *commit_trans;
2671 int ret = 0;
2673 /* This is a quick check to avoid locking if not necessary */
2674 if (!jinode->i_transaction)
2675 goto out;
2676 /* Locks are here just to force reading of recent values, it is
2677 * enough that the transaction was not committing before we started
2678 * a transaction adding the inode to orphan list */
2679 read_lock(&journal->j_state_lock);
2680 commit_trans = journal->j_committing_transaction;
2681 read_unlock(&journal->j_state_lock);
2682 spin_lock(&journal->j_list_lock);
2683 inode_trans = jinode->i_transaction;
2684 spin_unlock(&journal->j_list_lock);
2685 if (inode_trans == commit_trans) {
2686 ret = filemap_fdatawrite_range(jinode->i_vfs_inode->i_mapping,
2687 new_size, LLONG_MAX);
2688 if (ret)
2689 jbd2_journal_abort(journal, ret);
2691 out:
2692 return ret;