ext4_jbd2.h 10.6 KB
Newer Older
1
/*
2
 * ext4_jbd2.h
3
4
5
6
7
8
9
10
11
12
13
14
 *
 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
 *
 * Copyright 1998--1999 Red Hat corp --- All Rights Reserved
 *
 * This file is part of the Linux kernel and is made available under
 * the terms of the GNU General Public License, version 2, or at your
 * option, any later version, incorporated herein by reference.
 *
 * Ext4-specific journaling extensions.
 */

15
16
#ifndef _EXT4_JBD2_H
#define _EXT4_JBD2_H
17
18

#include <linux/fs.h>
19
#include <linux/jbd2.h>
20
#include "ext4.h"
21
22
23
24
25
26
27
28

#define EXT4_JOURNAL(inode)	(EXT4_SB((inode)->i_sb)->s_journal)

/* Define the number of blocks we need to account to a transaction to
 * modify one block of data.
 *
 * We may have to touch one inode, one bitmap buffer, up to three
 * indirection blocks, the group and superblock summaries, and the data
29
30
 * block to complete the transaction.
 *
31
32
 * For extents-enabled fs we may have to allocate and modify up to
 * 5 levels of tree + root which are stored in the inode. */
33

34
#define EXT4_SINGLEDATA_TRANS_BLOCKS(sb)				\
35
36
	(EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS)   \
	 ? 27U : 8U)
37
38
39
40
41
42
43
44
45
46
47
48
49

/* Extended attribute operations touch at most two data buffers,
 * two bitmap buffers, and two group summaries, in addition to the inode
 * and the superblock, which are already accounted for. */

#define EXT4_XATTR_TRANS_BLOCKS		6U

/* Define the minimum size for a transaction which modifies data.  This
 * needs to take into account the fact that we may end up modifying two
 * quota files too (one for the group, one for the user quota).  The
 * superblock only gets updated once, of course, so don't bother
 * 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 + \
Dmitry Monakhov's avatar
Dmitry Monakhov committed
52
					 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
53

54
55
56
57
58
59
/*
 * Define the number of metadata blocks we need to account to modify data.
 *
 * This include super block, inode block, quota blocks and xattr blocks
 */
#define EXT4_META_TRANS_BLOCKS(sb)	(EXT4_XATTR_TRANS_BLOCKS + \
Dmitry Monakhov's avatar
Dmitry Monakhov committed
60
					EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
61

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/* Delete operations potentially hit one directory's namespace plus an
 * entire inode, plus arbitrary amounts of bitmap/indirection data.  Be
 * generous.  We can grow the delete transaction later if necessary. */

#define EXT4_DELETE_TRANS_BLOCKS(sb)	(2 * EXT4_DATA_TRANS_BLOCKS(sb) + 64)

/* Define an arbitrary limit for the amount of data we will anticipate
 * writing to any given transaction.  For unbounded transactions such as
 * write(2) and truncate(2) we can write more than this, but we always
 * start off at the maximum transaction size and grow the transaction
 * optimistically as we go. */

#define EXT4_MAX_TRANS_DATA		64U

/* We break up a large truncate or write transaction once the handle's
 * buffer credits gets this low, we need either to extend the
 * transaction or to start a new one.  Reserve enough space here for
 * inode, bitmap, superblock, group and indirection updates for at least
 * one block, plus two quota updates.  Quota allocations are not
 * needed. */

#define EXT4_RESERVE_TRANS_BLOCKS	12U

#define EXT4_INDEX_EXTRA_TRANS_BLOCKS	8

#ifdef CONFIG_QUOTA
/* Amount of blocks needed for quota update - we know that the structure was
 * allocated so we need to update only inode+data */
#define EXT4_QUOTA_TRANS_BLOCKS(sb) (test_opt(sb, QUOTA) ? 2 : 0)
/* Amount of blocks needed for quota insert/delete - we do some block writes
 * but inode, sb and group updates are done only once */
#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)
Dmitry Monakhov's avatar
Dmitry Monakhov committed
95

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)
98
99
100
101
102
#else
#define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
#define EXT4_QUOTA_INIT_BLOCKS(sb) 0
#define EXT4_QUOTA_DEL_BLOCKS(sb) 0
#endif
Dmitry Monakhov's avatar
Dmitry Monakhov committed
103
104
105
#define EXT4_MAXQUOTAS_TRANS_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_TRANS_BLOCKS(sb))
#define EXT4_MAXQUOTAS_INIT_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_INIT_BLOCKS(sb))
#define EXT4_MAXQUOTAS_DEL_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_DEL_BLOCKS(sb))
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

int
ext4_mark_iloc_dirty(handle_t *handle,
		     struct inode *inode,
		     struct ext4_iloc *iloc);

/*
 * On success, We end up with an outstanding reference count against
 * iloc->bh.  This _must_ be cleaned up later.
 */

int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
			struct ext4_iloc *iloc);

int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);

/*
123
 * Wrapper functions with which ext4 calls into JBD.
124
 */
125
126
void ext4_journal_abort_handle(const char *caller, unsigned int line,
			       const char *err_fn,
127
		struct buffer_head *bh, handle_t *handle, int err);
128

129
130
int __ext4_journal_get_undo_access(const char *where, unsigned int line,
				   handle_t *handle, struct buffer_head *bh);
131

132
133
int __ext4_journal_get_write_access(const char *where, unsigned int line,
				    handle_t *handle, struct buffer_head *bh);
134

135
136
137
int __ext4_forget(const char *where, unsigned int line, handle_t *handle,
		  int is_metadata, struct inode *inode,
		  struct buffer_head *bh, ext4_fsblk_t blocknr);
138

139
int __ext4_journal_get_create_access(const char *where, unsigned int line,
140
				handle_t *handle, struct buffer_head *bh);
141

142
143
144
int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
				 handle_t *handle, struct inode *inode,
				 struct buffer_head *bh);
145

146
147
int __ext4_handle_dirty_super(const char *where, unsigned int line,
			      handle_t *handle, struct super_block *sb);
Theodore Ts'o's avatar
Theodore Ts'o committed
148

149
#define ext4_journal_get_undo_access(handle, bh) \
150
	__ext4_journal_get_undo_access(__func__, __LINE__, (handle), (bh))
151
#define ext4_journal_get_write_access(handle, bh) \
152
	__ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
153
#define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
154
155
	__ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
		      (bh), (block_nr))
156
#define ext4_journal_get_create_access(handle, bh) \
157
	__ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
158
#define ext4_handle_dirty_metadata(handle, inode, bh) \
159
160
	__ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
				     (bh))
Theodore Ts'o's avatar
Theodore Ts'o committed
161
#define ext4_handle_dirty_super(handle, sb) \
162
	__ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))
163
164

handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks);
165
int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle);
166

167
#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
168

169
170
/* Note:  Do not use this for NULL handles.  This is only to determine if
 * a properly allocated handle is using a journal or not. */
171
172
static inline int ext4_handle_valid(handle_t *handle)
{
173
	if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
		return 0;
	return 1;
}

static inline void ext4_handle_sync(handle_t *handle)
{
	if (ext4_handle_valid(handle))
		handle->h_sync = 1;
}

static inline void ext4_handle_release_buffer(handle_t *handle,
						struct buffer_head *bh)
{
	if (ext4_handle_valid(handle))
		jbd2_journal_release_buffer(handle, bh);
}

static inline int ext4_handle_is_aborted(handle_t *handle)
{
	if (ext4_handle_valid(handle))
		return is_handle_aborted(handle);
	return 0;
}

static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
{
	if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
		return 0;
	return 1;
}

static inline void ext4_journal_release_buffer(handle_t *handle,
						struct buffer_head *bh)
{
	if (ext4_handle_valid(handle))
		jbd2_journal_release_buffer(handle, bh);
}

212
213
214
215
216
217
static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks)
{
	return ext4_journal_start_sb(inode->i_sb, nblocks);
}

#define ext4_journal_stop(handle) \
218
	__ext4_journal_stop(__func__, __LINE__, (handle))
219
220
221
222
223
224
225
226

static inline handle_t *ext4_journal_current_handle(void)
{
	return journal_current_handle();
}

static inline int ext4_journal_extend(handle_t *handle, int nblocks)
{
227
228
229
	if (ext4_handle_valid(handle))
		return jbd2_journal_extend(handle, nblocks);
	return 0;
230
231
232
233
}

static inline int ext4_journal_restart(handle_t *handle, int nblocks)
{
234
235
236
	if (ext4_handle_valid(handle))
		return jbd2_journal_restart(handle, nblocks);
	return 0;
237
238
239
240
}

static inline int ext4_journal_blocks_per_page(struct inode *inode)
{
241
242
243
	if (EXT4_JOURNAL(inode) != NULL)
		return jbd2_journal_blocks_per_page(inode);
	return 0;
244
245
246
247
}

static inline int ext4_journal_force_commit(journal_t *journal)
{
248
249
250
	if (journal)
		return jbd2_journal_force_commit(journal);
	return 0;
251
252
}

253
254
static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
{
255
	if (ext4_handle_valid(handle))
256
		return jbd2_journal_file_inode(handle, EXT4_I(inode)->jinode);
257
	return 0;
258
259
}

260
261
262
263
264
265
266
267
268
269
270
271
272
static inline void ext4_update_inode_fsync_trans(handle_t *handle,
						 struct inode *inode,
						 int datasync)
{
	struct ext4_inode_info *ei = EXT4_I(inode);

	if (ext4_handle_valid(handle)) {
		ei->i_sync_tid = handle->h_transaction->t_tid;
		if (datasync)
			ei->i_datasync_tid = handle->h_transaction->t_tid;
	}
}

273
274
275
276
277
/* super.c */
int ext4_force_commit(struct super_block *sb);

static inline int ext4_should_journal_data(struct inode *inode)
{
278
279
	if (EXT4_JOURNAL(inode) == NULL)
		return 0;
280
281
282
283
	if (!S_ISREG(inode->i_mode))
		return 1;
	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
		return 1;
284
	if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
285
286
287
288
289
290
		return 1;
	return 0;
}

static inline int ext4_should_order_data(struct inode *inode)
{
291
292
	if (EXT4_JOURNAL(inode) == NULL)
		return 0;
293
294
	if (!S_ISREG(inode->i_mode))
		return 0;
295
	if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
296
297
298
299
300
301
302
303
304
305
		return 0;
	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
		return 1;
	return 0;
}

static inline int ext4_should_writeback_data(struct inode *inode)
{
	if (!S_ISREG(inode->i_mode))
		return 0;
306
307
	if (EXT4_JOURNAL(inode) == NULL)
		return 1;
308
	if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA))
309
310
311
312
313
314
		return 0;
	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
		return 1;
	return 0;
}

315
316
317
318
/*
 * This function controls whether or not we should try to go down the
 * dioread_nolock code paths, which makes it safe to avoid taking
 * i_mutex for direct I/O reads.  This only works for extent-based
319
320
321
322
 * files, and it doesn't work if data journaling is enabled, since the
 * dioread_nolock code uses b_private to pass information back to the
 * I/O completion handler, and this conflicts with the jbd's use of
 * b_private.
323
324
325
326
327
328
329
 */
static inline int ext4_should_dioread_nolock(struct inode *inode)
{
	if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
		return 0;
	if (!S_ISREG(inode->i_mode))
		return 0;
330
	if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
331
332
333
334
335
336
		return 0;
	if (ext4_should_journal_data(inode))
		return 0;
	return 1;
}

337
#endif	/* _EXT4_JBD2_H */