blob: fc5f2acc9f18c649ca98302b9257302b91309bcf [file] [log] [blame]
Dave Kleikamp470decc2006-10-11 01:20:57 -07001/*
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002 * linux/fs/jbd2/journal.c
Dave Kleikamp470decc2006-10-11 01:20:57 -07003 *
4 * Written by Stephen C. Tweedie <sct@redhat.com>, 1998
5 *
6 * Copyright 1998 Red Hat corp --- All Rights Reserved
7 *
8 * This file is part of the Linux kernel and is made available under
9 * the terms of the GNU General Public License, version 2, or at your
10 * option, any later version, incorporated herein by reference.
11 *
12 * Generic filesystem journal-writing code; part of the ext2fs
13 * journaling system.
14 *
15 * This file manages journals: areas of disk reserved for logging
16 * transactional updates. This includes the kernel journaling thread
17 * which is responsible for scheduling updates to the log.
18 *
19 * We do not actually manage the physical storage of the journal in this
20 * file: that is left to a per-journal policy function, which allows us
21 * to store the journal within a filesystem-specified area for ext2
22 * journaling (ext2 can use a reserved inode for storing the log).
23 */
24
25#include <linux/module.h>
26#include <linux/time.h>
27#include <linux/fs.h>
Mingming Caof7f4bcc2006-10-11 01:20:59 -070028#include <linux/jbd2.h>
Dave Kleikamp470decc2006-10-11 01:20:57 -070029#include <linux/errno.h>
30#include <linux/slab.h>
Dave Kleikamp470decc2006-10-11 01:20:57 -070031#include <linux/init.h>
32#include <linux/mm.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080033#include <linux/freezer.h>
Dave Kleikamp470decc2006-10-11 01:20:57 -070034#include <linux/pagemap.h>
35#include <linux/kthread.h>
36#include <linux/poison.h>
37#include <linux/proc_fs.h>
Jose R. Santos0f49d5d2007-07-18 08:50:18 -040038#include <linux/debugfs.h>
Johann Lombardi8e85fb32008-01-28 23:58:27 -050039#include <linux/seq_file.h>
Simon Holm Thøgersenc225aa52009-01-11 22:34:01 -050040#include <linux/math64.h>
Theodore Ts'o879c5e62009-06-17 11:47:48 -040041#include <linux/hash.h>
Theodore Ts'od2eecb02009-12-07 10:36:20 -050042#include <linux/log2.h>
43#include <linux/vmalloc.h>
Theodore Ts'o47def822010-07-27 11:56:05 -040044#include <linux/backing-dev.h>
Brian King39e3ac22010-10-27 21:25:12 -040045#include <linux/bitops.h>
Theodore Ts'o670be5a2010-12-17 10:44:16 -050046#include <linux/ratelimit.h>
Theodore Ts'o879c5e62009-06-17 11:47:48 -040047
48#define CREATE_TRACE_POINTS
49#include <trace/events/jbd2.h>
Dave Kleikamp470decc2006-10-11 01:20:57 -070050
51#include <asm/uaccess.h>
52#include <asm/page.h>
Brian King39e3ac22010-10-27 21:25:12 -040053#include <asm/system.h>
Dave Kleikamp470decc2006-10-11 01:20:57 -070054
Mingming Caof7f4bcc2006-10-11 01:20:59 -070055EXPORT_SYMBOL(jbd2_journal_extend);
56EXPORT_SYMBOL(jbd2_journal_stop);
57EXPORT_SYMBOL(jbd2_journal_lock_updates);
58EXPORT_SYMBOL(jbd2_journal_unlock_updates);
59EXPORT_SYMBOL(jbd2_journal_get_write_access);
60EXPORT_SYMBOL(jbd2_journal_get_create_access);
61EXPORT_SYMBOL(jbd2_journal_get_undo_access);
Joel Beckere06c8222008-09-11 15:35:47 -070062EXPORT_SYMBOL(jbd2_journal_set_triggers);
Mingming Caof7f4bcc2006-10-11 01:20:59 -070063EXPORT_SYMBOL(jbd2_journal_dirty_metadata);
64EXPORT_SYMBOL(jbd2_journal_release_buffer);
65EXPORT_SYMBOL(jbd2_journal_forget);
Dave Kleikamp470decc2006-10-11 01:20:57 -070066#if 0
67EXPORT_SYMBOL(journal_sync_buffer);
68#endif
Mingming Caof7f4bcc2006-10-11 01:20:59 -070069EXPORT_SYMBOL(jbd2_journal_flush);
70EXPORT_SYMBOL(jbd2_journal_revoke);
Dave Kleikamp470decc2006-10-11 01:20:57 -070071
Mingming Caof7f4bcc2006-10-11 01:20:59 -070072EXPORT_SYMBOL(jbd2_journal_init_dev);
73EXPORT_SYMBOL(jbd2_journal_init_inode);
Mingming Caof7f4bcc2006-10-11 01:20:59 -070074EXPORT_SYMBOL(jbd2_journal_check_used_features);
75EXPORT_SYMBOL(jbd2_journal_check_available_features);
76EXPORT_SYMBOL(jbd2_journal_set_features);
Mingming Caof7f4bcc2006-10-11 01:20:59 -070077EXPORT_SYMBOL(jbd2_journal_load);
78EXPORT_SYMBOL(jbd2_journal_destroy);
Mingming Caof7f4bcc2006-10-11 01:20:59 -070079EXPORT_SYMBOL(jbd2_journal_abort);
80EXPORT_SYMBOL(jbd2_journal_errno);
81EXPORT_SYMBOL(jbd2_journal_ack_err);
82EXPORT_SYMBOL(jbd2_journal_clear_err);
83EXPORT_SYMBOL(jbd2_log_wait_commit);
Theodore Ts'o3b799d12009-12-09 20:42:53 -050084EXPORT_SYMBOL(jbd2_log_start_commit);
Mingming Caof7f4bcc2006-10-11 01:20:59 -070085EXPORT_SYMBOL(jbd2_journal_start_commit);
86EXPORT_SYMBOL(jbd2_journal_force_commit_nested);
87EXPORT_SYMBOL(jbd2_journal_wipe);
88EXPORT_SYMBOL(jbd2_journal_blocks_per_page);
89EXPORT_SYMBOL(jbd2_journal_invalidatepage);
90EXPORT_SYMBOL(jbd2_journal_try_to_free_buffers);
91EXPORT_SYMBOL(jbd2_journal_force_commit);
Jan Karac851ed52008-07-11 19:27:31 -040092EXPORT_SYMBOL(jbd2_journal_file_inode);
93EXPORT_SYMBOL(jbd2_journal_init_jbd_inode);
94EXPORT_SYMBOL(jbd2_journal_release_jbd_inode);
95EXPORT_SYMBOL(jbd2_journal_begin_ordered_truncate);
Theodore Ts'o8aefcd52011-01-10 12:29:43 -050096EXPORT_SYMBOL(jbd2_inode_cache);
Dave Kleikamp470decc2006-10-11 01:20:57 -070097
Dave Kleikamp470decc2006-10-11 01:20:57 -070098static void __journal_abort_soft (journal_t *journal, int errno);
Theodore Ts'od2eecb02009-12-07 10:36:20 -050099static int jbd2_journal_create_slab(size_t slab_size);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700100
101/*
102 * Helper function used to manage commit timeouts
103 */
104
105static void commit_timeout(unsigned long __data)
106{
107 struct task_struct * p = (struct task_struct *) __data;
108
109 wake_up_process(p);
110}
111
112/*
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700113 * kjournald2: The main thread function used to manage a logging device
Dave Kleikamp470decc2006-10-11 01:20:57 -0700114 * journal.
115 *
116 * This kernel thread is responsible for two things:
117 *
118 * 1) COMMIT: Every so often we need to commit the current state of the
119 * filesystem to disk. The journal thread is responsible for writing
120 * all of the metadata buffers to disk.
121 *
122 * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
123 * of the data in that part of the log has been rewritten elsewhere on
124 * the disk. Flushing these old buffers to reclaim space in the log is
125 * known as checkpointing, and this thread is responsible for that job.
126 */
127
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700128static int kjournald2(void *arg)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700129{
130 journal_t *journal = arg;
131 transaction_t *transaction;
132
133 /*
134 * Set up an interval timer which can be used to trigger a commit wakeup
135 * after the commit interval expires
136 */
137 setup_timer(&journal->j_commit_timer, commit_timeout,
138 (unsigned long)current);
139
140 /* Record that the journal thread is running */
141 journal->j_task = current;
142 wake_up(&journal->j_wait_done_commit);
143
Dave Kleikamp470decc2006-10-11 01:20:57 -0700144 /*
145 * And now, wait forever for commit wakeup events.
146 */
Theodore Ts'oa931da62010-08-03 21:35:12 -0400147 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700148
149loop:
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700150 if (journal->j_flags & JBD2_UNMOUNT)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700151 goto end_loop;
152
153 jbd_debug(1, "commit_sequence=%d, commit_request=%d\n",
154 journal->j_commit_sequence, journal->j_commit_request);
155
156 if (journal->j_commit_sequence != journal->j_commit_request) {
157 jbd_debug(1, "OK, requests differ\n");
Theodore Ts'oa931da62010-08-03 21:35:12 -0400158 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700159 del_timer_sync(&journal->j_commit_timer);
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700160 jbd2_journal_commit_transaction(journal);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400161 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700162 goto loop;
163 }
164
165 wake_up(&journal->j_wait_done_commit);
166 if (freezing(current)) {
167 /*
168 * The simpler the better. Flushing journal isn't a
169 * good idea, because that depends on threads that may
170 * be already stopped.
171 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700172 jbd_debug(1, "Now suspending kjournald2\n");
Theodore Ts'oa931da62010-08-03 21:35:12 -0400173 write_unlock(&journal->j_state_lock);
Tejun Heoa0acae02011-11-21 12:32:22 -0800174 try_to_freeze();
Theodore Ts'oa931da62010-08-03 21:35:12 -0400175 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700176 } else {
177 /*
178 * We assume on resume that commits are already there,
179 * so we don't sleep
180 */
181 DEFINE_WAIT(wait);
182 int should_sleep = 1;
183
184 prepare_to_wait(&journal->j_wait_commit, &wait,
185 TASK_INTERRUPTIBLE);
186 if (journal->j_commit_sequence != journal->j_commit_request)
187 should_sleep = 0;
188 transaction = journal->j_running_transaction;
189 if (transaction && time_after_eq(jiffies,
190 transaction->t_expires))
191 should_sleep = 0;
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700192 if (journal->j_flags & JBD2_UNMOUNT)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700193 should_sleep = 0;
194 if (should_sleep) {
Theodore Ts'oa931da62010-08-03 21:35:12 -0400195 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700196 schedule();
Theodore Ts'oa931da62010-08-03 21:35:12 -0400197 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700198 }
199 finish_wait(&journal->j_wait_commit, &wait);
200 }
201
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700202 jbd_debug(1, "kjournald2 wakes\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -0700203
204 /*
205 * Were we woken up by a commit wakeup event?
206 */
207 transaction = journal->j_running_transaction;
208 if (transaction && time_after_eq(jiffies, transaction->t_expires)) {
209 journal->j_commit_request = transaction->t_tid;
210 jbd_debug(1, "woke because of timeout\n");
211 }
212 goto loop;
213
214end_loop:
Theodore Ts'oa931da62010-08-03 21:35:12 -0400215 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700216 del_timer_sync(&journal->j_commit_timer);
217 journal->j_task = NULL;
218 wake_up(&journal->j_wait_done_commit);
219 jbd_debug(1, "Journal thread exiting.\n");
220 return 0;
221}
222
Pavel Emelianov97f06782007-05-08 00:30:42 -0700223static int jbd2_journal_start_thread(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700224{
Pavel Emelianov97f06782007-05-08 00:30:42 -0700225 struct task_struct *t;
226
Theodore Ts'o90576c02009-09-29 15:51:30 -0400227 t = kthread_run(kjournald2, journal, "jbd2/%s",
228 journal->j_devname);
Pavel Emelianov97f06782007-05-08 00:30:42 -0700229 if (IS_ERR(t))
230 return PTR_ERR(t);
231
Al Viro1076d172008-03-29 03:07:18 +0000232 wait_event(journal->j_wait_done_commit, journal->j_task != NULL);
Pavel Emelianov97f06782007-05-08 00:30:42 -0700233 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700234}
235
236static void journal_kill_thread(journal_t *journal)
237{
Theodore Ts'oa931da62010-08-03 21:35:12 -0400238 write_lock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700239 journal->j_flags |= JBD2_UNMOUNT;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700240
241 while (journal->j_task) {
242 wake_up(&journal->j_wait_commit);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400243 write_unlock(&journal->j_state_lock);
Al Viro1076d172008-03-29 03:07:18 +0000244 wait_event(journal->j_wait_done_commit, journal->j_task == NULL);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400245 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700246 }
Theodore Ts'oa931da62010-08-03 21:35:12 -0400247 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700248}
249
250/*
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700251 * jbd2_journal_write_metadata_buffer: write a metadata buffer to the journal.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700252 *
253 * Writes a metadata buffer to a given disk block. The actual IO is not
254 * performed but a new buffer_head is constructed which labels the data
255 * to be written with the correct destination disk block.
256 *
257 * Any magic-number escaping which needs to be done will cause a
258 * copy-out here. If the buffer happens to start with the
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700259 * JBD2_MAGIC_NUMBER, then we can't write it to the log directly: the
Dave Kleikamp470decc2006-10-11 01:20:57 -0700260 * magic number is only written to the log for descripter blocks. In
261 * this case, we copy the data and replace the first word with 0, and we
262 * return a result code which indicates that this buffer needs to be
263 * marked as an escaped buffer in the corresponding log descriptor
264 * block. The missing word can then be restored when the block is read
265 * during recovery.
266 *
267 * If the source buffer has already been modified by a new transaction
268 * since we took the last commit snapshot, we use the frozen copy of
269 * that data for IO. If we end up using the existing buffer_head's data
270 * for the write, then we *have* to lock the buffer to prevent anyone
271 * else from using and possibly modifying it while the IO is in
272 * progress.
273 *
274 * The function returns a pointer to the buffer_heads to be used for IO.
275 *
276 * We assume that the journal has already been locked in this function.
277 *
278 * Return value:
279 * <0: Error
280 * >=0: Finished OK
281 *
282 * On success:
283 * Bit 0 set == escape performed on the data
284 * Bit 1 set == buffer copy-out performed (kfree the data after IO)
285 */
286
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700287int jbd2_journal_write_metadata_buffer(transaction_t *transaction,
Dave Kleikamp470decc2006-10-11 01:20:57 -0700288 struct journal_head *jh_in,
289 struct journal_head **jh_out,
Mingming Cao18eba7a2006-10-11 01:21:13 -0700290 unsigned long long blocknr)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700291{
292 int need_copy_out = 0;
293 int done_copy_out = 0;
294 int do_escape = 0;
295 char *mapped_data;
296 struct buffer_head *new_bh;
297 struct journal_head *new_jh;
298 struct page *new_page;
299 unsigned int new_offset;
300 struct buffer_head *bh_in = jh2bh(jh_in);
dingdinghua96577c42009-07-13 17:55:35 -0400301 journal_t *journal = transaction->t_journal;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700302
303 /*
304 * The buffer really shouldn't be locked: only the current committing
305 * transaction is allowed to write it, so nobody else is allowed
306 * to do any IO.
307 *
308 * akpm: except if we're journalling data, and write() output is
309 * also part of a shared mapping, and another thread has
310 * decided to launch a writepage() against this buffer.
311 */
312 J_ASSERT_BH(bh_in, buffer_jbddirty(bh_in));
313
Theodore Ts'o47def822010-07-27 11:56:05 -0400314retry_alloc:
315 new_bh = alloc_buffer_head(GFP_NOFS);
316 if (!new_bh) {
317 /*
318 * Failure is not an option, but __GFP_NOFAIL is going
319 * away; so we retry ourselves here.
320 */
321 congestion_wait(BLK_RW_ASYNC, HZ/50);
322 goto retry_alloc;
323 }
324
dingdinghua96577c42009-07-13 17:55:35 -0400325 /* keep subsequent assertions sane */
326 new_bh->b_state = 0;
327 init_buffer(new_bh, NULL, NULL);
328 atomic_set(&new_bh->b_count, 1);
329 new_jh = jbd2_journal_add_journal_head(new_bh); /* This sleeps */
Dave Kleikamp470decc2006-10-11 01:20:57 -0700330
331 /*
332 * If a new transaction has already done a buffer copy-out, then
333 * we use that version of the data for the commit.
334 */
335 jbd_lock_bh_state(bh_in);
336repeat:
337 if (jh_in->b_frozen_data) {
338 done_copy_out = 1;
339 new_page = virt_to_page(jh_in->b_frozen_data);
340 new_offset = offset_in_page(jh_in->b_frozen_data);
341 } else {
342 new_page = jh2bh(jh_in)->b_page;
343 new_offset = offset_in_page(jh2bh(jh_in)->b_data);
344 }
345
346 mapped_data = kmap_atomic(new_page, KM_USER0);
347 /*
Jan Kara13ceef02010-07-14 07:56:33 +0200348 * Fire data frozen trigger if data already wasn't frozen. Do this
349 * before checking for escaping, as the trigger may modify the magic
350 * offset. If a copy-out happens afterwards, it will have the correct
351 * data in the buffer.
Joel Beckere06c8222008-09-11 15:35:47 -0700352 */
Jan Kara13ceef02010-07-14 07:56:33 +0200353 if (!done_copy_out)
354 jbd2_buffer_frozen_trigger(jh_in, mapped_data + new_offset,
355 jh_in->b_triggers);
Joel Beckere06c8222008-09-11 15:35:47 -0700356
357 /*
Dave Kleikamp470decc2006-10-11 01:20:57 -0700358 * Check for escaping
359 */
360 if (*((__be32 *)(mapped_data + new_offset)) ==
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700361 cpu_to_be32(JBD2_MAGIC_NUMBER)) {
Dave Kleikamp470decc2006-10-11 01:20:57 -0700362 need_copy_out = 1;
363 do_escape = 1;
364 }
365 kunmap_atomic(mapped_data, KM_USER0);
366
367 /*
368 * Do we need to do a data copy?
369 */
370 if (need_copy_out && !done_copy_out) {
371 char *tmp;
372
373 jbd_unlock_bh_state(bh_in);
Mingming Caoaf1e76d2007-10-16 18:38:25 -0400374 tmp = jbd2_alloc(bh_in->b_size, GFP_NOFS);
Theodore Ts'oe6ec1162009-12-01 09:04:42 -0500375 if (!tmp) {
376 jbd2_journal_put_journal_head(new_jh);
377 return -ENOMEM;
378 }
Dave Kleikamp470decc2006-10-11 01:20:57 -0700379 jbd_lock_bh_state(bh_in);
380 if (jh_in->b_frozen_data) {
Mingming Caoaf1e76d2007-10-16 18:38:25 -0400381 jbd2_free(tmp, bh_in->b_size);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700382 goto repeat;
383 }
384
385 jh_in->b_frozen_data = tmp;
386 mapped_data = kmap_atomic(new_page, KM_USER0);
387 memcpy(tmp, mapped_data + new_offset, jh2bh(jh_in)->b_size);
388 kunmap_atomic(mapped_data, KM_USER0);
389
390 new_page = virt_to_page(tmp);
391 new_offset = offset_in_page(tmp);
392 done_copy_out = 1;
Joel Beckere06c8222008-09-11 15:35:47 -0700393
394 /*
395 * This isn't strictly necessary, as we're using frozen
396 * data for the escaping, but it keeps consistency with
397 * b_frozen_data usage.
398 */
399 jh_in->b_frozen_triggers = jh_in->b_triggers;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700400 }
401
402 /*
403 * Did we need to do an escaping? Now we've done all the
404 * copying, we can finally do so.
405 */
406 if (do_escape) {
407 mapped_data = kmap_atomic(new_page, KM_USER0);
408 *((unsigned int *)(mapped_data + new_offset)) = 0;
409 kunmap_atomic(mapped_data, KM_USER0);
410 }
411
Dave Kleikamp470decc2006-10-11 01:20:57 -0700412 set_bh_page(new_bh, new_page, new_offset);
413 new_jh->b_transaction = NULL;
414 new_bh->b_size = jh2bh(jh_in)->b_size;
415 new_bh->b_bdev = transaction->t_journal->j_dev;
416 new_bh->b_blocknr = blocknr;
417 set_buffer_mapped(new_bh);
418 set_buffer_dirty(new_bh);
419
420 *jh_out = new_jh;
421
422 /*
423 * The to-be-written buffer needs to get moved to the io queue,
424 * and the original buffer whose contents we are shadowing or
425 * copying is moved to the transaction's shadow queue.
426 */
427 JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
dingdinghua96577c42009-07-13 17:55:35 -0400428 spin_lock(&journal->j_list_lock);
429 __jbd2_journal_file_buffer(jh_in, transaction, BJ_Shadow);
430 spin_unlock(&journal->j_list_lock);
431 jbd_unlock_bh_state(bh_in);
432
Dave Kleikamp470decc2006-10-11 01:20:57 -0700433 JBUFFER_TRACE(new_jh, "file as BJ_IO");
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700434 jbd2_journal_file_buffer(new_jh, transaction, BJ_IO);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700435
436 return do_escape | (done_copy_out << 1);
437}
438
439/*
440 * Allocation code for the journal file. Manage the space left in the
441 * journal, so that we can begin checkpointing when appropriate.
442 */
443
444/*
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700445 * __jbd2_log_space_left: Return the number of free blocks left in the journal.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700446 *
447 * Called with the journal already locked.
448 *
449 * Called under j_state_lock
450 */
451
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700452int __jbd2_log_space_left(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700453{
454 int left = journal->j_free;
455
Theodore Ts'oa931da62010-08-03 21:35:12 -0400456 /* assert_spin_locked(&journal->j_state_lock); */
Dave Kleikamp470decc2006-10-11 01:20:57 -0700457
458 /*
459 * Be pessimistic here about the number of those free blocks which
460 * might be required for log descriptor control blocks.
461 */
462
463#define MIN_LOG_RESERVED_BLOCKS 32 /* Allow for rounding errors */
464
465 left -= MIN_LOG_RESERVED_BLOCKS;
466
467 if (left <= 0)
468 return 0;
469 left -= (left >> 3);
470 return left;
471}
472
473/*
Theodore Ts'oe4471832011-02-12 08:18:24 -0500474 * Called with j_state_lock locked for writing.
475 * Returns true if a transaction commit was started.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700476 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700477int __jbd2_log_start_commit(journal_t *journal, tid_t target)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700478{
479 /*
Theodore Ts'odeeeaf12011-05-01 18:16:26 -0400480 * The only transaction we can possibly wait upon is the
481 * currently running transaction (if it exists). Otherwise,
482 * the target tid must be an old one.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700483 */
Theodore Ts'odeeeaf12011-05-01 18:16:26 -0400484 if (journal->j_running_transaction &&
485 journal->j_running_transaction->t_tid == target) {
Dave Kleikamp470decc2006-10-11 01:20:57 -0700486 /*
Andrea Gelminibcf3d0b2010-10-16 15:19:14 +0200487 * We want a new commit: OK, mark the request and wakeup the
Dave Kleikamp470decc2006-10-11 01:20:57 -0700488 * commit thread. We do _not_ do the commit ourselves.
489 */
490
491 journal->j_commit_request = target;
Eryu Guanf2a44522011-11-01 19:09:18 -0400492 jbd_debug(1, "JBD2: requesting commit %d/%d\n",
Dave Kleikamp470decc2006-10-11 01:20:57 -0700493 journal->j_commit_request,
494 journal->j_commit_sequence);
495 wake_up(&journal->j_wait_commit);
496 return 1;
Theodore Ts'odeeeaf12011-05-01 18:16:26 -0400497 } else if (!tid_geq(journal->j_commit_request, target))
498 /* This should never happen, but if it does, preserve
499 the evidence before kjournald goes into a loop and
500 increments j_commit_sequence beyond all recognition. */
Eryu Guanf2a44522011-11-01 19:09:18 -0400501 WARN_ONCE(1, "JBD2: bad log_start_commit: %u %u %u %u\n",
Theodore Ts'o1be2add2011-05-08 19:37:54 -0400502 journal->j_commit_request,
503 journal->j_commit_sequence,
504 target, journal->j_running_transaction ?
505 journal->j_running_transaction->t_tid : 0);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700506 return 0;
507}
508
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700509int jbd2_log_start_commit(journal_t *journal, tid_t tid)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700510{
511 int ret;
512
Theodore Ts'oa931da62010-08-03 21:35:12 -0400513 write_lock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700514 ret = __jbd2_log_start_commit(journal, tid);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400515 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700516 return ret;
517}
518
519/*
520 * Force and wait upon a commit if the calling process is not within
521 * transaction. This is used for forcing out undo-protected data which contains
522 * bitmaps, when the fs is running out of space.
523 *
524 * We can only force the running transaction if we don't have an active handle;
525 * otherwise, we will deadlock.
526 *
527 * Returns true if a transaction was started.
528 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700529int jbd2_journal_force_commit_nested(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700530{
531 transaction_t *transaction = NULL;
532 tid_t tid;
Theodore Ts'oe4471832011-02-12 08:18:24 -0500533 int need_to_start = 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700534
Theodore Ts'oa931da62010-08-03 21:35:12 -0400535 read_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700536 if (journal->j_running_transaction && !current->journal_info) {
537 transaction = journal->j_running_transaction;
Theodore Ts'oe4471832011-02-12 08:18:24 -0500538 if (!tid_geq(journal->j_commit_request, transaction->t_tid))
539 need_to_start = 1;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700540 } else if (journal->j_committing_transaction)
541 transaction = journal->j_committing_transaction;
542
543 if (!transaction) {
Theodore Ts'oa931da62010-08-03 21:35:12 -0400544 read_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700545 return 0; /* Nothing to retry */
546 }
547
548 tid = transaction->t_tid;
Theodore Ts'oa931da62010-08-03 21:35:12 -0400549 read_unlock(&journal->j_state_lock);
Theodore Ts'oe4471832011-02-12 08:18:24 -0500550 if (need_to_start)
551 jbd2_log_start_commit(journal, tid);
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700552 jbd2_log_wait_commit(journal, tid);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700553 return 1;
554}
555
556/*
557 * Start a commit of the current running transaction (if any). Returns true
Jan Karac88ccea2009-02-10 11:27:46 -0500558 * if a transaction is going to be committed (or is currently already
559 * committing), and fills its tid in at *ptid
Dave Kleikamp470decc2006-10-11 01:20:57 -0700560 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700561int jbd2_journal_start_commit(journal_t *journal, tid_t *ptid)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700562{
563 int ret = 0;
564
Theodore Ts'oa931da62010-08-03 21:35:12 -0400565 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700566 if (journal->j_running_transaction) {
567 tid_t tid = journal->j_running_transaction->t_tid;
568
Jan Karac88ccea2009-02-10 11:27:46 -0500569 __jbd2_log_start_commit(journal, tid);
570 /* There's a running transaction and we've just made sure
571 * it's commit has been scheduled. */
572 if (ptid)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700573 *ptid = tid;
Jan Karac88ccea2009-02-10 11:27:46 -0500574 ret = 1;
575 } else if (journal->j_committing_transaction) {
Dave Kleikamp470decc2006-10-11 01:20:57 -0700576 /*
577 * If ext3_write_super() recently started a commit, then we
578 * have to wait for completion of that transaction
579 */
Jan Karac88ccea2009-02-10 11:27:46 -0500580 if (ptid)
581 *ptid = journal->j_committing_transaction->t_tid;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700582 ret = 1;
583 }
Theodore Ts'oa931da62010-08-03 21:35:12 -0400584 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700585 return ret;
586}
587
588/*
Jan Karabbd2be32011-05-24 11:59:18 -0400589 * Return 1 if a given transaction has not yet sent barrier request
590 * connected with a transaction commit. If 0 is returned, transaction
591 * may or may not have sent the barrier. Used to avoid sending barrier
592 * twice in common cases.
593 */
594int jbd2_trans_will_send_data_barrier(journal_t *journal, tid_t tid)
595{
596 int ret = 0;
597 transaction_t *commit_trans;
598
599 if (!(journal->j_flags & JBD2_BARRIER))
600 return 0;
601 read_lock(&journal->j_state_lock);
602 /* Transaction already committed? */
603 if (tid_geq(journal->j_commit_sequence, tid))
604 goto out;
605 commit_trans = journal->j_committing_transaction;
606 if (!commit_trans || commit_trans->t_tid != tid) {
607 ret = 1;
608 goto out;
609 }
610 /*
611 * Transaction is being committed and we already proceeded to
612 * submitting a flush to fs partition?
613 */
614 if (journal->j_fs_dev != journal->j_dev) {
615 if (!commit_trans->t_need_data_flush ||
616 commit_trans->t_state >= T_COMMIT_DFLUSH)
617 goto out;
618 } else {
619 if (commit_trans->t_state >= T_COMMIT_JFLUSH)
620 goto out;
621 }
622 ret = 1;
623out:
624 read_unlock(&journal->j_state_lock);
625 return ret;
626}
627EXPORT_SYMBOL(jbd2_trans_will_send_data_barrier);
628
629/*
Dave Kleikamp470decc2006-10-11 01:20:57 -0700630 * Wait for a specified commit to complete.
631 * The caller may not hold the journal lock.
632 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700633int jbd2_log_wait_commit(journal_t *journal, tid_t tid)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700634{
635 int err = 0;
636
Theodore Ts'oa931da62010-08-03 21:35:12 -0400637 read_lock(&journal->j_state_lock);
Jose R. Santose23291b2007-07-18 08:57:06 -0400638#ifdef CONFIG_JBD2_DEBUG
Dave Kleikamp470decc2006-10-11 01:20:57 -0700639 if (!tid_geq(journal->j_commit_request, tid)) {
640 printk(KERN_EMERG
641 "%s: error: j_commit_request=%d, tid=%d\n",
Harvey Harrison329d2912008-04-17 10:38:59 -0400642 __func__, journal->j_commit_request, tid);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700643 }
Dave Kleikamp470decc2006-10-11 01:20:57 -0700644#endif
Dave Kleikamp470decc2006-10-11 01:20:57 -0700645 while (tid_gt(tid, journal->j_commit_sequence)) {
Eryu Guanf2a44522011-11-01 19:09:18 -0400646 jbd_debug(1, "JBD2: want %d, j_commit_sequence=%d\n",
Dave Kleikamp470decc2006-10-11 01:20:57 -0700647 tid, journal->j_commit_sequence);
648 wake_up(&journal->j_wait_commit);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400649 read_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700650 wait_event(journal->j_wait_done_commit,
651 !tid_gt(tid, journal->j_commit_sequence));
Theodore Ts'oa931da62010-08-03 21:35:12 -0400652 read_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700653 }
Theodore Ts'oa931da62010-08-03 21:35:12 -0400654 read_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700655
656 if (unlikely(is_journal_aborted(journal))) {
657 printk(KERN_EMERG "journal commit I/O error\n");
658 err = -EIO;
659 }
660 return err;
661}
662
663/*
664 * Log buffer allocation routines:
665 */
666
Mingming Cao18eba7a2006-10-11 01:21:13 -0700667int jbd2_journal_next_log_block(journal_t *journal, unsigned long long *retp)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700668{
669 unsigned long blocknr;
670
Theodore Ts'oa931da62010-08-03 21:35:12 -0400671 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700672 J_ASSERT(journal->j_free > 1);
673
674 blocknr = journal->j_head;
675 journal->j_head++;
676 journal->j_free--;
677 if (journal->j_head == journal->j_last)
678 journal->j_head = journal->j_first;
Theodore Ts'oa931da62010-08-03 21:35:12 -0400679 write_unlock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700680 return jbd2_journal_bmap(journal, blocknr, retp);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700681}
682
683/*
684 * Conversion of logical to physical block numbers for the journal
685 *
686 * On external journals the journal blocks are identity-mapped, so
687 * this is a no-op. If needed, we can use j_blk_offset - everything is
688 * ready.
689 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700690int jbd2_journal_bmap(journal_t *journal, unsigned long blocknr,
Mingming Cao18eba7a2006-10-11 01:21:13 -0700691 unsigned long long *retp)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700692{
693 int err = 0;
Mingming Cao18eba7a2006-10-11 01:21:13 -0700694 unsigned long long ret;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700695
696 if (journal->j_inode) {
697 ret = bmap(journal->j_inode, blocknr);
698 if (ret)
699 *retp = ret;
700 else {
Dave Kleikamp470decc2006-10-11 01:20:57 -0700701 printk(KERN_ALERT "%s: journal block not found "
702 "at offset %lu on %s\n",
Theodore Ts'o05496762008-09-16 14:36:17 -0400703 __func__, blocknr, journal->j_devname);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700704 err = -EIO;
705 __journal_abort_soft(journal, err);
706 }
707 } else {
708 *retp = blocknr; /* +journal->j_blk_offset */
709 }
710 return err;
711}
712
713/*
714 * We play buffer_head aliasing tricks to write data/metadata blocks to
715 * the journal without copying their contents, but for journal
716 * descriptor blocks we do need to generate bona fide buffers.
717 *
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700718 * After the caller of jbd2_journal_get_descriptor_buffer() has finished modifying
Dave Kleikamp470decc2006-10-11 01:20:57 -0700719 * the buffer's contents they really should run flush_dcache_page(bh->b_page).
720 * But we don't bother doing that, so there will be coherency problems with
721 * mmaps of blockdevs which hold live JBD-controlled filesystems.
722 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700723struct journal_head *jbd2_journal_get_descriptor_buffer(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700724{
725 struct buffer_head *bh;
Mingming Cao18eba7a2006-10-11 01:21:13 -0700726 unsigned long long blocknr;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700727 int err;
728
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700729 err = jbd2_journal_next_log_block(journal, &blocknr);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700730
731 if (err)
732 return NULL;
733
734 bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
Jan Kara4b905672009-01-06 14:53:35 -0500735 if (!bh)
736 return NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700737 lock_buffer(bh);
738 memset(bh->b_data, 0, journal->j_blocksize);
739 set_buffer_uptodate(bh);
740 unlock_buffer(bh);
741 BUFFER_TRACE(bh, "return this buffer");
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700742 return jbd2_journal_add_journal_head(bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700743}
744
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500745struct jbd2_stats_proc_session {
746 journal_t *journal;
747 struct transaction_stats_s *stats;
748 int start;
749 int max;
750};
751
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500752static void *jbd2_seq_info_start(struct seq_file *seq, loff_t *pos)
753{
754 return *pos ? NULL : SEQ_START_TOKEN;
755}
756
757static void *jbd2_seq_info_next(struct seq_file *seq, void *v, loff_t *pos)
758{
759 return NULL;
760}
761
762static int jbd2_seq_info_show(struct seq_file *seq, void *v)
763{
764 struct jbd2_stats_proc_session *s = seq->private;
765
766 if (v != SEQ_START_TOKEN)
767 return 0;
Theodore Ts'obf699322009-09-30 00:32:06 -0400768 seq_printf(seq, "%lu transaction, each up to %u blocks\n",
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500769 s->stats->ts_tid,
770 s->journal->j_max_transaction_buffers);
771 if (s->stats->ts_tid == 0)
772 return 0;
773 seq_printf(seq, "average: \n %ums waiting for transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400774 jiffies_to_msecs(s->stats->run.rs_wait / s->stats->ts_tid));
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500775 seq_printf(seq, " %ums running transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400776 jiffies_to_msecs(s->stats->run.rs_running / s->stats->ts_tid));
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500777 seq_printf(seq, " %ums transaction was being locked\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400778 jiffies_to_msecs(s->stats->run.rs_locked / s->stats->ts_tid));
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500779 seq_printf(seq, " %ums flushing data (in ordered mode)\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400780 jiffies_to_msecs(s->stats->run.rs_flushing / s->stats->ts_tid));
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500781 seq_printf(seq, " %ums logging transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400782 jiffies_to_msecs(s->stats->run.rs_logging / s->stats->ts_tid));
Simon Holm Thøgersenc225aa52009-01-11 22:34:01 -0500783 seq_printf(seq, " %lluus average transaction commit time\n",
784 div_u64(s->journal->j_average_commit_time, 1000));
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500785 seq_printf(seq, " %lu handles per transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400786 s->stats->run.rs_handle_count / s->stats->ts_tid);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500787 seq_printf(seq, " %lu blocks per transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400788 s->stats->run.rs_blocks / s->stats->ts_tid);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500789 seq_printf(seq, " %lu logged blocks per transaction\n",
Theodore Ts'obf699322009-09-30 00:32:06 -0400790 s->stats->run.rs_blocks_logged / s->stats->ts_tid);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500791 return 0;
792}
793
794static void jbd2_seq_info_stop(struct seq_file *seq, void *v)
795{
796}
797
James Morris88e9d342009-09-22 16:43:43 -0700798static const struct seq_operations jbd2_seq_info_ops = {
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500799 .start = jbd2_seq_info_start,
800 .next = jbd2_seq_info_next,
801 .stop = jbd2_seq_info_stop,
802 .show = jbd2_seq_info_show,
803};
804
805static int jbd2_seq_info_open(struct inode *inode, struct file *file)
806{
807 journal_t *journal = PDE(inode)->data;
808 struct jbd2_stats_proc_session *s;
809 int rc, size;
810
811 s = kmalloc(sizeof(*s), GFP_KERNEL);
812 if (s == NULL)
813 return -ENOMEM;
814 size = sizeof(struct transaction_stats_s);
815 s->stats = kmalloc(size, GFP_KERNEL);
816 if (s->stats == NULL) {
817 kfree(s);
818 return -ENOMEM;
819 }
820 spin_lock(&journal->j_history_lock);
821 memcpy(s->stats, &journal->j_stats, size);
822 s->journal = journal;
823 spin_unlock(&journal->j_history_lock);
824
825 rc = seq_open(file, &jbd2_seq_info_ops);
826 if (rc == 0) {
827 struct seq_file *m = file->private_data;
828 m->private = s;
829 } else {
830 kfree(s->stats);
831 kfree(s);
832 }
833 return rc;
834
835}
836
837static int jbd2_seq_info_release(struct inode *inode, struct file *file)
838{
839 struct seq_file *seq = file->private_data;
840 struct jbd2_stats_proc_session *s = seq->private;
841 kfree(s->stats);
842 kfree(s);
843 return seq_release(inode, file);
844}
845
Alexey Dobriyan828c0952009-10-01 15:43:56 -0700846static const struct file_operations jbd2_seq_info_fops = {
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500847 .owner = THIS_MODULE,
848 .open = jbd2_seq_info_open,
849 .read = seq_read,
850 .llseek = seq_lseek,
851 .release = jbd2_seq_info_release,
852};
853
854static struct proc_dir_entry *proc_jbd2_stats;
855
856static void jbd2_stats_proc_init(journal_t *journal)
857{
Theodore Ts'o05496762008-09-16 14:36:17 -0400858 journal->j_proc_entry = proc_mkdir(journal->j_devname, proc_jbd2_stats);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500859 if (journal->j_proc_entry) {
Denis V. Lunev79da3662008-04-29 01:02:11 -0700860 proc_create_data("info", S_IRUGO, journal->j_proc_entry,
861 &jbd2_seq_info_fops, journal);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500862 }
863}
864
865static void jbd2_stats_proc_exit(journal_t *journal)
866{
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500867 remove_proc_entry("info", journal->j_proc_entry);
Theodore Ts'o05496762008-09-16 14:36:17 -0400868 remove_proc_entry(journal->j_devname, proc_jbd2_stats);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500869}
870
Dave Kleikamp470decc2006-10-11 01:20:57 -0700871/*
872 * Management for journal control blocks: functions to create and
873 * destroy journal_t structures, and to initialise and read existing
874 * journal blocks from disk. */
875
876/* First: create and setup a journal_t object in memory. We initialise
877 * very few fields yet: that has to wait until we have created the
878 * journal structures from from scratch, or loaded them from disk. */
879
880static journal_t * journal_init_common (void)
881{
882 journal_t *journal;
883 int err;
884
Andrew Morton3ebfdf82009-12-23 08:05:15 -0500885 journal = kzalloc(sizeof(*journal), GFP_KERNEL);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700886 if (!journal)
Theodore Ts'ob7271b02010-12-18 13:39:38 -0500887 return NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700888
889 init_waitqueue_head(&journal->j_wait_transaction_locked);
890 init_waitqueue_head(&journal->j_wait_logspace);
891 init_waitqueue_head(&journal->j_wait_done_commit);
892 init_waitqueue_head(&journal->j_wait_checkpoint);
893 init_waitqueue_head(&journal->j_wait_commit);
894 init_waitqueue_head(&journal->j_wait_updates);
895 mutex_init(&journal->j_barrier);
896 mutex_init(&journal->j_checkpoint_mutex);
897 spin_lock_init(&journal->j_revoke_lock);
898 spin_lock_init(&journal->j_list_lock);
Theodore Ts'oa931da62010-08-03 21:35:12 -0400899 rwlock_init(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700900
Mingming Caocd02ff02007-10-16 18:38:25 -0400901 journal->j_commit_interval = (HZ * JBD2_DEFAULT_MAX_COMMIT_AGE);
Theodore Ts'o30773842009-01-03 20:27:38 -0500902 journal->j_min_batch_time = 0;
903 journal->j_max_batch_time = 15000; /* 15ms */
Dave Kleikamp470decc2006-10-11 01:20:57 -0700904
905 /* The journal is marked for error until we succeed with recovery! */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700906 journal->j_flags = JBD2_ABORT;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700907
908 /* Set up a default-sized revoke table for the new mount. */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700909 err = jbd2_journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700910 if (err) {
911 kfree(journal);
Theodore Ts'ob7271b02010-12-18 13:39:38 -0500912 return NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700913 }
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500914
Theodore Ts'obf699322009-09-30 00:32:06 -0400915 spin_lock_init(&journal->j_history_lock);
Johann Lombardi8e85fb32008-01-28 23:58:27 -0500916
Dave Kleikamp470decc2006-10-11 01:20:57 -0700917 return journal;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700918}
919
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700920/* jbd2_journal_init_dev and jbd2_journal_init_inode:
Dave Kleikamp470decc2006-10-11 01:20:57 -0700921 *
922 * Create a journal structure assigned some fixed set of disk blocks to
923 * the journal. We don't actually touch those disk blocks yet, but we
924 * need to set up all of the mapping information to tell the journaling
925 * system where the journal blocks are.
926 *
927 */
928
929/**
Randy Dunlap5648ba52008-04-17 10:38:59 -0400930 * journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure
Dave Kleikamp470decc2006-10-11 01:20:57 -0700931 * @bdev: Block device on which to create the journal
932 * @fs_dev: Device which hold journalled filesystem for this journal.
933 * @start: Block nr Start of journal.
934 * @len: Length of the journal in blocks.
935 * @blocksize: blocksize of journalling device
Randy Dunlap5648ba52008-04-17 10:38:59 -0400936 *
937 * Returns: a newly created journal_t *
Dave Kleikamp470decc2006-10-11 01:20:57 -0700938 *
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700939 * jbd2_journal_init_dev creates a journal which maps a fixed contiguous
Dave Kleikamp470decc2006-10-11 01:20:57 -0700940 * range of blocks on an arbitrary block device.
941 *
942 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700943journal_t * jbd2_journal_init_dev(struct block_device *bdev,
Dave Kleikamp470decc2006-10-11 01:20:57 -0700944 struct block_device *fs_dev,
Mingming Cao18eba7a2006-10-11 01:21:13 -0700945 unsigned long long start, int len, int blocksize)
Dave Kleikamp470decc2006-10-11 01:20:57 -0700946{
947 journal_t *journal = journal_init_common();
948 struct buffer_head *bh;
Theodore Ts'o05496762008-09-16 14:36:17 -0400949 char *p;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700950 int n;
951
952 if (!journal)
953 return NULL;
954
955 /* journal descriptor can store up to n blocks -bzzz */
956 journal->j_blocksize = blocksize;
yangsheng0587aa32010-11-17 21:46:26 -0500957 journal->j_dev = bdev;
958 journal->j_fs_dev = fs_dev;
959 journal->j_blk_offset = start;
960 journal->j_maxlen = len;
961 bdevname(journal->j_dev, journal->j_devname);
962 p = journal->j_devname;
963 while ((p = strchr(p, '/')))
964 *p = '!';
Jan Kara4b905672009-01-06 14:53:35 -0500965 jbd2_stats_proc_init(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700966 n = journal->j_blocksize / sizeof(journal_block_tag_t);
967 journal->j_wbufsize = n;
968 journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
969 if (!journal->j_wbuf) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300970 printk(KERN_ERR "%s: Can't allocate bhs for commit thread\n",
Harvey Harrison329d2912008-04-17 10:38:59 -0400971 __func__);
Jan Kara4b905672009-01-06 14:53:35 -0500972 goto out_err;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700973 }
Dave Kleikamp470decc2006-10-11 01:20:57 -0700974
975 bh = __getblk(journal->j_dev, start, journal->j_blocksize);
Jan Kara4b905672009-01-06 14:53:35 -0500976 if (!bh) {
977 printk(KERN_ERR
978 "%s: Cannot get buffer for journal superblock\n",
979 __func__);
980 goto out_err;
981 }
Dave Kleikamp470decc2006-10-11 01:20:57 -0700982 journal->j_sb_buffer = bh;
983 journal->j_superblock = (journal_superblock_t *)bh->b_data;
Jan Kara4b905672009-01-06 14:53:35 -0500984
Dave Kleikamp470decc2006-10-11 01:20:57 -0700985 return journal;
Jan Kara4b905672009-01-06 14:53:35 -0500986out_err:
Tao Ma7b02bec2009-11-10 17:13:22 +0800987 kfree(journal->j_wbuf);
Jan Kara4b905672009-01-06 14:53:35 -0500988 jbd2_stats_proc_exit(journal);
989 kfree(journal);
990 return NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700991}
992
993/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700994 * journal_t * jbd2_journal_init_inode () - creates a journal which maps to a inode.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700995 * @inode: An inode to create the journal in
996 *
Mingming Caof7f4bcc2006-10-11 01:20:59 -0700997 * jbd2_journal_init_inode creates a journal which maps an on-disk inode as
Dave Kleikamp470decc2006-10-11 01:20:57 -0700998 * the journal. The inode must exist already, must support bmap() and
999 * must have all data blocks preallocated.
1000 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001001journal_t * jbd2_journal_init_inode (struct inode *inode)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001002{
1003 struct buffer_head *bh;
1004 journal_t *journal = journal_init_common();
Theodore Ts'o05496762008-09-16 14:36:17 -04001005 char *p;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001006 int err;
1007 int n;
Mingming Cao18eba7a2006-10-11 01:21:13 -07001008 unsigned long long blocknr;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001009
1010 if (!journal)
1011 return NULL;
1012
1013 journal->j_dev = journal->j_fs_dev = inode->i_sb->s_bdev;
1014 journal->j_inode = inode;
Theodore Ts'o05496762008-09-16 14:36:17 -04001015 bdevname(journal->j_dev, journal->j_devname);
1016 p = journal->j_devname;
1017 while ((p = strchr(p, '/')))
1018 *p = '!';
1019 p = journal->j_devname + strlen(journal->j_devname);
Theodore Ts'o90576c02009-09-29 15:51:30 -04001020 sprintf(p, "-%lu", journal->j_inode->i_ino);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001021 jbd_debug(1,
1022 "journal %p: inode %s/%ld, size %Ld, bits %d, blksize %ld\n",
1023 journal, inode->i_sb->s_id, inode->i_ino,
1024 (long long) inode->i_size,
1025 inode->i_sb->s_blocksize_bits, inode->i_sb->s_blocksize);
1026
1027 journal->j_maxlen = inode->i_size >> inode->i_sb->s_blocksize_bits;
1028 journal->j_blocksize = inode->i_sb->s_blocksize;
Johann Lombardi8e85fb32008-01-28 23:58:27 -05001029 jbd2_stats_proc_init(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001030
1031 /* journal descriptor can store up to n blocks -bzzz */
1032 n = journal->j_blocksize / sizeof(journal_block_tag_t);
1033 journal->j_wbufsize = n;
1034 journal->j_wbuf = kmalloc(n * sizeof(struct buffer_head*), GFP_KERNEL);
1035 if (!journal->j_wbuf) {
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001036 printk(KERN_ERR "%s: Can't allocate bhs for commit thread\n",
Harvey Harrison329d2912008-04-17 10:38:59 -04001037 __func__);
Jan Kara4b905672009-01-06 14:53:35 -05001038 goto out_err;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001039 }
1040
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001041 err = jbd2_journal_bmap(journal, 0, &blocknr);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001042 /* If that failed, give up */
1043 if (err) {
Justin P. Mattock3c26bdb2011-02-26 20:34:05 -08001044 printk(KERN_ERR "%s: Cannot locate journal superblock\n",
Harvey Harrison329d2912008-04-17 10:38:59 -04001045 __func__);
Jan Kara4b905672009-01-06 14:53:35 -05001046 goto out_err;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001047 }
1048
1049 bh = __getblk(journal->j_dev, blocknr, journal->j_blocksize);
Jan Kara4b905672009-01-06 14:53:35 -05001050 if (!bh) {
1051 printk(KERN_ERR
1052 "%s: Cannot get buffer for journal superblock\n",
1053 __func__);
1054 goto out_err;
1055 }
Dave Kleikamp470decc2006-10-11 01:20:57 -07001056 journal->j_sb_buffer = bh;
1057 journal->j_superblock = (journal_superblock_t *)bh->b_data;
1058
1059 return journal;
Jan Kara4b905672009-01-06 14:53:35 -05001060out_err:
Tao Ma7b02bec2009-11-10 17:13:22 +08001061 kfree(journal->j_wbuf);
Jan Kara4b905672009-01-06 14:53:35 -05001062 jbd2_stats_proc_exit(journal);
1063 kfree(journal);
1064 return NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001065}
1066
1067/*
1068 * If the journal init or create aborts, we need to mark the journal
1069 * superblock as being NULL to prevent the journal destroy from writing
1070 * back a bogus superblock.
1071 */
1072static void journal_fail_superblock (journal_t *journal)
1073{
1074 struct buffer_head *bh = journal->j_sb_buffer;
1075 brelse(bh);
1076 journal->j_sb_buffer = NULL;
1077}
1078
1079/*
1080 * Given a journal_t structure, initialise the various fields for
1081 * startup of a new journaling session. We use this both when creating
1082 * a journal, and after recovering an old journal to reset it for
1083 * subsequent use.
1084 */
1085
1086static int journal_reset(journal_t *journal)
1087{
1088 journal_superblock_t *sb = journal->j_superblock;
Mingming Cao18eba7a2006-10-11 01:21:13 -07001089 unsigned long long first, last;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001090
1091 first = be32_to_cpu(sb->s_first);
1092 last = be32_to_cpu(sb->s_maxlen);
Jan Karaf6f50e22009-07-17 10:40:01 -04001093 if (first + JBD2_MIN_JOURNAL_BLOCKS > last + 1) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001094 printk(KERN_ERR "JBD2: Journal too short (blocks %llu-%llu).\n",
Jan Karaf6f50e22009-07-17 10:40:01 -04001095 first, last);
1096 journal_fail_superblock(journal);
1097 return -EINVAL;
1098 }
Dave Kleikamp470decc2006-10-11 01:20:57 -07001099
1100 journal->j_first = first;
1101 journal->j_last = last;
1102
1103 journal->j_head = first;
1104 journal->j_tail = first;
1105 journal->j_free = last - first;
1106
1107 journal->j_tail_sequence = journal->j_transaction_sequence;
1108 journal->j_commit_sequence = journal->j_transaction_sequence - 1;
1109 journal->j_commit_request = journal->j_commit_sequence;
1110
1111 journal->j_max_transaction_buffers = journal->j_maxlen / 4;
1112
Dave Kleikamp470decc2006-10-11 01:20:57 -07001113 /*
1114 * As a special case, if the on-disk copy is already marked as needing
Jan Kara24bcc892012-03-13 15:41:04 -04001115 * no recovery (s_start == 0), then we can safely defer the superblock
1116 * update until the next commit by setting JBD2_FLUSHED. This avoids
Dave Kleikamp470decc2006-10-11 01:20:57 -07001117 * attempting a write to a potential-readonly device.
1118 */
Jan Kara24bcc892012-03-13 15:41:04 -04001119 if (sb->s_start == 0) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001120 jbd_debug(1, "JBD2: Skipping superblock update on recovered sb "
Dave Kleikamp470decc2006-10-11 01:20:57 -07001121 "(start %ld, seq %d, errno %d)\n",
1122 journal->j_tail, journal->j_tail_sequence,
1123 journal->j_errno);
Jan Kara24bcc892012-03-13 15:41:04 -04001124 journal->j_flags |= JBD2_FLUSHED;
1125 } else {
Jan Karaa78bb112012-03-13 15:43:04 -04001126 /* Lock here to make assertions happy... */
1127 mutex_lock(&journal->j_checkpoint_mutex);
Jan Kara24bcc892012-03-13 15:41:04 -04001128 /* Add the dynamic fields and write it to disk. */
1129 jbd2_journal_update_sb_log_tail(journal);
Jan Karaa78bb112012-03-13 15:43:04 -04001130 mutex_unlock(&journal->j_checkpoint_mutex);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001131 }
Jan Kara24bcc892012-03-13 15:41:04 -04001132 return jbd2_journal_start_thread(journal);
1133}
Dave Kleikamp470decc2006-10-11 01:20:57 -07001134
Jan Kara24bcc892012-03-13 15:41:04 -04001135static void jbd2_write_superblock(journal_t *journal)
1136{
1137 struct buffer_head *bh = journal->j_sb_buffer;
1138
1139 trace_jbd2_write_superblock(journal);
Theodore Ts'o914258b2008-10-06 21:35:40 -04001140 if (buffer_write_io_error(bh)) {
1141 /*
1142 * Oh, dear. A previous attempt to write the journal
1143 * superblock failed. This could happen because the
1144 * USB device was yanked out. Or it could happen to
1145 * be a transient write error and maybe the block will
1146 * be remapped. Nothing we can do but to retry the
1147 * write and hope for the best.
1148 */
1149 printk(KERN_ERR "JBD2: previous I/O error detected "
1150 "for journal superblock update for %s.\n",
1151 journal->j_devname);
1152 clear_buffer_write_io_error(bh);
1153 set_buffer_uptodate(bh);
1154 }
1155
Jan Kara24bcc892012-03-13 15:41:04 -04001156 BUFFER_TRACE(bh, "marking dirty");
1157 mark_buffer_dirty(bh);
1158 sync_dirty_buffer(bh);
1159 if (buffer_write_io_error(bh)) {
1160 printk(KERN_ERR "JBD2: I/O error detected "
1161 "when updating journal superblock for %s.\n",
1162 journal->j_devname);
1163 clear_buffer_write_io_error(bh);
1164 set_buffer_uptodate(bh);
1165 }
1166}
1167
1168/**
1169 * jbd2_journal_update_sb_log_tail() - Update log tail in journal sb on disk.
1170 * @journal: The journal to update.
1171 *
1172 * Update a journal's superblock information about log tail and write it to
1173 * disk, waiting for the IO to complete.
1174 */
1175void jbd2_journal_update_sb_log_tail(journal_t *journal)
1176{
1177 journal_superblock_t *sb = journal->j_superblock;
1178
Jan Karaa78bb112012-03-13 15:43:04 -04001179 BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
Theodore Ts'oa931da62010-08-03 21:35:12 -04001180 read_lock(&journal->j_state_lock);
Jan Kara24bcc892012-03-13 15:41:04 -04001181 jbd_debug(1, "JBD2: updating superblock (start %ld, seq %d)\n",
1182 journal->j_tail, journal->j_tail_sequence);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001183
1184 sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
1185 sb->s_start = cpu_to_be32(journal->j_tail);
Jan Kara24bcc892012-03-13 15:41:04 -04001186 read_unlock(&journal->j_state_lock);
1187
1188 jbd2_write_superblock(journal);
1189
1190 /* Log is no longer empty */
1191 write_lock(&journal->j_state_lock);
1192 WARN_ON(!sb->s_sequence);
1193 journal->j_flags &= ~JBD2_FLUSHED;
1194 write_unlock(&journal->j_state_lock);
1195}
1196
1197/**
1198 * jbd2_mark_journal_empty() - Mark on disk journal as empty.
1199 * @journal: The journal to update.
1200 *
1201 * Update a journal's dynamic superblock fields to show that journal is empty.
1202 * Write updated superblock to disk waiting for IO to complete.
1203 */
1204static void jbd2_mark_journal_empty(journal_t *journal)
1205{
1206 journal_superblock_t *sb = journal->j_superblock;
1207
Jan Karaa78bb112012-03-13 15:43:04 -04001208 BUG_ON(!mutex_is_locked(&journal->j_checkpoint_mutex));
Jan Kara24bcc892012-03-13 15:41:04 -04001209 read_lock(&journal->j_state_lock);
1210 jbd_debug(1, "JBD2: Marking journal as empty (seq %d)\n",
1211 journal->j_tail_sequence);
1212
1213 sb->s_sequence = cpu_to_be32(journal->j_tail_sequence);
1214 sb->s_start = cpu_to_be32(0);
1215 read_unlock(&journal->j_state_lock);
1216
1217 jbd2_write_superblock(journal);
1218
1219 /* Log is no longer empty */
1220 write_lock(&journal->j_state_lock);
1221 journal->j_flags |= JBD2_FLUSHED;
1222 write_unlock(&journal->j_state_lock);
1223}
1224
1225
1226/**
1227 * jbd2_journal_update_sb_errno() - Update error in the journal.
1228 * @journal: The journal to update.
1229 *
1230 * Update a journal's errno. Write updated superblock to disk waiting for IO
1231 * to complete.
1232 */
1233static void jbd2_journal_update_sb_errno(journal_t *journal)
1234{
1235 journal_superblock_t *sb = journal->j_superblock;
1236
1237 read_lock(&journal->j_state_lock);
1238 jbd_debug(1, "JBD2: updating superblock error (errno %d)\n",
1239 journal->j_errno);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001240 sb->s_errno = cpu_to_be32(journal->j_errno);
Theodore Ts'oa931da62010-08-03 21:35:12 -04001241 read_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001242
Jan Kara24bcc892012-03-13 15:41:04 -04001243 jbd2_write_superblock(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001244}
1245
1246/*
1247 * Read the superblock for a given journal, performing initial
1248 * validation of the format.
1249 */
Dave Kleikamp470decc2006-10-11 01:20:57 -07001250static int journal_get_superblock(journal_t *journal)
1251{
1252 struct buffer_head *bh;
1253 journal_superblock_t *sb;
1254 int err = -EIO;
1255
1256 bh = journal->j_sb_buffer;
1257
1258 J_ASSERT(bh != NULL);
1259 if (!buffer_uptodate(bh)) {
1260 ll_rw_block(READ, 1, &bh);
1261 wait_on_buffer(bh);
1262 if (!buffer_uptodate(bh)) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001263 printk(KERN_ERR
1264 "JBD2: IO error reading journal superblock\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001265 goto out;
1266 }
1267 }
1268
1269 sb = journal->j_superblock;
1270
1271 err = -EINVAL;
1272
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001273 if (sb->s_header.h_magic != cpu_to_be32(JBD2_MAGIC_NUMBER) ||
Dave Kleikamp470decc2006-10-11 01:20:57 -07001274 sb->s_blocksize != cpu_to_be32(journal->j_blocksize)) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001275 printk(KERN_WARNING "JBD2: no valid journal superblock found\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001276 goto out;
1277 }
1278
1279 switch(be32_to_cpu(sb->s_header.h_blocktype)) {
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001280 case JBD2_SUPERBLOCK_V1:
Dave Kleikamp470decc2006-10-11 01:20:57 -07001281 journal->j_format_version = 1;
1282 break;
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001283 case JBD2_SUPERBLOCK_V2:
Dave Kleikamp470decc2006-10-11 01:20:57 -07001284 journal->j_format_version = 2;
1285 break;
1286 default:
Eryu Guanf2a44522011-11-01 19:09:18 -04001287 printk(KERN_WARNING "JBD2: unrecognised superblock format ID\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001288 goto out;
1289 }
1290
1291 if (be32_to_cpu(sb->s_maxlen) < journal->j_maxlen)
1292 journal->j_maxlen = be32_to_cpu(sb->s_maxlen);
1293 else if (be32_to_cpu(sb->s_maxlen) > journal->j_maxlen) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001294 printk(KERN_WARNING "JBD2: journal file too short\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001295 goto out;
1296 }
1297
Eryu Guan87622022011-11-01 19:04:59 -04001298 if (be32_to_cpu(sb->s_first) == 0 ||
1299 be32_to_cpu(sb->s_first) >= journal->j_maxlen) {
1300 printk(KERN_WARNING
1301 "JBD2: Invalid start block of journal: %u\n",
1302 be32_to_cpu(sb->s_first));
1303 goto out;
1304 }
1305
Dave Kleikamp470decc2006-10-11 01:20:57 -07001306 return 0;
1307
1308out:
1309 journal_fail_superblock(journal);
1310 return err;
1311}
1312
1313/*
1314 * Load the on-disk journal superblock and read the key fields into the
1315 * journal_t.
1316 */
1317
1318static int load_superblock(journal_t *journal)
1319{
1320 int err;
1321 journal_superblock_t *sb;
1322
1323 err = journal_get_superblock(journal);
1324 if (err)
1325 return err;
1326
1327 sb = journal->j_superblock;
1328
1329 journal->j_tail_sequence = be32_to_cpu(sb->s_sequence);
1330 journal->j_tail = be32_to_cpu(sb->s_start);
1331 journal->j_first = be32_to_cpu(sb->s_first);
1332 journal->j_last = be32_to_cpu(sb->s_maxlen);
1333 journal->j_errno = be32_to_cpu(sb->s_errno);
1334
1335 return 0;
1336}
1337
1338
1339/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001340 * int jbd2_journal_load() - Read journal from disk.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001341 * @journal: Journal to act on.
1342 *
1343 * Given a journal_t structure which tells us which disk blocks contain
1344 * a journal, read the journal from disk to initialise the in-memory
1345 * structures.
1346 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001347int jbd2_journal_load(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001348{
1349 int err;
1350 journal_superblock_t *sb;
1351
1352 err = load_superblock(journal);
1353 if (err)
1354 return err;
1355
1356 sb = journal->j_superblock;
1357 /* If this is a V2 superblock, then we have to check the
1358 * features flags on it. */
1359
1360 if (journal->j_format_version >= 2) {
1361 if ((sb->s_feature_ro_compat &
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001362 ~cpu_to_be32(JBD2_KNOWN_ROCOMPAT_FEATURES)) ||
Dave Kleikamp470decc2006-10-11 01:20:57 -07001363 (sb->s_feature_incompat &
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001364 ~cpu_to_be32(JBD2_KNOWN_INCOMPAT_FEATURES))) {
Eryu Guanf2a44522011-11-01 19:09:18 -04001365 printk(KERN_WARNING
1366 "JBD2: Unrecognised features on journal\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001367 return -EINVAL;
1368 }
1369 }
1370
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001371 /*
1372 * Create a slab for this blocksize
1373 */
1374 err = jbd2_journal_create_slab(be32_to_cpu(sb->s_blocksize));
1375 if (err)
1376 return err;
1377
Dave Kleikamp470decc2006-10-11 01:20:57 -07001378 /* Let the recovery code check whether it needs to recover any
1379 * data from the journal. */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001380 if (jbd2_journal_recover(journal))
Dave Kleikamp470decc2006-10-11 01:20:57 -07001381 goto recovery_error;
1382
Theodore Ts'oe6a47422009-11-15 15:31:37 -05001383 if (journal->j_failed_commit) {
1384 printk(KERN_ERR "JBD2: journal transaction %u on %s "
1385 "is corrupt.\n", journal->j_failed_commit,
1386 journal->j_devname);
1387 return -EIO;
1388 }
1389
Dave Kleikamp470decc2006-10-11 01:20:57 -07001390 /* OK, we've finished with the dynamic journal bits:
1391 * reinitialise the dynamic contents of the superblock in memory
1392 * and reset them on disk. */
1393 if (journal_reset(journal))
1394 goto recovery_error;
1395
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001396 journal->j_flags &= ~JBD2_ABORT;
1397 journal->j_flags |= JBD2_LOADED;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001398 return 0;
1399
1400recovery_error:
Eryu Guanf2a44522011-11-01 19:09:18 -04001401 printk(KERN_WARNING "JBD2: recovery failed\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07001402 return -EIO;
1403}
1404
1405/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001406 * void jbd2_journal_destroy() - Release a journal_t structure.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001407 * @journal: Journal to act on.
1408 *
1409 * Release a journal_t structure once it is no longer in use by the
1410 * journaled object.
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001411 * Return <0 if we couldn't clean up the journal.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001412 */
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001413int jbd2_journal_destroy(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001414{
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001415 int err = 0;
1416
Dave Kleikamp470decc2006-10-11 01:20:57 -07001417 /* Wait for the commit thread to wake up and die. */
1418 journal_kill_thread(journal);
1419
1420 /* Force a final log commit */
1421 if (journal->j_running_transaction)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001422 jbd2_journal_commit_transaction(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001423
1424 /* Force any old transactions to disk */
1425
1426 /* Totally anal locking here... */
1427 spin_lock(&journal->j_list_lock);
1428 while (journal->j_checkpoint_transactions != NULL) {
1429 spin_unlock(&journal->j_list_lock);
Theodore Ts'o1a0d3782008-11-05 00:09:22 -05001430 mutex_lock(&journal->j_checkpoint_mutex);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001431 jbd2_log_do_checkpoint(journal);
Theodore Ts'o1a0d3782008-11-05 00:09:22 -05001432 mutex_unlock(&journal->j_checkpoint_mutex);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001433 spin_lock(&journal->j_list_lock);
1434 }
1435
1436 J_ASSERT(journal->j_running_transaction == NULL);
1437 J_ASSERT(journal->j_committing_transaction == NULL);
1438 J_ASSERT(journal->j_checkpoint_transactions == NULL);
1439 spin_unlock(&journal->j_list_lock);
1440
Dave Kleikamp470decc2006-10-11 01:20:57 -07001441 if (journal->j_sb_buffer) {
Jan Karaa78bb112012-03-13 15:43:04 -04001442 if (!is_journal_aborted(journal)) {
1443 mutex_lock(&journal->j_checkpoint_mutex);
Jan Kara24bcc892012-03-13 15:41:04 -04001444 jbd2_mark_journal_empty(journal);
Jan Karaa78bb112012-03-13 15:43:04 -04001445 mutex_unlock(&journal->j_checkpoint_mutex);
1446 } else
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001447 err = -EIO;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001448 brelse(journal->j_sb_buffer);
1449 }
1450
Johann Lombardi8e85fb32008-01-28 23:58:27 -05001451 if (journal->j_proc_entry)
1452 jbd2_stats_proc_exit(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001453 if (journal->j_inode)
1454 iput(journal->j_inode);
1455 if (journal->j_revoke)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001456 jbd2_journal_destroy_revoke(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001457 kfree(journal->j_wbuf);
1458 kfree(journal);
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001459
1460 return err;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001461}
1462
1463
1464/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001465 *int jbd2_journal_check_used_features () - Check if features specified are used.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001466 * @journal: Journal to check.
1467 * @compat: bitmask of compatible features
1468 * @ro: bitmask of features that force read-only mount
1469 * @incompat: bitmask of incompatible features
1470 *
1471 * Check whether the journal uses all of a given set of
1472 * features. Return true (non-zero) if it does.
1473 **/
1474
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001475int jbd2_journal_check_used_features (journal_t *journal, unsigned long compat,
Dave Kleikamp470decc2006-10-11 01:20:57 -07001476 unsigned long ro, unsigned long incompat)
1477{
1478 journal_superblock_t *sb;
1479
1480 if (!compat && !ro && !incompat)
1481 return 1;
Patrick J. LoPresti1113e1b2010-07-22 15:04:16 -07001482 /* Load journal superblock if it is not loaded yet. */
1483 if (journal->j_format_version == 0 &&
1484 journal_get_superblock(journal) != 0)
1485 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001486 if (journal->j_format_version == 1)
1487 return 0;
1488
1489 sb = journal->j_superblock;
1490
1491 if (((be32_to_cpu(sb->s_feature_compat) & compat) == compat) &&
1492 ((be32_to_cpu(sb->s_feature_ro_compat) & ro) == ro) &&
1493 ((be32_to_cpu(sb->s_feature_incompat) & incompat) == incompat))
1494 return 1;
1495
1496 return 0;
1497}
1498
1499/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001500 * int jbd2_journal_check_available_features() - Check feature set in journalling layer
Dave Kleikamp470decc2006-10-11 01:20:57 -07001501 * @journal: Journal to check.
1502 * @compat: bitmask of compatible features
1503 * @ro: bitmask of features that force read-only mount
1504 * @incompat: bitmask of incompatible features
1505 *
1506 * Check whether the journaling code supports the use of
1507 * all of a given set of features on this journal. Return true
1508 * (non-zero) if it can. */
1509
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001510int jbd2_journal_check_available_features (journal_t *journal, unsigned long compat,
Dave Kleikamp470decc2006-10-11 01:20:57 -07001511 unsigned long ro, unsigned long incompat)
1512{
Dave Kleikamp470decc2006-10-11 01:20:57 -07001513 if (!compat && !ro && !incompat)
1514 return 1;
1515
Dave Kleikamp470decc2006-10-11 01:20:57 -07001516 /* We can support any known requested features iff the
1517 * superblock is in version 2. Otherwise we fail to support any
1518 * extended sb features. */
1519
1520 if (journal->j_format_version != 2)
1521 return 0;
1522
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001523 if ((compat & JBD2_KNOWN_COMPAT_FEATURES) == compat &&
1524 (ro & JBD2_KNOWN_ROCOMPAT_FEATURES) == ro &&
1525 (incompat & JBD2_KNOWN_INCOMPAT_FEATURES) == incompat)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001526 return 1;
1527
1528 return 0;
1529}
1530
1531/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001532 * int jbd2_journal_set_features () - Mark a given journal feature in the superblock
Dave Kleikamp470decc2006-10-11 01:20:57 -07001533 * @journal: Journal to act on.
1534 * @compat: bitmask of compatible features
1535 * @ro: bitmask of features that force read-only mount
1536 * @incompat: bitmask of incompatible features
1537 *
1538 * Mark a given journal feature as present on the
1539 * superblock. Returns true if the requested features could be set.
1540 *
1541 */
1542
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001543int jbd2_journal_set_features (journal_t *journal, unsigned long compat,
Dave Kleikamp470decc2006-10-11 01:20:57 -07001544 unsigned long ro, unsigned long incompat)
1545{
1546 journal_superblock_t *sb;
1547
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001548 if (jbd2_journal_check_used_features(journal, compat, ro, incompat))
Dave Kleikamp470decc2006-10-11 01:20:57 -07001549 return 1;
1550
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001551 if (!jbd2_journal_check_available_features(journal, compat, ro, incompat))
Dave Kleikamp470decc2006-10-11 01:20:57 -07001552 return 0;
1553
1554 jbd_debug(1, "Setting new features 0x%lx/0x%lx/0x%lx\n",
1555 compat, ro, incompat);
1556
1557 sb = journal->j_superblock;
1558
1559 sb->s_feature_compat |= cpu_to_be32(compat);
1560 sb->s_feature_ro_compat |= cpu_to_be32(ro);
1561 sb->s_feature_incompat |= cpu_to_be32(incompat);
1562
1563 return 1;
1564}
1565
Girish Shilamkar818d2762008-01-28 23:58:27 -05001566/*
1567 * jbd2_journal_clear_features () - Clear a given journal feature in the
1568 * superblock
1569 * @journal: Journal to act on.
1570 * @compat: bitmask of compatible features
1571 * @ro: bitmask of features that force read-only mount
1572 * @incompat: bitmask of incompatible features
1573 *
1574 * Clear a given journal feature as present on the
1575 * superblock.
1576 */
1577void jbd2_journal_clear_features(journal_t *journal, unsigned long compat,
1578 unsigned long ro, unsigned long incompat)
1579{
1580 journal_superblock_t *sb;
1581
1582 jbd_debug(1, "Clear features 0x%lx/0x%lx/0x%lx\n",
1583 compat, ro, incompat);
1584
1585 sb = journal->j_superblock;
1586
1587 sb->s_feature_compat &= ~cpu_to_be32(compat);
1588 sb->s_feature_ro_compat &= ~cpu_to_be32(ro);
1589 sb->s_feature_incompat &= ~cpu_to_be32(incompat);
1590}
1591EXPORT_SYMBOL(jbd2_journal_clear_features);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001592
1593/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001594 * int jbd2_journal_flush () - Flush journal
Dave Kleikamp470decc2006-10-11 01:20:57 -07001595 * @journal: Journal to act on.
1596 *
1597 * Flush all data for a given journal to disk and empty the journal.
1598 * Filesystems can use this when remounting readonly to ensure that
1599 * recovery does not need to happen on remount.
1600 */
1601
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001602int jbd2_journal_flush(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001603{
1604 int err = 0;
1605 transaction_t *transaction = NULL;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001606
Theodore Ts'oa931da62010-08-03 21:35:12 -04001607 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001608
1609 /* Force everything buffered to the log... */
1610 if (journal->j_running_transaction) {
1611 transaction = journal->j_running_transaction;
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001612 __jbd2_log_start_commit(journal, transaction->t_tid);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001613 } else if (journal->j_committing_transaction)
1614 transaction = journal->j_committing_transaction;
1615
1616 /* Wait for the log commit to complete... */
1617 if (transaction) {
1618 tid_t tid = transaction->t_tid;
1619
Theodore Ts'oa931da62010-08-03 21:35:12 -04001620 write_unlock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001621 jbd2_log_wait_commit(journal, tid);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001622 } else {
Theodore Ts'oa931da62010-08-03 21:35:12 -04001623 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001624 }
1625
1626 /* ...and flush everything in the log out to disk. */
1627 spin_lock(&journal->j_list_lock);
1628 while (!err && journal->j_checkpoint_transactions != NULL) {
1629 spin_unlock(&journal->j_list_lock);
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001630 mutex_lock(&journal->j_checkpoint_mutex);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001631 err = jbd2_log_do_checkpoint(journal);
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001632 mutex_unlock(&journal->j_checkpoint_mutex);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001633 spin_lock(&journal->j_list_lock);
1634 }
1635 spin_unlock(&journal->j_list_lock);
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001636
1637 if (is_journal_aborted(journal))
1638 return -EIO;
1639
Jan Karaa78bb112012-03-13 15:43:04 -04001640 mutex_lock(&journal->j_checkpoint_mutex);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001641 jbd2_cleanup_journal_tail(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001642
1643 /* Finally, mark the journal as really needing no recovery.
1644 * This sets s_start==0 in the underlying superblock, which is
1645 * the magic code for a fully-recovered superblock. Any future
1646 * commits of data to the journal will restore the current
1647 * s_start value. */
Jan Kara24bcc892012-03-13 15:41:04 -04001648 jbd2_mark_journal_empty(journal);
Jan Karaa78bb112012-03-13 15:43:04 -04001649 mutex_unlock(&journal->j_checkpoint_mutex);
Theodore Ts'oa931da62010-08-03 21:35:12 -04001650 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001651 J_ASSERT(!journal->j_running_transaction);
1652 J_ASSERT(!journal->j_committing_transaction);
1653 J_ASSERT(!journal->j_checkpoint_transactions);
1654 J_ASSERT(journal->j_head == journal->j_tail);
1655 J_ASSERT(journal->j_tail_sequence == journal->j_transaction_sequence);
Theodore Ts'oa931da62010-08-03 21:35:12 -04001656 write_unlock(&journal->j_state_lock);
Hidehiro Kawai44519fa2008-10-10 20:29:13 -04001657 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001658}
1659
1660/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001661 * int jbd2_journal_wipe() - Wipe journal contents
Dave Kleikamp470decc2006-10-11 01:20:57 -07001662 * @journal: Journal to act on.
1663 * @write: flag (see below)
1664 *
1665 * Wipe out all of the contents of a journal, safely. This will produce
1666 * a warning if the journal contains any valid recovery information.
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001667 * Must be called between journal_init_*() and jbd2_journal_load().
Dave Kleikamp470decc2006-10-11 01:20:57 -07001668 *
1669 * If 'write' is non-zero, then we wipe out the journal on disk; otherwise
1670 * we merely suppress recovery.
1671 */
1672
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001673int jbd2_journal_wipe(journal_t *journal, int write)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001674{
Dave Kleikamp470decc2006-10-11 01:20:57 -07001675 int err = 0;
1676
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001677 J_ASSERT (!(journal->j_flags & JBD2_LOADED));
Dave Kleikamp470decc2006-10-11 01:20:57 -07001678
1679 err = load_superblock(journal);
1680 if (err)
1681 return err;
1682
Dave Kleikamp470decc2006-10-11 01:20:57 -07001683 if (!journal->j_tail)
1684 goto no_recovery;
1685
Eryu Guanf2a44522011-11-01 19:09:18 -04001686 printk(KERN_WARNING "JBD2: %s recovery information on journal\n",
Dave Kleikamp470decc2006-10-11 01:20:57 -07001687 write ? "Clearing" : "Ignoring");
1688
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001689 err = jbd2_journal_skip_recovery(journal);
Jan Karaa78bb112012-03-13 15:43:04 -04001690 if (write) {
1691 /* Lock to make assertions happy... */
1692 mutex_lock(&journal->j_checkpoint_mutex);
Jan Kara24bcc892012-03-13 15:41:04 -04001693 jbd2_mark_journal_empty(journal);
Jan Karaa78bb112012-03-13 15:43:04 -04001694 mutex_unlock(&journal->j_checkpoint_mutex);
1695 }
Dave Kleikamp470decc2006-10-11 01:20:57 -07001696
1697 no_recovery:
1698 return err;
1699}
1700
1701/*
Dave Kleikamp470decc2006-10-11 01:20:57 -07001702 * Journal abort has very specific semantics, which we describe
1703 * for journal abort.
1704 *
Alberto Bertoglibfcd3552009-06-09 00:06:20 -04001705 * Two internal functions, which provide abort to the jbd layer
Dave Kleikamp470decc2006-10-11 01:20:57 -07001706 * itself are here.
1707 */
1708
1709/*
1710 * Quick version for internal journal use (doesn't lock the journal).
1711 * Aborts hard --- we mark the abort as occurred, but do _nothing_ else,
1712 * and don't attempt to make any other journal updates.
1713 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001714void __jbd2_journal_abort_hard(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001715{
1716 transaction_t *transaction;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001717
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001718 if (journal->j_flags & JBD2_ABORT)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001719 return;
1720
1721 printk(KERN_ERR "Aborting journal on device %s.\n",
Theodore Ts'o05496762008-09-16 14:36:17 -04001722 journal->j_devname);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001723
Theodore Ts'oa931da62010-08-03 21:35:12 -04001724 write_lock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001725 journal->j_flags |= JBD2_ABORT;
Dave Kleikamp470decc2006-10-11 01:20:57 -07001726 transaction = journal->j_running_transaction;
1727 if (transaction)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001728 __jbd2_log_start_commit(journal, transaction->t_tid);
Theodore Ts'oa931da62010-08-03 21:35:12 -04001729 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001730}
1731
1732/* Soft abort: record the abort error status in the journal superblock,
1733 * but don't do any other IO. */
1734static void __journal_abort_soft (journal_t *journal, int errno)
1735{
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001736 if (journal->j_flags & JBD2_ABORT)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001737 return;
1738
1739 if (!journal->j_errno)
1740 journal->j_errno = errno;
1741
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001742 __jbd2_journal_abort_hard(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001743
1744 if (errno)
Jan Kara24bcc892012-03-13 15:41:04 -04001745 jbd2_journal_update_sb_errno(journal);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001746}
1747
1748/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001749 * void jbd2_journal_abort () - Shutdown the journal immediately.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001750 * @journal: the journal to shutdown.
1751 * @errno: an error number to record in the journal indicating
1752 * the reason for the shutdown.
1753 *
1754 * Perform a complete, immediate shutdown of the ENTIRE
1755 * journal (not of a single transaction). This operation cannot be
1756 * undone without closing and reopening the journal.
1757 *
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001758 * The jbd2_journal_abort function is intended to support higher level error
Dave Kleikamp470decc2006-10-11 01:20:57 -07001759 * recovery mechanisms such as the ext2/ext3 remount-readonly error
1760 * mode.
1761 *
1762 * Journal abort has very specific semantics. Any existing dirty,
1763 * unjournaled buffers in the main filesystem will still be written to
1764 * disk by bdflush, but the journaling mechanism will be suspended
1765 * immediately and no further transaction commits will be honoured.
1766 *
1767 * Any dirty, journaled buffers will be written back to disk without
1768 * hitting the journal. Atomicity cannot be guaranteed on an aborted
1769 * filesystem, but we _do_ attempt to leave as much data as possible
1770 * behind for fsck to use for cleanup.
1771 *
1772 * Any attempt to get a new transaction handle on a journal which is in
1773 * ABORT state will just result in an -EROFS error return. A
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001774 * jbd2_journal_stop on an existing handle will return -EIO if we have
Dave Kleikamp470decc2006-10-11 01:20:57 -07001775 * entered abort state during the update.
1776 *
1777 * Recursive transactions are not disturbed by journal abort until the
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001778 * final jbd2_journal_stop, which will receive the -EIO error.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001779 *
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001780 * Finally, the jbd2_journal_abort call allows the caller to supply an errno
Dave Kleikamp470decc2006-10-11 01:20:57 -07001781 * which will be recorded (if possible) in the journal superblock. This
1782 * allows a client to record failure conditions in the middle of a
1783 * transaction without having to complete the transaction to record the
1784 * failure to disk. ext3_error, for example, now uses this
1785 * functionality.
1786 *
1787 * Errors which originate from within the journaling layer will NOT
1788 * supply an errno; a null errno implies that absolutely no further
1789 * writes are done to the journal (unless there are any already in
1790 * progress).
1791 *
1792 */
1793
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001794void jbd2_journal_abort(journal_t *journal, int errno)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001795{
1796 __journal_abort_soft(journal, errno);
1797}
1798
1799/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001800 * int jbd2_journal_errno () - returns the journal's error state.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001801 * @journal: journal to examine.
1802 *
Alberto Bertoglibfcd3552009-06-09 00:06:20 -04001803 * This is the errno number set with jbd2_journal_abort(), the last
Dave Kleikamp470decc2006-10-11 01:20:57 -07001804 * time the journal was mounted - if the journal was stopped
1805 * without calling abort this will be 0.
1806 *
1807 * If the journal has been aborted on this mount time -EROFS will
1808 * be returned.
1809 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001810int jbd2_journal_errno(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001811{
1812 int err;
1813
Theodore Ts'oa931da62010-08-03 21:35:12 -04001814 read_lock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001815 if (journal->j_flags & JBD2_ABORT)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001816 err = -EROFS;
1817 else
1818 err = journal->j_errno;
Theodore Ts'oa931da62010-08-03 21:35:12 -04001819 read_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001820 return err;
1821}
1822
1823/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001824 * int jbd2_journal_clear_err () - clears the journal's error state
Dave Kleikamp470decc2006-10-11 01:20:57 -07001825 * @journal: journal to act on.
1826 *
Alberto Bertoglibfcd3552009-06-09 00:06:20 -04001827 * An error must be cleared or acked to take a FS out of readonly
Dave Kleikamp470decc2006-10-11 01:20:57 -07001828 * mode.
1829 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001830int jbd2_journal_clear_err(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001831{
1832 int err = 0;
1833
Theodore Ts'oa931da62010-08-03 21:35:12 -04001834 write_lock(&journal->j_state_lock);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001835 if (journal->j_flags & JBD2_ABORT)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001836 err = -EROFS;
1837 else
1838 journal->j_errno = 0;
Theodore Ts'oa931da62010-08-03 21:35:12 -04001839 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001840 return err;
1841}
1842
1843/**
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001844 * void jbd2_journal_ack_err() - Ack journal err.
Dave Kleikamp470decc2006-10-11 01:20:57 -07001845 * @journal: journal to act on.
1846 *
Alberto Bertoglibfcd3552009-06-09 00:06:20 -04001847 * An error must be cleared or acked to take a FS out of readonly
Dave Kleikamp470decc2006-10-11 01:20:57 -07001848 * mode.
1849 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001850void jbd2_journal_ack_err(journal_t *journal)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001851{
Theodore Ts'oa931da62010-08-03 21:35:12 -04001852 write_lock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001853 if (journal->j_errno)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001854 journal->j_flags |= JBD2_ACK_ERR;
Theodore Ts'oa931da62010-08-03 21:35:12 -04001855 write_unlock(&journal->j_state_lock);
Dave Kleikamp470decc2006-10-11 01:20:57 -07001856}
1857
Mingming Caof7f4bcc2006-10-11 01:20:59 -07001858int jbd2_journal_blocks_per_page(struct inode *inode)
Dave Kleikamp470decc2006-10-11 01:20:57 -07001859{
1860 return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits);
1861}
1862
1863/*
Zach Brownb517bea2006-10-11 01:21:08 -07001864 * helper functions to deal with 32 or 64bit block numbers.
1865 */
1866size_t journal_tag_bytes(journal_t *journal)
1867{
1868 if (JBD2_HAS_INCOMPAT_FEATURE(journal, JBD2_FEATURE_INCOMPAT_64BIT))
Mingming Caocd02ff02007-10-16 18:38:25 -04001869 return JBD2_TAG_SIZE64;
Zach Brownb517bea2006-10-11 01:21:08 -07001870 else
Mingming Caocd02ff02007-10-16 18:38:25 -04001871 return JBD2_TAG_SIZE32;
Zach Brownb517bea2006-10-11 01:21:08 -07001872}
1873
1874/*
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001875 * JBD memory management
1876 *
1877 * These functions are used to allocate block-sized chunks of memory
1878 * used for making copies of buffer_head data. Very often it will be
1879 * page-sized chunks of data, but sometimes it will be in
1880 * sub-page-size chunks. (For example, 16k pages on Power systems
1881 * with a 4k block file system.) For blocks smaller than a page, we
1882 * use a SLAB allocator. There are slab caches for each block size,
1883 * which are allocated at mount time, if necessary, and we only free
1884 * (all of) the slab caches when/if the jbd2 module is unloaded. For
1885 * this reason we don't need to a mutex to protect access to
1886 * jbd2_slab[] allocating or releasing memory; only in
1887 * jbd2_journal_create_slab().
1888 */
1889#define JBD2_MAX_SLABS 8
1890static struct kmem_cache *jbd2_slab[JBD2_MAX_SLABS];
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001891
1892static const char *jbd2_slab_names[JBD2_MAX_SLABS] = {
1893 "jbd2_1k", "jbd2_2k", "jbd2_4k", "jbd2_8k",
1894 "jbd2_16k", "jbd2_32k", "jbd2_64k", "jbd2_128k"
1895};
1896
1897
1898static void jbd2_journal_destroy_slabs(void)
1899{
1900 int i;
1901
1902 for (i = 0; i < JBD2_MAX_SLABS; i++) {
1903 if (jbd2_slab[i])
1904 kmem_cache_destroy(jbd2_slab[i]);
1905 jbd2_slab[i] = NULL;
1906 }
1907}
1908
1909static int jbd2_journal_create_slab(size_t size)
1910{
Thomas Gleixner51dfacde2010-10-16 22:34:39 +02001911 static DEFINE_MUTEX(jbd2_slab_create_mutex);
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001912 int i = order_base_2(size) - 10;
1913 size_t slab_size;
1914
1915 if (size == PAGE_SIZE)
1916 return 0;
1917
1918 if (i >= JBD2_MAX_SLABS)
1919 return -EINVAL;
1920
1921 if (unlikely(i < 0))
1922 i = 0;
Thomas Gleixner51dfacde2010-10-16 22:34:39 +02001923 mutex_lock(&jbd2_slab_create_mutex);
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001924 if (jbd2_slab[i]) {
Thomas Gleixner51dfacde2010-10-16 22:34:39 +02001925 mutex_unlock(&jbd2_slab_create_mutex);
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001926 return 0; /* Already created */
1927 }
1928
1929 slab_size = 1 << (i+10);
1930 jbd2_slab[i] = kmem_cache_create(jbd2_slab_names[i], slab_size,
1931 slab_size, 0, NULL);
Thomas Gleixner51dfacde2010-10-16 22:34:39 +02001932 mutex_unlock(&jbd2_slab_create_mutex);
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001933 if (!jbd2_slab[i]) {
1934 printk(KERN_EMERG "JBD2: no memory for jbd2_slab cache\n");
1935 return -ENOMEM;
1936 }
1937 return 0;
1938}
1939
1940static struct kmem_cache *get_slab(size_t size)
1941{
1942 int i = order_base_2(size) - 10;
1943
1944 BUG_ON(i >= JBD2_MAX_SLABS);
1945 if (unlikely(i < 0))
1946 i = 0;
Bill Pemberton8ac97b72010-04-30 09:34:31 -04001947 BUG_ON(jbd2_slab[i] == NULL);
Theodore Ts'od2eecb02009-12-07 10:36:20 -05001948 return jbd2_slab[i];
1949}
1950
1951void *jbd2_alloc(size_t size, gfp_t flags)
1952{
1953 void *ptr;
1954
1955 BUG_ON(size & (size-1)); /* Must be a power of 2 */
1956
1957 flags |= __GFP_REPEAT;
1958 if (size == PAGE_SIZE)
1959 ptr = (void *)__get_free_pages(flags, 0);
1960 else if (size > PAGE_SIZE) {
1961 int order = get_order(size);
1962
1963 if (order < 3)
1964 ptr = (void *)__get_free_pages(flags, order);
1965 else
1966 ptr = vmalloc(size);
1967 } else
1968 ptr = kmem_cache_alloc(get_slab(size), flags);
1969
1970 /* Check alignment; SLUB has gotten this wrong in the past,
1971 * and this can lead to user data corruption! */
1972 BUG_ON(((unsigned long) ptr) & (size-1));
1973
1974 return ptr;
1975}
1976
1977void jbd2_free(void *ptr, size_t size)
1978{
1979 if (size == PAGE_SIZE) {
1980 free_pages((unsigned long)ptr, 0);
1981 return;
1982 }
1983 if (size > PAGE_SIZE) {
1984 int order = get_order(size);
1985
1986 if (order < 3)
1987 free_pages((unsigned long)ptr, order);
1988 else
1989 vfree(ptr);
1990 return;
1991 }
1992 kmem_cache_free(get_slab(size), ptr);
1993};
1994
1995/*
Dave Kleikamp470decc2006-10-11 01:20:57 -07001996 * Journal_head storage management
1997 */
Christoph Lametere18b8902006-12-06 20:33:20 -08001998static struct kmem_cache *jbd2_journal_head_cache;
Jose R. Santose23291b2007-07-18 08:57:06 -04001999#ifdef CONFIG_JBD2_DEBUG
Dave Kleikamp470decc2006-10-11 01:20:57 -07002000static atomic_t nr_journal_heads = ATOMIC_INIT(0);
2001#endif
2002
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002003static int jbd2_journal_init_journal_head_cache(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002004{
2005 int retval;
2006
Al Viro1076d172008-03-29 03:07:18 +00002007 J_ASSERT(jbd2_journal_head_cache == NULL);
Johann Lombardia920e942006-10-11 01:21:00 -07002008 jbd2_journal_head_cache = kmem_cache_create("jbd2_journal_head",
Dave Kleikamp470decc2006-10-11 01:20:57 -07002009 sizeof(struct journal_head),
2010 0, /* offset */
Mingming Cao77160952008-01-28 23:58:27 -05002011 SLAB_TEMPORARY, /* flags */
Paul Mundt20c2df82007-07-20 10:11:58 +09002012 NULL); /* ctor */
Dave Kleikamp470decc2006-10-11 01:20:57 -07002013 retval = 0;
Al Viro1076d172008-03-29 03:07:18 +00002014 if (!jbd2_journal_head_cache) {
Dave Kleikamp470decc2006-10-11 01:20:57 -07002015 retval = -ENOMEM;
Eryu Guanf2a44522011-11-01 19:09:18 -04002016 printk(KERN_EMERG "JBD2: no memory for journal_head cache\n");
Dave Kleikamp470decc2006-10-11 01:20:57 -07002017 }
2018 return retval;
2019}
2020
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002021static void jbd2_journal_destroy_journal_head_cache(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002022{
Duane Griffin8a9362e2008-04-17 10:38:59 -04002023 if (jbd2_journal_head_cache) {
2024 kmem_cache_destroy(jbd2_journal_head_cache);
2025 jbd2_journal_head_cache = NULL;
2026 }
Dave Kleikamp470decc2006-10-11 01:20:57 -07002027}
2028
2029/*
2030 * journal_head splicing and dicing
2031 */
2032static struct journal_head *journal_alloc_journal_head(void)
2033{
2034 struct journal_head *ret;
Dave Kleikamp470decc2006-10-11 01:20:57 -07002035
Jose R. Santose23291b2007-07-18 08:57:06 -04002036#ifdef CONFIG_JBD2_DEBUG
Dave Kleikamp470decc2006-10-11 01:20:57 -07002037 atomic_inc(&nr_journal_heads);
2038#endif
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002039 ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
Al Viro1076d172008-03-29 03:07:18 +00002040 if (!ret) {
Dave Kleikamp470decc2006-10-11 01:20:57 -07002041 jbd_debug(1, "out of memory for journal_head\n");
Theodore Ts'o670be5a2010-12-17 10:44:16 -05002042 pr_notice_ratelimited("ENOMEM in %s, retrying.\n", __func__);
Al Viro1076d172008-03-29 03:07:18 +00002043 while (!ret) {
Dave Kleikamp470decc2006-10-11 01:20:57 -07002044 yield();
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002045 ret = kmem_cache_alloc(jbd2_journal_head_cache, GFP_NOFS);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002046 }
2047 }
2048 return ret;
2049}
2050
2051static void journal_free_journal_head(struct journal_head *jh)
2052{
Jose R. Santose23291b2007-07-18 08:57:06 -04002053#ifdef CONFIG_JBD2_DEBUG
Dave Kleikamp470decc2006-10-11 01:20:57 -07002054 atomic_dec(&nr_journal_heads);
Mingming Caocd02ff02007-10-16 18:38:25 -04002055 memset(jh, JBD2_POISON_FREE, sizeof(*jh));
Dave Kleikamp470decc2006-10-11 01:20:57 -07002056#endif
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002057 kmem_cache_free(jbd2_journal_head_cache, jh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002058}
2059
2060/*
2061 * A journal_head is attached to a buffer_head whenever JBD has an
2062 * interest in the buffer.
2063 *
2064 * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
2065 * is set. This bit is tested in core kernel code where we need to take
2066 * JBD-specific actions. Testing the zeroness of ->b_private is not reliable
2067 * there.
2068 *
2069 * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
2070 *
2071 * When a buffer has its BH_JBD bit set it is immune from being released by
2072 * core kernel code, mainly via ->b_count.
2073 *
Jan Karade1b7942011-06-13 15:38:22 -04002074 * A journal_head is detached from its buffer_head when the journal_head's
2075 * b_jcount reaches zero. Running transaction (b_transaction) and checkpoint
2076 * transaction (b_cp_transaction) hold their references to b_jcount.
Dave Kleikamp470decc2006-10-11 01:20:57 -07002077 *
2078 * Various places in the kernel want to attach a journal_head to a buffer_head
2079 * _before_ attaching the journal_head to a transaction. To protect the
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002080 * journal_head in this situation, jbd2_journal_add_journal_head elevates the
Dave Kleikamp470decc2006-10-11 01:20:57 -07002081 * journal_head's b_jcount refcount by one. The caller must call
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002082 * jbd2_journal_put_journal_head() to undo this.
Dave Kleikamp470decc2006-10-11 01:20:57 -07002083 *
2084 * So the typical usage would be:
2085 *
2086 * (Attach a journal_head if needed. Increments b_jcount)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002087 * struct journal_head *jh = jbd2_journal_add_journal_head(bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002088 * ...
Jan Karade1b7942011-06-13 15:38:22 -04002089 * (Get another reference for transaction)
2090 * jbd2_journal_grab_journal_head(bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002091 * jh->b_transaction = xxx;
Jan Karade1b7942011-06-13 15:38:22 -04002092 * (Put original reference)
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002093 * jbd2_journal_put_journal_head(jh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002094 */
2095
2096/*
2097 * Give a buffer_head a journal_head.
2098 *
Dave Kleikamp470decc2006-10-11 01:20:57 -07002099 * May sleep.
2100 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002101struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002102{
2103 struct journal_head *jh;
2104 struct journal_head *new_jh = NULL;
2105
2106repeat:
2107 if (!buffer_jbd(bh)) {
2108 new_jh = journal_alloc_journal_head();
2109 memset(new_jh, 0, sizeof(*new_jh));
2110 }
2111
2112 jbd_lock_bh_journal_head(bh);
2113 if (buffer_jbd(bh)) {
2114 jh = bh2jh(bh);
2115 } else {
2116 J_ASSERT_BH(bh,
2117 (atomic_read(&bh->b_count) > 0) ||
2118 (bh->b_page && bh->b_page->mapping));
2119
2120 if (!new_jh) {
2121 jbd_unlock_bh_journal_head(bh);
2122 goto repeat;
2123 }
2124
2125 jh = new_jh;
2126 new_jh = NULL; /* We consumed it */
2127 set_buffer_jbd(bh);
2128 bh->b_private = jh;
2129 jh->b_bh = bh;
2130 get_bh(bh);
2131 BUFFER_TRACE(bh, "added journal_head");
2132 }
2133 jh->b_jcount++;
2134 jbd_unlock_bh_journal_head(bh);
2135 if (new_jh)
2136 journal_free_journal_head(new_jh);
2137 return bh->b_private;
2138}
2139
2140/*
2141 * Grab a ref against this buffer_head's journal_head. If it ended up not
2142 * having a journal_head, return NULL
2143 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002144struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002145{
2146 struct journal_head *jh = NULL;
2147
2148 jbd_lock_bh_journal_head(bh);
2149 if (buffer_jbd(bh)) {
2150 jh = bh2jh(bh);
2151 jh->b_jcount++;
2152 }
2153 jbd_unlock_bh_journal_head(bh);
2154 return jh;
2155}
2156
2157static void __journal_remove_journal_head(struct buffer_head *bh)
2158{
2159 struct journal_head *jh = bh2jh(bh);
2160
2161 J_ASSERT_JH(jh, jh->b_jcount >= 0);
Jan Karade1b7942011-06-13 15:38:22 -04002162 J_ASSERT_JH(jh, jh->b_transaction == NULL);
2163 J_ASSERT_JH(jh, jh->b_next_transaction == NULL);
2164 J_ASSERT_JH(jh, jh->b_cp_transaction == NULL);
2165 J_ASSERT_JH(jh, jh->b_jlist == BJ_None);
2166 J_ASSERT_BH(bh, buffer_jbd(bh));
2167 J_ASSERT_BH(bh, jh2bh(jh) == bh);
2168 BUFFER_TRACE(bh, "remove journal_head");
2169 if (jh->b_frozen_data) {
2170 printk(KERN_WARNING "%s: freeing b_frozen_data\n", __func__);
2171 jbd2_free(jh->b_frozen_data, bh->b_size);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002172 }
Jan Karade1b7942011-06-13 15:38:22 -04002173 if (jh->b_committed_data) {
2174 printk(KERN_WARNING "%s: freeing b_committed_data\n", __func__);
2175 jbd2_free(jh->b_committed_data, bh->b_size);
2176 }
2177 bh->b_private = NULL;
2178 jh->b_bh = NULL; /* debug, really */
2179 clear_buffer_jbd(bh);
2180 journal_free_journal_head(jh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002181}
2182
2183/*
Jan Karade1b7942011-06-13 15:38:22 -04002184 * Drop a reference on the passed journal_head. If it fell to zero then
Dave Kleikamp470decc2006-10-11 01:20:57 -07002185 * release the journal_head from the buffer_head.
2186 */
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002187void jbd2_journal_put_journal_head(struct journal_head *jh)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002188{
2189 struct buffer_head *bh = jh2bh(jh);
2190
2191 jbd_lock_bh_journal_head(bh);
2192 J_ASSERT_JH(jh, jh->b_jcount > 0);
2193 --jh->b_jcount;
Jan Karade1b7942011-06-13 15:38:22 -04002194 if (!jh->b_jcount) {
Dave Kleikamp470decc2006-10-11 01:20:57 -07002195 __journal_remove_journal_head(bh);
Jan Karade1b7942011-06-13 15:38:22 -04002196 jbd_unlock_bh_journal_head(bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002197 __brelse(bh);
Jan Karade1b7942011-06-13 15:38:22 -04002198 } else
2199 jbd_unlock_bh_journal_head(bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002200}
2201
2202/*
Jan Karac851ed52008-07-11 19:27:31 -04002203 * Initialize jbd inode head
2204 */
2205void jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode)
2206{
2207 jinode->i_transaction = NULL;
2208 jinode->i_next_transaction = NULL;
2209 jinode->i_vfs_inode = inode;
2210 jinode->i_flags = 0;
2211 INIT_LIST_HEAD(&jinode->i_list);
2212}
2213
2214/*
2215 * Function to be called before we start removing inode from memory (i.e.,
2216 * clear_inode() is a fine place to be called from). It removes inode from
2217 * transaction's lists.
2218 */
2219void jbd2_journal_release_jbd_inode(journal_t *journal,
2220 struct jbd2_inode *jinode)
2221{
Jan Karac851ed52008-07-11 19:27:31 -04002222 if (!journal)
2223 return;
2224restart:
2225 spin_lock(&journal->j_list_lock);
2226 /* Is commit writing out inode - we have to wait */
Brian King39e3ac22010-10-27 21:25:12 -04002227 if (test_bit(__JI_COMMIT_RUNNING, &jinode->i_flags)) {
Jan Karac851ed52008-07-11 19:27:31 -04002228 wait_queue_head_t *wq;
2229 DEFINE_WAIT_BIT(wait, &jinode->i_flags, __JI_COMMIT_RUNNING);
2230 wq = bit_waitqueue(&jinode->i_flags, __JI_COMMIT_RUNNING);
2231 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
2232 spin_unlock(&journal->j_list_lock);
2233 schedule();
2234 finish_wait(wq, &wait.wait);
2235 goto restart;
2236 }
2237
Jan Karac851ed52008-07-11 19:27:31 -04002238 if (jinode->i_transaction) {
2239 list_del(&jinode->i_list);
2240 jinode->i_transaction = NULL;
2241 }
2242 spin_unlock(&journal->j_list_lock);
2243}
2244
2245/*
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002246 * debugfs tunables
Dave Kleikamp470decc2006-10-11 01:20:57 -07002247 */
Jose R. Santos6f38c742007-10-16 18:38:25 -04002248#ifdef CONFIG_JBD2_DEBUG
2249u8 jbd2_journal_enable_debug __read_mostly;
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002250EXPORT_SYMBOL(jbd2_journal_enable_debug);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002251
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002252#define JBD2_DEBUG_NAME "jbd2-debug"
Dave Kleikamp470decc2006-10-11 01:20:57 -07002253
Jose R. Santos6f38c742007-10-16 18:38:25 -04002254static struct dentry *jbd2_debugfs_dir;
2255static struct dentry *jbd2_debug;
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002256
2257static void __init jbd2_create_debugfs_entry(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002258{
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002259 jbd2_debugfs_dir = debugfs_create_dir("jbd2", NULL);
2260 if (jbd2_debugfs_dir)
Yin Kangkai765f8362009-12-15 14:48:25 -08002261 jbd2_debug = debugfs_create_u8(JBD2_DEBUG_NAME,
2262 S_IRUGO | S_IWUSR,
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002263 jbd2_debugfs_dir,
2264 &jbd2_journal_enable_debug);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002265}
2266
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002267static void __exit jbd2_remove_debugfs_entry(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002268{
Jose R. Santos6f38c742007-10-16 18:38:25 -04002269 debugfs_remove(jbd2_debug);
2270 debugfs_remove(jbd2_debugfs_dir);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002271}
2272
2273#else
2274
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002275static void __init jbd2_create_debugfs_entry(void)
2276{
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002277}
2278
2279static void __exit jbd2_remove_debugfs_entry(void)
2280{
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002281}
Dave Kleikamp470decc2006-10-11 01:20:57 -07002282
2283#endif
2284
Johann Lombardi8e85fb32008-01-28 23:58:27 -05002285#ifdef CONFIG_PROC_FS
2286
2287#define JBD2_STATS_PROC_NAME "fs/jbd2"
2288
2289static void __init jbd2_create_jbd_stats_proc_entry(void)
2290{
2291 proc_jbd2_stats = proc_mkdir(JBD2_STATS_PROC_NAME, NULL);
2292}
2293
2294static void __exit jbd2_remove_jbd_stats_proc_entry(void)
2295{
2296 if (proc_jbd2_stats)
2297 remove_proc_entry(JBD2_STATS_PROC_NAME, NULL);
2298}
2299
2300#else
2301
2302#define jbd2_create_jbd_stats_proc_entry() do {} while (0)
2303#define jbd2_remove_jbd_stats_proc_entry() do {} while (0)
2304
2305#endif
2306
Theodore Ts'o8aefcd52011-01-10 12:29:43 -05002307struct kmem_cache *jbd2_handle_cache, *jbd2_inode_cache;
Dave Kleikamp470decc2006-10-11 01:20:57 -07002308
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002309static int __init jbd2_journal_init_handle_cache(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002310{
Theodore Ts'o8aefcd52011-01-10 12:29:43 -05002311 jbd2_handle_cache = KMEM_CACHE(jbd2_journal_handle, SLAB_TEMPORARY);
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002312 if (jbd2_handle_cache == NULL) {
Theodore Ts'o8aefcd52011-01-10 12:29:43 -05002313 printk(KERN_EMERG "JBD2: failed to create handle cache\n");
2314 return -ENOMEM;
2315 }
2316 jbd2_inode_cache = KMEM_CACHE(jbd2_inode, 0);
2317 if (jbd2_inode_cache == NULL) {
2318 printk(KERN_EMERG "JBD2: failed to create inode cache\n");
2319 kmem_cache_destroy(jbd2_handle_cache);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002320 return -ENOMEM;
2321 }
2322 return 0;
2323}
2324
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002325static void jbd2_journal_destroy_handle_cache(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002326{
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002327 if (jbd2_handle_cache)
2328 kmem_cache_destroy(jbd2_handle_cache);
Theodore Ts'o8aefcd52011-01-10 12:29:43 -05002329 if (jbd2_inode_cache)
2330 kmem_cache_destroy(jbd2_inode_cache);
2331
Dave Kleikamp470decc2006-10-11 01:20:57 -07002332}
2333
2334/*
2335 * Module startup and shutdown
2336 */
2337
2338static int __init journal_init_caches(void)
2339{
2340 int ret;
2341
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002342 ret = jbd2_journal_init_revoke_caches();
Dave Kleikamp470decc2006-10-11 01:20:57 -07002343 if (ret == 0)
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002344 ret = jbd2_journal_init_journal_head_cache();
Dave Kleikamp470decc2006-10-11 01:20:57 -07002345 if (ret == 0)
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002346 ret = jbd2_journal_init_handle_cache();
Yongqiang Yang0c2022e2012-02-20 17:53:02 -05002347 if (ret == 0)
2348 ret = jbd2_journal_init_transaction_cache();
Dave Kleikamp470decc2006-10-11 01:20:57 -07002349 return ret;
2350}
2351
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002352static void jbd2_journal_destroy_caches(void)
Dave Kleikamp470decc2006-10-11 01:20:57 -07002353{
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002354 jbd2_journal_destroy_revoke_caches();
Yongqiang Yang4185a2a2012-02-20 17:53:03 -05002355 jbd2_journal_destroy_journal_head_cache();
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002356 jbd2_journal_destroy_handle_cache();
Yongqiang Yang0c2022e2012-02-20 17:53:02 -05002357 jbd2_journal_destroy_transaction_cache();
Theodore Ts'od2eecb02009-12-07 10:36:20 -05002358 jbd2_journal_destroy_slabs();
Dave Kleikamp470decc2006-10-11 01:20:57 -07002359}
2360
2361static int __init journal_init(void)
2362{
2363 int ret;
2364
2365 BUILD_BUG_ON(sizeof(struct journal_superblock_s) != 1024);
2366
2367 ret = journal_init_caches();
Duane Griffin620de4e2008-04-29 22:02:47 -04002368 if (ret == 0) {
2369 jbd2_create_debugfs_entry();
2370 jbd2_create_jbd_stats_proc_entry();
2371 } else {
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002372 jbd2_journal_destroy_caches();
Duane Griffin620de4e2008-04-29 22:02:47 -04002373 }
Dave Kleikamp470decc2006-10-11 01:20:57 -07002374 return ret;
2375}
2376
2377static void __exit journal_exit(void)
2378{
Jose R. Santose23291b2007-07-18 08:57:06 -04002379#ifdef CONFIG_JBD2_DEBUG
Dave Kleikamp470decc2006-10-11 01:20:57 -07002380 int n = atomic_read(&nr_journal_heads);
2381 if (n)
Eryu Guanf2a44522011-11-01 19:09:18 -04002382 printk(KERN_EMERG "JBD2: leaked %d journal_heads!\n", n);
Dave Kleikamp470decc2006-10-11 01:20:57 -07002383#endif
Jose R. Santos0f49d5d2007-07-18 08:50:18 -04002384 jbd2_remove_debugfs_entry();
Johann Lombardi8e85fb32008-01-28 23:58:27 -05002385 jbd2_remove_jbd_stats_proc_entry();
Mingming Caof7f4bcc2006-10-11 01:20:59 -07002386 jbd2_journal_destroy_caches();
Dave Kleikamp470decc2006-10-11 01:20:57 -07002387}
2388
Dave Kleikamp470decc2006-10-11 01:20:57 -07002389MODULE_LICENSE("GPL");
2390module_init(journal_init);
2391module_exit(journal_exit);
2392