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