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