xref: /linux/fs/ext4/ext4_jbd2.h (revision 8fa5723aa7e053d498336b48448b292fc2e0458b)
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 		|| test_opt(sb, EXTENTS) ? 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 					 2*EXT4_QUOTA_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 					2*EXT4_QUOTA_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 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)
95 #define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\
96 		(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0)
97 #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 
103 int
104 ext4_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 
113 int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
114 			struct ext4_iloc *iloc);
115 
116 int 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 
125 static inline void ext4_journal_release_buffer(handle_t *handle,
126 						struct buffer_head *bh)
127 {
128 	jbd2_journal_release_buffer(handle, bh);
129 }
130 
131 void ext4_journal_abort_handle(const char *caller, const char *err_fn,
132 		struct buffer_head *bh, handle_t *handle, int err);
133 
134 int __ext4_journal_get_undo_access(const char *where, handle_t *handle,
135 				struct buffer_head *bh);
136 
137 int __ext4_journal_get_write_access(const char *where, handle_t *handle,
138 				struct buffer_head *bh);
139 
140 int __ext4_journal_forget(const char *where, handle_t *handle,
141 				struct buffer_head *bh);
142 
143 int __ext4_journal_revoke(const char *where, handle_t *handle,
144 				ext4_fsblk_t blocknr, struct buffer_head *bh);
145 
146 int __ext4_journal_get_create_access(const char *where,
147 				handle_t *handle, struct buffer_head *bh);
148 
149 int __ext4_journal_dirty_metadata(const char *where,
150 				handle_t *handle, struct buffer_head *bh);
151 
152 #define ext4_journal_get_undo_access(handle, bh) \
153 	__ext4_journal_get_undo_access(__func__, (handle), (bh))
154 #define ext4_journal_get_write_access(handle, bh) \
155 	__ext4_journal_get_write_access(__func__, (handle), (bh))
156 #define ext4_journal_revoke(handle, blocknr, bh) \
157 	__ext4_journal_revoke(__func__, (handle), (blocknr), (bh))
158 #define ext4_journal_get_create_access(handle, bh) \
159 	__ext4_journal_get_create_access(__func__, (handle), (bh))
160 #define ext4_journal_dirty_metadata(handle, bh) \
161 	__ext4_journal_dirty_metadata(__func__, (handle), (bh))
162 #define ext4_journal_forget(handle, bh) \
163 	__ext4_journal_forget(__func__, (handle), (bh))
164 
165 handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
166 int __ext4_journal_stop(const char *where, handle_t *handle);
167 
168 static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks)
169 {
170 	return ext4_journal_start_sb(inode->i_sb, nblocks);
171 }
172 
173 #define ext4_journal_stop(handle) \
174 	__ext4_journal_stop(__func__, (handle))
175 
176 static inline handle_t *ext4_journal_current_handle(void)
177 {
178 	return journal_current_handle();
179 }
180 
181 static inline int ext4_journal_extend(handle_t *handle, int nblocks)
182 {
183 	return jbd2_journal_extend(handle, nblocks);
184 }
185 
186 static inline int ext4_journal_restart(handle_t *handle, int nblocks)
187 {
188 	return jbd2_journal_restart(handle, nblocks);
189 }
190 
191 static inline int ext4_journal_blocks_per_page(struct inode *inode)
192 {
193 	return jbd2_journal_blocks_per_page(inode);
194 }
195 
196 static inline int ext4_journal_force_commit(journal_t *journal)
197 {
198 	return jbd2_journal_force_commit(journal);
199 }
200 
201 static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
202 {
203 	return jbd2_journal_file_inode(handle, &EXT4_I(inode)->jinode);
204 }
205 
206 /* super.c */
207 int ext4_force_commit(struct super_block *sb);
208 
209 static inline int ext4_should_journal_data(struct inode *inode)
210 {
211 	if (!S_ISREG(inode->i_mode))
212 		return 1;
213 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
214 		return 1;
215 	if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
216 		return 1;
217 	return 0;
218 }
219 
220 static inline int ext4_should_order_data(struct inode *inode)
221 {
222 	if (!S_ISREG(inode->i_mode))
223 		return 0;
224 	if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
225 		return 0;
226 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
227 		return 1;
228 	return 0;
229 }
230 
231 static inline int ext4_should_writeback_data(struct inode *inode)
232 {
233 	if (!S_ISREG(inode->i_mode))
234 		return 0;
235 	if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
236 		return 0;
237 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
238 		return 1;
239 	return 0;
240 }
241 
242 #endif	/* _EXT4_JBD2_H */
243