blob: 5802fa1dab18f4a8aac358bd79f3ae92109daf02 [file] [log] [blame]
Dave Kleikamp470decc2006-10-11 01:20:57 -07001/*
Christoph Hellwig3dcf5452008-04-29 18:13:32 -04002 * ext4_jbd2.h
Dave Kleikamp470decc2006-10-11 01:20:57 -07003 *
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
Christoph Hellwig3dcf5452008-04-29 18:13:32 -040015#ifndef _EXT4_JBD2_H
16#define _EXT4_JBD2_H
Dave Kleikamp470decc2006-10-11 01:20:57 -070017
18#include <linux/fs.h>
Mingming Caof7f4bcc2006-10-11 01:20:59 -070019#include <linux/jbd2.h>
Christoph Hellwig3dcf5452008-04-29 18:13:32 -040020#include "ext4.h"
Dave Kleikamp470decc2006-10-11 01:20:57 -070021
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
Alex Tomasa86c6182006-10-11 01:21:03 -070029 * block to complete the transaction.
30 *
Randy Dunlapd0d856e2006-10-11 01:21:07 -070031 * 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. */
Dave Kleikamp470decc2006-10-11 01:20:57 -070033
Alex Tomasa86c6182006-10-11 01:21:03 -070034#define EXT4_SINGLEDATA_TRANS_BLOCKS(sb) \
Theodore Ts'o83982b62009-01-06 14:53:16 -050035 (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS) \
36 ? 27U : 8U)
Dave Kleikamp470decc2006-10-11 01:20:57 -070037
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
Alex Tomasa86c6182006-10-11 01:21:03 -070050#define EXT4_DATA_TRANS_BLOCKS(sb) (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
Dave Kleikamp470decc2006-10-11 01:20:57 -070051 EXT4_XATTR_TRANS_BLOCKS - 2 + \
Dmitry Monakhov5aca07e2009-12-08 22:42:15 -050052 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
Dave Kleikamp470decc2006-10-11 01:20:57 -070053
Mingming Caoa02908f2008-08-19 22:16:07 -040054/*
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 + \
Dmitry Monakhov5aca07e2009-12-08 22:42:15 -050060 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
Mingming Caoa02908f2008-08-19 22:16:07 -040061
Dave Kleikamp470decc2006-10-11 01:20:57 -070062/* 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
Jan Kara21f97692011-04-04 15:33:39 -040089 * allocated so we need to update only data block */
90#define EXT4_QUOTA_TRANS_BLOCKS(sb) (test_opt(sb, QUOTA) ? 1 : 0)
Dave Kleikamp470decc2006-10-11 01:20:57 -070091/* 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*\
Alex Tomasa86c6182006-10-11 01:21:03 -070094 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_INIT_REWRITE) : 0)
Dmitry Monakhov5aca07e2009-12-08 22:42:15 -050095
Dave Kleikamp470decc2006-10-11 01:20:57 -070096#define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\
Alex Tomasa86c6182006-10-11 01:21:03 -070097 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0)
Dave Kleikamp470decc2006-10-11 01:20:57 -070098#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
Dmitry Monakhov5aca07e2009-12-08 22:42:15 -0500103#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))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700106
107int
108ext4_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
117int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
118 struct ext4_iloc *iloc);
119
120int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);
121
122/*
Theodore Ts'oe4684b32009-11-24 11:05:59 -0500123 * Wrapper functions with which ext4 calls into JBD.
Dave Kleikamp470decc2006-10-11 01:20:57 -0700124 */
Theodore Ts'o90c72012010-06-29 14:53:24 -0400125void ext4_journal_abort_handle(const char *caller, unsigned int line,
126 const char *err_fn,
Andrew Morton8984d132006-12-06 20:37:15 -0800127 struct buffer_head *bh, handle_t *handle, int err);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700128
Theodore Ts'o90c72012010-06-29 14:53:24 -0400129int __ext4_journal_get_write_access(const char *where, unsigned int line,
130 handle_t *handle, struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700131
Theodore Ts'o90c72012010-06-29 14:53:24 -0400132int __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);
Theodore Ts'od6797d12009-11-22 20:52:12 -0500135
Theodore Ts'o90c72012010-06-29 14:53:24 -0400136int __ext4_journal_get_create_access(const char *where, unsigned int line,
Andrew Morton8984d132006-12-06 20:37:15 -0800137 handle_t *handle, struct buffer_head *bh);
138
Theodore Ts'o90c72012010-06-29 14:53:24 -0400139int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
140 handle_t *handle, struct inode *inode,
141 struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700142
Theodore Ts'o90c72012010-06-29 14:53:24 -0400143int __ext4_handle_dirty_super(const char *where, unsigned int line,
144 handle_t *handle, struct super_block *sb);
Theodore Ts'oa0375152010-06-11 23:14:04 -0400145
Dave Kleikamp470decc2006-10-11 01:20:57 -0700146#define ext4_journal_get_write_access(handle, bh) \
Theodore Ts'o90c72012010-06-29 14:53:24 -0400147 __ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
Theodore Ts'od6797d12009-11-22 20:52:12 -0500148#define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
Theodore Ts'o90c72012010-06-29 14:53:24 -0400149 __ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
150 (bh), (block_nr))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700151#define ext4_journal_get_create_access(handle, bh) \
Theodore Ts'o90c72012010-06-29 14:53:24 -0400152 __ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
Frank Mayhar03901312009-01-07 00:06:22 -0500153#define ext4_handle_dirty_metadata(handle, inode, bh) \
Theodore Ts'o90c72012010-06-29 14:53:24 -0400154 __ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
155 (bh))
Theodore Ts'oa0375152010-06-11 23:14:04 -0400156#define ext4_handle_dirty_super(handle, sb) \
Theodore Ts'o90c72012010-06-29 14:53:24 -0400157 __ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700158
Dave Kleikamp470decc2006-10-11 01:20:57 -0700159handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
Theodore Ts'oc398eda2010-07-27 11:56:40 -0400160int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700161
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400162#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
Frank Mayhar03901312009-01-07 00:06:22 -0500163
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400164/* 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. */
Frank Mayhar03901312009-01-07 00:06:22 -0500166static inline int ext4_handle_valid(handle_t *handle)
167{
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400168 if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
Frank Mayhar03901312009-01-07 00:06:22 -0500169 return 0;
170 return 1;
171}
172
173static inline void ext4_handle_sync(handle_t *handle)
174{
175 if (ext4_handle_valid(handle))
176 handle->h_sync = 1;
177}
178
179static 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
186static 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
193static 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
Dave Kleikamp470decc2006-10-11 01:20:57 -0700200static 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) \
Theodore Ts'oc398eda2010-07-27 11:56:40 -0400206 __ext4_journal_stop(__func__, __LINE__, (handle))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700207
208static inline handle_t *ext4_journal_current_handle(void)
209{
210 return journal_current_handle();
211}
212
213static inline int ext4_journal_extend(handle_t *handle, int nblocks)
214{
Frank Mayhar03901312009-01-07 00:06:22 -0500215 if (ext4_handle_valid(handle))
216 return jbd2_journal_extend(handle, nblocks);
217 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700218}
219
220static inline int ext4_journal_restart(handle_t *handle, int nblocks)
221{
Frank Mayhar03901312009-01-07 00:06:22 -0500222 if (ext4_handle_valid(handle))
223 return jbd2_journal_restart(handle, nblocks);
224 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700225}
226
227static inline int ext4_journal_blocks_per_page(struct inode *inode)
228{
Frank Mayhar03901312009-01-07 00:06:22 -0500229 if (EXT4_JOURNAL(inode) != NULL)
230 return jbd2_journal_blocks_per_page(inode);
231 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700232}
233
234static inline int ext4_journal_force_commit(journal_t *journal)
235{
Frank Mayhar03901312009-01-07 00:06:22 -0500236 if (journal)
237 return jbd2_journal_force_commit(journal);
238 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700239}
240
Jan Kara678aaf42008-07-11 19:27:31 -0400241static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
242{
Frank Mayhar03901312009-01-07 00:06:22 -0500243 if (ext4_handle_valid(handle))
Theodore Ts'o8aefcd52011-01-10 12:29:43 -0500244 return jbd2_journal_file_inode(handle, EXT4_I(inode)->jinode);
Frank Mayhar03901312009-01-07 00:06:22 -0500245 return 0;
Jan Kara678aaf42008-07-11 19:27:31 -0400246}
247
Jan Karab436b9b2009-12-08 23:51:10 -0500248static 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
Dave Kleikamp470decc2006-10-11 01:20:57 -0700261/* super.c */
262int ext4_force_commit(struct super_block *sb);
263
264static inline int ext4_should_journal_data(struct inode *inode)
265{
Frank Mayhar03901312009-01-07 00:06:22 -0500266 if (EXT4_JOURNAL(inode) == NULL)
267 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700268 if (!S_ISREG(inode->i_mode))
269 return 1;
270 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
271 return 1;
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400272 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700273 return 1;
274 return 0;
275}
276
277static inline int ext4_should_order_data(struct inode *inode)
278{
Frank Mayhar03901312009-01-07 00:06:22 -0500279 if (EXT4_JOURNAL(inode) == NULL)
280 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700281 if (!S_ISREG(inode->i_mode))
282 return 0;
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400283 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700284 return 0;
285 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
286 return 1;
287 return 0;
288}
289
290static inline int ext4_should_writeback_data(struct inode *inode)
291{
Theodore Ts'o5adfee92009-07-08 17:11:24 -0400292 if (EXT4_JOURNAL(inode) == NULL)
293 return 1;
Curt Wohlgemuth441c8502011-08-13 11:25:18 -0400294 if (!S_ISREG(inode->i_mode))
295 return 0;
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400296 if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700297 return 0;
298 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
299 return 1;
300 return 0;
301}
302
Jiaying Zhang744692d2010-03-04 16:14:02 -0500303/*
304 * This function controls whether or not we should try to go down the
305 * dioread_nolock code paths, which makes it safe to avoid taking
306 * i_mutex for direct I/O reads. This only works for extent-based
Christoph Hellwig206f7ab2010-06-14 14:42:49 -0400307 * files, and it doesn't work if data journaling is enabled, since the
308 * dioread_nolock code uses b_private to pass information back to the
309 * I/O completion handler, and this conflicts with the jbd's use of
310 * b_private.
Jiaying Zhang744692d2010-03-04 16:14:02 -0500311 */
312static inline int ext4_should_dioread_nolock(struct inode *inode)
313{
314 if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
315 return 0;
Jiaying Zhang744692d2010-03-04 16:14:02 -0500316 if (!S_ISREG(inode->i_mode))
317 return 0;
Dmitry Monakhov12e9b892010-05-16 22:00:00 -0400318 if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
Jiaying Zhang744692d2010-03-04 16:14:02 -0500319 return 0;
320 if (ext4_should_journal_data(inode))
321 return 0;
322 return 1;
323}
324
Christoph Hellwig3dcf5452008-04-29 18:13:32 -0400325#endif /* _EXT4_JBD2_H */