xref: /openbmc/linux/fs/jbd2/journal.c (revision ff780b91efe901b8eecd8114785abae5341820ad)
1f5166768STheodore Ts'o // SPDX-License-Identifier: GPL-2.0+
2470decc6SDave Kleikamp /*
3f7f4bccbSMingming Cao  * linux/fs/jbd2/journal.c
4470decc6SDave Kleikamp  *
5470decc6SDave Kleikamp  * Written by Stephen C. Tweedie <sct@redhat.com>, 1998
6470decc6SDave Kleikamp  *
7470decc6SDave Kleikamp  * Copyright 1998 Red Hat corp --- All Rights Reserved
8470decc6SDave Kleikamp  *
9470decc6SDave Kleikamp  * Generic filesystem journal-writing code; part of the ext2fs
10470decc6SDave Kleikamp  * journaling system.
11470decc6SDave Kleikamp  *
12470decc6SDave Kleikamp  * This file manages journals: areas of disk reserved for logging
13470decc6SDave Kleikamp  * transactional updates.  This includes the kernel journaling thread
14470decc6SDave Kleikamp  * which is responsible for scheduling updates to the log.
15470decc6SDave Kleikamp  *
16470decc6SDave Kleikamp  * We do not actually manage the physical storage of the journal in this
17470decc6SDave Kleikamp  * file: that is left to a per-journal policy function, which allows us
18470decc6SDave Kleikamp  * to store the journal within a filesystem-specified area for ext2
19470decc6SDave Kleikamp  * journaling (ext2 can use a reserved inode for storing the log).
20470decc6SDave Kleikamp  */
21470decc6SDave Kleikamp 
22470decc6SDave Kleikamp #include <linux/module.h>
23470decc6SDave Kleikamp #include <linux/time.h>
24470decc6SDave Kleikamp #include <linux/fs.h>
25f7f4bccbSMingming Cao #include <linux/jbd2.h>
26470decc6SDave Kleikamp #include <linux/errno.h>
27470decc6SDave Kleikamp #include <linux/slab.h>
28470decc6SDave Kleikamp #include <linux/init.h>
29470decc6SDave Kleikamp #include <linux/mm.h>
307dfb7103SNigel Cunningham #include <linux/freezer.h>
31470decc6SDave Kleikamp #include <linux/pagemap.h>
32470decc6SDave Kleikamp #include <linux/kthread.h>
33470decc6SDave Kleikamp #include <linux/poison.h>
34470decc6SDave Kleikamp #include <linux/proc_fs.h>
358e85fb3fSJohann Lombardi #include <linux/seq_file.h>
36c225aa57SSimon Holm Thøgersen #include <linux/math64.h>
37879c5e6bSTheodore Ts'o #include <linux/hash.h>
38d2eecb03STheodore Ts'o #include <linux/log2.h>
39d2eecb03STheodore Ts'o #include <linux/vmalloc.h>
4047def826STheodore Ts'o #include <linux/backing-dev.h>
4139e3ac25SBrian King #include <linux/bitops.h>
42670be5a7STheodore Ts'o #include <linux/ratelimit.h>
43eb52da3fSMichal Hocko #include <linux/sched/mm.h>
44879c5e6bSTheodore Ts'o 
45879c5e6bSTheodore Ts'o #define CREATE_TRACE_POINTS
46879c5e6bSTheodore Ts'o #include <trace/events/jbd2.h>
47470decc6SDave Kleikamp 
487c0f6ba6SLinus Torvalds #include <linux/uaccess.h>
49470decc6SDave Kleikamp #include <asm/page.h>
50470decc6SDave Kleikamp 
51b6e96d00STheodore Ts'o #ifdef CONFIG_JBD2_DEBUG
52b6e96d00STheodore Ts'o ushort jbd2_journal_enable_debug __read_mostly;
53b6e96d00STheodore Ts'o EXPORT_SYMBOL(jbd2_journal_enable_debug);
54b6e96d00STheodore Ts'o 
55b6e96d00STheodore Ts'o module_param_named(jbd2_debug, jbd2_journal_enable_debug, ushort, 0644);
56b6e96d00STheodore Ts'o MODULE_PARM_DESC(jbd2_debug, "Debugging level for jbd2");
57b6e96d00STheodore Ts'o #endif
58b6e96d00STheodore Ts'o 
59f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_extend);
60f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_stop);
61f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_lock_updates);
62f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_unlock_updates);
63f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_write_access);
64f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_create_access);
65f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_get_undo_access);
66e06c8227SJoel Becker EXPORT_SYMBOL(jbd2_journal_set_triggers);
67f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_dirty_metadata);
68f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_forget);
69f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_flush);
70f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_revoke);
71470decc6SDave Kleikamp 
72f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_dev);
73f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_init_inode);
74f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_used_features);
75f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_check_available_features);
76f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_set_features);
77f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_load);
78f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_destroy);
79f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_abort);
80f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_errno);
81f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_ack_err);
82f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_clear_err);
83f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_log_wait_commit);
843b799d15STheodore Ts'o EXPORT_SYMBOL(jbd2_log_start_commit);
85f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_start_commit);
86f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit_nested);
87f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_wipe);
88f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_blocks_per_page);
89f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_invalidatepage);
90f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_try_to_free_buffers);
91f7f4bccbSMingming Cao EXPORT_SYMBOL(jbd2_journal_force_commit);
926ba0e7dcSRoss Zwisler EXPORT_SYMBOL(jbd2_journal_inode_ranged_write);
936ba0e7dcSRoss Zwisler EXPORT_SYMBOL(jbd2_journal_inode_ranged_wait);
94aa3c0c61SMauricio Faria de Oliveira EXPORT_SYMBOL(jbd2_journal_submit_inode_data_buffers);
95aa3c0c61SMauricio Faria de Oliveira EXPORT_SYMBOL(jbd2_journal_finish_inode_data_buffers);
96c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_init_jbd_inode);
97c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_release_jbd_inode);
98c851ed54SJan Kara EXPORT_SYMBOL(jbd2_journal_begin_ordered_truncate);
998aefcd55STheodore Ts'o EXPORT_SYMBOL(jbd2_inode_cache);
100470decc6SDave Kleikamp 
101d2eecb03STheodore Ts'o static int jbd2_journal_create_slab(size_t slab_size);
102470decc6SDave Kleikamp 
103169f1a2aSPaul Gortmaker #ifdef CONFIG_JBD2_DEBUG
104169f1a2aSPaul Gortmaker void __jbd2_debug(int level, const char *file, const char *func,
105169f1a2aSPaul Gortmaker 		  unsigned int line, const char *fmt, ...)
106169f1a2aSPaul Gortmaker {
107169f1a2aSPaul Gortmaker 	struct va_format vaf;
108169f1a2aSPaul Gortmaker 	va_list args;
109169f1a2aSPaul Gortmaker 
110169f1a2aSPaul Gortmaker 	if (level > jbd2_journal_enable_debug)
111169f1a2aSPaul Gortmaker 		return;
112169f1a2aSPaul Gortmaker 	va_start(args, fmt);
113169f1a2aSPaul Gortmaker 	vaf.fmt = fmt;
114169f1a2aSPaul Gortmaker 	vaf.va = &args;
1159196f571SWang Shilong 	printk(KERN_DEBUG "%s: (%s, %u): %pV", file, func, line, &vaf);
116169f1a2aSPaul Gortmaker 	va_end(args);
117169f1a2aSPaul Gortmaker }
118169f1a2aSPaul Gortmaker EXPORT_SYMBOL(__jbd2_debug);
119169f1a2aSPaul Gortmaker #endif
120169f1a2aSPaul Gortmaker 
12125ed6e8aSDarrick J. Wong /* Checksumming functions */
1227747e6d0SRashika Kheria static int jbd2_verify_csum_type(journal_t *j, journal_superblock_t *sb)
12325ed6e8aSDarrick J. Wong {
1248595798cSDarrick J. Wong 	if (!jbd2_journal_has_csum_v2or3_feature(j))
12525ed6e8aSDarrick J. Wong 		return 1;
12625ed6e8aSDarrick J. Wong 
12725ed6e8aSDarrick J. Wong 	return sb->s_checksum_type == JBD2_CRC32C_CHKSUM;
12825ed6e8aSDarrick J. Wong }
12925ed6e8aSDarrick J. Wong 
13018a6ea1eSDarrick J. Wong static __be32 jbd2_superblock_csum(journal_t *j, journal_superblock_t *sb)
1314fd5ea43SDarrick J. Wong {
13218a6ea1eSDarrick J. Wong 	__u32 csum;
13318a6ea1eSDarrick J. Wong 	__be32 old_csum;
1344fd5ea43SDarrick J. Wong 
1354fd5ea43SDarrick J. Wong 	old_csum = sb->s_checksum;
1364fd5ea43SDarrick J. Wong 	sb->s_checksum = 0;
1374fd5ea43SDarrick J. Wong 	csum = jbd2_chksum(j, ~0, (char *)sb, sizeof(journal_superblock_t));
1384fd5ea43SDarrick J. Wong 	sb->s_checksum = old_csum;
1394fd5ea43SDarrick J. Wong 
1404fd5ea43SDarrick J. Wong 	return cpu_to_be32(csum);
1414fd5ea43SDarrick J. Wong }
1424fd5ea43SDarrick J. Wong 
143470decc6SDave Kleikamp /*
144470decc6SDave Kleikamp  * Helper function used to manage commit timeouts
145470decc6SDave Kleikamp  */
146470decc6SDave Kleikamp 
147e3c95788SKees Cook static void commit_timeout(struct timer_list *t)
148470decc6SDave Kleikamp {
149e3c95788SKees Cook 	journal_t *journal = from_timer(journal, t, j_commit_timer);
150470decc6SDave Kleikamp 
151e3c95788SKees Cook 	wake_up_process(journal->j_task);
152470decc6SDave Kleikamp }
153470decc6SDave Kleikamp 
154470decc6SDave Kleikamp /*
155f7f4bccbSMingming Cao  * kjournald2: The main thread function used to manage a logging device
156470decc6SDave Kleikamp  * journal.
157470decc6SDave Kleikamp  *
158470decc6SDave Kleikamp  * This kernel thread is responsible for two things:
159470decc6SDave Kleikamp  *
160470decc6SDave Kleikamp  * 1) COMMIT:  Every so often we need to commit the current state of the
161470decc6SDave Kleikamp  *    filesystem to disk.  The journal thread is responsible for writing
162*ff780b91SHarshad Shirwadkar  *    all of the metadata buffers to disk. If a fast commit is ongoing
163*ff780b91SHarshad Shirwadkar  *    journal thread waits until it's done and then continues from
164*ff780b91SHarshad Shirwadkar  *    there on.
165470decc6SDave Kleikamp  *
166470decc6SDave Kleikamp  * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
167470decc6SDave Kleikamp  *    of the data in that part of the log has been rewritten elsewhere on
168470decc6SDave Kleikamp  *    the disk.  Flushing these old buffers to reclaim space in the log is
169470decc6SDave Kleikamp  *    known as checkpointing, and this thread is responsible for that job.
170470decc6SDave Kleikamp  */
171470decc6SDave Kleikamp 
172f7f4bccbSMingming Cao static int kjournald2(void *arg)
173470decc6SDave Kleikamp {
174470decc6SDave Kleikamp 	journal_t *journal = arg;
175470decc6SDave Kleikamp 	transaction_t *transaction;
176470decc6SDave Kleikamp 
177470decc6SDave Kleikamp 	/*
178470decc6SDave Kleikamp 	 * Set up an interval timer which can be used to trigger a commit wakeup
179470decc6SDave Kleikamp 	 * after the commit interval expires
180470decc6SDave Kleikamp 	 */
181e3c95788SKees Cook 	timer_setup(&journal->j_commit_timer, commit_timeout, 0);
182470decc6SDave Kleikamp 
18335c80422SNigel Cunningham 	set_freezable();
18435c80422SNigel Cunningham 
185470decc6SDave Kleikamp 	/* Record that the journal thread is running */
186470decc6SDave Kleikamp 	journal->j_task = current;
187470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
188470decc6SDave Kleikamp 
189470decc6SDave Kleikamp 	/*
190eb52da3fSMichal Hocko 	 * Make sure that no allocations from this kernel thread will ever
191eb52da3fSMichal Hocko 	 * recurse to the fs layer because we are responsible for the
192eb52da3fSMichal Hocko 	 * transaction commit and any fs involvement might get stuck waiting for
193eb52da3fSMichal Hocko 	 * the trasn. commit.
194eb52da3fSMichal Hocko 	 */
195eb52da3fSMichal Hocko 	memalloc_nofs_save();
196eb52da3fSMichal Hocko 
197eb52da3fSMichal Hocko 	/*
198470decc6SDave Kleikamp 	 * And now, wait forever for commit wakeup events.
199470decc6SDave Kleikamp 	 */
200a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
201470decc6SDave Kleikamp 
202470decc6SDave Kleikamp loop:
203f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_UNMOUNT)
204470decc6SDave Kleikamp 		goto end_loop;
205470decc6SDave Kleikamp 
2067821ce41SGaowei Pu 	jbd_debug(1, "commit_sequence=%u, commit_request=%u\n",
207470decc6SDave Kleikamp 		journal->j_commit_sequence, journal->j_commit_request);
208470decc6SDave Kleikamp 
209470decc6SDave Kleikamp 	if (journal->j_commit_sequence != journal->j_commit_request) {
210470decc6SDave Kleikamp 		jbd_debug(1, "OK, requests differ\n");
211a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
212470decc6SDave Kleikamp 		del_timer_sync(&journal->j_commit_timer);
213f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
214a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
215470decc6SDave Kleikamp 		goto loop;
216470decc6SDave Kleikamp 	}
217470decc6SDave Kleikamp 
218470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
219470decc6SDave Kleikamp 	if (freezing(current)) {
220470decc6SDave Kleikamp 		/*
221470decc6SDave Kleikamp 		 * The simpler the better. Flushing journal isn't a
222470decc6SDave Kleikamp 		 * good idea, because that depends on threads that may
223470decc6SDave Kleikamp 		 * be already stopped.
224470decc6SDave Kleikamp 		 */
225f7f4bccbSMingming Cao 		jbd_debug(1, "Now suspending kjournald2\n");
226a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
227a0acae0eSTejun Heo 		try_to_freeze();
228a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
229470decc6SDave Kleikamp 	} else {
230470decc6SDave Kleikamp 		/*
231470decc6SDave Kleikamp 		 * We assume on resume that commits are already there,
232470decc6SDave Kleikamp 		 * so we don't sleep
233470decc6SDave Kleikamp 		 */
234470decc6SDave Kleikamp 		DEFINE_WAIT(wait);
235470decc6SDave Kleikamp 		int should_sleep = 1;
236470decc6SDave Kleikamp 
237470decc6SDave Kleikamp 		prepare_to_wait(&journal->j_wait_commit, &wait,
238470decc6SDave Kleikamp 				TASK_INTERRUPTIBLE);
239470decc6SDave Kleikamp 		if (journal->j_commit_sequence != journal->j_commit_request)
240470decc6SDave Kleikamp 			should_sleep = 0;
241470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
242470decc6SDave Kleikamp 		if (transaction && time_after_eq(jiffies,
243470decc6SDave Kleikamp 						transaction->t_expires))
244470decc6SDave Kleikamp 			should_sleep = 0;
245f7f4bccbSMingming Cao 		if (journal->j_flags & JBD2_UNMOUNT)
246470decc6SDave Kleikamp 			should_sleep = 0;
247470decc6SDave Kleikamp 		if (should_sleep) {
248a931da6aSTheodore Ts'o 			write_unlock(&journal->j_state_lock);
249470decc6SDave Kleikamp 			schedule();
250a931da6aSTheodore Ts'o 			write_lock(&journal->j_state_lock);
251470decc6SDave Kleikamp 		}
252470decc6SDave Kleikamp 		finish_wait(&journal->j_wait_commit, &wait);
253470decc6SDave Kleikamp 	}
254470decc6SDave Kleikamp 
255f7f4bccbSMingming Cao 	jbd_debug(1, "kjournald2 wakes\n");
256470decc6SDave Kleikamp 
257470decc6SDave Kleikamp 	/*
258470decc6SDave Kleikamp 	 * Were we woken up by a commit wakeup event?
259470decc6SDave Kleikamp 	 */
260470decc6SDave Kleikamp 	transaction = journal->j_running_transaction;
261470decc6SDave Kleikamp 	if (transaction && time_after_eq(jiffies, transaction->t_expires)) {
262470decc6SDave Kleikamp 		journal->j_commit_request = transaction->t_tid;
263470decc6SDave Kleikamp 		jbd_debug(1, "woke because of timeout\n");
264470decc6SDave Kleikamp 	}
265470decc6SDave Kleikamp 	goto loop;
266470decc6SDave Kleikamp 
267470decc6SDave Kleikamp end_loop:
268470decc6SDave Kleikamp 	del_timer_sync(&journal->j_commit_timer);
269470decc6SDave Kleikamp 	journal->j_task = NULL;
270470decc6SDave Kleikamp 	wake_up(&journal->j_wait_done_commit);
271470decc6SDave Kleikamp 	jbd_debug(1, "Journal thread exiting.\n");
272dbfcef6bSSahitya Tummala 	write_unlock(&journal->j_state_lock);
273470decc6SDave Kleikamp 	return 0;
274470decc6SDave Kleikamp }
275470decc6SDave Kleikamp 
27697f06784SPavel Emelianov static int jbd2_journal_start_thread(journal_t *journal)
277470decc6SDave Kleikamp {
27897f06784SPavel Emelianov 	struct task_struct *t;
27997f06784SPavel Emelianov 
28090576c0bSTheodore Ts'o 	t = kthread_run(kjournald2, journal, "jbd2/%s",
28190576c0bSTheodore Ts'o 			journal->j_devname);
28297f06784SPavel Emelianov 	if (IS_ERR(t))
28397f06784SPavel Emelianov 		return PTR_ERR(t);
28497f06784SPavel Emelianov 
2851076d17aSAl Viro 	wait_event(journal->j_wait_done_commit, journal->j_task != NULL);
28697f06784SPavel Emelianov 	return 0;
287470decc6SDave Kleikamp }
288470decc6SDave Kleikamp 
289470decc6SDave Kleikamp static void journal_kill_thread(journal_t *journal)
290470decc6SDave Kleikamp {
291a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
292f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_UNMOUNT;
293470decc6SDave Kleikamp 
294470decc6SDave Kleikamp 	while (journal->j_task) {
295a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
2963469a32aSTheodore Ts'o 		wake_up(&journal->j_wait_commit);
2971076d17aSAl Viro 		wait_event(journal->j_wait_done_commit, journal->j_task == NULL);
298a931da6aSTheodore Ts'o 		write_lock(&journal->j_state_lock);
299470decc6SDave Kleikamp 	}
300a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
301470decc6SDave Kleikamp }
302470decc6SDave Kleikamp 
303470decc6SDave Kleikamp /*
304f7f4bccbSMingming Cao  * jbd2_journal_write_metadata_buffer: write a metadata buffer to the journal.
305470decc6SDave Kleikamp  *
306470decc6SDave Kleikamp  * Writes a metadata buffer to a given disk block.  The actual IO is not
307470decc6SDave Kleikamp  * performed but a new buffer_head is constructed which labels the data
308470decc6SDave Kleikamp  * to be written with the correct destination disk block.
309470decc6SDave Kleikamp  *
310470decc6SDave Kleikamp  * Any magic-number escaping which needs to be done will cause a
311470decc6SDave Kleikamp  * copy-out here.  If the buffer happens to start with the
312f7f4bccbSMingming Cao  * JBD2_MAGIC_NUMBER, then we can't write it to the log directly: the
313470decc6SDave Kleikamp  * magic number is only written to the log for descripter blocks.  In
314470decc6SDave Kleikamp  * this case, we copy the data and replace the first word with 0, and we
315470decc6SDave Kleikamp  * return a result code which indicates that this buffer needs to be
316470decc6SDave Kleikamp  * marked as an escaped buffer in the corresponding log descriptor
317470decc6SDave Kleikamp  * block.  The missing word can then be restored when the block is read
318470decc6SDave Kleikamp  * during recovery.
319470decc6SDave Kleikamp  *
320470decc6SDave Kleikamp  * If the source buffer has already been modified by a new transaction
321470decc6SDave Kleikamp  * since we took the last commit snapshot, we use the frozen copy of
322470decc6SDave Kleikamp  * that data for IO. If we end up using the existing buffer_head's data
323f5113effSJan Kara  * for the write, then we have to make sure nobody modifies it while the
324f5113effSJan Kara  * IO is in progress. do_get_write_access() handles this.
325470decc6SDave Kleikamp  *
326f5113effSJan Kara  * The function returns a pointer to the buffer_head to be used for IO.
327470decc6SDave Kleikamp  *
328470decc6SDave Kleikamp  *
329470decc6SDave Kleikamp  * Return value:
330470decc6SDave Kleikamp  *  <0: Error
331470decc6SDave Kleikamp  * >=0: Finished OK
332470decc6SDave Kleikamp  *
333470decc6SDave Kleikamp  * On success:
334470decc6SDave Kleikamp  * Bit 0 set == escape performed on the data
335470decc6SDave Kleikamp  * Bit 1 set == buffer copy-out performed (kfree the data after IO)
336470decc6SDave Kleikamp  */
337470decc6SDave Kleikamp 
338f7f4bccbSMingming Cao int jbd2_journal_write_metadata_buffer(transaction_t *transaction,
339470decc6SDave Kleikamp 				  struct journal_head  *jh_in,
340f5113effSJan Kara 				  struct buffer_head **bh_out,
341f5113effSJan Kara 				  sector_t blocknr)
342470decc6SDave Kleikamp {
343470decc6SDave Kleikamp 	int need_copy_out = 0;
344470decc6SDave Kleikamp 	int done_copy_out = 0;
345470decc6SDave Kleikamp 	int do_escape = 0;
346470decc6SDave Kleikamp 	char *mapped_data;
347470decc6SDave Kleikamp 	struct buffer_head *new_bh;
348470decc6SDave Kleikamp 	struct page *new_page;
349470decc6SDave Kleikamp 	unsigned int new_offset;
350470decc6SDave Kleikamp 	struct buffer_head *bh_in = jh2bh(jh_in);
35196577c43Sdingdinghua 	journal_t *journal = transaction->t_journal;
352470decc6SDave Kleikamp 
353470decc6SDave Kleikamp 	/*
354470decc6SDave Kleikamp 	 * The buffer really shouldn't be locked: only the current committing
355470decc6SDave Kleikamp 	 * transaction is allowed to write it, so nobody else is allowed
356470decc6SDave Kleikamp 	 * to do any IO.
357470decc6SDave Kleikamp 	 *
358470decc6SDave Kleikamp 	 * akpm: except if we're journalling data, and write() output is
359470decc6SDave Kleikamp 	 * also part of a shared mapping, and another thread has
360470decc6SDave Kleikamp 	 * decided to launch a writepage() against this buffer.
361470decc6SDave Kleikamp 	 */
362470decc6SDave Kleikamp 	J_ASSERT_BH(bh_in, buffer_jbddirty(bh_in));
363470decc6SDave Kleikamp 
3646ccaf3e2SMichal Hocko 	new_bh = alloc_buffer_head(GFP_NOFS|__GFP_NOFAIL);
36547def826STheodore Ts'o 
36696577c43Sdingdinghua 	/* keep subsequent assertions sane */
36796577c43Sdingdinghua 	atomic_set(&new_bh->b_count, 1);
368470decc6SDave Kleikamp 
36946417064SThomas Gleixner 	spin_lock(&jh_in->b_state_lock);
370f5113effSJan Kara repeat:
371470decc6SDave Kleikamp 	/*
372470decc6SDave Kleikamp 	 * If a new transaction has already done a buffer copy-out, then
373470decc6SDave Kleikamp 	 * we use that version of the data for the commit.
374470decc6SDave Kleikamp 	 */
375470decc6SDave Kleikamp 	if (jh_in->b_frozen_data) {
376470decc6SDave Kleikamp 		done_copy_out = 1;
377470decc6SDave Kleikamp 		new_page = virt_to_page(jh_in->b_frozen_data);
378470decc6SDave Kleikamp 		new_offset = offset_in_page(jh_in->b_frozen_data);
379470decc6SDave Kleikamp 	} else {
380470decc6SDave Kleikamp 		new_page = jh2bh(jh_in)->b_page;
381470decc6SDave Kleikamp 		new_offset = offset_in_page(jh2bh(jh_in)->b_data);
382470decc6SDave Kleikamp 	}
383470decc6SDave Kleikamp 
384303a8f2aSCong Wang 	mapped_data = kmap_atomic(new_page);
385470decc6SDave Kleikamp 	/*
38613ceef09SJan Kara 	 * Fire data frozen trigger if data already wasn't frozen.  Do this
38713ceef09SJan Kara 	 * before checking for escaping, as the trigger may modify the magic
38813ceef09SJan Kara 	 * offset.  If a copy-out happens afterwards, it will have the correct
38913ceef09SJan Kara 	 * data in the buffer.
390e06c8227SJoel Becker 	 */
39113ceef09SJan Kara 	if (!done_copy_out)
39213ceef09SJan Kara 		jbd2_buffer_frozen_trigger(jh_in, mapped_data + new_offset,
39313ceef09SJan Kara 					   jh_in->b_triggers);
394e06c8227SJoel Becker 
395e06c8227SJoel Becker 	/*
396470decc6SDave Kleikamp 	 * Check for escaping
397470decc6SDave Kleikamp 	 */
398470decc6SDave Kleikamp 	if (*((__be32 *)(mapped_data + new_offset)) ==
399f7f4bccbSMingming Cao 				cpu_to_be32(JBD2_MAGIC_NUMBER)) {
400470decc6SDave Kleikamp 		need_copy_out = 1;
401470decc6SDave Kleikamp 		do_escape = 1;
402470decc6SDave Kleikamp 	}
403303a8f2aSCong Wang 	kunmap_atomic(mapped_data);
404470decc6SDave Kleikamp 
405470decc6SDave Kleikamp 	/*
406470decc6SDave Kleikamp 	 * Do we need to do a data copy?
407470decc6SDave Kleikamp 	 */
408470decc6SDave Kleikamp 	if (need_copy_out && !done_copy_out) {
409470decc6SDave Kleikamp 		char *tmp;
410470decc6SDave Kleikamp 
41146417064SThomas Gleixner 		spin_unlock(&jh_in->b_state_lock);
412af1e76d6SMingming Cao 		tmp = jbd2_alloc(bh_in->b_size, GFP_NOFS);
413e6ec116bSTheodore Ts'o 		if (!tmp) {
414f5113effSJan Kara 			brelse(new_bh);
415e6ec116bSTheodore Ts'o 			return -ENOMEM;
416e6ec116bSTheodore Ts'o 		}
41746417064SThomas Gleixner 		spin_lock(&jh_in->b_state_lock);
418470decc6SDave Kleikamp 		if (jh_in->b_frozen_data) {
419af1e76d6SMingming Cao 			jbd2_free(tmp, bh_in->b_size);
420470decc6SDave Kleikamp 			goto repeat;
421470decc6SDave Kleikamp 		}
422470decc6SDave Kleikamp 
423470decc6SDave Kleikamp 		jh_in->b_frozen_data = tmp;
424303a8f2aSCong Wang 		mapped_data = kmap_atomic(new_page);
425f5113effSJan Kara 		memcpy(tmp, mapped_data + new_offset, bh_in->b_size);
426303a8f2aSCong Wang 		kunmap_atomic(mapped_data);
427470decc6SDave Kleikamp 
428470decc6SDave Kleikamp 		new_page = virt_to_page(tmp);
429470decc6SDave Kleikamp 		new_offset = offset_in_page(tmp);
430470decc6SDave Kleikamp 		done_copy_out = 1;
431e06c8227SJoel Becker 
432e06c8227SJoel Becker 		/*
433e06c8227SJoel Becker 		 * This isn't strictly necessary, as we're using frozen
434e06c8227SJoel Becker 		 * data for the escaping, but it keeps consistency with
435e06c8227SJoel Becker 		 * b_frozen_data usage.
436e06c8227SJoel Becker 		 */
437e06c8227SJoel Becker 		jh_in->b_frozen_triggers = jh_in->b_triggers;
438470decc6SDave Kleikamp 	}
439470decc6SDave Kleikamp 
440470decc6SDave Kleikamp 	/*
441470decc6SDave Kleikamp 	 * Did we need to do an escaping?  Now we've done all the
442470decc6SDave Kleikamp 	 * copying, we can finally do so.
443470decc6SDave Kleikamp 	 */
444470decc6SDave Kleikamp 	if (do_escape) {
445303a8f2aSCong Wang 		mapped_data = kmap_atomic(new_page);
446470decc6SDave Kleikamp 		*((unsigned int *)(mapped_data + new_offset)) = 0;
447303a8f2aSCong Wang 		kunmap_atomic(mapped_data);
448470decc6SDave Kleikamp 	}
449470decc6SDave Kleikamp 
450470decc6SDave Kleikamp 	set_bh_page(new_bh, new_page, new_offset);
451f5113effSJan Kara 	new_bh->b_size = bh_in->b_size;
452f5113effSJan Kara 	new_bh->b_bdev = journal->j_dev;
453470decc6SDave Kleikamp 	new_bh->b_blocknr = blocknr;
454b34090e5SJan Kara 	new_bh->b_private = bh_in;
455470decc6SDave Kleikamp 	set_buffer_mapped(new_bh);
456470decc6SDave Kleikamp 	set_buffer_dirty(new_bh);
457470decc6SDave Kleikamp 
458f5113effSJan Kara 	*bh_out = new_bh;
459470decc6SDave Kleikamp 
460470decc6SDave Kleikamp 	/*
461470decc6SDave Kleikamp 	 * The to-be-written buffer needs to get moved to the io queue,
462470decc6SDave Kleikamp 	 * and the original buffer whose contents we are shadowing or
463470decc6SDave Kleikamp 	 * copying is moved to the transaction's shadow queue.
464470decc6SDave Kleikamp 	 */
465470decc6SDave Kleikamp 	JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
46696577c43Sdingdinghua 	spin_lock(&journal->j_list_lock);
46796577c43Sdingdinghua 	__jbd2_journal_file_buffer(jh_in, transaction, BJ_Shadow);
46896577c43Sdingdinghua 	spin_unlock(&journal->j_list_lock);
469b34090e5SJan Kara 	set_buffer_shadow(bh_in);
47046417064SThomas Gleixner 	spin_unlock(&jh_in->b_state_lock);
47196577c43Sdingdinghua 
472470decc6SDave Kleikamp 	return do_escape | (done_copy_out << 1);
473470decc6SDave Kleikamp }
474470decc6SDave Kleikamp 
475470decc6SDave Kleikamp /*
476470decc6SDave Kleikamp  * Allocation code for the journal file.  Manage the space left in the
477470decc6SDave Kleikamp  * journal, so that we can begin checkpointing when appropriate.
478470decc6SDave Kleikamp  */
479470decc6SDave Kleikamp 
480470decc6SDave Kleikamp /*
481e4471831STheodore Ts'o  * Called with j_state_lock locked for writing.
482e4471831STheodore Ts'o  * Returns true if a transaction commit was started.
483470decc6SDave Kleikamp  */
484f7f4bccbSMingming Cao int __jbd2_log_start_commit(journal_t *journal, tid_t target)
485470decc6SDave Kleikamp {
486e7b04ac0SEric Sandeen 	/* Return if the txn has already requested to be committed */
487e7b04ac0SEric Sandeen 	if (journal->j_commit_request == target)
488e7b04ac0SEric Sandeen 		return 0;
489e7b04ac0SEric Sandeen 
490470decc6SDave Kleikamp 	/*
491deeeaf13STheodore Ts'o 	 * The only transaction we can possibly wait upon is the
492deeeaf13STheodore Ts'o 	 * currently running transaction (if it exists).  Otherwise,
493deeeaf13STheodore Ts'o 	 * the target tid must be an old one.
494470decc6SDave Kleikamp 	 */
495deeeaf13STheodore Ts'o 	if (journal->j_running_transaction &&
496deeeaf13STheodore Ts'o 	    journal->j_running_transaction->t_tid == target) {
497470decc6SDave Kleikamp 		/*
498bcf3d0bcSAndrea Gelmini 		 * We want a new commit: OK, mark the request and wakeup the
499470decc6SDave Kleikamp 		 * commit thread.  We do _not_ do the commit ourselves.
500470decc6SDave Kleikamp 		 */
501470decc6SDave Kleikamp 
502470decc6SDave Kleikamp 		journal->j_commit_request = target;
5037821ce41SGaowei Pu 		jbd_debug(1, "JBD2: requesting commit %u/%u\n",
504470decc6SDave Kleikamp 			  journal->j_commit_request,
505470decc6SDave Kleikamp 			  journal->j_commit_sequence);
5069fff24aaSTheodore Ts'o 		journal->j_running_transaction->t_requested = jiffies;
507470decc6SDave Kleikamp 		wake_up(&journal->j_wait_commit);
508470decc6SDave Kleikamp 		return 1;
509deeeaf13STheodore Ts'o 	} else if (!tid_geq(journal->j_commit_request, target))
510deeeaf13STheodore Ts'o 		/* This should never happen, but if it does, preserve
511deeeaf13STheodore Ts'o 		   the evidence before kjournald goes into a loop and
512deeeaf13STheodore Ts'o 		   increments j_commit_sequence beyond all recognition. */
513f2a44523SEryu Guan 		WARN_ONCE(1, "JBD2: bad log_start_commit: %u %u %u %u\n",
5141be2add6STheodore Ts'o 			  journal->j_commit_request,
5151be2add6STheodore Ts'o 			  journal->j_commit_sequence,
516deeeaf13STheodore Ts'o 			  target, journal->j_running_transaction ?
517deeeaf13STheodore Ts'o 			  journal->j_running_transaction->t_tid : 0);
518470decc6SDave Kleikamp 	return 0;
519470decc6SDave Kleikamp }
520470decc6SDave Kleikamp 
521f7f4bccbSMingming Cao int jbd2_log_start_commit(journal_t *journal, tid_t tid)
522470decc6SDave Kleikamp {
523470decc6SDave Kleikamp 	int ret;
524470decc6SDave Kleikamp 
525a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
526f7f4bccbSMingming Cao 	ret = __jbd2_log_start_commit(journal, tid);
527a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
528470decc6SDave Kleikamp 	return ret;
529470decc6SDave Kleikamp }
530470decc6SDave Kleikamp 
531470decc6SDave Kleikamp /*
5329ff86446SDmitry Monakhov  * Force and wait any uncommitted transactions.  We can only force the running
5339ff86446SDmitry Monakhov  * transaction if we don't have an active handle, otherwise, we will deadlock.
5349ff86446SDmitry Monakhov  * Returns: <0 in case of error,
5359ff86446SDmitry Monakhov  *           0 if nothing to commit,
5369ff86446SDmitry Monakhov  *           1 if transaction was successfully committed.
537470decc6SDave Kleikamp  */
5389ff86446SDmitry Monakhov static int __jbd2_journal_force_commit(journal_t *journal)
539470decc6SDave Kleikamp {
540470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
541470decc6SDave Kleikamp 	tid_t tid;
5429ff86446SDmitry Monakhov 	int need_to_start = 0, ret = 0;
543470decc6SDave Kleikamp 
544a931da6aSTheodore Ts'o 	read_lock(&journal->j_state_lock);
545470decc6SDave Kleikamp 	if (journal->j_running_transaction && !current->journal_info) {
546470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
547e4471831STheodore Ts'o 		if (!tid_geq(journal->j_commit_request, transaction->t_tid))
548e4471831STheodore Ts'o 			need_to_start = 1;
549470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
550470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
551470decc6SDave Kleikamp 
552470decc6SDave Kleikamp 	if (!transaction) {
5539ff86446SDmitry Monakhov 		/* Nothing to commit */
554a931da6aSTheodore Ts'o 		read_unlock(&journal->j_state_lock);
5559ff86446SDmitry Monakhov 		return 0;
556470decc6SDave Kleikamp 	}
557470decc6SDave Kleikamp 	tid = transaction->t_tid;
558a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
559e4471831STheodore Ts'o 	if (need_to_start)
560e4471831STheodore Ts'o 		jbd2_log_start_commit(journal, tid);
5619ff86446SDmitry Monakhov 	ret = jbd2_log_wait_commit(journal, tid);
5629ff86446SDmitry Monakhov 	if (!ret)
5639ff86446SDmitry Monakhov 		ret = 1;
5649ff86446SDmitry Monakhov 
5659ff86446SDmitry Monakhov 	return ret;
5669ff86446SDmitry Monakhov }
5679ff86446SDmitry Monakhov 
5689ff86446SDmitry Monakhov /**
5699ff86446SDmitry Monakhov  * Force and wait upon a commit if the calling process is not within
5709ff86446SDmitry Monakhov  * transaction.  This is used for forcing out undo-protected data which contains
5719ff86446SDmitry Monakhov  * bitmaps, when the fs is running out of space.
5729ff86446SDmitry Monakhov  *
5739ff86446SDmitry Monakhov  * @journal: journal to force
5749ff86446SDmitry Monakhov  * Returns true if progress was made.
5759ff86446SDmitry Monakhov  */
5769ff86446SDmitry Monakhov int jbd2_journal_force_commit_nested(journal_t *journal)
5779ff86446SDmitry Monakhov {
5789ff86446SDmitry Monakhov 	int ret;
5799ff86446SDmitry Monakhov 
5809ff86446SDmitry Monakhov 	ret = __jbd2_journal_force_commit(journal);
5819ff86446SDmitry Monakhov 	return ret > 0;
5829ff86446SDmitry Monakhov }
5839ff86446SDmitry Monakhov 
5849ff86446SDmitry Monakhov /**
5859ff86446SDmitry Monakhov  * int journal_force_commit() - force any uncommitted transactions
5869ff86446SDmitry Monakhov  * @journal: journal to force
5879ff86446SDmitry Monakhov  *
5889ff86446SDmitry Monakhov  * Caller want unconditional commit. We can only force the running transaction
5899ff86446SDmitry Monakhov  * if we don't have an active handle, otherwise, we will deadlock.
5909ff86446SDmitry Monakhov  */
5919ff86446SDmitry Monakhov int jbd2_journal_force_commit(journal_t *journal)
5929ff86446SDmitry Monakhov {
5939ff86446SDmitry Monakhov 	int ret;
5949ff86446SDmitry Monakhov 
5959ff86446SDmitry Monakhov 	J_ASSERT(!current->journal_info);
5969ff86446SDmitry Monakhov 	ret = __jbd2_journal_force_commit(journal);
5979ff86446SDmitry Monakhov 	if (ret > 0)
5989ff86446SDmitry Monakhov 		ret = 0;
5999ff86446SDmitry Monakhov 	return ret;
600470decc6SDave Kleikamp }
601470decc6SDave Kleikamp 
602470decc6SDave Kleikamp /*
603470decc6SDave Kleikamp  * Start a commit of the current running transaction (if any).  Returns true
604c88ccea3SJan Kara  * if a transaction is going to be committed (or is currently already
605c88ccea3SJan Kara  * committing), and fills its tid in at *ptid
606470decc6SDave Kleikamp  */
607f7f4bccbSMingming Cao int jbd2_journal_start_commit(journal_t *journal, tid_t *ptid)
608470decc6SDave Kleikamp {
609470decc6SDave Kleikamp 	int ret = 0;
610470decc6SDave Kleikamp 
611a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
612470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
613470decc6SDave Kleikamp 		tid_t tid = journal->j_running_transaction->t_tid;
614470decc6SDave Kleikamp 
615c88ccea3SJan Kara 		__jbd2_log_start_commit(journal, tid);
616c88ccea3SJan Kara 		/* There's a running transaction and we've just made sure
617c88ccea3SJan Kara 		 * it's commit has been scheduled. */
618c88ccea3SJan Kara 		if (ptid)
619470decc6SDave Kleikamp 			*ptid = tid;
620c88ccea3SJan Kara 		ret = 1;
621c88ccea3SJan Kara 	} else if (journal->j_committing_transaction) {
622470decc6SDave Kleikamp 		/*
62312810ad7SArtem Bityutskiy 		 * If commit has been started, then we have to wait for
62412810ad7SArtem Bityutskiy 		 * completion of that transaction.
625470decc6SDave Kleikamp 		 */
626c88ccea3SJan Kara 		if (ptid)
627470decc6SDave Kleikamp 			*ptid = journal->j_committing_transaction->t_tid;
628470decc6SDave Kleikamp 		ret = 1;
629470decc6SDave Kleikamp 	}
630a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
631470decc6SDave Kleikamp 	return ret;
632470decc6SDave Kleikamp }
633470decc6SDave Kleikamp 
634470decc6SDave Kleikamp /*
635bbd2be36SJan Kara  * Return 1 if a given transaction has not yet sent barrier request
636bbd2be36SJan Kara  * connected with a transaction commit. If 0 is returned, transaction
637bbd2be36SJan Kara  * may or may not have sent the barrier. Used to avoid sending barrier
638bbd2be36SJan Kara  * twice in common cases.
639bbd2be36SJan Kara  */
640bbd2be36SJan Kara int jbd2_trans_will_send_data_barrier(journal_t *journal, tid_t tid)
641bbd2be36SJan Kara {
642bbd2be36SJan Kara 	int ret = 0;
643bbd2be36SJan Kara 	transaction_t *commit_trans;
644bbd2be36SJan Kara 
645bbd2be36SJan Kara 	if (!(journal->j_flags & JBD2_BARRIER))
646bbd2be36SJan Kara 		return 0;
647bbd2be36SJan Kara 	read_lock(&journal->j_state_lock);
648bbd2be36SJan Kara 	/* Transaction already committed? */
649bbd2be36SJan Kara 	if (tid_geq(journal->j_commit_sequence, tid))
650bbd2be36SJan Kara 		goto out;
651bbd2be36SJan Kara 	commit_trans = journal->j_committing_transaction;
652bbd2be36SJan Kara 	if (!commit_trans || commit_trans->t_tid != tid) {
653bbd2be36SJan Kara 		ret = 1;
654bbd2be36SJan Kara 		goto out;
655bbd2be36SJan Kara 	}
656bbd2be36SJan Kara 	/*
657bbd2be36SJan Kara 	 * Transaction is being committed and we already proceeded to
658bbd2be36SJan Kara 	 * submitting a flush to fs partition?
659bbd2be36SJan Kara 	 */
660bbd2be36SJan Kara 	if (journal->j_fs_dev != journal->j_dev) {
661bbd2be36SJan Kara 		if (!commit_trans->t_need_data_flush ||
662bbd2be36SJan Kara 		    commit_trans->t_state >= T_COMMIT_DFLUSH)
663bbd2be36SJan Kara 			goto out;
664bbd2be36SJan Kara 	} else {
665bbd2be36SJan Kara 		if (commit_trans->t_state >= T_COMMIT_JFLUSH)
666bbd2be36SJan Kara 			goto out;
667bbd2be36SJan Kara 	}
668bbd2be36SJan Kara 	ret = 1;
669bbd2be36SJan Kara out:
670bbd2be36SJan Kara 	read_unlock(&journal->j_state_lock);
671bbd2be36SJan Kara 	return ret;
672bbd2be36SJan Kara }
673bbd2be36SJan Kara EXPORT_SYMBOL(jbd2_trans_will_send_data_barrier);
674bbd2be36SJan Kara 
675bbd2be36SJan Kara /*
676470decc6SDave Kleikamp  * Wait for a specified commit to complete.
677470decc6SDave Kleikamp  * The caller may not hold the journal lock.
678470decc6SDave Kleikamp  */
679f7f4bccbSMingming Cao int jbd2_log_wait_commit(journal_t *journal, tid_t tid)
680470decc6SDave Kleikamp {
681470decc6SDave Kleikamp 	int err = 0;
682470decc6SDave Kleikamp 
683c52c47e4SJan Kara 	read_lock(&journal->j_state_lock);
684c52c47e4SJan Kara #ifdef CONFIG_PROVE_LOCKING
685c52c47e4SJan Kara 	/*
686c52c47e4SJan Kara 	 * Some callers make sure transaction is already committing and in that
687c52c47e4SJan Kara 	 * case we cannot block on open handles anymore. So don't warn in that
688c52c47e4SJan Kara 	 * case.
689c52c47e4SJan Kara 	 */
690c52c47e4SJan Kara 	if (tid_gt(tid, journal->j_commit_sequence) &&
691c52c47e4SJan Kara 	    (!journal->j_committing_transaction ||
692c52c47e4SJan Kara 	     journal->j_committing_transaction->t_tid != tid)) {
693c52c47e4SJan Kara 		read_unlock(&journal->j_state_lock);
6941eaa566dSJan Kara 		jbd2_might_wait_for_commit(journal);
695a931da6aSTheodore Ts'o 		read_lock(&journal->j_state_lock);
696c52c47e4SJan Kara 	}
697c52c47e4SJan Kara #endif
698e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
699470decc6SDave Kleikamp 	if (!tid_geq(journal->j_commit_request, tid)) {
70075685071SJan Kara 		printk(KERN_ERR
7017821ce41SGaowei Pu 		       "%s: error: j_commit_request=%u, tid=%u\n",
702329d291fSHarvey Harrison 		       __func__, journal->j_commit_request, tid);
703470decc6SDave Kleikamp 	}
704470decc6SDave Kleikamp #endif
705470decc6SDave Kleikamp 	while (tid_gt(tid, journal->j_commit_sequence)) {
7067821ce41SGaowei Pu 		jbd_debug(1, "JBD2: want %u, j_commit_sequence=%u\n",
707470decc6SDave Kleikamp 				  tid, journal->j_commit_sequence);
708a931da6aSTheodore Ts'o 		read_unlock(&journal->j_state_lock);
7093469a32aSTheodore Ts'o 		wake_up(&journal->j_wait_commit);
710470decc6SDave Kleikamp 		wait_event(journal->j_wait_done_commit,
711470decc6SDave Kleikamp 				!tid_gt(tid, journal->j_commit_sequence));
712a931da6aSTheodore Ts'o 		read_lock(&journal->j_state_lock);
713470decc6SDave Kleikamp 	}
714a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
715470decc6SDave Kleikamp 
71675685071SJan Kara 	if (unlikely(is_journal_aborted(journal)))
717470decc6SDave Kleikamp 		err = -EIO;
718470decc6SDave Kleikamp 	return err;
719470decc6SDave Kleikamp }
720470decc6SDave Kleikamp 
721*ff780b91SHarshad Shirwadkar /*
722*ff780b91SHarshad Shirwadkar  * Start a fast commit. If there's an ongoing fast or full commit wait for
723*ff780b91SHarshad Shirwadkar  * it to complete. Returns 0 if a new fast commit was started. Returns -EALREADY
724*ff780b91SHarshad Shirwadkar  * if a fast commit is not needed, either because there's an already a commit
725*ff780b91SHarshad Shirwadkar  * going on or this tid has already been committed. Returns -EINVAL if no jbd2
726*ff780b91SHarshad Shirwadkar  * commit has yet been performed.
727*ff780b91SHarshad Shirwadkar  */
728*ff780b91SHarshad Shirwadkar int jbd2_fc_begin_commit(journal_t *journal, tid_t tid)
729*ff780b91SHarshad Shirwadkar {
730*ff780b91SHarshad Shirwadkar 	/*
731*ff780b91SHarshad Shirwadkar 	 * Fast commits only allowed if at least one full commit has
732*ff780b91SHarshad Shirwadkar 	 * been processed.
733*ff780b91SHarshad Shirwadkar 	 */
734*ff780b91SHarshad Shirwadkar 	if (!journal->j_stats.ts_tid)
735*ff780b91SHarshad Shirwadkar 		return -EINVAL;
736*ff780b91SHarshad Shirwadkar 
737*ff780b91SHarshad Shirwadkar 	if (tid <= journal->j_commit_sequence)
738*ff780b91SHarshad Shirwadkar 		return -EALREADY;
739*ff780b91SHarshad Shirwadkar 
740*ff780b91SHarshad Shirwadkar 	write_lock(&journal->j_state_lock);
741*ff780b91SHarshad Shirwadkar 	if (journal->j_flags & JBD2_FULL_COMMIT_ONGOING ||
742*ff780b91SHarshad Shirwadkar 	    (journal->j_flags & JBD2_FAST_COMMIT_ONGOING)) {
743*ff780b91SHarshad Shirwadkar 		DEFINE_WAIT(wait);
744*ff780b91SHarshad Shirwadkar 
745*ff780b91SHarshad Shirwadkar 		prepare_to_wait(&journal->j_fc_wait, &wait,
746*ff780b91SHarshad Shirwadkar 				TASK_UNINTERRUPTIBLE);
747*ff780b91SHarshad Shirwadkar 		write_unlock(&journal->j_state_lock);
748*ff780b91SHarshad Shirwadkar 		schedule();
749*ff780b91SHarshad Shirwadkar 		finish_wait(&journal->j_fc_wait, &wait);
750*ff780b91SHarshad Shirwadkar 		return -EALREADY;
751*ff780b91SHarshad Shirwadkar 	}
752*ff780b91SHarshad Shirwadkar 	journal->j_flags |= JBD2_FAST_COMMIT_ONGOING;
753*ff780b91SHarshad Shirwadkar 	write_unlock(&journal->j_state_lock);
754*ff780b91SHarshad Shirwadkar 
755*ff780b91SHarshad Shirwadkar 	return 0;
756*ff780b91SHarshad Shirwadkar }
757*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_begin_commit);
758*ff780b91SHarshad Shirwadkar 
759*ff780b91SHarshad Shirwadkar /*
760*ff780b91SHarshad Shirwadkar  * Stop a fast commit. If fallback is set, this function starts commit of
761*ff780b91SHarshad Shirwadkar  * TID tid before any other fast commit can start.
762*ff780b91SHarshad Shirwadkar  */
763*ff780b91SHarshad Shirwadkar static int __jbd2_fc_end_commit(journal_t *journal, tid_t tid, bool fallback)
764*ff780b91SHarshad Shirwadkar {
765*ff780b91SHarshad Shirwadkar 	if (journal->j_fc_cleanup_callback)
766*ff780b91SHarshad Shirwadkar 		journal->j_fc_cleanup_callback(journal, 0);
767*ff780b91SHarshad Shirwadkar 	write_lock(&journal->j_state_lock);
768*ff780b91SHarshad Shirwadkar 	journal->j_flags &= ~JBD2_FAST_COMMIT_ONGOING;
769*ff780b91SHarshad Shirwadkar 	if (fallback)
770*ff780b91SHarshad Shirwadkar 		journal->j_flags |= JBD2_FULL_COMMIT_ONGOING;
771*ff780b91SHarshad Shirwadkar 	write_unlock(&journal->j_state_lock);
772*ff780b91SHarshad Shirwadkar 	wake_up(&journal->j_fc_wait);
773*ff780b91SHarshad Shirwadkar 	if (fallback)
774*ff780b91SHarshad Shirwadkar 		return jbd2_complete_transaction(journal, tid);
775*ff780b91SHarshad Shirwadkar 	return 0;
776*ff780b91SHarshad Shirwadkar }
777*ff780b91SHarshad Shirwadkar 
778*ff780b91SHarshad Shirwadkar int jbd2_fc_end_commit(journal_t *journal)
779*ff780b91SHarshad Shirwadkar {
780*ff780b91SHarshad Shirwadkar 	return __jbd2_fc_end_commit(journal, 0, 0);
781*ff780b91SHarshad Shirwadkar }
782*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_end_commit);
783*ff780b91SHarshad Shirwadkar 
784*ff780b91SHarshad Shirwadkar int jbd2_fc_end_commit_fallback(journal_t *journal, tid_t tid)
785*ff780b91SHarshad Shirwadkar {
786*ff780b91SHarshad Shirwadkar 	return __jbd2_fc_end_commit(journal, tid, 1);
787*ff780b91SHarshad Shirwadkar }
788*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_end_commit_fallback);
789*ff780b91SHarshad Shirwadkar 
790b8a6176cSJan Kara /* Return 1 when transaction with given tid has already committed. */
791b8a6176cSJan Kara int jbd2_transaction_committed(journal_t *journal, tid_t tid)
792b8a6176cSJan Kara {
793b8a6176cSJan Kara 	int ret = 1;
794b8a6176cSJan Kara 
795b8a6176cSJan Kara 	read_lock(&journal->j_state_lock);
796b8a6176cSJan Kara 	if (journal->j_running_transaction &&
797b8a6176cSJan Kara 	    journal->j_running_transaction->t_tid == tid)
798b8a6176cSJan Kara 		ret = 0;
799b8a6176cSJan Kara 	if (journal->j_committing_transaction &&
800b8a6176cSJan Kara 	    journal->j_committing_transaction->t_tid == tid)
801b8a6176cSJan Kara 		ret = 0;
802b8a6176cSJan Kara 	read_unlock(&journal->j_state_lock);
803b8a6176cSJan Kara 	return ret;
804b8a6176cSJan Kara }
805b8a6176cSJan Kara EXPORT_SYMBOL(jbd2_transaction_committed);
806b8a6176cSJan Kara 
807470decc6SDave Kleikamp /*
808d76a3a77STheodore Ts'o  * When this function returns the transaction corresponding to tid
809d76a3a77STheodore Ts'o  * will be completed.  If the transaction has currently running, start
810d76a3a77STheodore Ts'o  * committing that transaction before waiting for it to complete.  If
811d76a3a77STheodore Ts'o  * the transaction id is stale, it is by definition already completed,
812d76a3a77STheodore Ts'o  * so just return SUCCESS.
813d76a3a77STheodore Ts'o  */
814d76a3a77STheodore Ts'o int jbd2_complete_transaction(journal_t *journal, tid_t tid)
815d76a3a77STheodore Ts'o {
816d76a3a77STheodore Ts'o 	int	need_to_wait = 1;
817d76a3a77STheodore Ts'o 
818d76a3a77STheodore Ts'o 	read_lock(&journal->j_state_lock);
819d76a3a77STheodore Ts'o 	if (journal->j_running_transaction &&
820d76a3a77STheodore Ts'o 	    journal->j_running_transaction->t_tid == tid) {
821d76a3a77STheodore Ts'o 		if (journal->j_commit_request != tid) {
822d76a3a77STheodore Ts'o 			/* transaction not yet started, so request it */
823d76a3a77STheodore Ts'o 			read_unlock(&journal->j_state_lock);
824d76a3a77STheodore Ts'o 			jbd2_log_start_commit(journal, tid);
825d76a3a77STheodore Ts'o 			goto wait_commit;
826d76a3a77STheodore Ts'o 		}
827d76a3a77STheodore Ts'o 	} else if (!(journal->j_committing_transaction &&
828d76a3a77STheodore Ts'o 		     journal->j_committing_transaction->t_tid == tid))
829d76a3a77STheodore Ts'o 		need_to_wait = 0;
830d76a3a77STheodore Ts'o 	read_unlock(&journal->j_state_lock);
831d76a3a77STheodore Ts'o 	if (!need_to_wait)
832d76a3a77STheodore Ts'o 		return 0;
833d76a3a77STheodore Ts'o wait_commit:
834d76a3a77STheodore Ts'o 	return jbd2_log_wait_commit(journal, tid);
835d76a3a77STheodore Ts'o }
836d76a3a77STheodore Ts'o EXPORT_SYMBOL(jbd2_complete_transaction);
837d76a3a77STheodore Ts'o 
838d76a3a77STheodore Ts'o /*
839470decc6SDave Kleikamp  * Log buffer allocation routines:
840470decc6SDave Kleikamp  */
841470decc6SDave Kleikamp 
84218eba7aaSMingming Cao int jbd2_journal_next_log_block(journal_t *journal, unsigned long long *retp)
843470decc6SDave Kleikamp {
844470decc6SDave Kleikamp 	unsigned long blocknr;
845470decc6SDave Kleikamp 
846a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
847470decc6SDave Kleikamp 	J_ASSERT(journal->j_free > 1);
848470decc6SDave Kleikamp 
849470decc6SDave Kleikamp 	blocknr = journal->j_head;
850470decc6SDave Kleikamp 	journal->j_head++;
851470decc6SDave Kleikamp 	journal->j_free--;
852470decc6SDave Kleikamp 	if (journal->j_head == journal->j_last)
853470decc6SDave Kleikamp 		journal->j_head = journal->j_first;
854a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
855f7f4bccbSMingming Cao 	return jbd2_journal_bmap(journal, blocknr, retp);
856470decc6SDave Kleikamp }
857470decc6SDave Kleikamp 
858*ff780b91SHarshad Shirwadkar /* Map one fast commit buffer for use by the file system */
859*ff780b91SHarshad Shirwadkar int jbd2_fc_get_buf(journal_t *journal, struct buffer_head **bh_out)
860*ff780b91SHarshad Shirwadkar {
861*ff780b91SHarshad Shirwadkar 	unsigned long long pblock;
862*ff780b91SHarshad Shirwadkar 	unsigned long blocknr;
863*ff780b91SHarshad Shirwadkar 	int ret = 0;
864*ff780b91SHarshad Shirwadkar 	struct buffer_head *bh;
865*ff780b91SHarshad Shirwadkar 	int fc_off;
866*ff780b91SHarshad Shirwadkar 
867*ff780b91SHarshad Shirwadkar 	*bh_out = NULL;
868*ff780b91SHarshad Shirwadkar 	write_lock(&journal->j_state_lock);
869*ff780b91SHarshad Shirwadkar 
870*ff780b91SHarshad Shirwadkar 	if (journal->j_fc_off + journal->j_fc_first < journal->j_fc_last) {
871*ff780b91SHarshad Shirwadkar 		fc_off = journal->j_fc_off;
872*ff780b91SHarshad Shirwadkar 		blocknr = journal->j_fc_first + fc_off;
873*ff780b91SHarshad Shirwadkar 		journal->j_fc_off++;
874*ff780b91SHarshad Shirwadkar 	} else {
875*ff780b91SHarshad Shirwadkar 		ret = -EINVAL;
876*ff780b91SHarshad Shirwadkar 	}
877*ff780b91SHarshad Shirwadkar 	write_unlock(&journal->j_state_lock);
878*ff780b91SHarshad Shirwadkar 
879*ff780b91SHarshad Shirwadkar 	if (ret)
880*ff780b91SHarshad Shirwadkar 		return ret;
881*ff780b91SHarshad Shirwadkar 
882*ff780b91SHarshad Shirwadkar 	ret = jbd2_journal_bmap(journal, blocknr, &pblock);
883*ff780b91SHarshad Shirwadkar 	if (ret)
884*ff780b91SHarshad Shirwadkar 		return ret;
885*ff780b91SHarshad Shirwadkar 
886*ff780b91SHarshad Shirwadkar 	bh = __getblk(journal->j_dev, pblock, journal->j_blocksize);
887*ff780b91SHarshad Shirwadkar 	if (!bh)
888*ff780b91SHarshad Shirwadkar 		return -ENOMEM;
889*ff780b91SHarshad Shirwadkar 
890*ff780b91SHarshad Shirwadkar 	lock_buffer(bh);
891*ff780b91SHarshad Shirwadkar 
892*ff780b91SHarshad Shirwadkar 	clear_buffer_uptodate(bh);
893*ff780b91SHarshad Shirwadkar 	set_buffer_dirty(bh);
894*ff780b91SHarshad Shirwadkar 	unlock_buffer(bh);
895*ff780b91SHarshad Shirwadkar 	journal->j_fc_wbuf[fc_off] = bh;
896*ff780b91SHarshad Shirwadkar 
897*ff780b91SHarshad Shirwadkar 	*bh_out = bh;
898*ff780b91SHarshad Shirwadkar 
899*ff780b91SHarshad Shirwadkar 	return 0;
900*ff780b91SHarshad Shirwadkar }
901*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_get_buf);
902*ff780b91SHarshad Shirwadkar 
903*ff780b91SHarshad Shirwadkar /*
904*ff780b91SHarshad Shirwadkar  * Wait on fast commit buffers that were allocated by jbd2_fc_get_buf
905*ff780b91SHarshad Shirwadkar  * for completion.
906*ff780b91SHarshad Shirwadkar  */
907*ff780b91SHarshad Shirwadkar int jbd2_fc_wait_bufs(journal_t *journal, int num_blks)
908*ff780b91SHarshad Shirwadkar {
909*ff780b91SHarshad Shirwadkar 	struct buffer_head *bh;
910*ff780b91SHarshad Shirwadkar 	int i, j_fc_off;
911*ff780b91SHarshad Shirwadkar 
912*ff780b91SHarshad Shirwadkar 	read_lock(&journal->j_state_lock);
913*ff780b91SHarshad Shirwadkar 	j_fc_off = journal->j_fc_off;
914*ff780b91SHarshad Shirwadkar 	read_unlock(&journal->j_state_lock);
915*ff780b91SHarshad Shirwadkar 
916*ff780b91SHarshad Shirwadkar 	/*
917*ff780b91SHarshad Shirwadkar 	 * Wait in reverse order to minimize chances of us being woken up before
918*ff780b91SHarshad Shirwadkar 	 * all IOs have completed
919*ff780b91SHarshad Shirwadkar 	 */
920*ff780b91SHarshad Shirwadkar 	for (i = j_fc_off - 1; i >= j_fc_off - num_blks; i--) {
921*ff780b91SHarshad Shirwadkar 		bh = journal->j_fc_wbuf[i];
922*ff780b91SHarshad Shirwadkar 		wait_on_buffer(bh);
923*ff780b91SHarshad Shirwadkar 		put_bh(bh);
924*ff780b91SHarshad Shirwadkar 		journal->j_fc_wbuf[i] = NULL;
925*ff780b91SHarshad Shirwadkar 		if (unlikely(!buffer_uptodate(bh)))
926*ff780b91SHarshad Shirwadkar 			return -EIO;
927*ff780b91SHarshad Shirwadkar 	}
928*ff780b91SHarshad Shirwadkar 
929*ff780b91SHarshad Shirwadkar 	return 0;
930*ff780b91SHarshad Shirwadkar }
931*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_wait_bufs);
932*ff780b91SHarshad Shirwadkar 
933*ff780b91SHarshad Shirwadkar /*
934*ff780b91SHarshad Shirwadkar  * Wait on fast commit buffers that were allocated by jbd2_fc_get_buf
935*ff780b91SHarshad Shirwadkar  * for completion.
936*ff780b91SHarshad Shirwadkar  */
937*ff780b91SHarshad Shirwadkar int jbd2_fc_release_bufs(journal_t *journal)
938*ff780b91SHarshad Shirwadkar {
939*ff780b91SHarshad Shirwadkar 	struct buffer_head *bh;
940*ff780b91SHarshad Shirwadkar 	int i, j_fc_off;
941*ff780b91SHarshad Shirwadkar 
942*ff780b91SHarshad Shirwadkar 	read_lock(&journal->j_state_lock);
943*ff780b91SHarshad Shirwadkar 	j_fc_off = journal->j_fc_off;
944*ff780b91SHarshad Shirwadkar 	read_unlock(&journal->j_state_lock);
945*ff780b91SHarshad Shirwadkar 
946*ff780b91SHarshad Shirwadkar 	/*
947*ff780b91SHarshad Shirwadkar 	 * Wait in reverse order to minimize chances of us being woken up before
948*ff780b91SHarshad Shirwadkar 	 * all IOs have completed
949*ff780b91SHarshad Shirwadkar 	 */
950*ff780b91SHarshad Shirwadkar 	for (i = j_fc_off - 1; i >= 0; i--) {
951*ff780b91SHarshad Shirwadkar 		bh = journal->j_fc_wbuf[i];
952*ff780b91SHarshad Shirwadkar 		if (!bh)
953*ff780b91SHarshad Shirwadkar 			break;
954*ff780b91SHarshad Shirwadkar 		put_bh(bh);
955*ff780b91SHarshad Shirwadkar 		journal->j_fc_wbuf[i] = NULL;
956*ff780b91SHarshad Shirwadkar 	}
957*ff780b91SHarshad Shirwadkar 
958*ff780b91SHarshad Shirwadkar 	return 0;
959*ff780b91SHarshad Shirwadkar }
960*ff780b91SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_release_bufs);
961*ff780b91SHarshad Shirwadkar 
962470decc6SDave Kleikamp /*
963470decc6SDave Kleikamp  * Conversion of logical to physical block numbers for the journal
964470decc6SDave Kleikamp  *
965470decc6SDave Kleikamp  * On external journals the journal blocks are identity-mapped, so
966470decc6SDave Kleikamp  * this is a no-op.  If needed, we can use j_blk_offset - everything is
967470decc6SDave Kleikamp  * ready.
968470decc6SDave Kleikamp  */
969f7f4bccbSMingming Cao int jbd2_journal_bmap(journal_t *journal, unsigned long blocknr,
97018eba7aaSMingming Cao 		 unsigned long long *retp)
971470decc6SDave Kleikamp {
972470decc6SDave Kleikamp 	int err = 0;
97318eba7aaSMingming Cao 	unsigned long long ret;
97430460e1eSCarlos Maiolino 	sector_t block = 0;
975470decc6SDave Kleikamp 
976470decc6SDave Kleikamp 	if (journal->j_inode) {
97730460e1eSCarlos Maiolino 		block = blocknr;
97830460e1eSCarlos Maiolino 		ret = bmap(journal->j_inode, &block);
97930460e1eSCarlos Maiolino 
98030460e1eSCarlos Maiolino 		if (ret || !block) {
981470decc6SDave Kleikamp 			printk(KERN_ALERT "%s: journal block not found "
982470decc6SDave Kleikamp 					"at offset %lu on %s\n",
98305496769STheodore Ts'o 			       __func__, blocknr, journal->j_devname);
984470decc6SDave Kleikamp 			err = -EIO;
9857f6225e4Szhangyi (F) 			jbd2_journal_abort(journal, err);
98630460e1eSCarlos Maiolino 		} else {
98730460e1eSCarlos Maiolino 			*retp = block;
988470decc6SDave Kleikamp 		}
98930460e1eSCarlos Maiolino 
990470decc6SDave Kleikamp 	} else {
991470decc6SDave Kleikamp 		*retp = blocknr; /* +journal->j_blk_offset */
992470decc6SDave Kleikamp 	}
993470decc6SDave Kleikamp 	return err;
994470decc6SDave Kleikamp }
995470decc6SDave Kleikamp 
996470decc6SDave Kleikamp /*
997470decc6SDave Kleikamp  * We play buffer_head aliasing tricks to write data/metadata blocks to
998470decc6SDave Kleikamp  * the journal without copying their contents, but for journal
999470decc6SDave Kleikamp  * descriptor blocks we do need to generate bona fide buffers.
1000470decc6SDave Kleikamp  *
1001f7f4bccbSMingming Cao  * After the caller of jbd2_journal_get_descriptor_buffer() has finished modifying
1002470decc6SDave Kleikamp  * the buffer's contents they really should run flush_dcache_page(bh->b_page).
1003470decc6SDave Kleikamp  * But we don't bother doing that, so there will be coherency problems with
1004470decc6SDave Kleikamp  * mmaps of blockdevs which hold live JBD-controlled filesystems.
1005470decc6SDave Kleikamp  */
100632ab6715SJan Kara struct buffer_head *
100732ab6715SJan Kara jbd2_journal_get_descriptor_buffer(transaction_t *transaction, int type)
1008470decc6SDave Kleikamp {
100932ab6715SJan Kara 	journal_t *journal = transaction->t_journal;
1010470decc6SDave Kleikamp 	struct buffer_head *bh;
101118eba7aaSMingming Cao 	unsigned long long blocknr;
101232ab6715SJan Kara 	journal_header_t *header;
1013470decc6SDave Kleikamp 	int err;
1014470decc6SDave Kleikamp 
1015f7f4bccbSMingming Cao 	err = jbd2_journal_next_log_block(journal, &blocknr);
1016470decc6SDave Kleikamp 
1017470decc6SDave Kleikamp 	if (err)
1018470decc6SDave Kleikamp 		return NULL;
1019470decc6SDave Kleikamp 
1020470decc6SDave Kleikamp 	bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
10214b905671SJan Kara 	if (!bh)
10224b905671SJan Kara 		return NULL;
10239f356e5aSJan Kara 	atomic_dec(&transaction->t_outstanding_credits);
1024470decc6SDave Kleikamp 	lock_buffer(bh);
1025470decc6SDave Kleikamp 	memset(bh->b_data, 0, journal->j_blocksize);
102632ab6715SJan Kara 	header = (journal_header_t *)bh->b_data;
102732ab6715SJan Kara 	header->h_magic = cpu_to_be32(JBD2_MAGIC_NUMBER);
102832ab6715SJan Kara 	header->h_blocktype = cpu_to_be32(type);
102932ab6715SJan Kara 	header->h_sequence = cpu_to_be32(transaction->t_tid);
1030470decc6SDave Kleikamp 	set_buffer_uptodate(bh);
1031470decc6SDave Kleikamp 	unlock_buffer(bh);
1032470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "return this buffer");
1033e5a120aeSJan Kara 	return bh;
1034470decc6SDave Kleikamp }
1035470decc6SDave Kleikamp 
10361101cd4dSJan Kara void jbd2_descriptor_block_csum_set(journal_t *j, struct buffer_head *bh)
10371101cd4dSJan Kara {
10381101cd4dSJan Kara 	struct jbd2_journal_block_tail *tail;
10391101cd4dSJan Kara 	__u32 csum;
10401101cd4dSJan Kara 
10411101cd4dSJan Kara 	if (!jbd2_journal_has_csum_v2or3(j))
10421101cd4dSJan Kara 		return;
10431101cd4dSJan Kara 
10441101cd4dSJan Kara 	tail = (struct jbd2_journal_block_tail *)(bh->b_data + j->j_blocksize -
10451101cd4dSJan Kara 			sizeof(struct jbd2_journal_block_tail));
10461101cd4dSJan Kara 	tail->t_checksum = 0;
10471101cd4dSJan Kara 	csum = jbd2_chksum(j, j->j_csum_seed, bh->b_data, j->j_blocksize);
10481101cd4dSJan Kara 	tail->t_checksum = cpu_to_be32(csum);
10491101cd4dSJan Kara }
10501101cd4dSJan Kara 
105179feb521SJan Kara /*
105279feb521SJan Kara  * Return tid of the oldest transaction in the journal and block in the journal
105379feb521SJan Kara  * where the transaction starts.
105479feb521SJan Kara  *
105579feb521SJan Kara  * If the journal is now empty, return which will be the next transaction ID
105679feb521SJan Kara  * we will write and where will that transaction start.
105779feb521SJan Kara  *
105879feb521SJan Kara  * The return value is 0 if journal tail cannot be pushed any further, 1 if
105979feb521SJan Kara  * it can.
106079feb521SJan Kara  */
106179feb521SJan Kara int jbd2_journal_get_log_tail(journal_t *journal, tid_t *tid,
106279feb521SJan Kara 			      unsigned long *block)
106379feb521SJan Kara {
106479feb521SJan Kara 	transaction_t *transaction;
106579feb521SJan Kara 	int ret;
106679feb521SJan Kara 
106779feb521SJan Kara 	read_lock(&journal->j_state_lock);
106879feb521SJan Kara 	spin_lock(&journal->j_list_lock);
106979feb521SJan Kara 	transaction = journal->j_checkpoint_transactions;
107079feb521SJan Kara 	if (transaction) {
107179feb521SJan Kara 		*tid = transaction->t_tid;
107279feb521SJan Kara 		*block = transaction->t_log_start;
107379feb521SJan Kara 	} else if ((transaction = journal->j_committing_transaction) != NULL) {
107479feb521SJan Kara 		*tid = transaction->t_tid;
107579feb521SJan Kara 		*block = transaction->t_log_start;
107679feb521SJan Kara 	} else if ((transaction = journal->j_running_transaction) != NULL) {
107779feb521SJan Kara 		*tid = transaction->t_tid;
107879feb521SJan Kara 		*block = journal->j_head;
107979feb521SJan Kara 	} else {
108079feb521SJan Kara 		*tid = journal->j_transaction_sequence;
108179feb521SJan Kara 		*block = journal->j_head;
108279feb521SJan Kara 	}
108379feb521SJan Kara 	ret = tid_gt(*tid, journal->j_tail_sequence);
108479feb521SJan Kara 	spin_unlock(&journal->j_list_lock);
108579feb521SJan Kara 	read_unlock(&journal->j_state_lock);
108679feb521SJan Kara 
108779feb521SJan Kara 	return ret;
108879feb521SJan Kara }
108979feb521SJan Kara 
109079feb521SJan Kara /*
109179feb521SJan Kara  * Update information in journal structure and in on disk journal superblock
109279feb521SJan Kara  * about log tail. This function does not check whether information passed in
109379feb521SJan Kara  * really pushes log tail further. It's responsibility of the caller to make
109479feb521SJan Kara  * sure provided log tail information is valid (e.g. by holding
109579feb521SJan Kara  * j_checkpoint_mutex all the time between computing log tail and calling this
109679feb521SJan Kara  * function as is the case with jbd2_cleanup_journal_tail()).
109779feb521SJan Kara  *
109879feb521SJan Kara  * Requires j_checkpoint_mutex
109979feb521SJan Kara  */
11006f6a6fdaSJoseph Qi int __jbd2_update_log_tail(journal_t *journal, tid_t tid, unsigned long block)
110179feb521SJan Kara {
110279feb521SJan Kara 	unsigned long freed;
11036f6a6fdaSJoseph Qi 	int ret;
110479feb521SJan Kara 
110579feb521SJan Kara 	BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
110679feb521SJan Kara 
110779feb521SJan Kara 	/*
110879feb521SJan Kara 	 * We cannot afford for write to remain in drive's caches since as
110979feb521SJan Kara 	 * soon as we update j_tail, next transaction can start reusing journal
111079feb521SJan Kara 	 * space and if we lose sb update during power failure we'd replay
111179feb521SJan Kara 	 * old transaction with possibly newly overwritten data.
111279feb521SJan Kara 	 */
111317f423b5SJan Kara 	ret = jbd2_journal_update_sb_log_tail(journal, tid, block,
111417f423b5SJan Kara 					      REQ_SYNC | REQ_FUA);
11156f6a6fdaSJoseph Qi 	if (ret)
11166f6a6fdaSJoseph Qi 		goto out;
11176f6a6fdaSJoseph Qi 
111879feb521SJan Kara 	write_lock(&journal->j_state_lock);
111979feb521SJan Kara 	freed = block - journal->j_tail;
112079feb521SJan Kara 	if (block < journal->j_tail)
112179feb521SJan Kara 		freed += journal->j_last - journal->j_first;
112279feb521SJan Kara 
112379feb521SJan Kara 	trace_jbd2_update_log_tail(journal, tid, block, freed);
112479feb521SJan Kara 	jbd_debug(1,
11257821ce41SGaowei Pu 		  "Cleaning journal tail from %u to %u (offset %lu), "
112679feb521SJan Kara 		  "freeing %lu\n",
112779feb521SJan Kara 		  journal->j_tail_sequence, tid, block, freed);
112879feb521SJan Kara 
112979feb521SJan Kara 	journal->j_free += freed;
113079feb521SJan Kara 	journal->j_tail_sequence = tid;
113179feb521SJan Kara 	journal->j_tail = block;
113279feb521SJan Kara 	write_unlock(&journal->j_state_lock);
11336f6a6fdaSJoseph Qi 
11346f6a6fdaSJoseph Qi out:
11356f6a6fdaSJoseph Qi 	return ret;
113679feb521SJan Kara }
113779feb521SJan Kara 
11383339578fSJan Kara /*
113985e0c4e8STheodore Ts'o  * This is a variation of __jbd2_update_log_tail which checks for validity of
11403339578fSJan Kara  * provided log tail and locks j_checkpoint_mutex. So it is safe against races
11413339578fSJan Kara  * with other threads updating log tail.
11423339578fSJan Kara  */
11433339578fSJan Kara void jbd2_update_log_tail(journal_t *journal, tid_t tid, unsigned long block)
11443339578fSJan Kara {
11456fa7aa50STejun Heo 	mutex_lock_io(&journal->j_checkpoint_mutex);
11463339578fSJan Kara 	if (tid_gt(tid, journal->j_tail_sequence))
11473339578fSJan Kara 		__jbd2_update_log_tail(journal, tid, block);
11483339578fSJan Kara 	mutex_unlock(&journal->j_checkpoint_mutex);
11493339578fSJan Kara }
11503339578fSJan Kara 
11518e85fb3fSJohann Lombardi struct jbd2_stats_proc_session {
11528e85fb3fSJohann Lombardi 	journal_t *journal;
11538e85fb3fSJohann Lombardi 	struct transaction_stats_s *stats;
11548e85fb3fSJohann Lombardi 	int start;
11558e85fb3fSJohann Lombardi 	int max;
11568e85fb3fSJohann Lombardi };
11578e85fb3fSJohann Lombardi 
11588e85fb3fSJohann Lombardi static void *jbd2_seq_info_start(struct seq_file *seq, loff_t *pos)
11598e85fb3fSJohann Lombardi {
11608e85fb3fSJohann Lombardi 	return *pos ? NULL : SEQ_START_TOKEN;
11618e85fb3fSJohann Lombardi }
11628e85fb3fSJohann Lombardi 
11638e85fb3fSJohann Lombardi static void *jbd2_seq_info_next(struct seq_file *seq, void *v, loff_t *pos)
11648e85fb3fSJohann Lombardi {
11651a8e9cf4SVasily Averin 	(*pos)++;
11668e85fb3fSJohann Lombardi 	return NULL;
11678e85fb3fSJohann Lombardi }
11688e85fb3fSJohann Lombardi 
11698e85fb3fSJohann Lombardi static int jbd2_seq_info_show(struct seq_file *seq, void *v)
11708e85fb3fSJohann Lombardi {
11718e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
11728e85fb3fSJohann Lombardi 
11738e85fb3fSJohann Lombardi 	if (v != SEQ_START_TOKEN)
11748e85fb3fSJohann Lombardi 		return 0;
11759fff24aaSTheodore Ts'o 	seq_printf(seq, "%lu transactions (%lu requested), "
11769fff24aaSTheodore Ts'o 		   "each up to %u blocks\n",
11779fff24aaSTheodore Ts'o 		   s->stats->ts_tid, s->stats->ts_requested,
11788e85fb3fSJohann Lombardi 		   s->journal->j_max_transaction_buffers);
11798e85fb3fSJohann Lombardi 	if (s->stats->ts_tid == 0)
11808e85fb3fSJohann Lombardi 		return 0;
11818e85fb3fSJohann Lombardi 	seq_printf(seq, "average: \n  %ums waiting for transaction\n",
1182bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_wait / s->stats->ts_tid));
11839fff24aaSTheodore Ts'o 	seq_printf(seq, "  %ums request delay\n",
11849fff24aaSTheodore Ts'o 	    (s->stats->ts_requested == 0) ? 0 :
11859fff24aaSTheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_request_delay /
11869fff24aaSTheodore Ts'o 			     s->stats->ts_requested));
11878e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums running transaction\n",
1188bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_running / s->stats->ts_tid));
11898e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums transaction was being locked\n",
1190bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_locked / s->stats->ts_tid));
11918e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums flushing data (in ordered mode)\n",
1192bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_flushing / s->stats->ts_tid));
11938e85fb3fSJohann Lombardi 	seq_printf(seq, "  %ums logging transaction\n",
1194bf699327STheodore Ts'o 	    jiffies_to_msecs(s->stats->run.rs_logging / s->stats->ts_tid));
1195c225aa57SSimon Holm Thøgersen 	seq_printf(seq, "  %lluus average transaction commit time\n",
1196c225aa57SSimon Holm Thøgersen 		   div_u64(s->journal->j_average_commit_time, 1000));
11978e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu handles per transaction\n",
1198bf699327STheodore Ts'o 	    s->stats->run.rs_handle_count / s->stats->ts_tid);
11998e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu blocks per transaction\n",
1200bf699327STheodore Ts'o 	    s->stats->run.rs_blocks / s->stats->ts_tid);
12018e85fb3fSJohann Lombardi 	seq_printf(seq, "  %lu logged blocks per transaction\n",
1202bf699327STheodore Ts'o 	    s->stats->run.rs_blocks_logged / s->stats->ts_tid);
12038e85fb3fSJohann Lombardi 	return 0;
12048e85fb3fSJohann Lombardi }
12058e85fb3fSJohann Lombardi 
12068e85fb3fSJohann Lombardi static void jbd2_seq_info_stop(struct seq_file *seq, void *v)
12078e85fb3fSJohann Lombardi {
12088e85fb3fSJohann Lombardi }
12098e85fb3fSJohann Lombardi 
121088e9d34cSJames Morris static const struct seq_operations jbd2_seq_info_ops = {
12118e85fb3fSJohann Lombardi 	.start  = jbd2_seq_info_start,
12128e85fb3fSJohann Lombardi 	.next   = jbd2_seq_info_next,
12138e85fb3fSJohann Lombardi 	.stop   = jbd2_seq_info_stop,
12148e85fb3fSJohann Lombardi 	.show   = jbd2_seq_info_show,
12158e85fb3fSJohann Lombardi };
12168e85fb3fSJohann Lombardi 
12178e85fb3fSJohann Lombardi static int jbd2_seq_info_open(struct inode *inode, struct file *file)
12188e85fb3fSJohann Lombardi {
1219d9dda78bSAl Viro 	journal_t *journal = PDE_DATA(inode);
12208e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s;
12218e85fb3fSJohann Lombardi 	int rc, size;
12228e85fb3fSJohann Lombardi 
12238e85fb3fSJohann Lombardi 	s = kmalloc(sizeof(*s), GFP_KERNEL);
12248e85fb3fSJohann Lombardi 	if (s == NULL)
12258e85fb3fSJohann Lombardi 		return -ENOMEM;
12268e85fb3fSJohann Lombardi 	size = sizeof(struct transaction_stats_s);
12278e85fb3fSJohann Lombardi 	s->stats = kmalloc(size, GFP_KERNEL);
12288e85fb3fSJohann Lombardi 	if (s->stats == NULL) {
12298e85fb3fSJohann Lombardi 		kfree(s);
12308e85fb3fSJohann Lombardi 		return -ENOMEM;
12318e85fb3fSJohann Lombardi 	}
12328e85fb3fSJohann Lombardi 	spin_lock(&journal->j_history_lock);
12338e85fb3fSJohann Lombardi 	memcpy(s->stats, &journal->j_stats, size);
12348e85fb3fSJohann Lombardi 	s->journal = journal;
12358e85fb3fSJohann Lombardi 	spin_unlock(&journal->j_history_lock);
12368e85fb3fSJohann Lombardi 
12378e85fb3fSJohann Lombardi 	rc = seq_open(file, &jbd2_seq_info_ops);
12388e85fb3fSJohann Lombardi 	if (rc == 0) {
12398e85fb3fSJohann Lombardi 		struct seq_file *m = file->private_data;
12408e85fb3fSJohann Lombardi 		m->private = s;
12418e85fb3fSJohann Lombardi 	} else {
12428e85fb3fSJohann Lombardi 		kfree(s->stats);
12438e85fb3fSJohann Lombardi 		kfree(s);
12448e85fb3fSJohann Lombardi 	}
12458e85fb3fSJohann Lombardi 	return rc;
12468e85fb3fSJohann Lombardi 
12478e85fb3fSJohann Lombardi }
12488e85fb3fSJohann Lombardi 
12498e85fb3fSJohann Lombardi static int jbd2_seq_info_release(struct inode *inode, struct file *file)
12508e85fb3fSJohann Lombardi {
12518e85fb3fSJohann Lombardi 	struct seq_file *seq = file->private_data;
12528e85fb3fSJohann Lombardi 	struct jbd2_stats_proc_session *s = seq->private;
12538e85fb3fSJohann Lombardi 	kfree(s->stats);
12548e85fb3fSJohann Lombardi 	kfree(s);
12558e85fb3fSJohann Lombardi 	return seq_release(inode, file);
12568e85fb3fSJohann Lombardi }
12578e85fb3fSJohann Lombardi 
125897a32539SAlexey Dobriyan static const struct proc_ops jbd2_info_proc_ops = {
125997a32539SAlexey Dobriyan 	.proc_open	= jbd2_seq_info_open,
126097a32539SAlexey Dobriyan 	.proc_read	= seq_read,
126197a32539SAlexey Dobriyan 	.proc_lseek	= seq_lseek,
126297a32539SAlexey Dobriyan 	.proc_release	= jbd2_seq_info_release,
12638e85fb3fSJohann Lombardi };
12648e85fb3fSJohann Lombardi 
12658e85fb3fSJohann Lombardi static struct proc_dir_entry *proc_jbd2_stats;
12668e85fb3fSJohann Lombardi 
12678e85fb3fSJohann Lombardi static void jbd2_stats_proc_init(journal_t *journal)
12688e85fb3fSJohann Lombardi {
126905496769STheodore Ts'o 	journal->j_proc_entry = proc_mkdir(journal->j_devname, proc_jbd2_stats);
12708e85fb3fSJohann Lombardi 	if (journal->j_proc_entry) {
127179da3664SDenis V. Lunev 		proc_create_data("info", S_IRUGO, journal->j_proc_entry,
127297a32539SAlexey Dobriyan 				 &jbd2_info_proc_ops, journal);
12738e85fb3fSJohann Lombardi 	}
12748e85fb3fSJohann Lombardi }
12758e85fb3fSJohann Lombardi 
12768e85fb3fSJohann Lombardi static void jbd2_stats_proc_exit(journal_t *journal)
12778e85fb3fSJohann Lombardi {
12788e85fb3fSJohann Lombardi 	remove_proc_entry("info", journal->j_proc_entry);
127905496769STheodore Ts'o 	remove_proc_entry(journal->j_devname, proc_jbd2_stats);
12808e85fb3fSJohann Lombardi }
12818e85fb3fSJohann Lombardi 
1282b90bfdf5SJan Kara /* Minimum size of descriptor tag */
1283b90bfdf5SJan Kara static int jbd2_min_tag_size(void)
1284b90bfdf5SJan Kara {
1285b90bfdf5SJan Kara 	/*
1286b90bfdf5SJan Kara 	 * Tag with 32-bit block numbers does not use last four bytes of the
1287b90bfdf5SJan Kara 	 * structure
1288b90bfdf5SJan Kara 	 */
1289b90bfdf5SJan Kara 	return sizeof(journal_block_tag_t) - 4;
1290b90bfdf5SJan Kara }
1291b90bfdf5SJan Kara 
1292470decc6SDave Kleikamp /*
1293470decc6SDave Kleikamp  * Management for journal control blocks: functions to create and
1294470decc6SDave Kleikamp  * destroy journal_t structures, and to initialise and read existing
1295470decc6SDave Kleikamp  * journal blocks from disk.  */
1296470decc6SDave Kleikamp 
1297470decc6SDave Kleikamp /* First: create and setup a journal_t object in memory.  We initialise
1298470decc6SDave Kleikamp  * very few fields yet: that has to wait until we have created the
1299470decc6SDave Kleikamp  * journal structures from from scratch, or loaded them from disk. */
1300470decc6SDave Kleikamp 
1301f0c9fd54SGeliang Tang static journal_t *journal_init_common(struct block_device *bdev,
1302f0c9fd54SGeliang Tang 			struct block_device *fs_dev,
1303f0c9fd54SGeliang Tang 			unsigned long long start, int len, int blocksize)
1304470decc6SDave Kleikamp {
1305ab714affSJan Kara 	static struct lock_class_key jbd2_trans_commit_key;
1306470decc6SDave Kleikamp 	journal_t *journal;
1307470decc6SDave Kleikamp 	int err;
1308f0c9fd54SGeliang Tang 	struct buffer_head *bh;
1309f0c9fd54SGeliang Tang 	int n;
1310470decc6SDave Kleikamp 
13113ebfdf88SAndrew Morton 	journal = kzalloc(sizeof(*journal), GFP_KERNEL);
1312470decc6SDave Kleikamp 	if (!journal)
1313b7271b0aSTheodore Ts'o 		return NULL;
1314470decc6SDave Kleikamp 
1315470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_transaction_locked);
1316470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_done_commit);
1317470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_commit);
1318470decc6SDave Kleikamp 	init_waitqueue_head(&journal->j_wait_updates);
13198f7d89f3SJan Kara 	init_waitqueue_head(&journal->j_wait_reserved);
1320*ff780b91SHarshad Shirwadkar 	init_waitqueue_head(&journal->j_fc_wait);
13217b97d868Szhangyi (F) 	mutex_init(&journal->j_abort_mutex);
1322470decc6SDave Kleikamp 	mutex_init(&journal->j_barrier);
1323470decc6SDave Kleikamp 	mutex_init(&journal->j_checkpoint_mutex);
1324470decc6SDave Kleikamp 	spin_lock_init(&journal->j_revoke_lock);
1325470decc6SDave Kleikamp 	spin_lock_init(&journal->j_list_lock);
1326a931da6aSTheodore Ts'o 	rwlock_init(&journal->j_state_lock);
1327470decc6SDave Kleikamp 
1328cd02ff0bSMingming Cao 	journal->j_commit_interval = (HZ * JBD2_DEFAULT_MAX_COMMIT_AGE);
132930773840STheodore Ts'o 	journal->j_min_batch_time = 0;
133030773840STheodore Ts'o 	journal->j_max_batch_time = 15000; /* 15ms */
13318f7d89f3SJan Kara 	atomic_set(&journal->j_reserved_credits, 0);
1332470decc6SDave Kleikamp 
1333470decc6SDave Kleikamp 	/* The journal is marked for error until we succeed with recovery! */
1334f7f4bccbSMingming Cao 	journal->j_flags = JBD2_ABORT;
1335470decc6SDave Kleikamp 
1336470decc6SDave Kleikamp 	/* Set up a default-sized revoke table for the new mount. */
1337f7f4bccbSMingming Cao 	err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
1338cd9cb405SEric Biggers 	if (err)
1339cd9cb405SEric Biggers 		goto err_cleanup;
13408e85fb3fSJohann Lombardi 
1341bf699327STheodore Ts'o 	spin_lock_init(&journal->j_history_lock);
13428e85fb3fSJohann Lombardi 
1343ab714affSJan Kara 	lockdep_init_map(&journal->j_trans_commit_map, "jbd2_handle",
1344ab714affSJan Kara 			 &jbd2_trans_commit_key, 0);
1345ab714affSJan Kara 
1346f0c9fd54SGeliang Tang 	/* journal descriptor can store up to n blocks -bzzz */
1347f0c9fd54SGeliang Tang 	journal->j_blocksize = blocksize;
1348f0c9fd54SGeliang Tang 	journal->j_dev = bdev;
1349f0c9fd54SGeliang Tang 	journal->j_fs_dev = fs_dev;
1350f0c9fd54SGeliang Tang 	journal->j_blk_offset = start;
1351f0c9fd54SGeliang Tang 	journal->j_maxlen = len;
1352b90bfdf5SJan Kara 	/* We need enough buffers to write out full descriptor block. */
1353b90bfdf5SJan Kara 	n = journal->j_blocksize / jbd2_min_tag_size();
1354f0c9fd54SGeliang Tang 	journal->j_wbufsize = n;
1355f0c9fd54SGeliang Tang 	journal->j_wbuf = kmalloc_array(n, sizeof(struct buffer_head *),
1356f0c9fd54SGeliang Tang 					GFP_KERNEL);
1357cd9cb405SEric Biggers 	if (!journal->j_wbuf)
1358cd9cb405SEric Biggers 		goto err_cleanup;
1359f0c9fd54SGeliang Tang 
13606866d7b3SHarshad Shirwadkar 	if (journal->j_fc_wbufsize > 0) {
13616866d7b3SHarshad Shirwadkar 		journal->j_fc_wbuf = kmalloc_array(journal->j_fc_wbufsize,
13626866d7b3SHarshad Shirwadkar 					sizeof(struct buffer_head *),
13636866d7b3SHarshad Shirwadkar 					GFP_KERNEL);
13646866d7b3SHarshad Shirwadkar 		if (!journal->j_fc_wbuf)
13656866d7b3SHarshad Shirwadkar 			goto err_cleanup;
13666866d7b3SHarshad Shirwadkar 	}
13676866d7b3SHarshad Shirwadkar 
1368f0c9fd54SGeliang Tang 	bh = getblk_unmovable(journal->j_dev, start, journal->j_blocksize);
1369f0c9fd54SGeliang Tang 	if (!bh) {
1370f0c9fd54SGeliang Tang 		pr_err("%s: Cannot get buffer for journal superblock\n",
1371f0c9fd54SGeliang Tang 			__func__);
1372cd9cb405SEric Biggers 		goto err_cleanup;
1373f0c9fd54SGeliang Tang 	}
1374f0c9fd54SGeliang Tang 	journal->j_sb_buffer = bh;
1375f0c9fd54SGeliang Tang 	journal->j_superblock = (journal_superblock_t *)bh->b_data;
1376f0c9fd54SGeliang Tang 
1377470decc6SDave Kleikamp 	return journal;
1378cd9cb405SEric Biggers 
1379cd9cb405SEric Biggers err_cleanup:
1380cd9cb405SEric Biggers 	kfree(journal->j_wbuf);
13816866d7b3SHarshad Shirwadkar 	kfree(journal->j_fc_wbuf);
1382cd9cb405SEric Biggers 	jbd2_journal_destroy_revoke(journal);
1383cd9cb405SEric Biggers 	kfree(journal);
1384cd9cb405SEric Biggers 	return NULL;
1385470decc6SDave Kleikamp }
1386470decc6SDave Kleikamp 
13876866d7b3SHarshad Shirwadkar int jbd2_fc_init(journal_t *journal, int num_fc_blks)
13886866d7b3SHarshad Shirwadkar {
13896866d7b3SHarshad Shirwadkar 	journal->j_fc_wbufsize = num_fc_blks;
13906866d7b3SHarshad Shirwadkar 	journal->j_fc_wbuf = kmalloc_array(journal->j_fc_wbufsize,
13916866d7b3SHarshad Shirwadkar 				sizeof(struct buffer_head *), GFP_KERNEL);
13926866d7b3SHarshad Shirwadkar 	if (!journal->j_fc_wbuf)
13936866d7b3SHarshad Shirwadkar 		return -ENOMEM;
13946866d7b3SHarshad Shirwadkar 	return 0;
13956866d7b3SHarshad Shirwadkar }
13966866d7b3SHarshad Shirwadkar EXPORT_SYMBOL(jbd2_fc_init);
13976866d7b3SHarshad Shirwadkar 
1398f7f4bccbSMingming Cao /* jbd2_journal_init_dev and jbd2_journal_init_inode:
1399470decc6SDave Kleikamp  *
1400470decc6SDave Kleikamp  * Create a journal structure assigned some fixed set of disk blocks to
1401470decc6SDave Kleikamp  * the journal.  We don't actually touch those disk blocks yet, but we
1402470decc6SDave Kleikamp  * need to set up all of the mapping information to tell the journaling
1403470decc6SDave Kleikamp  * system where the journal blocks are.
1404470decc6SDave Kleikamp  *
1405470decc6SDave Kleikamp  */
1406470decc6SDave Kleikamp 
1407470decc6SDave Kleikamp /**
14085648ba5bSRandy Dunlap  *  journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure
1409470decc6SDave Kleikamp  *  @bdev: Block device on which to create the journal
1410470decc6SDave Kleikamp  *  @fs_dev: Device which hold journalled filesystem for this journal.
1411470decc6SDave Kleikamp  *  @start: Block nr Start of journal.
1412470decc6SDave Kleikamp  *  @len:  Length of the journal in blocks.
1413470decc6SDave Kleikamp  *  @blocksize: blocksize of journalling device
14145648ba5bSRandy Dunlap  *
14155648ba5bSRandy Dunlap  *  Returns: a newly created journal_t *
1416470decc6SDave Kleikamp  *
1417f7f4bccbSMingming Cao  *  jbd2_journal_init_dev creates a journal which maps a fixed contiguous
1418470decc6SDave Kleikamp  *  range of blocks on an arbitrary block device.
1419470decc6SDave Kleikamp  *
1420470decc6SDave Kleikamp  */
1421f7f4bccbSMingming Cao journal_t *jbd2_journal_init_dev(struct block_device *bdev,
1422470decc6SDave Kleikamp 			struct block_device *fs_dev,
142318eba7aaSMingming Cao 			unsigned long long start, int len, int blocksize)
1424470decc6SDave Kleikamp {
1425f0c9fd54SGeliang Tang 	journal_t *journal;
1426470decc6SDave Kleikamp 
1427f0c9fd54SGeliang Tang 	journal = journal_init_common(bdev, fs_dev, start, len, blocksize);
1428470decc6SDave Kleikamp 	if (!journal)
1429470decc6SDave Kleikamp 		return NULL;
1430470decc6SDave Kleikamp 
14310587aa3dSyangsheng 	bdevname(journal->j_dev, journal->j_devname);
143281ae394bSRasmus Villemoes 	strreplace(journal->j_devname, '/', '!');
14334b905671SJan Kara 	jbd2_stats_proc_init(journal);
14344b905671SJan Kara 
1435470decc6SDave Kleikamp 	return journal;
1436470decc6SDave Kleikamp }
1437470decc6SDave Kleikamp 
1438470decc6SDave Kleikamp /**
1439f7f4bccbSMingming Cao  *  journal_t * jbd2_journal_init_inode () - creates a journal which maps to a inode.
1440470decc6SDave Kleikamp  *  @inode: An inode to create the journal in
1441470decc6SDave Kleikamp  *
1442f7f4bccbSMingming Cao  * jbd2_journal_init_inode creates a journal which maps an on-disk inode as
1443470decc6SDave Kleikamp  * the journal.  The inode must exist already, must support bmap() and
1444470decc6SDave Kleikamp  * must have all data blocks preallocated.
1445470decc6SDave Kleikamp  */
1446f7f4bccbSMingming Cao journal_t *jbd2_journal_init_inode(struct inode *inode)
1447470decc6SDave Kleikamp {
1448f0c9fd54SGeliang Tang 	journal_t *journal;
144930460e1eSCarlos Maiolino 	sector_t blocknr;
145005496769STheodore Ts'o 	char *p;
145130460e1eSCarlos Maiolino 	int err = 0;
1452470decc6SDave Kleikamp 
145330460e1eSCarlos Maiolino 	blocknr = 0;
145430460e1eSCarlos Maiolino 	err = bmap(inode, &blocknr);
145530460e1eSCarlos Maiolino 
145630460e1eSCarlos Maiolino 	if (err || !blocknr) {
1457f0c9fd54SGeliang Tang 		pr_err("%s: Cannot locate journal superblock\n",
1458f0c9fd54SGeliang Tang 			__func__);
1459f0c9fd54SGeliang Tang 		return NULL;
1460f0c9fd54SGeliang Tang 	}
1461f0c9fd54SGeliang Tang 
1462f0c9fd54SGeliang Tang 	jbd_debug(1, "JBD2: inode %s/%ld, size %lld, bits %d, blksize %ld\n",
1463f0c9fd54SGeliang Tang 		  inode->i_sb->s_id, inode->i_ino, (long long) inode->i_size,
1464f0c9fd54SGeliang Tang 		  inode->i_sb->s_blocksize_bits, inode->i_sb->s_blocksize);
1465f0c9fd54SGeliang Tang 
1466f0c9fd54SGeliang Tang 	journal = journal_init_common(inode->i_sb->s_bdev, inode->i_sb->s_bdev,
1467f0c9fd54SGeliang Tang 			blocknr, inode->i_size >> inode->i_sb->s_blocksize_bits,
1468f0c9fd54SGeliang Tang 			inode->i_sb->s_blocksize);
1469470decc6SDave Kleikamp 	if (!journal)
1470470decc6SDave Kleikamp 		return NULL;
1471470decc6SDave Kleikamp 
1472470decc6SDave Kleikamp 	journal->j_inode = inode;
147305496769STheodore Ts'o 	bdevname(journal->j_dev, journal->j_devname);
147481ae394bSRasmus Villemoes 	p = strreplace(journal->j_devname, '/', '!');
147590576c0bSTheodore Ts'o 	sprintf(p, "-%lu", journal->j_inode->i_ino);
14768e85fb3fSJohann Lombardi 	jbd2_stats_proc_init(journal);
1477470decc6SDave Kleikamp 
1478470decc6SDave Kleikamp 	return journal;
1479470decc6SDave Kleikamp }
1480470decc6SDave Kleikamp 
1481470decc6SDave Kleikamp /*
1482470decc6SDave Kleikamp  * If the journal init or create aborts, we need to mark the journal
1483470decc6SDave Kleikamp  * superblock as being NULL to prevent the journal destroy from writing
1484470decc6SDave Kleikamp  * back a bogus superblock.
1485470decc6SDave Kleikamp  */
1486470decc6SDave Kleikamp static void journal_fail_superblock(journal_t *journal)
1487470decc6SDave Kleikamp {
1488470decc6SDave Kleikamp 	struct buffer_head *bh = journal->j_sb_buffer;
1489470decc6SDave Kleikamp 	brelse(bh);
1490470decc6SDave Kleikamp 	journal->j_sb_buffer = NULL;
1491470decc6SDave Kleikamp }
1492470decc6SDave Kleikamp 
1493470decc6SDave Kleikamp /*
1494470decc6SDave Kleikamp  * Given a journal_t structure, initialise the various fields for
1495470decc6SDave Kleikamp  * startup of a new journaling session.  We use this both when creating
1496470decc6SDave Kleikamp  * a journal, and after recovering an old journal to reset it for
1497470decc6SDave Kleikamp  * subsequent use.
1498470decc6SDave Kleikamp  */
1499470decc6SDave Kleikamp 
1500470decc6SDave Kleikamp static int journal_reset(journal_t *journal)
1501470decc6SDave Kleikamp {
1502470decc6SDave Kleikamp 	journal_superblock_t *sb = journal->j_superblock;
150318eba7aaSMingming Cao 	unsigned long long first, last;
1504470decc6SDave Kleikamp 
1505470decc6SDave Kleikamp 	first = be32_to_cpu(sb->s_first);
1506470decc6SDave Kleikamp 	last = be32_to_cpu(sb->s_maxlen);
1507f6f50e28SJan Kara 	if (first + JBD2_MIN_JOURNAL_BLOCKS > last + 1) {
1508f2a44523SEryu Guan 		printk(KERN_ERR "JBD2: Journal too short (blocks %llu-%llu).\n",
1509f6f50e28SJan Kara 		       first, last);
1510f6f50e28SJan Kara 		journal_fail_superblock(journal);
1511f6f50e28SJan Kara 		return -EINVAL;
1512f6f50e28SJan Kara 	}
1513470decc6SDave Kleikamp 
1514470decc6SDave Kleikamp 	journal->j_first = first;
1515470decc6SDave Kleikamp 
15166866d7b3SHarshad Shirwadkar 	if (jbd2_has_feature_fast_commit(journal) &&
15176866d7b3SHarshad Shirwadkar 	    journal->j_fc_wbufsize > 0) {
15186866d7b3SHarshad Shirwadkar 		journal->j_fc_last = last;
15196866d7b3SHarshad Shirwadkar 		journal->j_last = last - journal->j_fc_wbufsize;
15206866d7b3SHarshad Shirwadkar 		journal->j_fc_first = journal->j_last + 1;
15216866d7b3SHarshad Shirwadkar 		journal->j_fc_off = 0;
15226866d7b3SHarshad Shirwadkar 	} else {
15236866d7b3SHarshad Shirwadkar 		journal->j_last = last;
15246866d7b3SHarshad Shirwadkar 	}
15256866d7b3SHarshad Shirwadkar 
15266866d7b3SHarshad Shirwadkar 	journal->j_head = journal->j_first;
15276866d7b3SHarshad Shirwadkar 	journal->j_tail = journal->j_first;
15286866d7b3SHarshad Shirwadkar 	journal->j_free = journal->j_last - journal->j_first;
1529470decc6SDave Kleikamp 
1530470decc6SDave Kleikamp 	journal->j_tail_sequence = journal->j_transaction_sequence;
1531470decc6SDave Kleikamp 	journal->j_commit_sequence = journal->j_transaction_sequence - 1;
1532470decc6SDave Kleikamp 	journal->j_commit_request = journal->j_commit_sequence;
1533470decc6SDave Kleikamp 
1534470decc6SDave Kleikamp 	journal->j_max_transaction_buffers = journal->j_maxlen / 4;
1535470decc6SDave Kleikamp 
1536470decc6SDave Kleikamp 	/*
1537470decc6SDave Kleikamp 	 * As a special case, if the on-disk copy is already marked as needing
153824bcc89cSJan Kara 	 * no recovery (s_start == 0), then we can safely defer the superblock
153924bcc89cSJan Kara 	 * update until the next commit by setting JBD2_FLUSHED.  This avoids
1540470decc6SDave Kleikamp 	 * attempting a write to a potential-readonly device.
1541470decc6SDave Kleikamp 	 */
154224bcc89cSJan Kara 	if (sb->s_start == 0) {
1543f2a44523SEryu Guan 		jbd_debug(1, "JBD2: Skipping superblock update on recovered sb "
15447821ce41SGaowei Pu 			"(start %ld, seq %u, errno %d)\n",
1545470decc6SDave Kleikamp 			journal->j_tail, journal->j_tail_sequence,
1546470decc6SDave Kleikamp 			journal->j_errno);
154724bcc89cSJan Kara 		journal->j_flags |= JBD2_FLUSHED;
154824bcc89cSJan Kara 	} else {
1549a78bb11dSJan Kara 		/* Lock here to make assertions happy... */
15506fa7aa50STejun Heo 		mutex_lock_io(&journal->j_checkpoint_mutex);
155179feb521SJan Kara 		/*
155270fd7614SChristoph Hellwig 		 * Update log tail information. We use REQ_FUA since new
155379feb521SJan Kara 		 * transaction will start reusing journal space and so we
155479feb521SJan Kara 		 * must make sure information about current log tail is on
155579feb521SJan Kara 		 * disk before that.
155679feb521SJan Kara 		 */
155779feb521SJan Kara 		jbd2_journal_update_sb_log_tail(journal,
155879feb521SJan Kara 						journal->j_tail_sequence,
155979feb521SJan Kara 						journal->j_tail,
156017f423b5SJan Kara 						REQ_SYNC | REQ_FUA);
1561a78bb11dSJan Kara 		mutex_unlock(&journal->j_checkpoint_mutex);
156224bcc89cSJan Kara 	}
156324bcc89cSJan Kara 	return jbd2_journal_start_thread(journal);
1564470decc6SDave Kleikamp }
1565470decc6SDave Kleikamp 
1566538bcaa6STheodore Ts'o /*
1567538bcaa6STheodore Ts'o  * This function expects that the caller will have locked the journal
1568538bcaa6STheodore Ts'o  * buffer head, and will return with it unlocked
1569538bcaa6STheodore Ts'o  */
15702a222ca9SMike Christie static int jbd2_write_superblock(journal_t *journal, int write_flags)
157124bcc89cSJan Kara {
157224bcc89cSJan Kara 	struct buffer_head *bh = journal->j_sb_buffer;
1573fe52d17cSTheodore Ts'o 	journal_superblock_t *sb = journal->j_superblock;
157479feb521SJan Kara 	int ret;
157524bcc89cSJan Kara 
1576742b06b5SJiufei Xue 	/* Buffer got discarded which means block device got invalidated */
1577ef3f5830Szhangyi (F) 	if (!buffer_mapped(bh)) {
1578ef3f5830Szhangyi (F) 		unlock_buffer(bh);
1579742b06b5SJiufei Xue 		return -EIO;
1580ef3f5830Szhangyi (F) 	}
1581742b06b5SJiufei Xue 
15822a222ca9SMike Christie 	trace_jbd2_write_superblock(journal, write_flags);
158379feb521SJan Kara 	if (!(journal->j_flags & JBD2_BARRIER))
158428a8f0d3SMike Christie 		write_flags &= ~(REQ_FUA | REQ_PREFLUSH);
1585914258bfSTheodore Ts'o 	if (buffer_write_io_error(bh)) {
1586914258bfSTheodore Ts'o 		/*
1587914258bfSTheodore Ts'o 		 * Oh, dear.  A previous attempt to write the journal
1588914258bfSTheodore Ts'o 		 * superblock failed.  This could happen because the
1589914258bfSTheodore Ts'o 		 * USB device was yanked out.  Or it could happen to
1590914258bfSTheodore Ts'o 		 * be a transient write error and maybe the block will
1591914258bfSTheodore Ts'o 		 * be remapped.  Nothing we can do but to retry the
1592914258bfSTheodore Ts'o 		 * write and hope for the best.
1593914258bfSTheodore Ts'o 		 */
1594914258bfSTheodore Ts'o 		printk(KERN_ERR "JBD2: previous I/O error detected "
1595914258bfSTheodore Ts'o 		       "for journal superblock update for %s.\n",
1596914258bfSTheodore Ts'o 		       journal->j_devname);
1597914258bfSTheodore Ts'o 		clear_buffer_write_io_error(bh);
1598914258bfSTheodore Ts'o 		set_buffer_uptodate(bh);
1599914258bfSTheodore Ts'o 	}
1600a58ca992STheodore Ts'o 	if (jbd2_journal_has_csum_v2or3(journal))
1601a58ca992STheodore Ts'o 		sb->s_checksum = jbd2_superblock_csum(journal, sb);
160279feb521SJan Kara 	get_bh(bh);
160379feb521SJan Kara 	bh->b_end_io = end_buffer_write_sync;
16042a222ca9SMike Christie 	ret = submit_bh(REQ_OP_WRITE, write_flags, bh);
160579feb521SJan Kara 	wait_on_buffer(bh);
1606914258bfSTheodore Ts'o 	if (buffer_write_io_error(bh)) {
1607914258bfSTheodore Ts'o 		clear_buffer_write_io_error(bh);
1608914258bfSTheodore Ts'o 		set_buffer_uptodate(bh);
160979feb521SJan Kara 		ret = -EIO;
161079feb521SJan Kara 	}
161179feb521SJan Kara 	if (ret) {
161279feb521SJan Kara 		printk(KERN_ERR "JBD2: Error %d detected when updating "
161379feb521SJan Kara 		       "journal superblock for %s.\n", ret,
161479feb521SJan Kara 		       journal->j_devname);
16157b97d868Szhangyi (F) 		if (!is_journal_aborted(journal))
16166f6a6fdaSJoseph Qi 			jbd2_journal_abort(journal, ret);
1617914258bfSTheodore Ts'o 	}
16186f6a6fdaSJoseph Qi 
16196f6a6fdaSJoseph Qi 	return ret;
162024bcc89cSJan Kara }
1621470decc6SDave Kleikamp 
162224bcc89cSJan Kara /**
162324bcc89cSJan Kara  * jbd2_journal_update_sb_log_tail() - Update log tail in journal sb on disk.
162424bcc89cSJan Kara  * @journal: The journal to update.
162579feb521SJan Kara  * @tail_tid: TID of the new transaction at the tail of the log
162679feb521SJan Kara  * @tail_block: The first block of the transaction at the tail of the log
162779feb521SJan Kara  * @write_op: With which operation should we write the journal sb
162824bcc89cSJan Kara  *
162924bcc89cSJan Kara  * Update a journal's superblock information about log tail and write it to
163024bcc89cSJan Kara  * disk, waiting for the IO to complete.
163124bcc89cSJan Kara  */
16326f6a6fdaSJoseph Qi int jbd2_journal_update_sb_log_tail(journal_t *journal, tid_t tail_tid,
163379feb521SJan Kara 				     unsigned long tail_block, int write_op)
163424bcc89cSJan Kara {
163524bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
16366f6a6fdaSJoseph Qi 	int ret;
16372201c590SSeiji Aguchi 
163885e0c4e8STheodore Ts'o 	if (is_journal_aborted(journal))
163985e0c4e8STheodore Ts'o 		return -EIO;
164085e0c4e8STheodore Ts'o 
1641a78bb11dSJan Kara 	BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
164279feb521SJan Kara 	jbd_debug(1, "JBD2: updating superblock (start %lu, seq %u)\n",
164379feb521SJan Kara 		  tail_block, tail_tid);
1644470decc6SDave Kleikamp 
1645538bcaa6STheodore Ts'o 	lock_buffer(journal->j_sb_buffer);
164679feb521SJan Kara 	sb->s_sequence = cpu_to_be32(tail_tid);
164779feb521SJan Kara 	sb->s_start    = cpu_to_be32(tail_block);
164824bcc89cSJan Kara 
16496f6a6fdaSJoseph Qi 	ret = jbd2_write_superblock(journal, write_op);
16506f6a6fdaSJoseph Qi 	if (ret)
16516f6a6fdaSJoseph Qi 		goto out;
165224bcc89cSJan Kara 
165324bcc89cSJan Kara 	/* Log is no longer empty */
1654a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
165524bcc89cSJan Kara 	WARN_ON(!sb->s_sequence);
1656f7f4bccbSMingming Cao 	journal->j_flags &= ~JBD2_FLUSHED;
165724bcc89cSJan Kara 	write_unlock(&journal->j_state_lock);
16586f6a6fdaSJoseph Qi 
16596f6a6fdaSJoseph Qi out:
16606f6a6fdaSJoseph Qi 	return ret;
166124bcc89cSJan Kara }
166224bcc89cSJan Kara 
166324bcc89cSJan Kara /**
166424bcc89cSJan Kara  * jbd2_mark_journal_empty() - Mark on disk journal as empty.
166524bcc89cSJan Kara  * @journal: The journal to update.
1666c0a2ad9bSOGAWA Hirofumi  * @write_op: With which operation should we write the journal sb
166724bcc89cSJan Kara  *
166824bcc89cSJan Kara  * Update a journal's dynamic superblock fields to show that journal is empty.
166924bcc89cSJan Kara  * Write updated superblock to disk waiting for IO to complete.
167024bcc89cSJan Kara  */
1671c0a2ad9bSOGAWA Hirofumi static void jbd2_mark_journal_empty(journal_t *journal, int write_op)
167224bcc89cSJan Kara {
167324bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
1674*ff780b91SHarshad Shirwadkar 	bool had_fast_commit = false;
167524bcc89cSJan Kara 
1676a78bb11dSJan Kara 	BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
1677538bcaa6STheodore Ts'o 	lock_buffer(journal->j_sb_buffer);
1678538bcaa6STheodore Ts'o 	if (sb->s_start == 0) {		/* Is it already empty? */
1679538bcaa6STheodore Ts'o 		unlock_buffer(journal->j_sb_buffer);
1680eeecef0aSEric Sandeen 		return;
1681eeecef0aSEric Sandeen 	}
1682538bcaa6STheodore Ts'o 
16837821ce41SGaowei Pu 	jbd_debug(1, "JBD2: Marking journal as empty (seq %u)\n",
168424bcc89cSJan Kara 		  journal->j_tail_sequence);
1685470decc6SDave Kleikamp 
1686470decc6SDave Kleikamp 	sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
168724bcc89cSJan Kara 	sb->s_start    = cpu_to_be32(0);
1688*ff780b91SHarshad Shirwadkar 	if (jbd2_has_feature_fast_commit(journal)) {
1689*ff780b91SHarshad Shirwadkar 		/*
1690*ff780b91SHarshad Shirwadkar 		 * When journal is clean, no need to commit fast commit flag and
1691*ff780b91SHarshad Shirwadkar 		 * make file system incompatible with older kernels.
1692*ff780b91SHarshad Shirwadkar 		 */
1693*ff780b91SHarshad Shirwadkar 		jbd2_clear_feature_fast_commit(journal);
1694*ff780b91SHarshad Shirwadkar 		had_fast_commit = true;
1695*ff780b91SHarshad Shirwadkar 	}
169624bcc89cSJan Kara 
1697c0a2ad9bSOGAWA Hirofumi 	jbd2_write_superblock(journal, write_op);
169824bcc89cSJan Kara 
1699*ff780b91SHarshad Shirwadkar 	if (had_fast_commit)
1700*ff780b91SHarshad Shirwadkar 		jbd2_set_feature_fast_commit(journal);
1701*ff780b91SHarshad Shirwadkar 
170224bcc89cSJan Kara 	/* Log is no longer empty */
170324bcc89cSJan Kara 	write_lock(&journal->j_state_lock);
1704f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_FLUSHED;
1705a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
1706470decc6SDave Kleikamp }
1707470decc6SDave Kleikamp 
170824bcc89cSJan Kara 
170924bcc89cSJan Kara /**
171024bcc89cSJan Kara  * jbd2_journal_update_sb_errno() - Update error in the journal.
171124bcc89cSJan Kara  * @journal: The journal to update.
171224bcc89cSJan Kara  *
171324bcc89cSJan Kara  * Update a journal's errno.  Write updated superblock to disk waiting for IO
171424bcc89cSJan Kara  * to complete.
171524bcc89cSJan Kara  */
1716d796c52eSTheodore Ts'o void jbd2_journal_update_sb_errno(journal_t *journal)
171724bcc89cSJan Kara {
171824bcc89cSJan Kara 	journal_superblock_t *sb = journal->j_superblock;
1719fb7c0244STheodore Ts'o 	int errcode;
172024bcc89cSJan Kara 
1721538bcaa6STheodore Ts'o 	lock_buffer(journal->j_sb_buffer);
1722fb7c0244STheodore Ts'o 	errcode = journal->j_errno;
1723fb7c0244STheodore Ts'o 	if (errcode == -ESHUTDOWN)
1724fb7c0244STheodore Ts'o 		errcode = 0;
1725fb7c0244STheodore Ts'o 	jbd_debug(1, "JBD2: updating superblock error (errno %d)\n", errcode);
1726fb7c0244STheodore Ts'o 	sb->s_errno    = cpu_to_be32(errcode);
1727470decc6SDave Kleikamp 
172817f423b5SJan Kara 	jbd2_write_superblock(journal, REQ_SYNC | REQ_FUA);
1729470decc6SDave Kleikamp }
1730d796c52eSTheodore Ts'o EXPORT_SYMBOL(jbd2_journal_update_sb_errno);
1731470decc6SDave Kleikamp 
1732fdc3ef88SJan Kara static int journal_revoke_records_per_block(journal_t *journal)
1733fdc3ef88SJan Kara {
1734fdc3ef88SJan Kara 	int record_size;
1735fdc3ef88SJan Kara 	int space = journal->j_blocksize - sizeof(jbd2_journal_revoke_header_t);
1736fdc3ef88SJan Kara 
1737fdc3ef88SJan Kara 	if (jbd2_has_feature_64bit(journal))
1738fdc3ef88SJan Kara 		record_size = 8;
1739fdc3ef88SJan Kara 	else
1740fdc3ef88SJan Kara 		record_size = 4;
1741fdc3ef88SJan Kara 
1742fdc3ef88SJan Kara 	if (jbd2_journal_has_csum_v2or3(journal))
1743fdc3ef88SJan Kara 		space -= sizeof(struct jbd2_journal_block_tail);
1744fdc3ef88SJan Kara 	return space / record_size;
1745fdc3ef88SJan Kara }
1746fdc3ef88SJan Kara 
1747470decc6SDave Kleikamp /*
1748470decc6SDave Kleikamp  * Read the superblock for a given journal, performing initial
1749470decc6SDave Kleikamp  * validation of the format.
1750470decc6SDave Kleikamp  */
1751470decc6SDave Kleikamp static int journal_get_superblock(journal_t *journal)
1752470decc6SDave Kleikamp {
1753470decc6SDave Kleikamp 	struct buffer_head *bh;
1754470decc6SDave Kleikamp 	journal_superblock_t *sb;
1755470decc6SDave Kleikamp 	int err = -EIO;
1756470decc6SDave Kleikamp 
1757470decc6SDave Kleikamp 	bh = journal->j_sb_buffer;
1758470decc6SDave Kleikamp 
1759470decc6SDave Kleikamp 	J_ASSERT(bh != NULL);
1760470decc6SDave Kleikamp 	if (!buffer_uptodate(bh)) {
1761dfec8a14SMike Christie 		ll_rw_block(REQ_OP_READ, 0, 1, &bh);
1762470decc6SDave Kleikamp 		wait_on_buffer(bh);
1763470decc6SDave Kleikamp 		if (!buffer_uptodate(bh)) {
1764470decc6SDave Kleikamp 			printk(KERN_ERR
1765f2a44523SEryu Guan 				"JBD2: IO error reading journal superblock\n");
1766470decc6SDave Kleikamp 			goto out;
1767470decc6SDave Kleikamp 		}
1768470decc6SDave Kleikamp 	}
1769470decc6SDave Kleikamp 
177025ed6e8aSDarrick J. Wong 	if (buffer_verified(bh))
177125ed6e8aSDarrick J. Wong 		return 0;
177225ed6e8aSDarrick J. Wong 
1773470decc6SDave Kleikamp 	sb = journal->j_superblock;
1774470decc6SDave Kleikamp 
1775470decc6SDave Kleikamp 	err = -EINVAL;
1776470decc6SDave Kleikamp 
1777f7f4bccbSMingming Cao 	if (sb->s_header.h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER) ||
1778470decc6SDave Kleikamp 	    sb->s_blocksize != cpu_to_be32(journal->j_blocksize)) {
1779f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: no valid journal superblock found\n");
1780470decc6SDave Kleikamp 		goto out;
1781470decc6SDave Kleikamp 	}
1782470decc6SDave Kleikamp 
1783470decc6SDave Kleikamp 	switch(be32_to_cpu(sb->s_header.h_blocktype)) {
1784f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V1:
1785470decc6SDave Kleikamp 		journal->j_format_version = 1;
1786470decc6SDave Kleikamp 		break;
1787f7f4bccbSMingming Cao 	case JBD2_SUPERBLOCK_V2:
1788470decc6SDave Kleikamp 		journal->j_format_version = 2;
1789470decc6SDave Kleikamp 		break;
1790470decc6SDave Kleikamp 	default:
1791f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: unrecognised superblock format ID\n");
1792470decc6SDave Kleikamp 		goto out;
1793470decc6SDave Kleikamp 	}
1794470decc6SDave Kleikamp 
1795470decc6SDave Kleikamp 	if (be32_to_cpu(sb->s_maxlen) < journal->j_maxlen)
1796470decc6SDave Kleikamp 		journal->j_maxlen = be32_to_cpu(sb->s_maxlen);
1797470decc6SDave Kleikamp 	else if (be32_to_cpu(sb->s_maxlen) > journal->j_maxlen) {
1798f2a44523SEryu Guan 		printk(KERN_WARNING "JBD2: journal file too short\n");
1799470decc6SDave Kleikamp 		goto out;
1800470decc6SDave Kleikamp 	}
1801470decc6SDave Kleikamp 
18028762202dSEryu Guan 	if (be32_to_cpu(sb->s_first) == 0 ||
18038762202dSEryu Guan 	    be32_to_cpu(sb->s_first) >= journal->j_maxlen) {
18048762202dSEryu Guan 		printk(KERN_WARNING
18058762202dSEryu Guan 			"JBD2: Invalid start block of journal: %u\n",
18068762202dSEryu Guan 			be32_to_cpu(sb->s_first));
18078762202dSEryu Guan 		goto out;
18088762202dSEryu Guan 	}
18098762202dSEryu Guan 
181056316a0dSDarrick J. Wong 	if (jbd2_has_feature_csum2(journal) &&
181156316a0dSDarrick J. Wong 	    jbd2_has_feature_csum3(journal)) {
1812db9ee220SDarrick J. Wong 		/* Can't have checksum v2 and v3 at the same time! */
1813db9ee220SDarrick J. Wong 		printk(KERN_ERR "JBD2: Can't enable checksumming v2 and v3 "
1814db9ee220SDarrick J. Wong 		       "at the same time!\n");
1815db9ee220SDarrick J. Wong 		goto out;
1816db9ee220SDarrick J. Wong 	}
1817db9ee220SDarrick J. Wong 
18188595798cSDarrick J. Wong 	if (jbd2_journal_has_csum_v2or3_feature(journal) &&
181956316a0dSDarrick J. Wong 	    jbd2_has_feature_checksum(journal)) {
1820feb8c6d3SDarrick J. Wong 		/* Can't have checksum v1 and v2 on at the same time! */
1821feb8c6d3SDarrick J. Wong 		printk(KERN_ERR "JBD2: Can't enable checksumming v1 and v2/3 "
1822feb8c6d3SDarrick J. Wong 		       "at the same time!\n");
1823feb8c6d3SDarrick J. Wong 		goto out;
1824feb8c6d3SDarrick J. Wong 	}
1825feb8c6d3SDarrick J. Wong 
182625ed6e8aSDarrick J. Wong 	if (!jbd2_verify_csum_type(journal, sb)) {
1827a67c848aSDmitry Monakhov 		printk(KERN_ERR "JBD2: Unknown checksum type\n");
182825ed6e8aSDarrick J. Wong 		goto out;
182925ed6e8aSDarrick J. Wong 	}
183025ed6e8aSDarrick J. Wong 
183101b5adceSDarrick J. Wong 	/* Load the checksum driver */
18328595798cSDarrick J. Wong 	if (jbd2_journal_has_csum_v2or3_feature(journal)) {
183301b5adceSDarrick J. Wong 		journal->j_chksum_driver = crypto_alloc_shash("crc32c", 0, 0);
183401b5adceSDarrick J. Wong 		if (IS_ERR(journal->j_chksum_driver)) {
1835a67c848aSDmitry Monakhov 			printk(KERN_ERR "JBD2: Cannot load crc32c driver.\n");
183601b5adceSDarrick J. Wong 			err = PTR_ERR(journal->j_chksum_driver);
183701b5adceSDarrick J. Wong 			journal->j_chksum_driver = NULL;
183801b5adceSDarrick J. Wong 			goto out;
183901b5adceSDarrick J. Wong 		}
184001b5adceSDarrick J. Wong 	}
184101b5adceSDarrick J. Wong 
1842a58ca992STheodore Ts'o 	if (jbd2_journal_has_csum_v2or3(journal)) {
18434fd5ea43SDarrick J. Wong 		/* Check superblock checksum */
1844a58ca992STheodore Ts'o 		if (sb->s_checksum != jbd2_superblock_csum(journal, sb)) {
1845a67c848aSDmitry Monakhov 			printk(KERN_ERR "JBD2: journal checksum error\n");
18466a797d27SDarrick J. Wong 			err = -EFSBADCRC;
18474fd5ea43SDarrick J. Wong 			goto out;
18484fd5ea43SDarrick J. Wong 		}
18494fd5ea43SDarrick J. Wong 
18504fd5ea43SDarrick J. Wong 		/* Precompute checksum seed for all metadata */
18514fd5ea43SDarrick J. Wong 		journal->j_csum_seed = jbd2_chksum(journal, ~0, sb->s_uuid,
18524fd5ea43SDarrick J. Wong 						   sizeof(sb->s_uuid));
1853a58ca992STheodore Ts'o 	}
18544fd5ea43SDarrick J. Wong 
1855fdc3ef88SJan Kara 	journal->j_revoke_records_per_block =
1856fdc3ef88SJan Kara 				journal_revoke_records_per_block(journal);
185725ed6e8aSDarrick J. Wong 	set_buffer_verified(bh);
185825ed6e8aSDarrick J. Wong 
1859470decc6SDave Kleikamp 	return 0;
1860470decc6SDave Kleikamp 
1861470decc6SDave Kleikamp out:
1862470decc6SDave Kleikamp 	journal_fail_superblock(journal);
1863470decc6SDave Kleikamp 	return err;
1864470decc6SDave Kleikamp }
1865470decc6SDave Kleikamp 
1866470decc6SDave Kleikamp /*
1867470decc6SDave Kleikamp  * Load the on-disk journal superblock and read the key fields into the
1868470decc6SDave Kleikamp  * journal_t.
1869470decc6SDave Kleikamp  */
1870470decc6SDave Kleikamp 
1871470decc6SDave Kleikamp static int load_superblock(journal_t *journal)
1872470decc6SDave Kleikamp {
1873470decc6SDave Kleikamp 	int err;
1874470decc6SDave Kleikamp 	journal_superblock_t *sb;
1875470decc6SDave Kleikamp 
1876470decc6SDave Kleikamp 	err = journal_get_superblock(journal);
1877470decc6SDave Kleikamp 	if (err)
1878470decc6SDave Kleikamp 		return err;
1879470decc6SDave Kleikamp 
1880470decc6SDave Kleikamp 	sb = journal->j_superblock;
1881470decc6SDave Kleikamp 
1882470decc6SDave Kleikamp 	journal->j_tail_sequence = be32_to_cpu(sb->s_sequence);
1883470decc6SDave Kleikamp 	journal->j_tail = be32_to_cpu(sb->s_start);
1884470decc6SDave Kleikamp 	journal->j_first = be32_to_cpu(sb->s_first);
1885470decc6SDave Kleikamp 	journal->j_errno = be32_to_cpu(sb->s_errno);
1886470decc6SDave Kleikamp 
18876866d7b3SHarshad Shirwadkar 	if (jbd2_has_feature_fast_commit(journal) &&
18886866d7b3SHarshad Shirwadkar 	    journal->j_fc_wbufsize > 0) {
18896866d7b3SHarshad Shirwadkar 		journal->j_fc_last = be32_to_cpu(sb->s_maxlen);
18906866d7b3SHarshad Shirwadkar 		journal->j_last = journal->j_fc_last - journal->j_fc_wbufsize;
18916866d7b3SHarshad Shirwadkar 		journal->j_fc_first = journal->j_last + 1;
18926866d7b3SHarshad Shirwadkar 		journal->j_fc_off = 0;
18936866d7b3SHarshad Shirwadkar 	} else {
18946866d7b3SHarshad Shirwadkar 		journal->j_last = be32_to_cpu(sb->s_maxlen);
18956866d7b3SHarshad Shirwadkar 	}
18966866d7b3SHarshad Shirwadkar 
1897470decc6SDave Kleikamp 	return 0;
1898470decc6SDave Kleikamp }
1899470decc6SDave Kleikamp 
1900470decc6SDave Kleikamp 
1901470decc6SDave Kleikamp /**
1902f7f4bccbSMingming Cao  * int jbd2_journal_load() - Read journal from disk.
1903470decc6SDave Kleikamp  * @journal: Journal to act on.
1904470decc6SDave Kleikamp  *
1905470decc6SDave Kleikamp  * Given a journal_t structure which tells us which disk blocks contain
1906470decc6SDave Kleikamp  * a journal, read the journal from disk to initialise the in-memory
1907470decc6SDave Kleikamp  * structures.
1908470decc6SDave Kleikamp  */
1909f7f4bccbSMingming Cao int jbd2_journal_load(journal_t *journal)
1910470decc6SDave Kleikamp {
1911470decc6SDave Kleikamp 	int err;
1912470decc6SDave Kleikamp 	journal_superblock_t *sb;
1913470decc6SDave Kleikamp 
1914470decc6SDave Kleikamp 	err = load_superblock(journal);
1915470decc6SDave Kleikamp 	if (err)
1916470decc6SDave Kleikamp 		return err;
1917470decc6SDave Kleikamp 
1918470decc6SDave Kleikamp 	sb = journal->j_superblock;
1919470decc6SDave Kleikamp 	/* If this is a V2 superblock, then we have to check the
1920470decc6SDave Kleikamp 	 * features flags on it. */
1921470decc6SDave Kleikamp 
1922470decc6SDave Kleikamp 	if (journal->j_format_version >= 2) {
1923470decc6SDave Kleikamp 		if ((sb->s_feature_ro_compat &
1924f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_ROCOMPAT_FEATURES)) ||
1925470decc6SDave Kleikamp 		    (sb->s_feature_incompat &
1926f7f4bccbSMingming Cao 		     ~cpu_to_be32(JBD2_KNOWN_INCOMPAT_FEATURES))) {
1927470decc6SDave Kleikamp 			printk(KERN_WARNING
1928f2a44523SEryu Guan 				"JBD2: Unrecognised features on journal\n");
1929470decc6SDave Kleikamp 			return -EINVAL;
1930470decc6SDave Kleikamp 		}
1931470decc6SDave Kleikamp 	}
1932470decc6SDave Kleikamp 
1933d2eecb03STheodore Ts'o 	/*
1934d2eecb03STheodore Ts'o 	 * Create a slab for this blocksize
1935d2eecb03STheodore Ts'o 	 */
1936d2eecb03STheodore Ts'o 	err = jbd2_journal_create_slab(be32_to_cpu(sb->s_blocksize));
1937d2eecb03STheodore Ts'o 	if (err)
1938d2eecb03STheodore Ts'o 		return err;
1939d2eecb03STheodore Ts'o 
1940470decc6SDave Kleikamp 	/* Let the recovery code check whether it needs to recover any
1941470decc6SDave Kleikamp 	 * data from the journal. */
1942f7f4bccbSMingming Cao 	if (jbd2_journal_recover(journal))
1943470decc6SDave Kleikamp 		goto recovery_error;
1944470decc6SDave Kleikamp 
1945e6a47428STheodore Ts'o 	if (journal->j_failed_commit) {
1946e6a47428STheodore Ts'o 		printk(KERN_ERR "JBD2: journal transaction %u on %s "
1947e6a47428STheodore Ts'o 		       "is corrupt.\n", journal->j_failed_commit,
1948e6a47428STheodore Ts'o 		       journal->j_devname);
19496a797d27SDarrick J. Wong 		return -EFSCORRUPTED;
1950e6a47428STheodore Ts'o 	}
1951a09decffSKai Li 	/*
1952a09decffSKai Li 	 * clear JBD2_ABORT flag initialized in journal_init_common
1953a09decffSKai Li 	 * here to update log tail information with the newest seq.
1954a09decffSKai Li 	 */
1955a09decffSKai Li 	journal->j_flags &= ~JBD2_ABORT;
1956e6a47428STheodore Ts'o 
19576866d7b3SHarshad Shirwadkar 	if (journal->j_fc_wbufsize > 0)
19586866d7b3SHarshad Shirwadkar 		jbd2_journal_set_features(journal, 0, 0,
19596866d7b3SHarshad Shirwadkar 					  JBD2_FEATURE_INCOMPAT_FAST_COMMIT);
1960470decc6SDave Kleikamp 	/* OK, we've finished with the dynamic journal bits:
1961470decc6SDave Kleikamp 	 * reinitialise the dynamic contents of the superblock in memory
1962470decc6SDave Kleikamp 	 * and reset them on disk. */
1963470decc6SDave Kleikamp 	if (journal_reset(journal))
1964470decc6SDave Kleikamp 		goto recovery_error;
1965470decc6SDave Kleikamp 
1966f7f4bccbSMingming Cao 	journal->j_flags |= JBD2_LOADED;
1967470decc6SDave Kleikamp 	return 0;
1968470decc6SDave Kleikamp 
1969470decc6SDave Kleikamp recovery_error:
1970f2a44523SEryu Guan 	printk(KERN_WARNING "JBD2: recovery failed\n");
1971470decc6SDave Kleikamp 	return -EIO;
1972470decc6SDave Kleikamp }
1973470decc6SDave Kleikamp 
1974470decc6SDave Kleikamp /**
1975f7f4bccbSMingming Cao  * void jbd2_journal_destroy() - Release a journal_t structure.
1976470decc6SDave Kleikamp  * @journal: Journal to act on.
1977470decc6SDave Kleikamp  *
1978470decc6SDave Kleikamp  * Release a journal_t structure once it is no longer in use by the
1979470decc6SDave Kleikamp  * journaled object.
198044519fafSHidehiro Kawai  * Return <0 if we couldn't clean up the journal.
1981470decc6SDave Kleikamp  */
198244519fafSHidehiro Kawai int jbd2_journal_destroy(journal_t *journal)
1983470decc6SDave Kleikamp {
198444519fafSHidehiro Kawai 	int err = 0;
198544519fafSHidehiro Kawai 
1986470decc6SDave Kleikamp 	/* Wait for the commit thread to wake up and die. */
1987470decc6SDave Kleikamp 	journal_kill_thread(journal);
1988470decc6SDave Kleikamp 
1989470decc6SDave Kleikamp 	/* Force a final log commit */
1990470decc6SDave Kleikamp 	if (journal->j_running_transaction)
1991f7f4bccbSMingming Cao 		jbd2_journal_commit_transaction(journal);
1992470decc6SDave Kleikamp 
1993470decc6SDave Kleikamp 	/* Force any old transactions to disk */
1994470decc6SDave Kleikamp 
1995470decc6SDave Kleikamp 	/* Totally anal locking here... */
1996470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
1997470decc6SDave Kleikamp 	while (journal->j_checkpoint_transactions != NULL) {
1998470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
19996fa7aa50STejun Heo 		mutex_lock_io(&journal->j_checkpoint_mutex);
2000841df7dfSJan Kara 		err = jbd2_log_do_checkpoint(journal);
20011a0d3786STheodore Ts'o 		mutex_unlock(&journal->j_checkpoint_mutex);
2002841df7dfSJan Kara 		/*
2003841df7dfSJan Kara 		 * If checkpointing failed, just free the buffers to avoid
2004841df7dfSJan Kara 		 * looping forever
2005841df7dfSJan Kara 		 */
2006841df7dfSJan Kara 		if (err) {
2007841df7dfSJan Kara 			jbd2_journal_destroy_checkpoint(journal);
2008841df7dfSJan Kara 			spin_lock(&journal->j_list_lock);
2009841df7dfSJan Kara 			break;
2010841df7dfSJan Kara 		}
2011470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
2012470decc6SDave Kleikamp 	}
2013470decc6SDave Kleikamp 
2014470decc6SDave Kleikamp 	J_ASSERT(journal->j_running_transaction == NULL);
2015470decc6SDave Kleikamp 	J_ASSERT(journal->j_committing_transaction == NULL);
2016470decc6SDave Kleikamp 	J_ASSERT(journal->j_checkpoint_transactions == NULL);
2017470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
2018470decc6SDave Kleikamp 
201944519fafSHidehiro Kawai 	if (journal->j_sb_buffer) {
202044519fafSHidehiro Kawai 		if (!is_journal_aborted(journal)) {
20216fa7aa50STejun Heo 			mutex_lock_io(&journal->j_checkpoint_mutex);
2022c0a2ad9bSOGAWA Hirofumi 
2023c0a2ad9bSOGAWA Hirofumi 			write_lock(&journal->j_state_lock);
2024c0a2ad9bSOGAWA Hirofumi 			journal->j_tail_sequence =
2025c0a2ad9bSOGAWA Hirofumi 				++journal->j_transaction_sequence;
2026c0a2ad9bSOGAWA Hirofumi 			write_unlock(&journal->j_state_lock);
2027c0a2ad9bSOGAWA Hirofumi 
202870fd7614SChristoph Hellwig 			jbd2_mark_journal_empty(journal,
202917f423b5SJan Kara 					REQ_SYNC | REQ_PREFLUSH | REQ_FUA);
2030a78bb11dSJan Kara 			mutex_unlock(&journal->j_checkpoint_mutex);
2031a78bb11dSJan Kara 		} else
203244519fafSHidehiro Kawai 			err = -EIO;
2033470decc6SDave Kleikamp 		brelse(journal->j_sb_buffer);
2034470decc6SDave Kleikamp 	}
2035470decc6SDave Kleikamp 
20368e85fb3fSJohann Lombardi 	if (journal->j_proc_entry)
20378e85fb3fSJohann Lombardi 		jbd2_stats_proc_exit(journal);
2038470decc6SDave Kleikamp 	iput(journal->j_inode);
2039470decc6SDave Kleikamp 	if (journal->j_revoke)
2040f7f4bccbSMingming Cao 		jbd2_journal_destroy_revoke(journal);
204101b5adceSDarrick J. Wong 	if (journal->j_chksum_driver)
204201b5adceSDarrick J. Wong 		crypto_free_shash(journal->j_chksum_driver);
20436866d7b3SHarshad Shirwadkar 	if (journal->j_fc_wbufsize > 0)
20446866d7b3SHarshad Shirwadkar 		kfree(journal->j_fc_wbuf);
2045470decc6SDave Kleikamp 	kfree(journal->j_wbuf);
2046470decc6SDave Kleikamp 	kfree(journal);
204744519fafSHidehiro Kawai 
204844519fafSHidehiro Kawai 	return err;
2049470decc6SDave Kleikamp }
2050470decc6SDave Kleikamp 
2051470decc6SDave Kleikamp 
2052470decc6SDave Kleikamp /**
2053f7f4bccbSMingming Cao  *int jbd2_journal_check_used_features() - Check if features specified are used.
2054470decc6SDave Kleikamp  * @journal: Journal to check.
2055470decc6SDave Kleikamp  * @compat: bitmask of compatible features
2056470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
2057470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
2058470decc6SDave Kleikamp  *
2059470decc6SDave Kleikamp  * Check whether the journal uses all of a given set of
2060470decc6SDave Kleikamp  * features.  Return true (non-zero) if it does.
2061470decc6SDave Kleikamp  **/
2062470decc6SDave Kleikamp 
2063f7f4bccbSMingming Cao int jbd2_journal_check_used_features(journal_t *journal, unsigned long compat,
2064470decc6SDave Kleikamp 				 unsigned long ro, unsigned long incompat)
2065470decc6SDave Kleikamp {
2066470decc6SDave Kleikamp 	journal_superblock_t *sb;
2067470decc6SDave Kleikamp 
2068470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
2069470decc6SDave Kleikamp 		return 1;
20701113e1b5SPatrick J. LoPresti 	/* Load journal superblock if it is not loaded yet. */
20711113e1b5SPatrick J. LoPresti 	if (journal->j_format_version == 0 &&
20721113e1b5SPatrick J. LoPresti 	    journal_get_superblock(journal) != 0)
20731113e1b5SPatrick J. LoPresti 		return 0;
2074470decc6SDave Kleikamp 	if (journal->j_format_version == 1)
2075470decc6SDave Kleikamp 		return 0;
2076470decc6SDave Kleikamp 
2077470decc6SDave Kleikamp 	sb = journal->j_superblock;
2078470decc6SDave Kleikamp 
2079470decc6SDave Kleikamp 	if (((be32_to_cpu(sb->s_feature_compat) & compat) == compat) &&
2080470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_ro_compat) & ro) == ro) &&
2081470decc6SDave Kleikamp 	    ((be32_to_cpu(sb->s_feature_incompat) & incompat) == incompat))
2082470decc6SDave Kleikamp 		return 1;
2083470decc6SDave Kleikamp 
2084470decc6SDave Kleikamp 	return 0;
2085470decc6SDave Kleikamp }
2086470decc6SDave Kleikamp 
2087470decc6SDave Kleikamp /**
2088f7f4bccbSMingming Cao  * int jbd2_journal_check_available_features() - Check feature set in journalling layer
2089470decc6SDave Kleikamp  * @journal: Journal to check.
2090470decc6SDave Kleikamp  * @compat: bitmask of compatible features
2091470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
2092470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
2093470decc6SDave Kleikamp  *
2094470decc6SDave Kleikamp  * Check whether the journaling code supports the use of
2095470decc6SDave Kleikamp  * all of a given set of features on this journal.  Return true
2096470decc6SDave Kleikamp  * (non-zero) if it can. */
2097470decc6SDave Kleikamp 
2098f7f4bccbSMingming Cao int jbd2_journal_check_available_features(journal_t *journal, unsigned long compat,
2099470decc6SDave Kleikamp 				      unsigned long ro, unsigned long incompat)
2100470decc6SDave Kleikamp {
2101470decc6SDave Kleikamp 	if (!compat && !ro && !incompat)
2102470decc6SDave Kleikamp 		return 1;
2103470decc6SDave Kleikamp 
2104470decc6SDave Kleikamp 	/* We can support any known requested features iff the
2105470decc6SDave Kleikamp 	 * superblock is in version 2.  Otherwise we fail to support any
2106470decc6SDave Kleikamp 	 * extended sb features. */
2107470decc6SDave Kleikamp 
2108470decc6SDave Kleikamp 	if (journal->j_format_version != 2)
2109470decc6SDave Kleikamp 		return 0;
2110470decc6SDave Kleikamp 
2111f7f4bccbSMingming Cao 	if ((compat   & JBD2_KNOWN_COMPAT_FEATURES) == compat &&
2112f7f4bccbSMingming Cao 	    (ro       & JBD2_KNOWN_ROCOMPAT_FEATURES) == ro &&
2113f7f4bccbSMingming Cao 	    (incompat & JBD2_KNOWN_INCOMPAT_FEATURES) == incompat)
2114470decc6SDave Kleikamp 		return 1;
2115470decc6SDave Kleikamp 
2116470decc6SDave Kleikamp 	return 0;
2117470decc6SDave Kleikamp }
2118470decc6SDave Kleikamp 
2119470decc6SDave Kleikamp /**
2120f7f4bccbSMingming Cao  * int jbd2_journal_set_features() - Mark a given journal feature in the superblock
2121470decc6SDave Kleikamp  * @journal: Journal to act on.
2122470decc6SDave Kleikamp  * @compat: bitmask of compatible features
2123470decc6SDave Kleikamp  * @ro: bitmask of features that force read-only mount
2124470decc6SDave Kleikamp  * @incompat: bitmask of incompatible features
2125470decc6SDave Kleikamp  *
2126470decc6SDave Kleikamp  * Mark a given journal feature as present on the
2127470decc6SDave Kleikamp  * superblock.  Returns true if the requested features could be set.
2128470decc6SDave Kleikamp  *
2129470decc6SDave Kleikamp  */
2130470decc6SDave Kleikamp 
2131f7f4bccbSMingming Cao int jbd2_journal_set_features(journal_t *journal, unsigned long compat,
2132470decc6SDave Kleikamp 			  unsigned long ro, unsigned long incompat)
2133470decc6SDave Kleikamp {
213425ed6e8aSDarrick J. Wong #define INCOMPAT_FEATURE_ON(f) \
213525ed6e8aSDarrick J. Wong 		((incompat & (f)) && !(sb->s_feature_incompat & cpu_to_be32(f)))
213625ed6e8aSDarrick J. Wong #define COMPAT_FEATURE_ON(f) \
213725ed6e8aSDarrick J. Wong 		((compat & (f)) && !(sb->s_feature_compat & cpu_to_be32(f)))
2138470decc6SDave Kleikamp 	journal_superblock_t *sb;
2139470decc6SDave Kleikamp 
2140f7f4bccbSMingming Cao 	if (jbd2_journal_check_used_features(journal, compat, ro, incompat))
2141470decc6SDave Kleikamp 		return 1;
2142470decc6SDave Kleikamp 
2143f7f4bccbSMingming Cao 	if (!jbd2_journal_check_available_features(journal, compat, ro, incompat))
2144470decc6SDave Kleikamp 		return 0;
2145470decc6SDave Kleikamp 
2146db9ee220SDarrick J. Wong 	/* If enabling v2 checksums, turn on v3 instead */
2147db9ee220SDarrick J. Wong 	if (incompat & JBD2_FEATURE_INCOMPAT_CSUM_V2) {
2148db9ee220SDarrick J. Wong 		incompat &= ~JBD2_FEATURE_INCOMPAT_CSUM_V2;
2149db9ee220SDarrick J. Wong 		incompat |= JBD2_FEATURE_INCOMPAT_CSUM_V3;
2150db9ee220SDarrick J. Wong 	}
2151db9ee220SDarrick J. Wong 
2152db9ee220SDarrick J. Wong 	/* Asking for checksumming v3 and v1?  Only give them v3. */
2153db9ee220SDarrick J. Wong 	if (incompat & JBD2_FEATURE_INCOMPAT_CSUM_V3 &&
215425ed6e8aSDarrick J. Wong 	    compat & JBD2_FEATURE_COMPAT_CHECKSUM)
215525ed6e8aSDarrick J. Wong 		compat &= ~JBD2_FEATURE_COMPAT_CHECKSUM;
215625ed6e8aSDarrick J. Wong 
2157470decc6SDave Kleikamp 	jbd_debug(1, "Setting new features 0x%lx/0x%lx/0x%lx\n",
2158470decc6SDave Kleikamp 		  compat, ro, incompat);
2159470decc6SDave Kleikamp 
2160470decc6SDave Kleikamp 	sb = journal->j_superblock;
2161470decc6SDave Kleikamp 
2162538bcaa6STheodore Ts'o 	/* Load the checksum driver if necessary */
2163538bcaa6STheodore Ts'o 	if ((journal->j_chksum_driver == NULL) &&
2164538bcaa6STheodore Ts'o 	    INCOMPAT_FEATURE_ON(JBD2_FEATURE_INCOMPAT_CSUM_V3)) {
2165538bcaa6STheodore Ts'o 		journal->j_chksum_driver = crypto_alloc_shash("crc32c", 0, 0);
2166538bcaa6STheodore Ts'o 		if (IS_ERR(journal->j_chksum_driver)) {
2167538bcaa6STheodore Ts'o 			printk(KERN_ERR "JBD2: Cannot load crc32c driver.\n");
2168538bcaa6STheodore Ts'o 			journal->j_chksum_driver = NULL;
2169538bcaa6STheodore Ts'o 			return 0;
2170538bcaa6STheodore Ts'o 		}
2171538bcaa6STheodore Ts'o 		/* Precompute checksum seed for all metadata */
2172538bcaa6STheodore Ts'o 		journal->j_csum_seed = jbd2_chksum(journal, ~0, sb->s_uuid,
2173538bcaa6STheodore Ts'o 						   sizeof(sb->s_uuid));
2174538bcaa6STheodore Ts'o 	}
2175538bcaa6STheodore Ts'o 
2176538bcaa6STheodore Ts'o 	lock_buffer(journal->j_sb_buffer);
2177538bcaa6STheodore Ts'o 
2178db9ee220SDarrick J. Wong 	/* If enabling v3 checksums, update superblock */
2179db9ee220SDarrick J. Wong 	if (INCOMPAT_FEATURE_ON(JBD2_FEATURE_INCOMPAT_CSUM_V3)) {
218025ed6e8aSDarrick J. Wong 		sb->s_checksum_type = JBD2_CRC32C_CHKSUM;
218125ed6e8aSDarrick J. Wong 		sb->s_feature_compat &=
218225ed6e8aSDarrick J. Wong 			~cpu_to_be32(JBD2_FEATURE_COMPAT_CHECKSUM);
218332f38691SDarrick J. Wong 	}
218425ed6e8aSDarrick J. Wong 
218525ed6e8aSDarrick J. Wong 	/* If enabling v1 checksums, downgrade superblock */
218625ed6e8aSDarrick J. Wong 	if (COMPAT_FEATURE_ON(JBD2_FEATURE_COMPAT_CHECKSUM))
218725ed6e8aSDarrick J. Wong 		sb->s_feature_incompat &=
2188db9ee220SDarrick J. Wong 			~cpu_to_be32(JBD2_FEATURE_INCOMPAT_CSUM_V2 |
2189db9ee220SDarrick J. Wong 				     JBD2_FEATURE_INCOMPAT_CSUM_V3);
219025ed6e8aSDarrick J. Wong 
2191470decc6SDave Kleikamp 	sb->s_feature_compat    |= cpu_to_be32(compat);
2192470decc6SDave Kleikamp 	sb->s_feature_ro_compat |= cpu_to_be32(ro);
2193470decc6SDave Kleikamp 	sb->s_feature_incompat  |= cpu_to_be32(incompat);
2194538bcaa6STheodore Ts'o 	unlock_buffer(journal->j_sb_buffer);
2195fdc3ef88SJan Kara 	journal->j_revoke_records_per_block =
2196fdc3ef88SJan Kara 				journal_revoke_records_per_block(journal);
2197470decc6SDave Kleikamp 
2198470decc6SDave Kleikamp 	return 1;
219925ed6e8aSDarrick J. Wong #undef COMPAT_FEATURE_ON
220025ed6e8aSDarrick J. Wong #undef INCOMPAT_FEATURE_ON
2201470decc6SDave Kleikamp }
2202470decc6SDave Kleikamp 
2203818d276cSGirish Shilamkar /*
2204818d276cSGirish Shilamkar  * jbd2_journal_clear_features () - Clear a given journal feature in the
2205818d276cSGirish Shilamkar  * 				    superblock
2206818d276cSGirish Shilamkar  * @journal: Journal to act on.
2207818d276cSGirish Shilamkar  * @compat: bitmask of compatible features
2208818d276cSGirish Shilamkar  * @ro: bitmask of features that force read-only mount
2209818d276cSGirish Shilamkar  * @incompat: bitmask of incompatible features
2210818d276cSGirish Shilamkar  *
2211818d276cSGirish Shilamkar  * Clear a given journal feature as present on the
2212818d276cSGirish Shilamkar  * superblock.
2213818d276cSGirish Shilamkar  */
2214818d276cSGirish Shilamkar void jbd2_journal_clear_features(journal_t *journal, unsigned long compat,
2215818d276cSGirish Shilamkar 				unsigned long ro, unsigned long incompat)
2216818d276cSGirish Shilamkar {
2217818d276cSGirish Shilamkar 	journal_superblock_t *sb;
2218818d276cSGirish Shilamkar 
2219818d276cSGirish Shilamkar 	jbd_debug(1, "Clear features 0x%lx/0x%lx/0x%lx\n",
2220818d276cSGirish Shilamkar 		  compat, ro, incompat);
2221818d276cSGirish Shilamkar 
2222818d276cSGirish Shilamkar 	sb = journal->j_superblock;
2223818d276cSGirish Shilamkar 
2224818d276cSGirish Shilamkar 	sb->s_feature_compat    &= ~cpu_to_be32(compat);
2225818d276cSGirish Shilamkar 	sb->s_feature_ro_compat &= ~cpu_to_be32(ro);
2226818d276cSGirish Shilamkar 	sb->s_feature_incompat  &= ~cpu_to_be32(incompat);
2227fdc3ef88SJan Kara 	journal->j_revoke_records_per_block =
2228fdc3ef88SJan Kara 				journal_revoke_records_per_block(journal);
2229818d276cSGirish Shilamkar }
2230818d276cSGirish Shilamkar EXPORT_SYMBOL(jbd2_journal_clear_features);
2231470decc6SDave Kleikamp 
2232470decc6SDave Kleikamp /**
2233f7f4bccbSMingming Cao  * int jbd2_journal_flush () - Flush journal
2234470decc6SDave Kleikamp  * @journal: Journal to act on.
2235470decc6SDave Kleikamp  *
2236470decc6SDave Kleikamp  * Flush all data for a given journal to disk and empty the journal.
2237470decc6SDave Kleikamp  * Filesystems can use this when remounting readonly to ensure that
2238470decc6SDave Kleikamp  * recovery does not need to happen on remount.
2239470decc6SDave Kleikamp  */
2240470decc6SDave Kleikamp 
2241f7f4bccbSMingming Cao int jbd2_journal_flush(journal_t *journal)
2242470decc6SDave Kleikamp {
2243470decc6SDave Kleikamp 	int err = 0;
2244470decc6SDave Kleikamp 	transaction_t *transaction = NULL;
2245470decc6SDave Kleikamp 
2246a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
2247470decc6SDave Kleikamp 
2248470decc6SDave Kleikamp 	/* Force everything buffered to the log... */
2249470decc6SDave Kleikamp 	if (journal->j_running_transaction) {
2250470decc6SDave Kleikamp 		transaction = journal->j_running_transaction;
2251f7f4bccbSMingming Cao 		__jbd2_log_start_commit(journal, transaction->t_tid);
2252470decc6SDave Kleikamp 	} else if (journal->j_committing_transaction)
2253470decc6SDave Kleikamp 		transaction = journal->j_committing_transaction;
2254470decc6SDave Kleikamp 
2255470decc6SDave Kleikamp 	/* Wait for the log commit to complete... */
2256470decc6SDave Kleikamp 	if (transaction) {
2257470decc6SDave Kleikamp 		tid_t tid = transaction->t_tid;
2258470decc6SDave Kleikamp 
2259a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
2260f7f4bccbSMingming Cao 		jbd2_log_wait_commit(journal, tid);
2261470decc6SDave Kleikamp 	} else {
2262a931da6aSTheodore Ts'o 		write_unlock(&journal->j_state_lock);
2263470decc6SDave Kleikamp 	}
2264470decc6SDave Kleikamp 
2265470decc6SDave Kleikamp 	/* ...and flush everything in the log out to disk. */
2266470decc6SDave Kleikamp 	spin_lock(&journal->j_list_lock);
2267470decc6SDave Kleikamp 	while (!err && journal->j_checkpoint_transactions != NULL) {
2268470decc6SDave Kleikamp 		spin_unlock(&journal->j_list_lock);
22696fa7aa50STejun Heo 		mutex_lock_io(&journal->j_checkpoint_mutex);
2270f7f4bccbSMingming Cao 		err = jbd2_log_do_checkpoint(journal);
227144519fafSHidehiro Kawai 		mutex_unlock(&journal->j_checkpoint_mutex);
2272470decc6SDave Kleikamp 		spin_lock(&journal->j_list_lock);
2273470decc6SDave Kleikamp 	}
2274470decc6SDave Kleikamp 	spin_unlock(&journal->j_list_lock);
227544519fafSHidehiro Kawai 
227644519fafSHidehiro Kawai 	if (is_journal_aborted(journal))
227744519fafSHidehiro Kawai 		return -EIO;
227844519fafSHidehiro Kawai 
22796fa7aa50STejun Heo 	mutex_lock_io(&journal->j_checkpoint_mutex);
22806f6a6fdaSJoseph Qi 	if (!err) {
22816f6a6fdaSJoseph Qi 		err = jbd2_cleanup_journal_tail(journal);
22826f6a6fdaSJoseph Qi 		if (err < 0) {
22836f6a6fdaSJoseph Qi 			mutex_unlock(&journal->j_checkpoint_mutex);
22846f6a6fdaSJoseph Qi 			goto out;
22856f6a6fdaSJoseph Qi 		}
22866f6a6fdaSJoseph Qi 		err = 0;
22876f6a6fdaSJoseph Qi 	}
2288470decc6SDave Kleikamp 
2289470decc6SDave Kleikamp 	/* Finally, mark the journal as really needing no recovery.
2290470decc6SDave Kleikamp 	 * This sets s_start==0 in the underlying superblock, which is
2291470decc6SDave Kleikamp 	 * the magic code for a fully-recovered superblock.  Any future
2292470decc6SDave Kleikamp 	 * commits of data to the journal will restore the current
2293470decc6SDave Kleikamp 	 * s_start value. */
229417f423b5SJan Kara 	jbd2_mark_journal_empty(journal, REQ_SYNC | REQ_FUA);
2295a78bb11dSJan Kara 	mutex_unlock(&journal->j_checkpoint_mutex);
2296a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
2297470decc6SDave Kleikamp 	J_ASSERT(!journal->j_running_transaction);
2298470decc6SDave Kleikamp 	J_ASSERT(!journal->j_committing_transaction);
2299470decc6SDave Kleikamp 	J_ASSERT(!journal->j_checkpoint_transactions);
2300470decc6SDave Kleikamp 	J_ASSERT(journal->j_head == journal->j_tail);
2301470decc6SDave Kleikamp 	J_ASSERT(journal->j_tail_sequence == journal->j_transaction_sequence);
2302a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
23036f6a6fdaSJoseph Qi out:
23046f6a6fdaSJoseph Qi 	return err;
2305470decc6SDave Kleikamp }
2306470decc6SDave Kleikamp 
2307470decc6SDave Kleikamp /**
2308f7f4bccbSMingming Cao  * int jbd2_journal_wipe() - Wipe journal contents
2309470decc6SDave Kleikamp  * @journal: Journal to act on.
2310470decc6SDave Kleikamp  * @write: flag (see below)
2311470decc6SDave Kleikamp  *
2312470decc6SDave Kleikamp  * Wipe out all of the contents of a journal, safely.  This will produce
2313470decc6SDave Kleikamp  * a warning if the journal contains any valid recovery information.
2314f7f4bccbSMingming Cao  * Must be called between journal_init_*() and jbd2_journal_load().
2315470decc6SDave Kleikamp  *
2316470decc6SDave Kleikamp  * If 'write' is non-zero, then we wipe out the journal on disk; otherwise
2317470decc6SDave Kleikamp  * we merely suppress recovery.
2318470decc6SDave Kleikamp  */
2319470decc6SDave Kleikamp 
2320f7f4bccbSMingming Cao int jbd2_journal_wipe(journal_t *journal, int write)
2321470decc6SDave Kleikamp {
2322470decc6SDave Kleikamp 	int err = 0;
2323470decc6SDave Kleikamp 
2324f7f4bccbSMingming Cao 	J_ASSERT (!(journal->j_flags & JBD2_LOADED));
2325470decc6SDave Kleikamp 
2326470decc6SDave Kleikamp 	err = load_superblock(journal);
2327470decc6SDave Kleikamp 	if (err)
2328470decc6SDave Kleikamp 		return err;
2329470decc6SDave Kleikamp 
2330470decc6SDave Kleikamp 	if (!journal->j_tail)
2331470decc6SDave Kleikamp 		goto no_recovery;
2332470decc6SDave Kleikamp 
2333f2a44523SEryu Guan 	printk(KERN_WARNING "JBD2: %s recovery information on journal\n",
2334470decc6SDave Kleikamp 		write ? "Clearing" : "Ignoring");
2335470decc6SDave Kleikamp 
2336f7f4bccbSMingming Cao 	err = jbd2_journal_skip_recovery(journal);
2337a78bb11dSJan Kara 	if (write) {
2338a78bb11dSJan Kara 		/* Lock to make assertions happy... */
233953cf9784SXiaoguang Wang 		mutex_lock_io(&journal->j_checkpoint_mutex);
234017f423b5SJan Kara 		jbd2_mark_journal_empty(journal, REQ_SYNC | REQ_FUA);
2341a78bb11dSJan Kara 		mutex_unlock(&journal->j_checkpoint_mutex);
2342a78bb11dSJan Kara 	}
2343470decc6SDave Kleikamp 
2344470decc6SDave Kleikamp  no_recovery:
2345470decc6SDave Kleikamp 	return err;
2346470decc6SDave Kleikamp }
2347470decc6SDave Kleikamp 
2348470decc6SDave Kleikamp /**
2349f7f4bccbSMingming Cao  * void jbd2_journal_abort () - Shutdown the journal immediately.
2350470decc6SDave Kleikamp  * @journal: the journal to shutdown.
2351470decc6SDave Kleikamp  * @errno:   an error number to record in the journal indicating
2352470decc6SDave Kleikamp  *           the reason for the shutdown.
2353470decc6SDave Kleikamp  *
2354470decc6SDave Kleikamp  * Perform a complete, immediate shutdown of the ENTIRE
2355470decc6SDave Kleikamp  * journal (not of a single transaction).  This operation cannot be
2356470decc6SDave Kleikamp  * undone without closing and reopening the journal.
2357470decc6SDave Kleikamp  *
2358f7f4bccbSMingming Cao  * The jbd2_journal_abort function is intended to support higher level error
2359470decc6SDave Kleikamp  * recovery mechanisms such as the ext2/ext3 remount-readonly error
2360470decc6SDave Kleikamp  * mode.
2361470decc6SDave Kleikamp  *
2362470decc6SDave Kleikamp  * Journal abort has very specific semantics.  Any existing dirty,
2363470decc6SDave Kleikamp  * unjournaled buffers in the main filesystem will still be written to
2364470decc6SDave Kleikamp  * disk by bdflush, but the journaling mechanism will be suspended
2365470decc6SDave Kleikamp  * immediately and no further transaction commits will be honoured.
2366470decc6SDave Kleikamp  *
2367470decc6SDave Kleikamp  * Any dirty, journaled buffers will be written back to disk without
2368470decc6SDave Kleikamp  * hitting the journal.  Atomicity cannot be guaranteed on an aborted
2369470decc6SDave Kleikamp  * filesystem, but we _do_ attempt to leave as much data as possible
2370470decc6SDave Kleikamp  * behind for fsck to use for cleanup.
2371470decc6SDave Kleikamp  *
2372470decc6SDave Kleikamp  * Any attempt to get a new transaction handle on a journal which is in
2373470decc6SDave Kleikamp  * ABORT state will just result in an -EROFS error return.  A
2374f7f4bccbSMingming Cao  * jbd2_journal_stop on an existing handle will return -EIO if we have
2375470decc6SDave Kleikamp  * entered abort state during the update.
2376470decc6SDave Kleikamp  *
2377470decc6SDave Kleikamp  * Recursive transactions are not disturbed by journal abort until the
2378f7f4bccbSMingming Cao  * final jbd2_journal_stop, which will receive the -EIO error.
2379470decc6SDave Kleikamp  *
2380f7f4bccbSMingming Cao  * Finally, the jbd2_journal_abort call allows the caller to supply an errno
2381470decc6SDave Kleikamp  * which will be recorded (if possible) in the journal superblock.  This
2382470decc6SDave Kleikamp  * allows a client to record failure conditions in the middle of a
2383470decc6SDave Kleikamp  * transaction without having to complete the transaction to record the
2384470decc6SDave Kleikamp  * failure to disk.  ext3_error, for example, now uses this
2385470decc6SDave Kleikamp  * functionality.
2386470decc6SDave Kleikamp  *
2387470decc6SDave Kleikamp  */
2388470decc6SDave Kleikamp 
2389f7f4bccbSMingming Cao void jbd2_journal_abort(journal_t *journal, int errno)
2390470decc6SDave Kleikamp {
23917f6225e4Szhangyi (F) 	transaction_t *transaction;
23927f6225e4Szhangyi (F) 
23937f6225e4Szhangyi (F) 	/*
23947b97d868Szhangyi (F) 	 * Lock the aborting procedure until everything is done, this avoid
23957b97d868Szhangyi (F) 	 * races between filesystem's error handling flow (e.g. ext4_abort()),
23967b97d868Szhangyi (F) 	 * ensure panic after the error info is written into journal's
23977b97d868Szhangyi (F) 	 * superblock.
23987b97d868Szhangyi (F) 	 */
23997b97d868Szhangyi (F) 	mutex_lock(&journal->j_abort_mutex);
24007b97d868Szhangyi (F) 	/*
24017f6225e4Szhangyi (F) 	 * ESHUTDOWN always takes precedence because a file system check
24027f6225e4Szhangyi (F) 	 * caused by any other journal abort error is not required after
24037f6225e4Szhangyi (F) 	 * a shutdown triggered.
24047f6225e4Szhangyi (F) 	 */
24057f6225e4Szhangyi (F) 	write_lock(&journal->j_state_lock);
24067f6225e4Szhangyi (F) 	if (journal->j_flags & JBD2_ABORT) {
24077f6225e4Szhangyi (F) 		int old_errno = journal->j_errno;
24087f6225e4Szhangyi (F) 
24097f6225e4Szhangyi (F) 		write_unlock(&journal->j_state_lock);
24107f6225e4Szhangyi (F) 		if (old_errno != -ESHUTDOWN && errno == -ESHUTDOWN) {
24117f6225e4Szhangyi (F) 			journal->j_errno = errno;
24127f6225e4Szhangyi (F) 			jbd2_journal_update_sb_errno(journal);
24137f6225e4Szhangyi (F) 		}
24147b97d868Szhangyi (F) 		mutex_unlock(&journal->j_abort_mutex);
24157f6225e4Szhangyi (F) 		return;
24167f6225e4Szhangyi (F) 	}
24177f6225e4Szhangyi (F) 
24187f6225e4Szhangyi (F) 	/*
24197f6225e4Szhangyi (F) 	 * Mark the abort as occurred and start current running transaction
24207f6225e4Szhangyi (F) 	 * to release all journaled buffer.
24217f6225e4Szhangyi (F) 	 */
24227f6225e4Szhangyi (F) 	pr_err("Aborting journal on device %s.\n", journal->j_devname);
24237f6225e4Szhangyi (F) 
24247f6225e4Szhangyi (F) 	journal->j_flags |= JBD2_ABORT;
24257f6225e4Szhangyi (F) 	journal->j_errno = errno;
24267f6225e4Szhangyi (F) 	transaction = journal->j_running_transaction;
24277f6225e4Szhangyi (F) 	if (transaction)
24287f6225e4Szhangyi (F) 		__jbd2_log_start_commit(journal, transaction->t_tid);
24297f6225e4Szhangyi (F) 	write_unlock(&journal->j_state_lock);
24307f6225e4Szhangyi (F) 
24317f6225e4Szhangyi (F) 	/*
24327f6225e4Szhangyi (F) 	 * Record errno to the journal super block, so that fsck and jbd2
24337f6225e4Szhangyi (F) 	 * layer could realise that a filesystem check is needed.
24347f6225e4Szhangyi (F) 	 */
24357f6225e4Szhangyi (F) 	jbd2_journal_update_sb_errno(journal);
24367b97d868Szhangyi (F) 	mutex_unlock(&journal->j_abort_mutex);
2437470decc6SDave Kleikamp }
2438470decc6SDave Kleikamp 
2439470decc6SDave Kleikamp /**
2440f7f4bccbSMingming Cao  * int jbd2_journal_errno () - returns the journal's error state.
2441470decc6SDave Kleikamp  * @journal: journal to examine.
2442470decc6SDave Kleikamp  *
2443bfcd3555SAlberto Bertogli  * This is the errno number set with jbd2_journal_abort(), the last
2444470decc6SDave Kleikamp  * time the journal was mounted - if the journal was stopped
2445470decc6SDave Kleikamp  * without calling abort this will be 0.
2446470decc6SDave Kleikamp  *
2447470decc6SDave Kleikamp  * If the journal has been aborted on this mount time -EROFS will
2448470decc6SDave Kleikamp  * be returned.
2449470decc6SDave Kleikamp  */
2450f7f4bccbSMingming Cao int jbd2_journal_errno(journal_t *journal)
2451470decc6SDave Kleikamp {
2452470decc6SDave Kleikamp 	int err;
2453470decc6SDave Kleikamp 
2454a931da6aSTheodore Ts'o 	read_lock(&journal->j_state_lock);
2455f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
2456470decc6SDave Kleikamp 		err = -EROFS;
2457470decc6SDave Kleikamp 	else
2458470decc6SDave Kleikamp 		err = journal->j_errno;
2459a931da6aSTheodore Ts'o 	read_unlock(&journal->j_state_lock);
2460470decc6SDave Kleikamp 	return err;
2461470decc6SDave Kleikamp }
2462470decc6SDave Kleikamp 
2463470decc6SDave Kleikamp /**
2464f7f4bccbSMingming Cao  * int jbd2_journal_clear_err () - clears the journal's error state
2465470decc6SDave Kleikamp  * @journal: journal to act on.
2466470decc6SDave Kleikamp  *
2467bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
2468470decc6SDave Kleikamp  * mode.
2469470decc6SDave Kleikamp  */
2470f7f4bccbSMingming Cao int jbd2_journal_clear_err(journal_t *journal)
2471470decc6SDave Kleikamp {
2472470decc6SDave Kleikamp 	int err = 0;
2473470decc6SDave Kleikamp 
2474a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
2475f7f4bccbSMingming Cao 	if (journal->j_flags & JBD2_ABORT)
2476470decc6SDave Kleikamp 		err = -EROFS;
2477470decc6SDave Kleikamp 	else
2478470decc6SDave Kleikamp 		journal->j_errno = 0;
2479a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
2480470decc6SDave Kleikamp 	return err;
2481470decc6SDave Kleikamp }
2482470decc6SDave Kleikamp 
2483470decc6SDave Kleikamp /**
2484f7f4bccbSMingming Cao  * void jbd2_journal_ack_err() - Ack journal err.
2485470decc6SDave Kleikamp  * @journal: journal to act on.
2486470decc6SDave Kleikamp  *
2487bfcd3555SAlberto Bertogli  * An error must be cleared or acked to take a FS out of readonly
2488470decc6SDave Kleikamp  * mode.
2489470decc6SDave Kleikamp  */
2490f7f4bccbSMingming Cao void jbd2_journal_ack_err(journal_t *journal)
2491470decc6SDave Kleikamp {
2492a931da6aSTheodore Ts'o 	write_lock(&journal->j_state_lock);
2493470decc6SDave Kleikamp 	if (journal->j_errno)
2494f7f4bccbSMingming Cao 		journal->j_flags |= JBD2_ACK_ERR;
2495a931da6aSTheodore Ts'o 	write_unlock(&journal->j_state_lock);
2496470decc6SDave Kleikamp }
2497470decc6SDave Kleikamp 
2498f7f4bccbSMingming Cao int jbd2_journal_blocks_per_page(struct inode *inode)
2499470decc6SDave Kleikamp {
250009cbfeafSKirill A. Shutemov 	return 1 << (PAGE_SHIFT - inode->i_sb->s_blocksize_bits);
2501470decc6SDave Kleikamp }
2502470decc6SDave Kleikamp 
2503470decc6SDave Kleikamp /*
2504b517bea1SZach Brown  * helper functions to deal with 32 or 64bit block numbers.
2505b517bea1SZach Brown  */
2506b517bea1SZach Brown size_t journal_tag_bytes(journal_t *journal)
2507b517bea1SZach Brown {
2508db9ee220SDarrick J. Wong 	size_t sz;
2509db9ee220SDarrick J. Wong 
251056316a0dSDarrick J. Wong 	if (jbd2_has_feature_csum3(journal))
2511db9ee220SDarrick J. Wong 		return sizeof(journal_block_tag3_t);
2512db9ee220SDarrick J. Wong 
2513db9ee220SDarrick J. Wong 	sz = sizeof(journal_block_tag_t);
2514c3900875SDarrick J. Wong 
251556316a0dSDarrick J. Wong 	if (jbd2_has_feature_csum2(journal))
2516db9ee220SDarrick J. Wong 		sz += sizeof(__u16);
2517c3900875SDarrick J. Wong 
251856316a0dSDarrick J. Wong 	if (jbd2_has_feature_64bit(journal))
2519db9ee220SDarrick J. Wong 		return sz;
2520b517bea1SZach Brown 	else
2521db9ee220SDarrick J. Wong 		return sz - sizeof(__u32);
2522b517bea1SZach Brown }
2523b517bea1SZach Brown 
2524b517bea1SZach Brown /*
2525d2eecb03STheodore Ts'o  * JBD memory management
2526d2eecb03STheodore Ts'o  *
2527d2eecb03STheodore Ts'o  * These functions are used to allocate block-sized chunks of memory
2528d2eecb03STheodore Ts'o  * used for making copies of buffer_head data.  Very often it will be
2529d2eecb03STheodore Ts'o  * page-sized chunks of data, but sometimes it will be in
2530d2eecb03STheodore Ts'o  * sub-page-size chunks.  (For example, 16k pages on Power systems
2531d2eecb03STheodore Ts'o  * with a 4k block file system.)  For blocks smaller than a page, we
2532d2eecb03STheodore Ts'o  * use a SLAB allocator.  There are slab caches for each block size,
2533d2eecb03STheodore Ts'o  * which are allocated at mount time, if necessary, and we only free
2534d2eecb03STheodore Ts'o  * (all of) the slab caches when/if the jbd2 module is unloaded.  For
2535d2eecb03STheodore Ts'o  * this reason we don't need to a mutex to protect access to
2536d2eecb03STheodore Ts'o  * jbd2_slab[] allocating or releasing memory; only in
2537d2eecb03STheodore Ts'o  * jbd2_journal_create_slab().
2538d2eecb03STheodore Ts'o  */
2539d2eecb03STheodore Ts'o #define JBD2_MAX_SLABS 8
2540d2eecb03STheodore Ts'o static struct kmem_cache *jbd2_slab[JBD2_MAX_SLABS];
2541d2eecb03STheodore Ts'o 
2542d2eecb03STheodore Ts'o static const char *jbd2_slab_names[JBD2_MAX_SLABS] = {
2543d2eecb03STheodore Ts'o 	"jbd2_1k", "jbd2_2k", "jbd2_4k", "jbd2_8k",
2544d2eecb03STheodore Ts'o 	"jbd2_16k", "jbd2_32k", "jbd2_64k", "jbd2_128k"
2545d2eecb03STheodore Ts'o };
2546d2eecb03STheodore Ts'o 
2547d2eecb03STheodore Ts'o 
2548d2eecb03STheodore Ts'o static void jbd2_journal_destroy_slabs(void)
2549d2eecb03STheodore Ts'o {
2550d2eecb03STheodore Ts'o 	int i;
2551d2eecb03STheodore Ts'o 
2552d2eecb03STheodore Ts'o 	for (i = 0; i < JBD2_MAX_SLABS; i++) {
2553d2eecb03STheodore Ts'o 		kmem_cache_destroy(jbd2_slab[i]);
2554d2eecb03STheodore Ts'o 		jbd2_slab[i] = NULL;
2555d2eecb03STheodore Ts'o 	}
2556d2eecb03STheodore Ts'o }
2557d2eecb03STheodore Ts'o 
2558d2eecb03STheodore Ts'o static int jbd2_journal_create_slab(size_t size)
2559d2eecb03STheodore Ts'o {
256051dfacdeSThomas Gleixner 	static DEFINE_MUTEX(jbd2_slab_create_mutex);
2561d2eecb03STheodore Ts'o 	int i = order_base_2(size) - 10;
2562d2eecb03STheodore Ts'o 	size_t slab_size;
2563d2eecb03STheodore Ts'o 
2564d2eecb03STheodore Ts'o 	if (size == PAGE_SIZE)
2565d2eecb03STheodore Ts'o 		return 0;
2566d2eecb03STheodore Ts'o 
2567d2eecb03STheodore Ts'o 	if (i >= JBD2_MAX_SLABS)
2568d2eecb03STheodore Ts'o 		return -EINVAL;
2569d2eecb03STheodore Ts'o 
2570d2eecb03STheodore Ts'o 	if (unlikely(i < 0))
2571d2eecb03STheodore Ts'o 		i = 0;
257251dfacdeSThomas Gleixner 	mutex_lock(&jbd2_slab_create_mutex);
2573d2eecb03STheodore Ts'o 	if (jbd2_slab[i]) {
257451dfacdeSThomas Gleixner 		mutex_unlock(&jbd2_slab_create_mutex);
2575d2eecb03STheodore Ts'o 		return 0;	/* Already created */
2576d2eecb03STheodore Ts'o 	}
2577d2eecb03STheodore Ts'o 
2578d2eecb03STheodore Ts'o 	slab_size = 1 << (i+10);
2579d2eecb03STheodore Ts'o 	jbd2_slab[i] = kmem_cache_create(jbd2_slab_names[i], slab_size,
2580d2eecb03STheodore Ts'o 					 slab_size, 0, NULL);
258151dfacdeSThomas Gleixner 	mutex_unlock(&jbd2_slab_create_mutex);
2582d2eecb03STheodore Ts'o 	if (!jbd2_slab[i]) {
2583d2eecb03STheodore Ts'o 		printk(KERN_EMERG "JBD2: no memory for jbd2_slab cache\n");
2584d2eecb03STheodore Ts'o 		return -ENOMEM;
2585d2eecb03STheodore Ts'o 	}
2586d2eecb03STheodore Ts'o 	return 0;
2587d2eecb03STheodore Ts'o }
2588d2eecb03STheodore Ts'o 
2589d2eecb03STheodore Ts'o static struct kmem_cache *get_slab(size_t size)
2590d2eecb03STheodore Ts'o {
2591d2eecb03STheodore Ts'o 	int i = order_base_2(size) - 10;
2592d2eecb03STheodore Ts'o 
2593d2eecb03STheodore Ts'o 	BUG_ON(i >= JBD2_MAX_SLABS);
2594d2eecb03STheodore Ts'o 	if (unlikely(i < 0))
2595d2eecb03STheodore Ts'o 		i = 0;
25968ac97b74SBill Pemberton 	BUG_ON(jbd2_slab[i] == NULL);
2597d2eecb03STheodore Ts'o 	return jbd2_slab[i];
2598d2eecb03STheodore Ts'o }
2599d2eecb03STheodore Ts'o 
2600d2eecb03STheodore Ts'o void *jbd2_alloc(size_t size, gfp_t flags)
2601d2eecb03STheodore Ts'o {
2602d2eecb03STheodore Ts'o 	void *ptr;
2603d2eecb03STheodore Ts'o 
2604d2eecb03STheodore Ts'o 	BUG_ON(size & (size-1)); /* Must be a power of 2 */
2605d2eecb03STheodore Ts'o 
2606f2db1971SMichal Hocko 	if (size < PAGE_SIZE)
2607d2eecb03STheodore Ts'o 		ptr = kmem_cache_alloc(get_slab(size), flags);
2608f2db1971SMichal Hocko 	else
2609f2db1971SMichal Hocko 		ptr = (void *)__get_free_pages(flags, get_order(size));
2610d2eecb03STheodore Ts'o 
2611d2eecb03STheodore Ts'o 	/* Check alignment; SLUB has gotten this wrong in the past,
2612d2eecb03STheodore Ts'o 	 * and this can lead to user data corruption! */
2613d2eecb03STheodore Ts'o 	BUG_ON(((unsigned long) ptr) & (size-1));
2614d2eecb03STheodore Ts'o 
2615d2eecb03STheodore Ts'o 	return ptr;
2616d2eecb03STheodore Ts'o }
2617d2eecb03STheodore Ts'o 
2618d2eecb03STheodore Ts'o void jbd2_free(void *ptr, size_t size)
2619d2eecb03STheodore Ts'o {
2620f2db1971SMichal Hocko 	if (size < PAGE_SIZE)
2621d2eecb03STheodore Ts'o 		kmem_cache_free(get_slab(size), ptr);
2622f2db1971SMichal Hocko 	else
2623f2db1971SMichal Hocko 		free_pages((unsigned long)ptr, get_order(size));
2624d2eecb03STheodore Ts'o };
2625d2eecb03STheodore Ts'o 
2626d2eecb03STheodore Ts'o /*
2627470decc6SDave Kleikamp  * Journal_head storage management
2628470decc6SDave Kleikamp  */
2629e18b890bSChristoph Lameter static struct kmem_cache *jbd2_journal_head_cache;
2630e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2631470decc6SDave Kleikamp static atomic_t nr_journal_heads = ATOMIC_INIT(0);
2632470decc6SDave Kleikamp #endif
2633470decc6SDave Kleikamp 
26340d52154bSChengguang Xu static int __init jbd2_journal_init_journal_head_cache(void)
2635470decc6SDave Kleikamp {
26360d52154bSChengguang Xu 	J_ASSERT(!jbd2_journal_head_cache);
2637a920e941SJohann Lombardi 	jbd2_journal_head_cache = kmem_cache_create("jbd2_journal_head",
2638470decc6SDave Kleikamp 				sizeof(struct journal_head),
2639470decc6SDave Kleikamp 				0,		/* offset */
26405f0d5a3aSPaul E. McKenney 				SLAB_TEMPORARY | SLAB_TYPESAFE_BY_RCU,
264120c2df83SPaul Mundt 				NULL);		/* ctor */
26421076d17aSAl Viro 	if (!jbd2_journal_head_cache) {
2643f2a44523SEryu Guan 		printk(KERN_EMERG "JBD2: no memory for journal_head cache\n");
26440d52154bSChengguang Xu 		return -ENOMEM;
2645470decc6SDave Kleikamp 	}
26460d52154bSChengguang Xu 	return 0;
2647470decc6SDave Kleikamp }
2648470decc6SDave Kleikamp 
26494185a2acSYongqiang Yang static void jbd2_journal_destroy_journal_head_cache(void)
2650470decc6SDave Kleikamp {
2651f7f4bccbSMingming Cao 	kmem_cache_destroy(jbd2_journal_head_cache);
2652f7f4bccbSMingming Cao 	jbd2_journal_head_cache = NULL;
2653470decc6SDave Kleikamp }
2654470decc6SDave Kleikamp 
2655470decc6SDave Kleikamp /*
2656470decc6SDave Kleikamp  * journal_head splicing and dicing
2657470decc6SDave Kleikamp  */
2658470decc6SDave Kleikamp static struct journal_head *journal_alloc_journal_head(void)
2659470decc6SDave Kleikamp {
2660470decc6SDave Kleikamp 	struct journal_head *ret;
2661470decc6SDave Kleikamp 
2662e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2663470decc6SDave Kleikamp 	atomic_inc(&nr_journal_heads);
2664470decc6SDave Kleikamp #endif
26655d9cf9c6SZheng Liu 	ret = kmem_cache_zalloc(jbd2_journal_head_cache, GFP_NOFS);
26661076d17aSAl Viro 	if (!ret) {
2667470decc6SDave Kleikamp 		jbd_debug(1, "out of memory for journal_head\n");
2668670be5a7STheodore Ts'o 		pr_notice_ratelimited("ENOMEM in %s, retrying.\n", __func__);
26697b506b10SMichal Hocko 		ret = kmem_cache_zalloc(jbd2_journal_head_cache,
26707b506b10SMichal Hocko 				GFP_NOFS | __GFP_NOFAIL);
2671470decc6SDave Kleikamp 	}
267246417064SThomas Gleixner 	if (ret)
267346417064SThomas Gleixner 		spin_lock_init(&ret->b_state_lock);
2674470decc6SDave Kleikamp 	return ret;
2675470decc6SDave Kleikamp }
2676470decc6SDave Kleikamp 
2677470decc6SDave Kleikamp static void journal_free_journal_head(struct journal_head *jh)
2678470decc6SDave Kleikamp {
2679e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2680470decc6SDave Kleikamp 	atomic_dec(&nr_journal_heads);
2681cd02ff0bSMingming Cao 	memset(jh, JBD2_POISON_FREE, sizeof(*jh));
2682470decc6SDave Kleikamp #endif
2683f7f4bccbSMingming Cao 	kmem_cache_free(jbd2_journal_head_cache, jh);
2684470decc6SDave Kleikamp }
2685470decc6SDave Kleikamp 
2686470decc6SDave Kleikamp /*
2687470decc6SDave Kleikamp  * A journal_head is attached to a buffer_head whenever JBD has an
2688470decc6SDave Kleikamp  * interest in the buffer.
2689470decc6SDave Kleikamp  *
2690470decc6SDave Kleikamp  * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
2691470decc6SDave Kleikamp  * is set.  This bit is tested in core kernel code where we need to take
2692470decc6SDave Kleikamp  * JBD-specific actions.  Testing the zeroness of ->b_private is not reliable
2693470decc6SDave Kleikamp  * there.
2694470decc6SDave Kleikamp  *
2695470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
2696470decc6SDave Kleikamp  *
2697470decc6SDave Kleikamp  * When a buffer has its BH_JBD bit set it is immune from being released by
2698470decc6SDave Kleikamp  * core kernel code, mainly via ->b_count.
2699470decc6SDave Kleikamp  *
2700de1b7941SJan Kara  * A journal_head is detached from its buffer_head when the journal_head's
2701de1b7941SJan Kara  * b_jcount reaches zero. Running transaction (b_transaction) and checkpoint
2702de1b7941SJan Kara  * transaction (b_cp_transaction) hold their references to b_jcount.
2703470decc6SDave Kleikamp  *
2704470decc6SDave Kleikamp  * Various places in the kernel want to attach a journal_head to a buffer_head
2705470decc6SDave Kleikamp  * _before_ attaching the journal_head to a transaction.  To protect the
2706f7f4bccbSMingming Cao  * journal_head in this situation, jbd2_journal_add_journal_head elevates the
2707470decc6SDave Kleikamp  * journal_head's b_jcount refcount by one.  The caller must call
2708f7f4bccbSMingming Cao  * jbd2_journal_put_journal_head() to undo this.
2709470decc6SDave Kleikamp  *
2710470decc6SDave Kleikamp  * So the typical usage would be:
2711470decc6SDave Kleikamp  *
2712470decc6SDave Kleikamp  *	(Attach a journal_head if needed.  Increments b_jcount)
2713f7f4bccbSMingming Cao  *	struct journal_head *jh = jbd2_journal_add_journal_head(bh);
2714470decc6SDave Kleikamp  *	...
2715de1b7941SJan Kara  *      (Get another reference for transaction)
2716de1b7941SJan Kara  *	jbd2_journal_grab_journal_head(bh);
2717470decc6SDave Kleikamp  *	jh->b_transaction = xxx;
2718de1b7941SJan Kara  *	(Put original reference)
2719f7f4bccbSMingming Cao  *	jbd2_journal_put_journal_head(jh);
2720470decc6SDave Kleikamp  */
2721470decc6SDave Kleikamp 
2722470decc6SDave Kleikamp /*
2723470decc6SDave Kleikamp  * Give a buffer_head a journal_head.
2724470decc6SDave Kleikamp  *
2725470decc6SDave Kleikamp  * May sleep.
2726470decc6SDave Kleikamp  */
2727f7f4bccbSMingming Cao struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh)
2728470decc6SDave Kleikamp {
2729470decc6SDave Kleikamp 	struct journal_head *jh;
2730470decc6SDave Kleikamp 	struct journal_head *new_jh = NULL;
2731470decc6SDave Kleikamp 
2732470decc6SDave Kleikamp repeat:
27335d9cf9c6SZheng Liu 	if (!buffer_jbd(bh))
2734470decc6SDave Kleikamp 		new_jh = journal_alloc_journal_head();
2735470decc6SDave Kleikamp 
2736470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2737470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
2738470decc6SDave Kleikamp 		jh = bh2jh(bh);
2739470decc6SDave Kleikamp 	} else {
2740470decc6SDave Kleikamp 		J_ASSERT_BH(bh,
2741470decc6SDave Kleikamp 			(atomic_read(&bh->b_count) > 0) ||
2742470decc6SDave Kleikamp 			(bh->b_page && bh->b_page->mapping));
2743470decc6SDave Kleikamp 
2744470decc6SDave Kleikamp 		if (!new_jh) {
2745470decc6SDave Kleikamp 			jbd_unlock_bh_journal_head(bh);
2746470decc6SDave Kleikamp 			goto repeat;
2747470decc6SDave Kleikamp 		}
2748470decc6SDave Kleikamp 
2749470decc6SDave Kleikamp 		jh = new_jh;
2750470decc6SDave Kleikamp 		new_jh = NULL;		/* We consumed it */
2751470decc6SDave Kleikamp 		set_buffer_jbd(bh);
2752470decc6SDave Kleikamp 		bh->b_private = jh;
2753470decc6SDave Kleikamp 		jh->b_bh = bh;
2754470decc6SDave Kleikamp 		get_bh(bh);
2755470decc6SDave Kleikamp 		BUFFER_TRACE(bh, "added journal_head");
2756470decc6SDave Kleikamp 	}
2757470decc6SDave Kleikamp 	jh->b_jcount++;
2758470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2759470decc6SDave Kleikamp 	if (new_jh)
2760470decc6SDave Kleikamp 		journal_free_journal_head(new_jh);
2761470decc6SDave Kleikamp 	return bh->b_private;
2762470decc6SDave Kleikamp }
2763470decc6SDave Kleikamp 
2764470decc6SDave Kleikamp /*
2765470decc6SDave Kleikamp  * Grab a ref against this buffer_head's journal_head.  If it ended up not
2766470decc6SDave Kleikamp  * having a journal_head, return NULL
2767470decc6SDave Kleikamp  */
2768f7f4bccbSMingming Cao struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh)
2769470decc6SDave Kleikamp {
2770470decc6SDave Kleikamp 	struct journal_head *jh = NULL;
2771470decc6SDave Kleikamp 
2772470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2773470decc6SDave Kleikamp 	if (buffer_jbd(bh)) {
2774470decc6SDave Kleikamp 		jh = bh2jh(bh);
2775470decc6SDave Kleikamp 		jh->b_jcount++;
2776470decc6SDave Kleikamp 	}
2777470decc6SDave Kleikamp 	jbd_unlock_bh_journal_head(bh);
2778470decc6SDave Kleikamp 	return jh;
2779470decc6SDave Kleikamp }
2780470decc6SDave Kleikamp 
2781470decc6SDave Kleikamp static void __journal_remove_journal_head(struct buffer_head *bh)
2782470decc6SDave Kleikamp {
2783470decc6SDave Kleikamp 	struct journal_head *jh = bh2jh(bh);
2784470decc6SDave Kleikamp 
2785de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_transaction == NULL);
2786de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
2787de1b7941SJan Kara 	J_ASSERT_JH(jh, jh->b_cp_transaction == NULL);
2788470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jlist == BJ_None);
2789470decc6SDave Kleikamp 	J_ASSERT_BH(bh, buffer_jbd(bh));
2790470decc6SDave Kleikamp 	J_ASSERT_BH(bh, jh2bh(jh) == bh);
2791470decc6SDave Kleikamp 	BUFFER_TRACE(bh, "remove journal_head");
27927855a57dSThomas Gleixner 
27937855a57dSThomas Gleixner 	/* Unlink before dropping the lock */
2794470decc6SDave Kleikamp 	bh->b_private = NULL;
2795470decc6SDave Kleikamp 	jh->b_bh = NULL;	/* debug, really */
2796470decc6SDave Kleikamp 	clear_buffer_jbd(bh);
27977855a57dSThomas Gleixner }
27987855a57dSThomas Gleixner 
27997855a57dSThomas Gleixner static void journal_release_journal_head(struct journal_head *jh, size_t b_size)
28007855a57dSThomas Gleixner {
28017855a57dSThomas Gleixner 	if (jh->b_frozen_data) {
28027855a57dSThomas Gleixner 		printk(KERN_WARNING "%s: freeing b_frozen_data\n", __func__);
28037855a57dSThomas Gleixner 		jbd2_free(jh->b_frozen_data, b_size);
28047855a57dSThomas Gleixner 	}
28057855a57dSThomas Gleixner 	if (jh->b_committed_data) {
28067855a57dSThomas Gleixner 		printk(KERN_WARNING "%s: freeing b_committed_data\n", __func__);
28077855a57dSThomas Gleixner 		jbd2_free(jh->b_committed_data, b_size);
28087855a57dSThomas Gleixner 	}
2809470decc6SDave Kleikamp 	journal_free_journal_head(jh);
2810470decc6SDave Kleikamp }
2811470decc6SDave Kleikamp 
2812470decc6SDave Kleikamp /*
2813de1b7941SJan Kara  * Drop a reference on the passed journal_head.  If it fell to zero then
2814470decc6SDave Kleikamp  * release the journal_head from the buffer_head.
2815470decc6SDave Kleikamp  */
2816f7f4bccbSMingming Cao void jbd2_journal_put_journal_head(struct journal_head *jh)
2817470decc6SDave Kleikamp {
2818470decc6SDave Kleikamp 	struct buffer_head *bh = jh2bh(jh);
2819470decc6SDave Kleikamp 
2820470decc6SDave Kleikamp 	jbd_lock_bh_journal_head(bh);
2821470decc6SDave Kleikamp 	J_ASSERT_JH(jh, jh->b_jcount > 0);
2822470decc6SDave Kleikamp 	--jh->b_jcount;
2823de1b7941SJan Kara 	if (!jh->b_jcount) {
2824470decc6SDave Kleikamp 		__journal_remove_journal_head(bh);
2825de1b7941SJan Kara 		jbd_unlock_bh_journal_head(bh);
28267855a57dSThomas Gleixner 		journal_release_journal_head(jh, bh->b_size);
2827470decc6SDave Kleikamp 		__brelse(bh);
28287855a57dSThomas Gleixner 	} else {
2829470decc6SDave Kleikamp 		jbd_unlock_bh_journal_head(bh);
2830470decc6SDave Kleikamp 	}
28317855a57dSThomas Gleixner }
2832470decc6SDave Kleikamp 
2833470decc6SDave Kleikamp /*
2834c851ed54SJan Kara  * Initialize jbd inode head
2835c851ed54SJan Kara  */
2836c851ed54SJan Kara void jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode)
2837c851ed54SJan Kara {
2838c851ed54SJan Kara 	jinode->i_transaction = NULL;
2839c851ed54SJan Kara 	jinode->i_next_transaction = NULL;
2840c851ed54SJan Kara 	jinode->i_vfs_inode = inode;
2841c851ed54SJan Kara 	jinode->i_flags = 0;
28426ba0e7dcSRoss Zwisler 	jinode->i_dirty_start = 0;
28436ba0e7dcSRoss Zwisler 	jinode->i_dirty_end = 0;
2844c851ed54SJan Kara 	INIT_LIST_HEAD(&jinode->i_list);
2845c851ed54SJan Kara }
2846c851ed54SJan Kara 
2847c851ed54SJan Kara /*
2848c851ed54SJan Kara  * Function to be called before we start removing inode from memory (i.e.,
2849c851ed54SJan Kara  * clear_inode() is a fine place to be called from). It removes inode from
2850c851ed54SJan Kara  * transaction's lists.
2851c851ed54SJan Kara  */
2852c851ed54SJan Kara void jbd2_journal_release_jbd_inode(journal_t *journal,
2853c851ed54SJan Kara 				    struct jbd2_inode *jinode)
2854c851ed54SJan Kara {
2855c851ed54SJan Kara 	if (!journal)
2856c851ed54SJan Kara 		return;
2857c851ed54SJan Kara restart:
2858c851ed54SJan Kara 	spin_lock(&journal->j_list_lock);
2859c851ed54SJan Kara 	/* Is commit writing out inode - we have to wait */
2860cb0d9d47SJan Kara 	if (jinode->i_flags & JI_COMMIT_RUNNING) {
2861c851ed54SJan Kara 		wait_queue_head_t *wq;
2862c851ed54SJan Kara 		DEFINE_WAIT_BIT(wait, &jinode->i_flags, __JI_COMMIT_RUNNING);
2863c851ed54SJan Kara 		wq = bit_waitqueue(&jinode->i_flags, __JI_COMMIT_RUNNING);
286421417136SIngo Molnar 		prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
2865c851ed54SJan Kara 		spin_unlock(&journal->j_list_lock);
2866c851ed54SJan Kara 		schedule();
286721417136SIngo Molnar 		finish_wait(wq, &wait.wq_entry);
2868c851ed54SJan Kara 		goto restart;
2869c851ed54SJan Kara 	}
2870c851ed54SJan Kara 
2871c851ed54SJan Kara 	if (jinode->i_transaction) {
2872c851ed54SJan Kara 		list_del(&jinode->i_list);
2873c851ed54SJan Kara 		jinode->i_transaction = NULL;
2874c851ed54SJan Kara 	}
2875c851ed54SJan Kara 	spin_unlock(&journal->j_list_lock);
2876c851ed54SJan Kara }
2877c851ed54SJan Kara 
2878470decc6SDave Kleikamp 
28798e85fb3fSJohann Lombardi #ifdef CONFIG_PROC_FS
28808e85fb3fSJohann Lombardi 
28818e85fb3fSJohann Lombardi #define JBD2_STATS_PROC_NAME "fs/jbd2"
28828e85fb3fSJohann Lombardi 
28838e85fb3fSJohann Lombardi static void __init jbd2_create_jbd_stats_proc_entry(void)
28848e85fb3fSJohann Lombardi {
28858e85fb3fSJohann Lombardi 	proc_jbd2_stats = proc_mkdir(JBD2_STATS_PROC_NAME, NULL);
28868e85fb3fSJohann Lombardi }
28878e85fb3fSJohann Lombardi 
28888e85fb3fSJohann Lombardi static void __exit jbd2_remove_jbd_stats_proc_entry(void)
28898e85fb3fSJohann Lombardi {
28908e85fb3fSJohann Lombardi 	if (proc_jbd2_stats)
28918e85fb3fSJohann Lombardi 		remove_proc_entry(JBD2_STATS_PROC_NAME, NULL);
28928e85fb3fSJohann Lombardi }
28938e85fb3fSJohann Lombardi 
28948e85fb3fSJohann Lombardi #else
28958e85fb3fSJohann Lombardi 
28968e85fb3fSJohann Lombardi #define jbd2_create_jbd_stats_proc_entry() do {} while (0)
28978e85fb3fSJohann Lombardi #define jbd2_remove_jbd_stats_proc_entry() do {} while (0)
28988e85fb3fSJohann Lombardi 
28998e85fb3fSJohann Lombardi #endif
29008e85fb3fSJohann Lombardi 
29018aefcd55STheodore Ts'o struct kmem_cache *jbd2_handle_cache, *jbd2_inode_cache;
2902470decc6SDave Kleikamp 
29030d52154bSChengguang Xu static int __init jbd2_journal_init_inode_cache(void)
2904470decc6SDave Kleikamp {
29050d52154bSChengguang Xu 	J_ASSERT(!jbd2_inode_cache);
29068aefcd55STheodore Ts'o 	jbd2_inode_cache = KMEM_CACHE(jbd2_inode, 0);
29070d52154bSChengguang Xu 	if (!jbd2_inode_cache) {
29080d52154bSChengguang Xu 		pr_emerg("JBD2: failed to create inode cache\n");
2909470decc6SDave Kleikamp 		return -ENOMEM;
2910470decc6SDave Kleikamp 	}
2911470decc6SDave Kleikamp 	return 0;
2912470decc6SDave Kleikamp }
2913470decc6SDave Kleikamp 
29140d52154bSChengguang Xu static int __init jbd2_journal_init_handle_cache(void)
29150d52154bSChengguang Xu {
29160d52154bSChengguang Xu 	J_ASSERT(!jbd2_handle_cache);
29170d52154bSChengguang Xu 	jbd2_handle_cache = KMEM_CACHE(jbd2_journal_handle, SLAB_TEMPORARY);
29180d52154bSChengguang Xu 	if (!jbd2_handle_cache) {
29190d52154bSChengguang Xu 		printk(KERN_EMERG "JBD2: failed to create handle cache\n");
29200d52154bSChengguang Xu 		return -ENOMEM;
29210d52154bSChengguang Xu 	}
29220d52154bSChengguang Xu 	return 0;
29230d52154bSChengguang Xu }
29240d52154bSChengguang Xu 
29250d52154bSChengguang Xu static void jbd2_journal_destroy_inode_cache(void)
29260d52154bSChengguang Xu {
29270d52154bSChengguang Xu 	kmem_cache_destroy(jbd2_inode_cache);
29280d52154bSChengguang Xu 	jbd2_inode_cache = NULL;
29290d52154bSChengguang Xu }
29300d52154bSChengguang Xu 
2931f7f4bccbSMingming Cao static void jbd2_journal_destroy_handle_cache(void)
2932470decc6SDave Kleikamp {
2933f7f4bccbSMingming Cao 	kmem_cache_destroy(jbd2_handle_cache);
29348bdd5b60SWang Long 	jbd2_handle_cache = NULL;
2935470decc6SDave Kleikamp }
2936470decc6SDave Kleikamp 
2937470decc6SDave Kleikamp /*
2938470decc6SDave Kleikamp  * Module startup and shutdown
2939470decc6SDave Kleikamp  */
2940470decc6SDave Kleikamp 
2941470decc6SDave Kleikamp static int __init journal_init_caches(void)
2942470decc6SDave Kleikamp {
2943470decc6SDave Kleikamp 	int ret;
2944470decc6SDave Kleikamp 
29450d52154bSChengguang Xu 	ret = jbd2_journal_init_revoke_record_cache();
29460d52154bSChengguang Xu 	if (ret == 0)
29470d52154bSChengguang Xu 		ret = jbd2_journal_init_revoke_table_cache();
2948470decc6SDave Kleikamp 	if (ret == 0)
29494185a2acSYongqiang Yang 		ret = jbd2_journal_init_journal_head_cache();
2950470decc6SDave Kleikamp 	if (ret == 0)
29514185a2acSYongqiang Yang 		ret = jbd2_journal_init_handle_cache();
29520c2022ecSYongqiang Yang 	if (ret == 0)
29530d52154bSChengguang Xu 		ret = jbd2_journal_init_inode_cache();
29540d52154bSChengguang Xu 	if (ret == 0)
29550c2022ecSYongqiang Yang 		ret = jbd2_journal_init_transaction_cache();
2956470decc6SDave Kleikamp 	return ret;
2957470decc6SDave Kleikamp }
2958470decc6SDave Kleikamp 
2959f7f4bccbSMingming Cao static void jbd2_journal_destroy_caches(void)
2960470decc6SDave Kleikamp {
29610d52154bSChengguang Xu 	jbd2_journal_destroy_revoke_record_cache();
29620d52154bSChengguang Xu 	jbd2_journal_destroy_revoke_table_cache();
29634185a2acSYongqiang Yang 	jbd2_journal_destroy_journal_head_cache();
2964f7f4bccbSMingming Cao 	jbd2_journal_destroy_handle_cache();
29650d52154bSChengguang Xu 	jbd2_journal_destroy_inode_cache();
29660c2022ecSYongqiang Yang 	jbd2_journal_destroy_transaction_cache();
2967d2eecb03STheodore Ts'o 	jbd2_journal_destroy_slabs();
2968470decc6SDave Kleikamp }
2969470decc6SDave Kleikamp 
2970470decc6SDave Kleikamp static int __init journal_init(void)
2971470decc6SDave Kleikamp {
2972470decc6SDave Kleikamp 	int ret;
2973470decc6SDave Kleikamp 
2974470decc6SDave Kleikamp 	BUILD_BUG_ON(sizeof(struct journal_superblock_s) != 1024);
2975470decc6SDave Kleikamp 
2976470decc6SDave Kleikamp 	ret = journal_init_caches();
2977620de4e1SDuane Griffin 	if (ret == 0) {
29788e85fb3fSJohann Lombardi 		jbd2_create_jbd_stats_proc_entry();
2979620de4e1SDuane Griffin 	} else {
2980620de4e1SDuane Griffin 		jbd2_journal_destroy_caches();
2981620de4e1SDuane Griffin 	}
2982470decc6SDave Kleikamp 	return ret;
2983470decc6SDave Kleikamp }
2984470decc6SDave Kleikamp 
2985470decc6SDave Kleikamp static void __exit journal_exit(void)
2986470decc6SDave Kleikamp {
2987e23291b9SJose R. Santos #ifdef CONFIG_JBD2_DEBUG
2988470decc6SDave Kleikamp 	int n = atomic_read(&nr_journal_heads);
2989470decc6SDave Kleikamp 	if (n)
299075685071SJan Kara 		printk(KERN_ERR "JBD2: leaked %d journal_heads!\n", n);
2991470decc6SDave Kleikamp #endif
29928e85fb3fSJohann Lombardi 	jbd2_remove_jbd_stats_proc_entry();
2993f7f4bccbSMingming Cao 	jbd2_journal_destroy_caches();
2994470decc6SDave Kleikamp }
2995470decc6SDave Kleikamp 
2996470decc6SDave Kleikamp MODULE_LICENSE("GPL");
2997470decc6SDave Kleikamp module_init(journal_init);
2998470decc6SDave Kleikamp module_exit(journal_exit);
2999470decc6SDave Kleikamp 
3000