]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/ext4/ext4_jbd2.h
ext4: ext4_get_reserved_space() must return bytes instead of blocks
[mirror_ubuntu-bionic-kernel.git] / fs / ext4 / ext4_jbd2.h
CommitLineData
470decc6 1/*
3dcf5451 2 * ext4_jbd2.h
470decc6
DK
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
3dcf5451
CH
15#ifndef _EXT4_JBD2_H
16#define _EXT4_JBD2_H
470decc6
DK
17
18#include <linux/fs.h>
f7f4bccb 19#include <linux/jbd2.h>
3dcf5451 20#include "ext4.h"
470decc6
DK
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
a86c6181
AT
29 * block to complete the transaction.
30 *
d0d856e8
RD
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. */
470decc6 33
a86c6181 34#define EXT4_SINGLEDATA_TRANS_BLOCKS(sb) \
83982b6f
TT
35 (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS) \
36 ? 27U : 8U)
470decc6
DK
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
a86c6181 50#define EXT4_DATA_TRANS_BLOCKS(sb) (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
470decc6
DK
51 EXT4_XATTR_TRANS_BLOCKS - 2 + \
52 2*EXT4_QUOTA_TRANS_BLOCKS(sb))
53
a02908f1
MC
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
470decc6
DK
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*\
a86c6181 94 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_INIT_REWRITE) : 0)
470decc6 95#define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\
a86c6181 96 (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0)
470decc6
DK
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
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/*
e4684b3f 119 * Wrapper functions with which ext4 calls into JBD.
470decc6 120 */
8984d137
AM
121void ext4_journal_abort_handle(const char *caller, const char *err_fn,
122 struct buffer_head *bh, handle_t *handle, int err);
470decc6 123
8984d137
AM
124int __ext4_journal_get_undo_access(const char *where, handle_t *handle,
125 struct buffer_head *bh);
470decc6 126
8984d137
AM
127int __ext4_journal_get_write_access(const char *where, handle_t *handle,
128 struct buffer_head *bh);
470decc6 129
d6797d14
TT
130int __ext4_forget(const char *where, handle_t *handle, int is_metadata,
131 struct inode *inode, struct buffer_head *bh,
132 ext4_fsblk_t blocknr);
133
8984d137
AM
134int __ext4_journal_get_create_access(const char *where,
135 handle_t *handle, struct buffer_head *bh);
470decc6 136
0390131b
FM
137int __ext4_handle_dirty_metadata(const char *where, handle_t *handle,
138 struct inode *inode, struct buffer_head *bh);
470decc6
DK
139
140#define ext4_journal_get_undo_access(handle, bh) \
4db9c54a 141 __ext4_journal_get_undo_access(__func__, (handle), (bh))
470decc6 142#define ext4_journal_get_write_access(handle, bh) \
4db9c54a 143 __ext4_journal_get_write_access(__func__, (handle), (bh))
d6797d14
TT
144#define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
145 __ext4_forget(__func__, (handle), (is_metadata), (inode), (bh),\
146 (block_nr))
470decc6 147#define ext4_journal_get_create_access(handle, bh) \
4db9c54a 148 __ext4_journal_get_create_access(__func__, (handle), (bh))
0390131b
FM
149#define ext4_handle_dirty_metadata(handle, inode, bh) \
150 __ext4_handle_dirty_metadata(__func__, (handle), (inode), (bh))
470decc6 151
470decc6
DK
152handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
153int __ext4_journal_stop(const char *where, handle_t *handle);
154
d3d1faf6 155#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
0390131b 156
d3d1faf6
CW
157/* Note: Do not use this for NULL handles. This is only to determine if
158 * a properly allocated handle is using a journal or not. */
0390131b
FM
159static inline int ext4_handle_valid(handle_t *handle)
160{
d3d1faf6 161 if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
0390131b
FM
162 return 0;
163 return 1;
164}
165
166static inline void ext4_handle_sync(handle_t *handle)
167{
168 if (ext4_handle_valid(handle))
169 handle->h_sync = 1;
170}
171
172static inline void ext4_handle_release_buffer(handle_t *handle,
173 struct buffer_head *bh)
174{
175 if (ext4_handle_valid(handle))
176 jbd2_journal_release_buffer(handle, bh);
177}
178
179static inline int ext4_handle_is_aborted(handle_t *handle)
180{
181 if (ext4_handle_valid(handle))
182 return is_handle_aborted(handle);
183 return 0;
184}
185
186static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
187{
188 if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
189 return 0;
190 return 1;
191}
192
193static inline void ext4_journal_release_buffer(handle_t *handle,
194 struct buffer_head *bh)
195{
196 if (ext4_handle_valid(handle))
197 jbd2_journal_release_buffer(handle, bh);
198}
199
470decc6
DK
200static 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) \
4db9c54a 206 __ext4_journal_stop(__func__, (handle))
470decc6
DK
207
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{
0390131b
FM
215 if (ext4_handle_valid(handle))
216 return jbd2_journal_extend(handle, nblocks);
217 return 0;
470decc6
DK
218}
219
220static inline int ext4_journal_restart(handle_t *handle, int nblocks)
221{
0390131b
FM
222 if (ext4_handle_valid(handle))
223 return jbd2_journal_restart(handle, nblocks);
224 return 0;
470decc6
DK
225}
226
227static inline int ext4_journal_blocks_per_page(struct inode *inode)
228{
0390131b
FM
229 if (EXT4_JOURNAL(inode) != NULL)
230 return jbd2_journal_blocks_per_page(inode);
231 return 0;
470decc6
DK
232}
233
234static inline int ext4_journal_force_commit(journal_t *journal)
235{
0390131b
FM
236 if (journal)
237 return jbd2_journal_force_commit(journal);
238 return 0;
470decc6
DK
239}
240
678aaf48
JK
241static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
242{
0390131b
FM
243 if (ext4_handle_valid(handle))
244 return jbd2_journal_file_inode(handle, &EXT4_I(inode)->jinode);
245 return 0;
678aaf48
JK
246}
247
470decc6
DK
248/* super.c */
249int ext4_force_commit(struct super_block *sb);
250
251static inline int ext4_should_journal_data(struct inode *inode)
252{
0390131b
FM
253 if (EXT4_JOURNAL(inode) == NULL)
254 return 0;
470decc6
DK
255 if (!S_ISREG(inode->i_mode))
256 return 1;
257 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
258 return 1;
259 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
260 return 1;
261 return 0;
262}
263
264static inline int ext4_should_order_data(struct inode *inode)
265{
0390131b
FM
266 if (EXT4_JOURNAL(inode) == NULL)
267 return 0;
470decc6
DK
268 if (!S_ISREG(inode->i_mode))
269 return 0;
270 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
271 return 0;
272 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
273 return 1;
274 return 0;
275}
276
277static inline int ext4_should_writeback_data(struct inode *inode)
278{
279 if (!S_ISREG(inode->i_mode))
280 return 0;
5adfee9c
TT
281 if (EXT4_JOURNAL(inode) == NULL)
282 return 1;
470decc6
DK
283 if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL)
284 return 0;
285 if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
286 return 1;
287 return 0;
288}
289
3dcf5451 290#endif /* _EXT4_JBD2_H */