xref: /openbmc/linux/fs/ext4/ext4_jbd2.c (revision 82df5b73)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Interface between ext4 and JBD
4  */
5 
6 #include "ext4_jbd2.h"
7 
8 #include <trace/events/ext4.h>
9 
10 int ext4_inode_journal_mode(struct inode *inode)
11 {
12 	if (EXT4_JOURNAL(inode) == NULL)
13 		return EXT4_INODE_WRITEBACK_DATA_MODE;	/* writeback */
14 	/* We do not support data journalling with delayed allocation */
15 	if (!S_ISREG(inode->i_mode) ||
16 	    ext4_test_inode_flag(inode, EXT4_INODE_EA_INODE) ||
17 	    test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA ||
18 	    (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA) &&
19 	    !test_opt(inode->i_sb, DELALLOC))) {
20 		/* We do not support data journalling for encrypted data */
21 		if (S_ISREG(inode->i_mode) && IS_ENCRYPTED(inode))
22 			return EXT4_INODE_ORDERED_DATA_MODE;  /* ordered */
23 		return EXT4_INODE_JOURNAL_DATA_MODE;	/* journal data */
24 	}
25 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
26 		return EXT4_INODE_ORDERED_DATA_MODE;	/* ordered */
27 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
28 		return EXT4_INODE_WRITEBACK_DATA_MODE;	/* writeback */
29 	BUG();
30 }
31 
32 /* Just increment the non-pointer handle value */
33 static handle_t *ext4_get_nojournal(void)
34 {
35 	handle_t *handle = current->journal_info;
36 	unsigned long ref_cnt = (unsigned long)handle;
37 
38 	BUG_ON(ref_cnt >= EXT4_NOJOURNAL_MAX_REF_COUNT);
39 
40 	ref_cnt++;
41 	handle = (handle_t *)ref_cnt;
42 
43 	current->journal_info = handle;
44 	return handle;
45 }
46 
47 
48 /* Decrement the non-pointer handle value */
49 static void ext4_put_nojournal(handle_t *handle)
50 {
51 	unsigned long ref_cnt = (unsigned long)handle;
52 
53 	BUG_ON(ref_cnt == 0);
54 
55 	ref_cnt--;
56 	handle = (handle_t *)ref_cnt;
57 
58 	current->journal_info = handle;
59 }
60 
61 /*
62  * Wrappers for jbd2_journal_start/end.
63  */
64 static int ext4_journal_check_start(struct super_block *sb)
65 {
66 	journal_t *journal;
67 
68 	might_sleep();
69 
70 	if (unlikely(ext4_forced_shutdown(EXT4_SB(sb))))
71 		return -EIO;
72 
73 	if (sb_rdonly(sb))
74 		return -EROFS;
75 	WARN_ON(sb->s_writers.frozen == SB_FREEZE_COMPLETE);
76 	journal = EXT4_SB(sb)->s_journal;
77 	/*
78 	 * Special case here: if the journal has aborted behind our
79 	 * backs (eg. EIO in the commit thread), then we still need to
80 	 * take the FS itself readonly cleanly.
81 	 */
82 	if (journal && is_journal_aborted(journal)) {
83 		ext4_abort(sb, -journal->j_errno, "Detected aborted journal");
84 		return -EROFS;
85 	}
86 	return 0;
87 }
88 
89 handle_t *__ext4_journal_start_sb(struct super_block *sb, unsigned int line,
90 				  int type, int blocks, int rsv_blocks,
91 				  int revoke_creds)
92 {
93 	journal_t *journal;
94 	int err;
95 
96 	trace_ext4_journal_start(sb, blocks, rsv_blocks, revoke_creds,
97 				 _RET_IP_);
98 	err = ext4_journal_check_start(sb);
99 	if (err < 0)
100 		return ERR_PTR(err);
101 
102 	journal = EXT4_SB(sb)->s_journal;
103 	if (!journal)
104 		return ext4_get_nojournal();
105 	return jbd2__journal_start(journal, blocks, rsv_blocks, revoke_creds,
106 				   GFP_NOFS, type, line);
107 }
108 
109 int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle)
110 {
111 	struct super_block *sb;
112 	int err;
113 	int rc;
114 
115 	if (!ext4_handle_valid(handle)) {
116 		ext4_put_nojournal(handle);
117 		return 0;
118 	}
119 
120 	err = handle->h_err;
121 	if (!handle->h_transaction) {
122 		rc = jbd2_journal_stop(handle);
123 		return err ? err : rc;
124 	}
125 
126 	sb = handle->h_transaction->t_journal->j_private;
127 	rc = jbd2_journal_stop(handle);
128 
129 	if (!err)
130 		err = rc;
131 	if (err)
132 		__ext4_std_error(sb, where, line, err);
133 	return err;
134 }
135 
136 handle_t *__ext4_journal_start_reserved(handle_t *handle, unsigned int line,
137 					int type)
138 {
139 	struct super_block *sb;
140 	int err;
141 
142 	if (!ext4_handle_valid(handle))
143 		return ext4_get_nojournal();
144 
145 	sb = handle->h_journal->j_private;
146 	trace_ext4_journal_start_reserved(sb,
147 				jbd2_handle_buffer_credits(handle), _RET_IP_);
148 	err = ext4_journal_check_start(sb);
149 	if (err < 0) {
150 		jbd2_journal_free_reserved(handle);
151 		return ERR_PTR(err);
152 	}
153 
154 	err = jbd2_journal_start_reserved(handle, type, line);
155 	if (err < 0)
156 		return ERR_PTR(err);
157 	return handle;
158 }
159 
160 int __ext4_journal_ensure_credits(handle_t *handle, int check_cred,
161 				  int extend_cred, int revoke_cred)
162 {
163 	if (!ext4_handle_valid(handle))
164 		return 0;
165 	if (jbd2_handle_buffer_credits(handle) >= check_cred &&
166 	    handle->h_revoke_credits >= revoke_cred)
167 		return 0;
168 	extend_cred = max(0, extend_cred - jbd2_handle_buffer_credits(handle));
169 	revoke_cred = max(0, revoke_cred - handle->h_revoke_credits);
170 	return ext4_journal_extend(handle, extend_cred, revoke_cred);
171 }
172 
173 static void ext4_journal_abort_handle(const char *caller, unsigned int line,
174 				      const char *err_fn,
175 				      struct buffer_head *bh,
176 				      handle_t *handle, int err)
177 {
178 	char nbuf[16];
179 	const char *errstr = ext4_decode_error(NULL, err, nbuf);
180 
181 	BUG_ON(!ext4_handle_valid(handle));
182 
183 	if (bh)
184 		BUFFER_TRACE(bh, "abort");
185 
186 	if (!handle->h_err)
187 		handle->h_err = err;
188 
189 	if (is_handle_aborted(handle))
190 		return;
191 
192 	printk(KERN_ERR "EXT4-fs: %s:%d: aborting transaction: %s in %s\n",
193 	       caller, line, errstr, err_fn);
194 
195 	jbd2_journal_abort_handle(handle);
196 }
197 
198 int __ext4_journal_get_write_access(const char *where, unsigned int line,
199 				    handle_t *handle, struct buffer_head *bh)
200 {
201 	int err = 0;
202 
203 	might_sleep();
204 
205 	if (ext4_handle_valid(handle)) {
206 		err = jbd2_journal_get_write_access(handle, bh);
207 		if (err)
208 			ext4_journal_abort_handle(where, line, __func__, bh,
209 						  handle, err);
210 	}
211 	return err;
212 }
213 
214 /*
215  * The ext4 forget function must perform a revoke if we are freeing data
216  * which has been journaled.  Metadata (eg. indirect blocks) must be
217  * revoked in all cases.
218  *
219  * "bh" may be NULL: a metadata block may have been freed from memory
220  * but there may still be a record of it in the journal, and that record
221  * still needs to be revoked.
222  *
223  * If the handle isn't valid we're not journaling, but we still need to
224  * call into ext4_journal_revoke() to put the buffer head.
225  */
226 int __ext4_forget(const char *where, unsigned int line, handle_t *handle,
227 		  int is_metadata, struct inode *inode,
228 		  struct buffer_head *bh, ext4_fsblk_t blocknr)
229 {
230 	int err;
231 
232 	might_sleep();
233 
234 	trace_ext4_forget(inode, is_metadata, blocknr);
235 	BUFFER_TRACE(bh, "enter");
236 
237 	jbd_debug(4, "forgetting bh %p: is_metadata = %d, mode %o, "
238 		  "data mode %x\n",
239 		  bh, is_metadata, inode->i_mode,
240 		  test_opt(inode->i_sb, DATA_FLAGS));
241 
242 	/* In the no journal case, we can just do a bforget and return */
243 	if (!ext4_handle_valid(handle)) {
244 		bforget(bh);
245 		return 0;
246 	}
247 
248 	/* Never use the revoke function if we are doing full data
249 	 * journaling: there is no need to, and a V1 superblock won't
250 	 * support it.  Otherwise, only skip the revoke on un-journaled
251 	 * data blocks. */
252 
253 	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA ||
254 	    (!is_metadata && !ext4_should_journal_data(inode))) {
255 		if (bh) {
256 			BUFFER_TRACE(bh, "call jbd2_journal_forget");
257 			err = jbd2_journal_forget(handle, bh);
258 			if (err)
259 				ext4_journal_abort_handle(where, line, __func__,
260 							  bh, handle, err);
261 			return err;
262 		}
263 		return 0;
264 	}
265 
266 	/*
267 	 * data!=journal && (is_metadata || should_journal_data(inode))
268 	 */
269 	BUFFER_TRACE(bh, "call jbd2_journal_revoke");
270 	err = jbd2_journal_revoke(handle, blocknr, bh);
271 	if (err) {
272 		ext4_journal_abort_handle(where, line, __func__,
273 					  bh, handle, err);
274 		__ext4_abort(inode->i_sb, where, line, -err,
275 			   "error %d when attempting revoke", err);
276 	}
277 	BUFFER_TRACE(bh, "exit");
278 	return err;
279 }
280 
281 int __ext4_journal_get_create_access(const char *where, unsigned int line,
282 				handle_t *handle, struct buffer_head *bh)
283 {
284 	int err = 0;
285 
286 	if (ext4_handle_valid(handle)) {
287 		err = jbd2_journal_get_create_access(handle, bh);
288 		if (err)
289 			ext4_journal_abort_handle(where, line, __func__,
290 						  bh, handle, err);
291 	}
292 	return err;
293 }
294 
295 int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
296 				 handle_t *handle, struct inode *inode,
297 				 struct buffer_head *bh)
298 {
299 	int err = 0;
300 
301 	might_sleep();
302 
303 	set_buffer_meta(bh);
304 	set_buffer_prio(bh);
305 	if (ext4_handle_valid(handle)) {
306 		err = jbd2_journal_dirty_metadata(handle, bh);
307 		/* Errors can only happen due to aborted journal or a nasty bug */
308 		if (!is_handle_aborted(handle) && WARN_ON_ONCE(err)) {
309 			ext4_journal_abort_handle(where, line, __func__, bh,
310 						  handle, err);
311 			if (inode == NULL) {
312 				pr_err("EXT4: jbd2_journal_dirty_metadata "
313 				       "failed: handle type %u started at "
314 				       "line %u, credits %u/%u, errcode %d",
315 				       handle->h_type,
316 				       handle->h_line_no,
317 				       handle->h_requested_credits,
318 				       jbd2_handle_buffer_credits(handle), err);
319 				return err;
320 			}
321 			ext4_error_inode(inode, where, line,
322 					 bh->b_blocknr,
323 					 "journal_dirty_metadata failed: "
324 					 "handle type %u started at line %u, "
325 					 "credits %u/%u, errcode %d",
326 					 handle->h_type,
327 					 handle->h_line_no,
328 					 handle->h_requested_credits,
329 					 jbd2_handle_buffer_credits(handle),
330 					 err);
331 		}
332 	} else {
333 		set_buffer_uptodate(bh);
334 		if (inode)
335 			mark_buffer_dirty_inode(bh, inode);
336 		else
337 			mark_buffer_dirty(bh);
338 		if (inode && inode_needs_sync(inode)) {
339 			sync_dirty_buffer(bh);
340 			if (buffer_req(bh) && !buffer_uptodate(bh)) {
341 				ext4_error_inode_err(inode, where, line,
342 						     bh->b_blocknr, EIO,
343 					"IO error syncing itable block");
344 				err = -EIO;
345 			}
346 		}
347 	}
348 	return err;
349 }
350 
351 int __ext4_handle_dirty_super(const char *where, unsigned int line,
352 			      handle_t *handle, struct super_block *sb)
353 {
354 	struct buffer_head *bh = EXT4_SB(sb)->s_sbh;
355 	int err = 0;
356 
357 	ext4_superblock_csum_set(sb);
358 	if (ext4_handle_valid(handle)) {
359 		err = jbd2_journal_dirty_metadata(handle, bh);
360 		if (err)
361 			ext4_journal_abort_handle(where, line, __func__,
362 						  bh, handle, err);
363 	} else
364 		mark_buffer_dirty(bh);
365 	return err;
366 }
367