ext4: add fsync batch tuning knobs
[linux-2.6.git] / include / linux / jbd2.h
1 /*
2  * linux/include/linux/jbd2.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_JBD2_H
17 #define _LINUX_JBD2_H
18
19 /* Allow this file to be included directly into e2fsprogs */
20 #ifndef __KERNEL__
21 #include "jfs_compat.h"
22 #define JBD2_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 <linux/mutex.h>
32 #include <linux/timer.h>
33 #endif
34
35 #define journal_oom_retry 1
36
37 /*
38  * Define JBD2_PARANIOD_IOFAIL to cause a kernel BUG() if ext4 finds
39  * certain classes of error which can occur due to failed IOs.  Under
40  * normal use we want ext4 to continue after such errors, because
41  * hardware _can_ fail, but for debugging purposes when running tests on
42  * known-good hardware we may want to trap these errors.
43  */
44 #undef JBD2_PARANOID_IOFAIL
45
46 /*
47  * The default maximum commit age, in seconds.
48  */
49 #define JBD2_DEFAULT_MAX_COMMIT_AGE 5
50
51 #ifdef CONFIG_JBD2_DEBUG
52 /*
53  * Define JBD2_EXPENSIVE_CHECKING to enable more expensive internal
54  * consistency checks.  By default we don't do this unless
55  * CONFIG_JBD2_DEBUG is on.
56  */
57 #define JBD2_EXPENSIVE_CHECKING
58 extern u8 jbd2_journal_enable_debug;
59
60 #define jbd_debug(n, f, a...)                                           \
61         do {                                                            \
62                 if ((n) <= jbd2_journal_enable_debug) {                 \
63                         printk (KERN_DEBUG "(%s, %d): %s: ",            \
64                                 __FILE__, __LINE__, __func__);  \
65                         printk (f, ## a);                               \
66                 }                                                       \
67         } while (0)
68 #else
69 #define jbd_debug(f, a...)      /**/
70 #endif
71
72 static inline void *jbd2_alloc(size_t size, gfp_t flags)
73 {
74         return (void *)__get_free_pages(flags, get_order(size));
75 }
76
77 static inline void jbd2_free(void *ptr, size_t size)
78 {
79         free_pages((unsigned long)ptr, get_order(size));
80 };
81
82 #define JBD2_MIN_JOURNAL_BLOCKS 1024
83
84 #ifdef __KERNEL__
85
86 /**
87  * typedef handle_t - The handle_t type represents a single atomic update being performed by some process.
88  *
89  * All filesystem modifications made by the process go
90  * through this handle.  Recursive operations (such as quota operations)
91  * are gathered into a single update.
92  *
93  * The buffer credits field is used to account for journaled buffers
94  * being modified by the running process.  To ensure that there is
95  * enough log space for all outstanding operations, we need to limit the
96  * number of outstanding buffers possible at any time.  When the
97  * operation completes, any buffer credits not used are credited back to
98  * the transaction, so that at all times we know how many buffers the
99  * outstanding updates on a transaction might possibly touch.
100  *
101  * This is an opaque datatype.
102  **/
103 typedef struct handle_s         handle_t;       /* Atomic operation type */
104
105
106 /**
107  * typedef journal_t - The journal_t maintains all of the journaling state information for a single filesystem.
108  *
109  * journal_t is linked to from the fs superblock structure.
110  *
111  * We use the journal_t to keep track of all outstanding transaction
112  * activity on the filesystem, and to manage the state of the log
113  * writing process.
114  *
115  * This is an opaque datatype.
116  **/
117 typedef struct journal_s        journal_t;      /* Journal control structure */
118 #endif
119
120 /*
121  * Internal structures used by the logging mechanism:
122  */
123
124 #define JBD2_MAGIC_NUMBER 0xc03b3998U /* The first 4 bytes of /dev/random! */
125
126 /*
127  * On-disk structures
128  */
129
130 /*
131  * Descriptor block types:
132  */
133
134 #define JBD2_DESCRIPTOR_BLOCK   1
135 #define JBD2_COMMIT_BLOCK       2
136 #define JBD2_SUPERBLOCK_V1      3
137 #define JBD2_SUPERBLOCK_V2      4
138 #define JBD2_REVOKE_BLOCK       5
139
140 /*
141  * Standard header for all descriptor blocks:
142  */
143 typedef struct journal_header_s
144 {
145         __be32          h_magic;
146         __be32          h_blocktype;
147         __be32          h_sequence;
148 } journal_header_t;
149
150 /*
151  * Checksum types.
152  */
153 #define JBD2_CRC32_CHKSUM   1
154 #define JBD2_MD5_CHKSUM     2
155 #define JBD2_SHA1_CHKSUM    3
156
157 #define JBD2_CRC32_CHKSUM_SIZE 4
158
159 #define JBD2_CHECKSUM_BYTES (32 / sizeof(u32))
160 /*
161  * Commit block header for storing transactional checksums:
162  */
163 struct commit_header {
164         __be32          h_magic;
165         __be32          h_blocktype;
166         __be32          h_sequence;
167         unsigned char   h_chksum_type;
168         unsigned char   h_chksum_size;
169         unsigned char   h_padding[2];
170         __be32          h_chksum[JBD2_CHECKSUM_BYTES];
171         __be64          h_commit_sec;
172         __be32          h_commit_nsec;
173 };
174
175 /*
176  * The block tag: used to describe a single buffer in the journal.
177  * t_blocknr_high is only used if INCOMPAT_64BIT is set, so this
178  * raw struct shouldn't be used for pointer math or sizeof() - use
179  * journal_tag_bytes(journal) instead to compute this.
180  */
181 typedef struct journal_block_tag_s
182 {
183         __be32          t_blocknr;      /* The on-disk block number */
184         __be32          t_flags;        /* See below */
185         __be32          t_blocknr_high; /* most-significant high 32bits. */
186 } journal_block_tag_t;
187
188 #define JBD2_TAG_SIZE32 (offsetof(journal_block_tag_t, t_blocknr_high))
189 #define JBD2_TAG_SIZE64 (sizeof(journal_block_tag_t))
190
191 /*
192  * The revoke descriptor: used on disk to describe a series of blocks to
193  * be revoked from the log
194  */
195 typedef struct jbd2_journal_revoke_header_s
196 {
197         journal_header_t r_header;
198         __be32           r_count;       /* Count of bytes used in the block */
199 } jbd2_journal_revoke_header_t;
200
201
202 /* Definitions for the journal tag flags word: */
203 #define JBD2_FLAG_ESCAPE                1       /* on-disk block is escaped */
204 #define JBD2_FLAG_SAME_UUID     2       /* block has same uuid as previous */
205 #define JBD2_FLAG_DELETED       4       /* block deleted by this transaction */
206 #define JBD2_FLAG_LAST_TAG      8       /* last tag in this descriptor block */
207
208
209 /*
210  * The journal superblock.  All fields are in big-endian byte order.
211  */
212 typedef struct journal_superblock_s
213 {
214 /* 0x0000 */
215         journal_header_t s_header;
216
217 /* 0x000C */
218         /* Static information describing the journal */
219         __be32  s_blocksize;            /* journal device blocksize */
220         __be32  s_maxlen;               /* total blocks in journal file */
221         __be32  s_first;                /* first block of log information */
222
223 /* 0x0018 */
224         /* Dynamic information describing the current state of the log */
225         __be32  s_sequence;             /* first commit ID expected in log */
226         __be32  s_start;                /* blocknr of start of log */
227
228 /* 0x0020 */
229         /* Error value, as set by jbd2_journal_abort(). */
230         __be32  s_errno;
231
232 /* 0x0024 */
233         /* Remaining fields are only valid in a version-2 superblock */
234         __be32  s_feature_compat;       /* compatible feature set */
235         __be32  s_feature_incompat;     /* incompatible feature set */
236         __be32  s_feature_ro_compat;    /* readonly-compatible feature set */
237 /* 0x0030 */
238         __u8    s_uuid[16];             /* 128-bit uuid for journal */
239
240 /* 0x0040 */
241         __be32  s_nr_users;             /* Nr of filesystems sharing log */
242
243         __be32  s_dynsuper;             /* Blocknr of dynamic superblock copy*/
244
245 /* 0x0048 */
246         __be32  s_max_transaction;      /* Limit of journal blocks per trans.*/
247         __be32  s_max_trans_data;       /* Limit of data blocks per trans. */
248
249 /* 0x0050 */
250         __u32   s_padding[44];
251
252 /* 0x0100 */
253         __u8    s_users[16*48];         /* ids of all fs'es sharing the log */
254 /* 0x0400 */
255 } journal_superblock_t;
256
257 #define JBD2_HAS_COMPAT_FEATURE(j,mask)                                 \
258         ((j)->j_format_version >= 2 &&                                  \
259          ((j)->j_superblock->s_feature_compat & cpu_to_be32((mask))))
260 #define JBD2_HAS_RO_COMPAT_FEATURE(j,mask)                              \
261         ((j)->j_format_version >= 2 &&                                  \
262          ((j)->j_superblock->s_feature_ro_compat & cpu_to_be32((mask))))
263 #define JBD2_HAS_INCOMPAT_FEATURE(j,mask)                               \
264         ((j)->j_format_version >= 2 &&                                  \
265          ((j)->j_superblock->s_feature_incompat & cpu_to_be32((mask))))
266
267 #define JBD2_FEATURE_COMPAT_CHECKSUM    0x00000001
268
269 #define JBD2_FEATURE_INCOMPAT_REVOKE            0x00000001
270 #define JBD2_FEATURE_INCOMPAT_64BIT             0x00000002
271 #define JBD2_FEATURE_INCOMPAT_ASYNC_COMMIT      0x00000004
272
273 /* Features known to this kernel version: */
274 #define JBD2_KNOWN_COMPAT_FEATURES      JBD2_FEATURE_COMPAT_CHECKSUM
275 #define JBD2_KNOWN_ROCOMPAT_FEATURES    0
276 #define JBD2_KNOWN_INCOMPAT_FEATURES    (JBD2_FEATURE_INCOMPAT_REVOKE | \
277                                         JBD2_FEATURE_INCOMPAT_64BIT | \
278                                         JBD2_FEATURE_INCOMPAT_ASYNC_COMMIT)
279
280 #ifdef __KERNEL__
281
282 #include <linux/fs.h>
283 #include <linux/sched.h>
284
285 #define J_ASSERT(assert)        BUG_ON(!(assert))
286
287 #if defined(CONFIG_BUFFER_DEBUG)
288 void buffer_assertion_failure(struct buffer_head *bh);
289 #define J_ASSERT_BH(bh, expr)                                           \
290         do {                                                            \
291                 if (!(expr))                                            \
292                         buffer_assertion_failure(bh);                   \
293                 J_ASSERT(expr);                                         \
294         } while (0)
295 #define J_ASSERT_JH(jh, expr)   J_ASSERT_BH(jh2bh(jh), expr)
296 #else
297 #define J_ASSERT_BH(bh, expr)   J_ASSERT(expr)
298 #define J_ASSERT_JH(jh, expr)   J_ASSERT(expr)
299 #endif
300
301 #if defined(JBD2_PARANOID_IOFAIL)
302 #define J_EXPECT(expr, why...)          J_ASSERT(expr)
303 #define J_EXPECT_BH(bh, expr, why...)   J_ASSERT_BH(bh, expr)
304 #define J_EXPECT_JH(jh, expr, why...)   J_ASSERT_JH(jh, expr)
305 #else
306 #define __journal_expect(expr, why...)                                       \
307         ({                                                                   \
308                 int val = (expr);                                            \
309                 if (!val) {                                                  \
310                         printk(KERN_ERR                                      \
311                                 "EXT3-fs unexpected failure: %s;\n",# expr); \
312                         printk(KERN_ERR why "\n");                           \
313                 }                                                            \
314                 val;                                                         \
315         })
316 #define J_EXPECT(expr, why...)          __journal_expect(expr, ## why)
317 #define J_EXPECT_BH(bh, expr, why...)   __journal_expect(expr, ## why)
318 #define J_EXPECT_JH(jh, expr, why...)   __journal_expect(expr, ## why)
319 #endif
320
321 enum jbd_state_bits {
322         BH_JBD                  /* Has an attached ext3 journal_head */
323           = BH_PrivateStart,
324         BH_JWrite,              /* Being written to log (@@@ DEBUGGING) */
325         BH_Freed,               /* Has been freed (truncated) */
326         BH_Revoked,             /* Has been revoked from the log */
327         BH_RevokeValid,         /* Revoked flag is valid */
328         BH_JBDDirty,            /* Is dirty but journaled */
329         BH_State,               /* Pins most journal_head state */
330         BH_JournalHead,         /* Pins bh->b_private and jh->b_bh */
331         BH_Unshadow,            /* Dummy bit, for BJ_Shadow wakeup filtering */
332         BH_JBDPrivateStart,     /* First bit available for private use by FS */
333 };
334
335 BUFFER_FNS(JBD, jbd)
336 BUFFER_FNS(JWrite, jwrite)
337 BUFFER_FNS(JBDDirty, jbddirty)
338 TAS_BUFFER_FNS(JBDDirty, jbddirty)
339 BUFFER_FNS(Revoked, revoked)
340 TAS_BUFFER_FNS(Revoked, revoked)
341 BUFFER_FNS(RevokeValid, revokevalid)
342 TAS_BUFFER_FNS(RevokeValid, revokevalid)
343 BUFFER_FNS(Freed, freed)
344
345 static inline struct buffer_head *jh2bh(struct journal_head *jh)
346 {
347         return jh->b_bh;
348 }
349
350 static inline struct journal_head *bh2jh(struct buffer_head *bh)
351 {
352         return bh->b_private;
353 }
354
355 static inline void jbd_lock_bh_state(struct buffer_head *bh)
356 {
357         bit_spin_lock(BH_State, &bh->b_state);
358 }
359
360 static inline int jbd_trylock_bh_state(struct buffer_head *bh)
361 {
362         return bit_spin_trylock(BH_State, &bh->b_state);
363 }
364
365 static inline int jbd_is_locked_bh_state(struct buffer_head *bh)
366 {
367         return bit_spin_is_locked(BH_State, &bh->b_state);
368 }
369
370 static inline void jbd_unlock_bh_state(struct buffer_head *bh)
371 {
372         bit_spin_unlock(BH_State, &bh->b_state);
373 }
374
375 static inline void jbd_lock_bh_journal_head(struct buffer_head *bh)
376 {
377         bit_spin_lock(BH_JournalHead, &bh->b_state);
378 }
379
380 static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh)
381 {
382         bit_spin_unlock(BH_JournalHead, &bh->b_state);
383 }
384
385 /* Flags in jbd_inode->i_flags */
386 #define __JI_COMMIT_RUNNING 0
387 /* Commit of the inode data in progress. We use this flag to protect us from
388  * concurrent deletion of inode. We cannot use reference to inode for this
389  * since we cannot afford doing last iput() on behalf of kjournald
390  */
391 #define JI_COMMIT_RUNNING (1 << __JI_COMMIT_RUNNING)
392
393 /**
394  * struct jbd_inode is the structure linking inodes in ordered mode
395  *   present in a transaction so that we can sync them during commit.
396  */
397 struct jbd2_inode {
398         /* Which transaction does this inode belong to? Either the running
399          * transaction or the committing one. [j_list_lock] */
400         transaction_t *i_transaction;
401
402         /* Pointer to the running transaction modifying inode's data in case
403          * there is already a committing transaction touching it. [j_list_lock] */
404         transaction_t *i_next_transaction;
405
406         /* List of inodes in the i_transaction [j_list_lock] */
407         struct list_head i_list;
408
409         /* VFS inode this inode belongs to [constant during the lifetime
410          * of the structure] */
411         struct inode *i_vfs_inode;
412
413         /* Flags of inode [j_list_lock] */
414         unsigned int i_flags;
415 };
416
417 struct jbd2_revoke_table_s;
418
419 /**
420  * struct handle_s - The handle_s type is the concrete type associated with
421  *     handle_t.
422  * @h_transaction: Which compound transaction is this update a part of?
423  * @h_buffer_credits: Number of remaining buffers we are allowed to dirty.
424  * @h_ref: Reference count on this handle
425  * @h_err: Field for caller's use to track errors through large fs operations
426  * @h_sync: flag for sync-on-close
427  * @h_jdata: flag to force data journaling
428  * @h_aborted: flag indicating fatal error on handle
429  **/
430
431 /* Docbook can't yet cope with the bit fields, but will leave the documentation
432  * in so it can be fixed later.
433  */
434
435 struct handle_s
436 {
437         /* Which compound transaction is this update a part of? */
438         transaction_t           *h_transaction;
439
440         /* Number of remaining buffers we are allowed to dirty: */
441         int                     h_buffer_credits;
442
443         /* Reference count on this handle */
444         int                     h_ref;
445
446         /* Field for caller's use to track errors through large fs */
447         /* operations */
448         int                     h_err;
449
450         /* Flags [no locking] */
451         unsigned int    h_sync:         1;      /* sync-on-close */
452         unsigned int    h_jdata:        1;      /* force data journaling */
453         unsigned int    h_aborted:      1;      /* fatal error on handle */
454
455 #ifdef CONFIG_DEBUG_LOCK_ALLOC
456         struct lockdep_map      h_lockdep_map;
457 #endif
458 };
459
460
461 /*
462  * Some stats for checkpoint phase
463  */
464 struct transaction_chp_stats_s {
465         unsigned long           cs_chp_time;
466         unsigned long           cs_forced_to_close;
467         unsigned long           cs_written;
468         unsigned long           cs_dropped;
469 };
470
471 /* The transaction_t type is the guts of the journaling mechanism.  It
472  * tracks a compound transaction through its various states:
473  *
474  * RUNNING:     accepting new updates
475  * LOCKED:      Updates still running but we don't accept new ones
476  * RUNDOWN:     Updates are tidying up but have finished requesting
477  *              new buffers to modify (state not used for now)
478  * FLUSH:       All updates complete, but we are still writing to disk
479  * COMMIT:      All data on disk, writing commit record
480  * FINISHED:    We still have to keep the transaction for checkpointing.
481  *
482  * The transaction keeps track of all of the buffers modified by a
483  * running transaction, and all of the buffers committed but not yet
484  * flushed to home for finished transactions.
485  */
486
487 /*
488  * Lock ranking:
489  *
490  *    j_list_lock
491  *      ->jbd_lock_bh_journal_head()    (This is "innermost")
492  *
493  *    j_state_lock
494  *    ->jbd_lock_bh_state()
495  *
496  *    jbd_lock_bh_state()
497  *    ->j_list_lock
498  *
499  *    j_state_lock
500  *    ->t_handle_lock
501  *
502  *    j_state_lock
503  *    ->j_list_lock                     (journal_unmap_buffer)
504  *
505  */
506
507 struct transaction_s
508 {
509         /* Pointer to the journal for this transaction. [no locking] */
510         journal_t               *t_journal;
511
512         /* Sequence number for this transaction [no locking] */
513         tid_t                   t_tid;
514
515         /*
516          * Transaction's current state
517          * [no locking - only kjournald2 alters this]
518          * [j_list_lock] guards transition of a transaction into T_FINISHED
519          * state and subsequent call of __jbd2_journal_drop_transaction()
520          * FIXME: needs barriers
521          * KLUDGE: [use j_state_lock]
522          */
523         enum {
524                 T_RUNNING,
525                 T_LOCKED,
526                 T_RUNDOWN,
527                 T_FLUSH,
528                 T_COMMIT,
529                 T_FINISHED
530         }                       t_state;
531
532         /*
533          * Where in the log does this transaction's commit start? [no locking]
534          */
535         unsigned long           t_log_start;
536
537         /* Number of buffers on the t_buffers list [j_list_lock] */
538         int                     t_nr_buffers;
539
540         /*
541          * Doubly-linked circular list of all buffers reserved but not yet
542          * modified by this transaction [j_list_lock]
543          */
544         struct journal_head     *t_reserved_list;
545
546         /*
547          * Doubly-linked circular list of all metadata buffers owned by this
548          * transaction [j_list_lock]
549          */
550         struct journal_head     *t_buffers;
551
552         /*
553          * Doubly-linked circular list of all forget buffers (superseded
554          * buffers which we can un-checkpoint once this transaction commits)
555          * [j_list_lock]
556          */
557         struct journal_head     *t_forget;
558
559         /*
560          * Doubly-linked circular list of all buffers still to be flushed before
561          * this transaction can be checkpointed. [j_list_lock]
562          */
563         struct journal_head     *t_checkpoint_list;
564
565         /*
566          * Doubly-linked circular list of all buffers submitted for IO while
567          * checkpointing. [j_list_lock]
568          */
569         struct journal_head     *t_checkpoint_io_list;
570
571         /*
572          * Doubly-linked circular list of temporary buffers currently undergoing
573          * IO in the log [j_list_lock]
574          */
575         struct journal_head     *t_iobuf_list;
576
577         /*
578          * Doubly-linked circular list of metadata buffers being shadowed by log
579          * IO.  The IO buffers on the iobuf list and the shadow buffers on this
580          * list match each other one for one at all times. [j_list_lock]
581          */
582         struct journal_head     *t_shadow_list;
583
584         /*
585          * Doubly-linked circular list of control buffers being written to the
586          * log. [j_list_lock]
587          */
588         struct journal_head     *t_log_list;
589
590         /*
591          * List of inodes whose data we've modified in data=ordered mode.
592          * [j_list_lock]
593          */
594         struct list_head        t_inode_list;
595
596         /*
597          * Protects info related to handles
598          */
599         spinlock_t              t_handle_lock;
600
601         /*
602          * Longest time some handle had to wait for running transaction
603          */
604         unsigned long           t_max_wait;
605
606         /*
607          * When transaction started
608          */
609         unsigned long           t_start;
610
611         /*
612          * Checkpointing stats [j_checkpoint_sem]
613          */
614         struct transaction_chp_stats_s t_chp_stats;
615
616         /*
617          * Number of outstanding updates running on this transaction
618          * [t_handle_lock]
619          */
620         int                     t_updates;
621
622         /*
623          * Number of buffers reserved for use by all handles in this transaction
624          * handle but not yet modified. [t_handle_lock]
625          */
626         int                     t_outstanding_credits;
627
628         /*
629          * Forward and backward links for the circular list of all transactions
630          * awaiting checkpoint. [j_list_lock]
631          */
632         transaction_t           *t_cpnext, *t_cpprev;
633
634         /*
635          * When will the transaction expire (become due for commit), in jiffies?
636          * [no locking]
637          */
638         unsigned long           t_expires;
639
640         /*
641          * When this transaction started, in nanoseconds [no locking]
642          */
643         ktime_t                 t_start_time;
644
645         /*
646          * How many handles used this transaction? [t_handle_lock]
647          */
648         int t_handle_count;
649
650         /*
651          * For use by the filesystem to store fs-specific data
652          * structures associated with the transaction
653          */
654         struct list_head        t_private_list;
655 };
656
657 struct transaction_run_stats_s {
658         unsigned long           rs_wait;
659         unsigned long           rs_running;
660         unsigned long           rs_locked;
661         unsigned long           rs_flushing;
662         unsigned long           rs_logging;
663
664         unsigned long           rs_handle_count;
665         unsigned long           rs_blocks;
666         unsigned long           rs_blocks_logged;
667 };
668
669 struct transaction_stats_s {
670         int                     ts_type;
671         unsigned long           ts_tid;
672         union {
673                 struct transaction_run_stats_s run;
674                 struct transaction_chp_stats_s chp;
675         } u;
676 };
677
678 #define JBD2_STATS_RUN          1
679 #define JBD2_STATS_CHECKPOINT   2
680
681 static inline unsigned long
682 jbd2_time_diff(unsigned long start, unsigned long end)
683 {
684         if (end >= start)
685                 return end - start;
686
687         return end + (MAX_JIFFY_OFFSET - start);
688 }
689
690 /**
691  * struct journal_s - The journal_s type is the concrete type associated with
692  *     journal_t.
693  * @j_flags:  General journaling state flags
694  * @j_errno:  Is there an outstanding uncleared error on the journal (from a
695  *     prior abort)?
696  * @j_sb_buffer: First part of superblock buffer
697  * @j_superblock: Second part of superblock buffer
698  * @j_format_version: Version of the superblock format
699  * @j_state_lock: Protect the various scalars in the journal
700  * @j_barrier_count:  Number of processes waiting to create a barrier lock
701  * @j_barrier: The barrier lock itself
702  * @j_running_transaction: The current running transaction..
703  * @j_committing_transaction: the transaction we are pushing to disk
704  * @j_checkpoint_transactions: a linked circular list of all transactions
705  *  waiting for checkpointing
706  * @j_wait_transaction_locked: Wait queue for waiting for a locked transaction
707  *  to start committing, or for a barrier lock to be released
708  * @j_wait_logspace: Wait queue for waiting for checkpointing to complete
709  * @j_wait_done_commit: Wait queue for waiting for commit to complete
710  * @j_wait_checkpoint:  Wait queue to trigger checkpointing
711  * @j_wait_commit: Wait queue to trigger commit
712  * @j_wait_updates: Wait queue to wait for updates to complete
713  * @j_checkpoint_mutex: Mutex for locking against concurrent checkpoints
714  * @j_head: Journal head - identifies the first unused block in the journal
715  * @j_tail: Journal tail - identifies the oldest still-used block in the
716  *  journal.
717  * @j_free: Journal free - how many free blocks are there in the journal?
718  * @j_first: The block number of the first usable block
719  * @j_last: The block number one beyond the last usable block
720  * @j_dev: Device where we store the journal
721  * @j_blocksize: blocksize for the location where we store the journal.
722  * @j_blk_offset: starting block offset for into the device where we store the
723  *     journal
724  * @j_fs_dev: Device which holds the client fs.  For internal journal this will
725  *     be equal to j_dev
726  * @j_maxlen: Total maximum capacity of the journal region on disk.
727  * @j_list_lock: Protects the buffer lists and internal buffer state.
728  * @j_inode: Optional inode where we store the journal.  If present, all journal
729  *     block numbers are mapped into this inode via bmap().
730  * @j_tail_sequence:  Sequence number of the oldest transaction in the log
731  * @j_transaction_sequence: Sequence number of the next transaction to grant
732  * @j_commit_sequence: Sequence number of the most recently committed
733  *  transaction
734  * @j_commit_request: Sequence number of the most recent transaction wanting
735  *     commit
736  * @j_uuid: Uuid of client object.
737  * @j_task: Pointer to the current commit thread for this journal
738  * @j_max_transaction_buffers:  Maximum number of metadata buffers to allow in a
739  *     single compound commit transaction
740  * @j_commit_interval: What is the maximum transaction lifetime before we begin
741  *  a commit?
742  * @j_commit_timer:  The timer used to wakeup the commit thread
743  * @j_revoke_lock: Protect the revoke table
744  * @j_revoke: The revoke table - maintains the list of revoked blocks in the
745  *     current transaction.
746  * @j_revoke_table: alternate revoke tables for j_revoke
747  * @j_wbuf: array of buffer_heads for jbd2_journal_commit_transaction
748  * @j_wbufsize: maximum number of buffer_heads allowed in j_wbuf, the
749  *      number that will fit in j_blocksize
750  * @j_last_sync_writer: most recent pid which did a synchronous write
751  * @j_history: Buffer storing the transactions statistics history
752  * @j_history_max: Maximum number of transactions in the statistics history
753  * @j_history_cur: Current number of transactions in the statistics history
754  * @j_history_lock: Protect the transactions statistics history
755  * @j_proc_entry: procfs entry for the jbd statistics directory
756  * @j_stats: Overall statistics
757  * @j_private: An opaque pointer to fs-private information.
758  */
759
760 struct journal_s
761 {
762         /* General journaling state flags [j_state_lock] */
763         unsigned long           j_flags;
764
765         /*
766          * Is there an outstanding uncleared error on the journal (from a prior
767          * abort)? [j_state_lock]
768          */
769         int                     j_errno;
770
771         /* The superblock buffer */
772         struct buffer_head      *j_sb_buffer;
773         journal_superblock_t    *j_superblock;
774
775         /* Version of the superblock format */
776         int                     j_format_version;
777
778         /*
779          * Protect the various scalars in the journal
780          */
781         spinlock_t              j_state_lock;
782
783         /*
784          * Number of processes waiting to create a barrier lock [j_state_lock]
785          */
786         int                     j_barrier_count;
787
788         /* The barrier lock itself */
789         struct mutex            j_barrier;
790
791         /*
792          * Transactions: The current running transaction...
793          * [j_state_lock] [caller holding open handle]
794          */
795         transaction_t           *j_running_transaction;
796
797         /*
798          * the transaction we are pushing to disk
799          * [j_state_lock] [caller holding open handle]
800          */
801         transaction_t           *j_committing_transaction;
802
803         /*
804          * ... and a linked circular list of all transactions waiting for
805          * checkpointing. [j_list_lock]
806          */
807         transaction_t           *j_checkpoint_transactions;
808
809         /*
810          * Wait queue for waiting for a locked transaction to start committing,
811          * or for a barrier lock to be released
812          */
813         wait_queue_head_t       j_wait_transaction_locked;
814
815         /* Wait queue for waiting for checkpointing to complete */
816         wait_queue_head_t       j_wait_logspace;
817
818         /* Wait queue for waiting for commit to complete */
819         wait_queue_head_t       j_wait_done_commit;
820
821         /* Wait queue to trigger checkpointing */
822         wait_queue_head_t       j_wait_checkpoint;
823
824         /* Wait queue to trigger commit */
825         wait_queue_head_t       j_wait_commit;
826
827         /* Wait queue to wait for updates to complete */
828         wait_queue_head_t       j_wait_updates;
829
830         /* Semaphore for locking against concurrent checkpoints */
831         struct mutex            j_checkpoint_mutex;
832
833         /*
834          * Journal head: identifies the first unused block in the journal.
835          * [j_state_lock]
836          */
837         unsigned long           j_head;
838
839         /*
840          * Journal tail: identifies the oldest still-used block in the journal.
841          * [j_state_lock]
842          */
843         unsigned long           j_tail;
844
845         /*
846          * Journal free: how many free blocks are there in the journal?
847          * [j_state_lock]
848          */
849         unsigned long           j_free;
850
851         /*
852          * Journal start and end: the block numbers of the first usable block
853          * and one beyond the last usable block in the journal. [j_state_lock]
854          */
855         unsigned long           j_first;
856         unsigned long           j_last;
857
858         /*
859          * Device, blocksize and starting block offset for the location where we
860          * store the journal.
861          */
862         struct block_device     *j_dev;
863         int                     j_blocksize;
864         unsigned long long      j_blk_offset;
865         char                    j_devname[BDEVNAME_SIZE+24];
866
867         /*
868          * Device which holds the client fs.  For internal journal this will be
869          * equal to j_dev.
870          */
871         struct block_device     *j_fs_dev;
872
873         /* Total maximum capacity of the journal region on disk. */
874         unsigned int            j_maxlen;
875
876         /*
877          * Protects the buffer lists and internal buffer state.
878          */
879         spinlock_t              j_list_lock;
880
881         /* Optional inode where we store the journal.  If present, all */
882         /* journal block numbers are mapped into this inode via */
883         /* bmap(). */
884         struct inode            *j_inode;
885
886         /*
887          * Sequence number of the oldest transaction in the log [j_state_lock]
888          */
889         tid_t                   j_tail_sequence;
890
891         /*
892          * Sequence number of the next transaction to grant [j_state_lock]
893          */
894         tid_t                   j_transaction_sequence;
895
896         /*
897          * Sequence number of the most recently committed transaction
898          * [j_state_lock].
899          */
900         tid_t                   j_commit_sequence;
901
902         /*
903          * Sequence number of the most recent transaction wanting commit
904          * [j_state_lock]
905          */
906         tid_t                   j_commit_request;
907
908         /*
909          * Journal uuid: identifies the object (filesystem, LVM volume etc)
910          * backed by this journal.  This will eventually be replaced by an array
911          * of uuids, allowing us to index multiple devices within a single
912          * journal and to perform atomic updates across them.
913          */
914         __u8                    j_uuid[16];
915
916         /* Pointer to the current commit thread for this journal */
917         struct task_struct      *j_task;
918
919         /*
920          * Maximum number of metadata buffers to allow in a single compound
921          * commit transaction
922          */
923         int                     j_max_transaction_buffers;
924
925         /*
926          * What is the maximum transaction lifetime before we begin a commit?
927          */
928         unsigned long           j_commit_interval;
929
930         /* The timer used to wakeup the commit thread: */
931         struct timer_list       j_commit_timer;
932
933         /*
934          * The revoke table: maintains the list of revoked blocks in the
935          * current transaction.  [j_revoke_lock]
936          */
937         spinlock_t              j_revoke_lock;
938         struct jbd2_revoke_table_s *j_revoke;
939         struct jbd2_revoke_table_s *j_revoke_table[2];
940
941         /*
942          * array of bhs for jbd2_journal_commit_transaction
943          */
944         struct buffer_head      **j_wbuf;
945         int                     j_wbufsize;
946
947         /*
948          * this is the pid of hte last person to run a synchronous operation
949          * through the journal
950          */
951         pid_t                   j_last_sync_writer;
952
953         /*
954          * the average amount of time in nanoseconds it takes to commit a
955          * transaction to disk. [j_state_lock]
956          */
957         u64                     j_average_commit_time;
958
959         /*
960          * minimum and maximum times that we should wait for
961          * additional filesystem operations to get batched into a
962          * synchronous handle in microseconds
963          */
964         u32                     j_min_batch_time;
965         u32                     j_max_batch_time;
966
967         /* This function is called when a transaction is closed */
968         void                    (*j_commit_callback)(journal_t *,
969                                                      transaction_t *);
970
971         /*
972          * Journal statistics
973          */
974         struct transaction_stats_s *j_history;
975         int                     j_history_max;
976         int                     j_history_cur;
977         /*
978          * Protect the transactions statistics history
979          */
980         spinlock_t              j_history_lock;
981         struct proc_dir_entry   *j_proc_entry;
982         struct transaction_stats_s j_stats;
983
984         /* Failed journal commit ID */
985         unsigned int            j_failed_commit;
986
987         /*
988          * An opaque pointer to fs-private information.  ext3 puts its
989          * superblock pointer here
990          */
991         void *j_private;
992 };
993
994 /*
995  * Journal flag definitions
996  */
997 #define JBD2_UNMOUNT    0x001   /* Journal thread is being destroyed */
998 #define JBD2_ABORT      0x002   /* Journaling has been aborted for errors. */
999 #define JBD2_ACK_ERR    0x004   /* The errno in the sb has been acked */
1000 #define JBD2_FLUSHED    0x008   /* The journal superblock has been flushed */
1001 #define JBD2_LOADED     0x010   /* The journal superblock has been loaded */
1002 #define JBD2_BARRIER    0x020   /* Use IDE barriers */
1003 #define JBD2_ABORT_ON_SYNCDATA_ERR      0x040   /* Abort the journal on file
1004                                                  * data write error in ordered
1005                                                  * mode */
1006
1007 /*
1008  * Function declarations for the journaling transaction and buffer
1009  * management
1010  */
1011
1012 /* Filing buffers */
1013 extern void jbd2_journal_unfile_buffer(journal_t *, struct journal_head *);
1014 extern void __jbd2_journal_unfile_buffer(struct journal_head *);
1015 extern void __jbd2_journal_refile_buffer(struct journal_head *);
1016 extern void jbd2_journal_refile_buffer(journal_t *, struct journal_head *);
1017 extern void __jbd2_journal_file_buffer(struct journal_head *, transaction_t *, int);
1018 extern void __journal_free_buffer(struct journal_head *bh);
1019 extern void jbd2_journal_file_buffer(struct journal_head *, transaction_t *, int);
1020 extern void __journal_clean_data_list(transaction_t *transaction);
1021
1022 /* Log buffer allocation */
1023 extern struct journal_head * jbd2_journal_get_descriptor_buffer(journal_t *);
1024 int jbd2_journal_next_log_block(journal_t *, unsigned long long *);
1025
1026 /* Commit management */
1027 extern void jbd2_journal_commit_transaction(journal_t *);
1028
1029 /* Checkpoint list management */
1030 int __jbd2_journal_clean_checkpoint_list(journal_t *journal);
1031 int __jbd2_journal_remove_checkpoint(struct journal_head *);
1032 void __jbd2_journal_insert_checkpoint(struct journal_head *, transaction_t *);
1033
1034 /* Buffer IO */
1035 extern int
1036 jbd2_journal_write_metadata_buffer(transaction_t          *transaction,
1037                               struct journal_head  *jh_in,
1038                               struct journal_head **jh_out,
1039                               unsigned long long   blocknr);
1040
1041 /* Transaction locking */
1042 extern void             __wait_on_journal (journal_t *);
1043
1044 /*
1045  * Journal locking.
1046  *
1047  * We need to lock the journal during transaction state changes so that nobody
1048  * ever tries to take a handle on the running transaction while we are in the
1049  * middle of moving it to the commit phase.  j_state_lock does this.
1050  *
1051  * Note that the locking is completely interrupt unsafe.  We never touch
1052  * journal structures from interrupts.
1053  */
1054
1055 static inline handle_t *journal_current_handle(void)
1056 {
1057         return current->journal_info;
1058 }
1059
1060 /* The journaling code user interface:
1061  *
1062  * Create and destroy handles
1063  * Register buffer modifications against the current transaction.
1064  */
1065
1066 extern handle_t *jbd2_journal_start(journal_t *, int nblocks);
1067 extern int       jbd2_journal_restart (handle_t *, int nblocks);
1068 extern int       jbd2_journal_extend (handle_t *, int nblocks);
1069 extern int       jbd2_journal_get_write_access(handle_t *, struct buffer_head *);
1070 extern int       jbd2_journal_get_create_access (handle_t *, struct buffer_head *);
1071 extern int       jbd2_journal_get_undo_access(handle_t *, struct buffer_head *);
1072 extern int       jbd2_journal_dirty_metadata (handle_t *, struct buffer_head *);
1073 extern void      jbd2_journal_release_buffer (handle_t *, struct buffer_head *);
1074 extern int       jbd2_journal_forget (handle_t *, struct buffer_head *);
1075 extern void      journal_sync_buffer (struct buffer_head *);
1076 extern void      jbd2_journal_invalidatepage(journal_t *,
1077                                 struct page *, unsigned long);
1078 extern int       jbd2_journal_try_to_free_buffers(journal_t *, struct page *, gfp_t);
1079 extern int       jbd2_journal_stop(handle_t *);
1080 extern int       jbd2_journal_flush (journal_t *);
1081 extern void      jbd2_journal_lock_updates (journal_t *);
1082 extern void      jbd2_journal_unlock_updates (journal_t *);
1083
1084 extern journal_t * jbd2_journal_init_dev(struct block_device *bdev,
1085                                 struct block_device *fs_dev,
1086                                 unsigned long long start, int len, int bsize);
1087 extern journal_t * jbd2_journal_init_inode (struct inode *);
1088 extern int         jbd2_journal_update_format (journal_t *);
1089 extern int         jbd2_journal_check_used_features
1090                    (journal_t *, unsigned long, unsigned long, unsigned long);
1091 extern int         jbd2_journal_check_available_features
1092                    (journal_t *, unsigned long, unsigned long, unsigned long);
1093 extern int         jbd2_journal_set_features
1094                    (journal_t *, unsigned long, unsigned long, unsigned long);
1095 extern void        jbd2_journal_clear_features
1096                    (journal_t *, unsigned long, unsigned long, unsigned long);
1097 extern int         jbd2_journal_create     (journal_t *);
1098 extern int         jbd2_journal_load       (journal_t *journal);
1099 extern int         jbd2_journal_destroy    (journal_t *);
1100 extern int         jbd2_journal_recover    (journal_t *journal);
1101 extern int         jbd2_journal_wipe       (journal_t *, int);
1102 extern int         jbd2_journal_skip_recovery   (journal_t *);
1103 extern void        jbd2_journal_update_superblock       (journal_t *, int);
1104 extern void        __jbd2_journal_abort_hard    (journal_t *);
1105 extern void        jbd2_journal_abort      (journal_t *, int);
1106 extern int         jbd2_journal_errno      (journal_t *);
1107 extern void        jbd2_journal_ack_err    (journal_t *);
1108 extern int         jbd2_journal_clear_err  (journal_t *);
1109 extern int         jbd2_journal_bmap(journal_t *, unsigned long, unsigned long long *);
1110 extern int         jbd2_journal_force_commit(journal_t *);
1111 extern int         jbd2_journal_file_inode(handle_t *handle, struct jbd2_inode *inode);
1112 extern int         jbd2_journal_begin_ordered_truncate(struct jbd2_inode *inode, loff_t new_size);
1113 extern void        jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode);
1114 extern void        jbd2_journal_release_jbd_inode(journal_t *journal, struct jbd2_inode *jinode);
1115
1116 /*
1117  * journal_head management
1118  */
1119 struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh);
1120 struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh);
1121 void jbd2_journal_remove_journal_head(struct buffer_head *bh);
1122 void jbd2_journal_put_journal_head(struct journal_head *jh);
1123
1124 /*
1125  * handle management
1126  */
1127 extern struct kmem_cache *jbd2_handle_cache;
1128
1129 static inline handle_t *jbd2_alloc_handle(gfp_t gfp_flags)
1130 {
1131         return kmem_cache_alloc(jbd2_handle_cache, gfp_flags);
1132 }
1133
1134 static inline void jbd2_free_handle(handle_t *handle)
1135 {
1136         kmem_cache_free(jbd2_handle_cache, handle);
1137 }
1138
1139 /* Primary revoke support */
1140 #define JOURNAL_REVOKE_DEFAULT_HASH 256
1141 extern int         jbd2_journal_init_revoke(journal_t *, int);
1142 extern void        jbd2_journal_destroy_revoke_caches(void);
1143 extern int         jbd2_journal_init_revoke_caches(void);
1144
1145 extern void        jbd2_journal_destroy_revoke(journal_t *);
1146 extern int         jbd2_journal_revoke (handle_t *, unsigned long long, struct buffer_head *);
1147 extern int         jbd2_journal_cancel_revoke(handle_t *, struct journal_head *);
1148 extern void        jbd2_journal_write_revoke_records(journal_t *, transaction_t *);
1149
1150 /* Recovery revoke support */
1151 extern int      jbd2_journal_set_revoke(journal_t *, unsigned long long, tid_t);
1152 extern int      jbd2_journal_test_revoke(journal_t *, unsigned long long, tid_t);
1153 extern void     jbd2_journal_clear_revoke(journal_t *);
1154 extern void     jbd2_journal_switch_revoke_table(journal_t *journal);
1155
1156 /*
1157  * The log thread user interface:
1158  *
1159  * Request space in the current transaction, and force transaction commit
1160  * transitions on demand.
1161  */
1162
1163 int __jbd2_log_space_left(journal_t *); /* Called with journal locked */
1164 int jbd2_log_start_commit(journal_t *journal, tid_t tid);
1165 int __jbd2_log_start_commit(journal_t *journal, tid_t tid);
1166 int jbd2_journal_start_commit(journal_t *journal, tid_t *tid);
1167 int jbd2_journal_force_commit_nested(journal_t *journal);
1168 int jbd2_log_wait_commit(journal_t *journal, tid_t tid);
1169 int jbd2_log_do_checkpoint(journal_t *journal);
1170
1171 void __jbd2_log_wait_for_space(journal_t *journal);
1172 extern void     __jbd2_journal_drop_transaction(journal_t *, transaction_t *);
1173 extern int      jbd2_cleanup_journal_tail(journal_t *);
1174
1175 /* Debugging code only: */
1176
1177 #define jbd_ENOSYS() \
1178 do {                                                                       \
1179         printk (KERN_ERR "JBD unimplemented function %s\n", __func__); \
1180         current->state = TASK_UNINTERRUPTIBLE;                             \
1181         schedule();                                                        \
1182 } while (1)
1183
1184 /*
1185  * is_journal_abort
1186  *
1187  * Simple test wrapper function to test the JBD2_ABORT state flag.  This
1188  * bit, when set, indicates that we have had a fatal error somewhere,
1189  * either inside the journaling layer or indicated to us by the client
1190  * (eg. ext3), and that we and should not commit any further
1191  * transactions.
1192  */
1193
1194 static inline int is_journal_aborted(journal_t *journal)
1195 {
1196         return journal->j_flags & JBD2_ABORT;
1197 }
1198
1199 static inline int is_handle_aborted(handle_t *handle)
1200 {
1201         if (handle->h_aborted)
1202                 return 1;
1203         return is_journal_aborted(handle->h_transaction->t_journal);
1204 }
1205
1206 static inline void jbd2_journal_abort_handle(handle_t *handle)
1207 {
1208         handle->h_aborted = 1;
1209 }
1210
1211 #endif /* __KERNEL__   */
1212
1213 /* Comparison functions for transaction IDs: perform comparisons using
1214  * modulo arithmetic so that they work over sequence number wraps. */
1215
1216 static inline int tid_gt(tid_t x, tid_t y)
1217 {
1218         int difference = (x - y);
1219         return (difference > 0);
1220 }
1221
1222 static inline int tid_geq(tid_t x, tid_t y)
1223 {
1224         int difference = (x - y);
1225         return (difference >= 0);
1226 }
1227
1228 extern int jbd2_journal_blocks_per_page(struct inode *inode);
1229 extern size_t journal_tag_bytes(journal_t *journal);
1230
1231 /*
1232  * Return the minimum number of blocks which must be free in the journal
1233  * before a new transaction may be started.  Must be called under j_state_lock.
1234  */
1235 static inline int jbd_space_needed(journal_t *journal)
1236 {
1237         int nblocks = journal->j_max_transaction_buffers;
1238         if (journal->j_committing_transaction)
1239                 nblocks += journal->j_committing_transaction->
1240                                         t_outstanding_credits;
1241         return nblocks;
1242 }
1243
1244 /*
1245  * Definitions which augment the buffer_head layer
1246  */
1247
1248 /* journaling buffer types */
1249 #define BJ_None         0       /* Not journaled */
1250 #define BJ_Metadata     1       /* Normal journaled metadata */
1251 #define BJ_Forget       2       /* Buffer superseded by this transaction */
1252 #define BJ_IO           3       /* Buffer is for temporary IO use */
1253 #define BJ_Shadow       4       /* Buffer contents being shadowed to the log */
1254 #define BJ_LogCtl       5       /* Buffer contains log descriptors */
1255 #define BJ_Reserved     6       /* Buffer is reserved for access by journal */
1256 #define BJ_Types        7
1257
1258 extern int jbd_blocks_per_page(struct inode *inode);
1259
1260 #ifdef __KERNEL__
1261
1262 #define buffer_trace_init(bh)   do {} while (0)
1263 #define print_buffer_fields(bh) do {} while (0)
1264 #define print_buffer_trace(bh)  do {} while (0)
1265 #define BUFFER_TRACE(bh, info)  do {} while (0)
1266 #define BUFFER_TRACE2(bh, bh2, info)    do {} while (0)
1267 #define JBUFFER_TRACE(jh, info) do {} while (0)
1268
1269 #endif  /* __KERNEL__ */
1270
1271 #endif  /* _LINUX_JBD2_H */