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 #if defined(CONFIG_JBD) || defined(CONFIG_JBD_MODULE) || !defined(__KERNEL__)
  20
  21 /* Allow this file to be included directly into e2fsprogs */
  22 #ifndef __KERNEL__
  23 #include "jfs_compat.h"
  24 #define JFS_DEBUG
  25 #define jfs_debug jbd_debug
  26 #else
  27
  28 #include <linux/buffer_head.h>
  29 #include <linux/journal-head.h>
  30 #include <linux/stddef.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, int 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 #include <asm/bug.h>
 243
 244 #define JBD_ASSERTIONS
 245 #ifdef JBD_ASSERTIONS
 246 #define J_ASSERT(assert)                                                \
 247 do {                                                                    \
 248         if (!(assert)) {                                                \
 249                 printk (KERN_EMERG                                      \
 250                         "Assertion failure in %s() at %s:%d: \"%s\"\n", \
 251                         __FUNCTION__, __FILE__, __LINE__, # assert);    \
 252                 BUG();                                                  \
 253         }                                                               \
 254 } while (0)
 255
 256 #if defined(CONFIG_BUFFER_DEBUG)
 257 void buffer_assertion_failure(struct buffer_head *bh);
 258 #define J_ASSERT_BH(bh, expr)                                           \
 259         do {                                                            \
 260                 if (!(expr))                                            \
 261                         buffer_assertion_failure(bh);                   \
 262                 J_ASSERT(expr);                                         \
 263         } while (0)
 264 #define J_ASSERT_JH(jh, expr)   J_ASSERT_BH(jh2bh(jh), expr)
 265 #else
 266 #define J_ASSERT_BH(bh, expr)   J_ASSERT(expr)
 267 #define J_ASSERT_JH(jh, expr)   J_ASSERT(expr)
 268 #endif
 269
 270 #else
 271 #define J_ASSERT(assert)        do { } while (0)
 272 #endif          /* JBD_ASSERTIONS */
 273
 274 #if defined(JBD_PARANOID_IOFAIL)
 275 #define J_EXPECT(expr, why...)          J_ASSERT(expr)
 276 #define J_EXPECT_BH(bh, expr, why...)   J_ASSERT_BH(bh, expr)
 277 #define J_EXPECT_JH(jh, expr, why...)   J_ASSERT_JH(jh, expr)
 278 #else
 279 #define __journal_expect(expr, why...)                                       \
 280         ({                                                                   \
 281                 int val = (expr);                                            \
 282                 if (!val) {                                                  \
 283                         printk(KERN_ERR                                      \
 284                                 "EXT3-fs unexpected failure: %s;\n",# expr); \
 285                         printk(KERN_ERR why "\n");                           \
 286                 }                                                            \
 287                 val;                                                         \
 288         })
 289 #define J_EXPECT(expr, why...)          __journal_expect(expr, ## why)
 290 #define J_EXPECT_BH(bh, expr, why...)   __journal_expect(expr, ## why)
 291 #define J_EXPECT_JH(jh, expr, why...)   __journal_expect(expr, ## why)
 292 #endif
 293
 294 enum jbd_state_bits {
 295         BH_JBD                  /* Has an attached ext3 journal_head */
 296           = BH_PrivateStart,
 297         BH_JWrite,              /* Being written to log (@@@ DEBUGGING) */
 298         BH_Freed,               /* Has been freed (truncated) */
 299         BH_Revoked,             /* Has been revoked from the log */
 300         BH_RevokeValid,         /* Revoked flag is valid */
 301         BH_JBDDirty,            /* Is dirty but journaled */
 302         BH_State,               /* Pins most journal_head state */
 303         BH_JournalHead,         /* Pins bh->b_private and jh->b_bh */
 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 #define HAVE_JOURNAL_CALLBACK_STATUS
 357 /**
 358  *   struct journal_callback - Base structure for callback information.
 359  *   @jcb_list: list information for other callbacks attached to the same handle.
 360  *   @jcb_func: Function to call with this callback structure.
 361  *
 362  *   This struct is a 'seed' structure for a using with your own callback
 363  *   structs. If you are using callbacks you must allocate one of these
 364  *   or another struct of your own definition which has this struct
 365  *   as it's first element and pass it to journal_callback_set().
 366  *
 367  *   This is used internally by jbd to maintain callback information.
 368  *
 369  *   See journal_callback_set for more information.
 370  **/
 371 struct journal_callback {
 372         struct list_head jcb_list;              /* t_jcb_lock */
 373         void (*jcb_func)(struct journal_callback *jcb, int error);
 374         /* user data goes here */
 375 };
 376
 377 struct jbd_revoke_table_s;
 378
 379 /**
 380  * struct handle_s - The handle_s type is the concrete type associated with
 381  *     handle_t.
 382  * @h_transaction: Which compound transaction is this update a part of?
 383  * @h_buffer_credits: Number of remaining buffers we are allowed to dirty.
 384  * @h_ref: Reference count on this handle
 385  * @h_jcb: List of application registered callbacks for this handle.
 386  * @h_err: Field for caller's use to track errors through large fs operations
 387  * @h_sync: flag for sync-on-close
 388  * @h_jdata: flag to force data journaling
 389  * @h_aborted: flag indicating fatal error on handle
 390  **/
 391
 392 /* Docbook can't yet cope with the bit fields, but will leave the documentation
 393  * in so it can be fixed later.
 394  */
 395
 396 struct handle_s
 397 {
 398         /* Which compound transaction is this update a part of? */
 399         transaction_t           *h_transaction;
 400
 401         /* Number of remaining buffers we are allowed to dirty: */
 402         int                     h_buffer_credits;
 403
 404         /* Reference count on this handle */
 405         int                     h_ref;
 406
 407         /* Field for caller's use to track errors through large fs */
 408         /* operations */
 409         int                     h_err;
 410
 411         /*
 412          * List of application registered callbacks for this handle. The
 413          * function(s) will be called after the transaction that this handle is
 414          * part of has been committed to disk. [t_jcb_lock]
 415          */
 416         struct list_head        h_jcb;
 417
 418         /* Flags [no locking] */
 419         unsigned int    h_sync:         1;      /* sync-on-close */
 420         unsigned int    h_jdata:        1;      /* force data journaling */
 421         unsigned int    h_aborted:      1;      /* fatal error on handle */
 422 };
 423
 424
 425 /* The transaction_t type is the guts of the journaling mechanism.  It
 426  * tracks a compound transaction through its various states:
 427  *
 428  * RUNNING:     accepting new updates
 429  * LOCKED:      Updates still running but we don't accept new ones
 430  * RUNDOWN:     Updates are tidying up but have finished requesting
 431  *              new buffers to modify (state not used for now)
 432  * FLUSH:       All updates complete, but we are still writing to disk
 433  * COMMIT:      All data on disk, writing commit record
 434  * FINISHED:    We still have to keep the transaction for checkpointing.
 435  *
 436  * The transaction keeps track of all of the buffers modified by a
 437  * running transaction, and all of the buffers committed but not yet
 438  * flushed to home for finished transactions.
 439  */
 440
 441 /*
 442  * Lock ranking:
 443  *
 444  *    j_list_lock
 445  *      ->jbd_lock_bh_journal_head()    (This is "innermost")
 446  *
 447  *    j_state_lock
 448  *    ->jbd_lock_bh_state()
 449  *
 450  *    jbd_lock_bh_state()
 451  *    ->j_list_lock
 452  *
 453  *    j_state_lock
 454  *    ->t_handle_lock
 455  *
 456  *    j_state_lock
 457  *    ->j_list_lock                     (journal_unmap_buffer)
 458  *
 459  *    t_handle_lock
 460  *    ->t_jcb_lock
 461  */
 462
 463 struct transaction_s
 464 {
 465         /* Pointer to the journal for this transaction. [no locking] */
 466         journal_t               *t_journal;
 467
 468         /* Sequence number for this transaction [no locking] */
 469         tid_t                   t_tid;
 470
 471         /*
 472          * Transaction's current state
 473          * [no locking - only kjournald alters this]
 474          * FIXME: needs barriers
 475          * KLUDGE: [use j_state_lock]
 476          */
 477         enum {
 478                 T_RUNNING,
 479                 T_LOCKED,
 480                 T_RUNDOWN,
 481                 T_FLUSH,
 482                 T_COMMIT,
 483                 T_FINISHED
 484         }                       t_state;
 485
 486         /*
 487          * Where in the log does this transaction's commit start? [no locking]
 488          */
 489         unsigned long           t_log_start;
 490
 491         /* Number of buffers on the t_buffers list [j_list_lock] */
 492         int                     t_nr_buffers;
 493
 494         /*
 495          * Doubly-linked circular list of all buffers reserved but not yet
 496          * modified by this transaction [j_list_lock]
 497          */
 498         struct journal_head     *t_reserved_list;
 499
 500         /*
 501          * Doubly-linked circular list of all buffers under writeout during
 502          * commit [j_list_lock]
 503          */
 504         struct journal_head     *t_locked_list;
 505
 506         /*
 507          * Doubly-linked circular list of all metadata buffers owned by this
 508          * transaction [j_list_lock]
 509          */
 510         struct journal_head     *t_buffers;
 511
 512         /*
 513          * Doubly-linked circular list of all data buffers still to be
 514          * flushed before this transaction can be committed [j_list_lock]
 515          */
 516         struct journal_head     *t_sync_datalist;
 517
 518         /*
 519          * Doubly-linked circular list of all forget buffers (superseded
 520          * buffers which we can un-checkpoint once this transaction commits)
 521          * [j_list_lock]
 522          */
 523         struct journal_head     *t_forget;
 524
 525         /*
 526          * Doubly-linked circular list of all buffers still to be flushed before
 527          * this transaction can be checkpointed. [j_list_lock]
 528          */
 529         struct journal_head     *t_checkpoint_list;
 530
 531         /*
 532          * Doubly-linked circular list of temporary buffers currently undergoing
 533          * IO in the log [j_list_lock]
 534          */
 535         struct journal_head     *t_iobuf_list;
 536
 537         /*
 538          * Doubly-linked circular list of metadata buffers being shadowed by log
 539          * IO.  The IO buffers on the iobuf list and the shadow buffers on this
 540          * list match each other one for one at all times. [j_list_lock]
 541          */
 542         struct journal_head     *t_shadow_list;
 543
 544         /*
 545          * Doubly-linked circular list of control buffers being written to the
 546          * log. [j_list_lock]
 547          */
 548         struct journal_head     *t_log_list;
 549
 550         /*
 551          * Protects info related to handles
 552          */
 553         spinlock_t              t_handle_lock;
 554
 555         /*
 556          * Number of outstanding updates running on this transaction
 557          * [t_handle_lock]
 558          */
 559         int                     t_updates;
 560
 561         /*
 562          * Number of buffers reserved for use by all handles in this transaction
 563          * handle but not yet modified. [t_handle_lock]
 564          */
 565         int                     t_outstanding_credits;
 566
 567         /*
 568          * Forward and backward links for the circular list of all transactions
 569          * awaiting checkpoint. [j_list_lock]
 570          */
 571         transaction_t           *t_cpnext, *t_cpprev;
 572
 573         /*
 574          * When will the transaction expire (become due for commit), in jiffies?
 575          * [no locking]
 576          */
 577         unsigned long           t_expires;
 578
 579         /*
 580          * How many handles used this transaction? [t_handle_lock]
 581          */
 582         int t_handle_count;
 583
 584         /*
 585          * Protects the callback list
 586          */
 587         spinlock_t              t_jcb_lock;
 588         /*
 589          * List of registered callback functions for this transaction.
 590          * Called when the transaction is committed. [t_jcb_lock]
 591          */
 592         struct list_head        t_jcb;
 593 };
 594
 595 /**
 596  * struct journal_s - The journal_s type is the concrete type associated with
 597  *     journal_t.
 598  * @j_flags:  General journaling state flags
 599  * @j_errno:  Is there an outstanding uncleared error on the journal (from a
 600  *     prior abort)?
 601  * @j_sb_buffer: First part of superblock buffer
 602  * @j_superblock: Second part of superblock buffer
 603  * @j_format_version: Version of the superblock format
 604  * @j_barrier_count:  Number of processes waiting to create a barrier lock
 605  * @j_barrier: The barrier lock itself
 606  * @j_running_transaction: The current running transaction..
 607  * @j_committing_transaction: the transaction we are pushing to disk
 608  * @j_checkpoint_transactions: a linked circular list of all transactions
 609  *  waiting for checkpointing
 610  * @j_wait_transaction_locked: Wait queue for waiting for a locked transaction
 611  *  to start committing, or for a barrier lock to be released
 612  * @j_wait_logspace: Wait queue for waiting for checkpointing to complete
 613  * @j_wait_done_commit: Wait queue for waiting for commit to complete
 614  * @j_wait_checkpoint:  Wait queue to trigger checkpointing
 615  * @j_wait_commit: Wait queue to trigger commit
 616  * @j_wait_updates: Wait queue to wait for updates to complete
 617  * @j_checkpoint_sem: Semaphore for locking against concurrent checkpoints
 618  * @j_head: Journal head - identifies the first unused block in the journal
 619  * @j_tail: Journal tail - identifies the oldest still-used block in the
 620  *  journal.
 621  * @j_free: Journal free - how many free blocks are there in the journal?
 622  * @j_first: The block number of the first usable block
 623  * @j_last: The block number one beyond the last usable block
 624  * @j_dev: Device where we store the journal
 625  * @j_blocksize: blocksize for the location where we store the journal.
 626  * @j_blk_offset: starting block offset for into the device where we store the
 627  *     journal
 628  * @j_fs_dev: Device which holds the client fs.  For internal journal this will
 629  *     be equal to j_dev
 630  * @j_maxlen: Total maximum capacity of the journal region on disk.
 631  * @j_inode: Optional inode where we store the journal.  If present, all journal
 632  *     block numbers are mapped into this inode via bmap().
 633  * @j_tail_sequence:  Sequence number of the oldest transaction in the log
 634  * @j_transaction_sequence: Sequence number of the next transaction to grant
 635  * @j_commit_sequence: Sequence number of the most recently committed
 636  *  transaction
 637  * @j_commit_request: Sequence number of the most recent transaction wanting
 638  *     commit
 639  * @j_uuid: Uuid of client object.
 640  * @j_task: Pointer to the current commit thread for this journal
 641  * @j_max_transaction_buffers:  Maximum number of metadata buffers to allow in a
 642  *     single compound commit transaction
 643  * @j_commit_interval: What is the maximum transaction lifetime before we begin
 644  *  a commit?
 645  * @j_commit_timer:  The timer used to wakeup the commit thread
 646  * @j_revoke: The revoke table - maintains the list of revoked blocks in the
 647  *     current transaction.
 648  */
 649
 650 struct journal_s
 651 {
 652         /* General journaling state flags [j_state_lock] */
 653         unsigned long           j_flags;
 654
 655         /*
 656          * Is there an outstanding uncleared error on the journal (from a prior
 657          * abort)? [j_state_lock]
 658          */
 659         int                     j_errno;
 660
 661         /* The superblock buffer */
 662         struct buffer_head      *j_sb_buffer;
 663         journal_superblock_t    *j_superblock;
 664
 665         /* Version of the superblock format */
 666         int                     j_format_version;
 667
 668         /*
 669          * Protect the various scalars in the journal
 670          */
 671         spinlock_t              j_state_lock;
 672
 673         /*
 674          * Number of processes waiting to create a barrier lock [j_state_lock]
 675          */
 676         int                     j_barrier_count;
 677
 678         /* The barrier lock itself */
 679         struct semaphore        j_barrier;
 680
 681         /*
 682          * Transactions: The current running transaction...
 683          * [j_state_lock] [caller holding open handle]
 684          */
 685         transaction_t           *j_running_transaction;
 686
 687         /*
 688          * the transaction we are pushing to disk
 689          * [j_state_lock] [caller holding open handle]
 690          */
 691         transaction_t           *j_committing_transaction;
 692
 693         /*
 694          * ... and a linked circular list of all transactions waiting for
 695          * checkpointing. [j_list_lock]
 696          */
 697         transaction_t           *j_checkpoint_transactions;
 698
 699         /*
 700          * Wait queue for waiting for a locked transaction to start committing,
 701          * or for a barrier lock to be released
 702          */
 703         wait_queue_head_t       j_wait_transaction_locked;
 704
 705         /* Wait queue for waiting for checkpointing to complete */
 706         wait_queue_head_t       j_wait_logspace;
 707
 708         /* Wait queue for waiting for commit to complete */
 709         wait_queue_head_t       j_wait_done_commit;
 710
 711         /* Wait queue to trigger checkpointing */
 712         wait_queue_head_t       j_wait_checkpoint;
 713
 714         /* Wait queue to trigger commit */
 715         wait_queue_head_t       j_wait_commit;
 716
 717         /* Wait queue to wait for updates to complete */
 718         wait_queue_head_t       j_wait_updates;
 719
 720         /* Semaphore for locking against concurrent checkpoints */
 721         struct semaphore        j_checkpoint_sem;
 722
 723         /*
 724          * Journal head: identifies the first unused block in the journal.
 725          * [j_state_lock]
 726          */
 727         unsigned long           j_head;
 728
 729         /*
 730          * Journal tail: identifies the oldest still-used block in the journal.
 731          * [j_state_lock]
 732          */
 733         unsigned long           j_tail;
 734
 735         /*
 736          * Journal free: how many free blocks are there in the journal?
 737          * [j_state_lock]
 738          */
 739         unsigned long           j_free;
 740
 741         /*
 742          * Journal start and end: the block numbers of the first usable block
 743          * and one beyond the last usable block in the journal. [j_state_lock]
 744          */
 745         unsigned long           j_first;
 746         unsigned long           j_last;
 747
 748         /*
 749          * Device, blocksize and starting block offset for the location where we
 750          * store the journal.
 751          */
 752         struct block_device     *j_dev;
 753         int                     j_blocksize;
 754         unsigned int            j_blk_offset;
 755
 756         /*
 757          * Device which holds the client fs.  For internal journal this will be
 758          * equal to j_dev.
 759          */
 760         struct block_device     *j_fs_dev;
 761
 762         /* Total maximum capacity of the journal region on disk. */
 763         unsigned int            j_maxlen;
 764
 765         /*
 766          * Protects the buffer lists and internal buffer state.
 767          */
 768         spinlock_t              j_list_lock;
 769
 770         /* Optional inode where we store the journal.  If present, all */
 771         /* journal block numbers are mapped into this inode via */
 772         /* bmap(). */
 773         struct inode            *j_inode;
 774
 775         /*
 776          * Sequence number of the oldest transaction in the log [j_state_lock]
 777          */
 778         tid_t                   j_tail_sequence;
 779
 780         /*
 781          * Sequence number of the next transaction to grant [j_state_lock]
 782          */
 783         tid_t                   j_transaction_sequence;
 784
 785         /*
 786          * Sequence number of the most recently committed transaction
 787          * [j_state_lock].
 788          */
 789         tid_t                   j_commit_sequence;
 790
 791         /*
 792          * Sequence number of the most recent transaction wanting commit
 793          * [j_state_lock]
 794          */
 795         tid_t                   j_commit_request;
 796
 797         /*
 798          * Journal uuid: identifies the object (filesystem, LVM volume etc)
 799          * backed by this journal.  This will eventually be replaced by an array
 800          * of uuids, allowing us to index multiple devices within a single
 801          * journal and to perform atomic updates across them.
 802          */
 803         __u8                    j_uuid[16];
 804
 805         /* Pointer to the current commit thread for this journal */
 806         struct task_struct      *j_task;
 807
 808         /*
 809          * Maximum number of metadata buffers to allow in a single compound
 810          * commit transaction
 811          */
 812         int                     j_max_transaction_buffers;
 813
 814         /*
 815          * What is the maximum transaction lifetime before we begin a commit?
 816          */
 817         unsigned long           j_commit_interval;
 818
 819         /* The timer used to wakeup the commit thread: */
 820         struct timer_list       *j_commit_timer;
 821
 822         /*
 823          * The revoke table: maintains the list of revoked blocks in the
 824          * current transaction.  [j_revoke_lock]
 825          */
 826         spinlock_t              j_revoke_lock;
 827         struct jbd_revoke_table_s *j_revoke;
 828         struct jbd_revoke_table_s *j_revoke_table[2];
 829
 830         /*
 831          * An opaque pointer to fs-private information.  ext3 puts its
 832          * superblock pointer here
 833          */
 834         void *j_private;
 835 };
 836
 837 /*
 838  * Journal flag definitions
 839  */
 840 #define JFS_UNMOUNT     0x001   /* Journal thread is being destroyed */
 841 #define JFS_ABORT       0x002   /* Journaling has been aborted for errors. */
 842 #define JFS_ACK_ERR     0x004   /* The errno in the sb has been acked */
 843 #define JFS_FLUSHED     0x008   /* The journal superblock has been flushed */
 844 #define JFS_LOADED      0x010   /* The journal superblock has been loaded */
 845 #define JFS_BARRIER     0x020   /* Use IDE barriers */
 846
 847 /*
 848  * Function declarations for the journaling transaction and buffer
 849  * management
 850  */
 851
 852 /* Filing buffers */
 853 extern void journal_unfile_buffer(journal_t *, struct journal_head *);
 854 extern void __journal_unfile_buffer(struct journal_head *);
 855 extern void __journal_refile_buffer(struct journal_head *);
 856 extern void journal_refile_buffer(journal_t *, struct journal_head *);
 857 extern void __journal_file_buffer(struct journal_head *, transaction_t *, int);
 858 extern void __journal_free_buffer(struct journal_head *bh);
 859 extern void journal_file_buffer(struct journal_head *, transaction_t *, int);
 860 extern void __journal_clean_data_list(transaction_t *transaction);
 861
 862 /* Log buffer allocation */
 863 extern struct journal_head * journal_get_descriptor_buffer(journal_t *);
 864 int journal_next_log_block(journal_t *, unsigned long *);
 865
 866 /* Commit management */
 867 extern void journal_commit_transaction(journal_t *);
 868
 869 /* Checkpoint list management */
 870 int __journal_clean_checkpoint_list(journal_t *journal);
 871 void __journal_remove_checkpoint(struct journal_head *);
 872 void __journal_insert_checkpoint(struct journal_head *, transaction_t *);
 873
 874 /* Buffer IO */
 875 extern int
 876 journal_write_metadata_buffer(transaction_t       *transaction,
 877                               struct journal_head  *jh_in,
 878                               struct journal_head **jh_out,
 879                               int                  blocknr);
 880
 881 /* Transaction locking */
 882 extern void             __wait_on_journal (journal_t *);
 883
 884 /*
 885  * Journal locking.
 886  *
 887  * We need to lock the journal during transaction state changes so that nobody
 888  * ever tries to take a handle on the running transaction while we are in the
 889  * middle of moving it to the commit phase.  j_state_lock does this.
 890  *
 891  * Note that the locking is completely interrupt unsafe.  We never touch
 892  * journal structures from interrupts.
 893  */
 894
 895 static inline handle_t *journal_current_handle(void)
 896 {
 897         return current->journal_info;
 898 }
 899
 900 /* The journaling code user interface:
 901  *
 902  * Create and destroy handles
 903  * Register buffer modifications against the current transaction.
 904  */
 905
 906 extern handle_t *journal_start(journal_t *, int nblocks);
 907 extern int       journal_restart (handle_t *, int nblocks);
 908 extern int       journal_extend (handle_t *, int nblocks);
 909 extern int       journal_get_write_access(handle_t *, struct buffer_head *,
 910                                                 int *credits);
 911 extern int       journal_get_create_access (handle_t *, struct buffer_head *);
 912 extern int       journal_get_undo_access(handle_t *, struct buffer_head *,
 913                                                 int *credits);
 914 extern int       journal_dirty_data (handle_t *, struct buffer_head *);
 915 extern int       journal_dirty_metadata (handle_t *, struct buffer_head *);
 916 extern void      journal_release_buffer (handle_t *, struct buffer_head *,
 917                                                 int credits);
 918 extern int       journal_forget (handle_t *, struct buffer_head *);
 919 extern void      journal_sync_buffer (struct buffer_head *);
 920 extern int       journal_invalidatepage(journal_t *,
 921                                 struct page *, unsigned long);
 922 extern int       journal_try_to_free_buffers(journal_t *, struct page *, int);
 923 extern int       journal_stop(handle_t *);
 924 extern int       journal_flush (journal_t *);
 925 extern void      journal_callback_set(handle_t *handle,
 926                                       void (*fn)(struct journal_callback *,int),
 927                                       struct journal_callback *jcb);
 928
 929 extern void      journal_lock_updates (journal_t *);
 930 extern void      journal_unlock_updates (journal_t *);
 931
 932 extern journal_t * journal_init_dev(struct block_device *bdev,
 933                                 struct block_device *fs_dev,
 934                                 int start, int len, int bsize);
 935 extern journal_t * journal_init_inode (struct inode *);
 936 extern int         journal_update_format (journal_t *);
 937 extern int         journal_check_used_features
 938                    (journal_t *, unsigned long, unsigned long, unsigned long);
 939 extern int         journal_check_available_features
 940                    (journal_t *, unsigned long, unsigned long, unsigned long);
 941 extern int         journal_set_features
 942                    (journal_t *, unsigned long, unsigned long, unsigned long);
 943 extern int         journal_create     (journal_t *);
 944 extern int         journal_load       (journal_t *journal);
 945 extern void        journal_destroy    (journal_t *);
 946 extern int         journal_recover    (journal_t *journal);
 947 extern int         journal_wipe       (journal_t *, int);
 948 extern int         journal_skip_recovery        (journal_t *);
 949 extern void        journal_update_superblock    (journal_t *, int);
 950 extern void        __journal_abort_hard (journal_t *);
 951 extern void        __journal_abort_soft (journal_t *, int);
 952 extern void        journal_abort      (journal_t *, int);
 953 extern int         journal_errno      (journal_t *);
 954 extern void        journal_ack_err    (journal_t *);
 955 extern int         journal_clear_err  (journal_t *);
 956 extern int         journal_bmap(journal_t *, unsigned long, unsigned long *);
 957 extern int         journal_force_commit(journal_t *);
 958
 959 /*
 960  * journal_head management
 961  */
 962 struct journal_head *journal_add_journal_head(struct buffer_head *bh);
 963 struct journal_head *journal_grab_journal_head(struct buffer_head *bh);
 964 void journal_remove_journal_head(struct buffer_head *bh);
 965 void journal_put_journal_head(struct journal_head *jh);
 966
 967 /*
 968  * handle management
 969  */
 970 extern kmem_cache_t *jbd_handle_cache;
 971
 972 static inline handle_t *jbd_alloc_handle(int gfp_flags)
 973 {
 974         return kmem_cache_alloc(jbd_handle_cache, gfp_flags);
 975 }
 976
 977 static inline void jbd_free_handle(handle_t *handle)
 978 {
 979         kmem_cache_free(jbd_handle_cache, handle);
 980 }
 981
 982 /* Primary revoke support */
 983 #define JOURNAL_REVOKE_DEFAULT_HASH 256
 984 extern int         journal_init_revoke(journal_t *, int);
 985 extern void        journal_destroy_revoke_caches(void);
 986 extern int         journal_init_revoke_caches(void);
 987
 988 extern void        journal_destroy_revoke(journal_t *);
 989 extern int         journal_revoke (handle_t *,
 990                                 unsigned long, struct buffer_head *);
 991 extern int         journal_cancel_revoke(handle_t *, struct journal_head *);
 992 extern void        journal_write_revoke_records(journal_t *, transaction_t *);
 993
 994 /* Recovery revoke support */
 995 extern int      journal_set_revoke(journal_t *, unsigned long, tid_t);
 996 extern int      journal_test_revoke(journal_t *, unsigned long, tid_t);
 997 extern void     journal_clear_revoke(journal_t *);
 998 extern void     journal_brelse_array(struct buffer_head *b[], int n);
 999 extern void     journal_switch_revoke_table(journal_t *journal);
1000
1001 /*
1002  * The log thread user interface:
1003  *
1004  * Request space in the current transaction, and force transaction commit
1005  * transitions on demand.
1006  */
1007
1008 int __log_space_left(journal_t *); /* Called with journal locked */
1009 int log_start_commit(journal_t *journal, tid_t tid);
1010 int __log_start_commit(journal_t *journal, tid_t tid);
1011 int journal_start_commit(journal_t *journal, tid_t *tid);
1012 int journal_force_commit_nested(journal_t *journal);
1013 int log_wait_commit(journal_t *journal, tid_t tid);
1014 int log_do_checkpoint(journal_t *journal);
1015
1016 void __log_wait_for_space(journal_t *journal);
1017 extern void     __journal_drop_transaction(journal_t *, transaction_t *);
1018 extern int      cleanup_journal_tail(journal_t *);
1019
1020 /* Debugging code only: */
1021
1022 #define jbd_ENOSYS() \
1023 do {                                                                       \
1024         printk (KERN_ERR "JBD unimplemented function %s\n", __FUNCTION__); \
1025         current->state = TASK_UNINTERRUPTIBLE;                             \
1026         schedule();                                                        \
1027 } while (1)
1028
1029 /*
1030  * is_journal_abort
1031  *
1032  * Simple test wrapper function to test the JFS_ABORT state flag.  This
1033  * bit, when set, indicates that we have had a fatal error somewhere,
1034  * either inside the journaling layer or indicated to us by the client
1035  * (eg. ext3), and that we and should not commit any further
1036  * transactions.
1037  */
1038
1039 static inline int is_journal_aborted(journal_t *journal)
1040 {
1041         return journal->j_flags & JFS_ABORT;
1042 }
1043
1044 static inline int is_handle_aborted(handle_t *handle)
1045 {
1046         if (handle->h_aborted)
1047                 return 1;
1048         return is_journal_aborted(handle->h_transaction->t_journal);
1049 }
1050
1051 static inline void journal_abort_handle(handle_t *handle)
1052 {
1053         handle->h_aborted = 1;
1054 }
1055
1056 #endif /* __KERNEL__   */
1057
1058 /* Comparison functions for transaction IDs: perform comparisons using
1059  * modulo arithmetic so that they work over sequence number wraps. */
1060
1061 static inline int tid_gt(tid_t x, tid_t y)
1062 {
1063         int difference = (x - y);
1064         return (difference > 0);
1065 }
1066
1067 static inline int tid_geq(tid_t x, tid_t y)
1068 {
1069         int difference = (x - y);
1070         return (difference >= 0);
1071 }
1072
1073 extern int journal_blocks_per_page(struct inode *inode);
1074
1075 /*
1076  * Return the minimum number of blocks which must be free in the journal
1077  * before a new transaction may be started.  Must be called under j_state_lock.
1078  */
1079 static inline int jbd_space_needed(journal_t *journal)
1080 {
1081         int nblocks = journal->j_max_transaction_buffers;
1082         if (journal->j_committing_transaction)
1083                 nblocks += journal->j_committing_transaction->
1084                                         t_outstanding_credits;
1085         return nblocks;
1086 }
1087
1088 /*
1089  * Definitions which augment the buffer_head layer
1090  */
1091
1092 /* journaling buffer types */
1093 #define BJ_None         0       /* Not journaled */
1094 #define BJ_SyncData     1       /* Normal data: flush before commit */
1095 #define BJ_Metadata     2       /* Normal journaled metadata */
1096 #define BJ_Forget       3       /* Buffer superseded by this transaction */
1097 #define BJ_IO           4       /* Buffer is for temporary IO use */
1098 #define BJ_Shadow       5       /* Buffer contents being shadowed to the log */
1099 #define BJ_LogCtl       6       /* Buffer contains log descriptors */
1100 #define BJ_Reserved     7       /* Buffer is reserved for access by journal */
1101 #define BJ_Locked       8       /* Locked for I/O during commit */
1102 #define BJ_Types        9
1103
1104 extern int jbd_blocks_per_page(struct inode *inode);
1105
1106 #ifdef __KERNEL__
1107
1108 #ifdef CONFIG_SMP
1109 #define assert_spin_locked(lock)        J_ASSERT(spin_is_locked(lock))
1110 #else
1111 #define assert_spin_locked(lock)        do {} while(0)
1112 #endif
1113
1114 #define buffer_trace_init(bh)   do {} while (0)
1115 #define print_buffer_fields(bh) do {} while (0)
1116 #define print_buffer_trace(bh)  do {} while (0)
1117 #define BUFFER_TRACE(bh, info)  do {} while (0)
1118 #define BUFFER_TRACE2(bh, bh2, info)    do {} while (0)
1119 #define JBUFFER_TRACE(jh, info) do {} while (0)
1120
1121 #endif  /* __KERNEL__ */
1122
1123 #endif  /* CONFIG_JBD || CONFIG_JBD_MODULE || !__KERNEL__ */
1124
1125 /*
1126  * Compatibility no-ops which allow the kernel to compile without CONFIG_JBD
1127  * go here.
1128  */
1129
1130 #if defined(__KERNEL__) && !(defined(CONFIG_JBD) || defined(CONFIG_JBD_MODULE))
1131
1132 #define J_ASSERT(expr)                  do {} while (0)
1133 #define J_ASSERT_BH(bh, expr)           do {} while (0)
1134 #define buffer_jbd(bh)                  0
1135 #define journal_buffer_journal_lru(bh)  0
1136
1137 #endif  /* defined(__KERNEL__) && !defined(CONFIG_JBD) */
1138 #endif  /* _LINUX_JBD_H */