include/linux/jbd.h

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