include/linux/ext3_jbd.h

   1 /*
   2  * linux/include/linux/ext3_jbd.h
   3  *
   4  * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
   5  *
   6  * Copyright 1998--1999 Red Hat corp --- 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  * Ext3-specific journaling extensions.
  13  */
  14
  15 #ifndef _LINUX_EXT3_JBD_H
  16 #define _LINUX_EXT3_JBD_H
  17
  18 #include <linux/fs.h>
  19 #include <linux/jbd.h>
  20 #include <linux/ext3_fs.h>
  21
  22 #define EXT3_JOURNAL(inode)     (EXT3_SB((inode)->i_sb)->s_journal)
  23
  24 /* Define the number of blocks we need to account to a transaction to
  25  * modify one block of data.
  26  *
  27  * We may have to touch one inode, one bitmap buffer, up to three
  28  * indirection blocks, the group and superblock summaries, and the data
  29  * block to complete the transaction.  */
  30
  31 #define EXT3_SINGLEDATA_TRANS_BLOCKS    8U
  32
  33 /* Extended attribute operations touch at most two data buffers,
  34  * two bitmap buffers, and two group summaries, in addition to the inode
  35  * and the superblock, which are already accounted for. */
  36
  37 #define EXT3_XATTR_TRANS_BLOCKS         6U
  38
  39 /* Define the minimum size for a transaction which modifies data.  This
  40  * needs to take into account the fact that we may end up modifying two
  41  * quota files too (one for the group, one for the user quota).  The
  42  * superblock only gets updated once, of course, so don't bother
  43  * counting that again for the quota updates. */
  44
  45 #define EXT3_DATA_TRANS_BLOCKS          (EXT3_SINGLEDATA_TRANS_BLOCKS + \
  46                                          EXT3_XATTR_TRANS_BLOCKS - 2 + \
  47                                          2*EXT3_QUOTA_TRANS_BLOCKS)
  48
  49 extern int ext3_writepage_trans_blocks(struct inode *inode);
  50
  51 /* Delete operations potentially hit one directory's namespace plus an
  52  * entire inode, plus arbitrary amounts of bitmap/indirection data.  Be
  53  * generous.  We can grow the delete transaction later if necessary. */
  54
  55 #define EXT3_DELETE_TRANS_BLOCKS        (2 * EXT3_DATA_TRANS_BLOCKS + 64)
  56
  57 /* Define an arbitrary limit for the amount of data we will anticipate
  58  * writing to any given transaction.  For unbounded transactions such as
  59  * write(2) and truncate(2) we can write more than this, but we always
  60  * start off at the maximum transaction size and grow the transaction
  61  * optimistically as we go. */
  62
  63 #define EXT3_MAX_TRANS_DATA             64U
  64
  65 /* We break up a large truncate or write transaction once the handle's
  66  * buffer credits gets this low, we need either to extend the
  67  * transaction or to start a new one.  Reserve enough space here for
  68  * inode, bitmap, superblock, group and indirection updates for at least
  69  * one block, plus two quota updates.  Quota allocations are not
  70  * needed. */
  71
  72 #define EXT3_RESERVE_TRANS_BLOCKS       12U
  73
  74 #define EXT3_INDEX_EXTRA_TRANS_BLOCKS   8
  75
  76 #ifdef CONFIG_QUOTA
  77 /* Amount of blocks needed for quota update - we know that the structure was
  78  * allocated so we need to update only inode+data */
  79 #define EXT3_QUOTA_TRANS_BLOCKS 2
  80 /* Amount of blocks needed for quota insert/delete - we do some block writes
  81  * but inode, sb and group updates are done only once */
  82 #define EXT3_QUOTA_INIT_BLOCKS (DQUOT_MAX_WRITES*\
  83                                 (EXT3_SINGLEDATA_TRANS_BLOCKS-3)+3)
  84 #else
  85 #define EXT3_QUOTA_TRANS_BLOCKS 0
  86 #define EXT3_QUOTA_INIT_BLOCKS 0
  87 #endif
  88
  89 int
  90 ext3_mark_iloc_dirty(handle_t *handle,
  91                      struct inode *inode,
  92                      struct ext3_iloc *iloc);
  93
  94 /*
  95  * On success, We end up with an outstanding reference count against
  96  * iloc->bh.  This _must_ be cleaned up later.
  97  */
  98
  99 int ext3_reserve_inode_write(handle_t *handle, struct inode *inode,
 100                         struct ext3_iloc *iloc);
 101
 102 int ext3_mark_inode_dirty(handle_t *handle, struct inode *inode);
 103
 104 /*
 105  * Wrapper functions with which ext3 calls into JBD.  The intent here is
 106  * to allow these to be turned into appropriate stubs so ext3 can control
 107  * ext2 filesystems, so ext2+ext3 systems only nee one fs.  This work hasn't
 108  * been done yet.
 109  */
 110
 111 void ext3_journal_abort_handle(const char *caller, const char *err_fn,
 112                 struct buffer_head *bh, handle_t *handle, int err);
 113
 114 static inline int
 115 __ext3_journal_get_undo_access(const char *where, handle_t *handle,
 116                                 struct buffer_head *bh, int *credits)
 117 {
 118         int err = journal_get_undo_access(handle, bh, credits);
 119         if (err)
 120                 ext3_journal_abort_handle(where, __FUNCTION__, bh, handle,err);
 121         return err;
 122 }
 123
 124 static inline int
 125 __ext3_journal_get_write_access(const char *where, handle_t *handle,
 126                                 struct buffer_head *bh, int *credits)
 127 {
 128         int err = journal_get_write_access(handle, bh, credits);
 129         if (err)
 130                 ext3_journal_abort_handle(where, __FUNCTION__, bh, handle,err);
 131         return err;
 132 }
 133
 134 static inline void
 135 ext3_journal_release_buffer(handle_t *handle, struct buffer_head *bh,
 136                                 int credits)
 137 {
 138         journal_release_buffer(handle, bh, credits);
 139 }
 140
 141 static inline void
 142 ext3_journal_forget(handle_t *handle, struct buffer_head *bh)
 143 {
 144         journal_forget(handle, bh);
 145 }
 146
 147 static inline int
 148 __ext3_journal_revoke(const char *where, handle_t *handle,
 149                       unsigned long blocknr, struct buffer_head *bh)
 150 {
 151         int err = journal_revoke(handle, blocknr, bh);
 152         if (err)
 153                 ext3_journal_abort_handle(where, __FUNCTION__, bh, handle,err);
 154         return err;
 155 }
 156
 157 static inline int
 158 __ext3_journal_get_create_access(const char *where,
 159                                  handle_t *handle, struct buffer_head *bh)
 160 {
 161         int err = journal_get_create_access(handle, bh);
 162         if (err)
 163                 ext3_journal_abort_handle(where, __FUNCTION__, bh, handle,err);
 164         return err;
 165 }
 166
 167 static inline int
 168 __ext3_journal_dirty_metadata(const char *where,
 169                               handle_t *handle, struct buffer_head *bh)
 170 {
 171         int err = journal_dirty_metadata(handle, bh);
 172         if (err)
 173                 ext3_journal_abort_handle(where, __FUNCTION__, bh, handle,err);
 174         return err;
 175 }
 176
 177
 178 #define ext3_journal_get_undo_access(handle, bh, credits) \
 179         __ext3_journal_get_undo_access(__FUNCTION__, (handle), (bh), (credits))
 180 #define ext3_journal_get_write_access(handle, bh) \
 181         __ext3_journal_get_write_access(__FUNCTION__, (handle), (bh), NULL)
 182 #define ext3_journal_get_write_access_credits(handle, bh, credits) \
 183         __ext3_journal_get_write_access(__FUNCTION__, (handle), (bh), (credits))
 184 #define ext3_journal_revoke(handle, blocknr, bh) \
 185         __ext3_journal_revoke(__FUNCTION__, (handle), (blocknr), (bh))
 186 #define ext3_journal_get_create_access(handle, bh) \
 187         __ext3_journal_get_create_access(__FUNCTION__, (handle), (bh))
 188 #define ext3_journal_dirty_metadata(handle, bh) \
 189         __ext3_journal_dirty_metadata(__FUNCTION__, (handle), (bh))
 190
 191 handle_t *ext3_journal_start(struct inode *inode, int nblocks);
 192 int __ext3_journal_stop(const char *where, handle_t *handle);
 193
 194 #define ext3_journal_stop(handle) \
 195         __ext3_journal_stop(__FUNCTION__, (handle))
 196
 197 static inline handle_t *ext3_journal_current_handle(void)
 198 {
 199         return journal_current_handle();
 200 }
 201
 202 static inline int ext3_journal_extend(handle_t *handle, int nblocks)
 203 {
 204         return journal_extend(handle, nblocks);
 205 }
 206
 207 static inline int ext3_journal_restart(handle_t *handle, int nblocks)
 208 {
 209         return journal_restart(handle, nblocks);
 210 }
 211
 212 static inline int ext3_journal_blocks_per_page(struct inode *inode)
 213 {
 214         return journal_blocks_per_page(inode);
 215 }
 216
 217 static inline int ext3_journal_force_commit(journal_t *journal)
 218 {
 219         return journal_force_commit(journal);
 220 }
 221
 222 /* super.c */
 223 int ext3_force_commit(struct super_block *sb);
 224
 225 static inline int ext3_should_journal_data(struct inode *inode)
 226 {
 227         if (!S_ISREG(inode->i_mode))
 228                 return 1;
 229         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT3_MOUNT_JOURNAL_DATA)
 230                 return 1;
 231         if (EXT3_I(inode)->i_flags & EXT3_JOURNAL_DATA_FL)
 232                 return 1;
 233         return 0;
 234 }
 235
 236 static inline int ext3_should_order_data(struct inode *inode)
 237 {
 238         if (!S_ISREG(inode->i_mode))
 239                 return 0;
 240         if (EXT3_I(inode)->i_flags & EXT3_JOURNAL_DATA_FL)
 241                 return 0;
 242         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT3_MOUNT_ORDERED_DATA)
 243                 return 1;
 244         return 0;
 245 }
 246
 247 static inline int ext3_should_writeback_data(struct inode *inode)
 248 {
 249         if (!S_ISREG(inode->i_mode))
 250                 return 0;
 251         if (EXT3_I(inode)->i_flags & EXT3_JOURNAL_DATA_FL)
 252                 return 0;
 253         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT3_MOUNT_WRITEBACK_DATA)
 254                 return 1;
 255         return 0;
 256 }
 257
 258 #endif  /* _LINUX_EXT3_JBD_H */