Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * linux/include/linux/jbd2.h
0004  *
0005  * Written by Stephen C. Tweedie <sct@redhat.com>
0006  *
0007  * Copyright 1998-2000 Red Hat, Inc --- All Rights Reserved
0008  *
0009  * Definitions for transaction data structures for the buffer cache
0010  * filesystem journaling support.
0011  */
0012 
0013 #ifndef _LINUX_JBD2_H
0014 #define _LINUX_JBD2_H
0015 
0016 /* Allow this file to be included directly into e2fsprogs */
0017 #ifndef __KERNEL__
0018 #include "jfs_compat.h"
0019 #define JBD2_DEBUG
0020 #else
0021 
0022 #include <linux/types.h>
0023 #include <linux/buffer_head.h>
0024 #include <linux/journal-head.h>
0025 #include <linux/stddef.h>
0026 #include <linux/mutex.h>
0027 #include <linux/timer.h>
0028 #include <linux/slab.h>
0029 #include <linux/bit_spinlock.h>
0030 #include <linux/blkdev.h>
0031 #include <crypto/hash.h>
0032 #endif
0033 
0034 #define journal_oom_retry 1
0035 
0036 /*
0037  * Define JBD2_PARANIOD_IOFAIL to cause a kernel BUG() if ext4 finds
0038  * certain classes of error which can occur due to failed IOs.  Under
0039  * normal use we want ext4 to continue after such errors, because
0040  * hardware _can_ fail, but for debugging purposes when running tests on
0041  * known-good hardware we may want to trap these errors.
0042  */
0043 #undef JBD2_PARANOID_IOFAIL
0044 
0045 /*
0046  * The default maximum commit age, in seconds.
0047  */
0048 #define JBD2_DEFAULT_MAX_COMMIT_AGE 5
0049 
0050 #ifdef CONFIG_JBD2_DEBUG
0051 /*
0052  * Define JBD2_EXPENSIVE_CHECKING to enable more expensive internal
0053  * consistency checks.  By default we don't do this unless
0054  * CONFIG_JBD2_DEBUG is on.
0055  */
0056 #define JBD2_EXPENSIVE_CHECKING
0057 void __jbd2_debug(int level, const char *file, const char *func,
0058           unsigned int line, const char *fmt, ...);
0059 
0060 #define jbd2_debug(n, fmt, a...) \
0061     __jbd2_debug((n), __FILE__, __func__, __LINE__, (fmt), ##a)
0062 #else
0063 #define jbd2_debug(n, fmt, a...)  no_printk(fmt, ##a)
0064 #endif
0065 
0066 extern void *jbd2_alloc(size_t size, gfp_t flags);
0067 extern void jbd2_free(void *ptr, size_t size);
0068 
0069 #define JBD2_MIN_JOURNAL_BLOCKS 1024
0070 #define JBD2_DEFAULT_FAST_COMMIT_BLOCKS 256
0071 
0072 #ifdef __KERNEL__
0073 
0074 /**
0075  * typedef handle_t - The handle_t type represents a single atomic update being performed by some process.
0076  *
0077  * All filesystem modifications made by the process go
0078  * through this handle.  Recursive operations (such as quota operations)
0079  * are gathered into a single update.
0080  *
0081  * The buffer credits field is used to account for journaled buffers
0082  * being modified by the running process.  To ensure that there is
0083  * enough log space for all outstanding operations, we need to limit the
0084  * number of outstanding buffers possible at any time.  When the
0085  * operation completes, any buffer credits not used are credited back to
0086  * the transaction, so that at all times we know how many buffers the
0087  * outstanding updates on a transaction might possibly touch.
0088  *
0089  * This is an opaque datatype.
0090  **/
0091 typedef struct jbd2_journal_handle handle_t;    /* Atomic operation type */
0092 
0093 
0094 /**
0095  * typedef journal_t - The journal_t maintains all of the journaling state information for a single filesystem.
0096  *
0097  * journal_t is linked to from the fs superblock structure.
0098  *
0099  * We use the journal_t to keep track of all outstanding transaction
0100  * activity on the filesystem, and to manage the state of the log
0101  * writing process.
0102  *
0103  * This is an opaque datatype.
0104  **/
0105 typedef struct journal_s    journal_t;  /* Journal control structure */
0106 #endif
0107 
0108 /*
0109  * Internal structures used by the logging mechanism:
0110  */
0111 
0112 #define JBD2_MAGIC_NUMBER 0xc03b3998U /* The first 4 bytes of /dev/random! */
0113 
0114 /*
0115  * On-disk structures
0116  */
0117 
0118 /*
0119  * Descriptor block types:
0120  */
0121 
0122 #define JBD2_DESCRIPTOR_BLOCK   1
0123 #define JBD2_COMMIT_BLOCK   2
0124 #define JBD2_SUPERBLOCK_V1  3
0125 #define JBD2_SUPERBLOCK_V2  4
0126 #define JBD2_REVOKE_BLOCK   5
0127 
0128 /*
0129  * Standard header for all descriptor blocks:
0130  */
0131 typedef struct journal_header_s
0132 {
0133     __be32      h_magic;
0134     __be32      h_blocktype;
0135     __be32      h_sequence;
0136 } journal_header_t;
0137 
0138 /*
0139  * Checksum types.
0140  */
0141 #define JBD2_CRC32_CHKSUM   1
0142 #define JBD2_MD5_CHKSUM     2
0143 #define JBD2_SHA1_CHKSUM    3
0144 #define JBD2_CRC32C_CHKSUM  4
0145 
0146 #define JBD2_CRC32_CHKSUM_SIZE 4
0147 
0148 #define JBD2_CHECKSUM_BYTES (32 / sizeof(u32))
0149 /*
0150  * Commit block header for storing transactional checksums:
0151  *
0152  * NOTE: If FEATURE_COMPAT_CHECKSUM (checksum v1) is set, the h_chksum*
0153  * fields are used to store a checksum of the descriptor and data blocks.
0154  *
0155  * If FEATURE_INCOMPAT_CSUM_V2 (checksum v2) is set, then the h_chksum
0156  * field is used to store crc32c(uuid+commit_block).  Each journal metadata
0157  * block gets its own checksum, and data block checksums are stored in
0158  * journal_block_tag (in the descriptor).  The other h_chksum* fields are
0159  * not used.
0160  *
0161  * If FEATURE_INCOMPAT_CSUM_V3 is set, the descriptor block uses
0162  * journal_block_tag3_t to store a full 32-bit checksum.  Everything else
0163  * is the same as v2.
0164  *
0165  * Checksum v1, v2, and v3 are mutually exclusive features.
0166  */
0167 struct commit_header {
0168     __be32      h_magic;
0169     __be32          h_blocktype;
0170     __be32          h_sequence;
0171     unsigned char   h_chksum_type;
0172     unsigned char   h_chksum_size;
0173     unsigned char   h_padding[2];
0174     __be32      h_chksum[JBD2_CHECKSUM_BYTES];
0175     __be64      h_commit_sec;
0176     __be32      h_commit_nsec;
0177 };
0178 
0179 /*
0180  * The block tag: used to describe a single buffer in the journal.
0181  * t_blocknr_high is only used if INCOMPAT_64BIT is set, so this
0182  * raw struct shouldn't be used for pointer math or sizeof() - use
0183  * journal_tag_bytes(journal) instead to compute this.
0184  */
0185 typedef struct journal_block_tag3_s
0186 {
0187     __be32      t_blocknr;  /* The on-disk block number */
0188     __be32      t_flags;    /* See below */
0189     __be32      t_blocknr_high; /* most-significant high 32bits. */
0190     __be32      t_checksum; /* crc32c(uuid+seq+block) */
0191 } journal_block_tag3_t;
0192 
0193 typedef struct journal_block_tag_s
0194 {
0195     __be32      t_blocknr;  /* The on-disk block number */
0196     __be16      t_checksum; /* truncated crc32c(uuid+seq+block) */
0197     __be16      t_flags;    /* See below */
0198     __be32      t_blocknr_high; /* most-significant high 32bits. */
0199 } journal_block_tag_t;
0200 
0201 /* Tail of descriptor or revoke block, for checksumming */
0202 struct jbd2_journal_block_tail {
0203     __be32      t_checksum; /* crc32c(uuid+descr_block) */
0204 };
0205 
0206 /*
0207  * The revoke descriptor: used on disk to describe a series of blocks to
0208  * be revoked from the log
0209  */
0210 typedef struct jbd2_journal_revoke_header_s
0211 {
0212     journal_header_t r_header;
0213     __be32       r_count;   /* Count of bytes used in the block */
0214 } jbd2_journal_revoke_header_t;
0215 
0216 /* Definitions for the journal tag flags word: */
0217 #define JBD2_FLAG_ESCAPE        1   /* on-disk block is escaped */
0218 #define JBD2_FLAG_SAME_UUID 2   /* block has same uuid as previous */
0219 #define JBD2_FLAG_DELETED   4   /* block deleted by this transaction */
0220 #define JBD2_FLAG_LAST_TAG  8   /* last tag in this descriptor block */
0221 
0222 
0223 /*
0224  * The journal superblock.  All fields are in big-endian byte order.
0225  */
0226 typedef struct journal_superblock_s
0227 {
0228 /* 0x0000 */
0229     journal_header_t s_header;
0230 
0231 /* 0x000C */
0232     /* Static information describing the journal */
0233     __be32  s_blocksize;        /* journal device blocksize */
0234     __be32  s_maxlen;       /* total blocks in journal file */
0235     __be32  s_first;        /* first block of log information */
0236 
0237 /* 0x0018 */
0238     /* Dynamic information describing the current state of the log */
0239     __be32  s_sequence;     /* first commit ID expected in log */
0240     __be32  s_start;        /* blocknr of start of log */
0241 
0242 /* 0x0020 */
0243     /* Error value, as set by jbd2_journal_abort(). */
0244     __be32  s_errno;
0245 
0246 /* 0x0024 */
0247     /* Remaining fields are only valid in a version-2 superblock */
0248     __be32  s_feature_compat;   /* compatible feature set */
0249     __be32  s_feature_incompat; /* incompatible feature set */
0250     __be32  s_feature_ro_compat;    /* readonly-compatible feature set */
0251 /* 0x0030 */
0252     __u8    s_uuid[16];     /* 128-bit uuid for journal */
0253 
0254 /* 0x0040 */
0255     __be32  s_nr_users;     /* Nr of filesystems sharing log */
0256 
0257     __be32  s_dynsuper;     /* Blocknr of dynamic superblock copy*/
0258 
0259 /* 0x0048 */
0260     __be32  s_max_transaction;  /* Limit of journal blocks per trans.*/
0261     __be32  s_max_trans_data;   /* Limit of data blocks per trans. */
0262 
0263 /* 0x0050 */
0264     __u8    s_checksum_type;    /* checksum type */
0265     __u8    s_padding2[3];
0266 /* 0x0054 */
0267     __be32  s_num_fc_blks;      /* Number of fast commit blocks */
0268 /* 0x0058 */
0269     __u32   s_padding[41];
0270     __be32  s_checksum;     /* crc32c(superblock) */
0271 
0272 /* 0x0100 */
0273     __u8    s_users[16*48];     /* ids of all fs'es sharing the log */
0274 /* 0x0400 */
0275 } journal_superblock_t;
0276 
0277 /* Use the jbd2_{has,set,clear}_feature_* helpers; these will be removed */
0278 #define JBD2_HAS_COMPAT_FEATURE(j,mask)                 \
0279     ((j)->j_format_version >= 2 &&                  \
0280      ((j)->j_superblock->s_feature_compat & cpu_to_be32((mask))))
0281 #define JBD2_HAS_RO_COMPAT_FEATURE(j,mask)              \
0282     ((j)->j_format_version >= 2 &&                  \
0283      ((j)->j_superblock->s_feature_ro_compat & cpu_to_be32((mask))))
0284 #define JBD2_HAS_INCOMPAT_FEATURE(j,mask)               \
0285     ((j)->j_format_version >= 2 &&                  \
0286      ((j)->j_superblock->s_feature_incompat & cpu_to_be32((mask))))
0287 
0288 #define JBD2_FEATURE_COMPAT_CHECKSUM        0x00000001
0289 
0290 #define JBD2_FEATURE_INCOMPAT_REVOKE        0x00000001
0291 #define JBD2_FEATURE_INCOMPAT_64BIT     0x00000002
0292 #define JBD2_FEATURE_INCOMPAT_ASYNC_COMMIT  0x00000004
0293 #define JBD2_FEATURE_INCOMPAT_CSUM_V2       0x00000008
0294 #define JBD2_FEATURE_INCOMPAT_CSUM_V3       0x00000010
0295 #define JBD2_FEATURE_INCOMPAT_FAST_COMMIT   0x00000020
0296 
0297 /* See "journal feature predicate functions" below */
0298 
0299 /* Features known to this kernel version: */
0300 #define JBD2_KNOWN_COMPAT_FEATURES  JBD2_FEATURE_COMPAT_CHECKSUM
0301 #define JBD2_KNOWN_ROCOMPAT_FEATURES    0
0302 #define JBD2_KNOWN_INCOMPAT_FEATURES    (JBD2_FEATURE_INCOMPAT_REVOKE | \
0303                     JBD2_FEATURE_INCOMPAT_64BIT | \
0304                     JBD2_FEATURE_INCOMPAT_ASYNC_COMMIT | \
0305                     JBD2_FEATURE_INCOMPAT_CSUM_V2 | \
0306                     JBD2_FEATURE_INCOMPAT_CSUM_V3 | \
0307                     JBD2_FEATURE_INCOMPAT_FAST_COMMIT)
0308 
0309 #ifdef __KERNEL__
0310 
0311 #include <linux/fs.h>
0312 #include <linux/sched.h>
0313 
0314 enum jbd_state_bits {
0315     BH_JBD          /* Has an attached ext3 journal_head */
0316       = BH_PrivateStart,
0317     BH_JWrite,      /* Being written to log (@@@ DEBUGGING) */
0318     BH_Freed,       /* Has been freed (truncated) */
0319     BH_Revoked,     /* Has been revoked from the log */
0320     BH_RevokeValid,     /* Revoked flag is valid */
0321     BH_JBDDirty,        /* Is dirty but journaled */
0322     BH_JournalHead,     /* Pins bh->b_private and jh->b_bh */
0323     BH_Shadow,      /* IO on shadow buffer is running */
0324     BH_Verified,        /* Metadata block has been verified ok */
0325     BH_JBDPrivateStart, /* First bit available for private use by FS */
0326 };
0327 
0328 BUFFER_FNS(JBD, jbd)
0329 BUFFER_FNS(JWrite, jwrite)
0330 BUFFER_FNS(JBDDirty, jbddirty)
0331 TAS_BUFFER_FNS(JBDDirty, jbddirty)
0332 BUFFER_FNS(Revoked, revoked)
0333 TAS_BUFFER_FNS(Revoked, revoked)
0334 BUFFER_FNS(RevokeValid, revokevalid)
0335 TAS_BUFFER_FNS(RevokeValid, revokevalid)
0336 BUFFER_FNS(Freed, freed)
0337 BUFFER_FNS(Shadow, shadow)
0338 BUFFER_FNS(Verified, verified)
0339 
0340 static inline struct buffer_head *jh2bh(struct journal_head *jh)
0341 {
0342     return jh->b_bh;
0343 }
0344 
0345 static inline struct journal_head *bh2jh(struct buffer_head *bh)
0346 {
0347     return bh->b_private;
0348 }
0349 
0350 static inline void jbd_lock_bh_journal_head(struct buffer_head *bh)
0351 {
0352     bit_spin_lock(BH_JournalHead, &bh->b_state);
0353 }
0354 
0355 static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh)
0356 {
0357     bit_spin_unlock(BH_JournalHead, &bh->b_state);
0358 }
0359 
0360 #define J_ASSERT(assert)    BUG_ON(!(assert))
0361 
0362 #define J_ASSERT_BH(bh, expr)   J_ASSERT(expr)
0363 #define J_ASSERT_JH(jh, expr)   J_ASSERT(expr)
0364 
0365 #if defined(JBD2_PARANOID_IOFAIL)
0366 #define J_EXPECT(expr, why...)      J_ASSERT(expr)
0367 #define J_EXPECT_BH(bh, expr, why...)   J_ASSERT_BH(bh, expr)
0368 #define J_EXPECT_JH(jh, expr, why...)   J_ASSERT_JH(jh, expr)
0369 #else
0370 #define __journal_expect(expr, why...)                       \
0371     ({                                   \
0372         int val = (expr);                        \
0373         if (!val) {                          \
0374             printk(KERN_ERR                      \
0375                    "JBD2 unexpected failure: %s: %s;\n",         \
0376                    __func__, #expr);                 \
0377             printk(KERN_ERR why "\n");               \
0378         }                                \
0379         val;                                 \
0380     })
0381 #define J_EXPECT(expr, why...)      __journal_expect(expr, ## why)
0382 #define J_EXPECT_BH(bh, expr, why...)   __journal_expect(expr, ## why)
0383 #define J_EXPECT_JH(jh, expr, why...)   __journal_expect(expr, ## why)
0384 #endif
0385 
0386 /* Flags in jbd_inode->i_flags */
0387 #define __JI_COMMIT_RUNNING 0
0388 #define __JI_WRITE_DATA 1
0389 #define __JI_WAIT_DATA 2
0390 
0391 /*
0392  * Commit of the inode data in progress. We use this flag to protect us from
0393  * concurrent deletion of inode. We cannot use reference to inode for this
0394  * since we cannot afford doing last iput() on behalf of kjournald
0395  */
0396 #define JI_COMMIT_RUNNING (1 << __JI_COMMIT_RUNNING)
0397 /* Write allocated dirty buffers in this inode before commit */
0398 #define JI_WRITE_DATA (1 << __JI_WRITE_DATA)
0399 /* Wait for outstanding data writes for this inode before commit */
0400 #define JI_WAIT_DATA (1 << __JI_WAIT_DATA)
0401 
0402 /**
0403  * struct jbd2_inode - The jbd_inode type is the structure linking inodes in
0404  * ordered mode present in a transaction so that we can sync them during commit.
0405  */
0406 struct jbd2_inode {
0407     /**
0408      * @i_transaction:
0409      *
0410      * Which transaction does this inode belong to? Either the running
0411      * transaction or the committing one. [j_list_lock]
0412      */
0413     transaction_t *i_transaction;
0414 
0415     /**
0416      * @i_next_transaction:
0417      *
0418      * Pointer to the running transaction modifying inode's data in case
0419      * there is already a committing transaction touching it. [j_list_lock]
0420      */
0421     transaction_t *i_next_transaction;
0422 
0423     /**
0424      * @i_list: List of inodes in the i_transaction [j_list_lock]
0425      */
0426     struct list_head i_list;
0427 
0428     /**
0429      * @i_vfs_inode:
0430      *
0431      * VFS inode this inode belongs to [constant for lifetime of structure]
0432      */
0433     struct inode *i_vfs_inode;
0434 
0435     /**
0436      * @i_flags: Flags of inode [j_list_lock]
0437      */
0438     unsigned long i_flags;
0439 
0440     /**
0441      * @i_dirty_start:
0442      *
0443      * Offset in bytes where the dirty range for this inode starts.
0444      * [j_list_lock]
0445      */
0446     loff_t i_dirty_start;
0447 
0448     /**
0449      * @i_dirty_end:
0450      *
0451      * Inclusive offset in bytes where the dirty range for this inode
0452      * ends. [j_list_lock]
0453      */
0454     loff_t i_dirty_end;
0455 };
0456 
0457 struct jbd2_revoke_table_s;
0458 
0459 /**
0460  * struct jbd2_journal_handle - The jbd2_journal_handle type is the concrete
0461  *     type associated with handle_t.
0462  * @h_transaction: Which compound transaction is this update a part of?
0463  * @h_journal: Which journal handle belongs to - used iff h_reserved set.
0464  * @h_rsv_handle: Handle reserved for finishing the logical operation.
0465  * @h_total_credits: Number of remaining buffers we are allowed to add to
0466  *  journal. These are dirty buffers and revoke descriptor blocks.
0467  * @h_revoke_credits: Number of remaining revoke records available for handle
0468  * @h_ref: Reference count on this handle.
0469  * @h_err: Field for caller's use to track errors through large fs operations.
0470  * @h_sync: Flag for sync-on-close.
0471  * @h_jdata: Flag to force data journaling.
0472  * @h_reserved: Flag for handle for reserved credits.
0473  * @h_aborted: Flag indicating fatal error on handle.
0474  * @h_type: For handle statistics.
0475  * @h_line_no: For handle statistics.
0476  * @h_start_jiffies: Handle Start time.
0477  * @h_requested_credits: Holds @h_total_credits after handle is started.
0478  * @h_revoke_credits_requested: Holds @h_revoke_credits after handle is started.
0479  * @saved_alloc_context: Saved context while transaction is open.
0480  **/
0481 
0482 /* Docbook can't yet cope with the bit fields, but will leave the documentation
0483  * in so it can be fixed later.
0484  */
0485 
0486 struct jbd2_journal_handle
0487 {
0488     union {
0489         transaction_t   *h_transaction;
0490         /* Which journal handle belongs to - used iff h_reserved set */
0491         journal_t   *h_journal;
0492     };
0493 
0494     handle_t        *h_rsv_handle;
0495     int         h_total_credits;
0496     int         h_revoke_credits;
0497     int         h_revoke_credits_requested;
0498     int         h_ref;
0499     int         h_err;
0500 
0501     /* Flags [no locking] */
0502     unsigned int    h_sync:     1;
0503     unsigned int    h_jdata:    1;
0504     unsigned int    h_reserved: 1;
0505     unsigned int    h_aborted:  1;
0506     unsigned int    h_type:     8;
0507     unsigned int    h_line_no:  16;
0508 
0509     unsigned long       h_start_jiffies;
0510     unsigned int        h_requested_credits;
0511 
0512     unsigned int        saved_alloc_context;
0513 };
0514 
0515 
0516 /*
0517  * Some stats for checkpoint phase
0518  */
0519 struct transaction_chp_stats_s {
0520     unsigned long       cs_chp_time;
0521     __u32           cs_forced_to_close;
0522     __u32           cs_written;
0523     __u32           cs_dropped;
0524 };
0525 
0526 /* The transaction_t type is the guts of the journaling mechanism.  It
0527  * tracks a compound transaction through its various states:
0528  *
0529  * RUNNING: accepting new updates
0530  * LOCKED:  Updates still running but we don't accept new ones
0531  * RUNDOWN: Updates are tidying up but have finished requesting
0532  *      new buffers to modify (state not used for now)
0533  * FLUSH:       All updates complete, but we are still writing to disk
0534  * COMMIT:      All data on disk, writing commit record
0535  * FINISHED:    We still have to keep the transaction for checkpointing.
0536  *
0537  * The transaction keeps track of all of the buffers modified by a
0538  * running transaction, and all of the buffers committed but not yet
0539  * flushed to home for finished transactions.
0540  * (Locking Documentation improved by LockDoc)
0541  */
0542 
0543 /*
0544  * Lock ranking:
0545  *
0546  *    j_list_lock
0547  *      ->jbd_lock_bh_journal_head()    (This is "innermost")
0548  *
0549  *    j_state_lock
0550  *    ->b_state_lock
0551  *
0552  *    b_state_lock
0553  *    ->j_list_lock
0554  *
0555  *    j_state_lock
0556  *    ->j_list_lock         (journal_unmap_buffer)
0557  *
0558  */
0559 
0560 struct transaction_s
0561 {
0562     /* Pointer to the journal for this transaction. [no locking] */
0563     journal_t       *t_journal;
0564 
0565     /* Sequence number for this transaction [no locking] */
0566     tid_t           t_tid;
0567 
0568     /*
0569      * Transaction's current state
0570      * [no locking - only kjournald2 alters this]
0571      * [j_list_lock] guards transition of a transaction into T_FINISHED
0572      * state and subsequent call of __jbd2_journal_drop_transaction()
0573      * FIXME: needs barriers
0574      * KLUDGE: [use j_state_lock]
0575      */
0576     enum {
0577         T_RUNNING,
0578         T_LOCKED,
0579         T_SWITCH,
0580         T_FLUSH,
0581         T_COMMIT,
0582         T_COMMIT_DFLUSH,
0583         T_COMMIT_JFLUSH,
0584         T_COMMIT_CALLBACK,
0585         T_FINISHED
0586     }           t_state;
0587 
0588     /*
0589      * Where in the log does this transaction's commit start? [no locking]
0590      */
0591     unsigned long       t_log_start;
0592 
0593     /*
0594      * Number of buffers on the t_buffers list [j_list_lock, no locks
0595      * needed for jbd2 thread]
0596      */
0597     int         t_nr_buffers;
0598 
0599     /*
0600      * Doubly-linked circular list of all buffers reserved but not yet
0601      * modified by this transaction [j_list_lock, no locks needed fo
0602      * jbd2 thread]
0603      */
0604     struct journal_head *t_reserved_list;
0605 
0606     /*
0607      * Doubly-linked circular list of all metadata buffers owned by this
0608      * transaction [j_list_lock, no locks needed for jbd2 thread]
0609      */
0610     struct journal_head *t_buffers;
0611 
0612     /*
0613      * Doubly-linked circular list of all forget buffers (superseded
0614      * buffers which we can un-checkpoint once this transaction commits)
0615      * [j_list_lock]
0616      */
0617     struct journal_head *t_forget;
0618 
0619     /*
0620      * Doubly-linked circular list of all buffers still to be flushed before
0621      * this transaction can be checkpointed. [j_list_lock]
0622      */
0623     struct journal_head *t_checkpoint_list;
0624 
0625     /*
0626      * Doubly-linked circular list of all buffers submitted for IO while
0627      * checkpointing. [j_list_lock]
0628      */
0629     struct journal_head *t_checkpoint_io_list;
0630 
0631     /*
0632      * Doubly-linked circular list of metadata buffers being
0633      * shadowed by log IO.  The IO buffers on the iobuf list and
0634      * the shadow buffers on this list match each other one for
0635      * one at all times. [j_list_lock, no locks needed for jbd2
0636      * thread]
0637      */
0638     struct journal_head *t_shadow_list;
0639 
0640     /*
0641      * List of inodes associated with the transaction; e.g., ext4 uses
0642      * this to track inodes in data=ordered and data=journal mode that
0643      * need special handling on transaction commit; also used by ocfs2.
0644      * [j_list_lock]
0645      */
0646     struct list_head    t_inode_list;
0647 
0648     /*
0649      * Protects info related to handles
0650      */
0651     spinlock_t      t_handle_lock;
0652 
0653     /*
0654      * Longest time some handle had to wait for running transaction
0655      */
0656     unsigned long       t_max_wait;
0657 
0658     /*
0659      * When transaction started
0660      */
0661     unsigned long       t_start;
0662 
0663     /*
0664      * When commit was requested [j_state_lock]
0665      */
0666     unsigned long       t_requested;
0667 
0668     /*
0669      * Checkpointing stats [j_list_lock]
0670      */
0671     struct transaction_chp_stats_s t_chp_stats;
0672 
0673     /*
0674      * Number of outstanding updates running on this transaction
0675      * [none]
0676      */
0677     atomic_t        t_updates;
0678 
0679     /*
0680      * Number of blocks reserved for this transaction in the journal.
0681      * This is including all credits reserved when starting transaction
0682      * handles as well as all journal descriptor blocks needed for this
0683      * transaction. [none]
0684      */
0685     atomic_t        t_outstanding_credits;
0686 
0687     /*
0688      * Number of revoke records for this transaction added by already
0689      * stopped handles. [none]
0690      */
0691     atomic_t        t_outstanding_revokes;
0692 
0693     /*
0694      * How many handles used this transaction? [none]
0695      */
0696     atomic_t        t_handle_count;
0697 
0698     /*
0699      * Forward and backward links for the circular list of all transactions
0700      * awaiting checkpoint. [j_list_lock]
0701      */
0702     transaction_t       *t_cpnext, *t_cpprev;
0703 
0704     /*
0705      * When will the transaction expire (become due for commit), in jiffies?
0706      * [no locking]
0707      */
0708     unsigned long       t_expires;
0709 
0710     /*
0711      * When this transaction started, in nanoseconds [no locking]
0712      */
0713     ktime_t         t_start_time;
0714 
0715     /*
0716      * This transaction is being forced and some process is
0717      * waiting for it to finish.
0718      */
0719     unsigned int t_synchronous_commit:1;
0720 
0721     /* Disk flush needs to be sent to fs partition [no locking] */
0722     int         t_need_data_flush;
0723 
0724     /*
0725      * For use by the filesystem to store fs-specific data
0726      * structures associated with the transaction
0727      */
0728     struct list_head    t_private_list;
0729 };
0730 
0731 struct transaction_run_stats_s {
0732     unsigned long       rs_wait;
0733     unsigned long       rs_request_delay;
0734     unsigned long       rs_running;
0735     unsigned long       rs_locked;
0736     unsigned long       rs_flushing;
0737     unsigned long       rs_logging;
0738 
0739     __u32           rs_handle_count;
0740     __u32           rs_blocks;
0741     __u32           rs_blocks_logged;
0742 };
0743 
0744 struct transaction_stats_s {
0745     unsigned long       ts_tid;
0746     unsigned long       ts_requested;
0747     struct transaction_run_stats_s run;
0748 };
0749 
0750 static inline unsigned long
0751 jbd2_time_diff(unsigned long start, unsigned long end)
0752 {
0753     if (end >= start)
0754         return end - start;
0755 
0756     return end + (MAX_JIFFY_OFFSET - start);
0757 }
0758 
0759 #define JBD2_NR_BATCH   64
0760 
0761 enum passtype {PASS_SCAN, PASS_REVOKE, PASS_REPLAY};
0762 
0763 #define JBD2_FC_REPLAY_STOP 0
0764 #define JBD2_FC_REPLAY_CONTINUE 1
0765 
0766 /**
0767  * struct journal_s - The journal_s type is the concrete type associated with
0768  *     journal_t.
0769  */
0770 struct journal_s
0771 {
0772     /**
0773      * @j_flags: General journaling state flags [j_state_lock,
0774      * no lock for quick racy checks]
0775      */
0776     unsigned long       j_flags;
0777 
0778     /**
0779      * @j_atomic_flags: Atomic journaling state flags.
0780      */
0781     unsigned long       j_atomic_flags;
0782 
0783     /**
0784      * @j_errno:
0785      *
0786      * Is there an outstanding uncleared error on the journal (from a prior
0787      * abort)? [j_state_lock]
0788      */
0789     int         j_errno;
0790 
0791     /**
0792      * @j_abort_mutex: Lock the whole aborting procedure.
0793      */
0794     struct mutex        j_abort_mutex;
0795 
0796     /**
0797      * @j_sb_buffer: The first part of the superblock buffer.
0798      */
0799     struct buffer_head  *j_sb_buffer;
0800 
0801     /**
0802      * @j_superblock: The second part of the superblock buffer.
0803      */
0804     journal_superblock_t    *j_superblock;
0805 
0806     /**
0807      * @j_format_version: Version of the superblock format.
0808      */
0809     int         j_format_version;
0810 
0811     /**
0812      * @j_state_lock: Protect the various scalars in the journal.
0813      */
0814     rwlock_t        j_state_lock;
0815 
0816     /**
0817      * @j_barrier_count:
0818      *
0819      * Number of processes waiting to create a barrier lock [j_state_lock,
0820      * no lock for quick racy checks]
0821      */
0822     int         j_barrier_count;
0823 
0824     /**
0825      * @j_barrier: The barrier lock itself.
0826      */
0827     struct mutex        j_barrier;
0828 
0829     /**
0830      * @j_running_transaction:
0831      *
0832      * Transactions: The current running transaction...
0833      * [j_state_lock, no lock for quick racy checks] [caller holding
0834      * open handle]
0835      */
0836     transaction_t       *j_running_transaction;
0837 
0838     /**
0839      * @j_committing_transaction:
0840      *
0841      * the transaction we are pushing to disk
0842      * [j_state_lock] [caller holding open handle]
0843      */
0844     transaction_t       *j_committing_transaction;
0845 
0846     /**
0847      * @j_checkpoint_transactions:
0848      *
0849      * ... and a linked circular list of all transactions waiting for
0850      * checkpointing. [j_list_lock]
0851      */
0852     transaction_t       *j_checkpoint_transactions;
0853 
0854     /**
0855      * @j_wait_transaction_locked:
0856      *
0857      * Wait queue for waiting for a locked transaction to start committing,
0858      * or for a barrier lock to be released.
0859      */
0860     wait_queue_head_t   j_wait_transaction_locked;
0861 
0862     /**
0863      * @j_wait_done_commit: Wait queue for waiting for commit to complete.
0864      */
0865     wait_queue_head_t   j_wait_done_commit;
0866 
0867     /**
0868      * @j_wait_commit: Wait queue to trigger commit.
0869      */
0870     wait_queue_head_t   j_wait_commit;
0871 
0872     /**
0873      * @j_wait_updates: Wait queue to wait for updates to complete.
0874      */
0875     wait_queue_head_t   j_wait_updates;
0876 
0877     /**
0878      * @j_wait_reserved:
0879      *
0880      * Wait queue to wait for reserved buffer credits to drop.
0881      */
0882     wait_queue_head_t   j_wait_reserved;
0883 
0884     /**
0885      * @j_fc_wait:
0886      *
0887      * Wait queue to wait for completion of async fast commits.
0888      */
0889     wait_queue_head_t   j_fc_wait;
0890 
0891     /**
0892      * @j_checkpoint_mutex:
0893      *
0894      * Semaphore for locking against concurrent checkpoints.
0895      */
0896     struct mutex        j_checkpoint_mutex;
0897 
0898     /**
0899      * @j_chkpt_bhs:
0900      *
0901      * List of buffer heads used by the checkpoint routine.  This
0902      * was moved from jbd2_log_do_checkpoint() to reduce stack
0903      * usage.  Access to this array is controlled by the
0904      * @j_checkpoint_mutex.  [j_checkpoint_mutex]
0905      */
0906     struct buffer_head  *j_chkpt_bhs[JBD2_NR_BATCH];
0907 
0908     /**
0909      * @j_shrinker:
0910      *
0911      * Journal head shrinker, reclaim buffer's journal head which
0912      * has been written back.
0913      */
0914     struct shrinker     j_shrinker;
0915 
0916     /**
0917      * @j_checkpoint_jh_count:
0918      *
0919      * Number of journal buffers on the checkpoint list. [j_list_lock]
0920      */
0921     struct percpu_counter   j_checkpoint_jh_count;
0922 
0923     /**
0924      * @j_shrink_transaction:
0925      *
0926      * Record next transaction will shrink on the checkpoint list.
0927      * [j_list_lock]
0928      */
0929     transaction_t       *j_shrink_transaction;
0930 
0931     /**
0932      * @j_head:
0933      *
0934      * Journal head: identifies the first unused block in the journal.
0935      * [j_state_lock]
0936      */
0937     unsigned long       j_head;
0938 
0939     /**
0940      * @j_tail:
0941      *
0942      * Journal tail: identifies the oldest still-used block in the journal.
0943      * [j_state_lock]
0944      */
0945     unsigned long       j_tail;
0946 
0947     /**
0948      * @j_free:
0949      *
0950      * Journal free: how many free blocks are there in the journal?
0951      * [j_state_lock]
0952      */
0953     unsigned long       j_free;
0954 
0955     /**
0956      * @j_first:
0957      *
0958      * The block number of the first usable block in the journal
0959      * [j_state_lock].
0960      */
0961     unsigned long       j_first;
0962 
0963     /**
0964      * @j_last:
0965      *
0966      * The block number one beyond the last usable block in the journal
0967      * [j_state_lock].
0968      */
0969     unsigned long       j_last;
0970 
0971     /**
0972      * @j_fc_first:
0973      *
0974      * The block number of the first fast commit block in the journal
0975      * [j_state_lock].
0976      */
0977     unsigned long       j_fc_first;
0978 
0979     /**
0980      * @j_fc_off:
0981      *
0982      * Number of fast commit blocks currently allocated. Accessed only
0983      * during fast commit. Currently only process can do fast commit, so
0984      * this field is not protected by any lock.
0985      */
0986     unsigned long       j_fc_off;
0987 
0988     /**
0989      * @j_fc_last:
0990      *
0991      * The block number one beyond the last fast commit block in the journal
0992      * [j_state_lock].
0993      */
0994     unsigned long       j_fc_last;
0995 
0996     /**
0997      * @j_dev: Device where we store the journal.
0998      */
0999     struct block_device *j_dev;
1000 
1001     /**
1002      * @j_blocksize: Block size for the location where we store the journal.
1003      */
1004     int         j_blocksize;
1005 
1006     /**
1007      * @j_blk_offset:
1008      *
1009      * Starting block offset into the device where we store the journal.
1010      */
1011     unsigned long long  j_blk_offset;
1012 
1013     /**
1014      * @j_devname: Journal device name.
1015      */
1016     char            j_devname[BDEVNAME_SIZE+24];
1017 
1018     /**
1019      * @j_fs_dev:
1020      *
1021      * Device which holds the client fs.  For internal journal this will be
1022      * equal to j_dev.
1023      */
1024     struct block_device *j_fs_dev;
1025 
1026     /**
1027      * @j_total_len: Total maximum capacity of the journal region on disk.
1028      */
1029     unsigned int        j_total_len;
1030 
1031     /**
1032      * @j_reserved_credits:
1033      *
1034      * Number of buffers reserved from the running transaction.
1035      */
1036     atomic_t        j_reserved_credits;
1037 
1038     /**
1039      * @j_list_lock: Protects the buffer lists and internal buffer state.
1040      */
1041     spinlock_t      j_list_lock;
1042 
1043     /**
1044      * @j_inode:
1045      *
1046      * Optional inode where we store the journal.  If present, all
1047      * journal block numbers are mapped into this inode via bmap().
1048      */
1049     struct inode        *j_inode;
1050 
1051     /**
1052      * @j_tail_sequence:
1053      *
1054      * Sequence number of the oldest transaction in the log [j_state_lock]
1055      */
1056     tid_t           j_tail_sequence;
1057 
1058     /**
1059      * @j_transaction_sequence:
1060      *
1061      * Sequence number of the next transaction to grant [j_state_lock]
1062      */
1063     tid_t           j_transaction_sequence;
1064 
1065     /**
1066      * @j_commit_sequence:
1067      *
1068      * Sequence number of the most recently committed transaction
1069      * [j_state_lock, no lock for quick racy checks]
1070      */
1071     tid_t           j_commit_sequence;
1072 
1073     /**
1074      * @j_commit_request:
1075      *
1076      * Sequence number of the most recent transaction wanting commit
1077      * [j_state_lock, no lock for quick racy checks]
1078      */
1079     tid_t           j_commit_request;
1080 
1081     /**
1082      * @j_uuid:
1083      *
1084      * Journal uuid: identifies the object (filesystem, LVM volume etc)
1085      * backed by this journal.  This will eventually be replaced by an array
1086      * of uuids, allowing us to index multiple devices within a single
1087      * journal and to perform atomic updates across them.
1088      */
1089     __u8            j_uuid[16];
1090 
1091     /**
1092      * @j_task: Pointer to the current commit thread for this journal.
1093      */
1094     struct task_struct  *j_task;
1095 
1096     /**
1097      * @j_max_transaction_buffers:
1098      *
1099      * Maximum number of metadata buffers to allow in a single compound
1100      * commit transaction.
1101      */
1102     int         j_max_transaction_buffers;
1103 
1104     /**
1105      * @j_revoke_records_per_block:
1106      *
1107      * Number of revoke records that fit in one descriptor block.
1108      */
1109     int         j_revoke_records_per_block;
1110 
1111     /**
1112      * @j_commit_interval:
1113      *
1114      * What is the maximum transaction lifetime before we begin a commit?
1115      */
1116     unsigned long       j_commit_interval;
1117 
1118     /**
1119      * @j_commit_timer: The timer used to wakeup the commit thread.
1120      */
1121     struct timer_list   j_commit_timer;
1122 
1123     /**
1124      * @j_revoke_lock: Protect the revoke table.
1125      */
1126     spinlock_t      j_revoke_lock;
1127 
1128     /**
1129      * @j_revoke:
1130      *
1131      * The revoke table - maintains the list of revoked blocks in the
1132      * current transaction.
1133      */
1134     struct jbd2_revoke_table_s *j_revoke;
1135 
1136     /**
1137      * @j_revoke_table: Alternate revoke tables for j_revoke.
1138      */
1139     struct jbd2_revoke_table_s *j_revoke_table[2];
1140 
1141     /**
1142      * @j_wbuf: Array of bhs for jbd2_journal_commit_transaction.
1143      */
1144     struct buffer_head  **j_wbuf;
1145 
1146     /**
1147      * @j_fc_wbuf: Array of fast commit bhs for fast commit. Accessed only
1148      * during a fast commit. Currently only process can do fast commit, so
1149      * this field is not protected by any lock.
1150      */
1151     struct buffer_head  **j_fc_wbuf;
1152 
1153     /**
1154      * @j_wbufsize:
1155      *
1156      * Size of @j_wbuf array.
1157      */
1158     int         j_wbufsize;
1159 
1160     /**
1161      * @j_fc_wbufsize:
1162      *
1163      * Size of @j_fc_wbuf array.
1164      */
1165     int         j_fc_wbufsize;
1166 
1167     /**
1168      * @j_last_sync_writer:
1169      *
1170      * The pid of the last person to run a synchronous operation
1171      * through the journal.
1172      */
1173     pid_t           j_last_sync_writer;
1174 
1175     /**
1176      * @j_average_commit_time:
1177      *
1178      * The average amount of time in nanoseconds it takes to commit a
1179      * transaction to disk. [j_state_lock]
1180      */
1181     u64         j_average_commit_time;
1182 
1183     /**
1184      * @j_min_batch_time:
1185      *
1186      * Minimum time that we should wait for additional filesystem operations
1187      * to get batched into a synchronous handle in microseconds.
1188      */
1189     u32         j_min_batch_time;
1190 
1191     /**
1192      * @j_max_batch_time:
1193      *
1194      * Maximum time that we should wait for additional filesystem operations
1195      * to get batched into a synchronous handle in microseconds.
1196      */
1197     u32         j_max_batch_time;
1198 
1199     /**
1200      * @j_commit_callback:
1201      *
1202      * This function is called when a transaction is closed.
1203      */
1204     void            (*j_commit_callback)(journal_t *,
1205                              transaction_t *);
1206 
1207     /**
1208      * @j_submit_inode_data_buffers:
1209      *
1210      * This function is called for all inodes associated with the
1211      * committing transaction marked with JI_WRITE_DATA flag
1212      * before we start to write out the transaction to the journal.
1213      */
1214     int         (*j_submit_inode_data_buffers)
1215                     (struct jbd2_inode *);
1216 
1217     /**
1218      * @j_finish_inode_data_buffers:
1219      *
1220      * This function is called for all inodes associated with the
1221      * committing transaction marked with JI_WAIT_DATA flag
1222      * after we have written the transaction to the journal
1223      * but before we write out the commit block.
1224      */
1225     int         (*j_finish_inode_data_buffers)
1226                     (struct jbd2_inode *);
1227 
1228     /*
1229      * Journal statistics
1230      */
1231 
1232     /**
1233      * @j_history_lock: Protect the transactions statistics history.
1234      */
1235     spinlock_t      j_history_lock;
1236 
1237     /**
1238      * @j_proc_entry: procfs entry for the jbd statistics directory.
1239      */
1240     struct proc_dir_entry   *j_proc_entry;
1241 
1242     /**
1243      * @j_stats: Overall statistics.
1244      */
1245     struct transaction_stats_s j_stats;
1246 
1247     /**
1248      * @j_failed_commit: Failed journal commit ID.
1249      */
1250     unsigned int        j_failed_commit;
1251 
1252     /**
1253      * @j_private:
1254      *
1255      * An opaque pointer to fs-private information.  ext3 puts its
1256      * superblock pointer here.
1257      */
1258     void *j_private;
1259 
1260     /**
1261      * @j_chksum_driver:
1262      *
1263      * Reference to checksum algorithm driver via cryptoapi.
1264      */
1265     struct crypto_shash *j_chksum_driver;
1266 
1267     /**
1268      * @j_csum_seed:
1269      *
1270      * Precomputed journal UUID checksum for seeding other checksums.
1271      */
1272     __u32 j_csum_seed;
1273 
1274 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1275     /**
1276      * @j_trans_commit_map:
1277      *
1278      * Lockdep entity to track transaction commit dependencies. Handles
1279      * hold this "lock" for read, when we wait for commit, we acquire the
1280      * "lock" for writing. This matches the properties of jbd2 journalling
1281      * where the running transaction has to wait for all handles to be
1282      * dropped to commit that transaction and also acquiring a handle may
1283      * require transaction commit to finish.
1284      */
1285     struct lockdep_map  j_trans_commit_map;
1286 #endif
1287 
1288     /**
1289      * @j_fc_cleanup_callback:
1290      *
1291      * Clean-up after fast commit or full commit. JBD2 calls this function
1292      * after every commit operation.
1293      */
1294     void (*j_fc_cleanup_callback)(struct journal_s *journal, int full, tid_t tid);
1295 
1296     /**
1297      * @j_fc_replay_callback:
1298      *
1299      * File-system specific function that performs replay of a fast
1300      * commit. JBD2 calls this function for each fast commit block found in
1301      * the journal. This function should return JBD2_FC_REPLAY_CONTINUE
1302      * to indicate that the block was processed correctly and more fast
1303      * commit replay should continue. Return value of JBD2_FC_REPLAY_STOP
1304      * indicates the end of replay (no more blocks remaining). A negative
1305      * return value indicates error.
1306      */
1307     int (*j_fc_replay_callback)(struct journal_s *journal,
1308                     struct buffer_head *bh,
1309                     enum passtype pass, int off,
1310                     tid_t expected_commit_id);
1311 };
1312 
1313 #define jbd2_might_wait_for_commit(j) \
1314     do { \
1315         rwsem_acquire(&j->j_trans_commit_map, 0, 0, _THIS_IP_); \
1316         rwsem_release(&j->j_trans_commit_map, _THIS_IP_); \
1317     } while (0)
1318 
1319 /* journal feature predicate functions */
1320 #define JBD2_FEATURE_COMPAT_FUNCS(name, flagname) \
1321 static inline bool jbd2_has_feature_##name(journal_t *j) \
1322 { \
1323     return ((j)->j_format_version >= 2 && \
1324         ((j)->j_superblock->s_feature_compat & \
1325          cpu_to_be32(JBD2_FEATURE_COMPAT_##flagname)) != 0); \
1326 } \
1327 static inline void jbd2_set_feature_##name(journal_t *j) \
1328 { \
1329     (j)->j_superblock->s_feature_compat |= \
1330         cpu_to_be32(JBD2_FEATURE_COMPAT_##flagname); \
1331 } \
1332 static inline void jbd2_clear_feature_##name(journal_t *j) \
1333 { \
1334     (j)->j_superblock->s_feature_compat &= \
1335         ~cpu_to_be32(JBD2_FEATURE_COMPAT_##flagname); \
1336 }
1337 
1338 #define JBD2_FEATURE_RO_COMPAT_FUNCS(name, flagname) \
1339 static inline bool jbd2_has_feature_##name(journal_t *j) \
1340 { \
1341     return ((j)->j_format_version >= 2 && \
1342         ((j)->j_superblock->s_feature_ro_compat & \
1343          cpu_to_be32(JBD2_FEATURE_RO_COMPAT_##flagname)) != 0); \
1344 } \
1345 static inline void jbd2_set_feature_##name(journal_t *j) \
1346 { \
1347     (j)->j_superblock->s_feature_ro_compat |= \
1348         cpu_to_be32(JBD2_FEATURE_RO_COMPAT_##flagname); \
1349 } \
1350 static inline void jbd2_clear_feature_##name(journal_t *j) \
1351 { \
1352     (j)->j_superblock->s_feature_ro_compat &= \
1353         ~cpu_to_be32(JBD2_FEATURE_RO_COMPAT_##flagname); \
1354 }
1355 
1356 #define JBD2_FEATURE_INCOMPAT_FUNCS(name, flagname) \
1357 static inline bool jbd2_has_feature_##name(journal_t *j) \
1358 { \
1359     return ((j)->j_format_version >= 2 && \
1360         ((j)->j_superblock->s_feature_incompat & \
1361          cpu_to_be32(JBD2_FEATURE_INCOMPAT_##flagname)) != 0); \
1362 } \
1363 static inline void jbd2_set_feature_##name(journal_t *j) \
1364 { \
1365     (j)->j_superblock->s_feature_incompat |= \
1366         cpu_to_be32(JBD2_FEATURE_INCOMPAT_##flagname); \
1367 } \
1368 static inline void jbd2_clear_feature_##name(journal_t *j) \
1369 { \
1370     (j)->j_superblock->s_feature_incompat &= \
1371         ~cpu_to_be32(JBD2_FEATURE_INCOMPAT_##flagname); \
1372 }
1373 
1374 JBD2_FEATURE_COMPAT_FUNCS(checksum,     CHECKSUM)
1375 
1376 JBD2_FEATURE_INCOMPAT_FUNCS(revoke,     REVOKE)
1377 JBD2_FEATURE_INCOMPAT_FUNCS(64bit,      64BIT)
1378 JBD2_FEATURE_INCOMPAT_FUNCS(async_commit,   ASYNC_COMMIT)
1379 JBD2_FEATURE_INCOMPAT_FUNCS(csum2,      CSUM_V2)
1380 JBD2_FEATURE_INCOMPAT_FUNCS(csum3,      CSUM_V3)
1381 JBD2_FEATURE_INCOMPAT_FUNCS(fast_commit,    FAST_COMMIT)
1382 
1383 /*
1384  * Journal flag definitions
1385  */
1386 #define JBD2_UNMOUNT    0x001   /* Journal thread is being destroyed */
1387 #define JBD2_ABORT  0x002   /* Journaling has been aborted for errors. */
1388 #define JBD2_ACK_ERR    0x004   /* The errno in the sb has been acked */
1389 #define JBD2_FLUSHED    0x008   /* The journal superblock has been flushed */
1390 #define JBD2_LOADED 0x010   /* The journal superblock has been loaded */
1391 #define JBD2_BARRIER    0x020   /* Use IDE barriers */
1392 #define JBD2_ABORT_ON_SYNCDATA_ERR  0x040   /* Abort the journal on file
1393                          * data write error in ordered
1394                          * mode */
1395 #define JBD2_FAST_COMMIT_ONGOING    0x100   /* Fast commit is ongoing */
1396 #define JBD2_FULL_COMMIT_ONGOING    0x200   /* Full commit is ongoing */
1397 #define JBD2_JOURNAL_FLUSH_DISCARD  0x0001
1398 #define JBD2_JOURNAL_FLUSH_ZEROOUT  0x0002
1399 #define JBD2_JOURNAL_FLUSH_VALID    (JBD2_JOURNAL_FLUSH_DISCARD | \
1400                     JBD2_JOURNAL_FLUSH_ZEROOUT)
1401 
1402 /*
1403  * Journal atomic flag definitions
1404  */
1405 #define JBD2_CHECKPOINT_IO_ERROR    0x001   /* Detect io error while writing
1406                          * buffer back to disk */
1407 
1408 /*
1409  * Function declarations for the journaling transaction and buffer
1410  * management
1411  */
1412 
1413 /* Filing buffers */
1414 extern void jbd2_journal_unfile_buffer(journal_t *, struct journal_head *);
1415 extern bool __jbd2_journal_refile_buffer(struct journal_head *);
1416 extern void jbd2_journal_refile_buffer(journal_t *, struct journal_head *);
1417 extern void __jbd2_journal_file_buffer(struct journal_head *, transaction_t *, int);
1418 extern void jbd2_journal_file_buffer(struct journal_head *, transaction_t *, int);
1419 static inline void jbd2_file_log_bh(struct list_head *head, struct buffer_head *bh)
1420 {
1421     list_add_tail(&bh->b_assoc_buffers, head);
1422 }
1423 static inline void jbd2_unfile_log_bh(struct buffer_head *bh)
1424 {
1425     list_del_init(&bh->b_assoc_buffers);
1426 }
1427 
1428 /* Log buffer allocation */
1429 struct buffer_head *jbd2_journal_get_descriptor_buffer(transaction_t *, int);
1430 void jbd2_descriptor_block_csum_set(journal_t *, struct buffer_head *);
1431 int jbd2_journal_next_log_block(journal_t *, unsigned long long *);
1432 int jbd2_journal_get_log_tail(journal_t *journal, tid_t *tid,
1433                   unsigned long *block);
1434 int __jbd2_update_log_tail(journal_t *journal, tid_t tid, unsigned long block);
1435 void jbd2_update_log_tail(journal_t *journal, tid_t tid, unsigned long block);
1436 
1437 /* Commit management */
1438 extern void jbd2_journal_commit_transaction(journal_t *);
1439 
1440 /* Checkpoint list management */
1441 void __jbd2_journal_clean_checkpoint_list(journal_t *journal, bool destroy);
1442 unsigned long jbd2_journal_shrink_checkpoint_list(journal_t *journal, unsigned long *nr_to_scan);
1443 int __jbd2_journal_remove_checkpoint(struct journal_head *);
1444 void jbd2_journal_destroy_checkpoint(journal_t *journal);
1445 void __jbd2_journal_insert_checkpoint(struct journal_head *, transaction_t *);
1446 
1447 
1448 /*
1449  * Triggers
1450  */
1451 
1452 struct jbd2_buffer_trigger_type {
1453     /*
1454      * Fired a the moment data to write to the journal are known to be
1455      * stable - so either at the moment b_frozen_data is created or just
1456      * before a buffer is written to the journal.  mapped_data is a mapped
1457      * buffer that is the frozen data for commit.
1458      */
1459     void (*t_frozen)(struct jbd2_buffer_trigger_type *type,
1460              struct buffer_head *bh, void *mapped_data,
1461              size_t size);
1462 
1463     /*
1464      * Fired during journal abort for dirty buffers that will not be
1465      * committed.
1466      */
1467     void (*t_abort)(struct jbd2_buffer_trigger_type *type,
1468             struct buffer_head *bh);
1469 };
1470 
1471 extern void jbd2_buffer_frozen_trigger(struct journal_head *jh,
1472                        void *mapped_data,
1473                        struct jbd2_buffer_trigger_type *triggers);
1474 extern void jbd2_buffer_abort_trigger(struct journal_head *jh,
1475                       struct jbd2_buffer_trigger_type *triggers);
1476 
1477 /* Buffer IO */
1478 extern int jbd2_journal_write_metadata_buffer(transaction_t *transaction,
1479                           struct journal_head *jh_in,
1480                           struct buffer_head **bh_out,
1481                           sector_t blocknr);
1482 
1483 /* Transaction cache support */
1484 extern void jbd2_journal_destroy_transaction_cache(void);
1485 extern int __init jbd2_journal_init_transaction_cache(void);
1486 extern void jbd2_journal_free_transaction(transaction_t *);
1487 
1488 /*
1489  * Journal locking.
1490  *
1491  * We need to lock the journal during transaction state changes so that nobody
1492  * ever tries to take a handle on the running transaction while we are in the
1493  * middle of moving it to the commit phase.  j_state_lock does this.
1494  *
1495  * Note that the locking is completely interrupt unsafe.  We never touch
1496  * journal structures from interrupts.
1497  */
1498 
1499 static inline handle_t *journal_current_handle(void)
1500 {
1501     return current->journal_info;
1502 }
1503 
1504 /* The journaling code user interface:
1505  *
1506  * Create and destroy handles
1507  * Register buffer modifications against the current transaction.
1508  */
1509 
1510 extern handle_t *jbd2_journal_start(journal_t *, int nblocks);
1511 extern handle_t *jbd2__journal_start(journal_t *, int blocks, int rsv_blocks,
1512                      int revoke_records, gfp_t gfp_mask,
1513                      unsigned int type, unsigned int line_no);
1514 extern int   jbd2_journal_restart(handle_t *, int nblocks);
1515 extern int   jbd2__journal_restart(handle_t *, int nblocks,
1516                        int revoke_records, gfp_t gfp_mask);
1517 extern int   jbd2_journal_start_reserved(handle_t *handle,
1518                 unsigned int type, unsigned int line_no);
1519 extern void  jbd2_journal_free_reserved(handle_t *handle);
1520 extern int   jbd2_journal_extend(handle_t *handle, int nblocks,
1521                      int revoke_records);
1522 extern int   jbd2_journal_get_write_access(handle_t *, struct buffer_head *);
1523 extern int   jbd2_journal_get_create_access (handle_t *, struct buffer_head *);
1524 extern int   jbd2_journal_get_undo_access(handle_t *, struct buffer_head *);
1525 void         jbd2_journal_set_triggers(struct buffer_head *,
1526                        struct jbd2_buffer_trigger_type *type);
1527 extern int   jbd2_journal_dirty_metadata (handle_t *, struct buffer_head *);
1528 extern int   jbd2_journal_forget (handle_t *, struct buffer_head *);
1529 int jbd2_journal_invalidate_folio(journal_t *, struct folio *,
1530                     size_t offset, size_t length);
1531 bool jbd2_journal_try_to_free_buffers(journal_t *journal, struct folio *folio);
1532 extern int   jbd2_journal_stop(handle_t *);
1533 extern int   jbd2_journal_flush(journal_t *journal, unsigned int flags);
1534 extern void  jbd2_journal_lock_updates (journal_t *);
1535 extern void  jbd2_journal_unlock_updates (journal_t *);
1536 
1537 void jbd2_journal_wait_updates(journal_t *);
1538 
1539 extern journal_t * jbd2_journal_init_dev(struct block_device *bdev,
1540                 struct block_device *fs_dev,
1541                 unsigned long long start, int len, int bsize);
1542 extern journal_t * jbd2_journal_init_inode (struct inode *);
1543 extern int     jbd2_journal_update_format (journal_t *);
1544 extern int     jbd2_journal_check_used_features
1545            (journal_t *, unsigned long, unsigned long, unsigned long);
1546 extern int     jbd2_journal_check_available_features
1547            (journal_t *, unsigned long, unsigned long, unsigned long);
1548 extern int     jbd2_journal_set_features
1549            (journal_t *, unsigned long, unsigned long, unsigned long);
1550 extern void    jbd2_journal_clear_features
1551            (journal_t *, unsigned long, unsigned long, unsigned long);
1552 extern int     jbd2_journal_load       (journal_t *journal);
1553 extern int     jbd2_journal_destroy    (journal_t *);
1554 extern int     jbd2_journal_recover    (journal_t *journal);
1555 extern int     jbd2_journal_wipe       (journal_t *, int);
1556 extern int     jbd2_journal_skip_recovery   (journal_t *);
1557 extern void    jbd2_journal_update_sb_errno(journal_t *);
1558 extern int     jbd2_journal_update_sb_log_tail  (journal_t *, tid_t,
1559                 unsigned long, blk_opf_t);
1560 extern void    jbd2_journal_abort      (journal_t *, int);
1561 extern int     jbd2_journal_errno      (journal_t *);
1562 extern void    jbd2_journal_ack_err    (journal_t *);
1563 extern int     jbd2_journal_clear_err  (journal_t *);
1564 extern int     jbd2_journal_bmap(journal_t *, unsigned long, unsigned long long *);
1565 extern int     jbd2_journal_force_commit(journal_t *);
1566 extern int     jbd2_journal_force_commit_nested(journal_t *);
1567 extern int     jbd2_journal_inode_ranged_write(handle_t *handle,
1568             struct jbd2_inode *inode, loff_t start_byte,
1569             loff_t length);
1570 extern int     jbd2_journal_inode_ranged_wait(handle_t *handle,
1571             struct jbd2_inode *inode, loff_t start_byte,
1572             loff_t length);
1573 extern int     jbd2_journal_submit_inode_data_buffers(
1574             struct jbd2_inode *jinode);
1575 extern int     jbd2_journal_finish_inode_data_buffers(
1576             struct jbd2_inode *jinode);
1577 extern int     jbd2_journal_begin_ordered_truncate(journal_t *journal,
1578                 struct jbd2_inode *inode, loff_t new_size);
1579 extern void    jbd2_journal_init_jbd_inode(struct jbd2_inode *jinode, struct inode *inode);
1580 extern void    jbd2_journal_release_jbd_inode(journal_t *journal, struct jbd2_inode *jinode);
1581 
1582 /*
1583  * journal_head management
1584  */
1585 struct journal_head *jbd2_journal_add_journal_head(struct buffer_head *bh);
1586 struct journal_head *jbd2_journal_grab_journal_head(struct buffer_head *bh);
1587 void jbd2_journal_put_journal_head(struct journal_head *jh);
1588 
1589 /*
1590  * handle management
1591  */
1592 extern struct kmem_cache *jbd2_handle_cache;
1593 
1594 static inline handle_t *jbd2_alloc_handle(gfp_t gfp_flags)
1595 {
1596     return kmem_cache_zalloc(jbd2_handle_cache, gfp_flags);
1597 }
1598 
1599 static inline void jbd2_free_handle(handle_t *handle)
1600 {
1601     kmem_cache_free(jbd2_handle_cache, handle);
1602 }
1603 
1604 /*
1605  * jbd2_inode management (optional, for those file systems that want to use
1606  * dynamically allocated jbd2_inode structures)
1607  */
1608 extern struct kmem_cache *jbd2_inode_cache;
1609 
1610 static inline struct jbd2_inode *jbd2_alloc_inode(gfp_t gfp_flags)
1611 {
1612     return kmem_cache_alloc(jbd2_inode_cache, gfp_flags);
1613 }
1614 
1615 static inline void jbd2_free_inode(struct jbd2_inode *jinode)
1616 {
1617     kmem_cache_free(jbd2_inode_cache, jinode);
1618 }
1619 
1620 /* Primary revoke support */
1621 #define JOURNAL_REVOKE_DEFAULT_HASH 256
1622 extern int     jbd2_journal_init_revoke(journal_t *, int);
1623 extern void    jbd2_journal_destroy_revoke_record_cache(void);
1624 extern void    jbd2_journal_destroy_revoke_table_cache(void);
1625 extern int __init jbd2_journal_init_revoke_record_cache(void);
1626 extern int __init jbd2_journal_init_revoke_table_cache(void);
1627 
1628 extern void    jbd2_journal_destroy_revoke(journal_t *);
1629 extern int     jbd2_journal_revoke (handle_t *, unsigned long long, struct buffer_head *);
1630 extern int     jbd2_journal_cancel_revoke(handle_t *, struct journal_head *);
1631 extern void    jbd2_journal_write_revoke_records(transaction_t *transaction,
1632                              struct list_head *log_bufs);
1633 
1634 /* Recovery revoke support */
1635 extern int  jbd2_journal_set_revoke(journal_t *, unsigned long long, tid_t);
1636 extern int  jbd2_journal_test_revoke(journal_t *, unsigned long long, tid_t);
1637 extern void jbd2_journal_clear_revoke(journal_t *);
1638 extern void jbd2_journal_switch_revoke_table(journal_t *journal);
1639 extern void jbd2_clear_buffer_revoked_flags(journal_t *journal);
1640 
1641 /*
1642  * The log thread user interface:
1643  *
1644  * Request space in the current transaction, and force transaction commit
1645  * transitions on demand.
1646  */
1647 
1648 int jbd2_log_start_commit(journal_t *journal, tid_t tid);
1649 int jbd2_journal_start_commit(journal_t *journal, tid_t *tid);
1650 int jbd2_log_wait_commit(journal_t *journal, tid_t tid);
1651 int jbd2_transaction_committed(journal_t *journal, tid_t tid);
1652 int jbd2_complete_transaction(journal_t *journal, tid_t tid);
1653 int jbd2_log_do_checkpoint(journal_t *journal);
1654 int jbd2_trans_will_send_data_barrier(journal_t *journal, tid_t tid);
1655 
1656 void __jbd2_log_wait_for_space(journal_t *journal);
1657 extern void __jbd2_journal_drop_transaction(journal_t *, transaction_t *);
1658 extern int jbd2_cleanup_journal_tail(journal_t *);
1659 
1660 /* Fast commit related APIs */
1661 int jbd2_fc_begin_commit(journal_t *journal, tid_t tid);
1662 int jbd2_fc_end_commit(journal_t *journal);
1663 int jbd2_fc_end_commit_fallback(journal_t *journal);
1664 int jbd2_fc_get_buf(journal_t *journal, struct buffer_head **bh_out);
1665 int jbd2_submit_inode_data(struct jbd2_inode *jinode);
1666 int jbd2_wait_inode_data(journal_t *journal, struct jbd2_inode *jinode);
1667 int jbd2_fc_wait_bufs(journal_t *journal, int num_blks);
1668 int jbd2_fc_release_bufs(journal_t *journal);
1669 
1670 static inline int jbd2_journal_get_max_txn_bufs(journal_t *journal)
1671 {
1672     return (journal->j_total_len - journal->j_fc_wbufsize) / 4;
1673 }
1674 
1675 /*
1676  * is_journal_abort
1677  *
1678  * Simple test wrapper function to test the JBD2_ABORT state flag.  This
1679  * bit, when set, indicates that we have had a fatal error somewhere,
1680  * either inside the journaling layer or indicated to us by the client
1681  * (eg. ext3), and that we and should not commit any further
1682  * transactions.
1683  */
1684 
1685 static inline int is_journal_aborted(journal_t *journal)
1686 {
1687     return journal->j_flags & JBD2_ABORT;
1688 }
1689 
1690 static inline int is_handle_aborted(handle_t *handle)
1691 {
1692     if (handle->h_aborted || !handle->h_transaction)
1693         return 1;
1694     return is_journal_aborted(handle->h_transaction->t_journal);
1695 }
1696 
1697 static inline void jbd2_journal_abort_handle(handle_t *handle)
1698 {
1699     handle->h_aborted = 1;
1700 }
1701 
1702 #endif /* __KERNEL__   */
1703 
1704 /* Comparison functions for transaction IDs: perform comparisons using
1705  * modulo arithmetic so that they work over sequence number wraps. */
1706 
1707 static inline int tid_gt(tid_t x, tid_t y)
1708 {
1709     int difference = (x - y);
1710     return (difference > 0);
1711 }
1712 
1713 static inline int tid_geq(tid_t x, tid_t y)
1714 {
1715     int difference = (x - y);
1716     return (difference >= 0);
1717 }
1718 
1719 extern int jbd2_journal_blocks_per_page(struct inode *inode);
1720 extern size_t journal_tag_bytes(journal_t *journal);
1721 
1722 static inline bool jbd2_journal_has_csum_v2or3_feature(journal_t *j)
1723 {
1724     return jbd2_has_feature_csum2(j) || jbd2_has_feature_csum3(j);
1725 }
1726 
1727 static inline int jbd2_journal_has_csum_v2or3(journal_t *journal)
1728 {
1729     WARN_ON_ONCE(jbd2_journal_has_csum_v2or3_feature(journal) &&
1730              journal->j_chksum_driver == NULL);
1731 
1732     return journal->j_chksum_driver != NULL;
1733 }
1734 
1735 static inline int jbd2_journal_get_num_fc_blks(journal_superblock_t *jsb)
1736 {
1737     int num_fc_blocks = be32_to_cpu(jsb->s_num_fc_blks);
1738 
1739     return num_fc_blocks ? num_fc_blocks : JBD2_DEFAULT_FAST_COMMIT_BLOCKS;
1740 }
1741 
1742 /*
1743  * Return number of free blocks in the log. Must be called under j_state_lock.
1744  */
1745 static inline unsigned long jbd2_log_space_left(journal_t *journal)
1746 {
1747     /* Allow for rounding errors */
1748     long free = journal->j_free - 32;
1749 
1750     if (journal->j_committing_transaction) {
1751         free -= atomic_read(&journal->
1752                         j_committing_transaction->t_outstanding_credits);
1753     }
1754     return max_t(long, free, 0);
1755 }
1756 
1757 /*
1758  * Definitions which augment the buffer_head layer
1759  */
1760 
1761 /* journaling buffer types */
1762 #define BJ_None     0   /* Not journaled */
1763 #define BJ_Metadata 1   /* Normal journaled metadata */
1764 #define BJ_Forget   2   /* Buffer superseded by this transaction */
1765 #define BJ_Shadow   3   /* Buffer contents being shadowed to the log */
1766 #define BJ_Reserved 4   /* Buffer is reserved for access by journal */
1767 #define BJ_Types    5
1768 
1769 /* JBD uses a CRC32 checksum */
1770 #define JBD_MAX_CHECKSUM_SIZE 4
1771 
1772 static inline u32 jbd2_chksum(journal_t *journal, u32 crc,
1773                   const void *address, unsigned int length)
1774 {
1775     struct {
1776         struct shash_desc shash;
1777         char ctx[JBD_MAX_CHECKSUM_SIZE];
1778     } desc;
1779     int err;
1780 
1781     BUG_ON(crypto_shash_descsize(journal->j_chksum_driver) >
1782         JBD_MAX_CHECKSUM_SIZE);
1783 
1784     desc.shash.tfm = journal->j_chksum_driver;
1785     *(u32 *)desc.ctx = crc;
1786 
1787     err = crypto_shash_update(&desc.shash, address, length);
1788     BUG_ON(err);
1789 
1790     return *(u32 *)desc.ctx;
1791 }
1792 
1793 /* Return most recent uncommitted transaction */
1794 static inline tid_t  jbd2_get_latest_transaction(journal_t *journal)
1795 {
1796     tid_t tid;
1797 
1798     read_lock(&journal->j_state_lock);
1799     tid = journal->j_commit_request;
1800     if (journal->j_running_transaction)
1801         tid = journal->j_running_transaction->t_tid;
1802     read_unlock(&journal->j_state_lock);
1803     return tid;
1804 }
1805 
1806 static inline int jbd2_handle_buffer_credits(handle_t *handle)
1807 {
1808     journal_t *journal;
1809 
1810     if (!handle->h_reserved)
1811         journal = handle->h_transaction->t_journal;
1812     else
1813         journal = handle->h_journal;
1814 
1815     return handle->h_total_credits -
1816         DIV_ROUND_UP(handle->h_revoke_credits_requested,
1817                  journal->j_revoke_records_per_block);
1818 }
1819 
1820 #ifdef __KERNEL__
1821 
1822 #define buffer_trace_init(bh)   do {} while (0)
1823 #define print_buffer_fields(bh) do {} while (0)
1824 #define print_buffer_trace(bh)  do {} while (0)
1825 #define BUFFER_TRACE(bh, info)  do {} while (0)
1826 #define BUFFER_TRACE2(bh, bh2, info)    do {} while (0)
1827 #define JBUFFER_TRACE(jh, info) do {} while (0)
1828 
1829 #endif  /* __KERNEL__ */
1830 
1831 #define EFSBADCRC   EBADMSG     /* Bad CRC detected */
1832 #define EFSCORRUPTED    EUCLEAN     /* Filesystem is corrupted */
1833 
1834 #endif  /* _LINUX_JBD2_H */