xref: /openbmc/linux/fs/jbd2/journal.c (revision a78bb11d)
1470decc6SDave Kleikamp /*
2f7f4bccbSMingming Cao  * linux/fs/jbd2/journal.c
3470decc6SDave Kleikamp  *
4470decc6SDave Kleikamp  * Written by Stephen C. Tweedie <sct@redhat.com>, 1998
5470decc6SDave Kleikamp  *
6470decc6SDave Kleikamp  * Copyright 1998 Red Hat corp --- All Rights Reserved
7470decc6SDave Kleikamp  *
8470decc6SDave Kleikamp  * This file is part of the Linux kernel and is made available under
9470decc6SDave Kleikamp  * the terms of the GNU General Public License, version 2, or at your
10470decc6SDave Kleikamp  * option, any later version, incorporated herein by reference.
11470decc6SDave Kleikamp  *
12470decc6SDave Kleikamp  * Generic filesystem journal-writing code; part of the ext2fs
13470decc6SDave Kleikamp  * journaling system.
14470decc6SDave Kleikamp  *
15470decc6SDave Kleikamp  * This file manages journals: areas of disk reserved for logging
16470decc6SDave Kleikamp  * transactional updates.  This includes the kernel journaling thread
17470decc6SDave Kleikamp  * which is responsible for scheduling updates to the log.
18470decc6SDave Kleikamp  *
19470decc6SDave Kleikamp  * We do not actually manage the physical storage of the journal in this
20470decc6SDave Kleikamp  * file: that is left to a per-journal policy function, which allows us
21470decc6SDave Kleikamp  * to store the journal within a filesystem-specified area for ext2
22470decc6SDave Kleikamp  * journaling (ext2 can use a reserved inode for storing the log).
23470decc6SDave Kleikamp  */
24470decc6SDave Kleikamp 
25470decc6SDave Kleikamp #include <linux/module.h>
26470decc6SDave Kleikamp #include <linux/time.h>
27470decc6SDave Kleikamp #include <linux/fs.h>
28f7f4bccbSMingming Cao #include <linux/jbd2.h>
29470decc6SDave Kleikamp #include <linux/errno.h>
30470decc6SDave Kleikamp #include <linux/slab.h>
31470decc6SDave Kleikamp #include <linux/init.h>
32470decc6SDave Kleikamp #include <linux/mm.h>
337dfb7103SNigel Cunningham #include <linux/freezer.h>
34470decc6SDave Kleikamp #include <linux/pagemap.h>
35470decc6SDave Kleikamp #include <linux/kthread.h>
36470decc6SDave Kleikamp #include <linux/poison.h>
37470decc6SDave Kleikamp #include <linux/proc_fs.h>
380f49d5d0SJose R. Santos #include <linux/debugfs.h>
398e85fb3fSJohann Lombardi #include <linux/seq_file.h>
40c225aa57SSimon Holm Thøgersen #include <linux/math64.h>
41879c5e6bSTheodore Ts'o #include <linux/hash.h>
42d2eecb03STheodore Ts'o #include <linux/log2.h>
43d2eecb03STheodore Ts'o #include <linux/vmalloc.h>
4447def826STheodore Ts'o #include <linux/backing-dev.h>
4539e3ac25SBrian King #include <linux/bitops.h>
46670be5a7STheodore Ts'o #include <linux/ratelimit.h>
47879c5e6bSTheodore Ts'o 
48879c5e6bSTheodore Ts'o #define CREATE_TRACE_POINTS
49879c5e6bSTheodore Ts'o #include <trace/events/jbd2.h>
50470decc6SDave Kleikamp 
51470decc6SDave Kleikamp #include <asm/uaccess.h>
52470decc6SDave Kleikamp #include <asm/page.h>
5339e3ac25SBrian King #include <asm/system.h>
54470decc6SDave Kleikamp 
55f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_extend);
56f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_stop);
57f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_lock_updates);
58f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_unlock_updates);
59f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_write_access);
60f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_create_access);
61f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_undo_access);
62e06c8227SJoel Becker EXPORT_SYMBOL(jbd2_journal_set_triggers);
63f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_dirty_metadata);
64f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_release_buffer);
65f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_forget);
66470decc6SDave Kleikamp #if 0
67470decc6SDave Kleikamp EXPORT_SYMBOL(journal_sync_buffer);
68470decc6SDave Kleikamp #endif
69f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_flush);
70f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_revoke);
71470decc6SDave Kleikamp 
72f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_dev);
73f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_inode);
74f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_used_features);
75f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_available_features);
76f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_set_features);
77f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_load);
78f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_destroy);
79f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_abort);
80f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_errno);
81f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_ack_err);
82f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_clear_err);
83f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_log_wait_commit);
843b799d15STheodore Ts'o EXPORT_SYMBOL(jbd2_log_start_commit);
85f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_start_commit);
86f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit_nested);
87f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_wipe);
88f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_blocks_per_page);
89f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_invalidatepage);
90f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_try_to_free_buffers);
91f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit);
92c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_file_inode);
93c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_init_jbd_inode);
94c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_release_jbd_inode);
95c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_begin_ordered_truncate);
968aefcd55STheodore Ts'o EXPORT_SYMBOL(jbd2_inode_cache);
97470decc6SDave Kleikamp 
98470decc6SDave Kleikamp static void __journal_abort_soft (journal_t *journal, int errno);
99d2eecb03STheodore Ts'o static int jbd2_journal_create_slab(size_t slab_size);
100470decc6SDave Kleikamp 
101470decc6SDave Kleikamp /*
102470decc6SDave Kleikamp  * Helper function used to manage commit timeouts
103470decc6SDave Kleikamp  */
104470decc6SDave Kleikamp 
105470decc6SDave Kleikamp static void commit_timeout(unsigned long __data)
106470decc6SDave Kleikamp {
107470decc6SDave Kleikamp 	struct task_struct * p = (struct task_struct *) __data;
108470decc6SDave Kleikamp 
109470decc6SDave Kleikamp 	wake_up_process(p);
110470decc6SDave Kleikamp }
111470decc6SDave Kleikamp 
112470decc6SDave Kleikamp /*
113f7f4bccbSMingming Cao  * kjournald2: The main thread function used to manage a logging device
114470decc6SDave Kleikamp  * journal.
115470decc6SDave Kleikamp  *
116470decc6SDave Kleikamp  * This kernel thread is responsible for two things:
117470decc6SDave Kleikamp  *
118470decc6SDave Kleikamp  * 1) COMMIT:  Every so often we need to commit the current state of the
119470decc6SDave Kleikamp  *    filesystem to disk.  The journal thread is responsible for writing
120470decc6SDave Kleikamp  *    all of the metadata buffers to disk.
121470decc6SDave Kleikamp  *
122470decc6SDave Kleikamp  * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
123470decc6SDave Kleikamp  *    of the data in that part of the log has been rewritten elsewhere on
124470decc6SDave Kleikamp  *    the disk.  Flushing these old buffers to reclaim space in the log is
125470decc6SDave Kleikamp  *    known as checkpointing, and this thread is responsible for that job.
126470decc6SDave Kleikamp  */
127470decc6SDave Kleikamp 
128f7f4bccbSMingming Cao static int kjournald2(void *arg)
129470decc6SDave Kleikamp {
130470decc6SDave Kleikamp 	journal_t *journal = arg;
131470decc6SDave Kleikamp 	transaction_t *transaction;
132470decc6SDave Kleikamp 
133470decc6SDave Kleikamp 	/*
134470decc6SDave Kleikamp 	 * Set up an interval timer which can be used to trigger a commit wakeup
135470decc6SDave Kleikamp 	 * after the commit interval expires
136470decc6SDave Kleikamp 	 */
137470decc6SDave Kleikamp 	setup_timer(&journal->j_commit_timer, commit_timeout,
138470decc6SDave Kleikamp 			(unsigned long)current);
139470decc6SDave Kleikamp 
140470decc6SDave Kleikamp 	/* Record that the journal thread is running */
141470decc6SDave Kleikamp 	journal->j_task = current;
142470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
143470decc6SDave Kleikamp 
144470decc6SDave Kleikamp 	/*
145470decc6SDave Kleikamp 	 * And now, wait forever for commit wakeup events.
146470decc6SDave Kleikamp 	 */
147a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
148470decc6SDave Kleikamp 
149470decc6SDave Kleikamp loop:
150f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_UNMOUNT)
151470decc6SDave Kleikamp 		goto end_loop;
152470decc6SDave Kleikamp 
153470decc6SDave Kleikamp 	jbd_debug(1, "commit_sequence=%d, commit_request=%d\n",
154470decc6SDave Kleikamp 		journal->j_commit_sequence, journal->j_commit_request);
155470decc6SDave Kleikamp 
156470decc6SDave Kleikamp 	if (journal->j_commit_sequence != journal->j_commit_request) {
157470decc6SDave Kleikamp 		jbd_debug(1, "OK, requests differ\n");
158a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
159470decc6SDave Kleikamp 		del_timer_sync(&journal->j_commit_timer);
160f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
161a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
162470decc6SDave Kleikamp 		goto loop;
163470decc6SDave Kleikamp 	}
164470decc6SDave Kleikamp 
165470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
166470decc6SDave Kleikamp 	if (freezing(current)) {
167470decc6SDave Kleikamp 		/*
168470decc6SDave Kleikamp 		 * The simpler the better. Flushing journal isn't a
169470decc6SDave Kleikamp 		 * good idea, because that depends on threads that may
170470decc6SDave Kleikamp 		 * be already stopped.
171470decc6SDave Kleikamp 		 */
172f7f4bccbSMingming Cao 		jbd_debug(1, "Now suspending kjournald2\n");
173a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
174a0acae0eSTejun Heo 		try_to_freeze();
175a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
176470decc6SDave Kleikamp 	} else {
177470decc6SDave Kleikamp 		/*
178470decc6SDave Kleikamp 		 * We assume on resume that commits are already there,
179470decc6SDave Kleikamp 		 * so we don't sleep
180470decc6SDave Kleikamp 		 */
181470decc6SDave Kleikamp 		DEFINE_WAIT(wait);
182470decc6SDave Kleikamp 		int should_sleep = 1;
183470decc6SDave Kleikamp 
184470decc6SDave Kleikamp 		prepare_to_wait(&journal->j_wait_commit, &wait,
185470decc6SDave Kleikamp 				TASK_INTERRUPTIBLE);
186470decc6SDave Kleikamp 		if (journal->j_commit_sequence != journal->j_commit_request)
187470decc6SDave Kleikamp 			should_sleep = 0;
188470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
189470decc6SDave Kleikamp 		if (transaction && time_after_eq(jiffies,
190470decc6SDave Kleikamp 						transaction->t_expires))
191470decc6SDave Kleikamp 			should_sleep = 0;
192f7f4bccbSMingming Cao 		if (journal->j_flags & JBD2_UNMOUNT)
193470decc6SDave Kleikamp 			should_sleep = 0;
194470decc6SDave Kleikamp 		if (should_sleep) {
195a931da6aSTheodore Ts'o 			write_unlock(&journal->j_state_lock);
196470decc6SDave Kleikamp 			schedule();
197a931da6aSTheodore Ts'o 			write_lock(&journal->j_state_lock);
198470decc6SDave Kleikamp 		}
199470decc6SDave Kleikamp 		finish_wait(&journal->j_wait_commit, &wait);
200470decc6SDave Kleikamp 	}
201470decc6SDave Kleikamp 
202f7f4bccbSMingming Cao 	jbd_debug(1, "kjournald2 wakes\n");
203470decc6SDave Kleikamp 
204470decc6SDave Kleikamp 	/*
205470decc6SDave Kleikamp 	 * Were we woken up by a commit wakeup event?
206470decc6SDave Kleikamp 	 */
207470decc6SDave Kleikamp 	transaction = journal->j_running_transaction;
208470decc6SDave Kleikamp 	if (transaction && time_after_eq(jiffies, transaction->t_expires)) {
209470decc6SDave Kleikamp 		journal->j_commit_request = transaction->t_tid;
210470decc6SDave Kleikamp 		jbd_debug(1, "woke because of timeout\n");
211470decc6SDave Kleikamp 	}
212470decc6SDave Kleikamp 	goto loop;
213470decc6SDave Kleikamp 
214470decc6SDave Kleikamp end_loop:
215a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
216470decc6SDave Kleikamp 	del_timer_sync(&journal->j_commit_timer);
217470decc6SDave Kleikamp 	journal->j_task = NULL;
218470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
219470decc6SDave Kleikamp 	jbd_debug(1, "Journal thread exiting.\n");
220470decc6SDave Kleikamp 	return 0;
221470decc6SDave Kleikamp }
222470decc6SDave Kleikamp 
22397f06784SPavel Emelianov static int jbd2_journal_start_thread(journal_t *journal)
224470decc6SDave Kleikamp {
22597f06784SPavel Emelianov 	struct task_struct *t;
22697f06784SPavel Emelianov 
22790576c0bSTheodore Ts'o 	t = kthread_run(kjournald2, journal, "jbd2/%s",
22890576c0bSTheodore Ts'o 			journal->j_devname);
22997f06784SPavel Emelianov 	if (IS_ERR(t))
23097f06784SPavel Emelianov 		return PTR_ERR(t);
23197f06784SPavel Emelianov 
2321076d17aSAl Viro 	wait_event(journal->j_wait_done_commit, journal->j_task != NULL);
23397f06784SPavel Emelianov 	return 0;
234470decc6SDave Kleikamp }
235470decc6SDave Kleikamp 
236470decc6SDave Kleikamp static void journal_kill_thread(journal_t *journal)
237470decc6SDave Kleikamp {
238a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
239f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_UNMOUNT;
240470decc6SDave Kleikamp 
241470decc6SDave Kleikamp 	while (journal->j_task) {
242470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
243a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
2441076d17aSAl Viro 		wait_event(journal->j_wait_done_commit, journal->j_task == NULL);
245a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
246470decc6SDave Kleikamp 	}
247a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
248470decc6SDave Kleikamp }
249470decc6SDave Kleikamp 
250470decc6SDave Kleikamp /*
251f7f4bccbSMingming Cao  * jbd2_journal_write_metadata_buffer: write a metadata buffer to the journal.
252470decc6SDave Kleikamp  *
253470decc6SDave Kleikamp  * Writes a metadata buffer to a given disk block.  The actual IO is not
254470decc6SDave Kleikamp  * performed but a new buffer_head is constructed which labels the data
255470decc6SDave Kleikamp  * to be written with the correct destination disk block.
256470decc6SDave Kleikamp  *
257470decc6SDave Kleikamp  * Any magic-number escaping which needs to be done will cause a
258470decc6SDave Kleikamp  * copy-out here.  If the buffer happens to start with the
259f7f4bccbSMingming Cao  * JBD2_MAGIC_NUMBER, then we can't write it to the log directly: the
260470decc6SDave Kleikamp  * magic number is only written to the log for descripter blocks.  In
261470decc6SDave Kleikamp  * this case, we copy the data and replace the first word with 0, and we
262470decc6SDave Kleikamp  * return a result code which indicates that this buffer needs to be
263470decc6SDave Kleikamp  * marked as an escaped buffer in the corresponding log descriptor
264470decc6SDave Kleikamp  * block.  The missing word can then be restored when the block is read
265470decc6SDave Kleikamp  * during recovery.
266470decc6SDave Kleikamp  *
267470decc6SDave Kleikamp  * If the source buffer has already been modified by a new transaction
268470decc6SDave Kleikamp  * since we took the last commit snapshot, we use the frozen copy of
269470decc6SDave Kleikamp  * that data for IO.  If we end up using the existing buffer_head's data
270470decc6SDave Kleikamp  * for the write, then we *have* to lock the buffer to prevent anyone
271470decc6SDave Kleikamp  * else from using and possibly modifying it while the IO is in
272470decc6SDave Kleikamp  * progress.
273470decc6SDave Kleikamp  *
274470decc6SDave Kleikamp  * The function returns a pointer to the buffer_heads to be used for IO.
275470decc6SDave Kleikamp  *
276470decc6SDave Kleikamp  * We assume that the journal has already been locked in this function.
277470decc6SDave Kleikamp  *
278470decc6SDave Kleikamp  * Return value:
279470decc6SDave Kleikamp  *  <0: Error
280470decc6SDave Kleikamp  * >=0: Finished OK
281470decc6SDave Kleikamp  *
282470decc6SDave Kleikamp  * On success:
283470decc6SDave Kleikamp  * Bit 0 set == escape performed on the data
284470decc6SDave Kleikamp  * Bit 1 set == buffer copy-out performed (kfree the data after IO)
285470decc6SDave Kleikamp  */
286470decc6SDave Kleikamp 
287f7f4bccbSMingming Cao int jbd2_journal_write_metadata_buffer(transaction_t *transaction,
288470decc6SDave Kleikamp 				  struct journal_head  *jh_in,
289470decc6SDave Kleikamp 				  struct journal_head **jh_out,
29018eba7aaSMingming Cao 				  unsigned long long blocknr)
291470decc6SDave Kleikamp {
292470decc6SDave Kleikamp 	int need_copy_out = 0;
293470decc6SDave Kleikamp 	int done_copy_out = 0;
294470decc6SDave Kleikamp 	int do_escape = 0;
295470decc6SDave Kleikamp 	char *mapped_data;
296470decc6SDave Kleikamp 	struct buffer_head *new_bh;
297470decc6SDave Kleikamp 	struct journal_head *new_jh;
298470decc6SDave Kleikamp 	struct page *new_page;
299470decc6SDave Kleikamp 	unsigned int new_offset;
300470decc6SDave Kleikamp 	struct buffer_head *bh_in = jh2bh(jh_in);
30196577c43Sdingdinghua 	journal_t *journal = transaction->t_journal;
302470decc6SDave Kleikamp 
303470decc6SDave Kleikamp 	/*
304470decc6SDave Kleikamp 	 * The buffer really shouldn't be locked: only the current committing
305470decc6SDave Kleikamp 	 * transaction is allowed to write it, so nobody else is allowed
306470decc6SDave Kleikamp 	 * to do any IO.
307470decc6SDave Kleikamp 	 *
308470decc6SDave Kleikamp 	 * akpm: except if we're journalling data, and write() output is
309470decc6SDave Kleikamp 	 * also part of a shared mapping, and another thread has
310470decc6SDave Kleikamp 	 * decided to launch a writepage() against this buffer.
311470decc6SDave Kleikamp 	 */
312470decc6SDave Kleikamp 	J_ASSERT_BH(bh_in, buffer_jbddirty(bh_in));
313470decc6SDave Kleikamp 
31447def826STheodore Ts'o retry_alloc:
31547def826STheodore Ts'o 	new_bh = alloc_buffer_head(GFP_NOFS);
31647def826STheodore Ts'o 	if (!new_bh) {
31747def826STheodore Ts'o 		/*
31847def826STheodore Ts'o 		 * Failure is not an option, but __GFP_NOFAIL is going
31947def826STheodore Ts'o 		 * away; so we retry ourselves here.
32047def826STheodore Ts'o 		 */
32147def826STheodore Ts'o 		congestion_wait(BLK_RW_ASYNC, HZ/50);
32247def826STheodore Ts'o 		goto retry_alloc;
32347def826STheodore Ts'o 	}
32447def826STheodore Ts'o 
32596577c43Sdingdinghua 	/* keep subsequent assertions sane */
32696577c43Sdingdinghua 	new_bh->b_state = 0;
32796577c43Sdingdinghua 	init_buffer(new_bh, NULL, NULL);
32896577c43Sdingdinghua 	atomic_set(&new_bh->b_count, 1);
32996577c43Sdingdinghua 	new_jh = jbd2_journal_add_journal_head(new_bh);	/* This sleeps */
330470decc6SDave Kleikamp 
331470decc6SDave Kleikamp 	/*
332470decc6SDave Kleikamp 	 * If a new transaction has already done a buffer copy-out, then
333470decc6SDave Kleikamp 	 * we use that version of the data for the commit.
334470decc6SDave Kleikamp 	 */
335470decc6SDave Kleikamp 	jbd_lock_bh_state(bh_in);
336470decc6SDave Kleikamp repeat:
337470decc6SDave Kleikamp 	if (jh_in->b_frozen_data) {
338470decc6SDave Kleikamp 		done_copy_out = 1;
339470decc6SDave Kleikamp 		new_page = virt_to_page(jh_in->b_frozen_data);
340470decc6SDave Kleikamp 		new_offset = offset_in_page(jh_in->b_frozen_data);
341470decc6SDave Kleikamp 	} else {
342470decc6SDave Kleikamp 		new_page = jh2bh(jh_in)->b_page;
343470decc6SDave Kleikamp 		new_offset = offset_in_page(jh2bh(jh_in)->b_data);
344470decc6SDave Kleikamp 	}
345470decc6SDave Kleikamp 
346470decc6SDave Kleikamp 	mapped_data = kmap_atomic(new_page, KM_USER0);
347470decc6SDave Kleikamp 	/*
34813ceef09SJan Kara 	 * Fire data frozen trigger if data already wasn't frozen.  Do this
34913ceef09SJan Kara 	 * before checking for escaping, as the trigger may modify the magic
35013ceef09SJan Kara 	 * offset.  If a copy-out happens afterwards, it will have the correct
35113ceef09SJan Kara 	 * data in the buffer.
352e06c8227SJoel Becker 	 */
35313ceef09SJan Kara 	if (!done_copy_out)
35413ceef09SJan Kara 		jbd2_buffer_frozen_trigger(jh_in, mapped_data + new_offset,
35513ceef09SJan Kara 					   jh_in->b_triggers);
356e06c8227SJoel Becker 
357e06c8227SJoel Becker 	/*
358470decc6SDave Kleikamp 	 * Check for escaping
359470decc6SDave Kleikamp 	 */
360470decc6SDave Kleikamp 	if (*((__be32 *)(mapped_data + new_offset)) ==
361f7f4bccbSMingming Cao 				cpu_to_be32(JBD2_MAGIC_NUMBER)) {
362470decc6SDave Kleikamp 		need_copy_out = 1;
363470decc6SDave Kleikamp 		do_escape = 1;
364470decc6SDave Kleikamp 	}
365470decc6SDave Kleikamp 	kunmap_atomic(mapped_data, KM_USER0);
366470decc6SDave Kleikamp 
367470decc6SDave Kleikamp 	/*
368470decc6SDave Kleikamp 	 * Do we need to do a data copy?
369470decc6SDave Kleikamp 	 */
370470decc6SDave Kleikamp 	if (need_copy_out && !done_copy_out) {
371470decc6SDave Kleikamp 		char *tmp;
372470decc6SDave Kleikamp 
373470decc6SDave Kleikamp 		jbd_unlock_bh_state(bh_in);
374af1e76d6SMingming Cao 		tmp = jbd2_alloc(bh_in->b_size, GFP_NOFS);
375e6ec116bSTheodore Ts'o 		if (!tmp) {
376e6ec116bSTheodore Ts'o 			jbd2_journal_put_journal_head(new_jh);
377e6ec116bSTheodore Ts'o 			return -ENOMEM;
378e6ec116bSTheodore Ts'o 		}
379470decc6SDave Kleikamp 		jbd_lock_bh_state(bh_in);
380470decc6SDave Kleikamp 		if (jh_in->b_frozen_data) {
381af1e76d6SMingming Cao 			jbd2_free(tmp, bh_in->b_size);
382470decc6SDave Kleikamp 			goto repeat;
383470decc6SDave Kleikamp 		}
384470decc6SDave Kleikamp 
385470decc6SDave Kleikamp 		jh_in->b_frozen_data = tmp;
386470decc6SDave Kleikamp 		mapped_data = kmap_atomic(new_page, KM_USER0);
387470decc6SDave Kleikamp 		memcpy(tmp, mapped_data + new_offset, jh2bh(jh_in)->b_size);
388470decc6SDave Kleikamp 		kunmap_atomic(mapped_data, KM_USER0);
389470decc6SDave Kleikamp 
390470decc6SDave Kleikamp 		new_page = virt_to_page(tmp);
391470decc6SDave Kleikamp 		new_offset = offset_in_page(tmp);
392470decc6SDave Kleikamp 		done_copy_out = 1;
393e06c8227SJoel Becker 
394e06c8227SJoel Becker 		/*
395e06c8227SJoel Becker 		 * This isn't strictly necessary, as we're using frozen
396e06c8227SJoel Becker 		 * data for the escaping, but it keeps consistency with
397e06c8227SJoel Becker 		 * b_frozen_data usage.
398e06c8227SJoel Becker 		 */
399e06c8227SJoel Becker 		jh_in->b_frozen_triggers = jh_in->b_triggers;
400470decc6SDave Kleikamp 	}
401470decc6SDave Kleikamp 
402470decc6SDave Kleikamp 	/*
403470decc6SDave Kleikamp 	 * Did we need to do an escaping?  Now we've done all the
404470decc6SDave Kleikamp 	 * copying, we can finally do so.
405470decc6SDave Kleikamp 	 */
406470decc6SDave Kleikamp 	if (do_escape) {
407470decc6SDave Kleikamp 		mapped_data = kmap_atomic(new_page, KM_USER0);
408470decc6SDave Kleikamp 		*((unsigned int *)(mapped_data + new_offset)) = 0;
409470decc6SDave Kleikamp 		kunmap_atomic(mapped_data, KM_USER0);
410470decc6SDave Kleikamp 	}
411470decc6SDave Kleikamp 
412470decc6SDave Kleikamp 	set_bh_page(new_bh, new_page, new_offset);
413470decc6SDave Kleikamp 	new_jh->b_transaction = NULL;
414470decc6SDave Kleikamp 	new_bh->b_size = jh2bh(jh_in)->b_size;
415470decc6SDave Kleikamp 	new_bh->b_bdev = transaction->t_journal->j_dev;
416470decc6SDave Kleikamp 	new_bh->b_blocknr = blocknr;
417470decc6SDave Kleikamp 	set_buffer_mapped(new_bh);
418470decc6SDave Kleikamp 	set_buffer_dirty(new_bh);
419470decc6SDave Kleikamp 
420470decc6SDave Kleikamp 	*jh_out = new_jh;
421470decc6SDave Kleikamp 
422470decc6SDave Kleikamp 	/*
423470decc6SDave Kleikamp 	 * The to-be-written buffer needs to get moved to the io queue,
424470decc6SDave Kleikamp 	 * and the original buffer whose contents we are shadowing or
425470decc6SDave Kleikamp 	 * copying is moved to the transaction's shadow queue.
426470decc6SDave Kleikamp 	 */
427470decc6SDave Kleikamp 	JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
42896577c43Sdingdinghua 	spin_lock(&journal->j_list_lock);
42996577c43Sdingdinghua 	__jbd2_journal_file_buffer(jh_in, transaction, BJ_Shadow);
43096577c43Sdingdinghua 	spin_unlock(&journal->j_list_lock);
43196577c43Sdingdinghua 	jbd_unlock_bh_state(bh_in);
43296577c43Sdingdinghua 
433470decc6SDave Kleikamp 	JBUFFER_TRACE(new_jh, "file as BJ_IO");
434f7f4bccbSMingming Cao 	jbd2_journal_file_buffer(new_jh, transaction, BJ_IO);
435470decc6SDave Kleikamp 
436470decc6SDave Kleikamp 	return do_escape | (done_copy_out << 1);
437470decc6SDave Kleikamp }
438470decc6SDave Kleikamp 
439470decc6SDave Kleikamp /*
440470decc6SDave Kleikamp  * Allocation code for the journal file.  Manage the space left in the
441470decc6SDave Kleikamp  * journal, so that we can begin checkpointing when appropriate.
442470decc6SDave Kleikamp  */
443470decc6SDave Kleikamp 
444470decc6SDave Kleikamp /*
445f7f4bccbSMingming Cao  * __jbd2_log_space_left: Return the number of free blocks left in the journal.
446470decc6SDave Kleikamp  *
447470decc6SDave Kleikamp  * Called with the journal already locked.
448470decc6SDave Kleikamp  *
449470decc6SDave Kleikamp  * Called under j_state_lock
450470decc6SDave Kleikamp  */
451470decc6SDave Kleikamp 
452f7f4bccbSMingming Cao int __jbd2_log_space_left(journal_t *journal)
453470decc6SDave Kleikamp {
454470decc6SDave Kleikamp 	int left = journal->j_free;
455470decc6SDave Kleikamp 
456a931da6aSTheodore Ts'o 	/* assert_spin_locked(&journal->j_state_lock); */
457470decc6SDave Kleikamp 
458470decc6SDave Kleikamp 	/*
459470decc6SDave Kleikamp 	 * Be pessimistic here about the number of those free blocks which
460470decc6SDave Kleikamp 	 * might be required for log descriptor control blocks.
461470decc6SDave Kleikamp 	 */
462470decc6SDave Kleikamp 
463470decc6SDave Kleikamp #define MIN_LOG_RESERVED_BLOCKS 32 /* Allow for rounding errors */
464470decc6SDave Kleikamp 
465470decc6SDave Kleikamp 	left -= MIN_LOG_RESERVED_BLOCKS;
466470decc6SDave Kleikamp 
467470decc6SDave Kleikamp 	if (left <= 0)
468470decc6SDave Kleikamp 		return 0;
469470decc6SDave Kleikamp 	left -= (left >> 3);
470470decc6SDave Kleikamp 	return left;
471470decc6SDave Kleikamp }
472470decc6SDave Kleikamp 
473470decc6SDave Kleikamp /*
474e4471831STheodore Ts'o  * Called with j_state_lock locked for writing.
475e4471831STheodore Ts'o  * Returns true if a transaction commit was started.
476470decc6SDave Kleikamp  */
477f7f4bccbSMingming Cao int __jbd2_log_start_commit(journal_t *journal, tid_t target)
478470decc6SDave Kleikamp {
479470decc6SDave Kleikamp 	/*
480deeeaf13STheodore Ts'o 	 * The only transaction we can possibly wait upon is the
481deeeaf13STheodore Ts'o 	 * currently running transaction (if it exists).  Otherwise,
482deeeaf13STheodore Ts'o 	 * the target tid must be an old one.
483470decc6SDave Kleikamp 	 */
484deeeaf13STheodore Ts'o 	if (journal->j_running_transaction &&
485deeeaf13STheodore Ts'o 	    journal->j_running_transaction->t_tid == target) {
486470decc6SDave Kleikamp 		/*
487bcf3d0bcSAndrea Gelmini 		 * We want a new commit: OK, mark the request and wakeup the
488470decc6SDave Kleikamp 		 * commit thread.  We do _not_ do the commit ourselves.
489470decc6SDave Kleikamp 		 */
490470decc6SDave Kleikamp 
491470decc6SDave Kleikamp 		journal->j_commit_request = target;
492f2a44523SEryu Guan 		jbd_debug(1, "JBD2: requesting commit %d/%d\n",
493470decc6SDave Kleikamp 			  journal->j_commit_request,
494470decc6SDave Kleikamp 			  journal->j_commit_sequence);
495470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
496470decc6SDave Kleikamp 		return 1;
497deeeaf13STheodore Ts'o 	} else if (!tid_geq(journal->j_commit_request, target))
498deeeaf13STheodore Ts'o 		/* This should never happen, but if it does, preserve
499deeeaf13STheodore Ts'o 		   the evidence before kjournald goes into a loop and
500deeeaf13STheodore Ts'o 		   increments j_commit_sequence beyond all recognition. */
501f2a44523SEryu Guan 		WARN_ONCE(1, "JBD2: bad log_start_commit: %u %u %u %u\n",
5021be2add6STheodore Ts'o 			  journal->j_commit_request,
5031be2add6STheodore Ts'o 			  journal->j_commit_sequence,
504deeeaf13STheodore Ts'o 			  target, journal->j_running_transaction ?
505deeeaf13STheodore Ts'o 			  journal->j_running_transaction->t_tid : 0);
506470decc6SDave Kleikamp 	return 0;
507470decc6SDave Kleikamp }
508470decc6SDave Kleikamp 
509f7f4bccbSMingming Cao int jbd2_log_start_commit(journal_t *journal, tid_t tid)
510470decc6SDave Kleikamp {
511470decc6SDave Kleikamp 	int ret;
512470decc6SDave Kleikamp 
513a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
514f7f4bccbSMingming Cao 	ret = __jbd2_log_start_commit(journal, tid);
515a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
516470decc6SDave Kleikamp 	return ret;
517470decc6SDave Kleikamp }
518470decc6SDave Kleikamp 
519470decc6SDave Kleikamp /*
520470decc6SDave Kleikamp  * Force and wait upon a commit if the calling process is not within
521470decc6SDave Kleikamp  * transaction.  This is used for forcing out undo-protected data which contains
522470decc6SDave Kleikamp  * bitmaps, when the fs is running out of space.
523470decc6SDave Kleikamp  *
524470decc6SDave Kleikamp  * We can only force the running transaction if we don't have an active handle;
525470decc6SDave Kleikamp  * otherwise, we will deadlock.
526470decc6SDave Kleikamp  *
527470decc6SDave Kleikamp  * Returns true if a transaction was started.
528470decc6SDave Kleikamp  */
529f7f4bccbSMingming Cao int jbd2_journal_force_commit_nested(journal_t *journal)
530470decc6SDave Kleikamp {
531470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
532470decc6SDave Kleikamp 	tid_t tid;
533e4471831STheodore Ts'o 	int need_to_start = 0;
534470decc6SDave Kleikamp 
535a931da6aSTheodore Ts'o 	read_lock(&journal->j_state_lock);
536470decc6SDave Kleikamp 	if (journal->j_running_transaction && !current->journal_info) {
537470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
538e4471831STheodore Ts'o 		if (!tid_geq(journal->j_commit_request, transaction->t_tid))
539e4471831STheodore Ts'o 			need_to_start = 1;
540470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
541470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
542470decc6SDave Kleikamp 
543470decc6SDave Kleikamp 	if (!transaction) {
544a931da6aSTheodore Ts'o 		read_unlock(&journal->j_state_lock);
545470decc6SDave Kleikamp 		return 0;	/* Nothing to retry */
546470decc6SDave Kleikamp 	}
547470decc6SDave Kleikamp 
548470decc6SDave Kleikamp 	tid = transaction->t_tid;
549a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
550e4471831STheodore Ts'o 	if (need_to_start)
551e4471831STheodore Ts'o 		jbd2_log_start_commit(journal, tid);
552f7f4bccbSMingming Cao 	jbd2_log_wait_commit(journal, tid);
553470decc6SDave Kleikamp 	return 1;
554470decc6SDave Kleikamp }
555470decc6SDave Kleikamp 
556470decc6SDave Kleikamp /*
557470decc6SDave Kleikamp  * Start a commit of the current running transaction (if any).  Returns true
558c88ccea3SJan Kara  * if a transaction is going to be committed (or is currently already
559c88ccea3SJan Kara  * committing), and fills its tid in at *ptid
560470decc6SDave Kleikamp  */
561f7f4bccbSMingming Cao int jbd2_journal_start_commit(journal_t *journal, tid_t *ptid)
562470decc6SDave Kleikamp {
563470decc6SDave Kleikamp 	int ret = 0;
564470decc6SDave Kleikamp 
565a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
566470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
567470decc6SDave Kleikamp 		tid_t tid = journal->j_running_transaction->t_tid;
568470decc6SDave Kleikamp 
569c88ccea3SJan Kara 		__jbd2_log_start_commit(journal, tid);
570c88ccea3SJan Kara 		/* There's a running transaction and we've just made sure
571c88ccea3SJan Kara 		 * it's commit has been scheduled. */
572c88ccea3SJan Kara 		if (ptid)
573470decc6SDave Kleikamp 			*ptid = tid;
574c88ccea3SJan Kara 		ret = 1;
575c88ccea3SJan Kara 	} else if (journal->j_committing_transaction) {
576470decc6SDave Kleikamp 		/*
577470decc6SDave Kleikamp 		 * If ext3_write_super() recently started a commit, then we
578470decc6SDave Kleikamp 		 * have to wait for completion of that transaction
579470decc6SDave Kleikamp 		 */
580c88ccea3SJan Kara 		if (ptid)
581470decc6SDave Kleikamp 			*ptid = journal->j_committing_transaction->t_tid;
582470decc6SDave Kleikamp 		ret = 1;
583470decc6SDave Kleikamp 	}
584a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
585470decc6SDave Kleikamp 	return ret;
586470decc6SDave Kleikamp }
587470decc6SDave Kleikamp 
588470decc6SDave Kleikamp /*
589bbd2be36SJan Kara  * Return 1 if a given transaction has not yet sent barrier request
590bbd2be36SJan Kara  * connected with a transaction commit. If 0 is returned, transaction
591bbd2be36SJan Kara  * may or may not have sent the barrier. Used to avoid sending barrier
592bbd2be36SJan Kara  * twice in common cases.
593bbd2be36SJan Kara  */
594bbd2be36SJan Kara int jbd2_trans_will_send_data_barrier(journal_t *journal, tid_t tid)
595bbd2be36SJan Kara {
596bbd2be36SJan Kara 	int ret = 0;
597bbd2be36SJan Kara 	transaction_t *commit_trans;
598bbd2be36SJan Kara 
599bbd2be36SJan Kara 	if (!(journal->j_flags & JBD2_BARRIER))
600bbd2be36SJan Kara 		return 0;
601bbd2be36SJan Kara 	read_lock(&journal->j_state_lock);
602bbd2be36SJan Kara 	/* Transaction already committed? */
603bbd2be36SJan Kara 	if (tid_geq(journal->j_commit_sequence, tid))
604bbd2be36SJan Kara 		goto out;
605bbd2be36SJan Kara 	commit_trans = journal->j_committing_transaction;
606bbd2be36SJan Kara 	if (!commit_trans || commit_trans->t_tid != tid) {
607bbd2be36SJan Kara 		ret = 1;
608bbd2be36SJan Kara 		goto out;
609bbd2be36SJan Kara 	}
610bbd2be36SJan Kara 	/*
611bbd2be36SJan Kara 	 * Transaction is being committed and we already proceeded to
612bbd2be36SJan Kara 	 * submitting a flush to fs partition?
613bbd2be36SJan Kara 	 */
614bbd2be36SJan Kara 	if (journal->j_fs_dev != journal->j_dev) {
615bbd2be36SJan Kara 		if (!commit_trans->t_need_data_flush ||
616bbd2be36SJan Kara 		    commit_trans->t_state >= T_COMMIT_DFLUSH)
617bbd2be36SJan Kara 			goto out;
618bbd2be36SJan Kara 	} else {
619bbd2be36SJan Kara 		if (commit_trans->t_state >= T_COMMIT_JFLUSH)
620bbd2be36SJan Kara 			goto out;
621bbd2be36SJan Kara 	}
622bbd2be36SJan Kara 	ret = 1;
623bbd2be36SJan Kara out:
624bbd2be36SJan Kara 	read_unlock(&journal->j_state_lock);
625bbd2be36SJan Kara 	return ret;
626bbd2be36SJan Kara }
627bbd2be36SJan Kara EXPORT_SYMBOL(jbd2_trans_will_send_data_barrier);
628bbd2be36SJan Kara 
629bbd2be36SJan Kara /*
630470decc6SDave Kleikamp  * Wait for a specified commit to complete.
631470decc6SDave Kleikamp  * The caller may not hold the journal lock.
632470decc6SDave Kleikamp  */
633f7f4bccbSMingming Cao int jbd2_log_wait_commit(journal_t *journal, tid_t tid)
634470decc6SDave Kleikamp {
635470decc6SDave Kleikamp 	int err = 0;
636470decc6SDave Kleikamp 
637a931da6aSTheodore Ts'o 	read_lock(&journal->j_state_lock);
638e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
639470decc6SDave Kleikamp 	if (!tid_geq(journal->j_commit_request, tid)) {
640470decc6SDave Kleikamp 		printk(KERN_EMERG
641470decc6SDave Kleikamp 		       "%s: error: j_commit_request=%d, tid=%d\n",
642329d291fSHarvey Harrison 		       __func__, journal->j_commit_request, tid);
643470decc6SDave Kleikamp 	}
644470decc6SDave Kleikamp #endif
645470decc6SDave Kleikamp 	while (tid_gt(tid, journal->j_commit_sequence)) {
646f2a44523SEryu Guan 		jbd_debug(1, "JBD2: want %d, j_commit_sequence=%d\n",
647470decc6SDave Kleikamp 				  tid, journal->j_commit_sequence);
648470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
649a931da6aSTheodore Ts'o 		read_unlock(&journal->j_state_lock);
650470decc6SDave Kleikamp 		wait_event(journal->j_wait_done_commit,
651470decc6SDave Kleikamp 				!tid_gt(tid, journal->j_commit_sequence));
652a931da6aSTheodore Ts'o 		read_lock(&journal->j_state_lock);
653470decc6SDave Kleikamp 	}
654a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
655470decc6SDave Kleikamp 
656470decc6SDave Kleikamp 	if (unlikely(is_journal_aborted(journal))) {
657470decc6SDave Kleikamp 		printk(KERN_EMERG "journal commit I/O error\n");
658470decc6SDave Kleikamp 		err = -EIO;
659470decc6SDave Kleikamp 	}
660470decc6SDave Kleikamp 	return err;
661470decc6SDave Kleikamp }
662470decc6SDave Kleikamp 
663470decc6SDave Kleikamp /*
664470decc6SDave Kleikamp  * Log buffer allocation routines:
665470decc6SDave Kleikamp  */
666470decc6SDave Kleikamp 
66718eba7aaSMingming Cao int jbd2_journal_next_log_block(journal_t *journal, unsigned long long *retp)
668470decc6SDave Kleikamp {
669470decc6SDave Kleikamp 	unsigned long blocknr;
670470decc6SDave Kleikamp 
671a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
672470decc6SDave Kleikamp 	J_ASSERT(journal->j_free > 1);
673470decc6SDave Kleikamp 
674470decc6SDave Kleikamp 	blocknr = journal->j_head;
675470decc6SDave Kleikamp 	journal->j_head++;
676470decc6SDave Kleikamp 	journal->j_free--;
677470decc6SDave Kleikamp 	if (journal->j_head == journal->j_last)
678470decc6SDave Kleikamp 		journal->j_head = journal->j_first;
679a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
680f7f4bccbSMingming Cao 	return jbd2_journal_bmap(journal, blocknr, retp);
681470decc6SDave Kleikamp }
682470decc6SDave Kleikamp 
683470decc6SDave Kleikamp /*
684470decc6SDave Kleikamp  * Conversion of logical to physical block numbers for the journal
685470decc6SDave Kleikamp  *
686470decc6SDave Kleikamp  * On external journals the journal blocks are identity-mapped, so
687470decc6SDave Kleikamp  * this is a no-op.  If needed, we can use j_blk_offset - everything is
688470decc6SDave Kleikamp  * ready.
689470decc6SDave Kleikamp  */
690f7f4bccbSMingming Cao int jbd2_journal_bmap(journal_t *journal, unsigned long blocknr,
69118eba7aaSMingming Cao 		 unsigned long long *retp)
692470decc6SDave Kleikamp {
693470decc6SDave Kleikamp 	int err = 0;
69418eba7aaSMingming Cao 	unsigned long long ret;
695470decc6SDave Kleikamp 
696470decc6SDave Kleikamp 	if (journal->j_inode) {
697470decc6SDave Kleikamp 		ret = bmap(journal->j_inode, blocknr);
698470decc6SDave Kleikamp 		if (ret)
699470decc6SDave Kleikamp 			*retp = ret;
700470decc6SDave Kleikamp 		else {
701470decc6SDave Kleikamp 			printk(KERN_ALERT "%s: journal block not found "
702470decc6SDave Kleikamp 					"at offset %lu on %s\n",
70305496769STheodore Ts'o 			       __func__, blocknr, journal->j_devname);
704470decc6SDave Kleikamp 			err = -EIO;
705470decc6SDave Kleikamp 			__journal_abort_soft(journal, err);
706470decc6SDave Kleikamp 		}
707470decc6SDave Kleikamp 	} else {
708470decc6SDave Kleikamp 		*retp = blocknr; /* +journal->j_blk_offset */
709470decc6SDave Kleikamp 	}
710470decc6SDave Kleikamp 	return err;
711470decc6SDave Kleikamp }
712470decc6SDave Kleikamp 
713470decc6SDave Kleikamp /*
714470decc6SDave Kleikamp  * We play buffer_head aliasing tricks to write data/metadata blocks to
715470decc6SDave Kleikamp  * the journal without copying their contents, but for journal
716470decc6SDave Kleikamp  * descriptor blocks we do need to generate bona fide buffers.
717470decc6SDave Kleikamp  *
718f7f4bccbSMingming Cao  * After the caller of jbd2_journal_get_descriptor_buffer() has finished modifying
719470decc6SDave Kleikamp  * the buffer's contents they really should run flush_dcache_page(bh->b_page).
720470decc6SDave Kleikamp  * But we don't bother doing that, so there will be coherency problems with
721470decc6SDave Kleikamp  * mmaps of blockdevs which hold live JBD-controlled filesystems.
722470decc6SDave Kleikamp  */
723f7f4bccbSMingming Cao struct journal_head *jbd2_journal_get_descriptor_buffer(journal_t *journal)
724470decc6SDave Kleikamp {
725470decc6SDave Kleikamp 	struct buffer_head *bh;
72618eba7aaSMingming Cao 	unsigned long long blocknr;
727470decc6SDave Kleikamp 	int err;
728470decc6SDave Kleikamp 
729f7f4bccbSMingming Cao 	err = jbd2_journal_next_log_block(journal, &blocknr);
730470decc6SDave Kleikamp 
731470decc6SDave Kleikamp 	if (err)
732470decc6SDave Kleikamp 		return NULL;
733470decc6SDave Kleikamp 
734470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
7354b905671SJan Kara 	if (!bh)
7364b905671SJan Kara 		return NULL;
737470decc6SDave Kleikamp 	lock_buffer(bh);
738470decc6SDave Kleikamp 	memset(bh->b_data, 0, journal->j_blocksize);
739470decc6SDave Kleikamp 	set_buffer_uptodate(bh);
740470decc6SDave Kleikamp 	unlock_buffer(bh);
741470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "return this buffer");
742f7f4bccbSMingming Cao 	return jbd2_journal_add_journal_head(bh);
743470decc6SDave Kleikamp }
744470decc6SDave Kleikamp 
7458e85fb3fSJohann Lombardi struct jbd2_stats_proc_session {
7468e85fb3fSJohann Lombardi 	journal_t *journal;
7478e85fb3fSJohann Lombardi 	struct transaction_stats_s *stats;
7488e85fb3fSJohann Lombardi 	int start;
7498e85fb3fSJohann Lombardi 	int max;
7508e85fb3fSJohann Lombardi };
7518e85fb3fSJohann Lombardi 
7528e85fb3fSJohann Lombardi static void *jbd2_seq_info_start(struct seq_file *seq, loff_t *pos)
7538e85fb3fSJohann Lombardi {
7548e85fb3fSJohann Lombardi 	return *pos ? NULL : SEQ_START_TOKEN;
7558e85fb3fSJohann Lombardi }
7568e85fb3fSJohann Lombardi 
7578e85fb3fSJohann Lombardi static void *jbd2_seq_info_next(struct seq_file *seq, void *v, loff_t *pos)
7588e85fb3fSJohann Lombardi {
7598e85fb3fSJohann Lombardi 	return NULL;
7608e85fb3fSJohann Lombardi }
7618e85fb3fSJohann Lombardi 
7628e85fb3fSJohann Lombardi static int jbd2_seq_info_show(struct seq_file *seq, void *v)
7638e85fb3fSJohann Lombardi {
7648e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
7658e85fb3fSJohann Lombardi 
7668e85fb3fSJohann Lombardi 	if (v != SEQ_START_TOKEN)
7678e85fb3fSJohann Lombardi 		return 0;
7688e85fb3fSJohann Lombardi 	seq_printf(seq, "%lu transaction, each up to %u blocks\n",
7698e85fb3fSJohann Lombardi 			s->stats->ts_tid,
7708e85fb3fSJohann Lombardi 			s->journal->j_max_transaction_buffers);
7718e85fb3fSJohann Lombardi 	if (s->stats->ts_tid == 0)
7728e85fb3fSJohann Lombardi 		return 0;
7738e85fb3fSJohann Lombardi 	seq_printf(seq, "average: \n  %ums waiting for transaction\n",
774bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_wait / s->stats->ts_tid));
7758e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums running transaction\n",
776bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_running / s->stats->ts_tid));
7778e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums transaction was being locked\n",
778bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_locked / s->stats->ts_tid));
7798e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums flushing data (in ordered mode)\n",
780bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_flushing / s->stats->ts_tid));
7818e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums logging transaction\n",
782bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_logging / s->stats->ts_tid));
783c225aa57SSimon Holm Thøgersen 	seq_printf(seq, "  %lluus average transaction commit time\n",
784c225aa57SSimon Holm Thøgersen 		   div_u64(s->journal->j_average_commit_time, 1000));
7858e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu handles per transaction\n",
786bf699327STheodore Ts'o 	    s->stats->run.rs_handle_count / s->stats->ts_tid);
7878e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu blocks per transaction\n",
788bf699327STheodore Ts'o 	    s->stats->run.rs_blocks / s->stats->ts_tid);
7898e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu logged blocks per transaction\n",
790bf699327STheodore Ts'o 	    s->stats->run.rs_blocks_logged / s->stats->ts_tid);
7918e85fb3fSJohann Lombardi 	return 0;
7928e85fb3fSJohann Lombardi }
7938e85fb3fSJohann Lombardi 
7948e85fb3fSJohann Lombardi static void jbd2_seq_info_stop(struct seq_file *seq, void *v)
7958e85fb3fSJohann Lombardi {
7968e85fb3fSJohann Lombardi }
7978e85fb3fSJohann Lombardi 
79888e9d34cSJames Morris static const struct seq_operations jbd2_seq_info_ops = {
7998e85fb3fSJohann Lombardi 	.start  = jbd2_seq_info_start,
8008e85fb3fSJohann Lombardi 	.next   = jbd2_seq_info_next,
8018e85fb3fSJohann Lombardi 	.stop   = jbd2_seq_info_stop,
8028e85fb3fSJohann Lombardi 	.show   = jbd2_seq_info_show,
8038e85fb3fSJohann Lombardi };
8048e85fb3fSJohann Lombardi 
8058e85fb3fSJohann Lombardi static int jbd2_seq_info_open(struct inode *inode, struct file *file)
8068e85fb3fSJohann Lombardi {
8078e85fb3fSJohann Lombardi 	journal_t *journal = PDE(inode)->data;
8088e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s;
8098e85fb3fSJohann Lombardi 	int rc, size;
8108e85fb3fSJohann Lombardi 
8118e85fb3fSJohann Lombardi 	s = kmalloc(sizeof(*s), GFP_KERNEL);
8128e85fb3fSJohann Lombardi 	if (s == NULL)
8138e85fb3fSJohann Lombardi 		return -ENOMEM;
8148e85fb3fSJohann Lombardi 	size = sizeof(struct transaction_stats_s);
8158e85fb3fSJohann Lombardi 	s->stats = kmalloc(size, GFP_KERNEL);
8168e85fb3fSJohann Lombardi 	if (s->stats == NULL) {
8178e85fb3fSJohann Lombardi 		kfree(s);
8188e85fb3fSJohann Lombardi 		return -ENOMEM;
8198e85fb3fSJohann Lombardi 	}
8208e85fb3fSJohann Lombardi 	spin_lock(&journal->j_history_lock);
8218e85fb3fSJohann Lombardi 	memcpy(s->stats, &journal->j_stats, size);
8228e85fb3fSJohann Lombardi 	s->journal = journal;
8238e85fb3fSJohann Lombardi 	spin_unlock(&journal->j_history_lock);
8248e85fb3fSJohann Lombardi 
8258e85fb3fSJohann Lombardi 	rc = seq_open(file, &jbd2_seq_info_ops);
8268e85fb3fSJohann Lombardi 	if (rc == 0) {
8278e85fb3fSJohann Lombardi 		struct seq_file *m = file->private_data;
8288e85fb3fSJohann Lombardi 		m->private = s;
8298e85fb3fSJohann Lombardi 	} else {
8308e85fb3fSJohann Lombardi 		kfree(s->stats);
8318e85fb3fSJohann Lombardi 		kfree(s);
8328e85fb3fSJohann Lombardi 	}
8338e85fb3fSJohann Lombardi 	return rc;
8348e85fb3fSJohann Lombardi 
8358e85fb3fSJohann Lombardi }
8368e85fb3fSJohann Lombardi 
8378e85fb3fSJohann Lombardi static int jbd2_seq_info_release(struct inode *inode, struct file *file)
8388e85fb3fSJohann Lombardi {
8398e85fb3fSJohann Lombardi 	struct seq_file *seq = file->private_data;
8408e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
8418e85fb3fSJohann Lombardi 	kfree(s->stats);
8428e85fb3fSJohann Lombardi 	kfree(s);
8438e85fb3fSJohann Lombardi 	return seq_release(inode, file);
8448e85fb3fSJohann Lombardi }
8458e85fb3fSJohann Lombardi 
846828c0950SAlexey Dobriyan static const struct file_operations jbd2_seq_info_fops = {
8478e85fb3fSJohann Lombardi 	.owner		= THIS_MODULE,
8488e85fb3fSJohann Lombardi 	.open           = jbd2_seq_info_open,
8498e85fb3fSJohann Lombardi 	.read           = seq_read,
8508e85fb3fSJohann Lombardi 	.llseek         = seq_lseek,
8518e85fb3fSJohann Lombardi 	.release        = jbd2_seq_info_release,
8528e85fb3fSJohann Lombardi };
8538e85fb3fSJohann Lombardi 
8548e85fb3fSJohann Lombardi static struct proc_dir_entry *proc_jbd2_stats;
8558e85fb3fSJohann Lombardi 
8568e85fb3fSJohann Lombardi static void jbd2_stats_proc_init(journal_t *journal)
8578e85fb3fSJohann Lombardi {
85805496769STheodore Ts'o 	journal->j_proc_entry = proc_mkdir(journal->j_devname, proc_jbd2_stats);
8598e85fb3fSJohann Lombardi 	if (journal->j_proc_entry) {
86079da3664SDenis V. Lunev 		proc_create_data("info", S_IRUGO, journal->j_proc_entry,
86179da3664SDenis V. Lunev 				 &jbd2_seq_info_fops, journal);
8628e85fb3fSJohann Lombardi 	}
8638e85fb3fSJohann Lombardi }
8648e85fb3fSJohann Lombardi 
8658e85fb3fSJohann Lombardi static void jbd2_stats_proc_exit(journal_t *journal)
8668e85fb3fSJohann Lombardi {
8678e85fb3fSJohann Lombardi 	remove_proc_entry("info", journal->j_proc_entry);
86805496769STheodore Ts'o 	remove_proc_entry(journal->j_devname, proc_jbd2_stats);
8698e85fb3fSJohann Lombardi }
8708e85fb3fSJohann Lombardi 
871470decc6SDave Kleikamp /*
872470decc6SDave Kleikamp  * Management for journal control blocks: functions to create and
873470decc6SDave Kleikamp  * destroy journal_t structures, and to initialise and read existing
874470decc6SDave Kleikamp  * journal blocks from disk.  */
875470decc6SDave Kleikamp 
876470decc6SDave Kleikamp /* First: create and setup a journal_t object in memory.  We initialise
877470decc6SDave Kleikamp  * very few fields yet: that has to wait until we have created the
878470decc6SDave Kleikamp  * journal structures from from scratch, or loaded them from disk. */
879470decc6SDave Kleikamp 
880470decc6SDave Kleikamp static journal_t * journal_init_common (void)
881470decc6SDave Kleikamp {
882470decc6SDave Kleikamp 	journal_t *journal;
883470decc6SDave Kleikamp 	int err;
884470decc6SDave Kleikamp 
8853ebfdf88SAndrew Morton 	journal = kzalloc(sizeof(*journal), GFP_KERNEL);
886470decc6SDave Kleikamp 	if (!journal)
887b7271b0aSTheodore Ts'o 		return NULL;
888470decc6SDave Kleikamp 
889470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_transaction_locked);
890470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_logspace);
891470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_done_commit);
892470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_checkpoint);
893470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_commit);
894470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_updates);
895470decc6SDave Kleikamp 	mutex_init(&journal->j_barrier);
896470decc6SDave Kleikamp 	mutex_init(&journal->j_checkpoint_mutex);
897470decc6SDave Kleikamp 	spin_lock_init(&journal->j_revoke_lock);
898470decc6SDave Kleikamp 	spin_lock_init(&journal->j_list_lock);
899a931da6aSTheodore Ts'o 	rwlock_init(&journal->j_state_lock);
900470decc6SDave Kleikamp 
901cd02ff0bSMingming Cao 	journal->j_commit_interval = (HZ * JBD2_DEFAULT_MAX_COMMIT_AGE);
90230773840STheodore Ts'o 	journal->j_min_batch_time = 0;
90330773840STheodore Ts'o 	journal->j_max_batch_time = 15000; /* 15ms */
904470decc6SDave Kleikamp 
905470decc6SDave Kleikamp 	/* The journal is marked for error until we succeed with recovery! */
906f7f4bccbSMingming Cao 	journal->j_flags = JBD2_ABORT;
907470decc6SDave Kleikamp 
908470decc6SDave Kleikamp 	/* Set up a default-sized revoke table for the new mount. */
909f7f4bccbSMingming Cao 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
910470decc6SDave Kleikamp 	if (err) {
911470decc6SDave Kleikamp 		kfree(journal);
912b7271b0aSTheodore Ts'o 		return NULL;
913470decc6SDave Kleikamp 	}
9148e85fb3fSJohann Lombardi 
915bf699327STheodore Ts'o 	spin_lock_init(&journal->j_history_lock);
9168e85fb3fSJohann Lombardi 
917470decc6SDave Kleikamp 	return journal;
918470decc6SDave Kleikamp }
919470decc6SDave Kleikamp 
920f7f4bccbSMingming Cao /* jbd2_journal_init_dev and jbd2_journal_init_inode:
921470decc6SDave Kleikamp  *
922470decc6SDave Kleikamp  * Create a journal structure assigned some fixed set of disk blocks to
923470decc6SDave Kleikamp  * the journal.  We don't actually touch those disk blocks yet, but we
924470decc6SDave Kleikamp  * need to set up all of the mapping information to tell the journaling
925470decc6SDave Kleikamp  * system where the journal blocks are.
926470decc6SDave Kleikamp  *
927470decc6SDave Kleikamp  */
928470decc6SDave Kleikamp 
929470decc6SDave Kleikamp /**
9305648ba5bSRandy Dunlap  *  journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure
931470decc6SDave Kleikamp  *  @bdev: Block device on which to create the journal
932470decc6SDave Kleikamp  *  @fs_dev: Device which hold journalled filesystem for this journal.
933470decc6SDave Kleikamp  *  @start: Block nr Start of journal.
934470decc6SDave Kleikamp  *  @len:  Length of the journal in blocks.
935470decc6SDave Kleikamp  *  @blocksize: blocksize of journalling device
9365648ba5bSRandy Dunlap  *
9375648ba5bSRandy Dunlap  *  Returns: a newly created journal_t *
938470decc6SDave Kleikamp  *
939f7f4bccbSMingming Cao  *  jbd2_journal_init_dev creates a journal which maps a fixed contiguous
940470decc6SDave Kleikamp  *  range of blocks on an arbitrary block device.
941470decc6SDave Kleikamp  *
942470decc6SDave Kleikamp  */
943f7f4bccbSMingming Cao journal_t * jbd2_journal_init_dev(struct block_device *bdev,
944470decc6SDave Kleikamp 			struct block_device *fs_dev,
94518eba7aaSMingming Cao 			unsigned long long start, int len, int blocksize)
946470decc6SDave Kleikamp {
947470decc6SDave Kleikamp 	journal_t *journal = journal_init_common();
948470decc6SDave Kleikamp 	struct buffer_head *bh;
94905496769STheodore Ts'o 	char *p;
950470decc6SDave Kleikamp 	int n;
951470decc6SDave Kleikamp 
952470decc6SDave Kleikamp 	if (!journal)
953470decc6SDave Kleikamp 		return NULL;
954470decc6SDave Kleikamp 
955470decc6SDave Kleikamp 	/* journal descriptor can store up to n blocks -bzzz */
956470decc6SDave Kleikamp 	journal->j_blocksize = blocksize;
9570587aa3dSyangsheng 	journal->j_dev = bdev;
9580587aa3dSyangsheng 	journal->j_fs_dev = fs_dev;
9590587aa3dSyangsheng 	journal->j_blk_offset = start;
9600587aa3dSyangsheng 	journal->j_maxlen = len;
9610587aa3dSyangsheng 	bdevname(journal->j_dev, journal->j_devname);
9620587aa3dSyangsheng 	p = journal->j_devname;
9630587aa3dSyangsheng 	while ((p = strchr(p, '/')))
9640587aa3dSyangsheng 		*p = '!';
9654b905671SJan Kara 	jbd2_stats_proc_init(journal);
966470decc6SDave Kleikamp 	n = journal->j_blocksize / sizeof(journal_block_tag_t);
967470decc6SDave Kleikamp 	journal->j_wbufsize = n;
968470decc6SDave Kleikamp 	journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
969470decc6SDave Kleikamp 	if (!journal->j_wbuf) {
97025985edcSLucas De Marchi 		printk(KERN_ERR "%s: Can't allocate bhs for commit thread\n",
971329d291fSHarvey Harrison 			__func__);
9724b905671SJan Kara 		goto out_err;
973470decc6SDave Kleikamp 	}
974470decc6SDave Kleikamp 
975470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, start, journal->j_blocksize);
9764b905671SJan Kara 	if (!bh) {
9774b905671SJan Kara 		printk(KERN_ERR
9784b905671SJan Kara 		       "%s: Cannot get buffer for journal superblock\n",
9794b905671SJan Kara 		       __func__);
9804b905671SJan Kara 		goto out_err;
9814b905671SJan Kara 	}
982470decc6SDave Kleikamp 	journal->j_sb_buffer = bh;
983470decc6SDave Kleikamp 	journal->j_superblock = (journal_superblock_t *)bh->b_data;
9844b905671SJan Kara 
985470decc6SDave Kleikamp 	return journal;
9864b905671SJan Kara out_err:
9877b02bec0STao Ma 	kfree(journal->j_wbuf);
9884b905671SJan Kara 	jbd2_stats_proc_exit(journal);
9894b905671SJan Kara 	kfree(journal);
9904b905671SJan Kara 	return NULL;
991470decc6SDave Kleikamp }
992470decc6SDave Kleikamp 
993470decc6SDave Kleikamp /**
994f7f4bccbSMingming Cao  *  journal_t * jbd2_journal_init_inode () - creates a journal which maps to a inode.
995470decc6SDave Kleikamp  *  @inode: An inode to create the journal in
996470decc6SDave Kleikamp  *
997f7f4bccbSMingming Cao  * jbd2_journal_init_inode creates a journal which maps an on-disk inode as
998470decc6SDave Kleikamp  * the journal.  The inode must exist already, must support bmap() and
999470decc6SDave Kleikamp  * must have all data blocks preallocated.
1000470decc6SDave Kleikamp  */
1001f7f4bccbSMingming Cao journal_t * jbd2_journal_init_inode (struct inode *inode)
1002470decc6SDave Kleikamp {
1003470decc6SDave Kleikamp 	struct buffer_head *bh;
1004470decc6SDave Kleikamp 	journal_t *journal = journal_init_common();
100505496769STheodore Ts'o 	char *p;
1006470decc6SDave Kleikamp 	int err;
1007470decc6SDave Kleikamp 	int n;
100818eba7aaSMingming Cao 	unsigned long long blocknr;
1009470decc6SDave Kleikamp 
1010470decc6SDave Kleikamp 	if (!journal)
1011470decc6SDave Kleikamp 		return NULL;
1012470decc6SDave Kleikamp 
1013470decc6SDave Kleikamp 	journal->j_dev = journal->j_fs_dev = inode->i_sb->s_bdev;
1014470decc6SDave Kleikamp 	journal->j_inode = inode;
101505496769STheodore Ts'o 	bdevname(journal->j_dev, journal->j_devname);
101605496769STheodore Ts'o 	p = journal->j_devname;
101705496769STheodore Ts'o 	while ((p = strchr(p, '/')))
101805496769STheodore Ts'o 		*p = '!';
101905496769STheodore Ts'o 	p = journal->j_devname + strlen(journal->j_devname);
102090576c0bSTheodore Ts'o 	sprintf(p, "-%lu", journal->j_inode->i_ino);
1021470decc6SDave Kleikamp 	jbd_debug(1,
1022470decc6SDave Kleikamp 		  "journal %p: inode %s/%ld, size %Ld, bits %d, blksize %ld\n",
1023470decc6SDave Kleikamp 		  journal, inode->i_sb->s_id, inode->i_ino,
1024470decc6SDave Kleikamp 		  (long long) inode->i_size,
1025470decc6SDave Kleikamp 		  inode->i_sb->s_blocksize_bits, inode->i_sb->s_blocksize);
1026470decc6SDave Kleikamp 
1027470decc6SDave Kleikamp 	journal->j_maxlen = inode->i_size >> inode->i_sb->s_blocksize_bits;
1028470decc6SDave Kleikamp 	journal->j_blocksize = inode->i_sb->s_blocksize;
10298e85fb3fSJohann Lombardi 	jbd2_stats_proc_init(journal);
1030470decc6SDave Kleikamp 
1031470decc6SDave Kleikamp 	/* journal descriptor can store up to n blocks -bzzz */
1032470decc6SDave Kleikamp 	n = journal->j_blocksize / sizeof(journal_block_tag_t);
1033470decc6SDave Kleikamp 	journal->j_wbufsize = n;
1034470decc6SDave Kleikamp 	journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
1035470decc6SDave Kleikamp 	if (!journal->j_wbuf) {
103625985edcSLucas De Marchi 		printk(KERN_ERR "%s: Can't allocate bhs for commit thread\n",
1037329d291fSHarvey Harrison 			__func__);
10384b905671SJan Kara 		goto out_err;
1039470decc6SDave Kleikamp 	}
1040470decc6SDave Kleikamp 
1041f7f4bccbSMingming Cao 	err = jbd2_journal_bmap(journal, 0, &blocknr);
1042470decc6SDave Kleikamp 	/* If that failed, give up */
1043470decc6SDave Kleikamp 	if (err) {
10443c26bdb4SJustin P. Mattock 		printk(KERN_ERR "%s: Cannot locate journal superblock\n",
1045329d291fSHarvey Harrison 		       __func__);
10464b905671SJan Kara 		goto out_err;
1047470decc6SDave Kleikamp 	}
1048470decc6SDave Kleikamp 
1049470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
10504b905671SJan Kara 	if (!bh) {
10514b905671SJan Kara 		printk(KERN_ERR
10524b905671SJan Kara 		       "%s: Cannot get buffer for journal superblock\n",
10534b905671SJan Kara 		       __func__);
10544b905671SJan Kara 		goto out_err;
10554b905671SJan Kara 	}
1056470decc6SDave Kleikamp 	journal->j_sb_buffer = bh;
1057470decc6SDave Kleikamp 	journal->j_superblock = (journal_superblock_t *)bh->b_data;
1058470decc6SDave Kleikamp 
1059470decc6SDave Kleikamp 	return journal;
10604b905671SJan Kara out_err:
10617b02bec0STao Ma 	kfree(journal->j_wbuf);
10624b905671SJan Kara 	jbd2_stats_proc_exit(journal);
10634b905671SJan Kara 	kfree(journal);
10644b905671SJan Kara 	return NULL;
1065470decc6SDave Kleikamp }
1066470decc6SDave Kleikamp 
1067470decc6SDave Kleikamp /*
1068470decc6SDave Kleikamp  * If the journal init or create aborts, we need to mark the journal
1069470decc6SDave Kleikamp  * superblock as being NULL to prevent the journal destroy from writing
1070470decc6SDave Kleikamp  * back a bogus superblock.
1071470decc6SDave Kleikamp  */
1072470decc6SDave Kleikamp static void journal_fail_superblock (journal_t *journal)
1073470decc6SDave Kleikamp {
1074470decc6SDave Kleikamp 	struct buffer_head *bh = journal->j_sb_buffer;
1075470decc6SDave Kleikamp 	brelse(bh);
1076470decc6SDave Kleikamp 	journal->j_sb_buffer = NULL;
1077470decc6SDave Kleikamp }
1078470decc6SDave Kleikamp 
1079470decc6SDave Kleikamp /*
1080470decc6SDave Kleikamp  * Given a journal_t structure, initialise the various fields for
1081470decc6SDave Kleikamp  * startup of a new journaling session.  We use this both when creating
1082470decc6SDave Kleikamp  * a journal, and after recovering an old journal to reset it for
1083470decc6SDave Kleikamp  * subsequent use.
1084470decc6SDave Kleikamp  */
1085470decc6SDave Kleikamp 
1086470decc6SDave Kleikamp static int journal_reset(journal_t *journal)
1087470decc6SDave Kleikamp {
1088470decc6SDave Kleikamp 	journal_superblock_t *sb = journal->j_superblock;
108918eba7aaSMingming Cao 	unsigned long long first, last;
1090470decc6SDave Kleikamp 
1091470decc6SDave Kleikamp 	first = be32_to_cpu(sb->s_first);
1092470decc6SDave Kleikamp 	last = be32_to_cpu(sb->s_maxlen);
1093f6f50e28SJan Kara 	if (first + JBD2_MIN_JOURNAL_BLOCKS > last + 1) {
1094f2a44523SEryu Guan 		printk(KERN_ERR "JBD2: Journal too short (blocks %llu-%llu).\n",
1095f6f50e28SJan Kara 		       first, last);
1096f6f50e28SJan Kara 		journal_fail_superblock(journal);
1097f6f50e28SJan Kara 		return -EINVAL;
1098f6f50e28SJan Kara 	}
1099470decc6SDave Kleikamp 
1100470decc6SDave Kleikamp 	journal->j_first = first;
1101470decc6SDave Kleikamp 	journal->j_last = last;
1102470decc6SDave Kleikamp 
1103470decc6SDave Kleikamp 	journal->j_head = first;
1104470decc6SDave Kleikamp 	journal->j_tail = first;
1105470decc6SDave Kleikamp 	journal->j_free = last - first;
1106470decc6SDave Kleikamp 
1107470decc6SDave Kleikamp 	journal->j_tail_sequence = journal->j_transaction_sequence;
1108470decc6SDave Kleikamp 	journal->j_commit_sequence = journal->j_transaction_sequence - 1;
1109470decc6SDave Kleikamp 	journal->j_commit_request = journal->j_commit_sequence;
1110470decc6SDave Kleikamp 
1111470decc6SDave Kleikamp 	journal->j_max_transaction_buffers = journal->j_maxlen / 4;
1112470decc6SDave Kleikamp 
1113470decc6SDave Kleikamp 	/*
1114470decc6SDave Kleikamp 	 * As a special case, if the on-disk copy is already marked as needing
111524bcc89cSJan Kara 	 * no recovery (s_start == 0), then we can safely defer the superblock
111624bcc89cSJan Kara 	 * update until the next commit by setting JBD2_FLUSHED.  This avoids
1117470decc6SDave Kleikamp 	 * attempting a write to a potential-readonly device.
1118470decc6SDave Kleikamp 	 */
111924bcc89cSJan Kara 	if (sb->s_start == 0) {
1120f2a44523SEryu Guan 		jbd_debug(1, "JBD2: Skipping superblock update on recovered sb "
1121470decc6SDave Kleikamp 			"(start %ld, seq %d, errno %d)\n",
1122470decc6SDave Kleikamp 			journal->j_tail, journal->j_tail_sequence,
1123470decc6SDave Kleikamp 			journal->j_errno);
112424bcc89cSJan Kara 		journal->j_flags |= JBD2_FLUSHED;
112524bcc89cSJan Kara 	} else {
1126a78bb11dSJan Kara 		/* Lock here to make assertions happy... */
1127a78bb11dSJan Kara 		mutex_lock(&journal->j_checkpoint_mutex);
112824bcc89cSJan Kara 		/* Add the dynamic fields and write it to disk. */
112924bcc89cSJan Kara 		jbd2_journal_update_sb_log_tail(journal);
1130a78bb11dSJan Kara 		mutex_unlock(&journal->j_checkpoint_mutex);
113124bcc89cSJan Kara 	}
113224bcc89cSJan Kara 	return jbd2_journal_start_thread(journal);
1133470decc6SDave Kleikamp }
1134470decc6SDave Kleikamp 
113524bcc89cSJan Kara static void jbd2_write_superblock(journal_t *journal)
113624bcc89cSJan Kara {
113724bcc89cSJan Kara 	struct buffer_head *bh = journal->j_sb_buffer;
113824bcc89cSJan Kara 
113924bcc89cSJan Kara 	trace_jbd2_write_superblock(journal);
1140914258bfSTheodore Ts'o 	if (buffer_write_io_error(bh)) {
1141914258bfSTheodore Ts'o 		/*
1142914258bfSTheodore Ts'o 		 * Oh, dear.  A previous attempt to write the journal
1143914258bfSTheodore Ts'o 		 * superblock failed.  This could happen because the
1144914258bfSTheodore Ts'o 		 * USB device was yanked out.  Or it could happen to
1145914258bfSTheodore Ts'o 		 * be a transient write error and maybe the block will
1146914258bfSTheodore Ts'o 		 * be remapped.  Nothing we can do but to retry the
1147914258bfSTheodore Ts'o 		 * write and hope for the best.
1148914258bfSTheodore Ts'o 		 */
1149914258bfSTheodore Ts'o 		printk(KERN_ERR "JBD2: previous I/O error detected "
1150914258bfSTheodore Ts'o 		       "for journal superblock update for %s.\n",
1151914258bfSTheodore Ts'o 		       journal->j_devname);
1152914258bfSTheodore Ts'o 		clear_buffer_write_io_error(bh);
1153914258bfSTheodore Ts'o 		set_buffer_uptodate(bh);
1154914258bfSTheodore Ts'o 	}
1155914258bfSTheodore Ts'o 
1156470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "marking dirty");
1157470decc6SDave Kleikamp 	mark_buffer_dirty(bh);
1158470decc6SDave Kleikamp 	sync_dirty_buffer(bh);
1159914258bfSTheodore Ts'o 	if (buffer_write_io_error(bh)) {
1160914258bfSTheodore Ts'o 		printk(KERN_ERR "JBD2: I/O error detected "
1161914258bfSTheodore Ts'o 		       "when updating journal superblock for %s.\n",
1162914258bfSTheodore Ts'o 		       journal->j_devname);
1163914258bfSTheodore Ts'o 		clear_buffer_write_io_error(bh);
1164914258bfSTheodore Ts'o 		set_buffer_uptodate(bh);
1165914258bfSTheodore Ts'o 	}
116624bcc89cSJan Kara }
1167470decc6SDave Kleikamp 
116824bcc89cSJan Kara /**
116924bcc89cSJan Kara  * jbd2_journal_update_sb_log_tail() - Update log tail in journal sb on disk.
117024bcc89cSJan Kara  * @journal: The journal to update.
117124bcc89cSJan Kara  *
117224bcc89cSJan Kara  * Update a journal's superblock information about log tail and write it to
117324bcc89cSJan Kara  * disk, waiting for the IO to complete.
117424bcc89cSJan Kara  */
117524bcc89cSJan Kara void jbd2_journal_update_sb_log_tail(journal_t *journal)
117624bcc89cSJan Kara {
117724bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
11782201c590SSeiji Aguchi 
1179a78bb11dSJan Kara 	BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
118024bcc89cSJan Kara 	read_lock(&journal->j_state_lock);
118124bcc89cSJan Kara 	jbd_debug(1, "JBD2: updating superblock (start %ld, seq %d)\n",
118224bcc89cSJan Kara 		  journal->j_tail, journal->j_tail_sequence);
1183470decc6SDave Kleikamp 
118424bcc89cSJan Kara 	sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
118524bcc89cSJan Kara 	sb->s_start    = cpu_to_be32(journal->j_tail);
118624bcc89cSJan Kara 	read_unlock(&journal->j_state_lock);
118724bcc89cSJan Kara 
118824bcc89cSJan Kara 	jbd2_write_superblock(journal);
118924bcc89cSJan Kara 
119024bcc89cSJan Kara 	/* Log is no longer empty */
1191a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
119224bcc89cSJan Kara 	WARN_ON(!sb->s_sequence);
1193f7f4bccbSMingming Cao 	journal->j_flags &= ~JBD2_FLUSHED;
119424bcc89cSJan Kara 	write_unlock(&journal->j_state_lock);
119524bcc89cSJan Kara }
119624bcc89cSJan Kara 
119724bcc89cSJan Kara /**
119824bcc89cSJan Kara  * jbd2_mark_journal_empty() - Mark on disk journal as empty.
119924bcc89cSJan Kara  * @journal: The journal to update.
120024bcc89cSJan Kara  *
120124bcc89cSJan Kara  * Update a journal's dynamic superblock fields to show that journal is empty.
120224bcc89cSJan Kara  * Write updated superblock to disk waiting for IO to complete.
120324bcc89cSJan Kara  */
120424bcc89cSJan Kara static void jbd2_mark_journal_empty(journal_t *journal)
120524bcc89cSJan Kara {
120624bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
120724bcc89cSJan Kara 
1208a78bb11dSJan Kara 	BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
120924bcc89cSJan Kara 	read_lock(&journal->j_state_lock);
121024bcc89cSJan Kara 	jbd_debug(1, "JBD2: Marking journal as empty (seq %d)\n",
121124bcc89cSJan Kara 		  journal->j_tail_sequence);
121224bcc89cSJan Kara 
121324bcc89cSJan Kara 	sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
121424bcc89cSJan Kara 	sb->s_start    = cpu_to_be32(0);
121524bcc89cSJan Kara 	read_unlock(&journal->j_state_lock);
121624bcc89cSJan Kara 
121724bcc89cSJan Kara 	jbd2_write_superblock(journal);
121824bcc89cSJan Kara 
121924bcc89cSJan Kara 	/* Log is no longer empty */
122024bcc89cSJan Kara 	write_lock(&journal->j_state_lock);
1221f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_FLUSHED;
1222a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
1223470decc6SDave Kleikamp }
1224470decc6SDave Kleikamp 
122524bcc89cSJan Kara 
122624bcc89cSJan Kara /**
122724bcc89cSJan Kara  * jbd2_journal_update_sb_errno() - Update error in the journal.
122824bcc89cSJan Kara  * @journal: The journal to update.
122924bcc89cSJan Kara  *
123024bcc89cSJan Kara  * Update a journal's errno.  Write updated superblock to disk waiting for IO
123124bcc89cSJan Kara  * to complete.
123224bcc89cSJan Kara  */
123324bcc89cSJan Kara static void jbd2_journal_update_sb_errno(journal_t *journal)
123424bcc89cSJan Kara {
123524bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
123624bcc89cSJan Kara 
123724bcc89cSJan Kara 	read_lock(&journal->j_state_lock);
123824bcc89cSJan Kara 	jbd_debug(1, "JBD2: updating superblock error (errno %d)\n",
123924bcc89cSJan Kara 		  journal->j_errno);
124024bcc89cSJan Kara 	sb->s_errno    = cpu_to_be32(journal->j_errno);
124124bcc89cSJan Kara 	read_unlock(&journal->j_state_lock);
124224bcc89cSJan Kara 
124324bcc89cSJan Kara 	jbd2_write_superblock(journal);
124424bcc89cSJan Kara }
124524bcc89cSJan Kara 
1246470decc6SDave Kleikamp /*
1247470decc6SDave Kleikamp  * Read the superblock for a given journal, performing initial
1248470decc6SDave Kleikamp  * validation of the format.
1249470decc6SDave Kleikamp  */
1250470decc6SDave Kleikamp static int journal_get_superblock(journal_t *journal)
1251470decc6SDave Kleikamp {
1252470decc6SDave Kleikamp 	struct buffer_head *bh;
1253470decc6SDave Kleikamp 	journal_superblock_t *sb;
1254470decc6SDave Kleikamp 	int err = -EIO;
1255470decc6SDave Kleikamp 
1256470decc6SDave Kleikamp 	bh = journal->j_sb_buffer;
1257470decc6SDave Kleikamp 
1258470decc6SDave Kleikamp 	J_ASSERT(bh != NULL);
1259470decc6SDave Kleikamp 	if (!buffer_uptodate(bh)) {
1260470decc6SDave Kleikamp 		ll_rw_block(READ, 1, &bh);
1261470decc6SDave Kleikamp 		wait_on_buffer(bh);
1262470decc6SDave Kleikamp 		if (!buffer_uptodate(bh)) {
1263470decc6SDave Kleikamp 			printk(KERN_ERR
1264f2a44523SEryu Guan 				"JBD2: IO error reading journal superblock\n");
1265470decc6SDave Kleikamp 			goto out;
1266470decc6SDave Kleikamp 		}
1267470decc6SDave Kleikamp 	}
1268470decc6SDave Kleikamp 
1269470decc6SDave Kleikamp 	sb = journal->j_superblock;
1270470decc6SDave Kleikamp 
1271470decc6SDave Kleikamp 	err = -EINVAL;
1272470decc6SDave Kleikamp 
1273f7f4bccbSMingming Cao 	if (sb->s_header.h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER) ||
1274470decc6SDave Kleikamp 	    sb->s_blocksize != cpu_to_be32(journal->j_blocksize)) {
1275f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: no valid journal superblock found\n");
1276470decc6SDave Kleikamp 		goto out;
1277470decc6SDave Kleikamp 	}
1278470decc6SDave Kleikamp 
1279470decc6SDave Kleikamp 	switch(be32_to_cpu(sb->s_header.h_blocktype)) {
1280f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V1:
1281470decc6SDave Kleikamp 		journal->j_format_version = 1;
1282470decc6SDave Kleikamp 		break;
1283f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V2:
1284470decc6SDave Kleikamp 		journal->j_format_version = 2;
1285470decc6SDave Kleikamp 		break;
1286470decc6SDave Kleikamp 	default:
1287f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: unrecognised superblock format ID\n");
1288470decc6SDave Kleikamp 		goto out;
1289470decc6SDave Kleikamp 	}
1290470decc6SDave Kleikamp 
1291470decc6SDave Kleikamp 	if (be32_to_cpu(sb->s_maxlen) < journal->j_maxlen)
1292470decc6SDave Kleikamp 		journal->j_maxlen = be32_to_cpu(sb->s_maxlen);
1293470decc6SDave Kleikamp 	else if (be32_to_cpu(sb->s_maxlen) > journal->j_maxlen) {
1294f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: journal file too short\n");
1295470decc6SDave Kleikamp 		goto out;
1296470decc6SDave Kleikamp 	}
1297470decc6SDave Kleikamp 
12988762202dSEryu Guan 	if (be32_to_cpu(sb->s_first) == 0 ||
12998762202dSEryu Guan 	    be32_to_cpu(sb->s_first) >= journal->j_maxlen) {
13008762202dSEryu Guan 		printk(KERN_WARNING
13018762202dSEryu Guan 			"JBD2: Invalid start block of journal: %u\n",
13028762202dSEryu Guan 			be32_to_cpu(sb->s_first));
13038762202dSEryu Guan 		goto out;
13048762202dSEryu Guan 	}
13058762202dSEryu Guan 
1306470decc6SDave Kleikamp 	return 0;
1307470decc6SDave Kleikamp 
1308470decc6SDave Kleikamp out:
1309470decc6SDave Kleikamp 	journal_fail_superblock(journal);
1310470decc6SDave Kleikamp 	return err;
1311470decc6SDave Kleikamp }
1312470decc6SDave Kleikamp 
1313470decc6SDave Kleikamp /*
1314470decc6SDave Kleikamp  * Load the on-disk journal superblock and read the key fields into the
1315470decc6SDave Kleikamp  * journal_t.
1316470decc6SDave Kleikamp  */
1317470decc6SDave Kleikamp 
1318470decc6SDave Kleikamp static int load_superblock(journal_t *journal)
1319470decc6SDave Kleikamp {
1320470decc6SDave Kleikamp 	int err;
1321470decc6SDave Kleikamp 	journal_superblock_t *sb;
1322470decc6SDave Kleikamp 
1323470decc6SDave Kleikamp 	err = journal_get_superblock(journal);
1324470decc6SDave Kleikamp 	if (err)
1325470decc6SDave Kleikamp 		return err;
1326470decc6SDave Kleikamp 
1327470decc6SDave Kleikamp 	sb = journal->j_superblock;
1328470decc6SDave Kleikamp 
1329470decc6SDave Kleikamp 	journal->j_tail_sequence = be32_to_cpu(sb->s_sequence);
1330470decc6SDave Kleikamp 	journal->j_tail = be32_to_cpu(sb->s_start);
1331470decc6SDave Kleikamp 	journal->j_first = be32_to_cpu(sb->s_first);
1332470decc6SDave Kleikamp 	journal->j_last = be32_to_cpu(sb->s_maxlen);
1333470decc6SDave Kleikamp 	journal->j_errno = be32_to_cpu(sb->s_errno);
1334470decc6SDave Kleikamp 
1335470decc6SDave Kleikamp 	return 0;
1336470decc6SDave Kleikamp }
1337470decc6SDave Kleikamp 
1338470decc6SDave Kleikamp 
1339470decc6SDave Kleikamp /**
1340f7f4bccbSMingming Cao  * int jbd2_journal_load() - Read journal from disk.
1341470decc6SDave Kleikamp  * @journal: Journal to act on.
1342470decc6SDave Kleikamp  *
1343470decc6SDave Kleikamp  * Given a journal_t structure which tells us which disk blocks contain
1344470decc6SDave Kleikamp  * a journal, read the journal from disk to initialise the in-memory
1345470decc6SDave Kleikamp  * structures.
1346470decc6SDave Kleikamp  */
1347f7f4bccbSMingming Cao int jbd2_journal_load(journal_t *journal)
1348470decc6SDave Kleikamp {
1349470decc6SDave Kleikamp 	int err;
1350470decc6SDave Kleikamp 	journal_superblock_t *sb;
1351470decc6SDave Kleikamp 
1352470decc6SDave Kleikamp 	err = load_superblock(journal);
1353470decc6SDave Kleikamp 	if (err)
1354470decc6SDave Kleikamp 		return err;
1355470decc6SDave Kleikamp 
1356470decc6SDave Kleikamp 	sb = journal->j_superblock;
1357470decc6SDave Kleikamp 	/* If this is a V2 superblock, then we have to check the
1358470decc6SDave Kleikamp 	 * features flags on it. */
1359470decc6SDave Kleikamp 
1360470decc6SDave Kleikamp 	if (journal->j_format_version >= 2) {
1361470decc6SDave Kleikamp 		if ((sb->s_feature_ro_compat &
1362f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_ROCOMPAT_FEATURES)) ||
1363470decc6SDave Kleikamp 		    (sb->s_feature_incompat &
1364f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_INCOMPAT_FEATURES))) {
1365470decc6SDave Kleikamp 			printk(KERN_WARNING
1366f2a44523SEryu Guan 				"JBD2: Unrecognised features on journal\n");
1367470decc6SDave Kleikamp 			return -EINVAL;
1368470decc6SDave Kleikamp 		}
1369470decc6SDave Kleikamp 	}
1370470decc6SDave Kleikamp 
1371d2eecb03STheodore Ts'o 	/*
1372d2eecb03STheodore Ts'o 	 * Create a slab for this blocksize
1373d2eecb03STheodore Ts'o 	 */
1374d2eecb03STheodore Ts'o 	err = jbd2_journal_create_slab(be32_to_cpu(sb->s_blocksize));
1375d2eecb03STheodore Ts'o 	if (err)
1376d2eecb03STheodore Ts'o 		return err;
1377d2eecb03STheodore Ts'o 
1378470decc6SDave Kleikamp 	/* Let the recovery code check whether it needs to recover any
1379470decc6SDave Kleikamp 	 * data from the journal. */
1380f7f4bccbSMingming Cao 	if (jbd2_journal_recover(journal))
1381470decc6SDave Kleikamp 		goto recovery_error;
1382470decc6SDave Kleikamp 
1383e6a47428STheodore Ts'o 	if (journal->j_failed_commit) {
1384e6a47428STheodore Ts'o 		printk(KERN_ERR "JBD2: journal transaction %u on %s "
1385e6a47428STheodore Ts'o 		       "is corrupt.\n", journal->j_failed_commit,
1386e6a47428STheodore Ts'o 		       journal->j_devname);
1387e6a47428STheodore Ts'o 		return -EIO;
1388e6a47428STheodore Ts'o 	}
1389e6a47428STheodore Ts'o 
1390470decc6SDave Kleikamp 	/* OK, we've finished with the dynamic journal bits:
1391470decc6SDave Kleikamp 	 * reinitialise the dynamic contents of the superblock in memory
1392470decc6SDave Kleikamp 	 * and reset them on disk. */
1393470decc6SDave Kleikamp 	if (journal_reset(journal))
1394470decc6SDave Kleikamp 		goto recovery_error;
1395470decc6SDave Kleikamp 
1396f7f4bccbSMingming Cao 	journal->j_flags &= ~JBD2_ABORT;
1397f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_LOADED;
1398470decc6SDave Kleikamp 	return 0;
1399470decc6SDave Kleikamp 
1400470decc6SDave Kleikamp recovery_error:
1401f2a44523SEryu Guan 	printk(KERN_WARNING "JBD2: recovery failed\n");
1402470decc6SDave Kleikamp 	return -EIO;
1403470decc6SDave Kleikamp }
1404470decc6SDave Kleikamp 
1405470decc6SDave Kleikamp /**
1406f7f4bccbSMingming Cao  * void jbd2_journal_destroy() - Release a journal_t structure.
1407470decc6SDave Kleikamp  * @journal: Journal to act on.
1408470decc6SDave Kleikamp  *
1409470decc6SDave Kleikamp  * Release a journal_t structure once it is no longer in use by the
1410470decc6SDave Kleikamp  * journaled object.
141144519fafSHidehiro Kawai  * Return <0 if we couldn't clean up the journal.
1412470decc6SDave Kleikamp  */
141344519fafSHidehiro Kawai int jbd2_journal_destroy(journal_t *journal)
1414470decc6SDave Kleikamp {
141544519fafSHidehiro Kawai 	int err = 0;
141644519fafSHidehiro Kawai 
1417470decc6SDave Kleikamp 	/* Wait for the commit thread to wake up and die. */
1418470decc6SDave Kleikamp 	journal_kill_thread(journal);
1419470decc6SDave Kleikamp 
1420470decc6SDave Kleikamp 	/* Force a final log commit */
1421470decc6SDave Kleikamp 	if (journal->j_running_transaction)
1422f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
1423470decc6SDave Kleikamp 
1424470decc6SDave Kleikamp 	/* Force any old transactions to disk */
1425470decc6SDave Kleikamp 
1426470decc6SDave Kleikamp 	/* Totally anal locking here... */
1427470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
1428470decc6SDave Kleikamp 	while (journal->j_checkpoint_transactions != NULL) {
1429470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
14301a0d3786STheodore Ts'o 		mutex_lock(&journal->j_checkpoint_mutex);
1431f7f4bccbSMingming Cao 		jbd2_log_do_checkpoint(journal);
14321a0d3786STheodore Ts'o 		mutex_unlock(&journal->j_checkpoint_mutex);
1433470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
1434470decc6SDave Kleikamp 	}
1435470decc6SDave Kleikamp 
1436470decc6SDave Kleikamp 	J_ASSERT(journal->j_running_transaction == NULL);
1437470decc6SDave Kleikamp 	J_ASSERT(journal->j_committing_transaction == NULL);
1438470decc6SDave Kleikamp 	J_ASSERT(journal->j_checkpoint_transactions == NULL);
1439470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
1440470decc6SDave Kleikamp 
144144519fafSHidehiro Kawai 	if (journal->j_sb_buffer) {
1442a78bb11dSJan Kara 		if (!is_journal_aborted(journal)) {
1443a78bb11dSJan Kara 			mutex_lock(&journal->j_checkpoint_mutex);
144424bcc89cSJan Kara 			jbd2_mark_journal_empty(journal);
1445a78bb11dSJan Kara 			mutex_unlock(&journal->j_checkpoint_mutex);
1446a78bb11dSJan Kara 		} else
144744519fafSHidehiro Kawai 			err = -EIO;
1448470decc6SDave Kleikamp 		brelse(journal->j_sb_buffer);
1449470decc6SDave Kleikamp 	}
1450470decc6SDave Kleikamp 
14518e85fb3fSJohann Lombardi 	if (journal->j_proc_entry)
14528e85fb3fSJohann Lombardi 		jbd2_stats_proc_exit(journal);
1453470decc6SDave Kleikamp 	if (journal->j_inode)
1454470decc6SDave Kleikamp 		iput(journal->j_inode);
1455470decc6SDave Kleikamp 	if (journal->j_revoke)
1456f7f4bccbSMingming Cao 		jbd2_journal_destroy_revoke(journal);
1457470decc6SDave Kleikamp 	kfree(journal->j_wbuf);
1458470decc6SDave Kleikamp 	kfree(journal);
145944519fafSHidehiro Kawai 
146044519fafSHidehiro Kawai 	return err;
1461470decc6SDave Kleikamp }
1462470decc6SDave Kleikamp 
1463470decc6SDave Kleikamp 
1464470decc6SDave Kleikamp /**
1465f7f4bccbSMingming Cao  *int jbd2_journal_check_used_features () - Check if features specified are used.
1466470decc6SDave Kleikamp  * @journal: Journal to check.
1467470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1468470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1469470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1470470decc6SDave Kleikamp  *
1471470decc6SDave Kleikamp  * Check whether the journal uses all of a given set of
1472470decc6SDave Kleikamp  * features.  Return true (non-zero) if it does.
1473470decc6SDave Kleikamp  **/
1474470decc6SDave Kleikamp 
1475f7f4bccbSMingming Cao int jbd2_journal_check_used_features (journal_t *journal, unsigned long compat,
1476470decc6SDave Kleikamp 				 unsigned long ro, unsigned long incompat)
1477470decc6SDave Kleikamp {
1478470decc6SDave Kleikamp 	journal_superblock_t *sb;
1479470decc6SDave Kleikamp 
1480470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
1481470decc6SDave Kleikamp 		return 1;
14821113e1b5SPatrick J. LoPresti 	/* Load journal superblock if it is not loaded yet. */
14831113e1b5SPatrick J. LoPresti 	if (journal->j_format_version == 0 &&
14841113e1b5SPatrick J. LoPresti 	    journal_get_superblock(journal) != 0)
14851113e1b5SPatrick J. LoPresti 		return 0;
1486470decc6SDave Kleikamp 	if (journal->j_format_version == 1)
1487470decc6SDave Kleikamp 		return 0;
1488470decc6SDave Kleikamp 
1489470decc6SDave Kleikamp 	sb = journal->j_superblock;
1490470decc6SDave Kleikamp 
1491470decc6SDave Kleikamp 	if (((be32_to_cpu(sb->s_feature_compat) & compat) == compat) &&
1492470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_ro_compat) & ro) == ro) &&
1493470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_incompat) & incompat) == incompat))
1494470decc6SDave Kleikamp 		return 1;
1495470decc6SDave Kleikamp 
1496470decc6SDave Kleikamp 	return 0;
1497470decc6SDave Kleikamp }
1498470decc6SDave Kleikamp 
1499470decc6SDave Kleikamp /**
1500f7f4bccbSMingming Cao  * int jbd2_journal_check_available_features() - Check feature set in journalling layer
1501470decc6SDave Kleikamp  * @journal: Journal to check.
1502470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1503470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1504470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1505470decc6SDave Kleikamp  *
1506470decc6SDave Kleikamp  * Check whether the journaling code supports the use of
1507470decc6SDave Kleikamp  * all of a given set of features on this journal.  Return true
1508470decc6SDave Kleikamp  * (non-zero) if it can. */
1509470decc6SDave Kleikamp 
1510f7f4bccbSMingming Cao int jbd2_journal_check_available_features (journal_t *journal, unsigned long compat,
1511470decc6SDave Kleikamp 				      unsigned long ro, unsigned long incompat)
1512470decc6SDave Kleikamp {
1513470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
1514470decc6SDave Kleikamp 		return 1;
1515470decc6SDave Kleikamp 
1516470decc6SDave Kleikamp 	/* We can support any known requested features iff the
1517470decc6SDave Kleikamp 	 * superblock is in version 2.  Otherwise we fail to support any
1518470decc6SDave Kleikamp 	 * extended sb features. */
1519470decc6SDave Kleikamp 
1520470decc6SDave Kleikamp 	if (journal->j_format_version != 2)
1521470decc6SDave Kleikamp 		return 0;
1522470decc6SDave Kleikamp 
1523f7f4bccbSMingming Cao 	if ((compat   & JBD2_KNOWN_COMPAT_FEATURES) == compat &&
1524f7f4bccbSMingming Cao 	    (ro       & JBD2_KNOWN_ROCOMPAT_FEATURES) == ro &&
1525f7f4bccbSMingming Cao 	    (incompat & JBD2_KNOWN_INCOMPAT_FEATURES) == incompat)
1526470decc6SDave Kleikamp 		return 1;
1527470decc6SDave Kleikamp 
1528470decc6SDave Kleikamp 	return 0;
1529470decc6SDave Kleikamp }
1530470decc6SDave Kleikamp 
1531470decc6SDave Kleikamp /**
1532f7f4bccbSMingming Cao  * int jbd2_journal_set_features () - Mark a given journal feature in the superblock
1533470decc6SDave Kleikamp  * @journal: Journal to act on.
1534470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1535470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1536470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1537470decc6SDave Kleikamp  *
1538470decc6SDave Kleikamp  * Mark a given journal feature as present on the
1539470decc6SDave Kleikamp  * superblock.  Returns true if the requested features could be set.
1540470decc6SDave Kleikamp  *
1541470decc6SDave Kleikamp  */
1542470decc6SDave Kleikamp 
1543f7f4bccbSMingming Cao int jbd2_journal_set_features (journal_t *journal, unsigned long compat,
1544470decc6SDave Kleikamp 			  unsigned long ro, unsigned long incompat)
1545470decc6SDave Kleikamp {
1546470decc6SDave Kleikamp 	journal_superblock_t *sb;
1547470decc6SDave Kleikamp 
1548f7f4bccbSMingming Cao 	if (jbd2_journal_check_used_features(journal, compat, ro, incompat))
1549470decc6SDave Kleikamp 		return 1;
1550470decc6SDave Kleikamp 
1551f7f4bccbSMingming Cao 	if (!jbd2_journal_check_available_features(journal, compat, ro, incompat))
1552470decc6SDave Kleikamp 		return 0;
1553470decc6SDave Kleikamp 
1554470decc6SDave Kleikamp 	jbd_debug(1, "Setting new features 0x%lx/0x%lx/0x%lx\n",
1555470decc6SDave Kleikamp 		  compat, ro, incompat);
1556470decc6SDave Kleikamp 
1557470decc6SDave Kleikamp 	sb = journal->j_superblock;
1558470decc6SDave Kleikamp 
1559470decc6SDave Kleikamp 	sb->s_feature_compat    |= cpu_to_be32(compat);
1560470decc6SDave Kleikamp 	sb->s_feature_ro_compat |= cpu_to_be32(ro);
1561470decc6SDave Kleikamp 	sb->s_feature_incompat  |= cpu_to_be32(incompat);
1562470decc6SDave Kleikamp 
1563470decc6SDave Kleikamp 	return 1;
1564470decc6SDave Kleikamp }
1565470decc6SDave Kleikamp 
1566818d276cSGirish Shilamkar /*
1567818d276cSGirish Shilamkar  * jbd2_journal_clear_features () - Clear a given journal feature in the
1568818d276cSGirish Shilamkar  * 				    superblock
1569818d276cSGirish Shilamkar  * @journal: Journal to act on.
1570818d276cSGirish Shilamkar  * @compat: bitmask of compatible features
1571818d276cSGirish Shilamkar  * @ro: bitmask of features that force read-only mount
1572818d276cSGirish Shilamkar  * @incompat: bitmask of incompatible features
1573818d276cSGirish Shilamkar  *
1574818d276cSGirish Shilamkar  * Clear a given journal feature as present on the
1575818d276cSGirish Shilamkar  * superblock.
1576818d276cSGirish Shilamkar  */
1577818d276cSGirish Shilamkar void jbd2_journal_clear_features(journal_t *journal, unsigned long compat,
1578818d276cSGirish Shilamkar 				unsigned long ro, unsigned long incompat)
1579818d276cSGirish Shilamkar {
1580818d276cSGirish Shilamkar 	journal_superblock_t *sb;
1581818d276cSGirish Shilamkar 
1582818d276cSGirish Shilamkar 	jbd_debug(1, "Clear features 0x%lx/0x%lx/0x%lx\n",
1583818d276cSGirish Shilamkar 		  compat, ro, incompat);
1584818d276cSGirish Shilamkar 
1585818d276cSGirish Shilamkar 	sb = journal->j_superblock;
1586818d276cSGirish Shilamkar 
1587818d276cSGirish Shilamkar 	sb->s_feature_compat    &= ~cpu_to_be32(compat);
1588818d276cSGirish Shilamkar 	sb->s_feature_ro_compat &= ~cpu_to_be32(ro);
1589818d276cSGirish Shilamkar 	sb->s_feature_incompat  &= ~cpu_to_be32(incompat);
1590818d276cSGirish Shilamkar }
1591818d276cSGirish Shilamkar EXPORT_SYMBOL(jbd2_journal_clear_features);
1592470decc6SDave Kleikamp 
1593470decc6SDave Kleikamp /**
1594f7f4bccbSMingming Cao  * int jbd2_journal_flush () - Flush journal
1595470decc6SDave Kleikamp  * @journal: Journal to act on.
1596470decc6SDave Kleikamp  *
1597470decc6SDave Kleikamp  * Flush all data for a given journal to disk and empty the journal.
1598470decc6SDave Kleikamp  * Filesystems can use this when remounting readonly to ensure that
1599470decc6SDave Kleikamp  * recovery does not need to happen on remount.
1600470decc6SDave Kleikamp  */
1601470decc6SDave Kleikamp 
1602f7f4bccbSMingming Cao int jbd2_journal_flush(journal_t *journal)
1603470decc6SDave Kleikamp {
1604470decc6SDave Kleikamp 	int err = 0;
1605470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
1606470decc6SDave Kleikamp 
1607a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
1608470decc6SDave Kleikamp 
1609470decc6SDave Kleikamp 	/* Force everything buffered to the log... */
1610470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
1611470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
1612f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
1613470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
1614470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
1615470decc6SDave Kleikamp 
1616470decc6SDave Kleikamp 	/* Wait for the log commit to complete... */
1617470decc6SDave Kleikamp 	if (transaction) {
1618470decc6SDave Kleikamp 		tid_t tid = transaction->t_tid;
1619470decc6SDave Kleikamp 
1620a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
1621f7f4bccbSMingming Cao 		jbd2_log_wait_commit(journal, tid);
1622470decc6SDave Kleikamp 	} else {
1623a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
1624470decc6SDave Kleikamp 	}
1625470decc6SDave Kleikamp 
1626470decc6SDave Kleikamp 	/* ...and flush everything in the log out to disk. */
1627470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
1628470decc6SDave Kleikamp 	while (!err && journal->j_checkpoint_transactions != NULL) {
1629470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
163044519fafSHidehiro Kawai 		mutex_lock(&journal->j_checkpoint_mutex);
1631f7f4bccbSMingming Cao 		err = jbd2_log_do_checkpoint(journal);
163244519fafSHidehiro Kawai 		mutex_unlock(&journal->j_checkpoint_mutex);
1633470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
1634470decc6SDave Kleikamp 	}
1635470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
163644519fafSHidehiro Kawai 
163744519fafSHidehiro Kawai 	if (is_journal_aborted(journal))
163844519fafSHidehiro Kawai 		return -EIO;
163944519fafSHidehiro Kawai 
1640a78bb11dSJan Kara 	mutex_lock(&journal->j_checkpoint_mutex);
1641f7f4bccbSMingming Cao 	jbd2_cleanup_journal_tail(journal);
1642470decc6SDave Kleikamp 
1643470decc6SDave Kleikamp 	/* Finally, mark the journal as really needing no recovery.
1644470decc6SDave Kleikamp 	 * This sets s_start==0 in the underlying superblock, which is
1645470decc6SDave Kleikamp 	 * the magic code for a fully-recovered superblock.  Any future
1646470decc6SDave Kleikamp 	 * commits of data to the journal will restore the current
1647470decc6SDave Kleikamp 	 * s_start value. */
164824bcc89cSJan Kara 	jbd2_mark_journal_empty(journal);
1649a78bb11dSJan Kara 	mutex_unlock(&journal->j_checkpoint_mutex);
1650a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
1651470decc6SDave Kleikamp 	J_ASSERT(!journal->j_running_transaction);
1652470decc6SDave Kleikamp 	J_ASSERT(!journal->j_committing_transaction);
1653470decc6SDave Kleikamp 	J_ASSERT(!journal->j_checkpoint_transactions);
1654470decc6SDave Kleikamp 	J_ASSERT(journal->j_head == journal->j_tail);
1655470decc6SDave Kleikamp 	J_ASSERT(journal->j_tail_sequence == journal->j_transaction_sequence);
1656a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
165744519fafSHidehiro Kawai 	return 0;
1658470decc6SDave Kleikamp }
1659470decc6SDave Kleikamp 
1660470decc6SDave Kleikamp /**
1661f7f4bccbSMingming Cao  * int jbd2_journal_wipe() - Wipe journal contents
1662470decc6SDave Kleikamp  * @journal: Journal to act on.
1663470decc6SDave Kleikamp  * @write: flag (see below)
1664470decc6SDave Kleikamp  *
1665470decc6SDave Kleikamp  * Wipe out all of the contents of a journal, safely.  This will produce
1666470decc6SDave Kleikamp  * a warning if the journal contains any valid recovery information.
1667f7f4bccbSMingming Cao  * Must be called between journal_init_*() and jbd2_journal_load().
1668470decc6SDave Kleikamp  *
1669470decc6SDave Kleikamp  * If 'write' is non-zero, then we wipe out the journal on disk; otherwise
1670470decc6SDave Kleikamp  * we merely suppress recovery.
1671470decc6SDave Kleikamp  */
1672470decc6SDave Kleikamp 
1673f7f4bccbSMingming Cao int jbd2_journal_wipe(journal_t *journal, int write)
1674470decc6SDave Kleikamp {
1675470decc6SDave Kleikamp 	int err = 0;
1676470decc6SDave Kleikamp 
1677f7f4bccbSMingming Cao 	J_ASSERT (!(journal->j_flags & JBD2_LOADED));
1678470decc6SDave Kleikamp 
1679470decc6SDave Kleikamp 	err = load_superblock(journal);
1680470decc6SDave Kleikamp 	if (err)
1681470decc6SDave Kleikamp 		return err;
1682470decc6SDave Kleikamp 
1683470decc6SDave Kleikamp 	if (!journal->j_tail)
1684470decc6SDave Kleikamp 		goto no_recovery;
1685470decc6SDave Kleikamp 
1686f2a44523SEryu Guan 	printk(KERN_WARNING "JBD2: %s recovery information on journal\n",
1687470decc6SDave Kleikamp 		write ? "Clearing" : "Ignoring");
1688470decc6SDave Kleikamp 
1689f7f4bccbSMingming Cao 	err = jbd2_journal_skip_recovery(journal);
1690a78bb11dSJan Kara 	if (write) {
1691a78bb11dSJan Kara 		/* Lock to make assertions happy... */
1692a78bb11dSJan Kara 		mutex_lock(&journal->j_checkpoint_mutex);
169324bcc89cSJan Kara 		jbd2_mark_journal_empty(journal);
1694a78bb11dSJan Kara 		mutex_unlock(&journal->j_checkpoint_mutex);
1695a78bb11dSJan Kara 	}
1696470decc6SDave Kleikamp 
1697470decc6SDave Kleikamp  no_recovery:
1698470decc6SDave Kleikamp 	return err;
1699470decc6SDave Kleikamp }
1700470decc6SDave Kleikamp 
1701470decc6SDave Kleikamp /*
1702470decc6SDave Kleikamp  * Journal abort has very specific semantics, which we describe
1703470decc6SDave Kleikamp  * for journal abort.
1704470decc6SDave Kleikamp  *
1705bfcd3555SAlberto Bertogli  * Two internal functions, which provide abort to the jbd layer
1706470decc6SDave Kleikamp  * itself are here.
1707470decc6SDave Kleikamp  */
1708470decc6SDave Kleikamp 
1709470decc6SDave Kleikamp /*
1710470decc6SDave Kleikamp  * Quick version for internal journal use (doesn't lock the journal).
1711470decc6SDave Kleikamp  * Aborts hard --- we mark the abort as occurred, but do _nothing_ else,
1712470decc6SDave Kleikamp  * and don't attempt to make any other journal updates.
1713470decc6SDave Kleikamp  */
1714f7f4bccbSMingming Cao void __jbd2_journal_abort_hard(journal_t *journal)
1715470decc6SDave Kleikamp {
1716470decc6SDave Kleikamp 	transaction_t *transaction;
1717470decc6SDave Kleikamp 
1718f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1719470decc6SDave Kleikamp 		return;
1720470decc6SDave Kleikamp 
1721470decc6SDave Kleikamp 	printk(KERN_ERR "Aborting journal on device %s.\n",
172205496769STheodore Ts'o 	       journal->j_devname);
1723470decc6SDave Kleikamp 
1724a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
1725f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_ABORT;
1726470decc6SDave Kleikamp 	transaction = journal->j_running_transaction;
1727470decc6SDave Kleikamp 	if (transaction)
1728f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
1729a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
1730470decc6SDave Kleikamp }
1731470decc6SDave Kleikamp 
1732470decc6SDave Kleikamp /* Soft abort: record the abort error status in the journal superblock,
1733470decc6SDave Kleikamp  * but don't do any other IO. */
1734470decc6SDave Kleikamp static void __journal_abort_soft (journal_t *journal, int errno)
1735470decc6SDave Kleikamp {
1736f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1737470decc6SDave Kleikamp 		return;
1738470decc6SDave Kleikamp 
1739470decc6SDave Kleikamp 	if (!journal->j_errno)
1740470decc6SDave Kleikamp 		journal->j_errno = errno;
1741470decc6SDave Kleikamp 
1742f7f4bccbSMingming Cao 	__jbd2_journal_abort_hard(journal);
1743470decc6SDave Kleikamp 
1744470decc6SDave Kleikamp 	if (errno)
174524bcc89cSJan Kara 		jbd2_journal_update_sb_errno(journal);
1746470decc6SDave Kleikamp }
1747470decc6SDave Kleikamp 
1748470decc6SDave Kleikamp /**
1749f7f4bccbSMingming Cao  * void jbd2_journal_abort () - Shutdown the journal immediately.
1750470decc6SDave Kleikamp  * @journal: the journal to shutdown.
1751470decc6SDave Kleikamp  * @errno:   an error number to record in the journal indicating
1752470decc6SDave Kleikamp  *           the reason for the shutdown.
1753470decc6SDave Kleikamp  *
1754470decc6SDave Kleikamp  * Perform a complete, immediate shutdown of the ENTIRE
1755470decc6SDave Kleikamp  * journal (not of a single transaction).  This operation cannot be
1756470decc6SDave Kleikamp  * undone without closing and reopening the journal.
1757470decc6SDave Kleikamp  *
1758f7f4bccbSMingming Cao  * The jbd2_journal_abort function is intended to support higher level error
1759470decc6SDave Kleikamp  * recovery mechanisms such as the ext2/ext3 remount-readonly error
1760470decc6SDave Kleikamp  * mode.
1761470decc6SDave Kleikamp  *
1762470decc6SDave Kleikamp  * Journal abort has very specific semantics.  Any existing dirty,
1763470decc6SDave Kleikamp  * unjournaled buffers in the main filesystem will still be written to
1764470decc6SDave Kleikamp  * disk by bdflush, but the journaling mechanism will be suspended
1765470decc6SDave Kleikamp  * immediately and no further transaction commits will be honoured.
1766470decc6SDave Kleikamp  *
1767470decc6SDave Kleikamp  * Any dirty, journaled buffers will be written back to disk without
1768470decc6SDave Kleikamp  * hitting the journal.  Atomicity cannot be guaranteed on an aborted
1769470decc6SDave Kleikamp  * filesystem, but we _do_ attempt to leave as much data as possible
1770470decc6SDave Kleikamp  * behind for fsck to use for cleanup.
1771470decc6SDave Kleikamp  *
1772470decc6SDave Kleikamp  * Any attempt to get a new transaction handle on a journal which is in
1773470decc6SDave Kleikamp  * ABORT state will just result in an -EROFS error return.  A
1774f7f4bccbSMingming Cao  * jbd2_journal_stop on an existing handle will return -EIO if we have
1775470decc6SDave Kleikamp  * entered abort state during the update.
1776470decc6SDave Kleikamp  *
1777470decc6SDave Kleikamp  * Recursive transactions are not disturbed by journal abort until the
1778f7f4bccbSMingming Cao  * final jbd2_journal_stop, which will receive the -EIO error.
1779470decc6SDave Kleikamp  *
1780f7f4bccbSMingming Cao  * Finally, the jbd2_journal_abort call allows the caller to supply an errno
1781470decc6SDave Kleikamp  * which will be recorded (if possible) in the journal superblock.  This
1782470decc6SDave Kleikamp  * allows a client to record failure conditions in the middle of a
1783470decc6SDave Kleikamp  * transaction without having to complete the transaction to record the
1784470decc6SDave Kleikamp  * failure to disk.  ext3_error, for example, now uses this
1785470decc6SDave Kleikamp  * functionality.
1786470decc6SDave Kleikamp  *
1787470decc6SDave Kleikamp  * Errors which originate from within the journaling layer will NOT
1788470decc6SDave Kleikamp  * supply an errno; a null errno implies that absolutely no further
1789470decc6SDave Kleikamp  * writes are done to the journal (unless there are any already in
1790470decc6SDave Kleikamp  * progress).
1791470decc6SDave Kleikamp  *
1792470decc6SDave Kleikamp  */
1793470decc6SDave Kleikamp 
1794f7f4bccbSMingming Cao void jbd2_journal_abort(journal_t *journal, int errno)
1795470decc6SDave Kleikamp {
1796470decc6SDave Kleikamp 	__journal_abort_soft(journal, errno);
1797470decc6SDave Kleikamp }
1798470decc6SDave Kleikamp 
1799470decc6SDave Kleikamp /**
1800f7f4bccbSMingming Cao  * int jbd2_journal_errno () - returns the journal's error state.
1801470decc6SDave Kleikamp  * @journal: journal to examine.
1802470decc6SDave Kleikamp  *
1803bfcd3555SAlberto Bertogli  * This is the errno number set with jbd2_journal_abort(), the last
1804470decc6SDave Kleikamp  * time the journal was mounted - if the journal was stopped
1805470decc6SDave Kleikamp  * without calling abort this will be 0.
1806470decc6SDave Kleikamp  *
1807470decc6SDave Kleikamp  * If the journal has been aborted on this mount time -EROFS will
1808470decc6SDave Kleikamp  * be returned.
1809470decc6SDave Kleikamp  */
1810f7f4bccbSMingming Cao int jbd2_journal_errno(journal_t *journal)
1811470decc6SDave Kleikamp {
1812470decc6SDave Kleikamp 	int err;
1813470decc6SDave Kleikamp 
1814a931da6aSTheodore Ts'o 	read_lock(&journal->j_state_lock);
1815f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1816470decc6SDave Kleikamp 		err = -EROFS;
1817470decc6SDave Kleikamp 	else
1818470decc6SDave Kleikamp 		err = journal->j_errno;
1819a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
1820470decc6SDave Kleikamp 	return err;
1821470decc6SDave Kleikamp }
1822470decc6SDave Kleikamp 
1823470decc6SDave Kleikamp /**
1824f7f4bccbSMingming Cao  * int jbd2_journal_clear_err () - clears the journal's error state
1825470decc6SDave Kleikamp  * @journal: journal to act on.
1826470decc6SDave Kleikamp  *
1827bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
1828470decc6SDave Kleikamp  * mode.
1829470decc6SDave Kleikamp  */
1830f7f4bccbSMingming Cao int jbd2_journal_clear_err(journal_t *journal)
1831470decc6SDave Kleikamp {
1832470decc6SDave Kleikamp 	int err = 0;
1833470decc6SDave Kleikamp 
1834a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
1835f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1836470decc6SDave Kleikamp 		err = -EROFS;
1837470decc6SDave Kleikamp 	else
1838470decc6SDave Kleikamp 		journal->j_errno = 0;
1839a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
1840470decc6SDave Kleikamp 	return err;
1841470decc6SDave Kleikamp }
1842470decc6SDave Kleikamp 
1843470decc6SDave Kleikamp /**
1844f7f4bccbSMingming Cao  * void jbd2_journal_ack_err() - Ack journal err.
1845470decc6SDave Kleikamp  * @journal: journal to act on.
1846470decc6SDave Kleikamp  *
1847bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
1848470decc6SDave Kleikamp  * mode.
1849470decc6SDave Kleikamp  */
1850f7f4bccbSMingming Cao void jbd2_journal_ack_err(journal_t *journal)
1851470decc6SDave Kleikamp {
1852a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
1853470decc6SDave Kleikamp 	if (journal->j_errno)
1854f7f4bccbSMingming Cao 		journal->j_flags |= JBD2_ACK_ERR;
1855a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
1856470decc6SDave Kleikamp }
1857470decc6SDave Kleikamp 
1858f7f4bccbSMingming Cao int jbd2_journal_blocks_per_page(struct inode *inode)
1859470decc6SDave Kleikamp {
1860470decc6SDave Kleikamp 	return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits);
1861470decc6SDave Kleikamp }
1862470decc6SDave Kleikamp 
1863470decc6SDave Kleikamp /*
1864b517bea1SZach Brown  * helper functions to deal with 32 or 64bit block numbers.
1865b517bea1SZach Brown  */
1866b517bea1SZach Brown size_t journal_tag_bytes(journal_t *journal)
1867b517bea1SZach Brown {
1868b517bea1SZach Brown 	if (JBD2_HAS_INCOMPAT_FEATURE(journal, JBD2_FEATURE_INCOMPAT_64BIT))
1869cd02ff0bSMingming Cao 		return JBD2_TAG_SIZE64;
1870b517bea1SZach Brown 	else
1871cd02ff0bSMingming Cao 		return JBD2_TAG_SIZE32;
1872b517bea1SZach Brown }
1873b517bea1SZach Brown 
1874b517bea1SZach Brown /*
1875d2eecb03STheodore Ts'o  * JBD memory management
1876d2eecb03STheodore Ts'o  *
1877d2eecb03STheodore Ts'o  * These functions are used to allocate block-sized chunks of memory
1878d2eecb03STheodore Ts'o  * used for making copies of buffer_head data.  Very often it will be
1879d2eecb03STheodore Ts'o  * page-sized chunks of data, but sometimes it will be in
1880d2eecb03STheodore Ts'o  * sub-page-size chunks.  (For example, 16k pages on Power systems
1881d2eecb03STheodore Ts'o  * with a 4k block file system.)  For blocks smaller than a page, we
1882d2eecb03STheodore Ts'o  * use a SLAB allocator.  There are slab caches for each block size,
1883d2eecb03STheodore Ts'o  * which are allocated at mount time, if necessary, and we only free
1884d2eecb03STheodore Ts'o  * (all of) the slab caches when/if the jbd2 module is unloaded.  For
1885d2eecb03STheodore Ts'o  * this reason we don't need to a mutex to protect access to
1886d2eecb03STheodore Ts'o  * jbd2_slab[] allocating or releasing memory; only in
1887d2eecb03STheodore Ts'o  * jbd2_journal_create_slab().
1888d2eecb03STheodore Ts'o  */
1889d2eecb03STheodore Ts'o #define JBD2_MAX_SLABS 8
1890d2eecb03STheodore Ts'o static struct kmem_cache *jbd2_slab[JBD2_MAX_SLABS];
1891d2eecb03STheodore Ts'o 
1892d2eecb03STheodore Ts'o static const char *jbd2_slab_names[JBD2_MAX_SLABS] = {
1893d2eecb03STheodore Ts'o 	"jbd2_1k", "jbd2_2k", "jbd2_4k", "jbd2_8k",
1894d2eecb03STheodore Ts'o 	"jbd2_16k", "jbd2_32k", "jbd2_64k", "jbd2_128k"
1895d2eecb03STheodore Ts'o };
1896d2eecb03STheodore Ts'o 
1897d2eecb03STheodore Ts'o 
1898d2eecb03STheodore Ts'o static void jbd2_journal_destroy_slabs(void)
1899d2eecb03STheodore Ts'o {
1900d2eecb03STheodore Ts'o 	int i;
1901d2eecb03STheodore Ts'o 
1902d2eecb03STheodore Ts'o 	for (i = 0; i < JBD2_MAX_SLABS; i++) {
1903d2eecb03STheodore Ts'o 		if (jbd2_slab[i])
1904d2eecb03STheodore Ts'o 			kmem_cache_destroy(jbd2_slab[i]);
1905d2eecb03STheodore Ts'o 		jbd2_slab[i] = NULL;
1906d2eecb03STheodore Ts'o 	}
1907d2eecb03STheodore Ts'o }
1908d2eecb03STheodore Ts'o 
1909d2eecb03STheodore Ts'o static int jbd2_journal_create_slab(size_t size)
1910d2eecb03STheodore Ts'o {
191151dfacdeSThomas Gleixner 	static DEFINE_MUTEX(jbd2_slab_create_mutex);
1912d2eecb03STheodore Ts'o 	int i = order_base_2(size) - 10;
1913d2eecb03STheodore Ts'o 	size_t slab_size;
1914d2eecb03STheodore Ts'o 
1915d2eecb03STheodore Ts'o 	if (size == PAGE_SIZE)
1916d2eecb03STheodore Ts'o 		return 0;
1917d2eecb03STheodore Ts'o 
1918d2eecb03STheodore Ts'o 	if (i >= JBD2_MAX_SLABS)
1919d2eecb03STheodore Ts'o 		return -EINVAL;
1920d2eecb03STheodore Ts'o 
1921d2eecb03STheodore Ts'o 	if (unlikely(i < 0))
1922d2eecb03STheodore Ts'o 		i = 0;
192351dfacdeSThomas Gleixner 	mutex_lock(&jbd2_slab_create_mutex);
1924d2eecb03STheodore Ts'o 	if (jbd2_slab[i]) {
192551dfacdeSThomas Gleixner 		mutex_unlock(&jbd2_slab_create_mutex);
1926d2eecb03STheodore Ts'o 		return 0;	/* Already created */
1927d2eecb03STheodore Ts'o 	}
1928d2eecb03STheodore Ts'o 
1929d2eecb03STheodore Ts'o 	slab_size = 1 << (i+10);
1930d2eecb03STheodore Ts'o 	jbd2_slab[i] = kmem_cache_create(jbd2_slab_names[i], slab_size,
1931d2eecb03STheodore Ts'o 					 slab_size, 0, NULL);
193251dfacdeSThomas Gleixner 	mutex_unlock(&jbd2_slab_create_mutex);
1933d2eecb03STheodore Ts'o 	if (!jbd2_slab[i]) {
1934d2eecb03STheodore Ts'o 		printk(KERN_EMERG "JBD2: no memory for jbd2_slab cache\n");
1935d2eecb03STheodore Ts'o 		return -ENOMEM;
1936d2eecb03STheodore Ts'o 	}
1937d2eecb03STheodore Ts'o 	return 0;
1938d2eecb03STheodore Ts'o }
1939d2eecb03STheodore Ts'o 
1940d2eecb03STheodore Ts'o static struct kmem_cache *get_slab(size_t size)
1941d2eecb03STheodore Ts'o {
1942d2eecb03STheodore Ts'o 	int i = order_base_2(size) - 10;
1943d2eecb03STheodore Ts'o 
1944d2eecb03STheodore Ts'o 	BUG_ON(i >= JBD2_MAX_SLABS);
1945d2eecb03STheodore Ts'o 	if (unlikely(i < 0))
1946d2eecb03STheodore Ts'o 		i = 0;
19478ac97b74SBill Pemberton 	BUG_ON(jbd2_slab[i] == NULL);
1948d2eecb03STheodore Ts'o 	return jbd2_slab[i];
1949d2eecb03STheodore Ts'o }
1950d2eecb03STheodore Ts'o 
1951d2eecb03STheodore Ts'o void *jbd2_alloc(size_t size, gfp_t flags)
1952d2eecb03STheodore Ts'o {
1953d2eecb03STheodore Ts'o 	void *ptr;
1954d2eecb03STheodore Ts'o 
1955d2eecb03STheodore Ts'o 	BUG_ON(size & (size-1)); /* Must be a power of 2 */
1956d2eecb03STheodore Ts'o 
1957d2eecb03STheodore Ts'o 	flags |= __GFP_REPEAT;
1958d2eecb03STheodore Ts'o 	if (size == PAGE_SIZE)
1959d2eecb03STheodore Ts'o 		ptr = (void *)__get_free_pages(flags, 0);
1960d2eecb03STheodore Ts'o 	else if (size > PAGE_SIZE) {
1961d2eecb03STheodore Ts'o 		int order = get_order(size);
1962d2eecb03STheodore Ts'o 
1963d2eecb03STheodore Ts'o 		if (order < 3)
1964d2eecb03STheodore Ts'o 			ptr = (void *)__get_free_pages(flags, order);
1965d2eecb03STheodore Ts'o 		else
1966d2eecb03STheodore Ts'o 			ptr = vmalloc(size);
1967d2eecb03STheodore Ts'o 	} else
1968d2eecb03STheodore Ts'o 		ptr = kmem_cache_alloc(get_slab(size), flags);
1969d2eecb03STheodore Ts'o 
1970d2eecb03STheodore Ts'o 	/* Check alignment; SLUB has gotten this wrong in the past,
1971d2eecb03STheodore Ts'o 	 * and this can lead to user data corruption! */
1972d2eecb03STheodore Ts'o 	BUG_ON(((unsigned long) ptr) & (size-1));
1973d2eecb03STheodore Ts'o 
1974d2eecb03STheodore Ts'o 	return ptr;
1975d2eecb03STheodore Ts'o }
1976d2eecb03STheodore Ts'o 
1977d2eecb03STheodore Ts'o void jbd2_free(void *ptr, size_t size)
1978d2eecb03STheodore Ts'o {
1979d2eecb03STheodore Ts'o 	if (size == PAGE_SIZE) {
1980d2eecb03STheodore Ts'o 		free_pages((unsigned long)ptr, 0);
1981d2eecb03STheodore Ts'o 		return;
1982d2eecb03STheodore Ts'o 	}
1983d2eecb03STheodore Ts'o 	if (size > PAGE_SIZE) {
1984d2eecb03STheodore Ts'o 		int order = get_order(size);
1985d2eecb03STheodore Ts'o 
1986d2eecb03STheodore Ts'o 		if (order < 3)
1987d2eecb03STheodore Ts'o 			free_pages((unsigned long)ptr, order);
1988d2eecb03STheodore Ts'o 		else
1989d2eecb03STheodore Ts'o 			vfree(ptr);
1990d2eecb03STheodore Ts'o 		return;
1991d2eecb03STheodore Ts'o 	}
1992d2eecb03STheodore Ts'o 	kmem_cache_free(get_slab(size), ptr);
1993d2eecb03STheodore Ts'o };
1994d2eecb03STheodore Ts'o 
1995d2eecb03STheodore Ts'o /*
1996470decc6SDave Kleikamp  * Journal_head storage management
1997470decc6SDave Kleikamp  */
1998e18b890bSChristoph Lameter static struct kmem_cache *jbd2_journal_head_cache;
1999e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2000470decc6SDave Kleikamp static atomic_t nr_journal_heads = ATOMIC_INIT(0);
2001470decc6SDave Kleikamp #endif
2002470decc6SDave Kleikamp 
20034185a2acSYongqiang Yang static int jbd2_journal_init_journal_head_cache(void)
2004470decc6SDave Kleikamp {
2005470decc6SDave Kleikamp 	int retval;
2006470decc6SDave Kleikamp 
20071076d17aSAl Viro 	J_ASSERT(jbd2_journal_head_cache == NULL);
2008a920e941SJohann Lombardi 	jbd2_journal_head_cache = kmem_cache_create("jbd2_journal_head",
2009470decc6SDave Kleikamp 				sizeof(struct journal_head),
2010470decc6SDave Kleikamp 				0,		/* offset */
201177160957SMingming Cao 				SLAB_TEMPORARY,	/* flags */
201220c2df83SPaul Mundt 				NULL);		/* ctor */
2013470decc6SDave Kleikamp 	retval = 0;
20141076d17aSAl Viro 	if (!jbd2_journal_head_cache) {
2015470decc6SDave Kleikamp 		retval = -ENOMEM;
2016f2a44523SEryu Guan 		printk(KERN_EMERG "JBD2: no memory for journal_head cache\n");
2017470decc6SDave Kleikamp 	}
2018470decc6SDave Kleikamp 	return retval;
2019470decc6SDave Kleikamp }
2020470decc6SDave Kleikamp 
20214185a2acSYongqiang Yang static void jbd2_journal_destroy_journal_head_cache(void)
2022470decc6SDave Kleikamp {
20238a9362ebSDuane Griffin 	if (jbd2_journal_head_cache) {
2024f7f4bccbSMingming Cao 		kmem_cache_destroy(jbd2_journal_head_cache);
2025f7f4bccbSMingming Cao 		jbd2_journal_head_cache = NULL;
2026470decc6SDave Kleikamp 	}
20278a9362ebSDuane Griffin }
2028470decc6SDave Kleikamp 
2029470decc6SDave Kleikamp /*
2030470decc6SDave Kleikamp  * journal_head splicing and dicing
2031470decc6SDave Kleikamp  */
2032470decc6SDave Kleikamp static struct journal_head *journal_alloc_journal_head(void)
2033470decc6SDave Kleikamp {
2034470decc6SDave Kleikamp 	struct journal_head *ret;
2035470decc6SDave Kleikamp 
2036e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2037470decc6SDave Kleikamp 	atomic_inc(&nr_journal_heads);
2038470decc6SDave Kleikamp #endif
2039f7f4bccbSMingming Cao 	ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
20401076d17aSAl Viro 	if (!ret) {
2041470decc6SDave Kleikamp 		jbd_debug(1, "out of memory for journal_head\n");
2042670be5a7STheodore Ts'o 		pr_notice_ratelimited("ENOMEM in %s, retrying.\n", __func__);
20431076d17aSAl Viro 		while (!ret) {
2044470decc6SDave Kleikamp 			yield();
2045f7f4bccbSMingming Cao 			ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
2046470decc6SDave Kleikamp 		}
2047470decc6SDave Kleikamp 	}
2048470decc6SDave Kleikamp 	return ret;
2049470decc6SDave Kleikamp }
2050470decc6SDave Kleikamp 
2051470decc6SDave Kleikamp static void journal_free_journal_head(struct journal_head *jh)
2052470decc6SDave Kleikamp {
2053e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2054470decc6SDave Kleikamp 	atomic_dec(&nr_journal_heads);
2055cd02ff0bSMingming Cao 	memset(jh, JBD2_POISON_FREE, sizeof(*jh));
2056470decc6SDave Kleikamp #endif
2057f7f4bccbSMingming Cao 	kmem_cache_free(jbd2_journal_head_cache, jh);
2058470decc6SDave Kleikamp }
2059470decc6SDave Kleikamp 
2060470decc6SDave Kleikamp /*
2061470decc6SDave Kleikamp  * A journal_head is attached to a buffer_head whenever JBD has an
2062470decc6SDave Kleikamp  * interest in the buffer.
2063470decc6SDave Kleikamp  *
2064470decc6SDave Kleikamp  * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
2065470decc6SDave Kleikamp  * is set.  This bit is tested in core kernel code where we need to take
2066470decc6SDave Kleikamp  * JBD-specific actions.  Testing the zeroness of ->b_private is not reliable
2067470decc6SDave Kleikamp  * there.
2068470decc6SDave Kleikamp  *
2069470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
2070470decc6SDave Kleikamp  *
2071470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set it is immune from being released by
2072470decc6SDave Kleikamp  * core kernel code, mainly via ->b_count.
2073470decc6SDave Kleikamp  *
2074de1b7941SJan Kara  * A journal_head is detached from its buffer_head when the journal_head's
2075de1b7941SJan Kara  * b_jcount reaches zero. Running transaction (b_transaction) and checkpoint
2076de1b7941SJan Kara  * transaction (b_cp_transaction) hold their references to b_jcount.
2077470decc6SDave Kleikamp  *
2078470decc6SDave Kleikamp  * Various places in the kernel want to attach a journal_head to a buffer_head
2079470decc6SDave Kleikamp  * _before_ attaching the journal_head to a transaction.  To protect the
2080f7f4bccbSMingming Cao  * journal_head in this situation, jbd2_journal_add_journal_head elevates the
2081470decc6SDave Kleikamp  * journal_head's b_jcount refcount by one.  The caller must call
2082f7f4bccbSMingming Cao  * jbd2_journal_put_journal_head() to undo this.
2083470decc6SDave Kleikamp  *
2084470decc6SDave Kleikamp  * So the typical usage would be:
2085470decc6SDave Kleikamp  *
2086470decc6SDave Kleikamp  *	(Attach a journal_head if needed.  Increments b_jcount)
2087f7f4bccbSMingming Cao  *	struct journal_head *jh = jbd2_journal_add_journal_head(bh);
2088470decc6SDave Kleikamp  *	...
2089de1b7941SJan Kara  *      (Get another reference for transaction)
2090de1b7941SJan Kara  *	jbd2_journal_grab_journal_head(bh);
2091470decc6SDave Kleikamp  *	jh->b_transaction = xxx;
2092de1b7941SJan Kara  *	(Put original reference)
2093f7f4bccbSMingming Cao  *	jbd2_journal_put_journal_head(jh);
2094470decc6SDave Kleikamp  */
2095470decc6SDave Kleikamp 
2096470decc6SDave Kleikamp /*
2097470decc6SDave Kleikamp  * Give a buffer_head a journal_head.
2098470decc6SDave Kleikamp  *
2099470decc6SDave Kleikamp  * May sleep.
2100470decc6SDave Kleikamp  */
2101f7f4bccbSMingming Cao struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh)
2102470decc6SDave Kleikamp {
2103470decc6SDave Kleikamp 	struct journal_head *jh;
2104470decc6SDave Kleikamp 	struct journal_head *new_jh = NULL;
2105470decc6SDave Kleikamp 
2106470decc6SDave Kleikamp repeat:
2107470decc6SDave Kleikamp 	if (!buffer_jbd(bh)) {
2108470decc6SDave Kleikamp 		new_jh = journal_alloc_journal_head();
2109470decc6SDave Kleikamp 		memset(new_jh, 0, sizeof(*new_jh));
2110470decc6SDave Kleikamp 	}
2111470decc6SDave Kleikamp 
2112470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2113470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
2114470decc6SDave Kleikamp 		jh = bh2jh(bh);
2115470decc6SDave Kleikamp 	} else {
2116470decc6SDave Kleikamp 		J_ASSERT_BH(bh,
2117470decc6SDave Kleikamp 			(atomic_read(&bh->b_count) > 0) ||
2118470decc6SDave Kleikamp 			(bh->b_page && bh->b_page->mapping));
2119470decc6SDave Kleikamp 
2120470decc6SDave Kleikamp 		if (!new_jh) {
2121470decc6SDave Kleikamp 			jbd_unlock_bh_journal_head(bh);
2122470decc6SDave Kleikamp 			goto repeat;
2123470decc6SDave Kleikamp 		}
2124470decc6SDave Kleikamp 
2125470decc6SDave Kleikamp 		jh = new_jh;
2126470decc6SDave Kleikamp 		new_jh = NULL;		/* We consumed it */
2127470decc6SDave Kleikamp 		set_buffer_jbd(bh);
2128470decc6SDave Kleikamp 		bh->b_private = jh;
2129470decc6SDave Kleikamp 		jh->b_bh = bh;
2130470decc6SDave Kleikamp 		get_bh(bh);
2131470decc6SDave Kleikamp 		BUFFER_TRACE(bh, "added journal_head");
2132470decc6SDave Kleikamp 	}
2133470decc6SDave Kleikamp 	jh->b_jcount++;
2134470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2135470decc6SDave Kleikamp 	if (new_jh)
2136470decc6SDave Kleikamp 		journal_free_journal_head(new_jh);
2137470decc6SDave Kleikamp 	return bh->b_private;
2138470decc6SDave Kleikamp }
2139470decc6SDave Kleikamp 
2140470decc6SDave Kleikamp /*
2141470decc6SDave Kleikamp  * Grab a ref against this buffer_head's journal_head.  If it ended up not
2142470decc6SDave Kleikamp  * having a journal_head, return NULL
2143470decc6SDave Kleikamp  */
2144f7f4bccbSMingming Cao struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh)
2145470decc6SDave Kleikamp {
2146470decc6SDave Kleikamp 	struct journal_head *jh = NULL;
2147470decc6SDave Kleikamp 
2148470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2149470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
2150470decc6SDave Kleikamp 		jh = bh2jh(bh);
2151470decc6SDave Kleikamp 		jh->b_jcount++;
2152470decc6SDave Kleikamp 	}
2153470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2154470decc6SDave Kleikamp 	return jh;
2155470decc6SDave Kleikamp }
2156470decc6SDave Kleikamp 
2157470decc6SDave Kleikamp static void __journal_remove_journal_head(struct buffer_head *bh)
2158470decc6SDave Kleikamp {
2159470decc6SDave Kleikamp 	struct journal_head *jh = bh2jh(bh);
2160470decc6SDave Kleikamp 
2161470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jcount >= 0);
2162de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_transaction == NULL);
2163de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
2164de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_cp_transaction == NULL);
2165470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jlist == BJ_None);
2166470decc6SDave Kleikamp 	J_ASSERT_BH(bh, buffer_jbd(bh));
2167470decc6SDave Kleikamp 	J_ASSERT_BH(bh, jh2bh(jh) == bh);
2168470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "remove journal_head");
2169470decc6SDave Kleikamp 	if (jh->b_frozen_data) {
2170de1b7941SJan Kara 		printk(KERN_WARNING "%s: freeing b_frozen_data\n", __func__);
2171af1e76d6SMingming Cao 		jbd2_free(jh->b_frozen_data, bh->b_size);
2172470decc6SDave Kleikamp 	}
2173470decc6SDave Kleikamp 	if (jh->b_committed_data) {
2174de1b7941SJan Kara 		printk(KERN_WARNING "%s: freeing b_committed_data\n", __func__);
2175af1e76d6SMingming Cao 		jbd2_free(jh->b_committed_data, bh->b_size);
2176470decc6SDave Kleikamp 	}
2177470decc6SDave Kleikamp 	bh->b_private = NULL;
2178470decc6SDave Kleikamp 	jh->b_bh = NULL;	/* debug, really */
2179470decc6SDave Kleikamp 	clear_buffer_jbd(bh);
2180470decc6SDave Kleikamp 	journal_free_journal_head(jh);
2181470decc6SDave Kleikamp }
2182470decc6SDave Kleikamp 
2183470decc6SDave Kleikamp /*
2184de1b7941SJan Kara  * Drop a reference on the passed journal_head.  If it fell to zero then
2185470decc6SDave Kleikamp  * release the journal_head from the buffer_head.
2186470decc6SDave Kleikamp  */
2187f7f4bccbSMingming Cao void jbd2_journal_put_journal_head(struct journal_head *jh)
2188470decc6SDave Kleikamp {
2189470decc6SDave Kleikamp 	struct buffer_head *bh = jh2bh(jh);
2190470decc6SDave Kleikamp 
2191470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2192470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jcount > 0);
2193470decc6SDave Kleikamp 	--jh->b_jcount;
2194de1b7941SJan Kara 	if (!jh->b_jcount) {
2195470decc6SDave Kleikamp 		__journal_remove_journal_head(bh);
2196de1b7941SJan Kara 		jbd_unlock_bh_journal_head(bh);
2197470decc6SDave Kleikamp 		__brelse(bh);
2198de1b7941SJan Kara 	} else
2199470decc6SDave Kleikamp 		jbd_unlock_bh_journal_head(bh);
2200470decc6SDave Kleikamp }
2201470decc6SDave Kleikamp 
2202470decc6SDave Kleikamp /*
2203c851ed54SJan Kara  * Initialize jbd inode head
2204c851ed54SJan Kara  */
2205c851ed54SJan Kara void jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode)
2206c851ed54SJan Kara {
2207c851ed54SJan Kara 	jinode->i_transaction = NULL;
2208c851ed54SJan Kara 	jinode->i_next_transaction = NULL;
2209c851ed54SJan Kara 	jinode->i_vfs_inode = inode;
2210c851ed54SJan Kara 	jinode->i_flags = 0;
2211c851ed54SJan Kara 	INIT_LIST_HEAD(&jinode->i_list);
2212c851ed54SJan Kara }
2213c851ed54SJan Kara 
2214c851ed54SJan Kara /*
2215c851ed54SJan Kara  * Function to be called before we start removing inode from memory (i.e.,
2216c851ed54SJan Kara  * clear_inode() is a fine place to be called from). It removes inode from
2217c851ed54SJan Kara  * transaction's lists.
2218c851ed54SJan Kara  */
2219c851ed54SJan Kara void jbd2_journal_release_jbd_inode(journal_t *journal,
2220c851ed54SJan Kara 				    struct jbd2_inode *jinode)
2221c851ed54SJan Kara {
2222c851ed54SJan Kara 	if (!journal)
2223c851ed54SJan Kara 		return;
2224c851ed54SJan Kara restart:
2225c851ed54SJan Kara 	spin_lock(&journal->j_list_lock);
2226c851ed54SJan Kara 	/* Is commit writing out inode - we have to wait */
222739e3ac25SBrian King 	if (test_bit(__JI_COMMIT_RUNNING, &jinode->i_flags)) {
2228c851ed54SJan Kara 		wait_queue_head_t *wq;
2229c851ed54SJan Kara 		DEFINE_WAIT_BIT(wait, &jinode->i_flags, __JI_COMMIT_RUNNING);
2230c851ed54SJan Kara 		wq = bit_waitqueue(&jinode->i_flags, __JI_COMMIT_RUNNING);
2231c851ed54SJan Kara 		prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
2232c851ed54SJan Kara 		spin_unlock(&journal->j_list_lock);
2233c851ed54SJan Kara 		schedule();
2234c851ed54SJan Kara 		finish_wait(wq, &wait.wait);
2235c851ed54SJan Kara 		goto restart;
2236c851ed54SJan Kara 	}
2237c851ed54SJan Kara 
2238c851ed54SJan Kara 	if (jinode->i_transaction) {
2239c851ed54SJan Kara 		list_del(&jinode->i_list);
2240c851ed54SJan Kara 		jinode->i_transaction = NULL;
2241c851ed54SJan Kara 	}
2242c851ed54SJan Kara 	spin_unlock(&journal->j_list_lock);
2243c851ed54SJan Kara }
2244c851ed54SJan Kara 
2245c851ed54SJan Kara /*
22460f49d5d0SJose R. Santos  * debugfs tunables
2247470decc6SDave Kleikamp  */
22486f38c74fSJose R. Santos #ifdef CONFIG_JBD2_DEBUG
22496f38c74fSJose R. Santos u8 jbd2_journal_enable_debug __read_mostly;
2250f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_enable_debug);
2251470decc6SDave Kleikamp 
22520f49d5d0SJose R. Santos #define JBD2_DEBUG_NAME "jbd2-debug"
2253470decc6SDave Kleikamp 
22546f38c74fSJose R. Santos static struct dentry *jbd2_debugfs_dir;
22556f38c74fSJose R. Santos static struct dentry *jbd2_debug;
22560f49d5d0SJose R. Santos 
22570f49d5d0SJose R. Santos static void __init jbd2_create_debugfs_entry(void)
2258470decc6SDave Kleikamp {
22590f49d5d0SJose R. Santos 	jbd2_debugfs_dir = debugfs_create_dir("jbd2", NULL);
22600f49d5d0SJose R. Santos 	if (jbd2_debugfs_dir)
2261765f8361SYin Kangkai 		jbd2_debug = debugfs_create_u8(JBD2_DEBUG_NAME,
2262765f8361SYin Kangkai 					       S_IRUGO | S_IWUSR,
22630f49d5d0SJose R. Santos 					       jbd2_debugfs_dir,
22640f49d5d0SJose R. Santos 					       &jbd2_journal_enable_debug);
2265470decc6SDave Kleikamp }
2266470decc6SDave Kleikamp 
22670f49d5d0SJose R. Santos static void __exit jbd2_remove_debugfs_entry(void)
2268470decc6SDave Kleikamp {
22690f49d5d0SJose R. Santos 	debugfs_remove(jbd2_debug);
22700f49d5d0SJose R. Santos 	debugfs_remove(jbd2_debugfs_dir);
2271470decc6SDave Kleikamp }
2272470decc6SDave Kleikamp 
2273470decc6SDave Kleikamp #else
2274470decc6SDave Kleikamp 
22750f49d5d0SJose R. Santos static void __init jbd2_create_debugfs_entry(void)
22760f49d5d0SJose R. Santos {
22770f49d5d0SJose R. Santos }
22780f49d5d0SJose R. Santos 
22790f49d5d0SJose R. Santos static void __exit jbd2_remove_debugfs_entry(void)
22800f49d5d0SJose R. Santos {
22810f49d5d0SJose R. Santos }
2282470decc6SDave Kleikamp 
2283470decc6SDave Kleikamp #endif
2284470decc6SDave Kleikamp 
22858e85fb3fSJohann Lombardi #ifdef CONFIG_PROC_FS
22868e85fb3fSJohann Lombardi 
22878e85fb3fSJohann Lombardi #define JBD2_STATS_PROC_NAME "fs/jbd2"
22888e85fb3fSJohann Lombardi 
22898e85fb3fSJohann Lombardi static void __init jbd2_create_jbd_stats_proc_entry(void)
22908e85fb3fSJohann Lombardi {
22918e85fb3fSJohann Lombardi 	proc_jbd2_stats = proc_mkdir(JBD2_STATS_PROC_NAME, NULL);
22928e85fb3fSJohann Lombardi }
22938e85fb3fSJohann Lombardi 
22948e85fb3fSJohann Lombardi static void __exit jbd2_remove_jbd_stats_proc_entry(void)
22958e85fb3fSJohann Lombardi {
22968e85fb3fSJohann Lombardi 	if (proc_jbd2_stats)
22978e85fb3fSJohann Lombardi 		remove_proc_entry(JBD2_STATS_PROC_NAME, NULL);
22988e85fb3fSJohann Lombardi }
22998e85fb3fSJohann Lombardi 
23008e85fb3fSJohann Lombardi #else
23018e85fb3fSJohann Lombardi 
23028e85fb3fSJohann Lombardi #define jbd2_create_jbd_stats_proc_entry() do {} while (0)
23038e85fb3fSJohann Lombardi #define jbd2_remove_jbd_stats_proc_entry() do {} while (0)
23048e85fb3fSJohann Lombardi 
23058e85fb3fSJohann Lombardi #endif
23068e85fb3fSJohann Lombardi 
23078aefcd55STheodore Ts'o struct kmem_cache *jbd2_handle_cache, *jbd2_inode_cache;
2308470decc6SDave Kleikamp 
23094185a2acSYongqiang Yang static int __init jbd2_journal_init_handle_cache(void)
2310470decc6SDave Kleikamp {
23118aefcd55STheodore Ts'o 	jbd2_handle_cache = KMEM_CACHE(jbd2_journal_handle, SLAB_TEMPORARY);
2312f7f4bccbSMingming Cao 	if (jbd2_handle_cache == NULL) {
23138aefcd55STheodore Ts'o 		printk(KERN_EMERG "JBD2: failed to create handle cache\n");
23148aefcd55STheodore Ts'o 		return -ENOMEM;
23158aefcd55STheodore Ts'o 	}
23168aefcd55STheodore Ts'o 	jbd2_inode_cache = KMEM_CACHE(jbd2_inode, 0);
23178aefcd55STheodore Ts'o 	if (jbd2_inode_cache == NULL) {
23188aefcd55STheodore Ts'o 		printk(KERN_EMERG "JBD2: failed to create inode cache\n");
23198aefcd55STheodore Ts'o 		kmem_cache_destroy(jbd2_handle_cache);
2320470decc6SDave Kleikamp 		return -ENOMEM;
2321470decc6SDave Kleikamp 	}
2322470decc6SDave Kleikamp 	return 0;
2323470decc6SDave Kleikamp }
2324470decc6SDave Kleikamp 
2325f7f4bccbSMingming Cao static void jbd2_journal_destroy_handle_cache(void)
2326470decc6SDave Kleikamp {
2327f7f4bccbSMingming Cao 	if (jbd2_handle_cache)
2328f7f4bccbSMingming Cao 		kmem_cache_destroy(jbd2_handle_cache);
23298aefcd55STheodore Ts'o 	if (jbd2_inode_cache)
23308aefcd55STheodore Ts'o 		kmem_cache_destroy(jbd2_inode_cache);
23318aefcd55STheodore Ts'o 
2332470decc6SDave Kleikamp }
2333470decc6SDave Kleikamp 
2334470decc6SDave Kleikamp /*
2335470decc6SDave Kleikamp  * Module startup and shutdown
2336470decc6SDave Kleikamp  */
2337470decc6SDave Kleikamp 
2338470decc6SDave Kleikamp static int __init journal_init_caches(void)
2339470decc6SDave Kleikamp {
2340470decc6SDave Kleikamp 	int ret;
2341470decc6SDave Kleikamp 
2342f7f4bccbSMingming Cao 	ret = jbd2_journal_init_revoke_caches();
2343470decc6SDave Kleikamp 	if (ret == 0)
23444185a2acSYongqiang Yang 		ret = jbd2_journal_init_journal_head_cache();
2345470decc6SDave Kleikamp 	if (ret == 0)
23464185a2acSYongqiang Yang 		ret = jbd2_journal_init_handle_cache();
23470c2022ecSYongqiang Yang 	if (ret == 0)
23480c2022ecSYongqiang Yang 		ret = jbd2_journal_init_transaction_cache();
2349470decc6SDave Kleikamp 	return ret;
2350470decc6SDave Kleikamp }
2351470decc6SDave Kleikamp 
2352f7f4bccbSMingming Cao static void jbd2_journal_destroy_caches(void)
2353470decc6SDave Kleikamp {
2354f7f4bccbSMingming Cao 	jbd2_journal_destroy_revoke_caches();
23554185a2acSYongqiang Yang 	jbd2_journal_destroy_journal_head_cache();
2356f7f4bccbSMingming Cao 	jbd2_journal_destroy_handle_cache();
23570c2022ecSYongqiang Yang 	jbd2_journal_destroy_transaction_cache();
2358d2eecb03STheodore Ts'o 	jbd2_journal_destroy_slabs();
2359470decc6SDave Kleikamp }
2360470decc6SDave Kleikamp 
2361470decc6SDave Kleikamp static int __init journal_init(void)
2362470decc6SDave Kleikamp {
2363470decc6SDave Kleikamp 	int ret;
2364470decc6SDave Kleikamp 
2365470decc6SDave Kleikamp 	BUILD_BUG_ON(sizeof(struct journal_superblock_s) != 1024);
2366470decc6SDave Kleikamp 
2367470decc6SDave Kleikamp 	ret = journal_init_caches();
2368620de4e1SDuane Griffin 	if (ret == 0) {
23690f49d5d0SJose R. Santos 		jbd2_create_debugfs_entry();
23708e85fb3fSJohann Lombardi 		jbd2_create_jbd_stats_proc_entry();
2371620de4e1SDuane Griffin 	} else {
2372620de4e1SDuane Griffin 		jbd2_journal_destroy_caches();
2373620de4e1SDuane Griffin 	}
2374470decc6SDave Kleikamp 	return ret;
2375470decc6SDave Kleikamp }
2376470decc6SDave Kleikamp 
2377470decc6SDave Kleikamp static void __exit journal_exit(void)
2378470decc6SDave Kleikamp {
2379e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2380470decc6SDave Kleikamp 	int n = atomic_read(&nr_journal_heads);
2381470decc6SDave Kleikamp 	if (n)
2382f2a44523SEryu Guan 		printk(KERN_EMERG "JBD2: leaked %d journal_heads!\n", n);
2383470decc6SDave Kleikamp #endif
23840f49d5d0SJose R. Santos 	jbd2_remove_debugfs_entry();
23858e85fb3fSJohann Lombardi 	jbd2_remove_jbd_stats_proc_entry();
2386f7f4bccbSMingming Cao 	jbd2_journal_destroy_caches();
2387470decc6SDave Kleikamp }
2388470decc6SDave Kleikamp 
2389470decc6SDave Kleikamp MODULE_LICENSE("GPL");
2390470decc6SDave Kleikamp module_init(journal_init);
2391470decc6SDave Kleikamp module_exit(journal_exit);
2392470decc6SDave Kleikamp 
2393