xref: /openbmc/linux/fs/jbd2/journal.c (revision 828c09509b9695271bcbdc53e9fc9a6a737148d2)
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>
42879c5e6bSTheodore Ts'o 
43879c5e6bSTheodore Ts'o #define CREATE_TRACE_POINTS
44879c5e6bSTheodore Ts'o #include <trace/events/jbd2.h>
45470decc6SDave Kleikamp 
46470decc6SDave Kleikamp #include <asm/uaccess.h>
47470decc6SDave Kleikamp #include <asm/page.h>
48470decc6SDave Kleikamp 
49f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_start);
50f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_restart);
51f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_extend);
52f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_stop);
53f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_lock_updates);
54f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_unlock_updates);
55f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_write_access);
56f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_create_access);
57f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_undo_access);
58e06c8227SJoel Becker EXPORT_SYMBOL(jbd2_journal_set_triggers);
59f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_dirty_metadata);
60f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_release_buffer);
61f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_forget);
62470decc6SDave Kleikamp #if 0
63470decc6SDave Kleikamp EXPORT_SYMBOL(journal_sync_buffer);
64470decc6SDave Kleikamp #endif
65f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_flush);
66f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_revoke);
67470decc6SDave Kleikamp 
68f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_dev);
69f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_inode);
70f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_update_format);
71f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_used_features);
72f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_available_features);
73f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_set_features);
74f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_load);
75f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_destroy);
76f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_abort);
77f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_errno);
78f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_ack_err);
79f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_clear_err);
80f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_log_wait_commit);
81f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_start_commit);
82f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit_nested);
83f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_wipe);
84f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_blocks_per_page);
85f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_invalidatepage);
86f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_try_to_free_buffers);
87f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit);
88c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_file_inode);
89c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_init_jbd_inode);
90c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_release_jbd_inode);
91c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_begin_ordered_truncate);
92470decc6SDave Kleikamp 
93470decc6SDave Kleikamp static int journal_convert_superblock_v1(journal_t *, journal_superblock_t *);
94470decc6SDave Kleikamp static void __journal_abort_soft (journal_t *journal, int errno);
95470decc6SDave Kleikamp 
96470decc6SDave Kleikamp /*
97470decc6SDave Kleikamp  * Helper function used to manage commit timeouts
98470decc6SDave Kleikamp  */
99470decc6SDave Kleikamp 
100470decc6SDave Kleikamp static void commit_timeout(unsigned long __data)
101470decc6SDave Kleikamp {
102470decc6SDave Kleikamp 	struct task_struct * p = (struct task_struct *) __data;
103470decc6SDave Kleikamp 
104470decc6SDave Kleikamp 	wake_up_process(p);
105470decc6SDave Kleikamp }
106470decc6SDave Kleikamp 
107470decc6SDave Kleikamp /*
108f7f4bccbSMingming Cao  * kjournald2: The main thread function used to manage a logging device
109470decc6SDave Kleikamp  * journal.
110470decc6SDave Kleikamp  *
111470decc6SDave Kleikamp  * This kernel thread is responsible for two things:
112470decc6SDave Kleikamp  *
113470decc6SDave Kleikamp  * 1) COMMIT:  Every so often we need to commit the current state of the
114470decc6SDave Kleikamp  *    filesystem to disk.  The journal thread is responsible for writing
115470decc6SDave Kleikamp  *    all of the metadata buffers to disk.
116470decc6SDave Kleikamp  *
117470decc6SDave Kleikamp  * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
118470decc6SDave Kleikamp  *    of the data in that part of the log has been rewritten elsewhere on
119470decc6SDave Kleikamp  *    the disk.  Flushing these old buffers to reclaim space in the log is
120470decc6SDave Kleikamp  *    known as checkpointing, and this thread is responsible for that job.
121470decc6SDave Kleikamp  */
122470decc6SDave Kleikamp 
123f7f4bccbSMingming Cao static int kjournald2(void *arg)
124470decc6SDave Kleikamp {
125470decc6SDave Kleikamp 	journal_t *journal = arg;
126470decc6SDave Kleikamp 	transaction_t *transaction;
127470decc6SDave Kleikamp 
128470decc6SDave Kleikamp 	/*
129470decc6SDave Kleikamp 	 * Set up an interval timer which can be used to trigger a commit wakeup
130470decc6SDave Kleikamp 	 * after the commit interval expires
131470decc6SDave Kleikamp 	 */
132470decc6SDave Kleikamp 	setup_timer(&journal->j_commit_timer, commit_timeout,
133470decc6SDave Kleikamp 			(unsigned long)current);
134470decc6SDave Kleikamp 
135470decc6SDave Kleikamp 	/* Record that the journal thread is running */
136470decc6SDave Kleikamp 	journal->j_task = current;
137470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
138470decc6SDave Kleikamp 
139470decc6SDave Kleikamp 	/*
140470decc6SDave Kleikamp 	 * And now, wait forever for commit wakeup events.
141470decc6SDave Kleikamp 	 */
142470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
143470decc6SDave Kleikamp 
144470decc6SDave Kleikamp loop:
145f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_UNMOUNT)
146470decc6SDave Kleikamp 		goto end_loop;
147470decc6SDave Kleikamp 
148470decc6SDave Kleikamp 	jbd_debug(1, "commit_sequence=%d, commit_request=%d\n",
149470decc6SDave Kleikamp 		journal->j_commit_sequence, journal->j_commit_request);
150470decc6SDave Kleikamp 
151470decc6SDave Kleikamp 	if (journal->j_commit_sequence != journal->j_commit_request) {
152470decc6SDave Kleikamp 		jbd_debug(1, "OK, requests differ\n");
153470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
154470decc6SDave Kleikamp 		del_timer_sync(&journal->j_commit_timer);
155f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
156470decc6SDave Kleikamp 		spin_lock(&journal->j_state_lock);
157470decc6SDave Kleikamp 		goto loop;
158470decc6SDave Kleikamp 	}
159470decc6SDave Kleikamp 
160470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
161470decc6SDave Kleikamp 	if (freezing(current)) {
162470decc6SDave Kleikamp 		/*
163470decc6SDave Kleikamp 		 * The simpler the better. Flushing journal isn't a
164470decc6SDave Kleikamp 		 * good idea, because that depends on threads that may
165470decc6SDave Kleikamp 		 * be already stopped.
166470decc6SDave Kleikamp 		 */
167f7f4bccbSMingming Cao 		jbd_debug(1, "Now suspending kjournald2\n");
168470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
169470decc6SDave Kleikamp 		refrigerator();
170470decc6SDave Kleikamp 		spin_lock(&journal->j_state_lock);
171470decc6SDave Kleikamp 	} else {
172470decc6SDave Kleikamp 		/*
173470decc6SDave Kleikamp 		 * We assume on resume that commits are already there,
174470decc6SDave Kleikamp 		 * so we don't sleep
175470decc6SDave Kleikamp 		 */
176470decc6SDave Kleikamp 		DEFINE_WAIT(wait);
177470decc6SDave Kleikamp 		int should_sleep = 1;
178470decc6SDave Kleikamp 
179470decc6SDave Kleikamp 		prepare_to_wait(&journal->j_wait_commit, &wait,
180470decc6SDave Kleikamp 				TASK_INTERRUPTIBLE);
181470decc6SDave Kleikamp 		if (journal->j_commit_sequence != journal->j_commit_request)
182470decc6SDave Kleikamp 			should_sleep = 0;
183470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
184470decc6SDave Kleikamp 		if (transaction && time_after_eq(jiffies,
185470decc6SDave Kleikamp 						transaction->t_expires))
186470decc6SDave Kleikamp 			should_sleep = 0;
187f7f4bccbSMingming Cao 		if (journal->j_flags & JBD2_UNMOUNT)
188470decc6SDave Kleikamp 			should_sleep = 0;
189470decc6SDave Kleikamp 		if (should_sleep) {
190470decc6SDave Kleikamp 			spin_unlock(&journal->j_state_lock);
191470decc6SDave Kleikamp 			schedule();
192470decc6SDave Kleikamp 			spin_lock(&journal->j_state_lock);
193470decc6SDave Kleikamp 		}
194470decc6SDave Kleikamp 		finish_wait(&journal->j_wait_commit, &wait);
195470decc6SDave Kleikamp 	}
196470decc6SDave Kleikamp 
197f7f4bccbSMingming Cao 	jbd_debug(1, "kjournald2 wakes\n");
198470decc6SDave Kleikamp 
199470decc6SDave Kleikamp 	/*
200470decc6SDave Kleikamp 	 * Were we woken up by a commit wakeup event?
201470decc6SDave Kleikamp 	 */
202470decc6SDave Kleikamp 	transaction = journal->j_running_transaction;
203470decc6SDave Kleikamp 	if (transaction && time_after_eq(jiffies, transaction->t_expires)) {
204470decc6SDave Kleikamp 		journal->j_commit_request = transaction->t_tid;
205470decc6SDave Kleikamp 		jbd_debug(1, "woke because of timeout\n");
206470decc6SDave Kleikamp 	}
207470decc6SDave Kleikamp 	goto loop;
208470decc6SDave Kleikamp 
209470decc6SDave Kleikamp end_loop:
210470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
211470decc6SDave Kleikamp 	del_timer_sync(&journal->j_commit_timer);
212470decc6SDave Kleikamp 	journal->j_task = NULL;
213470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
214470decc6SDave Kleikamp 	jbd_debug(1, "Journal thread exiting.\n");
215470decc6SDave Kleikamp 	return 0;
216470decc6SDave Kleikamp }
217470decc6SDave Kleikamp 
21897f06784SPavel Emelianov static int jbd2_journal_start_thread(journal_t *journal)
219470decc6SDave Kleikamp {
22097f06784SPavel Emelianov 	struct task_struct *t;
22197f06784SPavel Emelianov 
22290576c0bSTheodore Ts'o 	t = kthread_run(kjournald2, journal, "jbd2/%s",
22390576c0bSTheodore Ts'o 			journal->j_devname);
22497f06784SPavel Emelianov 	if (IS_ERR(t))
22597f06784SPavel Emelianov 		return PTR_ERR(t);
22697f06784SPavel Emelianov 
2271076d17aSAl Viro 	wait_event(journal->j_wait_done_commit, journal->j_task != NULL);
22897f06784SPavel Emelianov 	return 0;
229470decc6SDave Kleikamp }
230470decc6SDave Kleikamp 
231470decc6SDave Kleikamp static void journal_kill_thread(journal_t *journal)
232470decc6SDave Kleikamp {
233470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
234f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_UNMOUNT;
235470decc6SDave Kleikamp 
236470decc6SDave Kleikamp 	while (journal->j_task) {
237470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
238470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
2391076d17aSAl Viro 		wait_event(journal->j_wait_done_commit, journal->j_task == NULL);
240470decc6SDave Kleikamp 		spin_lock(&journal->j_state_lock);
241470decc6SDave Kleikamp 	}
242470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
243470decc6SDave Kleikamp }
244470decc6SDave Kleikamp 
245470decc6SDave Kleikamp /*
246f7f4bccbSMingming Cao  * jbd2_journal_write_metadata_buffer: write a metadata buffer to the journal.
247470decc6SDave Kleikamp  *
248470decc6SDave Kleikamp  * Writes a metadata buffer to a given disk block.  The actual IO is not
249470decc6SDave Kleikamp  * performed but a new buffer_head is constructed which labels the data
250470decc6SDave Kleikamp  * to be written with the correct destination disk block.
251470decc6SDave Kleikamp  *
252470decc6SDave Kleikamp  * Any magic-number escaping which needs to be done will cause a
253470decc6SDave Kleikamp  * copy-out here.  If the buffer happens to start with the
254f7f4bccbSMingming Cao  * JBD2_MAGIC_NUMBER, then we can't write it to the log directly: the
255470decc6SDave Kleikamp  * magic number is only written to the log for descripter blocks.  In
256470decc6SDave Kleikamp  * this case, we copy the data and replace the first word with 0, and we
257470decc6SDave Kleikamp  * return a result code which indicates that this buffer needs to be
258470decc6SDave Kleikamp  * marked as an escaped buffer in the corresponding log descriptor
259470decc6SDave Kleikamp  * block.  The missing word can then be restored when the block is read
260470decc6SDave Kleikamp  * during recovery.
261470decc6SDave Kleikamp  *
262470decc6SDave Kleikamp  * If the source buffer has already been modified by a new transaction
263470decc6SDave Kleikamp  * since we took the last commit snapshot, we use the frozen copy of
264470decc6SDave Kleikamp  * that data for IO.  If we end up using the existing buffer_head's data
265470decc6SDave Kleikamp  * for the write, then we *have* to lock the buffer to prevent anyone
266470decc6SDave Kleikamp  * else from using and possibly modifying it while the IO is in
267470decc6SDave Kleikamp  * progress.
268470decc6SDave Kleikamp  *
269470decc6SDave Kleikamp  * The function returns a pointer to the buffer_heads to be used for IO.
270470decc6SDave Kleikamp  *
271470decc6SDave Kleikamp  * We assume that the journal has already been locked in this function.
272470decc6SDave Kleikamp  *
273470decc6SDave Kleikamp  * Return value:
274470decc6SDave Kleikamp  *  <0: Error
275470decc6SDave Kleikamp  * >=0: Finished OK
276470decc6SDave Kleikamp  *
277470decc6SDave Kleikamp  * On success:
278470decc6SDave Kleikamp  * Bit 0 set == escape performed on the data
279470decc6SDave Kleikamp  * Bit 1 set == buffer copy-out performed (kfree the data after IO)
280470decc6SDave Kleikamp  */
281470decc6SDave Kleikamp 
282f7f4bccbSMingming Cao int jbd2_journal_write_metadata_buffer(transaction_t *transaction,
283470decc6SDave Kleikamp 				  struct journal_head  *jh_in,
284470decc6SDave Kleikamp 				  struct journal_head **jh_out,
28518eba7aaSMingming Cao 				  unsigned long long blocknr)
286470decc6SDave Kleikamp {
287470decc6SDave Kleikamp 	int need_copy_out = 0;
288470decc6SDave Kleikamp 	int done_copy_out = 0;
289470decc6SDave Kleikamp 	int do_escape = 0;
290470decc6SDave Kleikamp 	char *mapped_data;
291470decc6SDave Kleikamp 	struct buffer_head *new_bh;
292470decc6SDave Kleikamp 	struct journal_head *new_jh;
293470decc6SDave Kleikamp 	struct page *new_page;
294470decc6SDave Kleikamp 	unsigned int new_offset;
295470decc6SDave Kleikamp 	struct buffer_head *bh_in = jh2bh(jh_in);
296e06c8227SJoel Becker 	struct jbd2_buffer_trigger_type *triggers;
29796577c43Sdingdinghua 	journal_t *journal = transaction->t_journal;
298470decc6SDave Kleikamp 
299470decc6SDave Kleikamp 	/*
300470decc6SDave Kleikamp 	 * The buffer really shouldn't be locked: only the current committing
301470decc6SDave Kleikamp 	 * transaction is allowed to write it, so nobody else is allowed
302470decc6SDave Kleikamp 	 * to do any IO.
303470decc6SDave Kleikamp 	 *
304470decc6SDave Kleikamp 	 * akpm: except if we're journalling data, and write() output is
305470decc6SDave Kleikamp 	 * also part of a shared mapping, and another thread has
306470decc6SDave Kleikamp 	 * decided to launch a writepage() against this buffer.
307470decc6SDave Kleikamp 	 */
308470decc6SDave Kleikamp 	J_ASSERT_BH(bh_in, buffer_jbddirty(bh_in));
309470decc6SDave Kleikamp 
310470decc6SDave Kleikamp 	new_bh = alloc_buffer_head(GFP_NOFS|__GFP_NOFAIL);
31196577c43Sdingdinghua 	/* keep subsequent assertions sane */
31296577c43Sdingdinghua 	new_bh->b_state = 0;
31396577c43Sdingdinghua 	init_buffer(new_bh, NULL, NULL);
31496577c43Sdingdinghua 	atomic_set(&new_bh->b_count, 1);
31596577c43Sdingdinghua 	new_jh = jbd2_journal_add_journal_head(new_bh);	/* This sleeps */
316470decc6SDave Kleikamp 
317470decc6SDave Kleikamp 	/*
318470decc6SDave Kleikamp 	 * If a new transaction has already done a buffer copy-out, then
319470decc6SDave Kleikamp 	 * we use that version of the data for the commit.
320470decc6SDave Kleikamp 	 */
321470decc6SDave Kleikamp 	jbd_lock_bh_state(bh_in);
322470decc6SDave Kleikamp repeat:
323470decc6SDave Kleikamp 	if (jh_in->b_frozen_data) {
324470decc6SDave Kleikamp 		done_copy_out = 1;
325470decc6SDave Kleikamp 		new_page = virt_to_page(jh_in->b_frozen_data);
326470decc6SDave Kleikamp 		new_offset = offset_in_page(jh_in->b_frozen_data);
327e06c8227SJoel Becker 		triggers = jh_in->b_frozen_triggers;
328470decc6SDave Kleikamp 	} else {
329470decc6SDave Kleikamp 		new_page = jh2bh(jh_in)->b_page;
330470decc6SDave Kleikamp 		new_offset = offset_in_page(jh2bh(jh_in)->b_data);
331e06c8227SJoel Becker 		triggers = jh_in->b_triggers;
332470decc6SDave Kleikamp 	}
333470decc6SDave Kleikamp 
334470decc6SDave Kleikamp 	mapped_data = kmap_atomic(new_page, KM_USER0);
335470decc6SDave Kleikamp 	/*
336e06c8227SJoel Becker 	 * Fire any commit trigger.  Do this before checking for escaping,
337e06c8227SJoel Becker 	 * as the trigger may modify the magic offset.  If a copy-out
338e06c8227SJoel Becker 	 * happens afterwards, it will have the correct data in the buffer.
339e06c8227SJoel Becker 	 */
340e06c8227SJoel Becker 	jbd2_buffer_commit_trigger(jh_in, mapped_data + new_offset,
341e06c8227SJoel Becker 				   triggers);
342e06c8227SJoel Becker 
343e06c8227SJoel Becker 	/*
344470decc6SDave Kleikamp 	 * Check for escaping
345470decc6SDave Kleikamp 	 */
346470decc6SDave Kleikamp 	if (*((__be32 *)(mapped_data + new_offset)) ==
347f7f4bccbSMingming Cao 				cpu_to_be32(JBD2_MAGIC_NUMBER)) {
348470decc6SDave Kleikamp 		need_copy_out = 1;
349470decc6SDave Kleikamp 		do_escape = 1;
350470decc6SDave Kleikamp 	}
351470decc6SDave Kleikamp 	kunmap_atomic(mapped_data, KM_USER0);
352470decc6SDave Kleikamp 
353470decc6SDave Kleikamp 	/*
354470decc6SDave Kleikamp 	 * Do we need to do a data copy?
355470decc6SDave Kleikamp 	 */
356470decc6SDave Kleikamp 	if (need_copy_out && !done_copy_out) {
357470decc6SDave Kleikamp 		char *tmp;
358470decc6SDave Kleikamp 
359470decc6SDave Kleikamp 		jbd_unlock_bh_state(bh_in);
360af1e76d6SMingming Cao 		tmp = jbd2_alloc(bh_in->b_size, GFP_NOFS);
361470decc6SDave Kleikamp 		jbd_lock_bh_state(bh_in);
362470decc6SDave Kleikamp 		if (jh_in->b_frozen_data) {
363af1e76d6SMingming Cao 			jbd2_free(tmp, bh_in->b_size);
364470decc6SDave Kleikamp 			goto repeat;
365470decc6SDave Kleikamp 		}
366470decc6SDave Kleikamp 
367470decc6SDave Kleikamp 		jh_in->b_frozen_data = tmp;
368470decc6SDave Kleikamp 		mapped_data = kmap_atomic(new_page, KM_USER0);
369470decc6SDave Kleikamp 		memcpy(tmp, mapped_data + new_offset, jh2bh(jh_in)->b_size);
370470decc6SDave Kleikamp 		kunmap_atomic(mapped_data, KM_USER0);
371470decc6SDave Kleikamp 
372470decc6SDave Kleikamp 		new_page = virt_to_page(tmp);
373470decc6SDave Kleikamp 		new_offset = offset_in_page(tmp);
374470decc6SDave Kleikamp 		done_copy_out = 1;
375e06c8227SJoel Becker 
376e06c8227SJoel Becker 		/*
377e06c8227SJoel Becker 		 * This isn't strictly necessary, as we're using frozen
378e06c8227SJoel Becker 		 * data for the escaping, but it keeps consistency with
379e06c8227SJoel Becker 		 * b_frozen_data usage.
380e06c8227SJoel Becker 		 */
381e06c8227SJoel Becker 		jh_in->b_frozen_triggers = jh_in->b_triggers;
382470decc6SDave Kleikamp 	}
383470decc6SDave Kleikamp 
384470decc6SDave Kleikamp 	/*
385470decc6SDave Kleikamp 	 * Did we need to do an escaping?  Now we've done all the
386470decc6SDave Kleikamp 	 * copying, we can finally do so.
387470decc6SDave Kleikamp 	 */
388470decc6SDave Kleikamp 	if (do_escape) {
389470decc6SDave Kleikamp 		mapped_data = kmap_atomic(new_page, KM_USER0);
390470decc6SDave Kleikamp 		*((unsigned int *)(mapped_data + new_offset)) = 0;
391470decc6SDave Kleikamp 		kunmap_atomic(mapped_data, KM_USER0);
392470decc6SDave Kleikamp 	}
393470decc6SDave Kleikamp 
394470decc6SDave Kleikamp 	set_bh_page(new_bh, new_page, new_offset);
395470decc6SDave Kleikamp 	new_jh->b_transaction = NULL;
396470decc6SDave Kleikamp 	new_bh->b_size = jh2bh(jh_in)->b_size;
397470decc6SDave Kleikamp 	new_bh->b_bdev = transaction->t_journal->j_dev;
398470decc6SDave Kleikamp 	new_bh->b_blocknr = blocknr;
399470decc6SDave Kleikamp 	set_buffer_mapped(new_bh);
400470decc6SDave Kleikamp 	set_buffer_dirty(new_bh);
401470decc6SDave Kleikamp 
402470decc6SDave Kleikamp 	*jh_out = new_jh;
403470decc6SDave Kleikamp 
404470decc6SDave Kleikamp 	/*
405470decc6SDave Kleikamp 	 * The to-be-written buffer needs to get moved to the io queue,
406470decc6SDave Kleikamp 	 * and the original buffer whose contents we are shadowing or
407470decc6SDave Kleikamp 	 * copying is moved to the transaction's shadow queue.
408470decc6SDave Kleikamp 	 */
409470decc6SDave Kleikamp 	JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
41096577c43Sdingdinghua 	spin_lock(&journal->j_list_lock);
41196577c43Sdingdinghua 	__jbd2_journal_file_buffer(jh_in, transaction, BJ_Shadow);
41296577c43Sdingdinghua 	spin_unlock(&journal->j_list_lock);
41396577c43Sdingdinghua 	jbd_unlock_bh_state(bh_in);
41496577c43Sdingdinghua 
415470decc6SDave Kleikamp 	JBUFFER_TRACE(new_jh, "file as BJ_IO");
416f7f4bccbSMingming Cao 	jbd2_journal_file_buffer(new_jh, transaction, BJ_IO);
417470decc6SDave Kleikamp 
418470decc6SDave Kleikamp 	return do_escape | (done_copy_out << 1);
419470decc6SDave Kleikamp }
420470decc6SDave Kleikamp 
421470decc6SDave Kleikamp /*
422470decc6SDave Kleikamp  * Allocation code for the journal file.  Manage the space left in the
423470decc6SDave Kleikamp  * journal, so that we can begin checkpointing when appropriate.
424470decc6SDave Kleikamp  */
425470decc6SDave Kleikamp 
426470decc6SDave Kleikamp /*
427f7f4bccbSMingming Cao  * __jbd2_log_space_left: Return the number of free blocks left in the journal.
428470decc6SDave Kleikamp  *
429470decc6SDave Kleikamp  * Called with the journal already locked.
430470decc6SDave Kleikamp  *
431470decc6SDave Kleikamp  * Called under j_state_lock
432470decc6SDave Kleikamp  */
433470decc6SDave Kleikamp 
434f7f4bccbSMingming Cao int __jbd2_log_space_left(journal_t *journal)
435470decc6SDave Kleikamp {
436470decc6SDave Kleikamp 	int left = journal->j_free;
437470decc6SDave Kleikamp 
438470decc6SDave Kleikamp 	assert_spin_locked(&journal->j_state_lock);
439470decc6SDave Kleikamp 
440470decc6SDave Kleikamp 	/*
441470decc6SDave Kleikamp 	 * Be pessimistic here about the number of those free blocks which
442470decc6SDave Kleikamp 	 * might be required for log descriptor control blocks.
443470decc6SDave Kleikamp 	 */
444470decc6SDave Kleikamp 
445470decc6SDave Kleikamp #define MIN_LOG_RESERVED_BLOCKS 32 /* Allow for rounding errors */
446470decc6SDave Kleikamp 
447470decc6SDave Kleikamp 	left -= MIN_LOG_RESERVED_BLOCKS;
448470decc6SDave Kleikamp 
449470decc6SDave Kleikamp 	if (left <= 0)
450470decc6SDave Kleikamp 		return 0;
451470decc6SDave Kleikamp 	left -= (left >> 3);
452470decc6SDave Kleikamp 	return left;
453470decc6SDave Kleikamp }
454470decc6SDave Kleikamp 
455470decc6SDave Kleikamp /*
456c88ccea3SJan Kara  * Called under j_state_lock.  Returns true if a transaction commit was started.
457470decc6SDave Kleikamp  */
458f7f4bccbSMingming Cao int __jbd2_log_start_commit(journal_t *journal, tid_t target)
459470decc6SDave Kleikamp {
460470decc6SDave Kleikamp 	/*
461470decc6SDave Kleikamp 	 * Are we already doing a recent enough commit?
462470decc6SDave Kleikamp 	 */
463470decc6SDave Kleikamp 	if (!tid_geq(journal->j_commit_request, target)) {
464470decc6SDave Kleikamp 		/*
465470decc6SDave Kleikamp 		 * We want a new commit: OK, mark the request and wakup the
466470decc6SDave Kleikamp 		 * commit thread.  We do _not_ do the commit ourselves.
467470decc6SDave Kleikamp 		 */
468470decc6SDave Kleikamp 
469470decc6SDave Kleikamp 		journal->j_commit_request = target;
470470decc6SDave Kleikamp 		jbd_debug(1, "JBD: requesting commit %d/%d\n",
471470decc6SDave Kleikamp 			  journal->j_commit_request,
472470decc6SDave Kleikamp 			  journal->j_commit_sequence);
473470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
474470decc6SDave Kleikamp 		return 1;
475470decc6SDave Kleikamp 	}
476470decc6SDave Kleikamp 	return 0;
477470decc6SDave Kleikamp }
478470decc6SDave Kleikamp 
479f7f4bccbSMingming Cao int jbd2_log_start_commit(journal_t *journal, tid_t tid)
480470decc6SDave Kleikamp {
481470decc6SDave Kleikamp 	int ret;
482470decc6SDave Kleikamp 
483470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
484f7f4bccbSMingming Cao 	ret = __jbd2_log_start_commit(journal, tid);
485470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
486470decc6SDave Kleikamp 	return ret;
487470decc6SDave Kleikamp }
488470decc6SDave Kleikamp 
489470decc6SDave Kleikamp /*
490470decc6SDave Kleikamp  * Force and wait upon a commit if the calling process is not within
491470decc6SDave Kleikamp  * transaction.  This is used for forcing out undo-protected data which contains
492470decc6SDave Kleikamp  * bitmaps, when the fs is running out of space.
493470decc6SDave Kleikamp  *
494470decc6SDave Kleikamp  * We can only force the running transaction if we don't have an active handle;
495470decc6SDave Kleikamp  * otherwise, we will deadlock.
496470decc6SDave Kleikamp  *
497470decc6SDave Kleikamp  * Returns true if a transaction was started.
498470decc6SDave Kleikamp  */
499f7f4bccbSMingming Cao int jbd2_journal_force_commit_nested(journal_t *journal)
500470decc6SDave Kleikamp {
501470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
502470decc6SDave Kleikamp 	tid_t tid;
503470decc6SDave Kleikamp 
504470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
505470decc6SDave Kleikamp 	if (journal->j_running_transaction && !current->journal_info) {
506470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
507f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
508470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
509470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
510470decc6SDave Kleikamp 
511470decc6SDave Kleikamp 	if (!transaction) {
512470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
513470decc6SDave Kleikamp 		return 0;	/* Nothing to retry */
514470decc6SDave Kleikamp 	}
515470decc6SDave Kleikamp 
516470decc6SDave Kleikamp 	tid = transaction->t_tid;
517470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
518f7f4bccbSMingming Cao 	jbd2_log_wait_commit(journal, tid);
519470decc6SDave Kleikamp 	return 1;
520470decc6SDave Kleikamp }
521470decc6SDave Kleikamp 
522470decc6SDave Kleikamp /*
523470decc6SDave Kleikamp  * Start a commit of the current running transaction (if any).  Returns true
524c88ccea3SJan Kara  * if a transaction is going to be committed (or is currently already
525c88ccea3SJan Kara  * committing), and fills its tid in at *ptid
526470decc6SDave Kleikamp  */
527f7f4bccbSMingming Cao int jbd2_journal_start_commit(journal_t *journal, tid_t *ptid)
528470decc6SDave Kleikamp {
529470decc6SDave Kleikamp 	int ret = 0;
530470decc6SDave Kleikamp 
531470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
532470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
533470decc6SDave Kleikamp 		tid_t tid = journal->j_running_transaction->t_tid;
534470decc6SDave Kleikamp 
535c88ccea3SJan Kara 		__jbd2_log_start_commit(journal, tid);
536c88ccea3SJan Kara 		/* There's a running transaction and we've just made sure
537c88ccea3SJan Kara 		 * it's commit has been scheduled. */
538c88ccea3SJan Kara 		if (ptid)
539470decc6SDave Kleikamp 			*ptid = tid;
540c88ccea3SJan Kara 		ret = 1;
541c88ccea3SJan Kara 	} else if (journal->j_committing_transaction) {
542470decc6SDave Kleikamp 		/*
543470decc6SDave Kleikamp 		 * If ext3_write_super() recently started a commit, then we
544470decc6SDave Kleikamp 		 * have to wait for completion of that transaction
545470decc6SDave Kleikamp 		 */
546c88ccea3SJan Kara 		if (ptid)
547470decc6SDave Kleikamp 			*ptid = journal->j_committing_transaction->t_tid;
548470decc6SDave Kleikamp 		ret = 1;
549470decc6SDave Kleikamp 	}
550470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
551470decc6SDave Kleikamp 	return ret;
552470decc6SDave Kleikamp }
553470decc6SDave Kleikamp 
554470decc6SDave Kleikamp /*
555470decc6SDave Kleikamp  * Wait for a specified commit to complete.
556470decc6SDave Kleikamp  * The caller may not hold the journal lock.
557470decc6SDave Kleikamp  */
558f7f4bccbSMingming Cao int jbd2_log_wait_commit(journal_t *journal, tid_t tid)
559470decc6SDave Kleikamp {
560470decc6SDave Kleikamp 	int err = 0;
561470decc6SDave Kleikamp 
562e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
563470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
564470decc6SDave Kleikamp 	if (!tid_geq(journal->j_commit_request, tid)) {
565470decc6SDave Kleikamp 		printk(KERN_EMERG
566470decc6SDave Kleikamp 		       "%s: error: j_commit_request=%d, tid=%d\n",
567329d291fSHarvey Harrison 		       __func__, journal->j_commit_request, tid);
568470decc6SDave Kleikamp 	}
569470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
570470decc6SDave Kleikamp #endif
571470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
572470decc6SDave Kleikamp 	while (tid_gt(tid, journal->j_commit_sequence)) {
573470decc6SDave Kleikamp 		jbd_debug(1, "JBD: want %d, j_commit_sequence=%d\n",
574470decc6SDave Kleikamp 				  tid, journal->j_commit_sequence);
575470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
576470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
577470decc6SDave Kleikamp 		wait_event(journal->j_wait_done_commit,
578470decc6SDave Kleikamp 				!tid_gt(tid, journal->j_commit_sequence));
579470decc6SDave Kleikamp 		spin_lock(&journal->j_state_lock);
580470decc6SDave Kleikamp 	}
581470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
582470decc6SDave Kleikamp 
583470decc6SDave Kleikamp 	if (unlikely(is_journal_aborted(journal))) {
584470decc6SDave Kleikamp 		printk(KERN_EMERG "journal commit I/O error\n");
585470decc6SDave Kleikamp 		err = -EIO;
586470decc6SDave Kleikamp 	}
587470decc6SDave Kleikamp 	return err;
588470decc6SDave Kleikamp }
589470decc6SDave Kleikamp 
590470decc6SDave Kleikamp /*
591470decc6SDave Kleikamp  * Log buffer allocation routines:
592470decc6SDave Kleikamp  */
593470decc6SDave Kleikamp 
59418eba7aaSMingming Cao int jbd2_journal_next_log_block(journal_t *journal, unsigned long long *retp)
595470decc6SDave Kleikamp {
596470decc6SDave Kleikamp 	unsigned long blocknr;
597470decc6SDave Kleikamp 
598470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
599470decc6SDave Kleikamp 	J_ASSERT(journal->j_free > 1);
600470decc6SDave Kleikamp 
601470decc6SDave Kleikamp 	blocknr = journal->j_head;
602470decc6SDave Kleikamp 	journal->j_head++;
603470decc6SDave Kleikamp 	journal->j_free--;
604470decc6SDave Kleikamp 	if (journal->j_head == journal->j_last)
605470decc6SDave Kleikamp 		journal->j_head = journal->j_first;
606470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
607f7f4bccbSMingming Cao 	return jbd2_journal_bmap(journal, blocknr, retp);
608470decc6SDave Kleikamp }
609470decc6SDave Kleikamp 
610470decc6SDave Kleikamp /*
611470decc6SDave Kleikamp  * Conversion of logical to physical block numbers for the journal
612470decc6SDave Kleikamp  *
613470decc6SDave Kleikamp  * On external journals the journal blocks are identity-mapped, so
614470decc6SDave Kleikamp  * this is a no-op.  If needed, we can use j_blk_offset - everything is
615470decc6SDave Kleikamp  * ready.
616470decc6SDave Kleikamp  */
617f7f4bccbSMingming Cao int jbd2_journal_bmap(journal_t *journal, unsigned long blocknr,
61818eba7aaSMingming Cao 		 unsigned long long *retp)
619470decc6SDave Kleikamp {
620470decc6SDave Kleikamp 	int err = 0;
62118eba7aaSMingming Cao 	unsigned long long ret;
622470decc6SDave Kleikamp 
623470decc6SDave Kleikamp 	if (journal->j_inode) {
624470decc6SDave Kleikamp 		ret = bmap(journal->j_inode, blocknr);
625470decc6SDave Kleikamp 		if (ret)
626470decc6SDave Kleikamp 			*retp = ret;
627470decc6SDave Kleikamp 		else {
628470decc6SDave Kleikamp 			printk(KERN_ALERT "%s: journal block not found "
629470decc6SDave Kleikamp 					"at offset %lu on %s\n",
63005496769STheodore Ts'o 			       __func__, blocknr, journal->j_devname);
631470decc6SDave Kleikamp 			err = -EIO;
632470decc6SDave Kleikamp 			__journal_abort_soft(journal, err);
633470decc6SDave Kleikamp 		}
634470decc6SDave Kleikamp 	} else {
635470decc6SDave Kleikamp 		*retp = blocknr; /* +journal->j_blk_offset */
636470decc6SDave Kleikamp 	}
637470decc6SDave Kleikamp 	return err;
638470decc6SDave Kleikamp }
639470decc6SDave Kleikamp 
640470decc6SDave Kleikamp /*
641470decc6SDave Kleikamp  * We play buffer_head aliasing tricks to write data/metadata blocks to
642470decc6SDave Kleikamp  * the journal without copying their contents, but for journal
643470decc6SDave Kleikamp  * descriptor blocks we do need to generate bona fide buffers.
644470decc6SDave Kleikamp  *
645f7f4bccbSMingming Cao  * After the caller of jbd2_journal_get_descriptor_buffer() has finished modifying
646470decc6SDave Kleikamp  * the buffer's contents they really should run flush_dcache_page(bh->b_page).
647470decc6SDave Kleikamp  * But we don't bother doing that, so there will be coherency problems with
648470decc6SDave Kleikamp  * mmaps of blockdevs which hold live JBD-controlled filesystems.
649470decc6SDave Kleikamp  */
650f7f4bccbSMingming Cao struct journal_head *jbd2_journal_get_descriptor_buffer(journal_t *journal)
651470decc6SDave Kleikamp {
652470decc6SDave Kleikamp 	struct buffer_head *bh;
65318eba7aaSMingming Cao 	unsigned long long blocknr;
654470decc6SDave Kleikamp 	int err;
655470decc6SDave Kleikamp 
656f7f4bccbSMingming Cao 	err = jbd2_journal_next_log_block(journal, &blocknr);
657470decc6SDave Kleikamp 
658470decc6SDave Kleikamp 	if (err)
659470decc6SDave Kleikamp 		return NULL;
660470decc6SDave Kleikamp 
661470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
6624b905671SJan Kara 	if (!bh)
6634b905671SJan Kara 		return NULL;
664470decc6SDave Kleikamp 	lock_buffer(bh);
665470decc6SDave Kleikamp 	memset(bh->b_data, 0, journal->j_blocksize);
666470decc6SDave Kleikamp 	set_buffer_uptodate(bh);
667470decc6SDave Kleikamp 	unlock_buffer(bh);
668470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "return this buffer");
669f7f4bccbSMingming Cao 	return jbd2_journal_add_journal_head(bh);
670470decc6SDave Kleikamp }
671470decc6SDave Kleikamp 
6728e85fb3fSJohann Lombardi struct jbd2_stats_proc_session {
6738e85fb3fSJohann Lombardi 	journal_t *journal;
6748e85fb3fSJohann Lombardi 	struct transaction_stats_s *stats;
6758e85fb3fSJohann Lombardi 	int start;
6768e85fb3fSJohann Lombardi 	int max;
6778e85fb3fSJohann Lombardi };
6788e85fb3fSJohann Lombardi 
6798e85fb3fSJohann Lombardi static void *jbd2_seq_info_start(struct seq_file *seq, loff_t *pos)
6808e85fb3fSJohann Lombardi {
6818e85fb3fSJohann Lombardi 	return *pos ? NULL : SEQ_START_TOKEN;
6828e85fb3fSJohann Lombardi }
6838e85fb3fSJohann Lombardi 
6848e85fb3fSJohann Lombardi static void *jbd2_seq_info_next(struct seq_file *seq, void *v, loff_t *pos)
6858e85fb3fSJohann Lombardi {
6868e85fb3fSJohann Lombardi 	return NULL;
6878e85fb3fSJohann Lombardi }
6888e85fb3fSJohann Lombardi 
6898e85fb3fSJohann Lombardi static int jbd2_seq_info_show(struct seq_file *seq, void *v)
6908e85fb3fSJohann Lombardi {
6918e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
6928e85fb3fSJohann Lombardi 
6938e85fb3fSJohann Lombardi 	if (v != SEQ_START_TOKEN)
6948e85fb3fSJohann Lombardi 		return 0;
6958e85fb3fSJohann Lombardi 	seq_printf(seq, "%lu transaction, each up to %u blocks\n",
6968e85fb3fSJohann Lombardi 			s->stats->ts_tid,
6978e85fb3fSJohann Lombardi 			s->journal->j_max_transaction_buffers);
6988e85fb3fSJohann Lombardi 	if (s->stats->ts_tid == 0)
6998e85fb3fSJohann Lombardi 		return 0;
7008e85fb3fSJohann Lombardi 	seq_printf(seq, "average: \n  %ums waiting for transaction\n",
701bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_wait / s->stats->ts_tid));
7028e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums running transaction\n",
703bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_running / s->stats->ts_tid));
7048e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums transaction was being locked\n",
705bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_locked / s->stats->ts_tid));
7068e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums flushing data (in ordered mode)\n",
707bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_flushing / s->stats->ts_tid));
7088e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums logging transaction\n",
709bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_logging / s->stats->ts_tid));
710c225aa57SSimon Holm Thøgersen 	seq_printf(seq, "  %lluus average transaction commit time\n",
711c225aa57SSimon Holm Thøgersen 		   div_u64(s->journal->j_average_commit_time, 1000));
7128e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu handles per transaction\n",
713bf699327STheodore Ts'o 	    s->stats->run.rs_handle_count / s->stats->ts_tid);
7148e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu blocks per transaction\n",
715bf699327STheodore Ts'o 	    s->stats->run.rs_blocks / s->stats->ts_tid);
7168e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu logged blocks per transaction\n",
717bf699327STheodore Ts'o 	    s->stats->run.rs_blocks_logged / s->stats->ts_tid);
7188e85fb3fSJohann Lombardi 	return 0;
7198e85fb3fSJohann Lombardi }
7208e85fb3fSJohann Lombardi 
7218e85fb3fSJohann Lombardi static void jbd2_seq_info_stop(struct seq_file *seq, void *v)
7228e85fb3fSJohann Lombardi {
7238e85fb3fSJohann Lombardi }
7248e85fb3fSJohann Lombardi 
72588e9d34cSJames Morris static const struct seq_operations jbd2_seq_info_ops = {
7268e85fb3fSJohann Lombardi 	.start  = jbd2_seq_info_start,
7278e85fb3fSJohann Lombardi 	.next   = jbd2_seq_info_next,
7288e85fb3fSJohann Lombardi 	.stop   = jbd2_seq_info_stop,
7298e85fb3fSJohann Lombardi 	.show   = jbd2_seq_info_show,
7308e85fb3fSJohann Lombardi };
7318e85fb3fSJohann Lombardi 
7328e85fb3fSJohann Lombardi static int jbd2_seq_info_open(struct inode *inode, struct file *file)
7338e85fb3fSJohann Lombardi {
7348e85fb3fSJohann Lombardi 	journal_t *journal = PDE(inode)->data;
7358e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s;
7368e85fb3fSJohann Lombardi 	int rc, size;
7378e85fb3fSJohann Lombardi 
7388e85fb3fSJohann Lombardi 	s = kmalloc(sizeof(*s), GFP_KERNEL);
7398e85fb3fSJohann Lombardi 	if (s == NULL)
7408e85fb3fSJohann Lombardi 		return -ENOMEM;
7418e85fb3fSJohann Lombardi 	size = sizeof(struct transaction_stats_s);
7428e85fb3fSJohann Lombardi 	s->stats = kmalloc(size, GFP_KERNEL);
7438e85fb3fSJohann Lombardi 	if (s->stats == NULL) {
7448e85fb3fSJohann Lombardi 		kfree(s);
7458e85fb3fSJohann Lombardi 		return -ENOMEM;
7468e85fb3fSJohann Lombardi 	}
7478e85fb3fSJohann Lombardi 	spin_lock(&journal->j_history_lock);
7488e85fb3fSJohann Lombardi 	memcpy(s->stats, &journal->j_stats, size);
7498e85fb3fSJohann Lombardi 	s->journal = journal;
7508e85fb3fSJohann Lombardi 	spin_unlock(&journal->j_history_lock);
7518e85fb3fSJohann Lombardi 
7528e85fb3fSJohann Lombardi 	rc = seq_open(file, &jbd2_seq_info_ops);
7538e85fb3fSJohann Lombardi 	if (rc == 0) {
7548e85fb3fSJohann Lombardi 		struct seq_file *m = file->private_data;
7558e85fb3fSJohann Lombardi 		m->private = s;
7568e85fb3fSJohann Lombardi 	} else {
7578e85fb3fSJohann Lombardi 		kfree(s->stats);
7588e85fb3fSJohann Lombardi 		kfree(s);
7598e85fb3fSJohann Lombardi 	}
7608e85fb3fSJohann Lombardi 	return rc;
7618e85fb3fSJohann Lombardi 
7628e85fb3fSJohann Lombardi }
7638e85fb3fSJohann Lombardi 
7648e85fb3fSJohann Lombardi static int jbd2_seq_info_release(struct inode *inode, struct file *file)
7658e85fb3fSJohann Lombardi {
7668e85fb3fSJohann Lombardi 	struct seq_file *seq = file->private_data;
7678e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
7688e85fb3fSJohann Lombardi 	kfree(s->stats);
7698e85fb3fSJohann Lombardi 	kfree(s);
7708e85fb3fSJohann Lombardi 	return seq_release(inode, file);
7718e85fb3fSJohann Lombardi }
7728e85fb3fSJohann Lombardi 
773*828c0950SAlexey Dobriyan static const struct file_operations jbd2_seq_info_fops = {
7748e85fb3fSJohann Lombardi 	.owner		= THIS_MODULE,
7758e85fb3fSJohann Lombardi 	.open           = jbd2_seq_info_open,
7768e85fb3fSJohann Lombardi 	.read           = seq_read,
7778e85fb3fSJohann Lombardi 	.llseek         = seq_lseek,
7788e85fb3fSJohann Lombardi 	.release        = jbd2_seq_info_release,
7798e85fb3fSJohann Lombardi };
7808e85fb3fSJohann Lombardi 
7818e85fb3fSJohann Lombardi static struct proc_dir_entry *proc_jbd2_stats;
7828e85fb3fSJohann Lombardi 
7838e85fb3fSJohann Lombardi static void jbd2_stats_proc_init(journal_t *journal)
7848e85fb3fSJohann Lombardi {
78505496769STheodore Ts'o 	journal->j_proc_entry = proc_mkdir(journal->j_devname, proc_jbd2_stats);
7868e85fb3fSJohann Lombardi 	if (journal->j_proc_entry) {
78779da3664SDenis V. Lunev 		proc_create_data("info", S_IRUGO, journal->j_proc_entry,
78879da3664SDenis V. Lunev 				 &jbd2_seq_info_fops, journal);
7898e85fb3fSJohann Lombardi 	}
7908e85fb3fSJohann Lombardi }
7918e85fb3fSJohann Lombardi 
7928e85fb3fSJohann Lombardi static void jbd2_stats_proc_exit(journal_t *journal)
7938e85fb3fSJohann Lombardi {
7948e85fb3fSJohann Lombardi 	remove_proc_entry("info", journal->j_proc_entry);
79505496769STheodore Ts'o 	remove_proc_entry(journal->j_devname, proc_jbd2_stats);
7968e85fb3fSJohann Lombardi }
7978e85fb3fSJohann Lombardi 
798470decc6SDave Kleikamp /*
799470decc6SDave Kleikamp  * Management for journal control blocks: functions to create and
800470decc6SDave Kleikamp  * destroy journal_t structures, and to initialise and read existing
801470decc6SDave Kleikamp  * journal blocks from disk.  */
802470decc6SDave Kleikamp 
803470decc6SDave Kleikamp /* First: create and setup a journal_t object in memory.  We initialise
804470decc6SDave Kleikamp  * very few fields yet: that has to wait until we have created the
805470decc6SDave Kleikamp  * journal structures from from scratch, or loaded them from disk. */
806470decc6SDave Kleikamp 
807470decc6SDave Kleikamp static journal_t * journal_init_common (void)
808470decc6SDave Kleikamp {
809470decc6SDave Kleikamp 	journal_t *journal;
810470decc6SDave Kleikamp 	int err;
811470decc6SDave Kleikamp 
812d802ffa8SMingming Cao 	journal = kzalloc(sizeof(*journal), GFP_KERNEL|__GFP_NOFAIL);
813470decc6SDave Kleikamp 	if (!journal)
814470decc6SDave Kleikamp 		goto fail;
815470decc6SDave Kleikamp 
816470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_transaction_locked);
817470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_logspace);
818470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_done_commit);
819470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_checkpoint);
820470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_commit);
821470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_updates);
822470decc6SDave Kleikamp 	mutex_init(&journal->j_barrier);
823470decc6SDave Kleikamp 	mutex_init(&journal->j_checkpoint_mutex);
824470decc6SDave Kleikamp 	spin_lock_init(&journal->j_revoke_lock);
825470decc6SDave Kleikamp 	spin_lock_init(&journal->j_list_lock);
826470decc6SDave Kleikamp 	spin_lock_init(&journal->j_state_lock);
827470decc6SDave Kleikamp 
828cd02ff0bSMingming Cao 	journal->j_commit_interval = (HZ * JBD2_DEFAULT_MAX_COMMIT_AGE);
82930773840STheodore Ts'o 	journal->j_min_batch_time = 0;
83030773840STheodore Ts'o 	journal->j_max_batch_time = 15000; /* 15ms */
831470decc6SDave Kleikamp 
832470decc6SDave Kleikamp 	/* The journal is marked for error until we succeed with recovery! */
833f7f4bccbSMingming Cao 	journal->j_flags = JBD2_ABORT;
834470decc6SDave Kleikamp 
835470decc6SDave Kleikamp 	/* Set up a default-sized revoke table for the new mount. */
836f7f4bccbSMingming Cao 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
837470decc6SDave Kleikamp 	if (err) {
838470decc6SDave Kleikamp 		kfree(journal);
839470decc6SDave Kleikamp 		goto fail;
840470decc6SDave Kleikamp 	}
8418e85fb3fSJohann Lombardi 
842bf699327STheodore Ts'o 	spin_lock_init(&journal->j_history_lock);
8438e85fb3fSJohann Lombardi 
844470decc6SDave Kleikamp 	return journal;
845470decc6SDave Kleikamp fail:
846470decc6SDave Kleikamp 	return NULL;
847470decc6SDave Kleikamp }
848470decc6SDave Kleikamp 
849f7f4bccbSMingming Cao /* jbd2_journal_init_dev and jbd2_journal_init_inode:
850470decc6SDave Kleikamp  *
851470decc6SDave Kleikamp  * Create a journal structure assigned some fixed set of disk blocks to
852470decc6SDave Kleikamp  * the journal.  We don't actually touch those disk blocks yet, but we
853470decc6SDave Kleikamp  * need to set up all of the mapping information to tell the journaling
854470decc6SDave Kleikamp  * system where the journal blocks are.
855470decc6SDave Kleikamp  *
856470decc6SDave Kleikamp  */
857470decc6SDave Kleikamp 
858470decc6SDave Kleikamp /**
8595648ba5bSRandy Dunlap  *  journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure
860470decc6SDave Kleikamp  *  @bdev: Block device on which to create the journal
861470decc6SDave Kleikamp  *  @fs_dev: Device which hold journalled filesystem for this journal.
862470decc6SDave Kleikamp  *  @start: Block nr Start of journal.
863470decc6SDave Kleikamp  *  @len:  Length of the journal in blocks.
864470decc6SDave Kleikamp  *  @blocksize: blocksize of journalling device
8655648ba5bSRandy Dunlap  *
8665648ba5bSRandy Dunlap  *  Returns: a newly created journal_t *
867470decc6SDave Kleikamp  *
868f7f4bccbSMingming Cao  *  jbd2_journal_init_dev creates a journal which maps a fixed contiguous
869470decc6SDave Kleikamp  *  range of blocks on an arbitrary block device.
870470decc6SDave Kleikamp  *
871470decc6SDave Kleikamp  */
872f7f4bccbSMingming Cao journal_t * jbd2_journal_init_dev(struct block_device *bdev,
873470decc6SDave Kleikamp 			struct block_device *fs_dev,
87418eba7aaSMingming Cao 			unsigned long long start, int len, int blocksize)
875470decc6SDave Kleikamp {
876470decc6SDave Kleikamp 	journal_t *journal = journal_init_common();
877470decc6SDave Kleikamp 	struct buffer_head *bh;
87805496769STheodore Ts'o 	char *p;
879470decc6SDave Kleikamp 	int n;
880470decc6SDave Kleikamp 
881470decc6SDave Kleikamp 	if (!journal)
882470decc6SDave Kleikamp 		return NULL;
883470decc6SDave Kleikamp 
884470decc6SDave Kleikamp 	/* journal descriptor can store up to n blocks -bzzz */
885470decc6SDave Kleikamp 	journal->j_blocksize = blocksize;
8864b905671SJan Kara 	jbd2_stats_proc_init(journal);
887470decc6SDave Kleikamp 	n = journal->j_blocksize / sizeof(journal_block_tag_t);
888470decc6SDave Kleikamp 	journal->j_wbufsize = n;
889470decc6SDave Kleikamp 	journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
890470decc6SDave Kleikamp 	if (!journal->j_wbuf) {
891470decc6SDave Kleikamp 		printk(KERN_ERR "%s: Cant allocate bhs for commit thread\n",
892329d291fSHarvey Harrison 			__func__);
8934b905671SJan Kara 		goto out_err;
894470decc6SDave Kleikamp 	}
895470decc6SDave Kleikamp 	journal->j_dev = bdev;
896470decc6SDave Kleikamp 	journal->j_fs_dev = fs_dev;
897470decc6SDave Kleikamp 	journal->j_blk_offset = start;
898470decc6SDave Kleikamp 	journal->j_maxlen = len;
89905496769STheodore Ts'o 	bdevname(journal->j_dev, journal->j_devname);
90005496769STheodore Ts'o 	p = journal->j_devname;
90105496769STheodore Ts'o 	while ((p = strchr(p, '/')))
90205496769STheodore Ts'o 		*p = '!';
903470decc6SDave Kleikamp 
904470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, start, journal->j_blocksize);
9054b905671SJan Kara 	if (!bh) {
9064b905671SJan Kara 		printk(KERN_ERR
9074b905671SJan Kara 		       "%s: Cannot get buffer for journal superblock\n",
9084b905671SJan Kara 		       __func__);
9094b905671SJan Kara 		goto out_err;
9104b905671SJan Kara 	}
911470decc6SDave Kleikamp 	journal->j_sb_buffer = bh;
912470decc6SDave Kleikamp 	journal->j_superblock = (journal_superblock_t *)bh->b_data;
9134b905671SJan Kara 
914470decc6SDave Kleikamp 	return journal;
9154b905671SJan Kara out_err:
9164b905671SJan Kara 	jbd2_stats_proc_exit(journal);
9174b905671SJan Kara 	kfree(journal);
9184b905671SJan Kara 	return NULL;
919470decc6SDave Kleikamp }
920470decc6SDave Kleikamp 
921470decc6SDave Kleikamp /**
922f7f4bccbSMingming Cao  *  journal_t * jbd2_journal_init_inode () - creates a journal which maps to a inode.
923470decc6SDave Kleikamp  *  @inode: An inode to create the journal in
924470decc6SDave Kleikamp  *
925f7f4bccbSMingming Cao  * jbd2_journal_init_inode creates a journal which maps an on-disk inode as
926470decc6SDave Kleikamp  * the journal.  The inode must exist already, must support bmap() and
927470decc6SDave Kleikamp  * must have all data blocks preallocated.
928470decc6SDave Kleikamp  */
929f7f4bccbSMingming Cao journal_t * jbd2_journal_init_inode (struct inode *inode)
930470decc6SDave Kleikamp {
931470decc6SDave Kleikamp 	struct buffer_head *bh;
932470decc6SDave Kleikamp 	journal_t *journal = journal_init_common();
93305496769STheodore Ts'o 	char *p;
934470decc6SDave Kleikamp 	int err;
935470decc6SDave Kleikamp 	int n;
93618eba7aaSMingming Cao 	unsigned long long blocknr;
937470decc6SDave Kleikamp 
938470decc6SDave Kleikamp 	if (!journal)
939470decc6SDave Kleikamp 		return NULL;
940470decc6SDave Kleikamp 
941470decc6SDave Kleikamp 	journal->j_dev = journal->j_fs_dev = inode->i_sb->s_bdev;
942470decc6SDave Kleikamp 	journal->j_inode = inode;
94305496769STheodore Ts'o 	bdevname(journal->j_dev, journal->j_devname);
94405496769STheodore Ts'o 	p = journal->j_devname;
94505496769STheodore Ts'o 	while ((p = strchr(p, '/')))
94605496769STheodore Ts'o 		*p = '!';
94705496769STheodore Ts'o 	p = journal->j_devname + strlen(journal->j_devname);
94890576c0bSTheodore Ts'o 	sprintf(p, "-%lu", journal->j_inode->i_ino);
949470decc6SDave Kleikamp 	jbd_debug(1,
950470decc6SDave Kleikamp 		  "journal %p: inode %s/%ld, size %Ld, bits %d, blksize %ld\n",
951470decc6SDave Kleikamp 		  journal, inode->i_sb->s_id, inode->i_ino,
952470decc6SDave Kleikamp 		  (long long) inode->i_size,
953470decc6SDave Kleikamp 		  inode->i_sb->s_blocksize_bits, inode->i_sb->s_blocksize);
954470decc6SDave Kleikamp 
955470decc6SDave Kleikamp 	journal->j_maxlen = inode->i_size >> inode->i_sb->s_blocksize_bits;
956470decc6SDave Kleikamp 	journal->j_blocksize = inode->i_sb->s_blocksize;
9578e85fb3fSJohann Lombardi 	jbd2_stats_proc_init(journal);
958470decc6SDave Kleikamp 
959470decc6SDave Kleikamp 	/* journal descriptor can store up to n blocks -bzzz */
960470decc6SDave Kleikamp 	n = journal->j_blocksize / sizeof(journal_block_tag_t);
961470decc6SDave Kleikamp 	journal->j_wbufsize = n;
962470decc6SDave Kleikamp 	journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
963470decc6SDave Kleikamp 	if (!journal->j_wbuf) {
964470decc6SDave Kleikamp 		printk(KERN_ERR "%s: Cant allocate bhs for commit thread\n",
965329d291fSHarvey Harrison 			__func__);
9664b905671SJan Kara 		goto out_err;
967470decc6SDave Kleikamp 	}
968470decc6SDave Kleikamp 
969f7f4bccbSMingming Cao 	err = jbd2_journal_bmap(journal, 0, &blocknr);
970470decc6SDave Kleikamp 	/* If that failed, give up */
971470decc6SDave Kleikamp 	if (err) {
972470decc6SDave Kleikamp 		printk(KERN_ERR "%s: Cannnot locate journal superblock\n",
973329d291fSHarvey Harrison 		       __func__);
9744b905671SJan Kara 		goto out_err;
975470decc6SDave Kleikamp 	}
976470decc6SDave Kleikamp 
977470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
9784b905671SJan Kara 	if (!bh) {
9794b905671SJan Kara 		printk(KERN_ERR
9804b905671SJan Kara 		       "%s: Cannot get buffer for journal superblock\n",
9814b905671SJan Kara 		       __func__);
9824b905671SJan Kara 		goto out_err;
9834b905671SJan Kara 	}
984470decc6SDave Kleikamp 	journal->j_sb_buffer = bh;
985470decc6SDave Kleikamp 	journal->j_superblock = (journal_superblock_t *)bh->b_data;
986470decc6SDave Kleikamp 
987470decc6SDave Kleikamp 	return journal;
9884b905671SJan Kara out_err:
9894b905671SJan Kara 	jbd2_stats_proc_exit(journal);
9904b905671SJan Kara 	kfree(journal);
9914b905671SJan Kara 	return NULL;
992470decc6SDave Kleikamp }
993470decc6SDave Kleikamp 
994470decc6SDave Kleikamp /*
995470decc6SDave Kleikamp  * If the journal init or create aborts, we need to mark the journal
996470decc6SDave Kleikamp  * superblock as being NULL to prevent the journal destroy from writing
997470decc6SDave Kleikamp  * back a bogus superblock.
998470decc6SDave Kleikamp  */
999470decc6SDave Kleikamp static void journal_fail_superblock (journal_t *journal)
1000470decc6SDave Kleikamp {
1001470decc6SDave Kleikamp 	struct buffer_head *bh = journal->j_sb_buffer;
1002470decc6SDave Kleikamp 	brelse(bh);
1003470decc6SDave Kleikamp 	journal->j_sb_buffer = NULL;
1004470decc6SDave Kleikamp }
1005470decc6SDave Kleikamp 
1006470decc6SDave Kleikamp /*
1007470decc6SDave Kleikamp  * Given a journal_t structure, initialise the various fields for
1008470decc6SDave Kleikamp  * startup of a new journaling session.  We use this both when creating
1009470decc6SDave Kleikamp  * a journal, and after recovering an old journal to reset it for
1010470decc6SDave Kleikamp  * subsequent use.
1011470decc6SDave Kleikamp  */
1012470decc6SDave Kleikamp 
1013470decc6SDave Kleikamp static int journal_reset(journal_t *journal)
1014470decc6SDave Kleikamp {
1015470decc6SDave Kleikamp 	journal_superblock_t *sb = journal->j_superblock;
101618eba7aaSMingming Cao 	unsigned long long first, last;
1017470decc6SDave Kleikamp 
1018470decc6SDave Kleikamp 	first = be32_to_cpu(sb->s_first);
1019470decc6SDave Kleikamp 	last = be32_to_cpu(sb->s_maxlen);
1020f6f50e28SJan Kara 	if (first + JBD2_MIN_JOURNAL_BLOCKS > last + 1) {
1021f6f50e28SJan Kara 		printk(KERN_ERR "JBD: Journal too short (blocks %llu-%llu).\n",
1022f6f50e28SJan Kara 		       first, last);
1023f6f50e28SJan Kara 		journal_fail_superblock(journal);
1024f6f50e28SJan Kara 		return -EINVAL;
1025f6f50e28SJan Kara 	}
1026470decc6SDave Kleikamp 
1027470decc6SDave Kleikamp 	journal->j_first = first;
1028470decc6SDave Kleikamp 	journal->j_last = last;
1029470decc6SDave Kleikamp 
1030470decc6SDave Kleikamp 	journal->j_head = first;
1031470decc6SDave Kleikamp 	journal->j_tail = first;
1032470decc6SDave Kleikamp 	journal->j_free = last - first;
1033470decc6SDave Kleikamp 
1034470decc6SDave Kleikamp 	journal->j_tail_sequence = journal->j_transaction_sequence;
1035470decc6SDave Kleikamp 	journal->j_commit_sequence = journal->j_transaction_sequence - 1;
1036470decc6SDave Kleikamp 	journal->j_commit_request = journal->j_commit_sequence;
1037470decc6SDave Kleikamp 
1038470decc6SDave Kleikamp 	journal->j_max_transaction_buffers = journal->j_maxlen / 4;
1039470decc6SDave Kleikamp 
1040470decc6SDave Kleikamp 	/* Add the dynamic fields and write it to disk. */
1041f7f4bccbSMingming Cao 	jbd2_journal_update_superblock(journal, 1);
104297f06784SPavel Emelianov 	return jbd2_journal_start_thread(journal);
1043470decc6SDave Kleikamp }
1044470decc6SDave Kleikamp 
1045470decc6SDave Kleikamp /**
1046f7f4bccbSMingming Cao  * void jbd2_journal_update_superblock() - Update journal sb on disk.
1047470decc6SDave Kleikamp  * @journal: The journal to update.
1048470decc6SDave Kleikamp  * @wait: Set to '0' if you don't want to wait for IO completion.
1049470decc6SDave Kleikamp  *
1050470decc6SDave Kleikamp  * Update a journal's dynamic superblock fields and write it to disk,
1051470decc6SDave Kleikamp  * optionally waiting for the IO to complete.
1052470decc6SDave Kleikamp  */
1053f7f4bccbSMingming Cao void jbd2_journal_update_superblock(journal_t *journal, int wait)
1054470decc6SDave Kleikamp {
1055470decc6SDave Kleikamp 	journal_superblock_t *sb = journal->j_superblock;
1056470decc6SDave Kleikamp 	struct buffer_head *bh = journal->j_sb_buffer;
1057470decc6SDave Kleikamp 
1058470decc6SDave Kleikamp 	/*
1059470decc6SDave Kleikamp 	 * As a special case, if the on-disk copy is already marked as needing
1060470decc6SDave Kleikamp 	 * no recovery (s_start == 0) and there are no outstanding transactions
1061470decc6SDave Kleikamp 	 * in the filesystem, then we can safely defer the superblock update
1062f7f4bccbSMingming Cao 	 * until the next commit by setting JBD2_FLUSHED.  This avoids
1063470decc6SDave Kleikamp 	 * attempting a write to a potential-readonly device.
1064470decc6SDave Kleikamp 	 */
1065470decc6SDave Kleikamp 	if (sb->s_start == 0 && journal->j_tail_sequence ==
1066470decc6SDave Kleikamp 				journal->j_transaction_sequence) {
1067470decc6SDave Kleikamp 		jbd_debug(1,"JBD: Skipping superblock update on recovered sb "
1068470decc6SDave Kleikamp 			"(start %ld, seq %d, errno %d)\n",
1069470decc6SDave Kleikamp 			journal->j_tail, journal->j_tail_sequence,
1070470decc6SDave Kleikamp 			journal->j_errno);
1071470decc6SDave Kleikamp 		goto out;
1072470decc6SDave Kleikamp 	}
1073470decc6SDave Kleikamp 
1074914258bfSTheodore Ts'o 	if (buffer_write_io_error(bh)) {
1075914258bfSTheodore Ts'o 		/*
1076914258bfSTheodore Ts'o 		 * Oh, dear.  A previous attempt to write the journal
1077914258bfSTheodore Ts'o 		 * superblock failed.  This could happen because the
1078914258bfSTheodore Ts'o 		 * USB device was yanked out.  Or it could happen to
1079914258bfSTheodore Ts'o 		 * be a transient write error and maybe the block will
1080914258bfSTheodore Ts'o 		 * be remapped.  Nothing we can do but to retry the
1081914258bfSTheodore Ts'o 		 * write and hope for the best.
1082914258bfSTheodore Ts'o 		 */
1083914258bfSTheodore Ts'o 		printk(KERN_ERR "JBD2: previous I/O error detected "
1084914258bfSTheodore Ts'o 		       "for journal superblock update for %s.\n",
1085914258bfSTheodore Ts'o 		       journal->j_devname);
1086914258bfSTheodore Ts'o 		clear_buffer_write_io_error(bh);
1087914258bfSTheodore Ts'o 		set_buffer_uptodate(bh);
1088914258bfSTheodore Ts'o 	}
1089914258bfSTheodore Ts'o 
1090470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1091470decc6SDave Kleikamp 	jbd_debug(1,"JBD: updating superblock (start %ld, seq %d, errno %d)\n",
1092470decc6SDave Kleikamp 		  journal->j_tail, journal->j_tail_sequence, journal->j_errno);
1093470decc6SDave Kleikamp 
1094470decc6SDave Kleikamp 	sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
1095470decc6SDave Kleikamp 	sb->s_start    = cpu_to_be32(journal->j_tail);
1096470decc6SDave Kleikamp 	sb->s_errno    = cpu_to_be32(journal->j_errno);
1097470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1098470decc6SDave Kleikamp 
1099470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "marking dirty");
1100470decc6SDave Kleikamp 	mark_buffer_dirty(bh);
1101914258bfSTheodore Ts'o 	if (wait) {
1102470decc6SDave Kleikamp 		sync_dirty_buffer(bh);
1103914258bfSTheodore Ts'o 		if (buffer_write_io_error(bh)) {
1104914258bfSTheodore Ts'o 			printk(KERN_ERR "JBD2: I/O error detected "
1105914258bfSTheodore Ts'o 			       "when updating journal superblock for %s.\n",
1106914258bfSTheodore Ts'o 			       journal->j_devname);
1107914258bfSTheodore Ts'o 			clear_buffer_write_io_error(bh);
1108914258bfSTheodore Ts'o 			set_buffer_uptodate(bh);
1109914258bfSTheodore Ts'o 		}
1110914258bfSTheodore Ts'o 	} else
1111470decc6SDave Kleikamp 		ll_rw_block(SWRITE, 1, &bh);
1112470decc6SDave Kleikamp 
1113470decc6SDave Kleikamp out:
1114470decc6SDave Kleikamp 	/* If we have just flushed the log (by marking s_start==0), then
1115470decc6SDave Kleikamp 	 * any future commit will have to be careful to update the
1116470decc6SDave Kleikamp 	 * superblock again to re-record the true start of the log. */
1117470decc6SDave Kleikamp 
1118470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1119470decc6SDave Kleikamp 	if (sb->s_start)
1120f7f4bccbSMingming Cao 		journal->j_flags &= ~JBD2_FLUSHED;
1121470decc6SDave Kleikamp 	else
1122f7f4bccbSMingming Cao 		journal->j_flags |= JBD2_FLUSHED;
1123470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1124470decc6SDave Kleikamp }
1125470decc6SDave Kleikamp 
1126470decc6SDave Kleikamp /*
1127470decc6SDave Kleikamp  * Read the superblock for a given journal, performing initial
1128470decc6SDave Kleikamp  * validation of the format.
1129470decc6SDave Kleikamp  */
1130470decc6SDave Kleikamp 
1131470decc6SDave Kleikamp static int journal_get_superblock(journal_t *journal)
1132470decc6SDave Kleikamp {
1133470decc6SDave Kleikamp 	struct buffer_head *bh;
1134470decc6SDave Kleikamp 	journal_superblock_t *sb;
1135470decc6SDave Kleikamp 	int err = -EIO;
1136470decc6SDave Kleikamp 
1137470decc6SDave Kleikamp 	bh = journal->j_sb_buffer;
1138470decc6SDave Kleikamp 
1139470decc6SDave Kleikamp 	J_ASSERT(bh != NULL);
1140470decc6SDave Kleikamp 	if (!buffer_uptodate(bh)) {
1141470decc6SDave Kleikamp 		ll_rw_block(READ, 1, &bh);
1142470decc6SDave Kleikamp 		wait_on_buffer(bh);
1143470decc6SDave Kleikamp 		if (!buffer_uptodate(bh)) {
1144470decc6SDave Kleikamp 			printk (KERN_ERR
1145470decc6SDave Kleikamp 				"JBD: IO error reading journal superblock\n");
1146470decc6SDave Kleikamp 			goto out;
1147470decc6SDave Kleikamp 		}
1148470decc6SDave Kleikamp 	}
1149470decc6SDave Kleikamp 
1150470decc6SDave Kleikamp 	sb = journal->j_superblock;
1151470decc6SDave Kleikamp 
1152470decc6SDave Kleikamp 	err = -EINVAL;
1153470decc6SDave Kleikamp 
1154f7f4bccbSMingming Cao 	if (sb->s_header.h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER) ||
1155470decc6SDave Kleikamp 	    sb->s_blocksize != cpu_to_be32(journal->j_blocksize)) {
1156470decc6SDave Kleikamp 		printk(KERN_WARNING "JBD: no valid journal superblock found\n");
1157470decc6SDave Kleikamp 		goto out;
1158470decc6SDave Kleikamp 	}
1159470decc6SDave Kleikamp 
1160470decc6SDave Kleikamp 	switch(be32_to_cpu(sb->s_header.h_blocktype)) {
1161f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V1:
1162470decc6SDave Kleikamp 		journal->j_format_version = 1;
1163470decc6SDave Kleikamp 		break;
1164f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V2:
1165470decc6SDave Kleikamp 		journal->j_format_version = 2;
1166470decc6SDave Kleikamp 		break;
1167470decc6SDave Kleikamp 	default:
1168470decc6SDave Kleikamp 		printk(KERN_WARNING "JBD: unrecognised superblock format ID\n");
1169470decc6SDave Kleikamp 		goto out;
1170470decc6SDave Kleikamp 	}
1171470decc6SDave Kleikamp 
1172470decc6SDave Kleikamp 	if (be32_to_cpu(sb->s_maxlen) < journal->j_maxlen)
1173470decc6SDave Kleikamp 		journal->j_maxlen = be32_to_cpu(sb->s_maxlen);
1174470decc6SDave Kleikamp 	else if (be32_to_cpu(sb->s_maxlen) > journal->j_maxlen) {
1175470decc6SDave Kleikamp 		printk (KERN_WARNING "JBD: journal file too short\n");
1176470decc6SDave Kleikamp 		goto out;
1177470decc6SDave Kleikamp 	}
1178470decc6SDave Kleikamp 
1179470decc6SDave Kleikamp 	return 0;
1180470decc6SDave Kleikamp 
1181470decc6SDave Kleikamp out:
1182470decc6SDave Kleikamp 	journal_fail_superblock(journal);
1183470decc6SDave Kleikamp 	return err;
1184470decc6SDave Kleikamp }
1185470decc6SDave Kleikamp 
1186470decc6SDave Kleikamp /*
1187470decc6SDave Kleikamp  * Load the on-disk journal superblock and read the key fields into the
1188470decc6SDave Kleikamp  * journal_t.
1189470decc6SDave Kleikamp  */
1190470decc6SDave Kleikamp 
1191470decc6SDave Kleikamp static int load_superblock(journal_t *journal)
1192470decc6SDave Kleikamp {
1193470decc6SDave Kleikamp 	int err;
1194470decc6SDave Kleikamp 	journal_superblock_t *sb;
1195470decc6SDave Kleikamp 
1196470decc6SDave Kleikamp 	err = journal_get_superblock(journal);
1197470decc6SDave Kleikamp 	if (err)
1198470decc6SDave Kleikamp 		return err;
1199470decc6SDave Kleikamp 
1200470decc6SDave Kleikamp 	sb = journal->j_superblock;
1201470decc6SDave Kleikamp 
1202470decc6SDave Kleikamp 	journal->j_tail_sequence = be32_to_cpu(sb->s_sequence);
1203470decc6SDave Kleikamp 	journal->j_tail = be32_to_cpu(sb->s_start);
1204470decc6SDave Kleikamp 	journal->j_first = be32_to_cpu(sb->s_first);
1205470decc6SDave Kleikamp 	journal->j_last = be32_to_cpu(sb->s_maxlen);
1206470decc6SDave Kleikamp 	journal->j_errno = be32_to_cpu(sb->s_errno);
1207470decc6SDave Kleikamp 
1208470decc6SDave Kleikamp 	return 0;
1209470decc6SDave Kleikamp }
1210470decc6SDave Kleikamp 
1211470decc6SDave Kleikamp 
1212470decc6SDave Kleikamp /**
1213f7f4bccbSMingming Cao  * int jbd2_journal_load() - Read journal from disk.
1214470decc6SDave Kleikamp  * @journal: Journal to act on.
1215470decc6SDave Kleikamp  *
1216470decc6SDave Kleikamp  * Given a journal_t structure which tells us which disk blocks contain
1217470decc6SDave Kleikamp  * a journal, read the journal from disk to initialise the in-memory
1218470decc6SDave Kleikamp  * structures.
1219470decc6SDave Kleikamp  */
1220f7f4bccbSMingming Cao int jbd2_journal_load(journal_t *journal)
1221470decc6SDave Kleikamp {
1222470decc6SDave Kleikamp 	int err;
1223470decc6SDave Kleikamp 	journal_superblock_t *sb;
1224470decc6SDave Kleikamp 
1225470decc6SDave Kleikamp 	err = load_superblock(journal);
1226470decc6SDave Kleikamp 	if (err)
1227470decc6SDave Kleikamp 		return err;
1228470decc6SDave Kleikamp 
1229470decc6SDave Kleikamp 	sb = journal->j_superblock;
1230470decc6SDave Kleikamp 	/* If this is a V2 superblock, then we have to check the
1231470decc6SDave Kleikamp 	 * features flags on it. */
1232470decc6SDave Kleikamp 
1233470decc6SDave Kleikamp 	if (journal->j_format_version >= 2) {
1234470decc6SDave Kleikamp 		if ((sb->s_feature_ro_compat &
1235f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_ROCOMPAT_FEATURES)) ||
1236470decc6SDave Kleikamp 		    (sb->s_feature_incompat &
1237f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_INCOMPAT_FEATURES))) {
1238470decc6SDave Kleikamp 			printk (KERN_WARNING
1239470decc6SDave Kleikamp 				"JBD: Unrecognised features on journal\n");
1240470decc6SDave Kleikamp 			return -EINVAL;
1241470decc6SDave Kleikamp 		}
1242470decc6SDave Kleikamp 	}
1243470decc6SDave Kleikamp 
1244470decc6SDave Kleikamp 	/* Let the recovery code check whether it needs to recover any
1245470decc6SDave Kleikamp 	 * data from the journal. */
1246f7f4bccbSMingming Cao 	if (jbd2_journal_recover(journal))
1247470decc6SDave Kleikamp 		goto recovery_error;
1248470decc6SDave Kleikamp 
1249470decc6SDave Kleikamp 	/* OK, we've finished with the dynamic journal bits:
1250470decc6SDave Kleikamp 	 * reinitialise the dynamic contents of the superblock in memory
1251470decc6SDave Kleikamp 	 * and reset them on disk. */
1252470decc6SDave Kleikamp 	if (journal_reset(journal))
1253470decc6SDave Kleikamp 		goto recovery_error;
1254470decc6SDave Kleikamp 
1255f7f4bccbSMingming Cao 	journal->j_flags &= ~JBD2_ABORT;
1256f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_LOADED;
1257470decc6SDave Kleikamp 	return 0;
1258470decc6SDave Kleikamp 
1259470decc6SDave Kleikamp recovery_error:
1260470decc6SDave Kleikamp 	printk (KERN_WARNING "JBD: recovery failed\n");
1261470decc6SDave Kleikamp 	return -EIO;
1262470decc6SDave Kleikamp }
1263470decc6SDave Kleikamp 
1264470decc6SDave Kleikamp /**
1265f7f4bccbSMingming Cao  * void jbd2_journal_destroy() - Release a journal_t structure.
1266470decc6SDave Kleikamp  * @journal: Journal to act on.
1267470decc6SDave Kleikamp  *
1268470decc6SDave Kleikamp  * Release a journal_t structure once it is no longer in use by the
1269470decc6SDave Kleikamp  * journaled object.
127044519fafSHidehiro Kawai  * Return <0 if we couldn't clean up the journal.
1271470decc6SDave Kleikamp  */
127244519fafSHidehiro Kawai int jbd2_journal_destroy(journal_t *journal)
1273470decc6SDave Kleikamp {
127444519fafSHidehiro Kawai 	int err = 0;
127544519fafSHidehiro Kawai 
1276470decc6SDave Kleikamp 	/* Wait for the commit thread to wake up and die. */
1277470decc6SDave Kleikamp 	journal_kill_thread(journal);
1278470decc6SDave Kleikamp 
1279470decc6SDave Kleikamp 	/* Force a final log commit */
1280470decc6SDave Kleikamp 	if (journal->j_running_transaction)
1281f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
1282470decc6SDave Kleikamp 
1283470decc6SDave Kleikamp 	/* Force any old transactions to disk */
1284470decc6SDave Kleikamp 
1285470decc6SDave Kleikamp 	/* Totally anal locking here... */
1286470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
1287470decc6SDave Kleikamp 	while (journal->j_checkpoint_transactions != NULL) {
1288470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
12891a0d3786STheodore Ts'o 		mutex_lock(&journal->j_checkpoint_mutex);
1290f7f4bccbSMingming Cao 		jbd2_log_do_checkpoint(journal);
12911a0d3786STheodore Ts'o 		mutex_unlock(&journal->j_checkpoint_mutex);
1292470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
1293470decc6SDave Kleikamp 	}
1294470decc6SDave Kleikamp 
1295470decc6SDave Kleikamp 	J_ASSERT(journal->j_running_transaction == NULL);
1296470decc6SDave Kleikamp 	J_ASSERT(journal->j_committing_transaction == NULL);
1297470decc6SDave Kleikamp 	J_ASSERT(journal->j_checkpoint_transactions == NULL);
1298470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
1299470decc6SDave Kleikamp 
130044519fafSHidehiro Kawai 	if (journal->j_sb_buffer) {
130144519fafSHidehiro Kawai 		if (!is_journal_aborted(journal)) {
1302470decc6SDave Kleikamp 			/* We can now mark the journal as empty. */
1303470decc6SDave Kleikamp 			journal->j_tail = 0;
130444519fafSHidehiro Kawai 			journal->j_tail_sequence =
130544519fafSHidehiro Kawai 				++journal->j_transaction_sequence;
1306f7f4bccbSMingming Cao 			jbd2_journal_update_superblock(journal, 1);
130744519fafSHidehiro Kawai 		} else {
130844519fafSHidehiro Kawai 			err = -EIO;
130944519fafSHidehiro Kawai 		}
1310470decc6SDave Kleikamp 		brelse(journal->j_sb_buffer);
1311470decc6SDave Kleikamp 	}
1312470decc6SDave Kleikamp 
13138e85fb3fSJohann Lombardi 	if (journal->j_proc_entry)
13148e85fb3fSJohann Lombardi 		jbd2_stats_proc_exit(journal);
1315470decc6SDave Kleikamp 	if (journal->j_inode)
1316470decc6SDave Kleikamp 		iput(journal->j_inode);
1317470decc6SDave Kleikamp 	if (journal->j_revoke)
1318f7f4bccbSMingming Cao 		jbd2_journal_destroy_revoke(journal);
1319470decc6SDave Kleikamp 	kfree(journal->j_wbuf);
1320470decc6SDave Kleikamp 	kfree(journal);
132144519fafSHidehiro Kawai 
132244519fafSHidehiro Kawai 	return err;
1323470decc6SDave Kleikamp }
1324470decc6SDave Kleikamp 
1325470decc6SDave Kleikamp 
1326470decc6SDave Kleikamp /**
1327f7f4bccbSMingming Cao  *int jbd2_journal_check_used_features () - Check if features specified are used.
1328470decc6SDave Kleikamp  * @journal: Journal to check.
1329470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1330470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1331470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1332470decc6SDave Kleikamp  *
1333470decc6SDave Kleikamp  * Check whether the journal uses all of a given set of
1334470decc6SDave Kleikamp  * features.  Return true (non-zero) if it does.
1335470decc6SDave Kleikamp  **/
1336470decc6SDave Kleikamp 
1337f7f4bccbSMingming Cao int jbd2_journal_check_used_features (journal_t *journal, unsigned long compat,
1338470decc6SDave Kleikamp 				 unsigned long ro, unsigned long incompat)
1339470decc6SDave Kleikamp {
1340470decc6SDave Kleikamp 	journal_superblock_t *sb;
1341470decc6SDave Kleikamp 
1342470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
1343470decc6SDave Kleikamp 		return 1;
1344470decc6SDave Kleikamp 	if (journal->j_format_version == 1)
1345470decc6SDave Kleikamp 		return 0;
1346470decc6SDave Kleikamp 
1347470decc6SDave Kleikamp 	sb = journal->j_superblock;
1348470decc6SDave Kleikamp 
1349470decc6SDave Kleikamp 	if (((be32_to_cpu(sb->s_feature_compat) & compat) == compat) &&
1350470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_ro_compat) & ro) == ro) &&
1351470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_incompat) & incompat) == incompat))
1352470decc6SDave Kleikamp 		return 1;
1353470decc6SDave Kleikamp 
1354470decc6SDave Kleikamp 	return 0;
1355470decc6SDave Kleikamp }
1356470decc6SDave Kleikamp 
1357470decc6SDave Kleikamp /**
1358f7f4bccbSMingming Cao  * int jbd2_journal_check_available_features() - Check feature set in journalling layer
1359470decc6SDave Kleikamp  * @journal: Journal to check.
1360470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1361470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1362470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1363470decc6SDave Kleikamp  *
1364470decc6SDave Kleikamp  * Check whether the journaling code supports the use of
1365470decc6SDave Kleikamp  * all of a given set of features on this journal.  Return true
1366470decc6SDave Kleikamp  * (non-zero) if it can. */
1367470decc6SDave Kleikamp 
1368f7f4bccbSMingming Cao int jbd2_journal_check_available_features (journal_t *journal, unsigned long compat,
1369470decc6SDave Kleikamp 				      unsigned long ro, unsigned long incompat)
1370470decc6SDave Kleikamp {
1371470decc6SDave Kleikamp 	journal_superblock_t *sb;
1372470decc6SDave Kleikamp 
1373470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
1374470decc6SDave Kleikamp 		return 1;
1375470decc6SDave Kleikamp 
1376470decc6SDave Kleikamp 	sb = journal->j_superblock;
1377470decc6SDave Kleikamp 
1378470decc6SDave Kleikamp 	/* We can support any known requested features iff the
1379470decc6SDave Kleikamp 	 * superblock is in version 2.  Otherwise we fail to support any
1380470decc6SDave Kleikamp 	 * extended sb features. */
1381470decc6SDave Kleikamp 
1382470decc6SDave Kleikamp 	if (journal->j_format_version != 2)
1383470decc6SDave Kleikamp 		return 0;
1384470decc6SDave Kleikamp 
1385f7f4bccbSMingming Cao 	if ((compat   & JBD2_KNOWN_COMPAT_FEATURES) == compat &&
1386f7f4bccbSMingming Cao 	    (ro       & JBD2_KNOWN_ROCOMPAT_FEATURES) == ro &&
1387f7f4bccbSMingming Cao 	    (incompat & JBD2_KNOWN_INCOMPAT_FEATURES) == incompat)
1388470decc6SDave Kleikamp 		return 1;
1389470decc6SDave Kleikamp 
1390470decc6SDave Kleikamp 	return 0;
1391470decc6SDave Kleikamp }
1392470decc6SDave Kleikamp 
1393470decc6SDave Kleikamp /**
1394f7f4bccbSMingming Cao  * int jbd2_journal_set_features () - Mark a given journal feature in the superblock
1395470decc6SDave Kleikamp  * @journal: Journal to act on.
1396470decc6SDave Kleikamp  * @compat: bitmask of compatible features
1397470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
1398470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
1399470decc6SDave Kleikamp  *
1400470decc6SDave Kleikamp  * Mark a given journal feature as present on the
1401470decc6SDave Kleikamp  * superblock.  Returns true if the requested features could be set.
1402470decc6SDave Kleikamp  *
1403470decc6SDave Kleikamp  */
1404470decc6SDave Kleikamp 
1405f7f4bccbSMingming Cao int jbd2_journal_set_features (journal_t *journal, unsigned long compat,
1406470decc6SDave Kleikamp 			  unsigned long ro, unsigned long incompat)
1407470decc6SDave Kleikamp {
1408470decc6SDave Kleikamp 	journal_superblock_t *sb;
1409470decc6SDave Kleikamp 
1410f7f4bccbSMingming Cao 	if (jbd2_journal_check_used_features(journal, compat, ro, incompat))
1411470decc6SDave Kleikamp 		return 1;
1412470decc6SDave Kleikamp 
1413f7f4bccbSMingming Cao 	if (!jbd2_journal_check_available_features(journal, compat, ro, incompat))
1414470decc6SDave Kleikamp 		return 0;
1415470decc6SDave Kleikamp 
1416470decc6SDave Kleikamp 	jbd_debug(1, "Setting new features 0x%lx/0x%lx/0x%lx\n",
1417470decc6SDave Kleikamp 		  compat, ro, incompat);
1418470decc6SDave Kleikamp 
1419470decc6SDave Kleikamp 	sb = journal->j_superblock;
1420470decc6SDave Kleikamp 
1421470decc6SDave Kleikamp 	sb->s_feature_compat    |= cpu_to_be32(compat);
1422470decc6SDave Kleikamp 	sb->s_feature_ro_compat |= cpu_to_be32(ro);
1423470decc6SDave Kleikamp 	sb->s_feature_incompat  |= cpu_to_be32(incompat);
1424470decc6SDave Kleikamp 
1425470decc6SDave Kleikamp 	return 1;
1426470decc6SDave Kleikamp }
1427470decc6SDave Kleikamp 
1428818d276cSGirish Shilamkar /*
1429818d276cSGirish Shilamkar  * jbd2_journal_clear_features () - Clear a given journal feature in the
1430818d276cSGirish Shilamkar  * 				    superblock
1431818d276cSGirish Shilamkar  * @journal: Journal to act on.
1432818d276cSGirish Shilamkar  * @compat: bitmask of compatible features
1433818d276cSGirish Shilamkar  * @ro: bitmask of features that force read-only mount
1434818d276cSGirish Shilamkar  * @incompat: bitmask of incompatible features
1435818d276cSGirish Shilamkar  *
1436818d276cSGirish Shilamkar  * Clear a given journal feature as present on the
1437818d276cSGirish Shilamkar  * superblock.
1438818d276cSGirish Shilamkar  */
1439818d276cSGirish Shilamkar void jbd2_journal_clear_features(journal_t *journal, unsigned long compat,
1440818d276cSGirish Shilamkar 				unsigned long ro, unsigned long incompat)
1441818d276cSGirish Shilamkar {
1442818d276cSGirish Shilamkar 	journal_superblock_t *sb;
1443818d276cSGirish Shilamkar 
1444818d276cSGirish Shilamkar 	jbd_debug(1, "Clear features 0x%lx/0x%lx/0x%lx\n",
1445818d276cSGirish Shilamkar 		  compat, ro, incompat);
1446818d276cSGirish Shilamkar 
1447818d276cSGirish Shilamkar 	sb = journal->j_superblock;
1448818d276cSGirish Shilamkar 
1449818d276cSGirish Shilamkar 	sb->s_feature_compat    &= ~cpu_to_be32(compat);
1450818d276cSGirish Shilamkar 	sb->s_feature_ro_compat &= ~cpu_to_be32(ro);
1451818d276cSGirish Shilamkar 	sb->s_feature_incompat  &= ~cpu_to_be32(incompat);
1452818d276cSGirish Shilamkar }
1453818d276cSGirish Shilamkar EXPORT_SYMBOL(jbd2_journal_clear_features);
1454470decc6SDave Kleikamp 
1455470decc6SDave Kleikamp /**
1456f7f4bccbSMingming Cao  * int jbd2_journal_update_format () - Update on-disk journal structure.
1457470decc6SDave Kleikamp  * @journal: Journal to act on.
1458470decc6SDave Kleikamp  *
1459470decc6SDave Kleikamp  * Given an initialised but unloaded journal struct, poke about in the
1460470decc6SDave Kleikamp  * on-disk structure to update it to the most recent supported version.
1461470decc6SDave Kleikamp  */
1462f7f4bccbSMingming Cao int jbd2_journal_update_format (journal_t *journal)
1463470decc6SDave Kleikamp {
1464470decc6SDave Kleikamp 	journal_superblock_t *sb;
1465470decc6SDave Kleikamp 	int err;
1466470decc6SDave Kleikamp 
1467470decc6SDave Kleikamp 	err = journal_get_superblock(journal);
1468470decc6SDave Kleikamp 	if (err)
1469470decc6SDave Kleikamp 		return err;
1470470decc6SDave Kleikamp 
1471470decc6SDave Kleikamp 	sb = journal->j_superblock;
1472470decc6SDave Kleikamp 
1473470decc6SDave Kleikamp 	switch (be32_to_cpu(sb->s_header.h_blocktype)) {
1474f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V2:
1475470decc6SDave Kleikamp 		return 0;
1476f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V1:
1477470decc6SDave Kleikamp 		return journal_convert_superblock_v1(journal, sb);
1478470decc6SDave Kleikamp 	default:
1479470decc6SDave Kleikamp 		break;
1480470decc6SDave Kleikamp 	}
1481470decc6SDave Kleikamp 	return -EINVAL;
1482470decc6SDave Kleikamp }
1483470decc6SDave Kleikamp 
1484470decc6SDave Kleikamp static int journal_convert_superblock_v1(journal_t *journal,
1485470decc6SDave Kleikamp 					 journal_superblock_t *sb)
1486470decc6SDave Kleikamp {
1487470decc6SDave Kleikamp 	int offset, blocksize;
1488470decc6SDave Kleikamp 	struct buffer_head *bh;
1489470decc6SDave Kleikamp 
1490470decc6SDave Kleikamp 	printk(KERN_WARNING
1491470decc6SDave Kleikamp 		"JBD: Converting superblock from version 1 to 2.\n");
1492470decc6SDave Kleikamp 
1493470decc6SDave Kleikamp 	/* Pre-initialise new fields to zero */
1494470decc6SDave Kleikamp 	offset = ((char *) &(sb->s_feature_compat)) - ((char *) sb);
1495470decc6SDave Kleikamp 	blocksize = be32_to_cpu(sb->s_blocksize);
1496470decc6SDave Kleikamp 	memset(&sb->s_feature_compat, 0, blocksize-offset);
1497470decc6SDave Kleikamp 
1498470decc6SDave Kleikamp 	sb->s_nr_users = cpu_to_be32(1);
1499f7f4bccbSMingming Cao 	sb->s_header.h_blocktype = cpu_to_be32(JBD2_SUPERBLOCK_V2);
1500470decc6SDave Kleikamp 	journal->j_format_version = 2;
1501470decc6SDave Kleikamp 
1502470decc6SDave Kleikamp 	bh = journal->j_sb_buffer;
1503470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "marking dirty");
1504470decc6SDave Kleikamp 	mark_buffer_dirty(bh);
1505470decc6SDave Kleikamp 	sync_dirty_buffer(bh);
1506470decc6SDave Kleikamp 	return 0;
1507470decc6SDave Kleikamp }
1508470decc6SDave Kleikamp 
1509470decc6SDave Kleikamp 
1510470decc6SDave Kleikamp /**
1511f7f4bccbSMingming Cao  * int jbd2_journal_flush () - Flush journal
1512470decc6SDave Kleikamp  * @journal: Journal to act on.
1513470decc6SDave Kleikamp  *
1514470decc6SDave Kleikamp  * Flush all data for a given journal to disk and empty the journal.
1515470decc6SDave Kleikamp  * Filesystems can use this when remounting readonly to ensure that
1516470decc6SDave Kleikamp  * recovery does not need to happen on remount.
1517470decc6SDave Kleikamp  */
1518470decc6SDave Kleikamp 
1519f7f4bccbSMingming Cao int jbd2_journal_flush(journal_t *journal)
1520470decc6SDave Kleikamp {
1521470decc6SDave Kleikamp 	int err = 0;
1522470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
1523470decc6SDave Kleikamp 	unsigned long old_tail;
1524470decc6SDave Kleikamp 
1525470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1526470decc6SDave Kleikamp 
1527470decc6SDave Kleikamp 	/* Force everything buffered to the log... */
1528470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
1529470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
1530f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
1531470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
1532470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
1533470decc6SDave Kleikamp 
1534470decc6SDave Kleikamp 	/* Wait for the log commit to complete... */
1535470decc6SDave Kleikamp 	if (transaction) {
1536470decc6SDave Kleikamp 		tid_t tid = transaction->t_tid;
1537470decc6SDave Kleikamp 
1538470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
1539f7f4bccbSMingming Cao 		jbd2_log_wait_commit(journal, tid);
1540470decc6SDave Kleikamp 	} else {
1541470decc6SDave Kleikamp 		spin_unlock(&journal->j_state_lock);
1542470decc6SDave Kleikamp 	}
1543470decc6SDave Kleikamp 
1544470decc6SDave Kleikamp 	/* ...and flush everything in the log out to disk. */
1545470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
1546470decc6SDave Kleikamp 	while (!err && journal->j_checkpoint_transactions != NULL) {
1547470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
154844519fafSHidehiro Kawai 		mutex_lock(&journal->j_checkpoint_mutex);
1549f7f4bccbSMingming Cao 		err = jbd2_log_do_checkpoint(journal);
155044519fafSHidehiro Kawai 		mutex_unlock(&journal->j_checkpoint_mutex);
1551470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
1552470decc6SDave Kleikamp 	}
1553470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
155444519fafSHidehiro Kawai 
155544519fafSHidehiro Kawai 	if (is_journal_aborted(journal))
155644519fafSHidehiro Kawai 		return -EIO;
155744519fafSHidehiro Kawai 
1558f7f4bccbSMingming Cao 	jbd2_cleanup_journal_tail(journal);
1559470decc6SDave Kleikamp 
1560470decc6SDave Kleikamp 	/* Finally, mark the journal as really needing no recovery.
1561470decc6SDave Kleikamp 	 * This sets s_start==0 in the underlying superblock, which is
1562470decc6SDave Kleikamp 	 * the magic code for a fully-recovered superblock.  Any future
1563470decc6SDave Kleikamp 	 * commits of data to the journal will restore the current
1564470decc6SDave Kleikamp 	 * s_start value. */
1565470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1566470decc6SDave Kleikamp 	old_tail = journal->j_tail;
1567470decc6SDave Kleikamp 	journal->j_tail = 0;
1568470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1569f7f4bccbSMingming Cao 	jbd2_journal_update_superblock(journal, 1);
1570470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1571470decc6SDave Kleikamp 	journal->j_tail = old_tail;
1572470decc6SDave Kleikamp 
1573470decc6SDave Kleikamp 	J_ASSERT(!journal->j_running_transaction);
1574470decc6SDave Kleikamp 	J_ASSERT(!journal->j_committing_transaction);
1575470decc6SDave Kleikamp 	J_ASSERT(!journal->j_checkpoint_transactions);
1576470decc6SDave Kleikamp 	J_ASSERT(journal->j_head == journal->j_tail);
1577470decc6SDave Kleikamp 	J_ASSERT(journal->j_tail_sequence == journal->j_transaction_sequence);
1578470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
157944519fafSHidehiro Kawai 	return 0;
1580470decc6SDave Kleikamp }
1581470decc6SDave Kleikamp 
1582470decc6SDave Kleikamp /**
1583f7f4bccbSMingming Cao  * int jbd2_journal_wipe() - Wipe journal contents
1584470decc6SDave Kleikamp  * @journal: Journal to act on.
1585470decc6SDave Kleikamp  * @write: flag (see below)
1586470decc6SDave Kleikamp  *
1587470decc6SDave Kleikamp  * Wipe out all of the contents of a journal, safely.  This will produce
1588470decc6SDave Kleikamp  * a warning if the journal contains any valid recovery information.
1589f7f4bccbSMingming Cao  * Must be called between journal_init_*() and jbd2_journal_load().
1590470decc6SDave Kleikamp  *
1591470decc6SDave Kleikamp  * If 'write' is non-zero, then we wipe out the journal on disk; otherwise
1592470decc6SDave Kleikamp  * we merely suppress recovery.
1593470decc6SDave Kleikamp  */
1594470decc6SDave Kleikamp 
1595f7f4bccbSMingming Cao int jbd2_journal_wipe(journal_t *journal, int write)
1596470decc6SDave Kleikamp {
1597470decc6SDave Kleikamp 	journal_superblock_t *sb;
1598470decc6SDave Kleikamp 	int err = 0;
1599470decc6SDave Kleikamp 
1600f7f4bccbSMingming Cao 	J_ASSERT (!(journal->j_flags & JBD2_LOADED));
1601470decc6SDave Kleikamp 
1602470decc6SDave Kleikamp 	err = load_superblock(journal);
1603470decc6SDave Kleikamp 	if (err)
1604470decc6SDave Kleikamp 		return err;
1605470decc6SDave Kleikamp 
1606470decc6SDave Kleikamp 	sb = journal->j_superblock;
1607470decc6SDave Kleikamp 
1608470decc6SDave Kleikamp 	if (!journal->j_tail)
1609470decc6SDave Kleikamp 		goto no_recovery;
1610470decc6SDave Kleikamp 
1611470decc6SDave Kleikamp 	printk (KERN_WARNING "JBD: %s recovery information on journal\n",
1612470decc6SDave Kleikamp 		write ? "Clearing" : "Ignoring");
1613470decc6SDave Kleikamp 
1614f7f4bccbSMingming Cao 	err = jbd2_journal_skip_recovery(journal);
1615470decc6SDave Kleikamp 	if (write)
1616f7f4bccbSMingming Cao 		jbd2_journal_update_superblock(journal, 1);
1617470decc6SDave Kleikamp 
1618470decc6SDave Kleikamp  no_recovery:
1619470decc6SDave Kleikamp 	return err;
1620470decc6SDave Kleikamp }
1621470decc6SDave Kleikamp 
1622470decc6SDave Kleikamp /*
1623470decc6SDave Kleikamp  * Journal abort has very specific semantics, which we describe
1624470decc6SDave Kleikamp  * for journal abort.
1625470decc6SDave Kleikamp  *
1626bfcd3555SAlberto Bertogli  * Two internal functions, which provide abort to the jbd layer
1627470decc6SDave Kleikamp  * itself are here.
1628470decc6SDave Kleikamp  */
1629470decc6SDave Kleikamp 
1630470decc6SDave Kleikamp /*
1631470decc6SDave Kleikamp  * Quick version for internal journal use (doesn't lock the journal).
1632470decc6SDave Kleikamp  * Aborts hard --- we mark the abort as occurred, but do _nothing_ else,
1633470decc6SDave Kleikamp  * and don't attempt to make any other journal updates.
1634470decc6SDave Kleikamp  */
1635f7f4bccbSMingming Cao void __jbd2_journal_abort_hard(journal_t *journal)
1636470decc6SDave Kleikamp {
1637470decc6SDave Kleikamp 	transaction_t *transaction;
1638470decc6SDave Kleikamp 
1639f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1640470decc6SDave Kleikamp 		return;
1641470decc6SDave Kleikamp 
1642470decc6SDave Kleikamp 	printk(KERN_ERR "Aborting journal on device %s.\n",
164305496769STheodore Ts'o 	       journal->j_devname);
1644470decc6SDave Kleikamp 
1645470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1646f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_ABORT;
1647470decc6SDave Kleikamp 	transaction = journal->j_running_transaction;
1648470decc6SDave Kleikamp 	if (transaction)
1649f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
1650470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1651470decc6SDave Kleikamp }
1652470decc6SDave Kleikamp 
1653470decc6SDave Kleikamp /* Soft abort: record the abort error status in the journal superblock,
1654470decc6SDave Kleikamp  * but don't do any other IO. */
1655470decc6SDave Kleikamp static void __journal_abort_soft (journal_t *journal, int errno)
1656470decc6SDave Kleikamp {
1657f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1658470decc6SDave Kleikamp 		return;
1659470decc6SDave Kleikamp 
1660470decc6SDave Kleikamp 	if (!journal->j_errno)
1661470decc6SDave Kleikamp 		journal->j_errno = errno;
1662470decc6SDave Kleikamp 
1663f7f4bccbSMingming Cao 	__jbd2_journal_abort_hard(journal);
1664470decc6SDave Kleikamp 
1665470decc6SDave Kleikamp 	if (errno)
1666f7f4bccbSMingming Cao 		jbd2_journal_update_superblock(journal, 1);
1667470decc6SDave Kleikamp }
1668470decc6SDave Kleikamp 
1669470decc6SDave Kleikamp /**
1670f7f4bccbSMingming Cao  * void jbd2_journal_abort () - Shutdown the journal immediately.
1671470decc6SDave Kleikamp  * @journal: the journal to shutdown.
1672470decc6SDave Kleikamp  * @errno:   an error number to record in the journal indicating
1673470decc6SDave Kleikamp  *           the reason for the shutdown.
1674470decc6SDave Kleikamp  *
1675470decc6SDave Kleikamp  * Perform a complete, immediate shutdown of the ENTIRE
1676470decc6SDave Kleikamp  * journal (not of a single transaction).  This operation cannot be
1677470decc6SDave Kleikamp  * undone without closing and reopening the journal.
1678470decc6SDave Kleikamp  *
1679f7f4bccbSMingming Cao  * The jbd2_journal_abort function is intended to support higher level error
1680470decc6SDave Kleikamp  * recovery mechanisms such as the ext2/ext3 remount-readonly error
1681470decc6SDave Kleikamp  * mode.
1682470decc6SDave Kleikamp  *
1683470decc6SDave Kleikamp  * Journal abort has very specific semantics.  Any existing dirty,
1684470decc6SDave Kleikamp  * unjournaled buffers in the main filesystem will still be written to
1685470decc6SDave Kleikamp  * disk by bdflush, but the journaling mechanism will be suspended
1686470decc6SDave Kleikamp  * immediately and no further transaction commits will be honoured.
1687470decc6SDave Kleikamp  *
1688470decc6SDave Kleikamp  * Any dirty, journaled buffers will be written back to disk without
1689470decc6SDave Kleikamp  * hitting the journal.  Atomicity cannot be guaranteed on an aborted
1690470decc6SDave Kleikamp  * filesystem, but we _do_ attempt to leave as much data as possible
1691470decc6SDave Kleikamp  * behind for fsck to use for cleanup.
1692470decc6SDave Kleikamp  *
1693470decc6SDave Kleikamp  * Any attempt to get a new transaction handle on a journal which is in
1694470decc6SDave Kleikamp  * ABORT state will just result in an -EROFS error return.  A
1695f7f4bccbSMingming Cao  * jbd2_journal_stop on an existing handle will return -EIO if we have
1696470decc6SDave Kleikamp  * entered abort state during the update.
1697470decc6SDave Kleikamp  *
1698470decc6SDave Kleikamp  * Recursive transactions are not disturbed by journal abort until the
1699f7f4bccbSMingming Cao  * final jbd2_journal_stop, which will receive the -EIO error.
1700470decc6SDave Kleikamp  *
1701f7f4bccbSMingming Cao  * Finally, the jbd2_journal_abort call allows the caller to supply an errno
1702470decc6SDave Kleikamp  * which will be recorded (if possible) in the journal superblock.  This
1703470decc6SDave Kleikamp  * allows a client to record failure conditions in the middle of a
1704470decc6SDave Kleikamp  * transaction without having to complete the transaction to record the
1705470decc6SDave Kleikamp  * failure to disk.  ext3_error, for example, now uses this
1706470decc6SDave Kleikamp  * functionality.
1707470decc6SDave Kleikamp  *
1708470decc6SDave Kleikamp  * Errors which originate from within the journaling layer will NOT
1709470decc6SDave Kleikamp  * supply an errno; a null errno implies that absolutely no further
1710470decc6SDave Kleikamp  * writes are done to the journal (unless there are any already in
1711470decc6SDave Kleikamp  * progress).
1712470decc6SDave Kleikamp  *
1713470decc6SDave Kleikamp  */
1714470decc6SDave Kleikamp 
1715f7f4bccbSMingming Cao void jbd2_journal_abort(journal_t *journal, int errno)
1716470decc6SDave Kleikamp {
1717470decc6SDave Kleikamp 	__journal_abort_soft(journal, errno);
1718470decc6SDave Kleikamp }
1719470decc6SDave Kleikamp 
1720470decc6SDave Kleikamp /**
1721f7f4bccbSMingming Cao  * int jbd2_journal_errno () - returns the journal's error state.
1722470decc6SDave Kleikamp  * @journal: journal to examine.
1723470decc6SDave Kleikamp  *
1724bfcd3555SAlberto Bertogli  * This is the errno number set with jbd2_journal_abort(), the last
1725470decc6SDave Kleikamp  * time the journal was mounted - if the journal was stopped
1726470decc6SDave Kleikamp  * without calling abort this will be 0.
1727470decc6SDave Kleikamp  *
1728470decc6SDave Kleikamp  * If the journal has been aborted on this mount time -EROFS will
1729470decc6SDave Kleikamp  * be returned.
1730470decc6SDave Kleikamp  */
1731f7f4bccbSMingming Cao int jbd2_journal_errno(journal_t *journal)
1732470decc6SDave Kleikamp {
1733470decc6SDave Kleikamp 	int err;
1734470decc6SDave Kleikamp 
1735470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1736f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1737470decc6SDave Kleikamp 		err = -EROFS;
1738470decc6SDave Kleikamp 	else
1739470decc6SDave Kleikamp 		err = journal->j_errno;
1740470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1741470decc6SDave Kleikamp 	return err;
1742470decc6SDave Kleikamp }
1743470decc6SDave Kleikamp 
1744470decc6SDave Kleikamp /**
1745f7f4bccbSMingming Cao  * int jbd2_journal_clear_err () - clears the journal's error state
1746470decc6SDave Kleikamp  * @journal: journal to act on.
1747470decc6SDave Kleikamp  *
1748bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
1749470decc6SDave Kleikamp  * mode.
1750470decc6SDave Kleikamp  */
1751f7f4bccbSMingming Cao int jbd2_journal_clear_err(journal_t *journal)
1752470decc6SDave Kleikamp {
1753470decc6SDave Kleikamp 	int err = 0;
1754470decc6SDave Kleikamp 
1755470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1756f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
1757470decc6SDave Kleikamp 		err = -EROFS;
1758470decc6SDave Kleikamp 	else
1759470decc6SDave Kleikamp 		journal->j_errno = 0;
1760470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1761470decc6SDave Kleikamp 	return err;
1762470decc6SDave Kleikamp }
1763470decc6SDave Kleikamp 
1764470decc6SDave Kleikamp /**
1765f7f4bccbSMingming Cao  * void jbd2_journal_ack_err() - Ack journal err.
1766470decc6SDave Kleikamp  * @journal: journal to act on.
1767470decc6SDave Kleikamp  *
1768bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
1769470decc6SDave Kleikamp  * mode.
1770470decc6SDave Kleikamp  */
1771f7f4bccbSMingming Cao void jbd2_journal_ack_err(journal_t *journal)
1772470decc6SDave Kleikamp {
1773470decc6SDave Kleikamp 	spin_lock(&journal->j_state_lock);
1774470decc6SDave Kleikamp 	if (journal->j_errno)
1775f7f4bccbSMingming Cao 		journal->j_flags |= JBD2_ACK_ERR;
1776470decc6SDave Kleikamp 	spin_unlock(&journal->j_state_lock);
1777470decc6SDave Kleikamp }
1778470decc6SDave Kleikamp 
1779f7f4bccbSMingming Cao int jbd2_journal_blocks_per_page(struct inode *inode)
1780470decc6SDave Kleikamp {
1781470decc6SDave Kleikamp 	return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits);
1782470decc6SDave Kleikamp }
1783470decc6SDave Kleikamp 
1784470decc6SDave Kleikamp /*
1785b517bea1SZach Brown  * helper functions to deal with 32 or 64bit block numbers.
1786b517bea1SZach Brown  */
1787b517bea1SZach Brown size_t journal_tag_bytes(journal_t *journal)
1788b517bea1SZach Brown {
1789b517bea1SZach Brown 	if (JBD2_HAS_INCOMPAT_FEATURE(journal, JBD2_FEATURE_INCOMPAT_64BIT))
1790cd02ff0bSMingming Cao 		return JBD2_TAG_SIZE64;
1791b517bea1SZach Brown 	else
1792cd02ff0bSMingming Cao 		return JBD2_TAG_SIZE32;
1793b517bea1SZach Brown }
1794b517bea1SZach Brown 
1795b517bea1SZach Brown /*
1796470decc6SDave Kleikamp  * Journal_head storage management
1797470decc6SDave Kleikamp  */
1798e18b890bSChristoph Lameter static struct kmem_cache *jbd2_journal_head_cache;
1799e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
1800470decc6SDave Kleikamp static atomic_t nr_journal_heads = ATOMIC_INIT(0);
1801470decc6SDave Kleikamp #endif
1802470decc6SDave Kleikamp 
1803f7f4bccbSMingming Cao static int journal_init_jbd2_journal_head_cache(void)
1804470decc6SDave Kleikamp {
1805470decc6SDave Kleikamp 	int retval;
1806470decc6SDave Kleikamp 
18071076d17aSAl Viro 	J_ASSERT(jbd2_journal_head_cache == NULL);
1808a920e941SJohann Lombardi 	jbd2_journal_head_cache = kmem_cache_create("jbd2_journal_head",
1809470decc6SDave Kleikamp 				sizeof(struct journal_head),
1810470decc6SDave Kleikamp 				0,		/* offset */
181177160957SMingming Cao 				SLAB_TEMPORARY,	/* flags */
181220c2df83SPaul Mundt 				NULL);		/* ctor */
1813470decc6SDave Kleikamp 	retval = 0;
18141076d17aSAl Viro 	if (!jbd2_journal_head_cache) {
1815470decc6SDave Kleikamp 		retval = -ENOMEM;
1816470decc6SDave Kleikamp 		printk(KERN_EMERG "JBD: no memory for journal_head cache\n");
1817470decc6SDave Kleikamp 	}
1818470decc6SDave Kleikamp 	return retval;
1819470decc6SDave Kleikamp }
1820470decc6SDave Kleikamp 
1821f7f4bccbSMingming Cao static void jbd2_journal_destroy_jbd2_journal_head_cache(void)
1822470decc6SDave Kleikamp {
18238a9362ebSDuane Griffin 	if (jbd2_journal_head_cache) {
1824f7f4bccbSMingming Cao 		kmem_cache_destroy(jbd2_journal_head_cache);
1825f7f4bccbSMingming Cao 		jbd2_journal_head_cache = NULL;
1826470decc6SDave Kleikamp 	}
18278a9362ebSDuane Griffin }
1828470decc6SDave Kleikamp 
1829470decc6SDave Kleikamp /*
1830470decc6SDave Kleikamp  * journal_head splicing and dicing
1831470decc6SDave Kleikamp  */
1832470decc6SDave Kleikamp static struct journal_head *journal_alloc_journal_head(void)
1833470decc6SDave Kleikamp {
1834470decc6SDave Kleikamp 	struct journal_head *ret;
1835470decc6SDave Kleikamp 	static unsigned long last_warning;
1836470decc6SDave Kleikamp 
1837e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
1838470decc6SDave Kleikamp 	atomic_inc(&nr_journal_heads);
1839470decc6SDave Kleikamp #endif
1840f7f4bccbSMingming Cao 	ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
18411076d17aSAl Viro 	if (!ret) {
1842470decc6SDave Kleikamp 		jbd_debug(1, "out of memory for journal_head\n");
1843470decc6SDave Kleikamp 		if (time_after(jiffies, last_warning + 5*HZ)) {
1844470decc6SDave Kleikamp 			printk(KERN_NOTICE "ENOMEM in %s, retrying.\n",
1845329d291fSHarvey Harrison 			       __func__);
1846470decc6SDave Kleikamp 			last_warning = jiffies;
1847470decc6SDave Kleikamp 		}
18481076d17aSAl Viro 		while (!ret) {
1849470decc6SDave Kleikamp 			yield();
1850f7f4bccbSMingming Cao 			ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
1851470decc6SDave Kleikamp 		}
1852470decc6SDave Kleikamp 	}
1853470decc6SDave Kleikamp 	return ret;
1854470decc6SDave Kleikamp }
1855470decc6SDave Kleikamp 
1856470decc6SDave Kleikamp static void journal_free_journal_head(struct journal_head *jh)
1857470decc6SDave Kleikamp {
1858e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
1859470decc6SDave Kleikamp 	atomic_dec(&nr_journal_heads);
1860cd02ff0bSMingming Cao 	memset(jh, JBD2_POISON_FREE, sizeof(*jh));
1861470decc6SDave Kleikamp #endif
1862f7f4bccbSMingming Cao 	kmem_cache_free(jbd2_journal_head_cache, jh);
1863470decc6SDave Kleikamp }
1864470decc6SDave Kleikamp 
1865470decc6SDave Kleikamp /*
1866470decc6SDave Kleikamp  * A journal_head is attached to a buffer_head whenever JBD has an
1867470decc6SDave Kleikamp  * interest in the buffer.
1868470decc6SDave Kleikamp  *
1869470decc6SDave Kleikamp  * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
1870470decc6SDave Kleikamp  * is set.  This bit is tested in core kernel code where we need to take
1871470decc6SDave Kleikamp  * JBD-specific actions.  Testing the zeroness of ->b_private is not reliable
1872470decc6SDave Kleikamp  * there.
1873470decc6SDave Kleikamp  *
1874470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
1875470decc6SDave Kleikamp  *
1876470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set it is immune from being released by
1877470decc6SDave Kleikamp  * core kernel code, mainly via ->b_count.
1878470decc6SDave Kleikamp  *
1879470decc6SDave Kleikamp  * A journal_head may be detached from its buffer_head when the journal_head's
1880470decc6SDave Kleikamp  * b_transaction, b_cp_transaction and b_next_transaction pointers are NULL.
1881f7f4bccbSMingming Cao  * Various places in JBD call jbd2_journal_remove_journal_head() to indicate that the
1882470decc6SDave Kleikamp  * journal_head can be dropped if needed.
1883470decc6SDave Kleikamp  *
1884470decc6SDave Kleikamp  * Various places in the kernel want to attach a journal_head to a buffer_head
1885470decc6SDave Kleikamp  * _before_ attaching the journal_head to a transaction.  To protect the
1886f7f4bccbSMingming Cao  * journal_head in this situation, jbd2_journal_add_journal_head elevates the
1887470decc6SDave Kleikamp  * journal_head's b_jcount refcount by one.  The caller must call
1888f7f4bccbSMingming Cao  * jbd2_journal_put_journal_head() to undo this.
1889470decc6SDave Kleikamp  *
1890470decc6SDave Kleikamp  * So the typical usage would be:
1891470decc6SDave Kleikamp  *
1892470decc6SDave Kleikamp  *	(Attach a journal_head if needed.  Increments b_jcount)
1893f7f4bccbSMingming Cao  *	struct journal_head *jh = jbd2_journal_add_journal_head(bh);
1894470decc6SDave Kleikamp  *	...
1895470decc6SDave Kleikamp  *	jh->b_transaction = xxx;
1896f7f4bccbSMingming Cao  *	jbd2_journal_put_journal_head(jh);
1897470decc6SDave Kleikamp  *
1898470decc6SDave Kleikamp  * Now, the journal_head's b_jcount is zero, but it is safe from being released
1899470decc6SDave Kleikamp  * because it has a non-zero b_transaction.
1900470decc6SDave Kleikamp  */
1901470decc6SDave Kleikamp 
1902470decc6SDave Kleikamp /*
1903470decc6SDave Kleikamp  * Give a buffer_head a journal_head.
1904470decc6SDave Kleikamp  *
1905470decc6SDave Kleikamp  * Doesn't need the journal lock.
1906470decc6SDave Kleikamp  * May sleep.
1907470decc6SDave Kleikamp  */
1908f7f4bccbSMingming Cao struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh)
1909470decc6SDave Kleikamp {
1910470decc6SDave Kleikamp 	struct journal_head *jh;
1911470decc6SDave Kleikamp 	struct journal_head *new_jh = NULL;
1912470decc6SDave Kleikamp 
1913470decc6SDave Kleikamp repeat:
1914470decc6SDave Kleikamp 	if (!buffer_jbd(bh)) {
1915470decc6SDave Kleikamp 		new_jh = journal_alloc_journal_head();
1916470decc6SDave Kleikamp 		memset(new_jh, 0, sizeof(*new_jh));
1917470decc6SDave Kleikamp 	}
1918470decc6SDave Kleikamp 
1919470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
1920470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
1921470decc6SDave Kleikamp 		jh = bh2jh(bh);
1922470decc6SDave Kleikamp 	} else {
1923470decc6SDave Kleikamp 		J_ASSERT_BH(bh,
1924470decc6SDave Kleikamp 			(atomic_read(&bh->b_count) > 0) ||
1925470decc6SDave Kleikamp 			(bh->b_page && bh->b_page->mapping));
1926470decc6SDave Kleikamp 
1927470decc6SDave Kleikamp 		if (!new_jh) {
1928470decc6SDave Kleikamp 			jbd_unlock_bh_journal_head(bh);
1929470decc6SDave Kleikamp 			goto repeat;
1930470decc6SDave Kleikamp 		}
1931470decc6SDave Kleikamp 
1932470decc6SDave Kleikamp 		jh = new_jh;
1933470decc6SDave Kleikamp 		new_jh = NULL;		/* We consumed it */
1934470decc6SDave Kleikamp 		set_buffer_jbd(bh);
1935470decc6SDave Kleikamp 		bh->b_private = jh;
1936470decc6SDave Kleikamp 		jh->b_bh = bh;
1937470decc6SDave Kleikamp 		get_bh(bh);
1938470decc6SDave Kleikamp 		BUFFER_TRACE(bh, "added journal_head");
1939470decc6SDave Kleikamp 	}
1940470decc6SDave Kleikamp 	jh->b_jcount++;
1941470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
1942470decc6SDave Kleikamp 	if (new_jh)
1943470decc6SDave Kleikamp 		journal_free_journal_head(new_jh);
1944470decc6SDave Kleikamp 	return bh->b_private;
1945470decc6SDave Kleikamp }
1946470decc6SDave Kleikamp 
1947470decc6SDave Kleikamp /*
1948470decc6SDave Kleikamp  * Grab a ref against this buffer_head's journal_head.  If it ended up not
1949470decc6SDave Kleikamp  * having a journal_head, return NULL
1950470decc6SDave Kleikamp  */
1951f7f4bccbSMingming Cao struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh)
1952470decc6SDave Kleikamp {
1953470decc6SDave Kleikamp 	struct journal_head *jh = NULL;
1954470decc6SDave Kleikamp 
1955470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
1956470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
1957470decc6SDave Kleikamp 		jh = bh2jh(bh);
1958470decc6SDave Kleikamp 		jh->b_jcount++;
1959470decc6SDave Kleikamp 	}
1960470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
1961470decc6SDave Kleikamp 	return jh;
1962470decc6SDave Kleikamp }
1963470decc6SDave Kleikamp 
1964470decc6SDave Kleikamp static void __journal_remove_journal_head(struct buffer_head *bh)
1965470decc6SDave Kleikamp {
1966470decc6SDave Kleikamp 	struct journal_head *jh = bh2jh(bh);
1967470decc6SDave Kleikamp 
1968470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jcount >= 0);
1969470decc6SDave Kleikamp 
1970470decc6SDave Kleikamp 	get_bh(bh);
1971470decc6SDave Kleikamp 	if (jh->b_jcount == 0) {
1972470decc6SDave Kleikamp 		if (jh->b_transaction == NULL &&
1973470decc6SDave Kleikamp 				jh->b_next_transaction == NULL &&
1974470decc6SDave Kleikamp 				jh->b_cp_transaction == NULL) {
1975470decc6SDave Kleikamp 			J_ASSERT_JH(jh, jh->b_jlist == BJ_None);
1976470decc6SDave Kleikamp 			J_ASSERT_BH(bh, buffer_jbd(bh));
1977470decc6SDave Kleikamp 			J_ASSERT_BH(bh, jh2bh(jh) == bh);
1978470decc6SDave Kleikamp 			BUFFER_TRACE(bh, "remove journal_head");
1979470decc6SDave Kleikamp 			if (jh->b_frozen_data) {
1980470decc6SDave Kleikamp 				printk(KERN_WARNING "%s: freeing "
1981470decc6SDave Kleikamp 						"b_frozen_data\n",
1982329d291fSHarvey Harrison 						__func__);
1983af1e76d6SMingming Cao 				jbd2_free(jh->b_frozen_data, bh->b_size);
1984470decc6SDave Kleikamp 			}
1985470decc6SDave Kleikamp 			if (jh->b_committed_data) {
1986470decc6SDave Kleikamp 				printk(KERN_WARNING "%s: freeing "
1987470decc6SDave Kleikamp 						"b_committed_data\n",
1988329d291fSHarvey Harrison 						__func__);
1989af1e76d6SMingming Cao 				jbd2_free(jh->b_committed_data, bh->b_size);
1990470decc6SDave Kleikamp 			}
1991470decc6SDave Kleikamp 			bh->b_private = NULL;
1992470decc6SDave Kleikamp 			jh->b_bh = NULL;	/* debug, really */
1993470decc6SDave Kleikamp 			clear_buffer_jbd(bh);
1994470decc6SDave Kleikamp 			__brelse(bh);
1995470decc6SDave Kleikamp 			journal_free_journal_head(jh);
1996470decc6SDave Kleikamp 		} else {
1997470decc6SDave Kleikamp 			BUFFER_TRACE(bh, "journal_head was locked");
1998470decc6SDave Kleikamp 		}
1999470decc6SDave Kleikamp 	}
2000470decc6SDave Kleikamp }
2001470decc6SDave Kleikamp 
2002470decc6SDave Kleikamp /*
2003f7f4bccbSMingming Cao  * jbd2_journal_remove_journal_head(): if the buffer isn't attached to a transaction
2004470decc6SDave Kleikamp  * and has a zero b_jcount then remove and release its journal_head.   If we did
2005470decc6SDave Kleikamp  * see that the buffer is not used by any transaction we also "logically"
2006470decc6SDave Kleikamp  * decrement ->b_count.
2007470decc6SDave Kleikamp  *
2008470decc6SDave Kleikamp  * We in fact take an additional increment on ->b_count as a convenience,
2009470decc6SDave Kleikamp  * because the caller usually wants to do additional things with the bh
2010470decc6SDave Kleikamp  * after calling here.
2011f7f4bccbSMingming Cao  * The caller of jbd2_journal_remove_journal_head() *must* run __brelse(bh) at some
2012470decc6SDave Kleikamp  * time.  Once the caller has run __brelse(), the buffer is eligible for
2013470decc6SDave Kleikamp  * reaping by try_to_free_buffers().
2014470decc6SDave Kleikamp  */
2015f7f4bccbSMingming Cao void jbd2_journal_remove_journal_head(struct buffer_head *bh)
2016470decc6SDave Kleikamp {
2017470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2018470decc6SDave Kleikamp 	__journal_remove_journal_head(bh);
2019470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2020470decc6SDave Kleikamp }
2021470decc6SDave Kleikamp 
2022470decc6SDave Kleikamp /*
2023470decc6SDave Kleikamp  * Drop a reference on the passed journal_head.  If it fell to zero then try to
2024470decc6SDave Kleikamp  * release the journal_head from the buffer_head.
2025470decc6SDave Kleikamp  */
2026f7f4bccbSMingming Cao void jbd2_journal_put_journal_head(struct journal_head *jh)
2027470decc6SDave Kleikamp {
2028470decc6SDave Kleikamp 	struct buffer_head *bh = jh2bh(jh);
2029470decc6SDave Kleikamp 
2030470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2031470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jcount > 0);
2032470decc6SDave Kleikamp 	--jh->b_jcount;
2033470decc6SDave Kleikamp 	if (!jh->b_jcount && !jh->b_transaction) {
2034470decc6SDave Kleikamp 		__journal_remove_journal_head(bh);
2035470decc6SDave Kleikamp 		__brelse(bh);
2036470decc6SDave Kleikamp 	}
2037470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2038470decc6SDave Kleikamp }
2039470decc6SDave Kleikamp 
2040470decc6SDave Kleikamp /*
2041c851ed54SJan Kara  * Initialize jbd inode head
2042c851ed54SJan Kara  */
2043c851ed54SJan Kara void jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode)
2044c851ed54SJan Kara {
2045c851ed54SJan Kara 	jinode->i_transaction = NULL;
2046c851ed54SJan Kara 	jinode->i_next_transaction = NULL;
2047c851ed54SJan Kara 	jinode->i_vfs_inode = inode;
2048c851ed54SJan Kara 	jinode->i_flags = 0;
2049c851ed54SJan Kara 	INIT_LIST_HEAD(&jinode->i_list);
2050c851ed54SJan Kara }
2051c851ed54SJan Kara 
2052c851ed54SJan Kara /*
2053c851ed54SJan Kara  * Function to be called before we start removing inode from memory (i.e.,
2054c851ed54SJan Kara  * clear_inode() is a fine place to be called from). It removes inode from
2055c851ed54SJan Kara  * transaction's lists.
2056c851ed54SJan Kara  */
2057c851ed54SJan Kara void jbd2_journal_release_jbd_inode(journal_t *journal,
2058c851ed54SJan Kara 				    struct jbd2_inode *jinode)
2059c851ed54SJan Kara {
2060c851ed54SJan Kara 	int writeout = 0;
2061c851ed54SJan Kara 
2062c851ed54SJan Kara 	if (!journal)
2063c851ed54SJan Kara 		return;
2064c851ed54SJan Kara restart:
2065c851ed54SJan Kara 	spin_lock(&journal->j_list_lock);
2066c851ed54SJan Kara 	/* Is commit writing out inode - we have to wait */
2067c851ed54SJan Kara 	if (jinode->i_flags & JI_COMMIT_RUNNING) {
2068c851ed54SJan Kara 		wait_queue_head_t *wq;
2069c851ed54SJan Kara 		DEFINE_WAIT_BIT(wait, &jinode->i_flags, __JI_COMMIT_RUNNING);
2070c851ed54SJan Kara 		wq = bit_waitqueue(&jinode->i_flags, __JI_COMMIT_RUNNING);
2071c851ed54SJan Kara 		prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
2072c851ed54SJan Kara 		spin_unlock(&journal->j_list_lock);
2073c851ed54SJan Kara 		schedule();
2074c851ed54SJan Kara 		finish_wait(wq, &wait.wait);
2075c851ed54SJan Kara 		goto restart;
2076c851ed54SJan Kara 	}
2077c851ed54SJan Kara 
2078c851ed54SJan Kara 	/* Do we need to wait for data writeback? */
2079c851ed54SJan Kara 	if (journal->j_committing_transaction == jinode->i_transaction)
2080c851ed54SJan Kara 		writeout = 1;
2081c851ed54SJan Kara 	if (jinode->i_transaction) {
2082c851ed54SJan Kara 		list_del(&jinode->i_list);
2083c851ed54SJan Kara 		jinode->i_transaction = NULL;
2084c851ed54SJan Kara 	}
2085c851ed54SJan Kara 	spin_unlock(&journal->j_list_lock);
2086c851ed54SJan Kara }
2087c851ed54SJan Kara 
2088c851ed54SJan Kara /*
20890f49d5d0SJose R. Santos  * debugfs tunables
2090470decc6SDave Kleikamp  */
20916f38c74fSJose R. Santos #ifdef CONFIG_JBD2_DEBUG
20926f38c74fSJose R. Santos u8 jbd2_journal_enable_debug __read_mostly;
2093f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_enable_debug);
2094470decc6SDave Kleikamp 
20950f49d5d0SJose R. Santos #define JBD2_DEBUG_NAME "jbd2-debug"
2096470decc6SDave Kleikamp 
20976f38c74fSJose R. Santos static struct dentry *jbd2_debugfs_dir;
20986f38c74fSJose R. Santos static struct dentry *jbd2_debug;
20990f49d5d0SJose R. Santos 
21000f49d5d0SJose R. Santos static void __init jbd2_create_debugfs_entry(void)
2101470decc6SDave Kleikamp {
21020f49d5d0SJose R. Santos 	jbd2_debugfs_dir = debugfs_create_dir("jbd2", NULL);
21030f49d5d0SJose R. Santos 	if (jbd2_debugfs_dir)
21040f49d5d0SJose R. Santos 		jbd2_debug = debugfs_create_u8(JBD2_DEBUG_NAME, S_IRUGO,
21050f49d5d0SJose R. Santos 					       jbd2_debugfs_dir,
21060f49d5d0SJose R. Santos 					       &jbd2_journal_enable_debug);
2107470decc6SDave Kleikamp }
2108470decc6SDave Kleikamp 
21090f49d5d0SJose R. Santos static void __exit jbd2_remove_debugfs_entry(void)
2110470decc6SDave Kleikamp {
21110f49d5d0SJose R. Santos 	debugfs_remove(jbd2_debug);
21120f49d5d0SJose R. Santos 	debugfs_remove(jbd2_debugfs_dir);
2113470decc6SDave Kleikamp }
2114470decc6SDave Kleikamp 
2115470decc6SDave Kleikamp #else
2116470decc6SDave Kleikamp 
21170f49d5d0SJose R. Santos static void __init jbd2_create_debugfs_entry(void)
21180f49d5d0SJose R. Santos {
21190f49d5d0SJose R. Santos }
21200f49d5d0SJose R. Santos 
21210f49d5d0SJose R. Santos static void __exit jbd2_remove_debugfs_entry(void)
21220f49d5d0SJose R. Santos {
21230f49d5d0SJose R. Santos }
2124470decc6SDave Kleikamp 
2125470decc6SDave Kleikamp #endif
2126470decc6SDave Kleikamp 
21278e85fb3fSJohann Lombardi #ifdef CONFIG_PROC_FS
21288e85fb3fSJohann Lombardi 
21298e85fb3fSJohann Lombardi #define JBD2_STATS_PROC_NAME "fs/jbd2"
21308e85fb3fSJohann Lombardi 
21318e85fb3fSJohann Lombardi static void __init jbd2_create_jbd_stats_proc_entry(void)
21328e85fb3fSJohann Lombardi {
21338e85fb3fSJohann Lombardi 	proc_jbd2_stats = proc_mkdir(JBD2_STATS_PROC_NAME, NULL);
21348e85fb3fSJohann Lombardi }
21358e85fb3fSJohann Lombardi 
21368e85fb3fSJohann Lombardi static void __exit jbd2_remove_jbd_stats_proc_entry(void)
21378e85fb3fSJohann Lombardi {
21388e85fb3fSJohann Lombardi 	if (proc_jbd2_stats)
21398e85fb3fSJohann Lombardi 		remove_proc_entry(JBD2_STATS_PROC_NAME, NULL);
21408e85fb3fSJohann Lombardi }
21418e85fb3fSJohann Lombardi 
21428e85fb3fSJohann Lombardi #else
21438e85fb3fSJohann Lombardi 
21448e85fb3fSJohann Lombardi #define jbd2_create_jbd_stats_proc_entry() do {} while (0)
21458e85fb3fSJohann Lombardi #define jbd2_remove_jbd_stats_proc_entry() do {} while (0)
21468e85fb3fSJohann Lombardi 
21478e85fb3fSJohann Lombardi #endif
21488e85fb3fSJohann Lombardi 
2149e18b890bSChristoph Lameter struct kmem_cache *jbd2_handle_cache;
2150470decc6SDave Kleikamp 
2151470decc6SDave Kleikamp static int __init journal_init_handle_cache(void)
2152470decc6SDave Kleikamp {
2153a920e941SJohann Lombardi 	jbd2_handle_cache = kmem_cache_create("jbd2_journal_handle",
2154470decc6SDave Kleikamp 				sizeof(handle_t),
2155470decc6SDave Kleikamp 				0,		/* offset */
215677160957SMingming Cao 				SLAB_TEMPORARY,	/* flags */
215720c2df83SPaul Mundt 				NULL);		/* ctor */
2158f7f4bccbSMingming Cao 	if (jbd2_handle_cache == NULL) {
2159470decc6SDave Kleikamp 		printk(KERN_EMERG "JBD: failed to create handle cache\n");
2160470decc6SDave Kleikamp 		return -ENOMEM;
2161470decc6SDave Kleikamp 	}
2162470decc6SDave Kleikamp 	return 0;
2163470decc6SDave Kleikamp }
2164470decc6SDave Kleikamp 
2165f7f4bccbSMingming Cao static void jbd2_journal_destroy_handle_cache(void)
2166470decc6SDave Kleikamp {
2167f7f4bccbSMingming Cao 	if (jbd2_handle_cache)
2168f7f4bccbSMingming Cao 		kmem_cache_destroy(jbd2_handle_cache);
2169470decc6SDave Kleikamp }
2170470decc6SDave Kleikamp 
2171470decc6SDave Kleikamp /*
2172470decc6SDave Kleikamp  * Module startup and shutdown
2173470decc6SDave Kleikamp  */
2174470decc6SDave Kleikamp 
2175470decc6SDave Kleikamp static int __init journal_init_caches(void)
2176470decc6SDave Kleikamp {
2177470decc6SDave Kleikamp 	int ret;
2178470decc6SDave Kleikamp 
2179f7f4bccbSMingming Cao 	ret = jbd2_journal_init_revoke_caches();
2180470decc6SDave Kleikamp 	if (ret == 0)
2181f7f4bccbSMingming Cao 		ret = journal_init_jbd2_journal_head_cache();
2182470decc6SDave Kleikamp 	if (ret == 0)
2183470decc6SDave Kleikamp 		ret = journal_init_handle_cache();
2184470decc6SDave Kleikamp 	return ret;
2185470decc6SDave Kleikamp }
2186470decc6SDave Kleikamp 
2187f7f4bccbSMingming Cao static void jbd2_journal_destroy_caches(void)
2188470decc6SDave Kleikamp {
2189f7f4bccbSMingming Cao 	jbd2_journal_destroy_revoke_caches();
2190f7f4bccbSMingming Cao 	jbd2_journal_destroy_jbd2_journal_head_cache();
2191f7f4bccbSMingming Cao 	jbd2_journal_destroy_handle_cache();
2192470decc6SDave Kleikamp }
2193470decc6SDave Kleikamp 
2194470decc6SDave Kleikamp static int __init journal_init(void)
2195470decc6SDave Kleikamp {
2196470decc6SDave Kleikamp 	int ret;
2197470decc6SDave Kleikamp 
2198470decc6SDave Kleikamp 	BUILD_BUG_ON(sizeof(struct journal_superblock_s) != 1024);
2199470decc6SDave Kleikamp 
2200470decc6SDave Kleikamp 	ret = journal_init_caches();
2201620de4e1SDuane Griffin 	if (ret == 0) {
22020f49d5d0SJose R. Santos 		jbd2_create_debugfs_entry();
22038e85fb3fSJohann Lombardi 		jbd2_create_jbd_stats_proc_entry();
2204620de4e1SDuane Griffin 	} else {
2205620de4e1SDuane Griffin 		jbd2_journal_destroy_caches();
2206620de4e1SDuane Griffin 	}
2207470decc6SDave Kleikamp 	return ret;
2208470decc6SDave Kleikamp }
2209470decc6SDave Kleikamp 
2210470decc6SDave Kleikamp static void __exit journal_exit(void)
2211470decc6SDave Kleikamp {
2212e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2213470decc6SDave Kleikamp 	int n = atomic_read(&nr_journal_heads);
2214470decc6SDave Kleikamp 	if (n)
2215470decc6SDave Kleikamp 		printk(KERN_EMERG "JBD: leaked %d journal_heads!\n", n);
2216470decc6SDave Kleikamp #endif
22170f49d5d0SJose R. Santos 	jbd2_remove_debugfs_entry();
22188e85fb3fSJohann Lombardi 	jbd2_remove_jbd_stats_proc_entry();
2219f7f4bccbSMingming Cao 	jbd2_journal_destroy_caches();
2220470decc6SDave Kleikamp }
2221470decc6SDave Kleikamp 
2222879c5e6bSTheodore Ts'o /*
2223879c5e6bSTheodore Ts'o  * jbd2_dev_to_name is a utility function used by the jbd2 and ext4
2224879c5e6bSTheodore Ts'o  * tracing infrastructure to map a dev_t to a device name.
2225879c5e6bSTheodore Ts'o  *
2226879c5e6bSTheodore Ts'o  * The caller should use rcu_read_lock() in order to make sure the
2227879c5e6bSTheodore Ts'o  * device name stays valid until its done with it.  We use
2228879c5e6bSTheodore Ts'o  * rcu_read_lock() as well to make sure we're safe in case the caller
2229879c5e6bSTheodore Ts'o  * gets sloppy, and because rcu_read_lock() is cheap and can be safely
2230879c5e6bSTheodore Ts'o  * nested.
2231879c5e6bSTheodore Ts'o  */
2232879c5e6bSTheodore Ts'o struct devname_cache {
2233879c5e6bSTheodore Ts'o 	struct rcu_head	rcu;
2234879c5e6bSTheodore Ts'o 	dev_t		device;
2235879c5e6bSTheodore Ts'o 	char		devname[BDEVNAME_SIZE];
2236879c5e6bSTheodore Ts'o };
2237879c5e6bSTheodore Ts'o #define CACHE_SIZE_BITS 6
2238879c5e6bSTheodore Ts'o static struct devname_cache *devcache[1 << CACHE_SIZE_BITS];
2239879c5e6bSTheodore Ts'o static DEFINE_SPINLOCK(devname_cache_lock);
2240879c5e6bSTheodore Ts'o 
2241879c5e6bSTheodore Ts'o static void free_devcache(struct rcu_head *rcu)
2242879c5e6bSTheodore Ts'o {
2243879c5e6bSTheodore Ts'o 	kfree(rcu);
2244879c5e6bSTheodore Ts'o }
2245879c5e6bSTheodore Ts'o 
2246879c5e6bSTheodore Ts'o const char *jbd2_dev_to_name(dev_t device)
2247879c5e6bSTheodore Ts'o {
2248879c5e6bSTheodore Ts'o 	int	i = hash_32(device, CACHE_SIZE_BITS);
2249879c5e6bSTheodore Ts'o 	char	*ret;
2250879c5e6bSTheodore Ts'o 	struct block_device *bd;
2251b5744805STheodore Ts'o 	static struct devname_cache *new_dev;
2252879c5e6bSTheodore Ts'o 
2253879c5e6bSTheodore Ts'o 	rcu_read_lock();
2254879c5e6bSTheodore Ts'o 	if (devcache[i] && devcache[i]->device == device) {
2255879c5e6bSTheodore Ts'o 		ret = devcache[i]->devname;
2256879c5e6bSTheodore Ts'o 		rcu_read_unlock();
2257879c5e6bSTheodore Ts'o 		return ret;
2258879c5e6bSTheodore Ts'o 	}
2259879c5e6bSTheodore Ts'o 	rcu_read_unlock();
2260879c5e6bSTheodore Ts'o 
2261b5744805STheodore Ts'o 	new_dev = kmalloc(sizeof(struct devname_cache), GFP_KERNEL);
2262b5744805STheodore Ts'o 	if (!new_dev)
2263b5744805STheodore Ts'o 		return "NODEV-ALLOCFAILURE"; /* Something non-NULL */
2264879c5e6bSTheodore Ts'o 	spin_lock(&devname_cache_lock);
2265879c5e6bSTheodore Ts'o 	if (devcache[i]) {
2266879c5e6bSTheodore Ts'o 		if (devcache[i]->device == device) {
2267b5744805STheodore Ts'o 			kfree(new_dev);
2268879c5e6bSTheodore Ts'o 			ret = devcache[i]->devname;
2269879c5e6bSTheodore Ts'o 			spin_unlock(&devname_cache_lock);
2270879c5e6bSTheodore Ts'o 			return ret;
2271879c5e6bSTheodore Ts'o 		}
2272879c5e6bSTheodore Ts'o 		call_rcu(&devcache[i]->rcu, free_devcache);
2273879c5e6bSTheodore Ts'o 	}
2274b5744805STheodore Ts'o 	devcache[i] = new_dev;
2275879c5e6bSTheodore Ts'o 	devcache[i]->device = device;
2276879c5e6bSTheodore Ts'o 	bd = bdget(device);
2277879c5e6bSTheodore Ts'o 	if (bd) {
2278879c5e6bSTheodore Ts'o 		bdevname(bd, devcache[i]->devname);
2279879c5e6bSTheodore Ts'o 		bdput(bd);
2280879c5e6bSTheodore Ts'o 	} else
2281879c5e6bSTheodore Ts'o 		__bdevname(device, devcache[i]->devname);
2282879c5e6bSTheodore Ts'o 	ret = devcache[i]->devname;
2283879c5e6bSTheodore Ts'o 	spin_unlock(&devname_cache_lock);
2284879c5e6bSTheodore Ts'o 	return ret;
2285879c5e6bSTheodore Ts'o }
2286879c5e6bSTheodore Ts'o EXPORT_SYMBOL(jbd2_dev_to_name);
2287879c5e6bSTheodore Ts'o 
2288470decc6SDave Kleikamp MODULE_LICENSE("GPL");
2289470decc6SDave Kleikamp module_init(journal_init);
2290470decc6SDave Kleikamp module_exit(journal_exit);
2291470decc6SDave Kleikamp 
2292