journal.c
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:49k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * linux/fs/journal.c
  3.  *
  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. #include <linux/module.h>
  25. #include <linux/sched.h>
  26. #include <linux/fs.h>
  27. #include <linux/jbd.h>
  28. #include <linux/errno.h>
  29. #include <linux/slab.h>
  30. #include <linux/locks.h>
  31. #include <linux/smp_lock.h>
  32. #include <linux/sched.h>
  33. #include <linux/init.h>
  34. #include <linux/mm.h>
  35. #include <linux/slab.h>
  36. #include <asm/uaccess.h>
  37. #include <linux/proc_fs.h>
  38. EXPORT_SYMBOL(journal_start);
  39. EXPORT_SYMBOL(journal_try_start);
  40. EXPORT_SYMBOL(journal_restart);
  41. EXPORT_SYMBOL(journal_extend);
  42. EXPORT_SYMBOL(journal_stop);
  43. EXPORT_SYMBOL(journal_lock_updates);
  44. EXPORT_SYMBOL(journal_unlock_updates);
  45. EXPORT_SYMBOL(journal_get_write_access);
  46. EXPORT_SYMBOL(journal_get_create_access);
  47. EXPORT_SYMBOL(journal_get_undo_access);
  48. EXPORT_SYMBOL(journal_dirty_data);
  49. EXPORT_SYMBOL(journal_dirty_metadata);
  50. #if 0
  51. EXPORT_SYMBOL(journal_release_buffer);
  52. #endif
  53. EXPORT_SYMBOL(journal_forget);
  54. #if 0
  55. EXPORT_SYMBOL(journal_sync_buffer);
  56. #endif
  57. EXPORT_SYMBOL(journal_flush);
  58. EXPORT_SYMBOL(journal_revoke);
  59. EXPORT_SYMBOL(journal_init_dev);
  60. EXPORT_SYMBOL(journal_init_inode);
  61. EXPORT_SYMBOL(journal_update_format);
  62. EXPORT_SYMBOL(journal_check_used_features);
  63. EXPORT_SYMBOL(journal_check_available_features);
  64. EXPORT_SYMBOL(journal_set_features);
  65. EXPORT_SYMBOL(journal_create);
  66. EXPORT_SYMBOL(journal_load);
  67. EXPORT_SYMBOL(journal_destroy);
  68. EXPORT_SYMBOL(journal_recover);
  69. EXPORT_SYMBOL(journal_update_superblock);
  70. EXPORT_SYMBOL(journal_abort);
  71. EXPORT_SYMBOL(journal_errno);
  72. EXPORT_SYMBOL(journal_ack_err);
  73. EXPORT_SYMBOL(journal_clear_err);
  74. EXPORT_SYMBOL(log_wait_commit);
  75. EXPORT_SYMBOL(log_start_commit);
  76. EXPORT_SYMBOL(journal_wipe);
  77. EXPORT_SYMBOL(journal_blocks_per_page);
  78. EXPORT_SYMBOL(journal_flushpage);
  79. EXPORT_SYMBOL(journal_try_to_free_buffers);
  80. EXPORT_SYMBOL(journal_bmap);
  81. EXPORT_SYMBOL(journal_force_commit);
  82. static int journal_convert_superblock_v1(journal_t *, journal_superblock_t *);
  83. /*
  84.  * journal_datalist_lock is used to protect data buffers:
  85.  *
  86.  * bh->b_transaction
  87.  * bh->b_tprev
  88.  * bh->b_tnext
  89.  *
  90.  * journal_free_buffer() is called from journal_try_to_free_buffer(), and is
  91.  * async wrt everything else.
  92.  *
  93.  * It is also used for checkpoint data, also to protect against
  94.  * journal_try_to_free_buffer():
  95.  *
  96.  * bh->b_cp_transaction
  97.  * bh->b_cpnext
  98.  * bh->b_cpprev
  99.  * transaction->t_checkpoint_list
  100.  * transaction->t_cpnext
  101.  * transaction->t_cpprev
  102.  * journal->j_checkpoint_transactions
  103.  *
  104.  * It is global at this time rather than per-journal because it's
  105.  * impossible for __journal_free_buffer to go from a buffer_head
  106.  * back to a journal_t unracily (well, not true.  Fix later)
  107.  *
  108.  *
  109.  * The `datalist' and `checkpoint list' functions are quite
  110.  * separate and we could use two spinlocks here.
  111.  *
  112.  * lru_list_lock nests inside journal_datalist_lock.
  113.  */
  114. spinlock_t journal_datalist_lock = SPIN_LOCK_UNLOCKED;
  115. /*
  116.  * jh_splice_lock needs explantion.
  117.  *
  118.  * In a number of places we want to do things like:
  119.  *
  120.  * if (buffer_jbd(bh) && bh2jh(bh)->foo)
  121.  *
  122.  * This is racy on SMP, because another CPU could remove the journal_head
  123.  * in the middle of this expression.  We need locking.
  124.  *
  125.  * But we can greatly optimise the locking cost by testing BH_JBD
  126.  * outside the lock.  So, effectively:
  127.  *
  128.  * ret = 0;
  129.  * if (buffer_jbd(bh)) {
  130.  * spin_lock(&jh_splice_lock);
  131.  * if (buffer_jbd(bh)) {  (* Still there? *)
  132.  * ret = bh2jh(bh)->foo;
  133.  * }
  134.  * spin_unlock(&jh_splice_lock);
  135.  * }
  136.  * return ret;
  137.  *
  138.  * Now, that protects us from races where another CPU can remove the
  139.  * journal_head.  But it doesn't defend us from the situation where another
  140.  * CPU can *add* a journal_head.  This is a correctness issue.  But it's not
  141.  * a problem because a) the calling code was *already* racy and b) it often
  142.  * can't happen at the call site and c) the places where we add journal_heads
  143.  * tend to be under external locking.
  144.  */
  145. spinlock_t jh_splice_lock = SPIN_LOCK_UNLOCKED;
  146. /*
  147.  * List of all journals in the system.  Protected by the BKL.
  148.  */
  149. static LIST_HEAD(all_journals);
  150. /*
  151.  * Helper function used to manage commit timeouts
  152.  */
  153. static void commit_timeout(unsigned long __data)
  154. {
  155. struct task_struct * p = (struct task_struct *) __data;
  156. wake_up_process(p);
  157. }
  158. /* Static check for data structure consistency.  There's no code
  159.  * invoked --- we'll just get a linker failure if things aren't right.
  160.  */
  161. void __journal_internal_check(void)
  162. {
  163. extern void journal_bad_superblock_size(void);
  164. if (sizeof(struct journal_superblock_s) != 1024)
  165. journal_bad_superblock_size();
  166. }
  167. /*
  168.  * kjournald: The main thread function used to manage a logging device
  169.  * journal.
  170.  *
  171.  * This kernel thread is responsible for two things:
  172.  *
  173.  * 1) COMMIT:  Every so often we need to commit the current state of the
  174.  *    filesystem to disk.  The journal thread is responsible for writing
  175.  *    all of the metadata buffers to disk.
  176.  *
  177.  * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
  178.  *    of the data in that part of the log has been rewritten elsewhere on
  179.  *    the disk.  Flushing these old buffers to reclaim space in the log is
  180.  *    known as checkpointing, and this thread is responsible for that job.
  181.  */
  182. journal_t *current_journal; // AKPM: debug
  183. int kjournald(void *arg)
  184. {
  185. journal_t *journal = (journal_t *) arg;
  186. transaction_t *transaction;
  187. struct timer_list timer;
  188. current_journal = journal;
  189. lock_kernel();
  190. daemonize();
  191. spin_lock_irq(&current->sigmask_lock);
  192. sigfillset(&current->blocked);
  193. recalc_sigpending(current);
  194. spin_unlock_irq(&current->sigmask_lock);
  195. sprintf(current->comm, "kjournald");
  196. /* Set up an interval timer which can be used to trigger a
  197.            commit wakeup after the commit interval expires */
  198. init_timer(&timer);
  199. timer.data = (unsigned long) current;
  200. timer.function = commit_timeout;
  201. journal->j_commit_timer = &timer;
  202. /* Record that the journal thread is running */
  203. journal->j_task = current;
  204. wake_up(&journal->j_wait_done_commit);
  205. printk(KERN_INFO "kjournald starting.  Commit interval %ld secondsn",
  206. journal->j_commit_interval / HZ);
  207. list_add(&journal->j_all_journals, &all_journals);
  208. /* And now, wait forever for commit wakeup events. */
  209. while (1) {
  210. if (journal->j_flags & JFS_UNMOUNT)
  211. break;
  212. jbd_debug(1, "commit_sequence=%d, commit_request=%dn",
  213. journal->j_commit_sequence, journal->j_commit_request);
  214. if (journal->j_commit_sequence != journal->j_commit_request) {
  215. jbd_debug(1, "OK, requests differn");
  216. if (journal->j_commit_timer_active) {
  217. journal->j_commit_timer_active = 0;
  218. del_timer(journal->j_commit_timer);
  219. }
  220. journal_commit_transaction(journal);
  221. continue;
  222. }
  223. wake_up(&journal->j_wait_done_commit);
  224. interruptible_sleep_on(&journal->j_wait_commit);
  225. jbd_debug(1, "kjournald wakesn");
  226. /* Were we woken up by a commit wakeup event? */
  227. if ((transaction = journal->j_running_transaction) != NULL &&
  228.     time_after_eq(jiffies, transaction->t_expires)) {
  229. journal->j_commit_request = transaction->t_tid;
  230. jbd_debug(1, "woke because of timeoutn");
  231. }
  232. }
  233. if (journal->j_commit_timer_active) {
  234. journal->j_commit_timer_active = 0;
  235. del_timer_sync(journal->j_commit_timer);
  236. }
  237. list_del(&journal->j_all_journals);
  238. journal->j_task = NULL;
  239. wake_up(&journal->j_wait_done_commit);
  240. jbd_debug(1, "Journal thread exiting.n");
  241. return 0;
  242. }
  243. static void journal_start_thread(journal_t *journal)
  244. {
  245. kernel_thread(kjournald, (void *) journal,
  246.       CLONE_VM | CLONE_FS | CLONE_FILES);
  247. while (!journal->j_task)
  248. sleep_on(&journal->j_wait_done_commit);
  249. }
  250. static void journal_kill_thread(journal_t *journal)
  251. {
  252. journal->j_flags |= JFS_UNMOUNT;
  253. while (journal->j_task) {
  254. wake_up(&journal->j_wait_commit);
  255. sleep_on(&journal->j_wait_done_commit);
  256. }
  257. }
  258. #if 0
  259. This is no longer needed - we do it in commit quite efficiently.
  260. Note that if this function is resurrected, the loop needs to
  261. be reorganised into the next_jh/last_jh algorithm.
  262. /*
  263.  * journal_clean_data_list: cleanup after data IO.
  264.  *
  265.  * Once the IO system has finished writing the buffers on the transaction's
  266.  * data list, we can remove those buffers from the list.  This function
  267.  * scans the list for such buffers and removes them cleanly.
  268.  *
  269.  * We assume that the journal is already locked.
  270.  * We are called with journal_datalist_lock held.
  271.  *
  272.  * AKPM: This function looks inefficient.  Approximately O(n^2)
  273.  * for potentially thousands of buffers.  It no longer shows on profiles
  274.  * because these buffers are mainly dropped in journal_commit_transaction().
  275.  */
  276. void __journal_clean_data_list(transaction_t *transaction)
  277. {
  278. struct journal_head *jh, *next;
  279. assert_spin_locked(&journal_datalist_lock);
  280. restart:
  281. jh = transaction->t_sync_datalist;
  282. if (!jh)
  283. goto out;
  284. do {
  285. next = jh->b_tnext;
  286. if (!buffer_locked(jh2bh(jh)) && !buffer_dirty(jh2bh(jh))) {
  287. struct buffer_head *bh = jh2bh(jh);
  288. BUFFER_TRACE(bh, "data writeout complete: unfile");
  289. __journal_unfile_buffer(jh);
  290. jh->b_transaction = NULL;
  291. __journal_remove_journal_head(bh);
  292. refile_buffer(bh);
  293. __brelse(bh);
  294. goto restart;
  295. }
  296. jh = next;
  297. } while (transaction->t_sync_datalist &&
  298. jh != transaction->t_sync_datalist);
  299. out:
  300. return;
  301. }
  302. #endif
  303. /*
  304.  * journal_write_metadata_buffer: write a metadata buffer to the journal.
  305.  *
  306.  * Writes a metadata buffer to a given disk block.  The actual IO is not
  307.  * performed but a new buffer_head is constructed which labels the data
  308.  * to be written with the correct destination disk block.
  309.  *
  310.  * Any magic-number escaping which needs to be done will cause a
  311.  * copy-out here.  If the buffer happens to start with the
  312.  * JFS_MAGIC_NUMBER, then we can't write it to the log directly: the
  313.  * magic number is only written to the log for descripter blocks.  In
  314.  * this case, we copy the data and replace the first word with 0, and we
  315.  * return a result code which indicates that this buffer needs to be
  316.  * marked as an escaped buffer in the corresponding log descriptor
  317.  * block.  The missing word can then be restored when the block is read
  318.  * during recovery.
  319.  *
  320.  * If the source buffer has already been modified by a new transaction
  321.  * since we took the last commit snapshot, we use the frozen copy of
  322.  * that data for IO.  If we end up using the existing buffer_head's data
  323.  * for the write, then we *have* to lock the buffer to prevent anyone
  324.  * else from using and possibly modifying it while the IO is in
  325.  * progress.
  326.  *
  327.  * The function returns a pointer to the buffer_heads to be used for IO.
  328.  *
  329.  * We assume that the journal has already been locked in this function.
  330.  *
  331.  * Return value:
  332.  *  <0: Error
  333.  * >=0: Finished OK
  334.  *
  335.  * On success:
  336.  * Bit 0 set == escape performed on the data
  337.  * Bit 1 set == buffer copy-out performed (kfree the data after IO)
  338.  */
  339. static inline unsigned long virt_to_offset(void *p) 
  340. {return ((unsigned long) p) & ~PAGE_MASK;}
  341.        
  342. int journal_write_metadata_buffer(transaction_t *transaction,
  343.   struct journal_head  *jh_in,
  344.   struct journal_head **jh_out,
  345.   int blocknr)
  346. {
  347. int need_copy_out = 0;
  348. int done_copy_out = 0;
  349. int do_escape = 0;
  350. char *mapped_data;
  351. struct buffer_head *new_bh;
  352. struct journal_head * new_jh;
  353. struct page *new_page;
  354. unsigned int new_offset;
  355. /*
  356.  * The buffer really shouldn't be locked: only the current committing
  357.  * transaction is allowed to write it, so nobody else is allowed
  358.  * to do any IO.
  359.  *
  360.  * akpm: except if we're journalling data, and write() output is
  361.  * also part of a shared mapping, and another thread has
  362.  * decided to launch a writepage() against this buffer.
  363.  */
  364. J_ASSERT_JH(jh_in, buffer_jdirty(jh2bh(jh_in)));
  365. /*
  366.  * If a new transaction has already done a buffer copy-out, then
  367.  * we use that version of the data for the commit.
  368.  */
  369. if (jh_in->b_frozen_data) {
  370. done_copy_out = 1;
  371. new_page = virt_to_page(jh_in->b_frozen_data);
  372. new_offset = virt_to_offset(jh_in->b_frozen_data);
  373. } else {
  374. new_page = jh2bh(jh_in)->b_page;
  375. new_offset = virt_to_offset(jh2bh(jh_in)->b_data);
  376. }
  377. mapped_data = ((char *) kmap(new_page)) + new_offset;
  378. /*
  379.  * Check for escaping
  380.  */
  381. if (* ((unsigned int *) mapped_data) == htonl(JFS_MAGIC_NUMBER)) {
  382. need_copy_out = 1;
  383. do_escape = 1;
  384. }
  385. /*
  386.  * Do we need to do a data copy?
  387.  */
  388. if (need_copy_out && !done_copy_out) {
  389. char *tmp;
  390. tmp = jbd_rep_kmalloc(jh2bh(jh_in)->b_size, GFP_NOFS);
  391. jh_in->b_frozen_data = tmp;
  392. memcpy (tmp, mapped_data, jh2bh(jh_in)->b_size);
  393. /* If we get to this path, we'll always need the new
  394.    address kmapped so that we can clear the escaped
  395.    magic number below. */
  396. kunmap(new_page);
  397. new_page = virt_to_page(tmp);
  398. new_offset = virt_to_offset(tmp);
  399. mapped_data = ((char *) kmap(new_page)) + new_offset;
  400. done_copy_out = 1;
  401. }
  402. /*
  403.  * Right, time to make up the new buffer_head.
  404.  */
  405. do {
  406. new_bh = get_unused_buffer_head(0);
  407. if (!new_bh) {
  408. printk (KERN_NOTICE __FUNCTION__
  409. ": ENOMEM at get_unused_buffer_head, "
  410. "trying again.n");
  411. current->policy |= SCHED_YIELD;
  412. schedule();
  413. }
  414. } while (!new_bh);
  415. /* keep subsequent assertions sane */
  416. new_bh->b_prev_free = 0;
  417. new_bh->b_next_free = 0;
  418. new_bh->b_state = 0;
  419. init_buffer(new_bh, NULL, NULL);
  420. atomic_set(&new_bh->b_count, 1);
  421. new_jh = journal_add_journal_head(new_bh);
  422. set_bh_page(new_bh, new_page, new_offset);
  423. new_jh->b_transaction = NULL;
  424. new_bh->b_size = jh2bh(jh_in)->b_size;
  425. new_bh->b_dev = transaction->t_journal->j_dev;
  426. new_bh->b_blocknr = blocknr;
  427. new_bh->b_state |= (1 << BH_Mapped) | (1 << BH_Dirty);
  428. *jh_out = new_jh;
  429. /*
  430.  * Did we need to do an escaping?  Now we've done all the
  431.  * copying, we can finally do so.
  432.  */
  433. if (do_escape)
  434. * ((unsigned int *) mapped_data) = 0;
  435. kunmap(new_page);
  436. /*
  437.  * The to-be-written buffer needs to get moved to the io queue,
  438.  * and the original buffer whose contents we are shadowing or
  439.  * copying is moved to the transaction's shadow queue.
  440.  */
  441. JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
  442. journal_file_buffer(jh_in, transaction, BJ_Shadow);
  443. JBUFFER_TRACE(new_jh, "file as BJ_IO");
  444. journal_file_buffer(new_jh, transaction, BJ_IO);
  445. return do_escape | (done_copy_out << 1);
  446. }
  447. /*
  448.  * Allocation code for the journal file.  Manage the space left in the
  449.  * journal, so that we can begin checkpointing when appropriate.
  450.  */
  451. /*
  452.  * log_space_left: Return the number of free blocks left in the journal.
  453.  *
  454.  * Called with the journal already locked.
  455.  */
  456. int log_space_left (journal_t *journal)
  457. {
  458. int left = journal->j_free;
  459. /* Be pessimistic here about the number of those free blocks
  460.  * which might be required for log descriptor control blocks. */
  461. #define MIN_LOG_RESERVED_BLOCKS 32 /* Allow for rounding errors */
  462. left -= MIN_LOG_RESERVED_BLOCKS;
  463. if (left <= 0)
  464. return 0;
  465. left -= (left >> 3);
  466. return left;
  467. }
  468. /*
  469.  * This function must be non-allocating for PF_MEMALLOC tasks
  470.  */
  471. tid_t log_start_commit (journal_t *journal, transaction_t *transaction)
  472. {
  473. tid_t target = journal->j_commit_request;
  474. lock_kernel(); /* Protect journal->j_running_transaction */
  475. /*
  476.  * A NULL transaction asks us to commit the currently running
  477.  * transaction, if there is one.  
  478.  */
  479. if (transaction)
  480. target = transaction->t_tid;
  481. else {
  482. transaction = journal->j_running_transaction;
  483. if (!transaction)
  484. goto out;
  485. target = transaction->t_tid;
  486. }
  487. /*
  488.  * Are we already doing a recent enough commit?
  489.  */
  490. if (tid_geq(journal->j_commit_request, target))
  491. goto out;
  492. /*
  493.  * We want a new commit: OK, mark the request and wakup the
  494.  * commit thread.  We do _not_ do the commit ourselves.
  495.  */
  496. journal->j_commit_request = target;
  497. jbd_debug(1, "JBD: requesting commit %d/%dn",
  498.   journal->j_commit_request,
  499.   journal->j_commit_sequence);
  500. wake_up(&journal->j_wait_commit);
  501. out:
  502. unlock_kernel();
  503. return target;
  504. }
  505. /*
  506.  * Wait for a specified commit to complete.
  507.  * The caller may not hold the journal lock.
  508.  */
  509. void log_wait_commit (journal_t *journal, tid_t tid)
  510. {
  511. lock_kernel();
  512. #ifdef CONFIG_JBD_DEBUG
  513. lock_journal(journal);
  514. if (!tid_geq(journal->j_commit_request, tid)) {
  515. printk(KERN_EMERG __FUNCTION__
  516. ": error: j_commit_request=%d, tid=%dn",
  517. journal->j_commit_request, tid);
  518. }
  519. unlock_journal(journal);
  520. #endif
  521. while (tid_gt(tid, journal->j_commit_sequence)) {
  522. jbd_debug(1, "JBD: want %d, j_commit_sequence=%dn",
  523.   tid, journal->j_commit_sequence);
  524. wake_up(&journal->j_wait_commit);
  525. sleep_on(&journal->j_wait_done_commit);
  526. }
  527. unlock_kernel();
  528. }
  529. /*
  530.  * Log buffer allocation routines:
  531.  */
  532. int journal_next_log_block(journal_t *journal, unsigned long *retp)
  533. {
  534. unsigned long blocknr;
  535. J_ASSERT(journal->j_free > 1);
  536. blocknr = journal->j_head;
  537. journal->j_head++;
  538. journal->j_free--;
  539. if (journal->j_head == journal->j_last)
  540. journal->j_head = journal->j_first;
  541. return journal_bmap(journal, blocknr, retp);
  542. }
  543. /*
  544.  * Conversion of logical to physical block numbers for the journal
  545.  *
  546.  * On external journals the journal blocks are identity-mapped, so
  547.  * this is a no-op.  If needed, we can use j_blk_offset - everything is
  548.  * ready.
  549.  */
  550. int journal_bmap(journal_t *journal, unsigned long blocknr, 
  551.  unsigned long *retp)
  552. {
  553. int err = 0;
  554. unsigned long ret;
  555. if (journal->j_inode) {
  556. ret = bmap(journal->j_inode, blocknr);
  557. if (ret)
  558. *retp = ret;
  559. else {
  560. printk (KERN_ALERT __FUNCTION__ 
  561. ": journal block not found "
  562. "at offset %lu on %sn",
  563. blocknr, bdevname(journal->j_dev));
  564. err = -EIO;
  565. __journal_abort_soft(journal, err);
  566. }
  567. } else {
  568. *retp = blocknr; /* +journal->j_blk_offset */
  569. }
  570. return err;
  571. }
  572. /*
  573.  * We play buffer_head aliasing tricks to write data/metadata blocks to
  574.  * the journal without copying their contents, but for journal
  575.  * descriptor blocks we do need to generate bona fide buffers.
  576.  *
  577.  * We return a jh whose bh is locked and ready to be populated.
  578.  */
  579. struct journal_head * journal_get_descriptor_buffer(journal_t *journal)
  580. {
  581. struct buffer_head *bh;
  582. unsigned long blocknr;
  583. int err;
  584. err = journal_next_log_block(journal, &blocknr);
  585. if (err)
  586. return NULL;
  587. bh = getblk(journal->j_dev, blocknr, journal->j_blocksize);
  588. lock_buffer(bh);
  589. BUFFER_TRACE(bh, "return this buffer");
  590. return journal_add_journal_head(bh);
  591. }
  592. /*
  593.  * Management for journal control blocks: functions to create and
  594.  * destroy journal_t structures, and to initialise and read existing
  595.  * journal blocks from disk.  */
  596. /* First: create and setup a journal_t object in memory.  We initialise
  597.  * very few fields yet: that has to wait until we have created the
  598.  * journal structures from from scratch, or loaded them from disk. */
  599. static journal_t * journal_init_common (void)
  600. {
  601. journal_t *journal;
  602. int err;
  603. MOD_INC_USE_COUNT;
  604. journal = jbd_kmalloc(sizeof(*journal), GFP_KERNEL);
  605. if (!journal)
  606. goto fail;
  607. memset(journal, 0, sizeof(*journal));
  608. init_waitqueue_head(&journal->j_wait_transaction_locked);
  609. init_waitqueue_head(&journal->j_wait_logspace);
  610. init_waitqueue_head(&journal->j_wait_done_commit);
  611. init_waitqueue_head(&journal->j_wait_checkpoint);
  612. init_waitqueue_head(&journal->j_wait_commit);
  613. init_waitqueue_head(&journal->j_wait_updates);
  614. init_MUTEX(&journal->j_barrier);
  615. init_MUTEX(&journal->j_checkpoint_sem);
  616. init_MUTEX(&journal->j_sem);
  617. journal->j_commit_interval = (HZ * 5);
  618. /* The journal is marked for error until we succeed with recovery! */
  619. journal->j_flags = JFS_ABORT;
  620. /* Set up a default-sized revoke table for the new mount. */
  621. err = journal_init_revoke(journal, JOURNAL_REVOKE_DEFAULT_HASH);
  622. if (err) {
  623. kfree(journal);
  624. goto fail;
  625. }
  626. return journal;
  627. fail:
  628. MOD_DEC_USE_COUNT;
  629. return NULL;
  630. }
  631. /* journal_init_dev and journal_init_inode:
  632.  *
  633.  * Create a journal structure assigned some fixed set of disk blocks to
  634.  * the journal.  We don't actually touch those disk blocks yet, but we
  635.  * need to set up all of the mapping information to tell the journaling
  636.  * system where the journal blocks are.
  637.  *
  638.  * journal_init_dev creates a journal which maps a fixed contiguous
  639.  * range of blocks on an arbitrary block device.
  640.  *
  641.  * journal_init_inode creates a journal which maps an on-disk inode as
  642.  * the journal.  The inode must exist already, must support bmap() and
  643.  * must have all data blocks preallocated.
  644.  */
  645. journal_t * journal_init_dev(kdev_t dev, kdev_t fs_dev,
  646. int start, int len, int blocksize)
  647. {
  648. journal_t *journal = journal_init_common();
  649. struct buffer_head *bh;
  650. if (!journal)
  651. return NULL;
  652. journal->j_dev = dev;
  653. journal->j_fs_dev = fs_dev;
  654. journal->j_blk_offset = start;
  655. journal->j_maxlen = len;
  656. journal->j_blocksize = blocksize;
  657. bh = getblk(journal->j_dev, start, journal->j_blocksize);
  658. J_ASSERT(bh != NULL);
  659. journal->j_sb_buffer = bh;
  660. journal->j_superblock = (journal_superblock_t *)bh->b_data;
  661. return journal;
  662. }
  663. journal_t * journal_init_inode (struct inode *inode)
  664. {
  665. struct buffer_head *bh;
  666. journal_t *journal = journal_init_common();
  667. int err;
  668. unsigned long blocknr;
  669. if (!journal)
  670. return NULL;
  671. journal->j_dev = inode->i_dev;
  672. journal->j_fs_dev = inode->i_dev;
  673. journal->j_inode = inode;
  674. jbd_debug(1,
  675.   "journal %p: inode %s/%ld, size %Ld, bits %d, blksize %ldn",
  676.   journal, bdevname(inode->i_dev), inode->i_ino, 
  677.   (long long) inode->i_size,
  678.   inode->i_sb->s_blocksize_bits, inode->i_sb->s_blocksize);
  679. journal->j_maxlen = inode->i_size >> inode->i_sb->s_blocksize_bits;
  680. journal->j_blocksize = inode->i_sb->s_blocksize;
  681. err = journal_bmap(journal, 0, &blocknr);
  682. /* If that failed, give up */
  683. if (err) {
  684. printk(KERN_ERR __FUNCTION__ ": Cannnot locate journal "
  685.        "superblockn");
  686. kfree(journal);
  687. return NULL;
  688. }
  689. bh = getblk(journal->j_dev, blocknr, journal->j_blocksize);
  690. J_ASSERT(bh != NULL);
  691. journal->j_sb_buffer = bh;
  692. journal->j_superblock = (journal_superblock_t *)bh->b_data;
  693. return journal;
  694. }
  695. /* 
  696.  * If the journal init or create aborts, we need to mark the journal
  697.  * superblock as being NULL to prevent the journal destroy from writing
  698.  * back a bogus superblock. 
  699.  */
  700. static void journal_fail_superblock (journal_t *journal)
  701. {
  702. struct buffer_head *bh = journal->j_sb_buffer;
  703. brelse(bh);
  704. journal->j_sb_buffer = NULL;
  705. }
  706. /*
  707.  * Given a journal_t structure, initialise the various fields for
  708.  * startup of a new journaling session.  We use this both when creating
  709.  * a journal, and after recovering an old journal to reset it for
  710.  * subsequent use.
  711.  */
  712. static int journal_reset (journal_t *journal)
  713. {
  714. journal_superblock_t *sb = journal->j_superblock;
  715. unsigned int first, last;
  716. first = ntohl(sb->s_first);
  717. last = ntohl(sb->s_maxlen);
  718. journal->j_first = first;
  719. journal->j_last = last;
  720. journal->j_head = first;
  721. journal->j_tail = first;
  722. journal->j_free = last - first;
  723. journal->j_tail_sequence = journal->j_transaction_sequence;
  724. journal->j_commit_sequence = journal->j_transaction_sequence - 1;
  725. journal->j_commit_request = journal->j_commit_sequence;
  726. journal->j_max_transaction_buffers = journal->j_maxlen / 4;
  727. /* Add the dynamic fields and write it to disk. */
  728. journal_update_superblock(journal, 1);
  729. lock_journal(journal);
  730. journal_start_thread(journal);
  731. unlock_journal(journal);
  732. return 0;
  733. }
  734. /*
  735.  * Given a journal_t structure which tells us which disk blocks we can
  736.  * use, create a new journal superblock and initialise all of the
  737.  * journal fields from scratch.  */
  738. int journal_create (journal_t *journal)
  739. {
  740. unsigned long blocknr;
  741. struct buffer_head *bh;
  742. journal_superblock_t *sb;
  743. int i, err;
  744. if (journal->j_maxlen < JFS_MIN_JOURNAL_BLOCKS) {
  745. printk (KERN_ERR "Journal length (%d blocks) too short.n",
  746. journal->j_maxlen);
  747. journal_fail_superblock(journal);
  748. return -EINVAL;
  749. }
  750. if (journal->j_inode == NULL) {
  751. /*
  752.  * We don't know what block to start at!
  753.  */
  754. printk(KERN_EMERG __FUNCTION__
  755. ": creation of journal on external device!n");
  756. BUG();
  757. }
  758. /* Zero out the entire journal on disk.  We cannot afford to
  759.    have any blocks on disk beginning with JFS_MAGIC_NUMBER. */
  760. jbd_debug(1, "JBD: Zeroing out journal blocks...n");
  761. for (i = 0; i < journal->j_maxlen; i++) {
  762. err = journal_bmap(journal, i, &blocknr);
  763. if (err)
  764. return err;
  765. bh = getblk(journal->j_dev, blocknr, journal->j_blocksize);
  766. wait_on_buffer(bh);
  767. memset (bh->b_data, 0, journal->j_blocksize);
  768. BUFFER_TRACE(bh, "marking dirty");
  769. mark_buffer_dirty(bh);
  770. BUFFER_TRACE(bh, "marking uptodate");
  771. mark_buffer_uptodate(bh, 1);
  772. __brelse(bh);
  773. }
  774. sync_dev(journal->j_dev);
  775. jbd_debug(1, "JBD: journal cleared.n");
  776. /* OK, fill in the initial static fields in the new superblock */
  777. sb = journal->j_superblock;
  778. sb->s_header.h_magic  = htonl(JFS_MAGIC_NUMBER);
  779. sb->s_header.h_blocktype = htonl(JFS_SUPERBLOCK_V2);
  780. sb->s_blocksize = htonl(journal->j_blocksize);
  781. sb->s_maxlen = htonl(journal->j_maxlen);
  782. sb->s_first = htonl(1);
  783. journal->j_transaction_sequence = 1;
  784. journal->j_flags &= ~JFS_ABORT;
  785. journal->j_format_version = 2;
  786. return journal_reset(journal);
  787. }
  788. /*
  789.  * Update a journal's dynamic superblock fields and write it to disk,
  790.  * optionally waiting for the IO to complete.
  791. */
  792. void journal_update_superblock(journal_t *journal, int wait)
  793. {
  794. journal_superblock_t *sb = journal->j_superblock;
  795. struct buffer_head *bh = journal->j_sb_buffer;
  796. jbd_debug(1,"JBD: updating superblock (start %ld, seq %d, errno %d)n",
  797.   journal->j_tail, journal->j_tail_sequence, journal->j_errno);
  798. sb->s_sequence = htonl(journal->j_tail_sequence);
  799. sb->s_start    = htonl(journal->j_tail);
  800. sb->s_errno    = htonl(journal->j_errno);
  801. BUFFER_TRACE(bh, "marking dirty");
  802. mark_buffer_dirty(bh);
  803. ll_rw_block(WRITE, 1, &bh);
  804. if (wait)
  805. wait_on_buffer(bh);
  806. /* If we have just flushed the log (by marking s_start==0), then
  807.  * any future commit will have to be careful to update the
  808.  * superblock again to re-record the true start of the log. */
  809. if (sb->s_start)
  810. journal->j_flags &= ~JFS_FLUSHED;
  811. else
  812. journal->j_flags |= JFS_FLUSHED;
  813. }
  814. /*
  815.  * Read the superblock for a given journal, performing initial
  816.  * validation of the format.
  817.  */
  818. static int journal_get_superblock(journal_t *journal)
  819. {
  820. struct buffer_head *bh;
  821. journal_superblock_t *sb;
  822. int err = -EIO;
  823. bh = journal->j_sb_buffer;
  824. J_ASSERT(bh != NULL);
  825. if (!buffer_uptodate(bh)) {
  826. ll_rw_block(READ, 1, &bh);
  827. wait_on_buffer(bh);
  828. if (!buffer_uptodate(bh)) {
  829. printk (KERN_ERR
  830. "JBD: IO error reading journal superblockn");
  831. goto out;
  832. }
  833. }
  834. sb = journal->j_superblock;
  835. err = -EINVAL;
  836. if (sb->s_header.h_magic != htonl(JFS_MAGIC_NUMBER) ||
  837.     sb->s_blocksize != htonl(journal->j_blocksize)) {
  838. printk(KERN_WARNING "JBD: no valid journal superblock foundn");
  839. goto out;
  840. }
  841. switch(ntohl(sb->s_header.h_blocktype)) {
  842. case JFS_SUPERBLOCK_V1:
  843. journal->j_format_version = 1;
  844. break;
  845. case JFS_SUPERBLOCK_V2:
  846. journal->j_format_version = 2;
  847. break;
  848. default:
  849. printk(KERN_WARNING "JBD: unrecognised superblock format IDn");
  850. goto out;
  851. }
  852. if (ntohl(sb->s_maxlen) < journal->j_maxlen)
  853. journal->j_maxlen = ntohl(sb->s_maxlen);
  854. else if (ntohl(sb->s_maxlen) > journal->j_maxlen) {
  855. printk (KERN_WARNING "JBD: journal file too shortn");
  856. goto out;
  857. }
  858. return 0;
  859. out:
  860. journal_fail_superblock(journal);
  861. return err;
  862. }
  863. /*
  864.  * Load the on-disk journal superblock and read the key fields into the
  865.  * journal_t.
  866.  */
  867. static int load_superblock(journal_t *journal)
  868. {
  869. int err;
  870. journal_superblock_t *sb;
  871. err = journal_get_superblock(journal);
  872. if (err)
  873. return err;
  874. sb = journal->j_superblock;
  875. journal->j_tail_sequence = ntohl(sb->s_sequence);
  876. journal->j_tail = ntohl(sb->s_start);
  877. journal->j_first = ntohl(sb->s_first);
  878. journal->j_last = ntohl(sb->s_maxlen);
  879. journal->j_errno = ntohl(sb->s_errno);
  880. return 0;
  881. }
  882. /*
  883.  * Given a journal_t structure which tells us which disk blocks contain
  884.  * a journal, read the journal from disk to initialise the in-memory
  885.  * structures.
  886.  */
  887. int journal_load(journal_t *journal)
  888. {
  889. int err;
  890. err = load_superblock(journal);
  891. if (err)
  892. return err;
  893. /* If this is a V2 superblock, then we have to check the
  894.  * features flags on it. */
  895. if (journal->j_format_version >= 2) {
  896. journal_superblock_t *sb = journal->j_superblock;
  897. if ((sb->s_feature_ro_compat &
  898.      ~cpu_to_be32(JFS_KNOWN_ROCOMPAT_FEATURES)) ||
  899.     (sb->s_feature_incompat &
  900.      ~cpu_to_be32(JFS_KNOWN_INCOMPAT_FEATURES))) {
  901. printk (KERN_WARNING
  902. "JBD: Unrecognised features on journaln");
  903. return -EINVAL;
  904. }
  905. }
  906. /* Let the recovery code check whether it needs to recover any
  907.  * data from the journal. */
  908. if (journal_recover(journal))
  909. goto recovery_error;
  910. /* OK, we've finished with the dynamic journal bits:
  911.  * reinitialise the dynamic contents of the superblock in memory
  912.  * and reset them on disk. */
  913. if (journal_reset(journal))
  914. goto recovery_error;
  915. journal->j_flags &= ~JFS_ABORT;
  916. journal->j_flags |= JFS_LOADED;
  917. return 0;
  918. recovery_error:
  919. printk (KERN_WARNING "JBD: recovery failedn");
  920. return -EIO;
  921. }
  922. /*
  923.  * Release a journal_t structure once it is no longer in use by the
  924.  * journaled object.
  925.  */
  926. void journal_destroy (journal_t *journal)
  927. {
  928. /* Wait for the commit thread to wake up and die. */
  929. journal_kill_thread(journal);
  930. /* Force a final log commit */
  931. if (journal->j_running_transaction)
  932. journal_commit_transaction(journal);
  933. /* Force any old transactions to disk */
  934. lock_journal(journal);
  935. while (journal->j_checkpoint_transactions != NULL)
  936. log_do_checkpoint(journal, 1);
  937. J_ASSERT(journal->j_running_transaction == NULL);
  938. J_ASSERT(journal->j_committing_transaction == NULL);
  939. J_ASSERT(journal->j_checkpoint_transactions == NULL);
  940. /* We can now mark the journal as empty. */
  941. journal->j_tail = 0;
  942. journal->j_tail_sequence = ++journal->j_transaction_sequence;
  943. if (journal->j_sb_buffer) {
  944. journal_update_superblock(journal, 1);
  945. brelse(journal->j_sb_buffer);
  946. }
  947. if (journal->j_inode)
  948. iput(journal->j_inode);
  949. if (journal->j_revoke)
  950. journal_destroy_revoke(journal);
  951. unlock_journal(journal);
  952. kfree(journal);
  953. MOD_DEC_USE_COUNT;
  954. }
  955. /* Published API: Check whether the journal uses all of a given set of
  956.  * features.  Return true (non-zero) if it does. */
  957. int journal_check_used_features (journal_t *journal, unsigned long compat,
  958.  unsigned long ro, unsigned long incompat)
  959. {
  960. journal_superblock_t *sb;
  961. if (!compat && !ro && !incompat)
  962. return 1;
  963. if (journal->j_format_version == 1)
  964. return 0;
  965. sb = journal->j_superblock;
  966. if (((be32_to_cpu(sb->s_feature_compat) & compat) == compat) &&
  967.     ((be32_to_cpu(sb->s_feature_ro_compat) & ro) == ro) &&
  968.     ((be32_to_cpu(sb->s_feature_incompat) & incompat) == incompat))
  969. return 1;
  970. return 0;
  971. }
  972. /* Published API: Check whether the journaling code supports the use of
  973.  * all of a given set of features on this journal.  Return true
  974.  * (non-zero) if it can. */
  975. int journal_check_available_features (journal_t *journal, unsigned long compat,
  976.       unsigned long ro, unsigned long incompat)
  977. {
  978. journal_superblock_t *sb;
  979. if (!compat && !ro && !incompat)
  980. return 1;
  981. sb = journal->j_superblock;
  982. /* We can support any known requested features iff the
  983.  * superblock is in version 2.  Otherwise we fail to support any
  984.  * extended sb features. */
  985. if (journal->j_format_version != 2)
  986. return 0;
  987. if ((compat   & JFS_KNOWN_COMPAT_FEATURES) == compat &&
  988.     (ro       & JFS_KNOWN_ROCOMPAT_FEATURES) == ro &&
  989.     (incompat & JFS_KNOWN_INCOMPAT_FEATURES) == incompat)
  990. return 1;
  991. return 0;
  992. }
  993. /* Published API: Mark a given journal feature as present on the
  994.  * superblock.  Returns true if the requested features could be set. */
  995. int journal_set_features (journal_t *journal, unsigned long compat,
  996.   unsigned long ro, unsigned long incompat)
  997. {
  998. journal_superblock_t *sb;
  999. if (journal_check_used_features(journal, compat, ro, incompat))
  1000. return 1;
  1001. if (!journal_check_available_features(journal, compat, ro, incompat))
  1002. return 0;
  1003. jbd_debug(1, "Setting new features 0x%lx/0x%lx/0x%lxn",
  1004.   compat, ro, incompat);
  1005. sb = journal->j_superblock;
  1006. sb->s_feature_compat    |= cpu_to_be32(compat);
  1007. sb->s_feature_ro_compat |= cpu_to_be32(ro);
  1008. sb->s_feature_incompat  |= cpu_to_be32(incompat);
  1009. return 1;
  1010. }
  1011. /*
  1012.  * Published API:
  1013.  * Given an initialised but unloaded journal struct, poke about in the
  1014.  * on-disk structure to update it to the most recent supported version.
  1015.  */
  1016. int journal_update_format (journal_t *journal)
  1017. {
  1018. journal_superblock_t *sb;
  1019. int err;
  1020. err = journal_get_superblock(journal);
  1021. if (err)
  1022. return err;
  1023. sb = journal->j_superblock;
  1024. switch (ntohl(sb->s_header.h_blocktype)) {
  1025. case JFS_SUPERBLOCK_V2:
  1026. return 0;
  1027. case JFS_SUPERBLOCK_V1:
  1028. return journal_convert_superblock_v1(journal, sb);
  1029. default:
  1030. break;
  1031. }
  1032. return -EINVAL;
  1033. }
  1034. static int journal_convert_superblock_v1(journal_t *journal,
  1035.  journal_superblock_t *sb)
  1036. {
  1037. int offset, blocksize;
  1038. struct buffer_head *bh;
  1039. printk(KERN_WARNING
  1040. "JBD: Converting superblock from version 1 to 2.n");
  1041. /* Pre-initialise new fields to zero */
  1042. offset = ((char *) &(sb->s_feature_compat)) - ((char *) sb);
  1043. blocksize = ntohl(sb->s_blocksize);
  1044. memset(&sb->s_feature_compat, 0, blocksize-offset);
  1045. sb->s_nr_users = cpu_to_be32(1);
  1046. sb->s_header.h_blocktype = cpu_to_be32(JFS_SUPERBLOCK_V2);
  1047. journal->j_format_version = 2;
  1048. bh = journal->j_sb_buffer;
  1049. BUFFER_TRACE(bh, "marking dirty");
  1050. mark_buffer_dirty(bh);
  1051. ll_rw_block(WRITE, 1, &bh);
  1052. wait_on_buffer(bh);
  1053. return 0;
  1054. }
  1055. /*
  1056.  * Flush all data for a given journal to disk and empty the journal.
  1057.  * Filesystems can use this when remounting readonly to ensure that
  1058.  * recovery does not need to happen on remount.
  1059.  */
  1060. int journal_flush (journal_t *journal)
  1061. {
  1062. int err = 0;
  1063. transaction_t *transaction = NULL;
  1064. unsigned long old_tail;
  1065. lock_kernel();
  1066. /* Force everything buffered to the log... */
  1067. if (journal->j_running_transaction) {
  1068. transaction = journal->j_running_transaction;
  1069. log_start_commit(journal, transaction);
  1070. } else if (journal->j_committing_transaction)
  1071. transaction = journal->j_committing_transaction;
  1072. /* Wait for the log commit to complete... */
  1073. if (transaction)
  1074. log_wait_commit(journal, transaction->t_tid);
  1075. /* ...and flush everything in the log out to disk. */
  1076. lock_journal(journal);
  1077. while (!err && journal->j_checkpoint_transactions != NULL)
  1078. err = log_do_checkpoint(journal, journal->j_maxlen);
  1079. cleanup_journal_tail(journal);
  1080. /* Finally, mark the journal as really needing no recovery.
  1081.  * This sets s_start==0 in the underlying superblock, which is
  1082.  * the magic code for a fully-recovered superblock.  Any future
  1083.  * commits of data to the journal will restore the current
  1084.  * s_start value. */
  1085. old_tail = journal->j_tail;
  1086. journal->j_tail = 0;
  1087. journal_update_superblock(journal, 1);
  1088. journal->j_tail = old_tail;
  1089. unlock_journal(journal);
  1090. J_ASSERT(!journal->j_running_transaction);
  1091. J_ASSERT(!journal->j_committing_transaction);
  1092. J_ASSERT(!journal->j_checkpoint_transactions);
  1093. J_ASSERT(journal->j_head == journal->j_tail);
  1094. J_ASSERT(journal->j_tail_sequence == journal->j_transaction_sequence);
  1095. unlock_kernel();
  1096. return err;
  1097. }
  1098. /*
  1099.  * Wipe out all of the contents of a journal, safely.  This will produce
  1100.  * a warning if the journal contains any valid recovery information.
  1101.  * Must be called between journal_init_*() and journal_load().
  1102.  *
  1103.  * If (write) is non-zero, then we wipe out the journal on disk; otherwise
  1104.  * we merely suppress recovery.
  1105.  */
  1106. int journal_wipe (journal_t *journal, int write)
  1107. {
  1108. journal_superblock_t *sb;
  1109. int err = 0;
  1110. J_ASSERT (!(journal->j_flags & JFS_LOADED));
  1111. err = load_superblock(journal);
  1112. if (err)
  1113. return err;
  1114. sb = journal->j_superblock;
  1115. if (!journal->j_tail)
  1116. goto no_recovery;
  1117. printk (KERN_WARNING "JBD: %s recovery information on journaln",
  1118. write ? "Clearing" : "Ignoring");
  1119. err = journal_skip_recovery(journal);
  1120. if (write)
  1121. journal_update_superblock(journal, 1);
  1122.  no_recovery:
  1123. return err;
  1124. }
  1125. /*
  1126.  * journal_dev_name: format a character string to describe on what
  1127.  * device this journal is present.
  1128.  */
  1129. const char * journal_dev_name(journal_t *journal)
  1130. {
  1131. kdev_t dev;
  1132. if (journal->j_inode)
  1133. dev = journal->j_inode->i_dev;
  1134. else
  1135. dev = journal->j_dev;
  1136. return bdevname(dev);
  1137. }
  1138. /*
  1139.  * journal_abort: perform a complete, immediate shutdown of the ENTIRE
  1140.  * journal (not of a single transaction).  This operation cannot be
  1141.  * undone without closing and reopening the journal.
  1142.  *
  1143.  * The journal_abort function is intended to support higher level error
  1144.  * recovery mechanisms such as the ext2/ext3 remount-readonly error
  1145.  * mode.
  1146.  *
  1147.  * Journal abort has very specific semantics.  Any existing dirty,
  1148.  * unjournaled buffers in the main filesystem will still be written to
  1149.  * disk by bdflush, but the journaling mechanism will be suspended
  1150.  * immediately and no further transaction commits will be honoured.
  1151.  *
  1152.  * Any dirty, journaled buffers will be written back to disk without
  1153.  * hitting the journal.  Atomicity cannot be guaranteed on an aborted
  1154.  * filesystem, but we _do_ attempt to leave as much data as possible
  1155.  * behind for fsck to use for cleanup.
  1156.  *
  1157.  * Any attempt to get a new transaction handle on a journal which is in
  1158.  * ABORT state will just result in an -EROFS error return.  A
  1159.  * journal_stop on an existing handle will return -EIO if we have
  1160.  * entered abort state during the update.
  1161.  *
  1162.  * Recursive transactions are not disturbed by journal abort until the
  1163.  * final journal_stop, which will receive the -EIO error.
  1164.  *
  1165.  * Finally, the journal_abort call allows the caller to supply an errno
  1166.  * which will be recored (if possible) in the journal superblock.  This
  1167.  * allows a client to record failure conditions in the middle of a
  1168.  * transaction without having to complete the transaction to record the
  1169.  * failure to disk.  ext3_error, for example, now uses this
  1170.  * functionality.
  1171.  *
  1172.  * Errors which originate from within the journaling layer will NOT
  1173.  * supply an errno; a null errno implies that absolutely no further
  1174.  * writes are done to the journal (unless there are any already in
  1175.  * progress).
  1176.  */
  1177. /* Quick version for internal journal use (doesn't lock the journal).
  1178.  * Aborts hard --- we mark the abort as occurred, but do _nothing_ else,
  1179.  * and don't attempt to make any other journal updates. */
  1180. void __journal_abort_hard (journal_t *journal)
  1181. {
  1182. transaction_t *transaction;
  1183. if (journal->j_flags & JFS_ABORT)
  1184. return;
  1185. printk (KERN_ERR "Aborting journal on device %s.n",
  1186. journal_dev_name(journal));
  1187. journal->j_flags |= JFS_ABORT;
  1188. transaction = journal->j_running_transaction;
  1189. if (transaction)
  1190. log_start_commit(journal, transaction);
  1191. }
  1192. /* Soft abort: record the abort error status in the journal superblock,
  1193.  * but don't do any other IO. */
  1194. void __journal_abort_soft (journal_t *journal, int errno)
  1195. {
  1196. if (journal->j_flags & JFS_ABORT)
  1197. return;
  1198. if (!journal->j_errno)
  1199. journal->j_errno = errno;
  1200. __journal_abort_hard(journal);
  1201. if (errno)
  1202. journal_update_superblock(journal, 1);
  1203. }
  1204. /* Full version for external use */
  1205. void journal_abort (journal_t *journal, int errno)
  1206. {
  1207. lock_journal(journal);
  1208. __journal_abort_soft(journal, errno);
  1209. unlock_journal(journal);
  1210. }
  1211. int journal_errno (journal_t *journal)
  1212. {
  1213. int err;
  1214. lock_journal(journal);
  1215. if (journal->j_flags & JFS_ABORT)
  1216. err = -EROFS;
  1217. else
  1218. err = journal->j_errno;
  1219. unlock_journal(journal);
  1220. return err;
  1221. }
  1222. int journal_clear_err (journal_t *journal)
  1223. {
  1224. int err = 0;
  1225. lock_journal(journal);
  1226. if (journal->j_flags & JFS_ABORT)
  1227. err = -EROFS;
  1228. else
  1229. journal->j_errno = 0;
  1230. unlock_journal(journal);
  1231. return err;
  1232. }
  1233. void journal_ack_err (journal_t *journal)
  1234. {
  1235. lock_journal(journal);
  1236. if (journal->j_errno)
  1237. journal->j_flags |= JFS_ACK_ERR;
  1238. unlock_journal(journal);
  1239. }
  1240. int journal_blocks_per_page(struct inode *inode)
  1241. {
  1242. return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits);
  1243. }
  1244. /*
  1245.  * shrink_journal_memory().
  1246.  * Called when we're under memory pressure.  Free up all the written-back
  1247.  * checkpointed metadata buffers.
  1248.  */
  1249. void shrink_journal_memory(void)
  1250. {
  1251. struct list_head *list;
  1252. lock_kernel();
  1253. list_for_each(list, &all_journals) {
  1254. journal_t *journal =
  1255. list_entry(list, journal_t, j_all_journals);
  1256. spin_lock(&journal_datalist_lock);
  1257. __journal_clean_checkpoint_list(journal);
  1258. spin_unlock(&journal_datalist_lock);
  1259. }
  1260. unlock_kernel();
  1261. }
  1262. /*
  1263.  * Simple support for retying memory allocations.  Introduced to help to
  1264.  * debug different VM deadlock avoidance strategies. 
  1265.  */
  1266. /*
  1267.  * Simple support for retying memory allocations.  Introduced to help to
  1268.  * debug different VM deadlock avoidance strategies. 
  1269.  */
  1270. void * __jbd_kmalloc (char *where, size_t size, int flags, int retry)
  1271. {
  1272. void *p;
  1273. static unsigned long last_warning;
  1274. while (1) {
  1275. p = kmalloc(size, flags);
  1276. if (p)
  1277. return p;
  1278. if (!retry)
  1279. return NULL;
  1280. /* Log every retry for debugging.  Also log them to the
  1281.  * syslog, but do rate-limiting on the non-debugging
  1282.  * messages. */
  1283. jbd_debug(1, "ENOMEM in %s, retrying.n", where);
  1284. if (time_after(jiffies, last_warning + 5*HZ)) {
  1285. printk(KERN_NOTICE
  1286.        "ENOMEM in %s, retrying.n", where);
  1287. last_warning = jiffies;
  1288. }
  1289. current->policy |= SCHED_YIELD;
  1290. schedule();
  1291. }
  1292. }
  1293. /*
  1294.  * Journal_head storage management
  1295.  */
  1296. static kmem_cache_t *journal_head_cache;
  1297. #ifdef CONFIG_JBD_DEBUG
  1298. static atomic_t nr_journal_heads = ATOMIC_INIT(0);
  1299. #endif
  1300. static int journal_init_journal_head_cache(void)
  1301. {
  1302. int retval;
  1303. J_ASSERT(journal_head_cache == 0);
  1304. journal_head_cache = kmem_cache_create("journal_head",
  1305. sizeof(struct journal_head),
  1306. 0, /* offset */
  1307. 0, /* flags */
  1308. NULL, /* ctor */
  1309. NULL); /* dtor */
  1310. retval = 0;
  1311. if (journal_head_cache == 0) {
  1312. retval = -ENOMEM;
  1313. printk(KERN_EMERG "JBD: no memory for journal_head cachen");
  1314. }
  1315. return retval;
  1316. }
  1317. static void journal_destroy_journal_head_cache(void)
  1318. {
  1319. J_ASSERT(journal_head_cache != NULL);
  1320. kmem_cache_destroy(journal_head_cache);
  1321. journal_head_cache = 0;
  1322. }
  1323. /*
  1324.  * journal_head splicing and dicing
  1325.  */
  1326. static struct journal_head *journal_alloc_journal_head(void)
  1327. {
  1328. struct journal_head *ret;
  1329. static unsigned long last_warning;
  1330. #ifdef CONFIG_JBD_DEBUG
  1331. atomic_inc(&nr_journal_heads);
  1332. #endif
  1333. ret = kmem_cache_alloc(journal_head_cache, GFP_NOFS);
  1334. if (ret == 0) {
  1335. jbd_debug(1, "out of memory for journal_headn");
  1336. if (time_after(jiffies, last_warning + 5*HZ)) {
  1337. printk(KERN_NOTICE "ENOMEM in " __FUNCTION__
  1338.        ", retrying.n");
  1339. last_warning = jiffies;
  1340. }
  1341. while (ret == 0) {
  1342. current->policy |= SCHED_YIELD;
  1343. schedule();
  1344. ret = kmem_cache_alloc(journal_head_cache, GFP_NOFS);
  1345. }
  1346. }
  1347. return ret;
  1348. }
  1349. static void journal_free_journal_head(struct journal_head *jh)
  1350. {
  1351. #ifdef CONFIG_JBD_DEBUG
  1352. atomic_dec(&nr_journal_heads);
  1353. memset(jh, 0x5b, sizeof(*jh));
  1354. #endif
  1355. kmem_cache_free(journal_head_cache, jh);
  1356. }
  1357. /*
  1358.  * A journal_head is attached to a buffer_head whenever JBD has an
  1359.  * interest in the buffer.
  1360.  *
  1361.  * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
  1362.  * is set.  This bit is tested in core kernel code where we need to take
  1363.  * JBD-specific actions.  Testing the zeroness of ->b_private is not reliable
  1364.  * there.
  1365.  *
  1366.  * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
  1367.  *
  1368.  * When a buffer has its BH_JBD bit set it is immune from being released by
  1369.  * core kernel code, mainly via ->b_count.
  1370.  *
  1371.  * A journal_head may be detached from its buffer_head when the journal_head's
  1372.  * b_transaction, b_cp_transaction and b_next_transaction pointers are NULL.
  1373.  * Various places in JBD call journal_remove_journal_head() to indicate that the
  1374.  * journal_head can be dropped if needed.
  1375.  *
  1376.  * Various places in the kernel want to attach a journal_head to a buffer_head
  1377.  * _before_ attaching the journal_head to a transaction.  To protect the
  1378.  * journal_head in this situation, journal_add_journal_head elevates the
  1379.  * journal_head's b_jcount refcount by one.  The caller must call
  1380.  * journal_unlock_journal_head() to undo this.
  1381.  *
  1382.  * So the typical usage would be:
  1383.  *
  1384.  * (Attach a journal_head if needed.  Increments b_jcount)
  1385.  * struct journal_head *jh = journal_add_journal_head(bh);
  1386.  * ...
  1387.  * jh->b_transaction = xxx;
  1388.  * journal_unlock_journal_head(jh);
  1389.  *
  1390.  * Now, the journal_head's b_jcount is zero, but it is safe from being released
  1391.  * because it has a non-zero b_transaction.
  1392.  */
  1393. /*
  1394.  * Give a buffer_head a journal_head.
  1395.  *
  1396.  * Doesn't need the journal lock.
  1397.  * May sleep.
  1398.  * Cannot be called with journal_datalist_lock held.
  1399.  */
  1400. struct journal_head *journal_add_journal_head(struct buffer_head *bh)
  1401. {
  1402. struct journal_head *jh;
  1403. spin_lock(&journal_datalist_lock);
  1404. if (buffer_jbd(bh)) {
  1405. jh = bh2jh(bh);
  1406. } else {
  1407. J_ASSERT_BH(bh,
  1408. (atomic_read(&bh->b_count) > 0) ||
  1409. (bh->b_page && bh->b_page->mapping));
  1410. spin_unlock(&journal_datalist_lock);
  1411. jh = journal_alloc_journal_head();
  1412. memset(jh, 0, sizeof(*jh));
  1413. spin_lock(&journal_datalist_lock);
  1414. if (buffer_jbd(bh)) {
  1415. /* Someone did it for us! */
  1416. J_ASSERT_BH(bh, bh->b_private != NULL);
  1417. journal_free_journal_head(jh);
  1418. jh = bh->b_private;
  1419. } else {
  1420. /*
  1421.  * We actually don't need jh_splice_lock when
  1422.  * adding a journal_head - only on removal.
  1423.  */
  1424. spin_lock(&jh_splice_lock);
  1425. set_bit(BH_JBD, &bh->b_state);
  1426. bh->b_private = jh;
  1427. jh->b_bh = bh;
  1428. atomic_inc(&bh->b_count);
  1429. spin_unlock(&jh_splice_lock);
  1430. BUFFER_TRACE(bh, "added journal_head");
  1431. }
  1432. }
  1433. jh->b_jcount++;
  1434. spin_unlock(&journal_datalist_lock);
  1435. return bh->b_private;
  1436. }
  1437. /*
  1438.  * journal_remove_journal_head(): if the buffer isn't attached to a transaction
  1439.  * and has a zero b_jcount then remove and release its journal_head.   If we did
  1440.  * see that the buffer is not used by any transaction we also "logically"
  1441.  * decrement ->b_count.
  1442.  *
  1443.  * We in fact take an additional increment on ->b_count as a convenience,
  1444.  * because the caller usually wants to do additional things with the bh
  1445.  * after calling here.
  1446.  * The caller of journal_remove_journal_head() *must* run __brelse(bh) at some
  1447.  * time.  Once the caller has run __brelse(), the buffer is eligible for
  1448.  * reaping by try_to_free_buffers().
  1449.  *
  1450.  * Requires journal_datalist_lock.
  1451.  */
  1452. void __journal_remove_journal_head(struct buffer_head *bh)
  1453. {
  1454. struct journal_head *jh = bh2jh(bh);
  1455. assert_spin_locked(&journal_datalist_lock);
  1456. J_ASSERT_JH(jh, jh->b_jcount >= 0);
  1457. atomic_inc(&bh->b_count);
  1458. if (jh->b_jcount == 0) {
  1459. if (jh->b_transaction == NULL &&
  1460. jh->b_next_transaction == NULL &&
  1461. jh->b_cp_transaction == NULL) {
  1462. J_ASSERT_BH(bh, buffer_jbd(bh));
  1463. J_ASSERT_BH(bh, jh2bh(jh) == bh);
  1464. BUFFER_TRACE(bh, "remove journal_head");
  1465. spin_lock(&jh_splice_lock);
  1466. bh->b_private = NULL;
  1467. jh->b_bh = NULL; /* debug, really */
  1468. clear_bit(BH_JBD, &bh->b_state);
  1469. __brelse(bh);
  1470. spin_unlock(&jh_splice_lock);
  1471. journal_free_journal_head(jh);
  1472. } else {
  1473. BUFFER_TRACE(bh, "journal_head was locked");
  1474. }
  1475. }
  1476. }
  1477. void journal_unlock_journal_head(struct journal_head *jh)
  1478. {
  1479. spin_lock(&journal_datalist_lock);
  1480. J_ASSERT_JH(jh, jh->b_jcount > 0);
  1481. --jh->b_jcount;
  1482. if (!jh->b_jcount && !jh->b_transaction) {
  1483. struct buffer_head *bh;
  1484. bh = jh2bh(jh);
  1485. __journal_remove_journal_head(bh);
  1486. __brelse(bh);
  1487. }
  1488. spin_unlock(&journal_datalist_lock);
  1489. }
  1490. void journal_remove_journal_head(struct buffer_head *bh)
  1491. {
  1492. spin_lock(&journal_datalist_lock);
  1493. __journal_remove_journal_head(bh);
  1494. spin_unlock(&journal_datalist_lock);
  1495. }
  1496. /*
  1497.  * /proc tunables
  1498.  */
  1499. #if defined(CONFIG_JBD_DEBUG)
  1500. int journal_enable_debug;
  1501. EXPORT_SYMBOL(journal_enable_debug);
  1502. #endif
  1503. #if defined(CONFIG_JBD_DEBUG) && defined(CONFIG_PROC_FS)
  1504. static struct proc_dir_entry *proc_jbd_debug;
  1505. int read_jbd_debug(char *page, char **start, off_t off,
  1506.   int count, int *eof, void *data)
  1507. {
  1508. int ret;
  1509. ret = sprintf(page + off, "%dn", journal_enable_debug);
  1510. *eof = 1;
  1511. return ret;
  1512. }
  1513. int write_jbd_debug(struct file *file, const char *buffer,
  1514.    unsigned long count, void *data)
  1515. {
  1516. char buf[32];
  1517. if (count > ARRAY_SIZE(buf) - 1)
  1518. count = ARRAY_SIZE(buf) - 1;
  1519. if (copy_from_user(buf, buffer, count))
  1520. return -EFAULT;
  1521. buf[ARRAY_SIZE(buf) - 1] = '';
  1522. journal_enable_debug = simple_strtoul(buf, NULL, 10);
  1523. return count;
  1524. }
  1525. #define JBD_PROC_NAME "sys/fs/jbd-debug"
  1526. static void __init create_jbd_proc_entry(void)
  1527. {
  1528. proc_jbd_debug = create_proc_entry(JBD_PROC_NAME, 0644, NULL);
  1529. if (proc_jbd_debug) {
  1530. /* Why is this so hard? */
  1531. proc_jbd_debug->read_proc = read_jbd_debug;
  1532. proc_jbd_debug->write_proc = write_jbd_debug;
  1533. }
  1534. }
  1535. static void __exit remove_jbd_proc_entry(void)
  1536. {
  1537. if (proc_jbd_debug)
  1538. remove_proc_entry(JBD_PROC_NAME, NULL);
  1539. }
  1540. #else
  1541. #define create_jbd_proc_entry() do {} while (0)
  1542. #define remove_jbd_proc_entry() do {} while (0)
  1543. #endif
  1544. /*
  1545.  * Module startup and shutdown
  1546.  */
  1547. static int __init journal_init_caches(void)
  1548. {
  1549. int ret;
  1550. ret = journal_init_revoke_caches();
  1551. if (ret == 0)
  1552. ret = journal_init_journal_head_cache();
  1553. return ret;
  1554. }
  1555. static void journal_destroy_caches(void)
  1556. {
  1557. journal_destroy_revoke_caches();
  1558. journal_destroy_journal_head_cache();
  1559. }
  1560. static int __init journal_init(void)
  1561. {
  1562. int ret;
  1563. printk(KERN_INFO "Journalled Block Device driver loadedn");
  1564. ret = journal_init_caches();
  1565. if (ret != 0)
  1566. journal_destroy_caches();
  1567. create_jbd_proc_entry();
  1568. return ret;
  1569. }
  1570. static void __exit journal_exit(void)
  1571. {
  1572. #ifdef CONFIG_JBD_DEBUG
  1573. int n = atomic_read(&nr_journal_heads);
  1574. if (n)
  1575. printk(KERN_EMERG "JBD: leaked %d journal_heads!n", n);
  1576. #endif
  1577. remove_jbd_proc_entry();
  1578. journal_destroy_caches();
  1579. }
  1580. MODULE_LICENSE("GPL");
  1581. module_init(journal_init);
  1582. module_exit(journal_exit);