fs/ext4/ext4_jbd2.h

   1 /*
   2  * ext4_jbd2.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  * Ext4-specific journaling extensions.
  13  */
  14
  15 #ifndef _EXT4_JBD2_H
  16 #define _EXT4_JBD2_H
  17
  18 #include <linux/fs.h>
  19 #include <linux/jbd2.h>
  20 #include "ext4.h"
  21
  22 #define EXT4_JOURNAL(inode)     (EXT4_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  * For extents-enabled fs we may have to allocate and modify up to
  32  * 5 levels of tree + root which are stored in the inode. */
  33
  34 #define EXT4_SINGLEDATA_TRANS_BLOCKS(sb)                                \
  35         (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS)   \
  36          ? 27U : 8U)
  37
  38 /* Extended attribute operations touch at most two data buffers,
  39  * two bitmap buffers, and two group summaries, in addition to the inode
  40  * and the superblock, which are already accounted for. */
  41
  42 #define EXT4_XATTR_TRANS_BLOCKS         6U
  43
  44 /* Define the minimum size for a transaction which modifies data.  This
  45  * needs to take into account the fact that we may end up modifying two
  46  * quota files too (one for the group, one for the user quota).  The
  47  * superblock only gets updated once, of course, so don't bother
  48  * counting that again for the quota updates. */
  49
  50 #define EXT4_DATA_TRANS_BLOCKS(sb)      (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
  51                                          EXT4_XATTR_TRANS_BLOCKS - 2 + \
  52                                          EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
  53
  54 /*
  55  * Define the number of metadata blocks we need to account to modify data.
  56  *
  57  * This include super block, inode block, quota blocks and xattr blocks
  58  */
  59 #define EXT4_META_TRANS_BLOCKS(sb)      (EXT4_XATTR_TRANS_BLOCKS + \
  60                                         EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
  61
  62 /* Delete operations potentially hit one directory's namespace plus an
  63  * entire inode, plus arbitrary amounts of bitmap/indirection data.  Be
  64  * generous.  We can grow the delete transaction later if necessary. */
  65
  66 #define EXT4_DELETE_TRANS_BLOCKS(sb)    (2 * EXT4_DATA_TRANS_BLOCKS(sb) + 64)
  67
  68 /* Define an arbitrary limit for the amount of data we will anticipate
  69  * writing to any given transaction.  For unbounded transactions such as
  70  * write(2) and truncate(2) we can write more than this, but we always
  71  * start off at the maximum transaction size and grow the transaction
  72  * optimistically as we go. */
  73
  74 #define EXT4_MAX_TRANS_DATA             64U
  75
  76 /* We break up a large truncate or write transaction once the handle's
  77  * buffer credits gets this low, we need either to extend the
  78  * transaction or to start a new one.  Reserve enough space here for
  79  * inode, bitmap, superblock, group and indirection updates for at least
  80  * one block, plus two quota updates.  Quota allocations are not
  81  * needed. */
  82
  83 #define EXT4_RESERVE_TRANS_BLOCKS       12U
  84
  85 #define EXT4_INDEX_EXTRA_TRANS_BLOCKS   8
  86
  87 #ifdef CONFIG_QUOTA
  88 /* Amount of blocks needed for quota update - we know that the structure was
  89  * allocated so we need to update only data block */
  90 #define EXT4_QUOTA_TRANS_BLOCKS(sb) (test_opt(sb, QUOTA) ? 1 : 0)
  91 /* Amount of blocks needed for quota insert/delete - we do some block writes
  92  * but inode, sb and group updates are done only once */
  93 #define EXT4_QUOTA_INIT_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_INIT_ALLOC*\
  94                 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_INIT_REWRITE) : 0)
  95
  96 #define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\
  97                 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0)
  98 #else
  99 #define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
 100 #define EXT4_QUOTA_INIT_BLOCKS(sb) 0
 101 #define EXT4_QUOTA_DEL_BLOCKS(sb) 0
 102 #endif
 103 #define EXT4_MAXQUOTAS_TRANS_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_TRANS_BLOCKS(sb))
 104 #define EXT4_MAXQUOTAS_INIT_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_INIT_BLOCKS(sb))
 105 #define EXT4_MAXQUOTAS_DEL_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_DEL_BLOCKS(sb))
 106
 107 int
 108 ext4_mark_iloc_dirty(handle_t *handle,
 109                      struct inode *inode,
 110                      struct ext4_iloc *iloc);
 111
 112 /*
 113  * On success, We end up with an outstanding reference count against
 114  * iloc->bh.  This _must_ be cleaned up later.
 115  */
 116
 117 int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
 118                         struct ext4_iloc *iloc);
 119
 120 int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);
 121
 122 /*
 123  * Wrapper functions with which ext4 calls into JBD.
 124  */
 125 void ext4_journal_abort_handle(const char *caller, unsigned int line,
 126                                const char *err_fn,
 127                 struct buffer_head *bh, handle_t *handle, int err);
 128
 129 int __ext4_journal_get_write_access(const char *where, unsigned int line,
 130                                     handle_t *handle, struct buffer_head *bh);
 131
 132 int __ext4_forget(const char *where, unsigned int line, handle_t *handle,
 133                   int is_metadata, struct inode *inode,
 134                   struct buffer_head *bh, ext4_fsblk_t blocknr);
 135
 136 int __ext4_journal_get_create_access(const char *where, unsigned int line,
 137                                 handle_t *handle, struct buffer_head *bh);
 138
 139 int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
 140                                  handle_t *handle, struct inode *inode,
 141                                  struct buffer_head *bh);
 142
 143 int __ext4_handle_dirty_super(const char *where, unsigned int line,
 144                               handle_t *handle, struct super_block *sb);
 145
 146 #define ext4_journal_get_write_access(handle, bh) \
 147         __ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
 148 #define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
 149         __ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
 150                       (bh), (block_nr))
 151 #define ext4_journal_get_create_access(handle, bh) \
 152         __ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
 153 #define ext4_handle_dirty_metadata(handle, inode, bh) \
 154         __ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
 155                                      (bh))
 156 #define ext4_handle_dirty_super(handle, sb) \
 157         __ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))
 158
 159 handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
 160 int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle);
 161
 162 #define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
 163
 164 /* Note:  Do not use this for NULL handles.  This is only to determine if
 165  * a properly allocated handle is using a journal or not. */
 166 static inline int ext4_handle_valid(handle_t *handle)
 167 {
 168         if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
 169                 return 0;
 170         return 1;
 171 }
 172
 173 static inline void ext4_handle_sync(handle_t *handle)
 174 {
 175         if (ext4_handle_valid(handle))
 176                 handle->h_sync = 1;
 177 }
 178
 179 static inline void ext4_handle_release_buffer(handle_t *handle,
 180                                                 struct buffer_head *bh)
 181 {
 182         if (ext4_handle_valid(handle))
 183                 jbd2_journal_release_buffer(handle, bh);
 184 }
 185
 186 static inline int ext4_handle_is_aborted(handle_t *handle)
 187 {
 188         if (ext4_handle_valid(handle))
 189                 return is_handle_aborted(handle);
 190         return 0;
 191 }
 192
 193 static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
 194 {
 195         if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
 196                 return 0;
 197         return 1;
 198 }
 199
 200 static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks)
 201 {
 202         return ext4_journal_start_sb(inode->i_sb, nblocks);
 203 }
 204
 205 #define ext4_journal_stop(handle) \
 206         __ext4_journal_stop(__func__, __LINE__, (handle))
 207
 208 static inline handle_t *ext4_journal_current_handle(void)
 209 {
 210         return journal_current_handle();
 211 }
 212
 213 static inline int ext4_journal_extend(handle_t *handle, int nblocks)
 214 {
 215         if (ext4_handle_valid(handle))
 216                 return jbd2_journal_extend(handle, nblocks);
 217         return 0;
 218 }
 219
 220 static inline int ext4_journal_restart(handle_t *handle, int nblocks)
 221 {
 222         if (ext4_handle_valid(handle))
 223                 return jbd2_journal_restart(handle, nblocks);
 224         return 0;
 225 }
 226
 227 static inline int ext4_journal_blocks_per_page(struct inode *inode)
 228 {
 229         if (EXT4_JOURNAL(inode) != NULL)
 230                 return jbd2_journal_blocks_per_page(inode);
 231         return 0;
 232 }
 233
 234 static inline int ext4_journal_force_commit(journal_t *journal)
 235 {
 236         if (journal)
 237                 return jbd2_journal_force_commit(journal);
 238         return 0;
 239 }
 240
 241 static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
 242 {
 243         if (ext4_handle_valid(handle))
 244                 return jbd2_journal_file_inode(handle, EXT4_I(inode)->jinode);
 245         return 0;
 246 }
 247
 248 static inline void ext4_update_inode_fsync_trans(handle_t *handle,
 249                                                  struct inode *inode,
 250                                                  int datasync)
 251 {
 252         struct ext4_inode_info *ei = EXT4_I(inode);
 253
 254         if (ext4_handle_valid(handle)) {
 255                 ei->i_sync_tid = handle->h_transaction->t_tid;
 256                 if (datasync)
 257                         ei->i_datasync_tid = handle->h_transaction->t_tid;
 258         }
 259 }
 260
 261 /* super.c */
 262 int ext4_force_commit(struct super_block *sb);
 263
 264 /*
 265  * Ext4 inode journal modes
 266  */
 267 #define EXT4_INODE_JOURNAL_DATA_MODE    0x01 /* journal data mode */
 268 #define EXT4_INODE_ORDERED_DATA_MODE    0x02 /* ordered data mode */
 269 #define EXT4_INODE_WRITEBACK_DATA_MODE  0x04 /* writeback data mode */
 270
 271 static inline int ext4_inode_journal_mode(struct inode *inode)
 272 {
 273         if (EXT4_JOURNAL(inode) == NULL)
 274                 return EXT4_INODE_WRITEBACK_DATA_MODE;  /* writeback */
 275         /* We do not support data journalling with delayed allocation */
 276         if (!S_ISREG(inode->i_mode) ||
 277             test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
 278                 return EXT4_INODE_JOURNAL_DATA_MODE;    /* journal data */
 279         if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA) &&
 280             !test_opt(inode->i_sb, DELALLOC))
 281                 return EXT4_INODE_JOURNAL_DATA_MODE;    /* journal data */
 282         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
 283                 return EXT4_INODE_ORDERED_DATA_MODE;    /* ordered */
 284         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
 285                 return EXT4_INODE_WRITEBACK_DATA_MODE;  /* writeback */
 286         else
 287                 BUG();
 288 }
 289
 290 static inline int ext4_should_journal_data(struct inode *inode)
 291 {
 292         return ext4_inode_journal_mode(inode) & EXT4_INODE_JOURNAL_DATA_MODE;
 293 }
 294
 295 static inline int ext4_should_order_data(struct inode *inode)
 296 {
 297         return ext4_inode_journal_mode(inode) & EXT4_INODE_ORDERED_DATA_MODE;
 298 }
 299
 300 static inline int ext4_should_writeback_data(struct inode *inode)
 301 {
 302         return ext4_inode_journal_mode(inode) & EXT4_INODE_WRITEBACK_DATA_MODE;
 303 }
 304
 305 /*
 306  * This function controls whether or not we should try to go down the
 307  * dioread_nolock code paths, which makes it safe to avoid taking
 308  * i_mutex for direct I/O reads.  This only works for extent-based
 309  * files, and it doesn't work if data journaling is enabled, since the
 310  * dioread_nolock code uses b_private to pass information back to the
 311  * I/O completion handler, and this conflicts with the jbd's use of
 312  * b_private.
 313  */
 314 static inline int ext4_should_dioread_nolock(struct inode *inode)
 315 {
 316         if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
 317                 return 0;
 318         if (!S_ISREG(inode->i_mode))
 319                 return 0;
 320         if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
 321                 return 0;
 322         if (ext4_should_journal_data(inode))
 323                 return 0;
 324         return 1;
 325 }
 326
 327 #endif  /* _EXT4_JBD2_H */