4 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
6 * Copyright 1998--1999 Red Hat corp --- All Rights Reserved
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.
12 * Ext4-specific journaling extensions.
19 #include <linux/jbd2.h>
22 #define EXT4_JOURNAL(inode) (EXT4_SB((inode)->i_sb)->s_journal)
24 /* Define the number of blocks we need to account to a transaction to
25 * modify one block of data.
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.
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. */
34 #define EXT4_SINGLEDATA_TRANS_BLOCKS(sb) \
35 (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS) \
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. */
42 #define EXT4_XATTR_TRANS_BLOCKS 6U
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. */
50 #define EXT4_DATA_TRANS_BLOCKS(sb) (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
51 EXT4_XATTR_TRANS_BLOCKS - 2 + \
52 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
55 * Define the number of metadata blocks we need to account to modify data.
57 * This include super block, inode block, quota blocks and xattr blocks
59 #define EXT4_META_TRANS_BLOCKS(sb) (EXT4_XATTR_TRANS_BLOCKS + \
60 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
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. */
66 #define EXT4_DELETE_TRANS_BLOCKS(sb) (2 * EXT4_DATA_TRANS_BLOCKS(sb) + 64)
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. */
74 #define EXT4_MAX_TRANS_DATA 64U
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
83 #define EXT4_RESERVE_TRANS_BLOCKS 12U
85 #define EXT4_INDEX_EXTRA_TRANS_BLOCKS 8
88 /* Amount of blocks needed for quota update - we know that the structure was
89 * allocated so we need to update only inode+data */
90 #define EXT4_QUOTA_TRANS_BLOCKS(sb) (test_opt(sb, QUOTA) ? 2 : 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)
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)
99 #define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
100 #define EXT4_QUOTA_INIT_BLOCKS(sb) 0
101 #define EXT4_QUOTA_DEL_BLOCKS(sb) 0
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))
108 ext4_mark_iloc_dirty(handle_t *handle,
110 struct ext4_iloc *iloc);
113 * On success, We end up with an outstanding reference count against
114 * iloc->bh. This _must_ be cleaned up later.
117 int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
118 struct ext4_iloc *iloc);
120 int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);
123 * Wrapper functions with which ext4 calls into JBD.
125 void ext4_journal_abort_handle(const char *caller, const char *err_fn,
126 struct buffer_head *bh, handle_t *handle, int err);
128 int __ext4_journal_get_undo_access(const char *where, handle_t *handle,
129 struct buffer_head *bh);
131 int __ext4_journal_get_write_access(const char *where, handle_t *handle,
132 struct buffer_head *bh);
134 int __ext4_forget(const char *where, handle_t *handle, int is_metadata,
135 struct inode *inode, struct buffer_head *bh,
136 ext4_fsblk_t blocknr);
138 int __ext4_journal_get_create_access(const char *where,
139 handle_t *handle, struct buffer_head *bh);
141 int __ext4_handle_dirty_metadata(const char *where, handle_t *handle,
142 struct inode *inode, struct buffer_head *bh);
144 int __ext4_handle_dirty_super(const char *where, handle_t *handle,
145 struct super_block *sb);
147 #define ext4_journal_get_undo_access(handle, bh) \
148 __ext4_journal_get_undo_access(__func__, (handle), (bh))
149 #define ext4_journal_get_write_access(handle, bh) \
150 __ext4_journal_get_write_access(__func__, (handle), (bh))
151 #define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
152 __ext4_forget(__func__, (handle), (is_metadata), (inode), (bh),\
154 #define ext4_journal_get_create_access(handle, bh) \
155 __ext4_journal_get_create_access(__func__, (handle), (bh))
156 #define ext4_handle_dirty_metadata(handle, inode, bh) \
157 __ext4_handle_dirty_metadata(__func__, (handle), (inode), (bh))
158 #define ext4_handle_dirty_super(handle, sb) \
159 __ext4_handle_dirty_super(__func__, (handle), (sb))
161 handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
162 int __ext4_journal_stop(const char *where, handle_t *handle);
164 #define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
166 /* Note: Do not use this for NULL handles. This is only to determine if
167 * a properly allocated handle is using a journal or not. */
168 static inline int ext4_handle_valid(handle_t *handle)
170 if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
175 static inline void ext4_handle_sync(handle_t *handle)
177 if (ext4_handle_valid(handle))
181 static inline void ext4_handle_release_buffer(handle_t *handle,
182 struct buffer_head *bh)
184 if (ext4_handle_valid(handle))
185 jbd2_journal_release_buffer(handle, bh);
188 static inline int ext4_handle_is_aborted(handle_t *handle)
190 if (ext4_handle_valid(handle))
191 return is_handle_aborted(handle);
195 static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
197 if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
202 static inline void ext4_journal_release_buffer(handle_t *handle,
203 struct buffer_head *bh)
205 if (ext4_handle_valid(handle))
206 jbd2_journal_release_buffer(handle, bh);
209 static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks)
211 return ext4_journal_start_sb(inode->i_sb, nblocks);
214 #define ext4_journal_stop(handle) \
215 __ext4_journal_stop(__func__, (handle))
217 static inline handle_t *ext4_journal_current_handle(void)
219 return journal_current_handle();
222 static inline int ext4_journal_extend(handle_t *handle, int nblocks)
224 if (ext4_handle_valid(handle))
225 return jbd2_journal_extend(handle, nblocks);
229 static inline int ext4_journal_restart(handle_t *handle, int nblocks)
231 if (ext4_handle_valid(handle))
232 return jbd2_journal_restart(handle, nblocks);
236 static inline int ext4_journal_blocks_per_page(struct inode *inode)
238 if (EXT4_JOURNAL(inode) != NULL)
239 return jbd2_journal_blocks_per_page(inode);
243 static inline int ext4_journal_force_commit(journal_t *journal)
246 return jbd2_journal_force_commit(journal);
250 static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
252 if (ext4_handle_valid(handle))
253 return jbd2_journal_file_inode(handle, &EXT4_I(inode)->jinode);
257 static inline void ext4_update_inode_fsync_trans(handle_t *handle,
261 struct ext4_inode_info *ei = EXT4_I(inode);
263 if (ext4_handle_valid(handle)) {
264 ei->i_sync_tid = handle->h_transaction->t_tid;
266 ei->i_datasync_tid = handle->h_transaction->t_tid;
271 int ext4_force_commit(struct super_block *sb);
273 static inline int ext4_should_journal_data(struct inode *inode)
275 if (EXT4_JOURNAL(inode) == NULL)
277 if (!S_ISREG(inode->i_mode))
279 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
281 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
286 static inline int ext4_should_order_data(struct inode *inode)
288 if (EXT4_JOURNAL(inode) == NULL)
290 if (!S_ISREG(inode->i_mode))
292 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
294 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
299 static inline int ext4_should_writeback_data(struct inode *inode)
301 if (!S_ISREG(inode->i_mode))
303 if (EXT4_JOURNAL(inode) == NULL)
305 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
307 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
313 * This function controls whether or not we should try to go down the
314 * dioread_nolock code paths, which makes it safe to avoid taking
315 * i_mutex for direct I/O reads. This only works for extent-based
316 * files, and it doesn't work if data journaling is enabled, since the
317 * dioread_nolock code uses b_private to pass information back to the
318 * I/O completion handler, and this conflicts with the jbd's use of
321 static inline int ext4_should_dioread_nolock(struct inode *inode)
323 if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
325 if (!S_ISREG(inode->i_mode))
327 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
329 if (ext4_should_journal_data(inode))
334 #endif /* _EXT4_JBD2_H */