journal.c
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:50k
源码类别:

Linux/Unix编程

开发平台:

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_callback_set);
  60. EXPORT_SYMBOL(journal_init_dev);
  61. EXPORT_SYMBOL(journal_init_inode);
  62. EXPORT_SYMBOL(journal_update_format);
  63. EXPORT_SYMBOL(journal_check_used_features);
  64. EXPORT_SYMBOL(journal_check_available_features);
  65. EXPORT_SYMBOL(journal_set_features);
  66. EXPORT_SYMBOL(journal_create);
  67. EXPORT_SYMBOL(journal_load);
  68. EXPORT_SYMBOL(journal_destroy);
  69. EXPORT_SYMBOL(journal_recover);
  70. EXPORT_SYMBOL(journal_update_superblock);
  71. EXPORT_SYMBOL(journal_abort);
  72. EXPORT_SYMBOL(journal_errno);
  73. EXPORT_SYMBOL(journal_ack_err);
  74. EXPORT_SYMBOL(journal_clear_err);
  75. EXPORT_SYMBOL(log_wait_commit);
  76. EXPORT_SYMBOL(log_start_commit);
  77. EXPORT_SYMBOL(journal_wipe);
  78. EXPORT_SYMBOL(journal_blocks_per_page);
  79. EXPORT_SYMBOL(journal_flushpage);
  80. EXPORT_SYMBOL(journal_try_to_free_buffers);
  81. EXPORT_SYMBOL(journal_bmap);
  82. EXPORT_SYMBOL(journal_force_commit);
  83. static int journal_convert_superblock_v1(journal_t *, journal_superblock_t *);
  84. /*
  85.  * journal_datalist_lock is used to protect data buffers:
  86.  *
  87.  * bh->b_transaction
  88.  * bh->b_tprev
  89.  * bh->b_tnext
  90.  *
  91.  * journal_free_buffer() is called from journal_try_to_free_buffer(), and is
  92.  * async wrt everything else.
  93.  *
  94.  * It is also used for checkpoint data, also to protect against
  95.  * journal_try_to_free_buffer():
  96.  *
  97.  * bh->b_cp_transaction
  98.  * bh->b_cpnext
  99.  * bh->b_cpprev
  100.  * transaction->t_checkpoint_list
  101.  * transaction->t_cpnext
  102.  * transaction->t_cpprev
  103.  * journal->j_checkpoint_transactions
  104.  *
  105.  * It is global at this time rather than per-journal because it's
  106.  * impossible for __journal_free_buffer to go from a buffer_head
  107.  * back to a journal_t unracily (well, not true.  Fix later)
  108.  *
  109.  *
  110.  * The `datalist' and `checkpoint list' functions are quite
  111.  * separate and we could use two spinlocks here.
  112.  *
  113.  * lru_list_lock nests inside journal_datalist_lock.
  114.  */
  115. spinlock_t journal_datalist_lock = SPIN_LOCK_UNLOCKED;
  116. /*
  117.  * jh_splice_lock needs explantion.
  118.  *
  119.  * In a number of places we want to do things like:
  120.  *
  121.  * if (buffer_jbd(bh) && bh2jh(bh)->foo)
  122.  *
  123.  * This is racy on SMP, because another CPU could remove the journal_head
  124.  * in the middle of this expression.  We need locking.
  125.  *
  126.  * But we can greatly optimise the locking cost by testing BH_JBD
  127.  * outside the lock.  So, effectively:
  128.  *
  129.  * ret = 0;
  130.  * if (buffer_jbd(bh)) {
  131.  * spin_lock(&jh_splice_lock);
  132.  * if (buffer_jbd(bh)) {  (* Still there? *)
  133.  * ret = bh2jh(bh)->foo;
  134.  * }
  135.  * spin_unlock(&jh_splice_lock);
  136.  * }
  137.  * return ret;
  138.  *
  139.  * Now, that protects us from races where another CPU can remove the
  140.  * journal_head.  But it doesn't defend us from the situation where another
  141.  * CPU can *add* a journal_head.  This is a correctness issue.  But it's not
  142.  * a problem because a) the calling code was *already* racy and b) it often
  143.  * can't happen at the call site and c) the places where we add journal_heads
  144.  * tend to be under external locking.
  145.  */
  146. spinlock_t jh_splice_lock = SPIN_LOCK_UNLOCKED;
  147. /*
  148.  * List of all journals in the system.  Protected by the BKL.
  149.  */
  150. static LIST_HEAD(all_journals);
  151. /*
  152.  * Helper function used to manage commit timeouts
  153.  */
  154. static void commit_timeout(unsigned long __data)
  155. {
  156. struct task_struct * p = (struct task_struct *) __data;
  157. wake_up_process(p);
  158. }
  159. /* Static check for data structure consistency.  There's no code
  160.  * invoked --- we'll just get a linker failure if things aren't right.
  161.  */
  162. void __journal_internal_check(void)
  163. {
  164. extern void journal_bad_superblock_size(void);
  165. if (sizeof(struct journal_superblock_s) != 1024)
  166. journal_bad_superblock_size();
  167. }
  168. /*
  169.  * kjournald: The main thread function used to manage a logging device
  170.  * journal.
  171.  *
  172.  * This kernel thread is responsible for two things:
  173.  *
  174.  * 1) COMMIT:  Every so often we need to commit the current state of the
  175.  *    filesystem to disk.  The journal thread is responsible for writing
  176.  *    all of the metadata buffers to disk.
  177.  *
  178.  * 2) CHECKPOINT: We cannot reuse a used section of the log file until all
  179.  *    of the data in that part of the log has been rewritten elsewhere on
  180.  *    the disk.  Flushing these old buffers to reclaim space in the log is
  181.  *    known as checkpointing, and this thread is responsible for that job.
  182.  */
  183. journal_t *current_journal; // AKPM: debug
  184. int kjournald(void *arg)
  185. {
  186. journal_t *journal = (journal_t *) arg;
  187. transaction_t *transaction;
  188. struct timer_list timer;
  189. current_journal = journal;
  190. lock_kernel();
  191. daemonize();
  192. reparent_to_init();
  193. spin_lock_irq(&current->sigmask_lock);
  194. sigfillset(&current->blocked);
  195. recalc_sigpending(current);
  196. spin_unlock_irq(&current->sigmask_lock);
  197. sprintf(current->comm, "kjournald");
  198. /* Set up an interval timer which can be used to trigger a
  199.            commit wakeup after the commit interval expires */
  200. init_timer(&timer);
  201. timer.data = (unsigned long) current;
  202. timer.function = commit_timeout;
  203. journal->j_commit_timer = &timer;
  204. /* Record that the journal thread is running */
  205. journal->j_task = current;
  206. wake_up(&journal->j_wait_done_commit);
  207. printk(KERN_INFO "kjournald starting.  Commit interval %ld secondsn",
  208. journal->j_commit_interval / HZ);
  209. list_add(&journal->j_all_journals, &all_journals);
  210. /* And now, wait forever for commit wakeup events. */
  211. while (1) {
  212. if (journal->j_flags & JFS_UNMOUNT)
  213. break;
  214. jbd_debug(1, "commit_sequence=%d, commit_request=%dn",
  215. journal->j_commit_sequence, journal->j_commit_request);
  216. if (journal->j_commit_sequence != journal->j_commit_request) {
  217. jbd_debug(1, "OK, requests differn");
  218. if (journal->j_commit_timer_active) {
  219. journal->j_commit_timer_active = 0;
  220. del_timer(journal->j_commit_timer);
  221. }
  222. journal_commit_transaction(journal);
  223. continue;
  224. }
  225. wake_up(&journal->j_wait_done_commit);
  226. interruptible_sleep_on(&journal->j_wait_commit);
  227. jbd_debug(1, "kjournald wakesn");
  228. /* Were we woken up by a commit wakeup event? */
  229. if ((transaction = journal->j_running_transaction) != NULL &&
  230.     time_after_eq(jiffies, transaction->t_expires)) {
  231. journal->j_commit_request = transaction->t_tid;
  232. jbd_debug(1, "woke because of timeoutn");
  233. }
  234. }
  235. if (journal->j_commit_timer_active) {
  236. journal->j_commit_timer_active = 0;
  237. del_timer_sync(journal->j_commit_timer);
  238. }
  239. list_del(&journal->j_all_journals);
  240. journal->j_task = NULL;
  241. wake_up(&journal->j_wait_done_commit);
  242. unlock_kernel();
  243. jbd_debug(1, "Journal thread exiting.n");
  244. return 0;
  245. }
  246. static void journal_start_thread(journal_t *journal)
  247. {
  248. kernel_thread(kjournald, (void *) journal,
  249.       CLONE_VM | CLONE_FS | CLONE_FILES);
  250. while (!journal->j_task)
  251. sleep_on(&journal->j_wait_done_commit);
  252. }
  253. static void journal_kill_thread(journal_t *journal)
  254. {
  255. journal->j_flags |= JFS_UNMOUNT;
  256. while (journal->j_task) {
  257. wake_up(&journal->j_wait_commit);
  258. sleep_on(&journal->j_wait_done_commit);
  259. }
  260. }
  261. #if 0
  262. This is no longer needed - we do it in commit quite efficiently.
  263. Note that if this function is resurrected, the loop needs to
  264. be reorganised into the next_jh/last_jh algorithm.
  265. /*
  266.  * journal_clean_data_list: cleanup after data IO.
  267.  *
  268.  * Once the IO system has finished writing the buffers on the transaction's
  269.  * data list, we can remove those buffers from the list.  This function
  270.  * scans the list for such buffers and removes them cleanly.
  271.  *
  272.  * We assume that the journal is already locked.
  273.  * We are called with journal_datalist_lock held.
  274.  *
  275.  * AKPM: This function looks inefficient.  Approximately O(n^2)
  276.  * for potentially thousands of buffers.  It no longer shows on profiles
  277.  * because these buffers are mainly dropped in journal_commit_transaction().
  278.  */
  279. void __journal_clean_data_list(transaction_t *transaction)
  280. {
  281. struct journal_head *jh, *next;
  282. assert_spin_locked(&journal_datalist_lock);
  283. restart:
  284. jh = transaction->t_sync_datalist;
  285. if (!jh)
  286. goto out;
  287. do {
  288. next = jh->b_tnext;
  289. if (!buffer_locked(jh2bh(jh)) && !buffer_dirty(jh2bh(jh))) {
  290. struct buffer_head *bh = jh2bh(jh);
  291. BUFFER_TRACE(bh, "data writeout complete: unfile");
  292. __journal_unfile_buffer(jh);
  293. jh->b_transaction = NULL;
  294. __journal_remove_journal_head(bh);
  295. refile_buffer(bh);
  296. __brelse(bh);
  297. goto restart;
  298. }
  299. jh = next;
  300. } while (transaction->t_sync_datalist &&
  301. jh != transaction->t_sync_datalist);
  302. out:
  303. return;
  304. }
  305. #endif
  306. /*
  307.  * journal_write_metadata_buffer: write a metadata buffer to the journal.
  308.  *
  309.  * Writes a metadata buffer to a given disk block.  The actual IO is not
  310.  * performed but a new buffer_head is constructed which labels the data
  311.  * to be written with the correct destination disk block.
  312.  *
  313.  * Any magic-number escaping which needs to be done will cause a
  314.  * copy-out here.  If the buffer happens to start with the
  315.  * JFS_MAGIC_NUMBER, then we can't write it to the log directly: the
  316.  * magic number is only written to the log for descripter blocks.  In
  317.  * this case, we copy the data and replace the first word with 0, and we
  318.  * return a result code which indicates that this buffer needs to be
  319.  * marked as an escaped buffer in the corresponding log descriptor
  320.  * block.  The missing word can then be restored when the block is read
  321.  * during recovery.
  322.  *
  323.  * If the source buffer has already been modified by a new transaction
  324.  * since we took the last commit snapshot, we use the frozen copy of
  325.  * that data for IO.  If we end up using the existing buffer_head's data
  326.  * for the write, then we *have* to lock the buffer to prevent anyone
  327.  * else from using and possibly modifying it while the IO is in
  328.  * progress.
  329.  *
  330.  * The function returns a pointer to the buffer_heads to be used for IO.
  331.  *
  332.  * We assume that the journal has already been locked in this function.
  333.  *
  334.  * Return value:
  335.  *  <0: Error
  336.  * >=0: Finished OK
  337.  *
  338.  * On success:
  339.  * Bit 0 set == escape performed on the data
  340.  * Bit 1 set == buffer copy-out performed (kfree the data after IO)
  341.  */
  342. static inline unsigned long virt_to_offset(void *p) 
  343. {return ((unsigned long) p) & ~PAGE_MASK;}
  344.        
  345. int journal_write_metadata_buffer(transaction_t *transaction,
  346.   struct journal_head  *jh_in,
  347.   struct journal_head **jh_out,
  348.   int blocknr)
  349. {
  350. int need_copy_out = 0;
  351. int done_copy_out = 0;
  352. int do_escape = 0;
  353. char *mapped_data;
  354. struct buffer_head *new_bh;
  355. struct journal_head * new_jh;
  356. struct page *new_page;
  357. unsigned int new_offset;
  358. /*
  359.  * The buffer really shouldn't be locked: only the current committing
  360.  * transaction is allowed to write it, so nobody else is allowed
  361.  * to do any IO.
  362.  *
  363.  * akpm: except if we're journalling data, and write() output is
  364.  * also part of a shared mapping, and another thread has
  365.  * decided to launch a writepage() against this buffer.
  366.  */
  367. J_ASSERT_JH(jh_in, buffer_jdirty(jh2bh(jh_in)));
  368. /*
  369.  * If a new transaction has already done a buffer copy-out, then
  370.  * we use that version of the data for the commit.
  371.  */
  372. if (jh_in->b_frozen_data) {
  373. done_copy_out = 1;
  374. new_page = virt_to_page(jh_in->b_frozen_data);
  375. new_offset = virt_to_offset(jh_in->b_frozen_data);
  376. } else {
  377. new_page = jh2bh(jh_in)->b_page;
  378. new_offset = virt_to_offset(jh2bh(jh_in)->b_data);
  379. }
  380. mapped_data = ((char *) kmap(new_page)) + new_offset;
  381. /*
  382.  * Check for escaping
  383.  */
  384. if (* ((unsigned int *) mapped_data) == htonl(JFS_MAGIC_NUMBER)) {
  385. need_copy_out = 1;
  386. do_escape = 1;
  387. }
  388. /*
  389.  * Do we need to do a data copy?
  390.  */
  391. if (need_copy_out && !done_copy_out) {
  392. char *tmp;
  393. tmp = jbd_rep_kmalloc(jh2bh(jh_in)->b_size, GFP_NOFS);
  394. jh_in->b_frozen_data = tmp;
  395. memcpy (tmp, mapped_data, jh2bh(jh_in)->b_size);
  396. /* If we get to this path, we'll always need the new
  397.    address kmapped so that we can clear the escaped
  398.    magic number below. */
  399. kunmap(new_page);
  400. new_page = virt_to_page(tmp);
  401. new_offset = virt_to_offset(tmp);
  402. mapped_data = ((char *) kmap(new_page)) + new_offset;
  403. done_copy_out = 1;
  404. }
  405. /*
  406.  * Right, time to make up the new buffer_head.
  407.  */
  408. do {
  409. new_bh = get_unused_buffer_head(0);
  410. if (!new_bh) {
  411. printk (KERN_NOTICE "%s: ENOMEM at "
  412. "get_unused_buffer_head, trying again.n",
  413. __FUNCTION__);
  414. yield();
  415. }
  416. } while (!new_bh);
  417. /* keep subsequent assertions sane */
  418. new_bh->b_prev_free = 0;
  419. new_bh->b_next_free = 0;
  420. new_bh->b_state = 0;
  421. init_buffer(new_bh, NULL, NULL);
  422. atomic_set(&new_bh->b_count, 1);
  423. new_jh = journal_add_journal_head(new_bh);
  424. set_bh_page(new_bh, new_page, new_offset);
  425. new_jh->b_transaction = NULL;
  426. new_bh->b_size = jh2bh(jh_in)->b_size;
  427. new_bh->b_dev = transaction->t_journal->j_dev;
  428. new_bh->b_blocknr = blocknr;
  429. new_bh->b_state |= (1 << BH_Mapped) | (1 << BH_Dirty);
  430. *jh_out = new_jh;
  431. /*
  432.  * Did we need to do an escaping?  Now we've done all the
  433.  * copying, we can finally do so.
  434.  */
  435. if (do_escape)
  436. * ((unsigned int *) mapped_data) = 0;
  437. kunmap(new_page);
  438. /*
  439.  * The to-be-written buffer needs to get moved to the io queue,
  440.  * and the original buffer whose contents we are shadowing or
  441.  * copying is moved to the transaction's shadow queue.
  442.  */
  443. JBUFFER_TRACE(jh_in, "file as BJ_Shadow");
  444. journal_file_buffer(jh_in, transaction, BJ_Shadow);
  445. JBUFFER_TRACE(new_jh, "file as BJ_IO");
  446. journal_file_buffer(new_jh, transaction, BJ_IO);
  447. return do_escape | (done_copy_out << 1);
  448. }
  449. /*
  450.  * Allocation code for the journal file.  Manage the space left in the
  451.  * journal, so that we can begin checkpointing when appropriate.
  452.  */
  453. /*
  454.  * log_space_left: Return the number of free blocks left in the journal.
  455.  *
  456.  * Called with the journal already locked.
  457.  */
  458. int log_space_left (journal_t *journal)
  459. {
  460. int left = journal->j_free;
  461. /* Be pessimistic here about the number of those free blocks
  462.  * which might be required for log descriptor control blocks. */
  463. #define MIN_LOG_RESERVED_BLOCKS 32 /* Allow for rounding errors */
  464. left -= MIN_LOG_RESERVED_BLOCKS;
  465. if (left <= 0)
  466. return 0;
  467. left -= (left >> 3);
  468. return left;
  469. }
  470. /*
  471.  * This function must be non-allocating for PF_MEMALLOC tasks
  472.  */
  473. tid_t log_start_commit (journal_t *journal, transaction_t *transaction)
  474. {
  475. tid_t target = journal->j_commit_request;
  476. lock_kernel(); /* Protect journal->j_running_transaction */
  477. /*
  478.  * A NULL transaction asks us to commit the currently running
  479.  * transaction, if there is one.  
  480.  */
  481. if (transaction)
  482. target = transaction->t_tid;
  483. else {
  484. transaction = journal->j_running_transaction;
  485. if (!transaction)
  486. goto out;
  487. target = transaction->t_tid;
  488. }
  489. /*
  490.  * Are we already doing a recent enough commit?
  491.  */
  492. if (tid_geq(journal->j_commit_request, target))
  493. goto out;
  494. /*
  495.  * We want a new commit: OK, mark the request and wakup the
  496.  * commit thread.  We do _not_ do the commit ourselves.
  497.  */
  498. journal->j_commit_request = target;
  499. jbd_debug(1, "JBD: requesting commit %d/%dn",
  500.   journal->j_commit_request,
  501.   journal->j_commit_sequence);
  502. wake_up(&journal->j_wait_commit);
  503. out:
  504. unlock_kernel();
  505. return target;
  506. }
  507. /*
  508.  * Wait for a specified commit to complete.
  509.  * The caller may not hold the journal lock.
  510.  */
  511. void log_wait_commit (journal_t *journal, tid_t tid)
  512. {
  513. lock_kernel();
  514. #ifdef CONFIG_JBD_DEBUG
  515. lock_journal(journal);
  516. if (!tid_geq(journal->j_commit_request, tid)) {
  517. printk(KERN_EMERG "%s: error: j_commit_request=%d, tid=%dn",
  518. __FUNCTION__, journal->j_commit_request, tid);
  519. }
  520. unlock_journal(journal);
  521. #endif
  522. while (tid_gt(tid, journal->j_commit_sequence)) {
  523. jbd_debug(1, "JBD: want %d, j_commit_sequence=%dn",
  524.   tid, journal->j_commit_sequence);
  525. wake_up(&journal->j_wait_commit);
  526. sleep_on(&journal->j_wait_done_commit);
  527. }
  528. unlock_kernel();
  529. }
  530. /*
  531.  * Log buffer allocation routines:
  532.  */
  533. int journal_next_log_block(journal_t *journal, unsigned long *retp)
  534. {
  535. unsigned long blocknr;
  536. J_ASSERT(journal->j_free > 1);
  537. blocknr = journal->j_head;
  538. journal->j_head++;
  539. journal->j_free--;
  540. if (journal->j_head == journal->j_last)
  541. journal->j_head = journal->j_first;
  542. return journal_bmap(journal, blocknr, retp);
  543. }
  544. /*
  545.  * Conversion of logical to physical block numbers for the journal
  546.  *
  547.  * On external journals the journal blocks are identity-mapped, so
  548.  * this is a no-op.  If needed, we can use j_blk_offset - everything is
  549.  * ready.
  550.  */
  551. int journal_bmap(journal_t *journal, unsigned long blocknr, 
  552.  unsigned long *retp)
  553. {
  554. int err = 0;
  555. unsigned long ret;
  556. if (journal->j_inode) {
  557. ret = bmap(journal->j_inode, blocknr);
  558. if (ret)
  559. *retp = ret;
  560. else {
  561. printk (KERN_ALERT "%s: journal block not found "
  562. "at offset %lu on %sn", __FUNCTION__,
  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 "%s: Cannnot locate journal superblockn",
  685. __FUNCTION__);
  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 "%s: creation of journal on external "
  755. "device!n", __FUNCTION__);
  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. /*
  1241.  * Report any unexpected dirty buffers which turn up.  Normally those
  1242.  * indicate an error, but they can occur if the user is running (say)
  1243.  * tune2fs to modify the live filesystem, so we need the option of
  1244.  * continuing as gracefully as possible.  #
  1245.  *
  1246.  * The caller should already hold the journal lock and
  1247.  * journal_datalist_lock spinlock: most callers will need those anyway
  1248.  * in order to probe the buffer's journaling state safely.
  1249.  */
  1250. void __jbd_unexpected_dirty_buffer(char *function, int line, 
  1251.  struct journal_head *jh)
  1252. {
  1253. struct buffer_head *bh = jh2bh(jh);
  1254. int jlist;
  1255. if (buffer_dirty(bh)) {
  1256. printk ("%sUnexpected dirty buffer encountered at "
  1257. "%s:%d (%s blocknr %lu)n",
  1258. KERN_WARNING, function, line,
  1259. kdevname(bh->b_dev), bh->b_blocknr);
  1260. #ifdef JBD_PARANOID_WRITES
  1261. J_ASSERT_BH (bh, !buffer_dirty(bh));
  1262. #endif
  1263. /* If this buffer is one which might reasonably be dirty
  1264.  * --- ie. data, or not part of this journal --- then
  1265.  * we're OK to leave it alone, but otherwise we need to
  1266.  * move the dirty bit to the journal's own internal
  1267.  * JBDDirty bit. */
  1268. jlist = jh->b_jlist;
  1269. if (jlist == BJ_Metadata || jlist == BJ_Reserved || 
  1270.     jlist == BJ_Shadow || jlist == BJ_Forget) {
  1271. if (atomic_set_buffer_clean(jh2bh(jh))) {
  1272. set_bit(BH_JBDDirty, &jh2bh(jh)->b_state);
  1273. }
  1274. }
  1275. }
  1276. }
  1277. int journal_blocks_per_page(struct inode *inode)
  1278. {
  1279. return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits);
  1280. }
  1281. /*
  1282.  * shrink_journal_memory().
  1283.  * Called when we're under memory pressure.  Free up all the written-back
  1284.  * checkpointed metadata buffers.
  1285.  */
  1286. void shrink_journal_memory(void)
  1287. {
  1288. struct list_head *list;
  1289. lock_kernel();
  1290. list_for_each(list, &all_journals) {
  1291. journal_t *journal =
  1292. list_entry(list, journal_t, j_all_journals);
  1293. spin_lock(&journal_datalist_lock);
  1294. __journal_clean_checkpoint_list(journal);
  1295. spin_unlock(&journal_datalist_lock);
  1296. }
  1297. unlock_kernel();
  1298. }
  1299. /*
  1300.  * Simple support for retying memory allocations.  Introduced to help to
  1301.  * debug different VM deadlock avoidance strategies. 
  1302.  */
  1303. /*
  1304.  * Simple support for retying memory allocations.  Introduced to help to
  1305.  * debug different VM deadlock avoidance strategies. 
  1306.  */
  1307. void * __jbd_kmalloc (char *where, size_t size, int flags, int retry)
  1308. {
  1309. void *p;
  1310. static unsigned long last_warning;
  1311. while (1) {
  1312. p = kmalloc(size, flags);
  1313. if (p)
  1314. return p;
  1315. if (!retry)
  1316. return NULL;
  1317. /* Log every retry for debugging.  Also log them to the
  1318.  * syslog, but do rate-limiting on the non-debugging
  1319.  * messages. */
  1320. jbd_debug(1, "ENOMEM in %s, retrying.n", where);
  1321. if (time_after(jiffies, last_warning + 5*HZ)) {
  1322. printk(KERN_NOTICE
  1323.        "ENOMEM in %s, retrying.n", where);
  1324. last_warning = jiffies;
  1325. }
  1326. yield();
  1327. }
  1328. }
  1329. /*
  1330.  * Journal_head storage management
  1331.  */
  1332. static kmem_cache_t *journal_head_cache;
  1333. #ifdef CONFIG_JBD_DEBUG
  1334. static atomic_t nr_journal_heads = ATOMIC_INIT(0);
  1335. #endif
  1336. static int journal_init_journal_head_cache(void)
  1337. {
  1338. int retval;
  1339. J_ASSERT(journal_head_cache == 0);
  1340. journal_head_cache = kmem_cache_create("journal_head",
  1341. sizeof(struct journal_head),
  1342. 0, /* offset */
  1343. 0, /* flags */
  1344. NULL, /* ctor */
  1345. NULL); /* dtor */
  1346. retval = 0;
  1347. if (journal_head_cache == 0) {
  1348. retval = -ENOMEM;
  1349. printk(KERN_EMERG "JBD: no memory for journal_head cachen");
  1350. }
  1351. return retval;
  1352. }
  1353. static void journal_destroy_journal_head_cache(void)
  1354. {
  1355. J_ASSERT(journal_head_cache != NULL);
  1356. kmem_cache_destroy(journal_head_cache);
  1357. journal_head_cache = 0;
  1358. }
  1359. /*
  1360.  * journal_head splicing and dicing
  1361.  */
  1362. static struct journal_head *journal_alloc_journal_head(void)
  1363. {
  1364. struct journal_head *ret;
  1365. static unsigned long last_warning;
  1366. #ifdef CONFIG_JBD_DEBUG
  1367. atomic_inc(&nr_journal_heads);
  1368. #endif
  1369. ret = kmem_cache_alloc(journal_head_cache, GFP_NOFS);
  1370. if (ret == 0) {
  1371. jbd_debug(1, "out of memory for journal_headn");
  1372. if (time_after(jiffies, last_warning + 5*HZ)) {
  1373. printk(KERN_NOTICE "ENOMEM in %s, retrying.n",
  1374. __FUNCTION__);
  1375. last_warning = jiffies;
  1376. }
  1377. while (ret == 0) {
  1378. yield();
  1379. ret = kmem_cache_alloc(journal_head_cache, GFP_NOFS);
  1380. }
  1381. }
  1382. return ret;
  1383. }
  1384. static void journal_free_journal_head(struct journal_head *jh)
  1385. {
  1386. #ifdef CONFIG_JBD_DEBUG
  1387. atomic_dec(&nr_journal_heads);
  1388. memset(jh, 0x5b, sizeof(*jh));
  1389. #endif
  1390. kmem_cache_free(journal_head_cache, jh);
  1391. }
  1392. /*
  1393.  * A journal_head is attached to a buffer_head whenever JBD has an
  1394.  * interest in the buffer.
  1395.  *
  1396.  * Whenever a buffer has an attached journal_head, its ->b_state:BH_JBD bit
  1397.  * is set.  This bit is tested in core kernel code where we need to take
  1398.  * JBD-specific actions.  Testing the zeroness of ->b_private is not reliable
  1399.  * there.
  1400.  *
  1401.  * When a buffer has its BH_JBD bit set, its ->b_count is elevated by one.
  1402.  *
  1403.  * When a buffer has its BH_JBD bit set it is immune from being released by
  1404.  * core kernel code, mainly via ->b_count.
  1405.  *
  1406.  * A journal_head may be detached from its buffer_head when the journal_head's
  1407.  * b_transaction, b_cp_transaction and b_next_transaction pointers are NULL.
  1408.  * Various places in JBD call journal_remove_journal_head() to indicate that the
  1409.  * journal_head can be dropped if needed.
  1410.  *
  1411.  * Various places in the kernel want to attach a journal_head to a buffer_head
  1412.  * _before_ attaching the journal_head to a transaction.  To protect the
  1413.  * journal_head in this situation, journal_add_journal_head elevates the
  1414.  * journal_head's b_jcount refcount by one.  The caller must call
  1415.  * journal_unlock_journal_head() to undo this.
  1416.  *
  1417.  * So the typical usage would be:
  1418.  *
  1419.  * (Attach a journal_head if needed.  Increments b_jcount)
  1420.  * struct journal_head *jh = journal_add_journal_head(bh);
  1421.  * ...
  1422.  * jh->b_transaction = xxx;
  1423.  * journal_unlock_journal_head(jh);
  1424.  *
  1425.  * Now, the journal_head's b_jcount is zero, but it is safe from being released
  1426.  * because it has a non-zero b_transaction.
  1427.  */
  1428. /*
  1429.  * Give a buffer_head a journal_head.
  1430.  *
  1431.  * Doesn't need the journal lock.
  1432.  * May sleep.
  1433.  * Cannot be called with journal_datalist_lock held.
  1434.  */
  1435. struct journal_head *journal_add_journal_head(struct buffer_head *bh)
  1436. {
  1437. struct journal_head *jh;
  1438. spin_lock(&journal_datalist_lock);
  1439. if (buffer_jbd(bh)) {
  1440. jh = bh2jh(bh);
  1441. } else {
  1442. J_ASSERT_BH(bh,
  1443. (atomic_read(&bh->b_count) > 0) ||
  1444. (bh->b_page && bh->b_page->mapping));
  1445. spin_unlock(&journal_datalist_lock);
  1446. jh = journal_alloc_journal_head();
  1447. memset(jh, 0, sizeof(*jh));
  1448. spin_lock(&journal_datalist_lock);
  1449. if (buffer_jbd(bh)) {
  1450. /* Someone did it for us! */
  1451. J_ASSERT_BH(bh, bh->b_private != NULL);
  1452. journal_free_journal_head(jh);
  1453. jh = bh->b_private;
  1454. } else {
  1455. /*
  1456.  * We actually don't need jh_splice_lock when
  1457.  * adding a journal_head - only on removal.
  1458.  */
  1459. spin_lock(&jh_splice_lock);
  1460. set_bit(BH_JBD, &bh->b_state);
  1461. bh->b_private = jh;
  1462. jh->b_bh = bh;
  1463. atomic_inc(&bh->b_count);
  1464. spin_unlock(&jh_splice_lock);
  1465. BUFFER_TRACE(bh, "added journal_head");
  1466. }
  1467. }
  1468. jh->b_jcount++;
  1469. spin_unlock(&journal_datalist_lock);
  1470. return bh->b_private;
  1471. }
  1472. /*
  1473.  * journal_remove_journal_head(): if the buffer isn't attached to a transaction
  1474.  * and has a zero b_jcount then remove and release its journal_head.   If we did
  1475.  * see that the buffer is not used by any transaction we also "logically"
  1476.  * decrement ->b_count.
  1477.  *
  1478.  * We in fact take an additional increment on ->b_count as a convenience,
  1479.  * because the caller usually wants to do additional things with the bh
  1480.  * after calling here.
  1481.  * The caller of journal_remove_journal_head() *must* run __brelse(bh) at some
  1482.  * time.  Once the caller has run __brelse(), the buffer is eligible for
  1483.  * reaping by try_to_free_buffers().
  1484.  *
  1485.  * Requires journal_datalist_lock.
  1486.  */
  1487. void __journal_remove_journal_head(struct buffer_head *bh)
  1488. {
  1489. struct journal_head *jh = bh2jh(bh);
  1490. assert_spin_locked(&journal_datalist_lock);
  1491. J_ASSERT_JH(jh, jh->b_jcount >= 0);
  1492. atomic_inc(&bh->b_count);
  1493. if (jh->b_jcount == 0) {
  1494. if (jh->b_transaction == NULL &&
  1495. jh->b_next_transaction == NULL &&
  1496. jh->b_cp_transaction == NULL) {
  1497. J_ASSERT_BH(bh, buffer_jbd(bh));
  1498. J_ASSERT_BH(bh, jh2bh(jh) == bh);
  1499. BUFFER_TRACE(bh, "remove journal_head");
  1500. spin_lock(&jh_splice_lock);
  1501. bh->b_private = NULL;
  1502. jh->b_bh = NULL; /* debug, really */
  1503. clear_bit(BH_JBD, &bh->b_state);
  1504. __brelse(bh);
  1505. spin_unlock(&jh_splice_lock);
  1506. journal_free_journal_head(jh);
  1507. } else {
  1508. BUFFER_TRACE(bh, "journal_head was locked");
  1509. }
  1510. }
  1511. }
  1512. void journal_unlock_journal_head(struct journal_head *jh)
  1513. {
  1514. spin_lock(&journal_datalist_lock);
  1515. J_ASSERT_JH(jh, jh->b_jcount > 0);
  1516. --jh->b_jcount;
  1517. if (!jh->b_jcount && !jh->b_transaction) {
  1518. struct buffer_head *bh;
  1519. bh = jh2bh(jh);
  1520. __journal_remove_journal_head(bh);
  1521. __brelse(bh);
  1522. }
  1523. spin_unlock(&journal_datalist_lock);
  1524. }
  1525. void journal_remove_journal_head(struct buffer_head *bh)
  1526. {
  1527. spin_lock(&journal_datalist_lock);
  1528. __journal_remove_journal_head(bh);
  1529. spin_unlock(&journal_datalist_lock);
  1530. }
  1531. /*
  1532.  * /proc tunables
  1533.  */
  1534. #if defined(CONFIG_JBD_DEBUG)
  1535. int journal_enable_debug;
  1536. EXPORT_SYMBOL(journal_enable_debug);
  1537. #endif
  1538. #if defined(CONFIG_JBD_DEBUG) && defined(CONFIG_PROC_FS)
  1539. static struct proc_dir_entry *proc_jbd_debug;
  1540. int read_jbd_debug(char *page, char **start, off_t off,
  1541.   int count, int *eof, void *data)
  1542. {
  1543. int ret;
  1544. ret = sprintf(page + off, "%dn", journal_enable_debug);
  1545. *eof = 1;
  1546. return ret;
  1547. }
  1548. int write_jbd_debug(struct file *file, const char *buffer,
  1549.    unsigned long count, void *data)
  1550. {
  1551. char buf[32];
  1552. if (count > ARRAY_SIZE(buf) - 1)
  1553. count = ARRAY_SIZE(buf) - 1;
  1554. if (copy_from_user(buf, buffer, count))
  1555. return -EFAULT;
  1556. buf[ARRAY_SIZE(buf) - 1] = '';
  1557. journal_enable_debug = simple_strtoul(buf, NULL, 10);
  1558. return count;
  1559. }
  1560. #define JBD_PROC_NAME "sys/fs/jbd-debug"
  1561. static void __init create_jbd_proc_entry(void)
  1562. {
  1563. proc_jbd_debug = create_proc_entry(JBD_PROC_NAME, 0644, NULL);
  1564. if (proc_jbd_debug) {
  1565. /* Why is this so hard? */
  1566. proc_jbd_debug->read_proc = read_jbd_debug;
  1567. proc_jbd_debug->write_proc = write_jbd_debug;
  1568. }
  1569. }
  1570. static void __exit remove_jbd_proc_entry(void)
  1571. {
  1572. if (proc_jbd_debug)
  1573. remove_proc_entry(JBD_PROC_NAME, NULL);
  1574. }
  1575. #else
  1576. #define create_jbd_proc_entry() do {} while (0)
  1577. #define remove_jbd_proc_entry() do {} while (0)
  1578. #endif
  1579. /*
  1580.  * Module startup and shutdown
  1581.  */
  1582. static int __init journal_init_caches(void)
  1583. {
  1584. int ret;
  1585. ret = journal_init_revoke_caches();
  1586. if (ret == 0)
  1587. ret = journal_init_journal_head_cache();
  1588. return ret;
  1589. }
  1590. static void journal_destroy_caches(void)
  1591. {
  1592. journal_destroy_revoke_caches();
  1593. journal_destroy_journal_head_cache();
  1594. }
  1595. static int __init journal_init(void)
  1596. {
  1597. int ret;
  1598. printk(KERN_INFO "Journalled Block Device driver loadedn");
  1599. ret = journal_init_caches();
  1600. if (ret != 0)
  1601. journal_destroy_caches();
  1602. create_jbd_proc_entry();
  1603. return ret;
  1604. }
  1605. static void __exit journal_exit(void)
  1606. {
  1607. #ifdef CONFIG_JBD_DEBUG
  1608. int n = atomic_read(&nr_journal_heads);
  1609. if (n)
  1610. printk(KERN_EMERG "JBD: leaked %d journal_heads!n", n);
  1611. #endif
  1612. remove_jbd_proc_entry();
  1613. journal_destroy_caches();
  1614. }
  1615. MODULE_LICENSE("GPL");
  1616. module_init(journal_init);
  1617. module_exit(journal_exit);