blob: a2865980342f90c21aed6d731fcf1d66d72e0312 [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 + \
52 2*EXT4_QUOTA_TRANS_BLOCKS(sb))
53
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 + \
60 2*EXT4_QUOTA_TRANS_BLOCKS(sb))
61
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
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*\
Alex Tomasa86c6182006-10-11 01:21:03 -070094 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_INIT_REWRITE) : 0)
Dave Kleikamp470decc2006-10-11 01:20:57 -070095#define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\
Alex Tomasa86c6182006-10-11 01:21:03 -070096 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0)
Dave Kleikamp470decc2006-10-11 01:20:57 -070097#else
98#define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
99#define EXT4_QUOTA_INIT_BLOCKS(sb) 0
100#define EXT4_QUOTA_DEL_BLOCKS(sb) 0
101#endif
102
103int
104ext4_mark_iloc_dirty(handle_t *handle,
105 struct inode *inode,
106 struct ext4_iloc *iloc);
107
108/*
109 * On success, We end up with an outstanding reference count against
110 * iloc->bh. This _must_ be cleaned up later.
111 */
112
113int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
114 struct ext4_iloc *iloc);
115
116int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);
117
118/*
119 * Wrapper functions with which ext4 calls into JBD. The intent here is
120 * to allow these to be turned into appropriate stubs so ext4 can control
121 * ext2 filesystems, so ext2+ext4 systems only nee one fs. This work hasn't
122 * been done yet.
123 */
124
Andrew Morton8984d132006-12-06 20:37:15 -0800125void ext4_journal_abort_handle(const char *caller, const char *err_fn,
126 struct buffer_head *bh, handle_t *handle, int err);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700127
Andrew Morton8984d132006-12-06 20:37:15 -0800128int __ext4_journal_get_undo_access(const char *where, handle_t *handle,
129 struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700130
Andrew Morton8984d132006-12-06 20:37:15 -0800131int __ext4_journal_get_write_access(const char *where, handle_t *handle,
132 struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700133
Curt Wohlgemuthe6b5d302009-07-13 09:07:20 -0400134/* When called with an invalid handle, this will still do a put on the BH */
Andrew Morton8984d132006-12-06 20:37:15 -0800135int __ext4_journal_forget(const char *where, handle_t *handle,
136 struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700137
Curt Wohlgemuthe6b5d302009-07-13 09:07:20 -0400138/* When called with an invalid handle, this will still do a put on the BH */
Andrew Morton8984d132006-12-06 20:37:15 -0800139int __ext4_journal_revoke(const char *where, handle_t *handle,
140 ext4_fsblk_t blocknr, struct buffer_head *bh);
141
142int __ext4_journal_get_create_access(const char *where,
143 handle_t *handle, struct buffer_head *bh);
144
Frank Mayhar03901312009-01-07 00:06:22 -0500145int __ext4_handle_dirty_metadata(const char *where, handle_t *handle,
146 struct inode *inode, struct buffer_head *bh);
Dave Kleikamp470decc2006-10-11 01:20:57 -0700147
148#define ext4_journal_get_undo_access(handle, bh) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400149 __ext4_journal_get_undo_access(__func__, (handle), (bh))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700150#define ext4_journal_get_write_access(handle, bh) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400151 __ext4_journal_get_write_access(__func__, (handle), (bh))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700152#define ext4_journal_revoke(handle, blocknr, bh) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400153 __ext4_journal_revoke(__func__, (handle), (blocknr), (bh))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700154#define ext4_journal_get_create_access(handle, bh) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400155 __ext4_journal_get_create_access(__func__, (handle), (bh))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700156#define ext4_journal_forget(handle, bh) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400157 __ext4_journal_forget(__func__, (handle), (bh))
Frank Mayhar03901312009-01-07 00:06:22 -0500158#define ext4_handle_dirty_metadata(handle, inode, bh) \
159 __ext4_handle_dirty_metadata(__func__, (handle), (inode), (bh))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700160
Dave Kleikamp470decc2006-10-11 01:20:57 -0700161handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
162int __ext4_journal_stop(const char *where, handle_t *handle);
163
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400164#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
Frank Mayhar03901312009-01-07 00:06:22 -0500165
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400166/* 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. */
Frank Mayhar03901312009-01-07 00:06:22 -0500168static inline int ext4_handle_valid(handle_t *handle)
169{
Curt Wohlgemuthd3d1faf2009-09-29 11:01:03 -0400170 if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
Frank Mayhar03901312009-01-07 00:06:22 -0500171 return 0;
172 return 1;
173}
174
175static inline void ext4_handle_sync(handle_t *handle)
176{
177 if (ext4_handle_valid(handle))
178 handle->h_sync = 1;
179}
180
181static inline void ext4_handle_release_buffer(handle_t *handle,
182 struct buffer_head *bh)
183{
184 if (ext4_handle_valid(handle))
185 jbd2_journal_release_buffer(handle, bh);
186}
187
188static inline int ext4_handle_is_aborted(handle_t *handle)
189{
190 if (ext4_handle_valid(handle))
191 return is_handle_aborted(handle);
192 return 0;
193}
194
195static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
196{
197 if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
198 return 0;
199 return 1;
200}
201
202static inline void ext4_journal_release_buffer(handle_t *handle,
203 struct buffer_head *bh)
204{
205 if (ext4_handle_valid(handle))
206 jbd2_journal_release_buffer(handle, bh);
207}
208
Dave Kleikamp470decc2006-10-11 01:20:57 -0700209static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks)
210{
211 return ext4_journal_start_sb(inode->i_sb, nblocks);
212}
213
214#define ext4_journal_stop(handle) \
Stoyan Gaydarov4db9c542008-07-13 21:03:29 -0400215 __ext4_journal_stop(__func__, (handle))
Dave Kleikamp470decc2006-10-11 01:20:57 -0700216
217static inline handle_t *ext4_journal_current_handle(void)
218{
219 return journal_current_handle();
220}
221
222static inline int ext4_journal_extend(handle_t *handle, int nblocks)
223{
Frank Mayhar03901312009-01-07 00:06:22 -0500224 if (ext4_handle_valid(handle))
225 return jbd2_journal_extend(handle, nblocks);
226 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700227}
228
229static inline int ext4_journal_restart(handle_t *handle, int nblocks)
230{
Frank Mayhar03901312009-01-07 00:06:22 -0500231 if (ext4_handle_valid(handle))
232 return jbd2_journal_restart(handle, nblocks);
233 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700234}
235
236static inline int ext4_journal_blocks_per_page(struct inode *inode)
237{
Frank Mayhar03901312009-01-07 00:06:22 -0500238 if (EXT4_JOURNAL(inode) != NULL)
239 return jbd2_journal_blocks_per_page(inode);
240 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700241}
242
243static inline int ext4_journal_force_commit(journal_t *journal)
244{
Frank Mayhar03901312009-01-07 00:06:22 -0500245 if (journal)
246 return jbd2_journal_force_commit(journal);
247 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700248}
249
Jan Kara678aaf42008-07-11 19:27:31 -0400250static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
251{
Frank Mayhar03901312009-01-07 00:06:22 -0500252 if (ext4_handle_valid(handle))
253 return jbd2_journal_file_inode(handle, &EXT4_I(inode)->jinode);
254 return 0;
Jan Kara678aaf42008-07-11 19:27:31 -0400255}
256
Dave Kleikamp470decc2006-10-11 01:20:57 -0700257/* super.c */
258int ext4_force_commit(struct super_block *sb);
259
260static inline int ext4_should_journal_data(struct inode *inode)
261{
Frank Mayhar03901312009-01-07 00:06:22 -0500262 if (EXT4_JOURNAL(inode) == NULL)
263 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700264 if (!S_ISREG(inode->i_mode))
265 return 1;
266 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
267 return 1;
268 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
269 return 1;
270 return 0;
271}
272
273static inline int ext4_should_order_data(struct inode *inode)
274{
Frank Mayhar03901312009-01-07 00:06:22 -0500275 if (EXT4_JOURNAL(inode) == NULL)
276 return 0;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700277 if (!S_ISREG(inode->i_mode))
278 return 0;
279 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
280 return 0;
281 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
282 return 1;
283 return 0;
284}
285
286static inline int ext4_should_writeback_data(struct inode *inode)
287{
288 if (!S_ISREG(inode->i_mode))
289 return 0;
Theodore Ts'o5adfee92009-07-08 17:11:24 -0400290 if (EXT4_JOURNAL(inode) == NULL)
291 return 1;
Dave Kleikamp470decc2006-10-11 01:20:57 -0700292 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
293 return 0;
294 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
295 return 1;
296 return 0;
297}
298
Christoph Hellwig3dcf5452008-04-29 18:13:32 -0400299#endif /* _EXT4_JBD2_H */