jbd.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:33k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * linux/include/linux/jbd.h
  3.  * 
  4.  * Written by Stephen C. Tweedie <sct@redhat.com>
  5.  *
  6.  * Copyright 1998-2000 Red Hat, Inc --- 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.  * Definitions for transaction data structures for the buffer cache
  13.  * filesystem journaling support.
  14.  */
  15. #ifndef _LINUX_JBD_H
  16. #define _LINUX_JBD_H
  17. #if defined(CONFIG_JBD) || defined(CONFIG_JBD_MODULE) || !defined(__KERNEL__)
  18. /* Allow this file to be included directly into e2fsprogs */
  19. #ifndef __KERNEL__
  20. #include "jfs_compat.h"
  21. #define JFS_DEBUG
  22. #define jfs_debug jbd_debug
  23. #else
  24. #include <linux/buffer_head.h>
  25. #include <linux/journal-head.h>
  26. #include <linux/stddef.h>
  27. #include <linux/bit_spinlock.h>
  28. #include <asm/semaphore.h>
  29. #endif
  30. #define journal_oom_retry 1
  31. /*
  32.  * Define JBD_PARANIOD_IOFAIL to cause a kernel BUG() if ext3 finds
  33.  * certain classes of error which can occur due to failed IOs.  Under
  34.  * normal use we want ext3 to continue after such errors, because
  35.  * hardware _can_ fail, but for debugging purposes when running tests on
  36.  * known-good hardware we may want to trap these errors.
  37.  */
  38. #undef JBD_PARANOID_IOFAIL
  39. /*
  40.  * The default maximum commit age, in seconds.
  41.  */
  42. #define JBD_DEFAULT_MAX_COMMIT_AGE 5
  43. #ifdef CONFIG_JBD_DEBUG
  44. /*
  45.  * Define JBD_EXPENSIVE_CHECKING to enable more expensive internal
  46.  * consistency checks.  By default we don't do this unless
  47.  * CONFIG_JBD_DEBUG is on.
  48.  */
  49. #define JBD_EXPENSIVE_CHECKING
  50. extern int journal_enable_debug;
  51. #define jbd_debug(n, f, a...)
  52. do {
  53. if ((n) <= journal_enable_debug) {
  54. printk (KERN_DEBUG "(%s, %d): %s: ",
  55. __FILE__, __LINE__, __FUNCTION__);
  56.    printk (f, ## a);
  57. }
  58. } while (0)
  59. #else
  60. #define jbd_debug(f, a...) /**/
  61. #endif
  62. extern void * __jbd_kmalloc (const char *where, size_t size, int flags, int retry);
  63. #define jbd_kmalloc(size, flags) 
  64. __jbd_kmalloc(__FUNCTION__, (size), (flags), journal_oom_retry)
  65. #define jbd_rep_kmalloc(size, flags) 
  66. __jbd_kmalloc(__FUNCTION__, (size), (flags), 1)
  67. #define JFS_MIN_JOURNAL_BLOCKS 1024
  68. #ifdef __KERNEL__
  69. /**
  70.  * typedef handle_t - The handle_t type represents a single atomic update being performed by some process.
  71.  *
  72.  * All filesystem modifications made by the process go
  73.  * through this handle.  Recursive operations (such as quota operations)
  74.  * are gathered into a single update.
  75.  *
  76.  * The buffer credits field is used to account for journaled buffers
  77.  * being modified by the running process.  To ensure that there is
  78.  * enough log space for all outstanding operations, we need to limit the
  79.  * number of outstanding buffers possible at any time.  When the
  80.  * operation completes, any buffer credits not used are credited back to
  81.  * the transaction, so that at all times we know how many buffers the
  82.  * outstanding updates on a transaction might possibly touch. 
  83.  * 
  84.  * This is an opaque datatype.
  85.  **/
  86. typedef struct handle_s handle_t; /* Atomic operation type */
  87. /**
  88.  * typedef journal_t - The journal_t maintains all of the journaling state information for a single filesystem.
  89.  *
  90.  * journal_t is linked to from the fs superblock structure.
  91.  * 
  92.  * We use the journal_t to keep track of all outstanding transaction
  93.  * activity on the filesystem, and to manage the state of the log
  94.  * writing process.
  95.  *
  96.  * This is an opaque datatype.
  97.  **/
  98. typedef struct journal_s journal_t; /* Journal control structure */
  99. #endif
  100. /*
  101.  * Internal structures used by the logging mechanism:
  102.  */
  103. #define JFS_MAGIC_NUMBER 0xc03b3998U /* The first 4 bytes of /dev/random! */
  104. /*
  105.  * On-disk structures
  106.  */
  107. /* 
  108.  * Descriptor block types:
  109.  */
  110. #define JFS_DESCRIPTOR_BLOCK 1
  111. #define JFS_COMMIT_BLOCK 2
  112. #define JFS_SUPERBLOCK_V1 3
  113. #define JFS_SUPERBLOCK_V2 4
  114. #define JFS_REVOKE_BLOCK 5
  115. /*
  116.  * Standard header for all descriptor blocks:
  117.  */
  118. typedef struct journal_header_s
  119. {
  120. __be32 h_magic;
  121. __be32 h_blocktype;
  122. __be32 h_sequence;
  123. } journal_header_t;
  124. /* 
  125.  * The block tag: used to describe a single buffer in the journal 
  126.  */
  127. typedef struct journal_block_tag_s
  128. {
  129. __be32 t_blocknr; /* The on-disk block number */
  130. __be32 t_flags; /* See below */
  131. } journal_block_tag_t;
  132. /* 
  133.  * The revoke descriptor: used on disk to describe a series of blocks to
  134.  * be revoked from the log 
  135.  */
  136. typedef struct journal_revoke_header_s
  137. {
  138. journal_header_t r_header;
  139. __be32  r_count; /* Count of bytes used in the block */
  140. } journal_revoke_header_t;
  141. /* Definitions for the journal tag flags word: */
  142. #define JFS_FLAG_ESCAPE 1 /* on-disk block is escaped */
  143. #define JFS_FLAG_SAME_UUID 2 /* block has same uuid as previous */
  144. #define JFS_FLAG_DELETED 4 /* block deleted by this transaction */
  145. #define JFS_FLAG_LAST_TAG 8 /* last tag in this descriptor block */
  146. /*
  147.  * The journal superblock.  All fields are in big-endian byte order.
  148.  */
  149. typedef struct journal_superblock_s
  150. {
  151. /* 0x0000 */
  152. journal_header_t s_header;
  153. /* 0x000C */
  154. /* Static information describing the journal */
  155. __be32 s_blocksize; /* journal device blocksize */
  156. __be32 s_maxlen; /* total blocks in journal file */
  157. __be32 s_first; /* first block of log information */
  158. /* 0x0018 */
  159. /* Dynamic information describing the current state of the log */
  160. __be32 s_sequence; /* first commit ID expected in log */
  161. __be32 s_start; /* blocknr of start of log */
  162. /* 0x0020 */
  163. /* Error value, as set by journal_abort(). */
  164. __be32 s_errno;
  165. /* 0x0024 */
  166. /* Remaining fields are only valid in a version-2 superblock */
  167. __be32 s_feature_compat;  /* compatible feature set */
  168. __be32 s_feature_incompat;  /* incompatible feature set */
  169. __be32 s_feature_ro_compat;  /* readonly-compatible feature set */
  170. /* 0x0030 */
  171. __u8 s_uuid[16]; /* 128-bit uuid for journal */
  172. /* 0x0040 */
  173. __be32 s_nr_users; /* Nr of filesystems sharing log */
  174. __be32 s_dynsuper; /* Blocknr of dynamic superblock copy*/
  175. /* 0x0048 */
  176. __be32 s_max_transaction; /* Limit of journal blocks per trans.*/
  177. __be32 s_max_trans_data; /* Limit of data blocks per trans. */
  178. /* 0x0050 */
  179. __u32 s_padding[44];
  180. /* 0x0100 */
  181. __u8 s_users[16*48]; /* ids of all fs'es sharing the log */
  182. /* 0x0400 */
  183. } journal_superblock_t;
  184. #define JFS_HAS_COMPAT_FEATURE(j,mask)
  185. ((j)->j_format_version >= 2 &&
  186.  ((j)->j_superblock->s_feature_compat & cpu_to_be32((mask))))
  187. #define JFS_HAS_RO_COMPAT_FEATURE(j,mask)
  188. ((j)->j_format_version >= 2 &&
  189.  ((j)->j_superblock->s_feature_ro_compat & cpu_to_be32((mask))))
  190. #define JFS_HAS_INCOMPAT_FEATURE(j,mask)
  191. ((j)->j_format_version >= 2 &&
  192.  ((j)->j_superblock->s_feature_incompat & cpu_to_be32((mask))))
  193. #define JFS_FEATURE_INCOMPAT_REVOKE 0x00000001
  194. /* Features known to this kernel version: */
  195. #define JFS_KNOWN_COMPAT_FEATURES 0
  196. #define JFS_KNOWN_ROCOMPAT_FEATURES 0
  197. #define JFS_KNOWN_INCOMPAT_FEATURES JFS_FEATURE_INCOMPAT_REVOKE
  198. #ifdef __KERNEL__
  199. #include <linux/fs.h>
  200. #include <linux/sched.h>
  201. #include <asm/bug.h>
  202. #define JBD_ASSERTIONS
  203. #ifdef JBD_ASSERTIONS
  204. #define J_ASSERT(assert)
  205. do {
  206. if (!(assert)) {
  207. printk (KERN_EMERG
  208. "Assertion failure in %s() at %s:%d: "%s"n",
  209. __FUNCTION__, __FILE__, __LINE__, # assert);
  210. BUG();
  211. }
  212. } while (0)
  213. #if defined(CONFIG_BUFFER_DEBUG)
  214. void buffer_assertion_failure(struct buffer_head *bh);
  215. #define J_ASSERT_BH(bh, expr)
  216. do {
  217. if (!(expr))
  218. buffer_assertion_failure(bh);
  219. J_ASSERT(expr);
  220. } while (0)
  221. #define J_ASSERT_JH(jh, expr) J_ASSERT_BH(jh2bh(jh), expr)
  222. #else
  223. #define J_ASSERT_BH(bh, expr) J_ASSERT(expr)
  224. #define J_ASSERT_JH(jh, expr) J_ASSERT(expr)
  225. #endif
  226. #else
  227. #define J_ASSERT(assert) do { } while (0)
  228. #endif /* JBD_ASSERTIONS */
  229. #if defined(JBD_PARANOID_IOFAIL)
  230. #define J_EXPECT(expr, why...) J_ASSERT(expr)
  231. #define J_EXPECT_BH(bh, expr, why...) J_ASSERT_BH(bh, expr)
  232. #define J_EXPECT_JH(jh, expr, why...) J_ASSERT_JH(jh, expr)
  233. #else
  234. #define __journal_expect(expr, why...)      
  235. ({      
  236. int val = (expr);      
  237. if (!val) {      
  238. printk(KERN_ERR      
  239. "EXT3-fs unexpected failure: %s;n",# expr); 
  240. printk(KERN_ERR why "n");      
  241. }      
  242. val;      
  243. })
  244. #define J_EXPECT(expr, why...) __journal_expect(expr, ## why)
  245. #define J_EXPECT_BH(bh, expr, why...) __journal_expect(expr, ## why)
  246. #define J_EXPECT_JH(jh, expr, why...) __journal_expect(expr, ## why)
  247. #endif
  248. enum jbd_state_bits {
  249. BH_JBD /* Has an attached ext3 journal_head */
  250.   = BH_PrivateStart,
  251. BH_JWrite, /* Being written to log (@@@ DEBUGGING) */
  252. BH_Freed, /* Has been freed (truncated) */
  253. BH_Revoked, /* Has been revoked from the log */
  254. BH_RevokeValid, /* Revoked flag is valid */
  255. BH_JBDDirty, /* Is dirty but journaled */
  256. BH_State, /* Pins most journal_head state */
  257. BH_JournalHead, /* Pins bh->b_private and jh->b_bh */
  258. BH_Unshadow, /* Dummy bit, for BJ_Shadow wakeup filtering */
  259. };
  260. BUFFER_FNS(JBD, jbd)
  261. BUFFER_FNS(JWrite, jwrite)
  262. BUFFER_FNS(JBDDirty, jbddirty)
  263. TAS_BUFFER_FNS(JBDDirty, jbddirty)
  264. BUFFER_FNS(Revoked, revoked)
  265. TAS_BUFFER_FNS(Revoked, revoked)
  266. BUFFER_FNS(RevokeValid, revokevalid)
  267. TAS_BUFFER_FNS(RevokeValid, revokevalid)
  268. BUFFER_FNS(Freed, freed)
  269. static inline struct buffer_head *jh2bh(struct journal_head *jh)
  270. {
  271. return jh->b_bh;
  272. }
  273. static inline struct journal_head *bh2jh(struct buffer_head *bh)
  274. {
  275. return bh->b_private;
  276. }
  277. static inline void jbd_lock_bh_state(struct buffer_head *bh)
  278. {
  279. bit_spin_lock(BH_State, &bh->b_state);
  280. }
  281. static inline int jbd_trylock_bh_state(struct buffer_head *bh)
  282. {
  283. return bit_spin_trylock(BH_State, &bh->b_state);
  284. }
  285. static inline int jbd_is_locked_bh_state(struct buffer_head *bh)
  286. {
  287. return bit_spin_is_locked(BH_State, &bh->b_state);
  288. }
  289. static inline void jbd_unlock_bh_state(struct buffer_head *bh)
  290. {
  291. bit_spin_unlock(BH_State, &bh->b_state);
  292. }
  293. static inline void jbd_lock_bh_journal_head(struct buffer_head *bh)
  294. {
  295. bit_spin_lock(BH_JournalHead, &bh->b_state);
  296. }
  297. static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh)
  298. {
  299. bit_spin_unlock(BH_JournalHead, &bh->b_state);
  300. }
  301. struct jbd_revoke_table_s;
  302. /**
  303.  * struct handle_s - The handle_s type is the concrete type associated with
  304.  *     handle_t.
  305.  * @h_transaction: Which compound transaction is this update a part of?
  306.  * @h_buffer_credits: Number of remaining buffers we are allowed to dirty.
  307.  * @h_ref: Reference count on this handle
  308.  * @h_err: Field for caller's use to track errors through large fs operations
  309.  * @h_sync: flag for sync-on-close
  310.  * @h_jdata: flag to force data journaling
  311.  * @h_aborted: flag indicating fatal error on handle
  312.  **/
  313. /* Docbook can't yet cope with the bit fields, but will leave the documentation
  314.  * in so it can be fixed later. 
  315.  */
  316. struct handle_s 
  317. {
  318. /* Which compound transaction is this update a part of? */
  319. transaction_t *h_transaction;
  320. /* Number of remaining buffers we are allowed to dirty: */
  321. int h_buffer_credits;
  322. /* Reference count on this handle */
  323. int h_ref;
  324. /* Field for caller's use to track errors through large fs */
  325. /* operations */
  326. int h_err;
  327. /* Flags [no locking] */
  328. unsigned int h_sync: 1; /* sync-on-close */
  329. unsigned int h_jdata: 1; /* force data journaling */
  330. unsigned int h_aborted: 1; /* fatal error on handle */
  331. };
  332. /* The transaction_t type is the guts of the journaling mechanism.  It
  333.  * tracks a compound transaction through its various states:
  334.  *
  335.  * RUNNING: accepting new updates
  336.  * LOCKED: Updates still running but we don't accept new ones
  337.  * RUNDOWN: Updates are tidying up but have finished requesting
  338.  * new buffers to modify (state not used for now)
  339.  * FLUSH:       All updates complete, but we are still writing to disk
  340.  * COMMIT:      All data on disk, writing commit record
  341.  * FINISHED: We still have to keep the transaction for checkpointing.
  342.  *
  343.  * The transaction keeps track of all of the buffers modified by a
  344.  * running transaction, and all of the buffers committed but not yet
  345.  * flushed to home for finished transactions.
  346.  */
  347. /*
  348.  * Lock ranking:
  349.  *
  350.  *    j_list_lock
  351.  *      ->jbd_lock_bh_journal_head() (This is "innermost")
  352.  *
  353.  *    j_state_lock
  354.  *    ->jbd_lock_bh_state()
  355.  *
  356.  *    jbd_lock_bh_state()
  357.  *    ->j_list_lock
  358.  *
  359.  *    j_state_lock
  360.  *    ->t_handle_lock
  361.  *
  362.  *    j_state_lock
  363.  *    ->j_list_lock (journal_unmap_buffer)
  364.  *
  365.  */
  366. struct transaction_s 
  367. {
  368. /* Pointer to the journal for this transaction. [no locking] */
  369. journal_t *t_journal;
  370. /* Sequence number for this transaction [no locking] */
  371. tid_t t_tid;
  372. /*
  373.  * Transaction's current state
  374.  * [no locking - only kjournald alters this]
  375.  * FIXME: needs barriers
  376.  * KLUDGE: [use j_state_lock]
  377.  */
  378. enum {
  379. T_RUNNING,
  380. T_LOCKED,
  381. T_RUNDOWN,
  382. T_FLUSH,
  383. T_COMMIT,
  384. T_FINISHED 
  385. } t_state;
  386. /*
  387.  * Where in the log does this transaction's commit start? [no locking]
  388.  */
  389. unsigned long t_log_start;
  390. /* Number of buffers on the t_buffers list [j_list_lock] */
  391. int t_nr_buffers;
  392. /*
  393.  * Doubly-linked circular list of all buffers reserved but not yet
  394.  * modified by this transaction [j_list_lock]
  395.  */
  396. struct journal_head *t_reserved_list;
  397. /*
  398.  * Doubly-linked circular list of all buffers under writeout during
  399.  * commit [j_list_lock]
  400.  */
  401. struct journal_head *t_locked_list;
  402. /*
  403.  * Doubly-linked circular list of all metadata buffers owned by this
  404.  * transaction [j_list_lock]
  405.  */
  406. struct journal_head *t_buffers;
  407. /*
  408.  * Doubly-linked circular list of all data buffers still to be
  409.  * flushed before this transaction can be committed [j_list_lock]
  410.  */
  411. struct journal_head *t_sync_datalist;
  412. /*
  413.  * Doubly-linked circular list of all forget buffers (superseded
  414.  * buffers which we can un-checkpoint once this transaction commits)
  415.  * [j_list_lock]
  416.  */
  417. struct journal_head *t_forget;
  418. /*
  419.  * Doubly-linked circular list of all buffers still to be flushed before
  420.  * this transaction can be checkpointed. [j_list_lock]
  421.  */
  422. struct journal_head *t_checkpoint_list;
  423. /*
  424.  * Doubly-linked circular list of temporary buffers currently undergoing
  425.  * IO in the log [j_list_lock]
  426.  */
  427. struct journal_head *t_iobuf_list;
  428. /*
  429.  * Doubly-linked circular list of metadata buffers being shadowed by log
  430.  * IO.  The IO buffers on the iobuf list and the shadow buffers on this
  431.  * list match each other one for one at all times. [j_list_lock]
  432.  */
  433. struct journal_head *t_shadow_list;
  434. /*
  435.  * Doubly-linked circular list of control buffers being written to the
  436.  * log. [j_list_lock]
  437.  */
  438. struct journal_head *t_log_list;
  439. /*
  440.  * Protects info related to handles
  441.  */
  442. spinlock_t t_handle_lock;
  443. /*
  444.  * Number of outstanding updates running on this transaction
  445.  * [t_handle_lock]
  446.  */
  447. int t_updates;
  448. /*
  449.  * Number of buffers reserved for use by all handles in this transaction
  450.  * handle but not yet modified. [t_handle_lock]
  451.  */
  452. int t_outstanding_credits;
  453. /*
  454.  * Forward and backward links for the circular list of all transactions
  455.  * awaiting checkpoint. [j_list_lock]
  456.  */
  457. transaction_t *t_cpnext, *t_cpprev;
  458. /*
  459.  * When will the transaction expire (become due for commit), in jiffies?
  460.  * [no locking]
  461.  */
  462. unsigned long t_expires;
  463. /*
  464.  * How many handles used this transaction? [t_handle_lock]
  465.  */
  466. int t_handle_count;
  467. };
  468. /**
  469.  * struct journal_s - The journal_s type is the concrete type associated with
  470.  *     journal_t.
  471.  * @j_flags:  General journaling state flags
  472.  * @j_errno:  Is there an outstanding uncleared error on the journal (from a
  473.  *     prior abort)? 
  474.  * @j_sb_buffer: First part of superblock buffer
  475.  * @j_superblock: Second part of superblock buffer
  476.  * @j_format_version: Version of the superblock format
  477.  * @j_state_lock: Protect the various scalars in the journal
  478.  * @j_barrier_count:  Number of processes waiting to create a barrier lock
  479.  * @j_barrier: The barrier lock itself
  480.  * @j_running_transaction: The current running transaction..
  481.  * @j_committing_transaction: the transaction we are pushing to disk
  482.  * @j_checkpoint_transactions: a linked circular list of all transactions
  483.  *  waiting for checkpointing
  484.  * @j_wait_transaction_locked: Wait queue for waiting for a locked transaction
  485.  *  to start committing, or for a barrier lock to be released
  486.  * @j_wait_logspace: Wait queue for waiting for checkpointing to complete
  487.  * @j_wait_done_commit: Wait queue for waiting for commit to complete 
  488.  * @j_wait_checkpoint:  Wait queue to trigger checkpointing
  489.  * @j_wait_commit: Wait queue to trigger commit
  490.  * @j_wait_updates: Wait queue to wait for updates to complete
  491.  * @j_checkpoint_sem: Semaphore for locking against concurrent checkpoints
  492.  * @j_head: Journal head - identifies the first unused block in the journal
  493.  * @j_tail: Journal tail - identifies the oldest still-used block in the
  494.  *  journal.
  495.  * @j_free: Journal free - how many free blocks are there in the journal?
  496.  * @j_first: The block number of the first usable block 
  497.  * @j_last: The block number one beyond the last usable block
  498.  * @j_dev: Device where we store the journal
  499.  * @j_blocksize: blocksize for the location where we store the journal.
  500.  * @j_blk_offset: starting block offset for into the device where we store the
  501.  *     journal
  502.  * @j_fs_dev: Device which holds the client fs.  For internal journal this will
  503.  *     be equal to j_dev
  504.  * @j_maxlen: Total maximum capacity of the journal region on disk.
  505.  * @j_list_lock: Protects the buffer lists and internal buffer state.
  506.  * @j_inode: Optional inode where we store the journal.  If present, all journal
  507.  *     block numbers are mapped into this inode via bmap().
  508.  * @j_tail_sequence:  Sequence number of the oldest transaction in the log 
  509.  * @j_transaction_sequence: Sequence number of the next transaction to grant
  510.  * @j_commit_sequence: Sequence number of the most recently committed
  511.  *  transaction
  512.  * @j_commit_request: Sequence number of the most recent transaction wanting
  513.  *     commit 
  514.  * @j_uuid: Uuid of client object.
  515.  * @j_task: Pointer to the current commit thread for this journal
  516.  * @j_max_transaction_buffers:  Maximum number of metadata buffers to allow in a
  517.  *     single compound commit transaction
  518.  * @j_commit_interval: What is the maximum transaction lifetime before we begin
  519.  *  a commit?
  520.  * @j_commit_timer:  The timer used to wakeup the commit thread
  521.  * @j_revoke_lock: Protect the revoke table
  522.  * @j_revoke: The revoke table - maintains the list of revoked blocks in the
  523.  *     current transaction.
  524.  * @j_revoke_table: alternate revoke tables for j_revoke
  525.  * @j_private: An opaque pointer to fs-private information.
  526.  */
  527. struct journal_s
  528. {
  529. /* General journaling state flags [j_state_lock] */
  530. unsigned long j_flags;
  531. /*
  532.  * Is there an outstanding uncleared error on the journal (from a prior
  533.  * abort)? [j_state_lock]
  534.  */
  535. int j_errno;
  536. /* The superblock buffer */
  537. struct buffer_head *j_sb_buffer;
  538. journal_superblock_t *j_superblock;
  539. /* Version of the superblock format */
  540. int j_format_version;
  541. /*
  542.  * Protect the various scalars in the journal
  543.  */
  544. spinlock_t j_state_lock;
  545. /*
  546.  * Number of processes waiting to create a barrier lock [j_state_lock]
  547.  */
  548. int j_barrier_count;
  549. /* The barrier lock itself */
  550. struct semaphore j_barrier;
  551. /*
  552.  * Transactions: The current running transaction...
  553.  * [j_state_lock] [caller holding open handle]
  554.  */
  555. transaction_t *j_running_transaction;
  556. /*
  557.  * the transaction we are pushing to disk
  558.  * [j_state_lock] [caller holding open handle]
  559.  */
  560. transaction_t *j_committing_transaction;
  561. /*
  562.  * ... and a linked circular list of all transactions waiting for
  563.  * checkpointing. [j_list_lock]
  564.  */
  565. transaction_t *j_checkpoint_transactions;
  566. /*
  567.  * Wait queue for waiting for a locked transaction to start committing,
  568.  * or for a barrier lock to be released
  569.  */
  570. wait_queue_head_t j_wait_transaction_locked;
  571. /* Wait queue for waiting for checkpointing to complete */
  572. wait_queue_head_t j_wait_logspace;
  573. /* Wait queue for waiting for commit to complete */
  574. wait_queue_head_t j_wait_done_commit;
  575. /* Wait queue to trigger checkpointing */
  576. wait_queue_head_t j_wait_checkpoint;
  577. /* Wait queue to trigger commit */
  578. wait_queue_head_t j_wait_commit;
  579. /* Wait queue to wait for updates to complete */
  580. wait_queue_head_t j_wait_updates;
  581. /* Semaphore for locking against concurrent checkpoints */
  582. struct semaphore  j_checkpoint_sem;
  583. /*
  584.  * Journal head: identifies the first unused block in the journal.
  585.  * [j_state_lock]
  586.  */
  587. unsigned long j_head;
  588. /*
  589.  * Journal tail: identifies the oldest still-used block in the journal.
  590.  * [j_state_lock]
  591.  */
  592. unsigned long j_tail;
  593. /*
  594.  * Journal free: how many free blocks are there in the journal?
  595.  * [j_state_lock]
  596.  */
  597. unsigned long j_free;
  598. /*
  599.  * Journal start and end: the block numbers of the first usable block
  600.  * and one beyond the last usable block in the journal. [j_state_lock]
  601.  */
  602. unsigned long j_first;
  603. unsigned long j_last;
  604. /*
  605.  * Device, blocksize and starting block offset for the location where we
  606.  * store the journal.
  607.  */
  608. struct block_device *j_dev;
  609. int j_blocksize;
  610. unsigned int j_blk_offset;
  611. /*
  612.  * Device which holds the client fs.  For internal journal this will be
  613.  * equal to j_dev.
  614.  */
  615. struct block_device *j_fs_dev;
  616. /* Total maximum capacity of the journal region on disk. */
  617. unsigned int j_maxlen;
  618. /*
  619.  * Protects the buffer lists and internal buffer state.
  620.  */
  621. spinlock_t j_list_lock;
  622. /* Optional inode where we store the journal.  If present, all */
  623. /* journal block numbers are mapped into this inode via */
  624. /* bmap(). */
  625. struct inode *j_inode;
  626. /*
  627.  * Sequence number of the oldest transaction in the log [j_state_lock]
  628.  */
  629. tid_t j_tail_sequence;
  630. /*
  631.  * Sequence number of the next transaction to grant [j_state_lock]
  632.  */
  633. tid_t j_transaction_sequence;
  634. /*
  635.  * Sequence number of the most recently committed transaction
  636.  * [j_state_lock].
  637.  */
  638. tid_t j_commit_sequence;
  639. /*
  640.  * Sequence number of the most recent transaction wanting commit
  641.  * [j_state_lock]
  642.  */
  643. tid_t j_commit_request;
  644. /*
  645.  * Journal uuid: identifies the object (filesystem, LVM volume etc)
  646.  * backed by this journal.  This will eventually be replaced by an array
  647.  * of uuids, allowing us to index multiple devices within a single
  648.  * journal and to perform atomic updates across them.
  649.  */
  650. __u8 j_uuid[16];
  651. /* Pointer to the current commit thread for this journal */
  652. struct task_struct *j_task;
  653. /*
  654.  * Maximum number of metadata buffers to allow in a single compound
  655.  * commit transaction
  656.  */
  657. int j_max_transaction_buffers;
  658. /*
  659.  * What is the maximum transaction lifetime before we begin a commit?
  660.  */
  661. unsigned long j_commit_interval;
  662. /* The timer used to wakeup the commit thread: */
  663. struct timer_list *j_commit_timer;
  664. /*
  665.  * The revoke table: maintains the list of revoked blocks in the
  666.  * current transaction.  [j_revoke_lock]
  667.  */
  668. spinlock_t j_revoke_lock;
  669. struct jbd_revoke_table_s *j_revoke;
  670. struct jbd_revoke_table_s *j_revoke_table[2];
  671. /*
  672.  * array of bhs for journal_commit_transaction
  673.  */
  674. struct buffer_head **j_wbuf;
  675. int j_wbufsize;
  676. /*
  677.  * An opaque pointer to fs-private information.  ext3 puts its
  678.  * superblock pointer here
  679.  */
  680. void *j_private;
  681. };
  682. /* 
  683.  * Journal flag definitions 
  684.  */
  685. #define JFS_UNMOUNT 0x001 /* Journal thread is being destroyed */
  686. #define JFS_ABORT 0x002 /* Journaling has been aborted for errors. */
  687. #define JFS_ACK_ERR 0x004 /* The errno in the sb has been acked */
  688. #define JFS_FLUSHED 0x008 /* The journal superblock has been flushed */
  689. #define JFS_LOADED 0x010 /* The journal superblock has been loaded */
  690. #define JFS_BARRIER 0x020 /* Use IDE barriers */
  691. /* 
  692.  * Function declarations for the journaling transaction and buffer
  693.  * management
  694.  */
  695. /* Filing buffers */
  696. extern void __journal_temp_unlink_buffer(struct journal_head *jh);
  697. extern void journal_unfile_buffer(journal_t *, struct journal_head *);
  698. extern void __journal_unfile_buffer(struct journal_head *);
  699. extern void __journal_refile_buffer(struct journal_head *);
  700. extern void journal_refile_buffer(journal_t *, struct journal_head *);
  701. extern void __journal_file_buffer(struct journal_head *, transaction_t *, int);
  702. extern void __journal_free_buffer(struct journal_head *bh);
  703. extern void journal_file_buffer(struct journal_head *, transaction_t *, int);
  704. extern void __journal_clean_data_list(transaction_t *transaction);
  705. /* Log buffer allocation */
  706. extern struct journal_head * journal_get_descriptor_buffer(journal_t *);
  707. int journal_next_log_block(journal_t *, unsigned long *);
  708. /* Commit management */
  709. extern void journal_commit_transaction(journal_t *);
  710. /* Checkpoint list management */
  711. int __journal_clean_checkpoint_list(journal_t *journal);
  712. void __journal_remove_checkpoint(struct journal_head *);
  713. void __journal_insert_checkpoint(struct journal_head *, transaction_t *);
  714. /* Buffer IO */
  715. extern int 
  716. journal_write_metadata_buffer(transaction_t   *transaction,
  717.       struct journal_head  *jh_in,
  718.       struct journal_head **jh_out,
  719.       int    blocknr);
  720. /* Transaction locking */
  721. extern void __wait_on_journal (journal_t *);
  722. /*
  723.  * Journal locking.
  724.  *
  725.  * We need to lock the journal during transaction state changes so that nobody
  726.  * ever tries to take a handle on the running transaction while we are in the
  727.  * middle of moving it to the commit phase.  j_state_lock does this.
  728.  *
  729.  * Note that the locking is completely interrupt unsafe.  We never touch
  730.  * journal structures from interrupts.
  731.  */
  732. static inline handle_t *journal_current_handle(void)
  733. {
  734. return current->journal_info;
  735. }
  736. /* The journaling code user interface:
  737.  *
  738.  * Create and destroy handles
  739.  * Register buffer modifications against the current transaction. 
  740.  */
  741. extern handle_t *journal_start(journal_t *, int nblocks);
  742. extern int  journal_restart (handle_t *, int nblocks);
  743. extern int  journal_extend (handle_t *, int nblocks);
  744. extern int  journal_get_write_access(handle_t *, struct buffer_head *);
  745. extern int  journal_get_create_access (handle_t *, struct buffer_head *);
  746. extern int  journal_get_undo_access(handle_t *, struct buffer_head *);
  747. extern int  journal_dirty_data (handle_t *, struct buffer_head *);
  748. extern int  journal_dirty_metadata (handle_t *, struct buffer_head *);
  749. extern void  journal_release_buffer (handle_t *, struct buffer_head *);
  750. extern int  journal_forget (handle_t *, struct buffer_head *);
  751. extern void  journal_sync_buffer (struct buffer_head *);
  752. extern int  journal_invalidatepage(journal_t *,
  753. struct page *, unsigned long);
  754. extern int  journal_try_to_free_buffers(journal_t *, struct page *, int);
  755. extern int  journal_stop(handle_t *);
  756. extern int  journal_flush (journal_t *);
  757. extern void  journal_lock_updates (journal_t *);
  758. extern void  journal_unlock_updates (journal_t *);
  759. extern journal_t * journal_init_dev(struct block_device *bdev,
  760. struct block_device *fs_dev,
  761. int start, int len, int bsize);
  762. extern journal_t * journal_init_inode (struct inode *);
  763. extern int    journal_update_format (journal_t *);
  764. extern int    journal_check_used_features 
  765.    (journal_t *, unsigned long, unsigned long, unsigned long);
  766. extern int    journal_check_available_features 
  767.    (journal_t *, unsigned long, unsigned long, unsigned long);
  768. extern int    journal_set_features 
  769.    (journal_t *, unsigned long, unsigned long, unsigned long);
  770. extern int    journal_create     (journal_t *);
  771. extern int    journal_load       (journal_t *journal);
  772. extern void    journal_destroy    (journal_t *);
  773. extern int    journal_recover    (journal_t *journal);
  774. extern int    journal_wipe       (journal_t *, int);
  775. extern int    journal_skip_recovery (journal_t *);
  776. extern void    journal_update_superblock (journal_t *, int);
  777. extern void    __journal_abort_hard (journal_t *);
  778. extern void    journal_abort      (journal_t *, int);
  779. extern int    journal_errno      (journal_t *);
  780. extern void    journal_ack_err    (journal_t *);
  781. extern int    journal_clear_err  (journal_t *);
  782. extern int    journal_bmap(journal_t *, unsigned long, unsigned long *);
  783. extern int    journal_force_commit(journal_t *);
  784. /*
  785.  * journal_head management
  786.  */
  787. struct journal_head *journal_add_journal_head(struct buffer_head *bh);
  788. struct journal_head *journal_grab_journal_head(struct buffer_head *bh);
  789. void journal_remove_journal_head(struct buffer_head *bh);
  790. void journal_put_journal_head(struct journal_head *jh);
  791. /*
  792.  * handle management
  793.  */
  794. extern kmem_cache_t *jbd_handle_cache;
  795. static inline handle_t *jbd_alloc_handle(gfp_t gfp_flags)
  796. {
  797. return kmem_cache_alloc(jbd_handle_cache, gfp_flags);
  798. }
  799. static inline void jbd_free_handle(handle_t *handle)
  800. {
  801. kmem_cache_free(jbd_handle_cache, handle);
  802. }
  803. /* Primary revoke support */
  804. #define JOURNAL_REVOKE_DEFAULT_HASH 256
  805. extern int    journal_init_revoke(journal_t *, int);
  806. extern void    journal_destroy_revoke_caches(void);
  807. extern int    journal_init_revoke_caches(void);
  808. extern void    journal_destroy_revoke(journal_t *);
  809. extern int    journal_revoke (handle_t *,
  810. unsigned long, struct buffer_head *);
  811. extern int    journal_cancel_revoke(handle_t *, struct journal_head *);
  812. extern void    journal_write_revoke_records(journal_t *, transaction_t *);
  813. /* Recovery revoke support */
  814. extern int journal_set_revoke(journal_t *, unsigned long, tid_t);
  815. extern int journal_test_revoke(journal_t *, unsigned long, tid_t);
  816. extern void journal_clear_revoke(journal_t *);
  817. extern void journal_brelse_array(struct buffer_head *b[], int n);
  818. extern void journal_switch_revoke_table(journal_t *journal);
  819. /*
  820.  * The log thread user interface:
  821.  *
  822.  * Request space in the current transaction, and force transaction commit
  823.  * transitions on demand.
  824.  */
  825. int __log_space_left(journal_t *); /* Called with journal locked */
  826. int log_start_commit(journal_t *journal, tid_t tid);
  827. int __log_start_commit(journal_t *journal, tid_t tid);
  828. int journal_start_commit(journal_t *journal, tid_t *tid);
  829. int journal_force_commit_nested(journal_t *journal);
  830. int log_wait_commit(journal_t *journal, tid_t tid);
  831. int log_do_checkpoint(journal_t *journal);
  832. void __log_wait_for_space(journal_t *journal);
  833. extern void __journal_drop_transaction(journal_t *, transaction_t *);
  834. extern int cleanup_journal_tail(journal_t *);
  835. /* Debugging code only: */
  836. #define jbd_ENOSYS() 
  837. do {            
  838. printk (KERN_ERR "JBD unimplemented function %sn", __FUNCTION__); 
  839. current->state = TASK_UNINTERRUPTIBLE;            
  840. schedule();            
  841. } while (1)
  842. /*
  843.  * is_journal_abort
  844.  *
  845.  * Simple test wrapper function to test the JFS_ABORT state flag.  This
  846.  * bit, when set, indicates that we have had a fatal error somewhere,
  847.  * either inside the journaling layer or indicated to us by the client
  848.  * (eg. ext3), and that we and should not commit any further
  849.  * transactions.  
  850.  */
  851. static inline int is_journal_aborted(journal_t *journal)
  852. {
  853. return journal->j_flags & JFS_ABORT;
  854. }
  855. static inline int is_handle_aborted(handle_t *handle)
  856. {
  857. if (handle->h_aborted)
  858. return 1;
  859. return is_journal_aborted(handle->h_transaction->t_journal);
  860. }
  861. static inline void journal_abort_handle(handle_t *handle)
  862. {
  863. handle->h_aborted = 1;
  864. }
  865. #endif /* __KERNEL__   */
  866. /* Comparison functions for transaction IDs: perform comparisons using
  867.  * modulo arithmetic so that they work over sequence number wraps. */
  868. static inline int tid_gt(tid_t x, tid_t y)
  869. {
  870. int difference = (x - y);
  871. return (difference > 0);
  872. }
  873. static inline int tid_geq(tid_t x, tid_t y)
  874. {
  875. int difference = (x - y);
  876. return (difference >= 0);
  877. }
  878. extern int journal_blocks_per_page(struct inode *inode);
  879. /*
  880.  * Return the minimum number of blocks which must be free in the journal
  881.  * before a new transaction may be started.  Must be called under j_state_lock.
  882.  */
  883. static inline int jbd_space_needed(journal_t *journal)
  884. {
  885. int nblocks = journal->j_max_transaction_buffers;
  886. if (journal->j_committing_transaction)
  887. nblocks += journal->j_committing_transaction->
  888. t_outstanding_credits;
  889. return nblocks;
  890. }
  891. /*
  892.  * Definitions which augment the buffer_head layer
  893.  */
  894. /* journaling buffer types */
  895. #define BJ_None 0 /* Not journaled */
  896. #define BJ_SyncData 1 /* Normal data: flush before commit */
  897. #define BJ_Metadata 2 /* Normal journaled metadata */
  898. #define BJ_Forget 3 /* Buffer superseded by this transaction */
  899. #define BJ_IO 4 /* Buffer is for temporary IO use */
  900. #define BJ_Shadow 5 /* Buffer contents being shadowed to the log */
  901. #define BJ_LogCtl 6 /* Buffer contains log descriptors */
  902. #define BJ_Reserved 7 /* Buffer is reserved for access by journal */
  903. #define BJ_Locked 8 /* Locked for I/O during commit */
  904. #define BJ_Types 9
  905.  
  906. extern int jbd_blocks_per_page(struct inode *inode);
  907. #ifdef __KERNEL__
  908. #define buffer_trace_init(bh) do {} while (0)
  909. #define print_buffer_fields(bh) do {} while (0)
  910. #define print_buffer_trace(bh) do {} while (0)
  911. #define BUFFER_TRACE(bh, info) do {} while (0)
  912. #define BUFFER_TRACE2(bh, bh2, info) do {} while (0)
  913. #define JBUFFER_TRACE(jh, info) do {} while (0)
  914. #endif /* __KERNEL__ */
  915. #endif /* CONFIG_JBD || CONFIG_JBD_MODULE || !__KERNEL__ */
  916. /*
  917.  * Compatibility no-ops which allow the kernel to compile without CONFIG_JBD
  918.  * go here.
  919.  */
  920. #if defined(__KERNEL__) && !(defined(CONFIG_JBD) || defined(CONFIG_JBD_MODULE))
  921. #define J_ASSERT(expr) do {} while (0)
  922. #define J_ASSERT_BH(bh, expr) do {} while (0)
  923. #define buffer_jbd(bh) 0
  924. #define journal_buffer_journal_lru(bh) 0
  925. #endif /* defined(__KERNEL__) && !defined(CONFIG_JBD) */
  926. #endif /* _LINUX_JBD_H */