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