blob: ebe5f423f8f2c6358cc104f57ca645561257021c [file] [log] [blame]
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07001// SPDX-License-Identifier: GPL-2.0
2
3/*
4 * fs/ext4/fast_commit.c
5 *
6 * Written by Harshad Shirwadkar <harshadshirwadkar@gmail.com>
7 *
8 * Ext4 fast commits routines.
9 */
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -070010#include "ext4.h"
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -070011#include "ext4_jbd2.h"
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -070012#include "ext4_extents.h"
13#include "mballoc.h"
14
15/*
16 * Ext4 Fast Commits
17 * -----------------
18 *
19 * Ext4 fast commits implement fine grained journalling for Ext4.
20 *
21 * Fast commits are organized as a log of tag-length-value (TLV) structs. (See
22 * struct ext4_fc_tl). Each TLV contains some delta that is replayed TLV by
23 * TLV during the recovery phase. For the scenarios for which we currently
24 * don't have replay code, fast commit falls back to full commits.
25 * Fast commits record delta in one of the following three categories.
26 *
27 * (A) Directory entry updates:
28 *
29 * - EXT4_FC_TAG_UNLINK - records directory entry unlink
30 * - EXT4_FC_TAG_LINK - records directory entry link
31 * - EXT4_FC_TAG_CREAT - records inode and directory entry creation
32 *
33 * (B) File specific data range updates:
34 *
35 * - EXT4_FC_TAG_ADD_RANGE - records addition of new blocks to an inode
36 * - EXT4_FC_TAG_DEL_RANGE - records deletion of blocks from an inode
37 *
38 * (C) Inode metadata (mtime / ctime etc):
39 *
40 * - EXT4_FC_TAG_INODE - record the inode that should be replayed
41 * during recovery. Note that iblocks field is
42 * not replayed and instead derived during
43 * replay.
44 * Commit Operation
45 * ----------------
46 * With fast commits, we maintain all the directory entry operations in the
47 * order in which they are issued in an in-memory queue. This queue is flushed
48 * to disk during the commit operation. We also maintain a list of inodes
49 * that need to be committed during a fast commit in another in memory queue of
50 * inodes. During the commit operation, we commit in the following order:
51 *
52 * [1] Lock inodes for any further data updates by setting COMMITTING state
53 * [2] Submit data buffers of all the inodes
54 * [3] Wait for [2] to complete
55 * [4] Commit all the directory entry updates in the fast commit space
56 * [5] Commit all the changed inode structures
57 * [6] Write tail tag (this tag ensures the atomicity, please read the following
58 * section for more details).
59 * [7] Wait for [4], [5] and [6] to complete.
60 *
61 * All the inode updates must call ext4_fc_start_update() before starting an
62 * update. If such an ongoing update is present, fast commit waits for it to
63 * complete. The completion of such an update is marked by
64 * ext4_fc_stop_update().
65 *
66 * Fast Commit Ineligibility
67 * -------------------------
68 * Not all operations are supported by fast commits today (e.g extended
69 * attributes). Fast commit ineligiblity is marked by calling one of the
70 * two following functions:
71 *
72 * - ext4_fc_mark_ineligible(): This makes next fast commit operation to fall
73 * back to full commit. This is useful in case of transient errors.
74 *
75 * - ext4_fc_start_ineligible() and ext4_fc_stop_ineligible() - This makes all
76 * the fast commits happening between ext4_fc_start_ineligible() and
77 * ext4_fc_stop_ineligible() and one fast commit after the call to
78 * ext4_fc_stop_ineligible() to fall back to full commits. It is important to
79 * make one more fast commit to fall back to full commit after stop call so
80 * that it guaranteed that the fast commit ineligible operation contained
81 * within ext4_fc_start_ineligible() and ext4_fc_stop_ineligible() is
82 * followed by at least 1 full commit.
83 *
84 * Atomicity of commits
85 * --------------------
Harshad Shirwadkara7407622020-11-05 19:59:03 -080086 * In order to guarantee atomicity during the commit operation, fast commit
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -070087 * uses "EXT4_FC_TAG_TAIL" tag that marks a fast commit as complete. Tail
88 * tag contains CRC of the contents and TID of the transaction after which
89 * this fast commit should be applied. Recovery code replays fast commit
90 * logs only if there's at least 1 valid tail present. For every fast commit
91 * operation, there is 1 tail. This means, we may end up with multiple tails
92 * in the fast commit space. Here's an example:
93 *
94 * - Create a new file A and remove existing file B
95 * - fsync()
96 * - Append contents to file A
97 * - Truncate file A
98 * - fsync()
99 *
100 * The fast commit space at the end of above operations would look like this:
101 * [HEAD] [CREAT A] [UNLINK B] [TAIL] [ADD_RANGE A] [DEL_RANGE A] [TAIL]
102 * |<--- Fast Commit 1 --->|<--- Fast Commit 2 ---->|
103 *
104 * Replay code should thus check for all the valid tails in the FC area.
105 *
106 * TODOs
107 * -----
108 * 1) Make fast commit atomic updates more fine grained. Today, a fast commit
109 * eligible update must be protected within ext4_fc_start_update() and
110 * ext4_fc_stop_update(). These routines are called at much higher
111 * routines. This can be made more fine grained by combining with
112 * ext4_journal_start().
113 *
114 * 2) Same above for ext4_fc_start_ineligible() and ext4_fc_stop_ineligible()
115 *
116 * 3) Handle more ineligible cases.
117 */
118
119#include <trace/events/ext4.h>
120static struct kmem_cache *ext4_fc_dentry_cachep;
121
122static void ext4_end_buffer_io_sync(struct buffer_head *bh, int uptodate)
123{
124 BUFFER_TRACE(bh, "");
125 if (uptodate) {
126 ext4_debug("%s: Block %lld up-to-date",
127 __func__, bh->b_blocknr);
128 set_buffer_uptodate(bh);
129 } else {
130 ext4_debug("%s: Block %lld not up-to-date",
131 __func__, bh->b_blocknr);
132 clear_buffer_uptodate(bh);
133 }
134
135 unlock_buffer(bh);
136}
137
138static inline void ext4_fc_reset_inode(struct inode *inode)
139{
140 struct ext4_inode_info *ei = EXT4_I(inode);
141
142 ei->i_fc_lblk_start = 0;
143 ei->i_fc_lblk_len = 0;
144}
145
146void ext4_fc_init_inode(struct inode *inode)
147{
148 struct ext4_inode_info *ei = EXT4_I(inode);
149
150 ext4_fc_reset_inode(inode);
151 ext4_clear_inode_state(inode, EXT4_STATE_FC_COMMITTING);
152 INIT_LIST_HEAD(&ei->i_fc_list);
153 init_waitqueue_head(&ei->i_fc_wait);
154 atomic_set(&ei->i_fc_updates, 0);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700155}
156
Harshad Shirwadkarf6634e22020-11-05 19:59:02 -0800157/* This function must be called with sbi->s_fc_lock held. */
158static void ext4_fc_wait_committing_inode(struct inode *inode)
159{
160 wait_queue_head_t *wq;
161 struct ext4_inode_info *ei = EXT4_I(inode);
162
163#if (BITS_PER_LONG < 64)
164 DEFINE_WAIT_BIT(wait, &ei->i_state_flags,
165 EXT4_STATE_FC_COMMITTING);
166 wq = bit_waitqueue(&ei->i_state_flags,
167 EXT4_STATE_FC_COMMITTING);
168#else
169 DEFINE_WAIT_BIT(wait, &ei->i_flags,
170 EXT4_STATE_FC_COMMITTING);
171 wq = bit_waitqueue(&ei->i_flags,
172 EXT4_STATE_FC_COMMITTING);
173#endif
174 lockdep_assert_held(&EXT4_SB(inode->i_sb)->s_fc_lock);
175 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
176 spin_unlock(&EXT4_SB(inode->i_sb)->s_fc_lock);
177 schedule();
178 finish_wait(wq, &wait.wq_entry);
179}
180
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700181/*
182 * Inform Ext4's fast about start of an inode update
183 *
184 * This function is called by the high level call VFS callbacks before
185 * performing any inode update. This function blocks if there's an ongoing
186 * fast commit on the inode in question.
187 */
188void ext4_fc_start_update(struct inode *inode)
189{
190 struct ext4_inode_info *ei = EXT4_I(inode);
191
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700192 if (!test_opt2(inode->i_sb, JOURNAL_FAST_COMMIT) ||
193 (EXT4_SB(inode->i_sb)->s_mount_state & EXT4_FC_REPLAY))
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700194 return;
195
196restart:
197 spin_lock(&EXT4_SB(inode->i_sb)->s_fc_lock);
198 if (list_empty(&ei->i_fc_list))
199 goto out;
200
201 if (ext4_test_inode_state(inode, EXT4_STATE_FC_COMMITTING)) {
Harshad Shirwadkarf6634e22020-11-05 19:59:02 -0800202 ext4_fc_wait_committing_inode(inode);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700203 goto restart;
204 }
205out:
206 atomic_inc(&ei->i_fc_updates);
207 spin_unlock(&EXT4_SB(inode->i_sb)->s_fc_lock);
208}
209
210/*
211 * Stop inode update and wake up waiting fast commits if any.
212 */
213void ext4_fc_stop_update(struct inode *inode)
214{
215 struct ext4_inode_info *ei = EXT4_I(inode);
216
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700217 if (!test_opt2(inode->i_sb, JOURNAL_FAST_COMMIT) ||
218 (EXT4_SB(inode->i_sb)->s_mount_state & EXT4_FC_REPLAY))
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700219 return;
220
221 if (atomic_dec_and_test(&ei->i_fc_updates))
222 wake_up_all(&ei->i_fc_wait);
223}
224
225/*
226 * Remove inode from fast commit list. If the inode is being committed
227 * we wait until inode commit is done.
228 */
229void ext4_fc_del(struct inode *inode)
230{
231 struct ext4_inode_info *ei = EXT4_I(inode);
232
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700233 if (!test_opt2(inode->i_sb, JOURNAL_FAST_COMMIT) ||
234 (EXT4_SB(inode->i_sb)->s_mount_state & EXT4_FC_REPLAY))
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700235 return;
236
237restart:
238 spin_lock(&EXT4_SB(inode->i_sb)->s_fc_lock);
239 if (list_empty(&ei->i_fc_list)) {
240 spin_unlock(&EXT4_SB(inode->i_sb)->s_fc_lock);
241 return;
242 }
243
244 if (ext4_test_inode_state(inode, EXT4_STATE_FC_COMMITTING)) {
Harshad Shirwadkarf6634e22020-11-05 19:59:02 -0800245 ext4_fc_wait_committing_inode(inode);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700246 goto restart;
247 }
Harshad Shirwadkarf6634e22020-11-05 19:59:02 -0800248 list_del_init(&ei->i_fc_list);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700249 spin_unlock(&EXT4_SB(inode->i_sb)->s_fc_lock);
250}
251
252/*
253 * Mark file system as fast commit ineligible. This means that next commit
254 * operation would result in a full jbd2 commit.
255 */
256void ext4_fc_mark_ineligible(struct super_block *sb, int reason)
257{
258 struct ext4_sb_info *sbi = EXT4_SB(sb);
259
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700260 if (!test_opt2(sb, JOURNAL_FAST_COMMIT) ||
261 (EXT4_SB(sb)->s_mount_state & EXT4_FC_REPLAY))
262 return;
263
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700264 sbi->s_mount_flags |= EXT4_MF_FC_INELIGIBLE;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700265 WARN_ON(reason >= EXT4_FC_REASON_MAX);
266 sbi->s_fc_stats.fc_ineligible_reason_count[reason]++;
267}
268
269/*
270 * Start a fast commit ineligible update. Any commits that happen while
271 * such an operation is in progress fall back to full commits.
272 */
273void ext4_fc_start_ineligible(struct super_block *sb, int reason)
274{
275 struct ext4_sb_info *sbi = EXT4_SB(sb);
276
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700277 if (!test_opt2(sb, JOURNAL_FAST_COMMIT) ||
278 (EXT4_SB(sb)->s_mount_state & EXT4_FC_REPLAY))
279 return;
280
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700281 WARN_ON(reason >= EXT4_FC_REASON_MAX);
282 sbi->s_fc_stats.fc_ineligible_reason_count[reason]++;
283 atomic_inc(&sbi->s_fc_ineligible_updates);
284}
285
286/*
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700287 * Stop a fast commit ineligible update. We set EXT4_MF_FC_INELIGIBLE flag here
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700288 * to ensure that after stopping the ineligible update, at least one full
289 * commit takes place.
290 */
291void ext4_fc_stop_ineligible(struct super_block *sb)
292{
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700293 if (!test_opt2(sb, JOURNAL_FAST_COMMIT) ||
294 (EXT4_SB(sb)->s_mount_state & EXT4_FC_REPLAY))
295 return;
296
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700297 EXT4_SB(sb)->s_mount_flags |= EXT4_MF_FC_INELIGIBLE;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700298 atomic_dec(&EXT4_SB(sb)->s_fc_ineligible_updates);
299}
300
301static inline int ext4_fc_is_ineligible(struct super_block *sb)
302{
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700303 return (EXT4_SB(sb)->s_mount_flags & EXT4_MF_FC_INELIGIBLE) ||
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700304 atomic_read(&EXT4_SB(sb)->s_fc_ineligible_updates);
305}
306
307/*
308 * Generic fast commit tracking function. If this is the first time this we are
309 * called after a full commit, we initialize fast commit fields and then call
310 * __fc_track_fn() with update = 0. If we have already been called after a full
311 * commit, we pass update = 1. Based on that, the track function can determine
312 * if it needs to track a field for the first time or if it needs to just
313 * update the previously tracked value.
314 *
315 * If enqueue is set, this function enqueues the inode in fast commit list.
316 */
317static int ext4_fc_track_template(
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800318 handle_t *handle, struct inode *inode,
319 int (*__fc_track_fn)(struct inode *, void *, bool),
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700320 void *args, int enqueue)
321{
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700322 bool update = false;
323 struct ext4_inode_info *ei = EXT4_I(inode);
324 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800325 tid_t tid = 0;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700326 int ret;
327
Harshad Shirwadkar8016e292020-10-15 13:37:59 -0700328 if (!test_opt2(inode->i_sb, JOURNAL_FAST_COMMIT) ||
329 (sbi->s_mount_state & EXT4_FC_REPLAY))
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700330 return -EOPNOTSUPP;
331
332 if (ext4_fc_is_ineligible(inode->i_sb))
333 return -EINVAL;
334
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800335 tid = handle->h_transaction->t_tid;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700336 mutex_lock(&ei->i_fc_lock);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800337 if (tid == ei->i_sync_tid) {
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700338 update = true;
339 } else {
340 ext4_fc_reset_inode(inode);
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800341 ei->i_sync_tid = tid;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700342 }
343 ret = __fc_track_fn(inode, args, update);
344 mutex_unlock(&ei->i_fc_lock);
345
346 if (!enqueue)
347 return ret;
348
349 spin_lock(&sbi->s_fc_lock);
350 if (list_empty(&EXT4_I(inode)->i_fc_list))
351 list_add_tail(&EXT4_I(inode)->i_fc_list,
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700352 (sbi->s_mount_flags & EXT4_MF_FC_COMMITTING) ?
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700353 &sbi->s_fc_q[FC_Q_STAGING] :
354 &sbi->s_fc_q[FC_Q_MAIN]);
355 spin_unlock(&sbi->s_fc_lock);
356
357 return ret;
358}
359
360struct __track_dentry_update_args {
361 struct dentry *dentry;
362 int op;
363};
364
365/* __track_fn for directory entry updates. Called with ei->i_fc_lock. */
366static int __track_dentry_update(struct inode *inode, void *arg, bool update)
367{
368 struct ext4_fc_dentry_update *node;
369 struct ext4_inode_info *ei = EXT4_I(inode);
370 struct __track_dentry_update_args *dentry_update =
371 (struct __track_dentry_update_args *)arg;
372 struct dentry *dentry = dentry_update->dentry;
373 struct ext4_sb_info *sbi = EXT4_SB(inode->i_sb);
374
375 mutex_unlock(&ei->i_fc_lock);
376 node = kmem_cache_alloc(ext4_fc_dentry_cachep, GFP_NOFS);
377 if (!node) {
Harshad Shirwadkarb21ebf12020-11-05 19:58:51 -0800378 ext4_fc_mark_ineligible(inode->i_sb, EXT4_FC_REASON_NOMEM);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700379 mutex_lock(&ei->i_fc_lock);
380 return -ENOMEM;
381 }
382
383 node->fcd_op = dentry_update->op;
384 node->fcd_parent = dentry->d_parent->d_inode->i_ino;
385 node->fcd_ino = inode->i_ino;
386 if (dentry->d_name.len > DNAME_INLINE_LEN) {
387 node->fcd_name.name = kmalloc(dentry->d_name.len, GFP_NOFS);
388 if (!node->fcd_name.name) {
389 kmem_cache_free(ext4_fc_dentry_cachep, node);
390 ext4_fc_mark_ineligible(inode->i_sb,
Harshad Shirwadkarb21ebf12020-11-05 19:58:51 -0800391 EXT4_FC_REASON_NOMEM);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700392 mutex_lock(&ei->i_fc_lock);
393 return -ENOMEM;
394 }
395 memcpy((u8 *)node->fcd_name.name, dentry->d_name.name,
396 dentry->d_name.len);
397 } else {
398 memcpy(node->fcd_iname, dentry->d_name.name,
399 dentry->d_name.len);
400 node->fcd_name.name = node->fcd_iname;
401 }
402 node->fcd_name.len = dentry->d_name.len;
403
404 spin_lock(&sbi->s_fc_lock);
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700405 if (sbi->s_mount_flags & EXT4_MF_FC_COMMITTING)
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700406 list_add_tail(&node->fcd_list,
407 &sbi->s_fc_dentry_q[FC_Q_STAGING]);
408 else
409 list_add_tail(&node->fcd_list, &sbi->s_fc_dentry_q[FC_Q_MAIN]);
410 spin_unlock(&sbi->s_fc_lock);
411 mutex_lock(&ei->i_fc_lock);
412
413 return 0;
414}
415
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800416void __ext4_fc_track_unlink(handle_t *handle,
417 struct inode *inode, struct dentry *dentry)
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700418{
419 struct __track_dentry_update_args args;
420 int ret;
421
422 args.dentry = dentry;
423 args.op = EXT4_FC_TAG_UNLINK;
424
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800425 ret = ext4_fc_track_template(handle, inode, __track_dentry_update,
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700426 (void *)&args, 0);
427 trace_ext4_fc_track_unlink(inode, dentry, ret);
428}
429
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800430void ext4_fc_track_unlink(handle_t *handle, struct dentry *dentry)
431{
432 __ext4_fc_track_unlink(handle, d_inode(dentry), dentry);
433}
434
435void __ext4_fc_track_link(handle_t *handle,
436 struct inode *inode, struct dentry *dentry)
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700437{
438 struct __track_dentry_update_args args;
439 int ret;
440
441 args.dentry = dentry;
442 args.op = EXT4_FC_TAG_LINK;
443
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800444 ret = ext4_fc_track_template(handle, inode, __track_dentry_update,
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700445 (void *)&args, 0);
446 trace_ext4_fc_track_link(inode, dentry, ret);
447}
448
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800449void ext4_fc_track_link(handle_t *handle, struct dentry *dentry)
450{
451 __ext4_fc_track_link(handle, d_inode(dentry), dentry);
452}
453
454void ext4_fc_track_create(handle_t *handle, struct dentry *dentry)
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700455{
456 struct __track_dentry_update_args args;
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800457 struct inode *inode = d_inode(dentry);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700458 int ret;
459
460 args.dentry = dentry;
461 args.op = EXT4_FC_TAG_CREAT;
462
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800463 ret = ext4_fc_track_template(handle, inode, __track_dentry_update,
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700464 (void *)&args, 0);
465 trace_ext4_fc_track_create(inode, dentry, ret);
466}
467
468/* __track_fn for inode tracking */
469static int __track_inode(struct inode *inode, void *arg, bool update)
470{
471 if (update)
472 return -EEXIST;
473
474 EXT4_I(inode)->i_fc_lblk_len = 0;
475
476 return 0;
477}
478
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800479void ext4_fc_track_inode(handle_t *handle, struct inode *inode)
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700480{
481 int ret;
482
483 if (S_ISDIR(inode->i_mode))
484 return;
485
Harshad Shirwadkar556e0312020-11-05 19:59:07 -0800486 if (ext4_should_journal_data(inode)) {
487 ext4_fc_mark_ineligible(inode->i_sb,
488 EXT4_FC_REASON_INODE_JOURNAL_DATA);
489 return;
490 }
491
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800492 ret = ext4_fc_track_template(handle, inode, __track_inode, NULL, 1);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700493 trace_ext4_fc_track_inode(inode, ret);
494}
495
496struct __track_range_args {
497 ext4_lblk_t start, end;
498};
499
500/* __track_fn for tracking data updates */
501static int __track_range(struct inode *inode, void *arg, bool update)
502{
503 struct ext4_inode_info *ei = EXT4_I(inode);
504 ext4_lblk_t oldstart;
505 struct __track_range_args *__arg =
506 (struct __track_range_args *)arg;
507
508 if (inode->i_ino < EXT4_FIRST_INO(inode->i_sb)) {
509 ext4_debug("Special inode %ld being modified\n", inode->i_ino);
510 return -ECANCELED;
511 }
512
513 oldstart = ei->i_fc_lblk_start;
514
515 if (update && ei->i_fc_lblk_len > 0) {
516 ei->i_fc_lblk_start = min(ei->i_fc_lblk_start, __arg->start);
517 ei->i_fc_lblk_len =
518 max(oldstart + ei->i_fc_lblk_len - 1, __arg->end) -
519 ei->i_fc_lblk_start + 1;
520 } else {
521 ei->i_fc_lblk_start = __arg->start;
522 ei->i_fc_lblk_len = __arg->end - __arg->start + 1;
523 }
524
525 return 0;
526}
527
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800528void ext4_fc_track_range(handle_t *handle, struct inode *inode, ext4_lblk_t start,
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700529 ext4_lblk_t end)
530{
531 struct __track_range_args args;
532 int ret;
533
534 if (S_ISDIR(inode->i_mode))
535 return;
536
537 args.start = start;
538 args.end = end;
539
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -0800540 ret = ext4_fc_track_template(handle, inode, __track_range, &args, 1);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700541
542 trace_ext4_fc_track_range(inode, start, end, ret);
543}
544
545static void ext4_fc_submit_bh(struct super_block *sb)
546{
547 int write_flags = REQ_SYNC;
548 struct buffer_head *bh = EXT4_SB(sb)->s_fc_bh;
549
Harshad Shirwadkara7407622020-11-05 19:59:03 -0800550 /* TODO: REQ_FUA | REQ_PREFLUSH is unnecessarily expensive. */
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700551 if (test_opt(sb, BARRIER))
552 write_flags |= REQ_FUA | REQ_PREFLUSH;
553 lock_buffer(bh);
Harshad Shirwadkar764b3fd2020-11-05 19:59:04 -0800554 set_buffer_dirty(bh);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700555 set_buffer_uptodate(bh);
556 bh->b_end_io = ext4_end_buffer_io_sync;
557 submit_bh(REQ_OP_WRITE, write_flags, bh);
558 EXT4_SB(sb)->s_fc_bh = NULL;
559}
560
561/* Ext4 commit path routines */
562
563/* memzero and update CRC */
564static void *ext4_fc_memzero(struct super_block *sb, void *dst, int len,
565 u32 *crc)
566{
567 void *ret;
568
569 ret = memset(dst, 0, len);
570 if (crc)
571 *crc = ext4_chksum(EXT4_SB(sb), *crc, dst, len);
572 return ret;
573}
574
575/*
576 * Allocate len bytes on a fast commit buffer.
577 *
578 * During the commit time this function is used to manage fast commit
579 * block space. We don't split a fast commit log onto different
580 * blocks. So this function makes sure that if there's not enough space
581 * on the current block, the remaining space in the current block is
582 * marked as unused by adding EXT4_FC_TAG_PAD tag. In that case,
583 * new block is from jbd2 and CRC is updated to reflect the padding
584 * we added.
585 */
586static u8 *ext4_fc_reserve_space(struct super_block *sb, int len, u32 *crc)
587{
588 struct ext4_fc_tl *tl;
589 struct ext4_sb_info *sbi = EXT4_SB(sb);
590 struct buffer_head *bh;
591 int bsize = sbi->s_journal->j_blocksize;
592 int ret, off = sbi->s_fc_bytes % bsize;
593 int pad_len;
594
595 /*
596 * After allocating len, we should have space at least for a 0 byte
597 * padding.
598 */
599 if (len + sizeof(struct ext4_fc_tl) > bsize)
600 return NULL;
601
602 if (bsize - off - 1 > len + sizeof(struct ext4_fc_tl)) {
603 /*
604 * Only allocate from current buffer if we have enough space for
605 * this request AND we have space to add a zero byte padding.
606 */
607 if (!sbi->s_fc_bh) {
608 ret = jbd2_fc_get_buf(EXT4_SB(sb)->s_journal, &bh);
609 if (ret)
610 return NULL;
611 sbi->s_fc_bh = bh;
612 }
613 sbi->s_fc_bytes += len;
614 return sbi->s_fc_bh->b_data + off;
615 }
616 /* Need to add PAD tag */
617 tl = (struct ext4_fc_tl *)(sbi->s_fc_bh->b_data + off);
618 tl->fc_tag = cpu_to_le16(EXT4_FC_TAG_PAD);
619 pad_len = bsize - off - 1 - sizeof(struct ext4_fc_tl);
620 tl->fc_len = cpu_to_le16(pad_len);
621 if (crc)
622 *crc = ext4_chksum(sbi, *crc, tl, sizeof(*tl));
623 if (pad_len > 0)
624 ext4_fc_memzero(sb, tl + 1, pad_len, crc);
625 ext4_fc_submit_bh(sb);
626
627 ret = jbd2_fc_get_buf(EXT4_SB(sb)->s_journal, &bh);
628 if (ret)
629 return NULL;
630 sbi->s_fc_bh = bh;
631 sbi->s_fc_bytes = (sbi->s_fc_bytes / bsize + 1) * bsize + len;
632 return sbi->s_fc_bh->b_data;
633}
634
635/* memcpy to fc reserved space and update CRC */
636static void *ext4_fc_memcpy(struct super_block *sb, void *dst, const void *src,
637 int len, u32 *crc)
638{
639 if (crc)
640 *crc = ext4_chksum(EXT4_SB(sb), *crc, src, len);
641 return memcpy(dst, src, len);
642}
643
644/*
645 * Complete a fast commit by writing tail tag.
646 *
647 * Writing tail tag marks the end of a fast commit. In order to guarantee
648 * atomicity, after writing tail tag, even if there's space remaining
649 * in the block, next commit shouldn't use it. That's why tail tag
650 * has the length as that of the remaining space on the block.
651 */
652static int ext4_fc_write_tail(struct super_block *sb, u32 crc)
653{
654 struct ext4_sb_info *sbi = EXT4_SB(sb);
655 struct ext4_fc_tl tl;
656 struct ext4_fc_tail tail;
657 int off, bsize = sbi->s_journal->j_blocksize;
658 u8 *dst;
659
660 /*
661 * ext4_fc_reserve_space takes care of allocating an extra block if
662 * there's no enough space on this block for accommodating this tail.
663 */
664 dst = ext4_fc_reserve_space(sb, sizeof(tl) + sizeof(tail), &crc);
665 if (!dst)
666 return -ENOSPC;
667
668 off = sbi->s_fc_bytes % bsize;
669
670 tl.fc_tag = cpu_to_le16(EXT4_FC_TAG_TAIL);
671 tl.fc_len = cpu_to_le16(bsize - off - 1 + sizeof(struct ext4_fc_tail));
672 sbi->s_fc_bytes = round_up(sbi->s_fc_bytes, bsize);
673
674 ext4_fc_memcpy(sb, dst, &tl, sizeof(tl), &crc);
675 dst += sizeof(tl);
676 tail.fc_tid = cpu_to_le32(sbi->s_journal->j_running_transaction->t_tid);
677 ext4_fc_memcpy(sb, dst, &tail.fc_tid, sizeof(tail.fc_tid), &crc);
678 dst += sizeof(tail.fc_tid);
679 tail.fc_crc = cpu_to_le32(crc);
680 ext4_fc_memcpy(sb, dst, &tail.fc_crc, sizeof(tail.fc_crc), NULL);
681
682 ext4_fc_submit_bh(sb);
683
684 return 0;
685}
686
687/*
688 * Adds tag, length, value and updates CRC. Returns true if tlv was added.
689 * Returns false if there's not enough space.
690 */
691static bool ext4_fc_add_tlv(struct super_block *sb, u16 tag, u16 len, u8 *val,
692 u32 *crc)
693{
694 struct ext4_fc_tl tl;
695 u8 *dst;
696
697 dst = ext4_fc_reserve_space(sb, sizeof(tl) + len, crc);
698 if (!dst)
699 return false;
700
701 tl.fc_tag = cpu_to_le16(tag);
702 tl.fc_len = cpu_to_le16(len);
703
704 ext4_fc_memcpy(sb, dst, &tl, sizeof(tl), crc);
705 ext4_fc_memcpy(sb, dst + sizeof(tl), val, len, crc);
706
707 return true;
708}
709
710/* Same as above, but adds dentry tlv. */
711static bool ext4_fc_add_dentry_tlv(struct super_block *sb, u16 tag,
712 int parent_ino, int ino, int dlen,
713 const unsigned char *dname,
714 u32 *crc)
715{
716 struct ext4_fc_dentry_info fcd;
717 struct ext4_fc_tl tl;
718 u8 *dst = ext4_fc_reserve_space(sb, sizeof(tl) + sizeof(fcd) + dlen,
719 crc);
720
721 if (!dst)
722 return false;
723
724 fcd.fc_parent_ino = cpu_to_le32(parent_ino);
725 fcd.fc_ino = cpu_to_le32(ino);
726 tl.fc_tag = cpu_to_le16(tag);
727 tl.fc_len = cpu_to_le16(sizeof(fcd) + dlen);
728 ext4_fc_memcpy(sb, dst, &tl, sizeof(tl), crc);
729 dst += sizeof(tl);
730 ext4_fc_memcpy(sb, dst, &fcd, sizeof(fcd), crc);
731 dst += sizeof(fcd);
732 ext4_fc_memcpy(sb, dst, dname, dlen, crc);
733 dst += dlen;
734
735 return true;
736}
737
738/*
739 * Writes inode in the fast commit space under TLV with tag @tag.
740 * Returns 0 on success, error on failure.
741 */
742static int ext4_fc_write_inode(struct inode *inode, u32 *crc)
743{
744 struct ext4_inode_info *ei = EXT4_I(inode);
745 int inode_len = EXT4_GOOD_OLD_INODE_SIZE;
746 int ret;
747 struct ext4_iloc iloc;
748 struct ext4_fc_inode fc_inode;
749 struct ext4_fc_tl tl;
750 u8 *dst;
751
752 ret = ext4_get_inode_loc(inode, &iloc);
753 if (ret)
754 return ret;
755
756 if (EXT4_INODE_SIZE(inode->i_sb) > EXT4_GOOD_OLD_INODE_SIZE)
757 inode_len += ei->i_extra_isize;
758
759 fc_inode.fc_ino = cpu_to_le32(inode->i_ino);
760 tl.fc_tag = cpu_to_le16(EXT4_FC_TAG_INODE);
761 tl.fc_len = cpu_to_le16(inode_len + sizeof(fc_inode.fc_ino));
762
763 dst = ext4_fc_reserve_space(inode->i_sb,
764 sizeof(tl) + inode_len + sizeof(fc_inode.fc_ino), crc);
765 if (!dst)
766 return -ECANCELED;
767
768 if (!ext4_fc_memcpy(inode->i_sb, dst, &tl, sizeof(tl), crc))
769 return -ECANCELED;
770 dst += sizeof(tl);
771 if (!ext4_fc_memcpy(inode->i_sb, dst, &fc_inode, sizeof(fc_inode), crc))
772 return -ECANCELED;
773 dst += sizeof(fc_inode);
774 if (!ext4_fc_memcpy(inode->i_sb, dst, (u8 *)ext4_raw_inode(&iloc),
775 inode_len, crc))
776 return -ECANCELED;
777
778 return 0;
779}
780
781/*
782 * Writes updated data ranges for the inode in question. Updates CRC.
783 * Returns 0 on success, error otherwise.
784 */
785static int ext4_fc_write_inode_data(struct inode *inode, u32 *crc)
786{
787 ext4_lblk_t old_blk_size, cur_lblk_off, new_blk_size;
788 struct ext4_inode_info *ei = EXT4_I(inode);
789 struct ext4_map_blocks map;
790 struct ext4_fc_add_range fc_ext;
791 struct ext4_fc_del_range lrange;
792 struct ext4_extent *ex;
793 int ret;
794
795 mutex_lock(&ei->i_fc_lock);
796 if (ei->i_fc_lblk_len == 0) {
797 mutex_unlock(&ei->i_fc_lock);
798 return 0;
799 }
800 old_blk_size = ei->i_fc_lblk_start;
801 new_blk_size = ei->i_fc_lblk_start + ei->i_fc_lblk_len - 1;
802 ei->i_fc_lblk_len = 0;
803 mutex_unlock(&ei->i_fc_lock);
804
805 cur_lblk_off = old_blk_size;
806 jbd_debug(1, "%s: will try writing %d to %d for inode %ld\n",
807 __func__, cur_lblk_off, new_blk_size, inode->i_ino);
808
809 while (cur_lblk_off <= new_blk_size) {
810 map.m_lblk = cur_lblk_off;
811 map.m_len = new_blk_size - cur_lblk_off + 1;
812 ret = ext4_map_blocks(NULL, inode, &map, 0);
813 if (ret < 0)
814 return -ECANCELED;
815
816 if (map.m_len == 0) {
817 cur_lblk_off++;
818 continue;
819 }
820
821 if (ret == 0) {
822 lrange.fc_ino = cpu_to_le32(inode->i_ino);
823 lrange.fc_lblk = cpu_to_le32(map.m_lblk);
824 lrange.fc_len = cpu_to_le32(map.m_len);
825 if (!ext4_fc_add_tlv(inode->i_sb, EXT4_FC_TAG_DEL_RANGE,
826 sizeof(lrange), (u8 *)&lrange, crc))
827 return -ENOSPC;
828 } else {
829 fc_ext.fc_ino = cpu_to_le32(inode->i_ino);
830 ex = (struct ext4_extent *)&fc_ext.fc_ex;
831 ex->ee_block = cpu_to_le32(map.m_lblk);
832 ex->ee_len = cpu_to_le16(map.m_len);
833 ext4_ext_store_pblock(ex, map.m_pblk);
834 if (map.m_flags & EXT4_MAP_UNWRITTEN)
835 ext4_ext_mark_unwritten(ex);
836 else
837 ext4_ext_mark_initialized(ex);
838 if (!ext4_fc_add_tlv(inode->i_sb, EXT4_FC_TAG_ADD_RANGE,
839 sizeof(fc_ext), (u8 *)&fc_ext, crc))
840 return -ENOSPC;
841 }
842
843 cur_lblk_off += map.m_len;
844 }
845
846 return 0;
847}
848
849
850/* Submit data for all the fast commit inodes */
851static int ext4_fc_submit_inode_data_all(journal_t *journal)
852{
853 struct super_block *sb = (struct super_block *)(journal->j_private);
854 struct ext4_sb_info *sbi = EXT4_SB(sb);
855 struct ext4_inode_info *ei;
856 struct list_head *pos;
857 int ret = 0;
858
859 spin_lock(&sbi->s_fc_lock);
Harshad Shirwadkarababea72020-10-26 21:49:15 -0700860 sbi->s_mount_flags |= EXT4_MF_FC_COMMITTING;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700861 list_for_each(pos, &sbi->s_fc_q[FC_Q_MAIN]) {
862 ei = list_entry(pos, struct ext4_inode_info, i_fc_list);
863 ext4_set_inode_state(&ei->vfs_inode, EXT4_STATE_FC_COMMITTING);
864 while (atomic_read(&ei->i_fc_updates)) {
865 DEFINE_WAIT(wait);
866
867 prepare_to_wait(&ei->i_fc_wait, &wait,
868 TASK_UNINTERRUPTIBLE);
869 if (atomic_read(&ei->i_fc_updates)) {
870 spin_unlock(&sbi->s_fc_lock);
871 schedule();
872 spin_lock(&sbi->s_fc_lock);
873 }
874 finish_wait(&ei->i_fc_wait, &wait);
875 }
876 spin_unlock(&sbi->s_fc_lock);
877 ret = jbd2_submit_inode_data(ei->jinode);
878 if (ret)
879 return ret;
880 spin_lock(&sbi->s_fc_lock);
881 }
882 spin_unlock(&sbi->s_fc_lock);
883
884 return ret;
885}
886
887/* Wait for completion of data for all the fast commit inodes */
888static int ext4_fc_wait_inode_data_all(journal_t *journal)
889{
890 struct super_block *sb = (struct super_block *)(journal->j_private);
891 struct ext4_sb_info *sbi = EXT4_SB(sb);
892 struct ext4_inode_info *pos, *n;
893 int ret = 0;
894
895 spin_lock(&sbi->s_fc_lock);
896 list_for_each_entry_safe(pos, n, &sbi->s_fc_q[FC_Q_MAIN], i_fc_list) {
897 if (!ext4_test_inode_state(&pos->vfs_inode,
898 EXT4_STATE_FC_COMMITTING))
899 continue;
900 spin_unlock(&sbi->s_fc_lock);
901
902 ret = jbd2_wait_inode_data(journal, pos->jinode);
903 if (ret)
904 return ret;
905 spin_lock(&sbi->s_fc_lock);
906 }
907 spin_unlock(&sbi->s_fc_lock);
908
909 return 0;
910}
911
912/* Commit all the directory entry updates */
913static int ext4_fc_commit_dentry_updates(journal_t *journal, u32 *crc)
914{
915 struct super_block *sb = (struct super_block *)(journal->j_private);
916 struct ext4_sb_info *sbi = EXT4_SB(sb);
917 struct ext4_fc_dentry_update *fc_dentry;
918 struct inode *inode;
919 struct list_head *pos, *n, *fcd_pos, *fcd_n;
920 struct ext4_inode_info *ei;
921 int ret;
922
923 if (list_empty(&sbi->s_fc_dentry_q[FC_Q_MAIN]))
924 return 0;
925 list_for_each_safe(fcd_pos, fcd_n, &sbi->s_fc_dentry_q[FC_Q_MAIN]) {
926 fc_dentry = list_entry(fcd_pos, struct ext4_fc_dentry_update,
927 fcd_list);
928 if (fc_dentry->fcd_op != EXT4_FC_TAG_CREAT) {
929 spin_unlock(&sbi->s_fc_lock);
930 if (!ext4_fc_add_dentry_tlv(
931 sb, fc_dentry->fcd_op,
932 fc_dentry->fcd_parent, fc_dentry->fcd_ino,
933 fc_dentry->fcd_name.len,
934 fc_dentry->fcd_name.name, crc)) {
935 ret = -ENOSPC;
936 goto lock_and_exit;
937 }
938 spin_lock(&sbi->s_fc_lock);
939 continue;
940 }
941
942 inode = NULL;
943 list_for_each_safe(pos, n, &sbi->s_fc_q[FC_Q_MAIN]) {
944 ei = list_entry(pos, struct ext4_inode_info, i_fc_list);
945 if (ei->vfs_inode.i_ino == fc_dentry->fcd_ino) {
946 inode = &ei->vfs_inode;
947 break;
948 }
949 }
950 /*
951 * If we don't find inode in our list, then it was deleted,
952 * in which case, we don't need to record it's create tag.
953 */
954 if (!inode)
955 continue;
956 spin_unlock(&sbi->s_fc_lock);
957
958 /*
959 * We first write the inode and then the create dirent. This
960 * allows the recovery code to create an unnamed inode first
961 * and then link it to a directory entry. This allows us
962 * to use namei.c routines almost as is and simplifies
963 * the recovery code.
964 */
965 ret = ext4_fc_write_inode(inode, crc);
966 if (ret)
967 goto lock_and_exit;
968
969 ret = ext4_fc_write_inode_data(inode, crc);
970 if (ret)
971 goto lock_and_exit;
972
973 if (!ext4_fc_add_dentry_tlv(
974 sb, fc_dentry->fcd_op,
975 fc_dentry->fcd_parent, fc_dentry->fcd_ino,
976 fc_dentry->fcd_name.len,
977 fc_dentry->fcd_name.name, crc)) {
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -0700978 ret = -ENOSPC;
979 goto lock_and_exit;
980 }
981
982 spin_lock(&sbi->s_fc_lock);
983 }
984 return 0;
985lock_and_exit:
986 spin_lock(&sbi->s_fc_lock);
987 return ret;
988}
989
990static int ext4_fc_perform_commit(journal_t *journal)
991{
992 struct super_block *sb = (struct super_block *)(journal->j_private);
993 struct ext4_sb_info *sbi = EXT4_SB(sb);
994 struct ext4_inode_info *iter;
995 struct ext4_fc_head head;
996 struct list_head *pos;
997 struct inode *inode;
998 struct blk_plug plug;
999 int ret = 0;
1000 u32 crc = 0;
1001
1002 ret = ext4_fc_submit_inode_data_all(journal);
1003 if (ret)
1004 return ret;
1005
1006 ret = ext4_fc_wait_inode_data_all(journal);
1007 if (ret)
1008 return ret;
1009
Harshad Shirwadkarda0c5d22020-11-05 19:59:08 -08001010 /*
1011 * If file system device is different from journal device, issue a cache
1012 * flush before we start writing fast commit blocks.
1013 */
1014 if (journal->j_fs_dev != journal->j_dev)
1015 blkdev_issue_flush(journal->j_fs_dev, GFP_NOFS);
1016
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001017 blk_start_plug(&plug);
1018 if (sbi->s_fc_bytes == 0) {
1019 /*
1020 * Add a head tag only if this is the first fast commit
1021 * in this TID.
1022 */
1023 head.fc_features = cpu_to_le32(EXT4_FC_SUPPORTED_FEATURES);
1024 head.fc_tid = cpu_to_le32(
1025 sbi->s_journal->j_running_transaction->t_tid);
1026 if (!ext4_fc_add_tlv(sb, EXT4_FC_TAG_HEAD, sizeof(head),
1027 (u8 *)&head, &crc))
1028 goto out;
1029 }
1030
1031 spin_lock(&sbi->s_fc_lock);
1032 ret = ext4_fc_commit_dentry_updates(journal, &crc);
1033 if (ret) {
1034 spin_unlock(&sbi->s_fc_lock);
1035 goto out;
1036 }
1037
1038 list_for_each(pos, &sbi->s_fc_q[FC_Q_MAIN]) {
1039 iter = list_entry(pos, struct ext4_inode_info, i_fc_list);
1040 inode = &iter->vfs_inode;
1041 if (!ext4_test_inode_state(inode, EXT4_STATE_FC_COMMITTING))
1042 continue;
1043
1044 spin_unlock(&sbi->s_fc_lock);
1045 ret = ext4_fc_write_inode_data(inode, &crc);
1046 if (ret)
1047 goto out;
1048 ret = ext4_fc_write_inode(inode, &crc);
1049 if (ret)
1050 goto out;
1051 spin_lock(&sbi->s_fc_lock);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001052 }
1053 spin_unlock(&sbi->s_fc_lock);
1054
1055 ret = ext4_fc_write_tail(sb, crc);
1056
1057out:
1058 blk_finish_plug(&plug);
1059 return ret;
1060}
1061
1062/*
1063 * The main commit entry point. Performs a fast commit for transaction
1064 * commit_tid if needed. If it's not possible to perform a fast commit
1065 * due to various reasons, we fall back to full commit. Returns 0
1066 * on success, error otherwise.
1067 */
1068int ext4_fc_commit(journal_t *journal, tid_t commit_tid)
1069{
1070 struct super_block *sb = (struct super_block *)(journal->j_private);
1071 struct ext4_sb_info *sbi = EXT4_SB(sb);
1072 int nblks = 0, ret, bsize = journal->j_blocksize;
1073 int subtid = atomic_read(&sbi->s_fc_subtid);
1074 int reason = EXT4_FC_REASON_OK, fc_bufs_before = 0;
1075 ktime_t start_time, commit_time;
1076
1077 trace_ext4_fc_commit_start(sb);
1078
1079 start_time = ktime_get();
1080
1081 if (!test_opt2(sb, JOURNAL_FAST_COMMIT) ||
1082 (ext4_fc_is_ineligible(sb))) {
1083 reason = EXT4_FC_REASON_INELIGIBLE;
1084 goto out;
1085 }
1086
1087restart_fc:
1088 ret = jbd2_fc_begin_commit(journal, commit_tid);
1089 if (ret == -EALREADY) {
1090 /* There was an ongoing commit, check if we need to restart */
1091 if (atomic_read(&sbi->s_fc_subtid) <= subtid &&
1092 commit_tid > journal->j_commit_sequence)
1093 goto restart_fc;
1094 reason = EXT4_FC_REASON_ALREADY_COMMITTED;
1095 goto out;
1096 } else if (ret) {
1097 sbi->s_fc_stats.fc_ineligible_reason_count[EXT4_FC_COMMIT_FAILED]++;
1098 reason = EXT4_FC_REASON_FC_START_FAILED;
1099 goto out;
1100 }
1101
1102 fc_bufs_before = (sbi->s_fc_bytes + bsize - 1) / bsize;
1103 ret = ext4_fc_perform_commit(journal);
1104 if (ret < 0) {
1105 sbi->s_fc_stats.fc_ineligible_reason_count[EXT4_FC_COMMIT_FAILED]++;
1106 reason = EXT4_FC_REASON_FC_FAILED;
1107 goto out;
1108 }
1109 nblks = (sbi->s_fc_bytes + bsize - 1) / bsize - fc_bufs_before;
1110 ret = jbd2_fc_wait_bufs(journal, nblks);
1111 if (ret < 0) {
1112 sbi->s_fc_stats.fc_ineligible_reason_count[EXT4_FC_COMMIT_FAILED]++;
1113 reason = EXT4_FC_REASON_FC_FAILED;
1114 goto out;
1115 }
1116 atomic_inc(&sbi->s_fc_subtid);
1117 jbd2_fc_end_commit(journal);
1118out:
1119 /* Has any ineligible update happened since we started? */
1120 if (reason == EXT4_FC_REASON_OK && ext4_fc_is_ineligible(sb)) {
1121 sbi->s_fc_stats.fc_ineligible_reason_count[EXT4_FC_COMMIT_FAILED]++;
1122 reason = EXT4_FC_REASON_INELIGIBLE;
1123 }
1124
1125 spin_lock(&sbi->s_fc_lock);
1126 if (reason != EXT4_FC_REASON_OK &&
1127 reason != EXT4_FC_REASON_ALREADY_COMMITTED) {
1128 sbi->s_fc_stats.fc_ineligible_commits++;
1129 } else {
1130 sbi->s_fc_stats.fc_num_commits++;
1131 sbi->s_fc_stats.fc_numblks += nblks;
1132 }
1133 spin_unlock(&sbi->s_fc_lock);
1134 nblks = (reason == EXT4_FC_REASON_OK) ? nblks : 0;
1135 trace_ext4_fc_commit_stop(sb, nblks, reason);
1136 commit_time = ktime_to_ns(ktime_sub(ktime_get(), start_time));
1137 /*
1138 * weight the commit time higher than the average time so we don't
1139 * react too strongly to vast changes in the commit time
1140 */
1141 if (likely(sbi->s_fc_avg_commit_time))
1142 sbi->s_fc_avg_commit_time = (commit_time +
1143 sbi->s_fc_avg_commit_time * 3) / 4;
1144 else
1145 sbi->s_fc_avg_commit_time = commit_time;
1146 jbd_debug(1,
1147 "Fast commit ended with blks = %d, reason = %d, subtid - %d",
1148 nblks, reason, subtid);
1149 if (reason == EXT4_FC_REASON_FC_FAILED)
Harshad Shirwadkar0bce5772020-11-05 19:58:58 -08001150 return jbd2_fc_end_commit_fallback(journal);
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001151 if (reason == EXT4_FC_REASON_FC_START_FAILED ||
1152 reason == EXT4_FC_REASON_INELIGIBLE)
1153 return jbd2_complete_transaction(journal, commit_tid);
1154 return 0;
1155}
1156
Harshad Shirwadkarff780b92020-10-15 13:37:56 -07001157/*
1158 * Fast commit cleanup routine. This is called after every fast commit and
1159 * full commit. full is true if we are called after a full commit.
1160 */
1161static void ext4_fc_cleanup(journal_t *journal, int full)
1162{
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001163 struct super_block *sb = journal->j_private;
1164 struct ext4_sb_info *sbi = EXT4_SB(sb);
1165 struct ext4_inode_info *iter;
1166 struct ext4_fc_dentry_update *fc_dentry;
1167 struct list_head *pos, *n;
1168
1169 if (full && sbi->s_fc_bh)
1170 sbi->s_fc_bh = NULL;
1171
1172 jbd2_fc_release_bufs(journal);
1173
1174 spin_lock(&sbi->s_fc_lock);
1175 list_for_each_safe(pos, n, &sbi->s_fc_q[FC_Q_MAIN]) {
1176 iter = list_entry(pos, struct ext4_inode_info, i_fc_list);
1177 list_del_init(&iter->i_fc_list);
1178 ext4_clear_inode_state(&iter->vfs_inode,
1179 EXT4_STATE_FC_COMMITTING);
1180 ext4_fc_reset_inode(&iter->vfs_inode);
1181 /* Make sure EXT4_STATE_FC_COMMITTING bit is clear */
1182 smp_mb();
1183#if (BITS_PER_LONG < 64)
1184 wake_up_bit(&iter->i_state_flags, EXT4_STATE_FC_COMMITTING);
1185#else
1186 wake_up_bit(&iter->i_flags, EXT4_STATE_FC_COMMITTING);
1187#endif
1188 }
1189
1190 while (!list_empty(&sbi->s_fc_dentry_q[FC_Q_MAIN])) {
1191 fc_dentry = list_first_entry(&sbi->s_fc_dentry_q[FC_Q_MAIN],
1192 struct ext4_fc_dentry_update,
1193 fcd_list);
1194 list_del_init(&fc_dentry->fcd_list);
1195 spin_unlock(&sbi->s_fc_lock);
1196
1197 if (fc_dentry->fcd_name.name &&
1198 fc_dentry->fcd_name.len > DNAME_INLINE_LEN)
1199 kfree(fc_dentry->fcd_name.name);
1200 kmem_cache_free(ext4_fc_dentry_cachep, fc_dentry);
1201 spin_lock(&sbi->s_fc_lock);
1202 }
1203
1204 list_splice_init(&sbi->s_fc_dentry_q[FC_Q_STAGING],
1205 &sbi->s_fc_dentry_q[FC_Q_MAIN]);
1206 list_splice_init(&sbi->s_fc_q[FC_Q_STAGING],
1207 &sbi->s_fc_q[FC_Q_STAGING]);
1208
Harshad Shirwadkarababea72020-10-26 21:49:15 -07001209 sbi->s_mount_flags &= ~EXT4_MF_FC_COMMITTING;
1210 sbi->s_mount_flags &= ~EXT4_MF_FC_INELIGIBLE;
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07001211
1212 if (full)
1213 sbi->s_fc_bytes = 0;
1214 spin_unlock(&sbi->s_fc_lock);
1215 trace_ext4_fc_stats(sb);
Harshad Shirwadkarff780b92020-10-15 13:37:56 -07001216}
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07001217
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07001218/* Ext4 Replay Path Routines */
1219
1220/* Get length of a particular tlv */
1221static inline int ext4_fc_tag_len(struct ext4_fc_tl *tl)
1222{
1223 return le16_to_cpu(tl->fc_len);
1224}
1225
1226/* Get a pointer to "value" of a tlv */
1227static inline u8 *ext4_fc_tag_val(struct ext4_fc_tl *tl)
1228{
1229 return (u8 *)tl + sizeof(*tl);
1230}
1231
1232/* Helper struct for dentry replay routines */
1233struct dentry_info_args {
1234 int parent_ino, dname_len, ino, inode_len;
1235 char *dname;
1236};
1237
1238static inline void tl_to_darg(struct dentry_info_args *darg,
1239 struct ext4_fc_tl *tl)
1240{
1241 struct ext4_fc_dentry_info *fcd;
1242
1243 fcd = (struct ext4_fc_dentry_info *)ext4_fc_tag_val(tl);
1244
1245 darg->parent_ino = le32_to_cpu(fcd->fc_parent_ino);
1246 darg->ino = le32_to_cpu(fcd->fc_ino);
1247 darg->dname = fcd->fc_dname;
1248 darg->dname_len = ext4_fc_tag_len(tl) -
1249 sizeof(struct ext4_fc_dentry_info);
1250}
1251
1252/* Unlink replay function */
1253static int ext4_fc_replay_unlink(struct super_block *sb, struct ext4_fc_tl *tl)
1254{
1255 struct inode *inode, *old_parent;
1256 struct qstr entry;
1257 struct dentry_info_args darg;
1258 int ret = 0;
1259
1260 tl_to_darg(&darg, tl);
1261
1262 trace_ext4_fc_replay(sb, EXT4_FC_TAG_UNLINK, darg.ino,
1263 darg.parent_ino, darg.dname_len);
1264
1265 entry.name = darg.dname;
1266 entry.len = darg.dname_len;
1267 inode = ext4_iget(sb, darg.ino, EXT4_IGET_NORMAL);
1268
1269 if (IS_ERR_OR_NULL(inode)) {
1270 jbd_debug(1, "Inode %d not found", darg.ino);
1271 return 0;
1272 }
1273
1274 old_parent = ext4_iget(sb, darg.parent_ino,
1275 EXT4_IGET_NORMAL);
1276 if (IS_ERR_OR_NULL(old_parent)) {
1277 jbd_debug(1, "Dir with inode %d not found", darg.parent_ino);
1278 iput(inode);
1279 return 0;
1280 }
1281
Harshad Shirwadkara80f7fc2020-11-05 19:58:53 -08001282 ret = __ext4_unlink(NULL, old_parent, &entry, inode);
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07001283 /* -ENOENT ok coz it might not exist anymore. */
1284 if (ret == -ENOENT)
1285 ret = 0;
1286 iput(old_parent);
1287 iput(inode);
1288 return ret;
1289}
1290
1291static int ext4_fc_replay_link_internal(struct super_block *sb,
1292 struct dentry_info_args *darg,
1293 struct inode *inode)
1294{
1295 struct inode *dir = NULL;
1296 struct dentry *dentry_dir = NULL, *dentry_inode = NULL;
1297 struct qstr qstr_dname = QSTR_INIT(darg->dname, darg->dname_len);
1298 int ret = 0;
1299
1300 dir = ext4_iget(sb, darg->parent_ino, EXT4_IGET_NORMAL);
1301 if (IS_ERR(dir)) {
1302 jbd_debug(1, "Dir with inode %d not found.", darg->parent_ino);
1303 dir = NULL;
1304 goto out;
1305 }
1306
1307 dentry_dir = d_obtain_alias(dir);
1308 if (IS_ERR(dentry_dir)) {
1309 jbd_debug(1, "Failed to obtain dentry");
1310 dentry_dir = NULL;
1311 goto out;
1312 }
1313
1314 dentry_inode = d_alloc(dentry_dir, &qstr_dname);
1315 if (!dentry_inode) {
1316 jbd_debug(1, "Inode dentry not created.");
1317 ret = -ENOMEM;
1318 goto out;
1319 }
1320
1321 ret = __ext4_link(dir, inode, dentry_inode);
1322 /*
1323 * It's possible that link already existed since data blocks
1324 * for the dir in question got persisted before we crashed OR
1325 * we replayed this tag and crashed before the entire replay
1326 * could complete.
1327 */
1328 if (ret && ret != -EEXIST) {
1329 jbd_debug(1, "Failed to link\n");
1330 goto out;
1331 }
1332
1333 ret = 0;
1334out:
1335 if (dentry_dir) {
1336 d_drop(dentry_dir);
1337 dput(dentry_dir);
1338 } else if (dir) {
1339 iput(dir);
1340 }
1341 if (dentry_inode) {
1342 d_drop(dentry_inode);
1343 dput(dentry_inode);
1344 }
1345
1346 return ret;
1347}
1348
1349/* Link replay function */
1350static int ext4_fc_replay_link(struct super_block *sb, struct ext4_fc_tl *tl)
1351{
1352 struct inode *inode;
1353 struct dentry_info_args darg;
1354 int ret = 0;
1355
1356 tl_to_darg(&darg, tl);
1357 trace_ext4_fc_replay(sb, EXT4_FC_TAG_LINK, darg.ino,
1358 darg.parent_ino, darg.dname_len);
1359
1360 inode = ext4_iget(sb, darg.ino, EXT4_IGET_NORMAL);
1361 if (IS_ERR_OR_NULL(inode)) {
1362 jbd_debug(1, "Inode not found.");
1363 return 0;
1364 }
1365
1366 ret = ext4_fc_replay_link_internal(sb, &darg, inode);
1367 iput(inode);
1368 return ret;
1369}
1370
1371/*
1372 * Record all the modified inodes during replay. We use this later to setup
1373 * block bitmaps correctly.
1374 */
1375static int ext4_fc_record_modified_inode(struct super_block *sb, int ino)
1376{
1377 struct ext4_fc_replay_state *state;
1378 int i;
1379
1380 state = &EXT4_SB(sb)->s_fc_replay_state;
1381 for (i = 0; i < state->fc_modified_inodes_used; i++)
1382 if (state->fc_modified_inodes[i] == ino)
1383 return 0;
1384 if (state->fc_modified_inodes_used == state->fc_modified_inodes_size) {
1385 state->fc_modified_inodes_size +=
1386 EXT4_FC_REPLAY_REALLOC_INCREMENT;
1387 state->fc_modified_inodes = krealloc(
1388 state->fc_modified_inodes, sizeof(int) *
1389 state->fc_modified_inodes_size,
1390 GFP_KERNEL);
1391 if (!state->fc_modified_inodes)
1392 return -ENOMEM;
1393 }
1394 state->fc_modified_inodes[state->fc_modified_inodes_used++] = ino;
1395 return 0;
1396}
1397
1398/*
1399 * Inode replay function
1400 */
1401static int ext4_fc_replay_inode(struct super_block *sb, struct ext4_fc_tl *tl)
1402{
1403 struct ext4_fc_inode *fc_inode;
1404 struct ext4_inode *raw_inode;
1405 struct ext4_inode *raw_fc_inode;
1406 struct inode *inode = NULL;
1407 struct ext4_iloc iloc;
1408 int inode_len, ino, ret, tag = le16_to_cpu(tl->fc_tag);
1409 struct ext4_extent_header *eh;
1410
1411 fc_inode = (struct ext4_fc_inode *)ext4_fc_tag_val(tl);
1412
1413 ino = le32_to_cpu(fc_inode->fc_ino);
1414 trace_ext4_fc_replay(sb, tag, ino, 0, 0);
1415
1416 inode = ext4_iget(sb, ino, EXT4_IGET_NORMAL);
1417 if (!IS_ERR_OR_NULL(inode)) {
1418 ext4_ext_clear_bb(inode);
1419 iput(inode);
1420 }
1421
1422 ext4_fc_record_modified_inode(sb, ino);
1423
1424 raw_fc_inode = (struct ext4_inode *)fc_inode->fc_raw_inode;
1425 ret = ext4_get_fc_inode_loc(sb, ino, &iloc);
1426 if (ret)
1427 goto out;
1428
1429 inode_len = ext4_fc_tag_len(tl) - sizeof(struct ext4_fc_inode);
1430 raw_inode = ext4_raw_inode(&iloc);
1431
1432 memcpy(raw_inode, raw_fc_inode, offsetof(struct ext4_inode, i_block));
1433 memcpy(&raw_inode->i_generation, &raw_fc_inode->i_generation,
1434 inode_len - offsetof(struct ext4_inode, i_generation));
1435 if (le32_to_cpu(raw_inode->i_flags) & EXT4_EXTENTS_FL) {
1436 eh = (struct ext4_extent_header *)(&raw_inode->i_block[0]);
1437 if (eh->eh_magic != EXT4_EXT_MAGIC) {
1438 memset(eh, 0, sizeof(*eh));
1439 eh->eh_magic = EXT4_EXT_MAGIC;
1440 eh->eh_max = cpu_to_le16(
1441 (sizeof(raw_inode->i_block) -
1442 sizeof(struct ext4_extent_header))
1443 / sizeof(struct ext4_extent));
1444 }
1445 } else if (le32_to_cpu(raw_inode->i_flags) & EXT4_INLINE_DATA_FL) {
1446 memcpy(raw_inode->i_block, raw_fc_inode->i_block,
1447 sizeof(raw_inode->i_block));
1448 }
1449
1450 /* Immediately update the inode on disk. */
1451 ret = ext4_handle_dirty_metadata(NULL, NULL, iloc.bh);
1452 if (ret)
1453 goto out;
1454 ret = sync_dirty_buffer(iloc.bh);
1455 if (ret)
1456 goto out;
1457 ret = ext4_mark_inode_used(sb, ino);
1458 if (ret)
1459 goto out;
1460
1461 /* Given that we just wrote the inode on disk, this SHOULD succeed. */
1462 inode = ext4_iget(sb, ino, EXT4_IGET_NORMAL);
1463 if (IS_ERR_OR_NULL(inode)) {
1464 jbd_debug(1, "Inode not found.");
1465 return -EFSCORRUPTED;
1466 }
1467
1468 /*
1469 * Our allocator could have made different decisions than before
1470 * crashing. This should be fixed but until then, we calculate
1471 * the number of blocks the inode.
1472 */
1473 ext4_ext_replay_set_iblocks(inode);
1474
1475 inode->i_generation = le32_to_cpu(ext4_raw_inode(&iloc)->i_generation);
1476 ext4_reset_inode_seed(inode);
1477
1478 ext4_inode_csum_set(inode, ext4_raw_inode(&iloc), EXT4_I(inode));
1479 ret = ext4_handle_dirty_metadata(NULL, NULL, iloc.bh);
1480 sync_dirty_buffer(iloc.bh);
1481 brelse(iloc.bh);
1482out:
1483 iput(inode);
1484 if (!ret)
1485 blkdev_issue_flush(sb->s_bdev, GFP_KERNEL);
1486
1487 return 0;
1488}
1489
1490/*
1491 * Dentry create replay function.
1492 *
1493 * EXT4_FC_TAG_CREAT is preceded by EXT4_FC_TAG_INODE_FULL. Which means, the
1494 * inode for which we are trying to create a dentry here, should already have
1495 * been replayed before we start here.
1496 */
1497static int ext4_fc_replay_create(struct super_block *sb, struct ext4_fc_tl *tl)
1498{
1499 int ret = 0;
1500 struct inode *inode = NULL;
1501 struct inode *dir = NULL;
1502 struct dentry_info_args darg;
1503
1504 tl_to_darg(&darg, tl);
1505
1506 trace_ext4_fc_replay(sb, EXT4_FC_TAG_CREAT, darg.ino,
1507 darg.parent_ino, darg.dname_len);
1508
1509 /* This takes care of update group descriptor and other metadata */
1510 ret = ext4_mark_inode_used(sb, darg.ino);
1511 if (ret)
1512 goto out;
1513
1514 inode = ext4_iget(sb, darg.ino, EXT4_IGET_NORMAL);
1515 if (IS_ERR_OR_NULL(inode)) {
1516 jbd_debug(1, "inode %d not found.", darg.ino);
1517 inode = NULL;
1518 ret = -EINVAL;
1519 goto out;
1520 }
1521
1522 if (S_ISDIR(inode->i_mode)) {
1523 /*
1524 * If we are creating a directory, we need to make sure that the
1525 * dot and dot dot dirents are setup properly.
1526 */
1527 dir = ext4_iget(sb, darg.parent_ino, EXT4_IGET_NORMAL);
1528 if (IS_ERR_OR_NULL(dir)) {
1529 jbd_debug(1, "Dir %d not found.", darg.ino);
1530 goto out;
1531 }
1532 ret = ext4_init_new_dir(NULL, dir, inode);
1533 iput(dir);
1534 if (ret) {
1535 ret = 0;
1536 goto out;
1537 }
1538 }
1539 ret = ext4_fc_replay_link_internal(sb, &darg, inode);
1540 if (ret)
1541 goto out;
1542 set_nlink(inode, 1);
1543 ext4_mark_inode_dirty(NULL, inode);
1544out:
1545 if (inode)
1546 iput(inode);
1547 return ret;
1548}
1549
1550/*
1551 * Record physical disk regions which are in use as per fast commit area. Our
1552 * simple replay phase allocator excludes these regions from allocation.
1553 */
1554static int ext4_fc_record_regions(struct super_block *sb, int ino,
1555 ext4_lblk_t lblk, ext4_fsblk_t pblk, int len)
1556{
1557 struct ext4_fc_replay_state *state;
1558 struct ext4_fc_alloc_region *region;
1559
1560 state = &EXT4_SB(sb)->s_fc_replay_state;
1561 if (state->fc_regions_used == state->fc_regions_size) {
1562 state->fc_regions_size +=
1563 EXT4_FC_REPLAY_REALLOC_INCREMENT;
1564 state->fc_regions = krealloc(
1565 state->fc_regions,
1566 state->fc_regions_size *
1567 sizeof(struct ext4_fc_alloc_region),
1568 GFP_KERNEL);
1569 if (!state->fc_regions)
1570 return -ENOMEM;
1571 }
1572 region = &state->fc_regions[state->fc_regions_used++];
1573 region->ino = ino;
1574 region->lblk = lblk;
1575 region->pblk = pblk;
1576 region->len = len;
1577
1578 return 0;
1579}
1580
1581/* Replay add range tag */
1582static int ext4_fc_replay_add_range(struct super_block *sb,
1583 struct ext4_fc_tl *tl)
1584{
1585 struct ext4_fc_add_range *fc_add_ex;
1586 struct ext4_extent newex, *ex;
1587 struct inode *inode;
1588 ext4_lblk_t start, cur;
1589 int remaining, len;
1590 ext4_fsblk_t start_pblk;
1591 struct ext4_map_blocks map;
1592 struct ext4_ext_path *path = NULL;
1593 int ret;
1594
1595 fc_add_ex = (struct ext4_fc_add_range *)ext4_fc_tag_val(tl);
1596 ex = (struct ext4_extent *)&fc_add_ex->fc_ex;
1597
1598 trace_ext4_fc_replay(sb, EXT4_FC_TAG_ADD_RANGE,
1599 le32_to_cpu(fc_add_ex->fc_ino), le32_to_cpu(ex->ee_block),
1600 ext4_ext_get_actual_len(ex));
1601
1602 inode = ext4_iget(sb, le32_to_cpu(fc_add_ex->fc_ino),
1603 EXT4_IGET_NORMAL);
1604 if (IS_ERR_OR_NULL(inode)) {
1605 jbd_debug(1, "Inode not found.");
1606 return 0;
1607 }
1608
1609 ret = ext4_fc_record_modified_inode(sb, inode->i_ino);
1610
1611 start = le32_to_cpu(ex->ee_block);
1612 start_pblk = ext4_ext_pblock(ex);
1613 len = ext4_ext_get_actual_len(ex);
1614
1615 cur = start;
1616 remaining = len;
1617 jbd_debug(1, "ADD_RANGE, lblk %d, pblk %lld, len %d, unwritten %d, inode %ld\n",
1618 start, start_pblk, len, ext4_ext_is_unwritten(ex),
1619 inode->i_ino);
1620
1621 while (remaining > 0) {
1622 map.m_lblk = cur;
1623 map.m_len = remaining;
1624 map.m_pblk = 0;
1625 ret = ext4_map_blocks(NULL, inode, &map, 0);
1626
1627 if (ret < 0) {
1628 iput(inode);
1629 return 0;
1630 }
1631
1632 if (ret == 0) {
1633 /* Range is not mapped */
1634 path = ext4_find_extent(inode, cur, NULL, 0);
Harshad Shirwadkar8c9be1e2020-10-27 13:43:42 -07001635 if (IS_ERR(path)) {
1636 iput(inode);
1637 return 0;
1638 }
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07001639 memset(&newex, 0, sizeof(newex));
1640 newex.ee_block = cpu_to_le32(cur);
1641 ext4_ext_store_pblock(
1642 &newex, start_pblk + cur - start);
1643 newex.ee_len = cpu_to_le16(map.m_len);
1644 if (ext4_ext_is_unwritten(ex))
1645 ext4_ext_mark_unwritten(&newex);
1646 down_write(&EXT4_I(inode)->i_data_sem);
1647 ret = ext4_ext_insert_extent(
1648 NULL, inode, &path, &newex, 0);
1649 up_write((&EXT4_I(inode)->i_data_sem));
1650 ext4_ext_drop_refs(path);
1651 kfree(path);
1652 if (ret) {
1653 iput(inode);
1654 return 0;
1655 }
1656 goto next;
1657 }
1658
1659 if (start_pblk + cur - start != map.m_pblk) {
1660 /*
1661 * Logical to physical mapping changed. This can happen
1662 * if this range was removed and then reallocated to
1663 * map to new physical blocks during a fast commit.
1664 */
1665 ret = ext4_ext_replay_update_ex(inode, cur, map.m_len,
1666 ext4_ext_is_unwritten(ex),
1667 start_pblk + cur - start);
1668 if (ret) {
1669 iput(inode);
1670 return 0;
1671 }
1672 /*
1673 * Mark the old blocks as free since they aren't used
1674 * anymore. We maintain an array of all the modified
1675 * inodes. In case these blocks are still used at either
1676 * a different logical range in the same inode or in
1677 * some different inode, we will mark them as allocated
1678 * at the end of the FC replay using our array of
1679 * modified inodes.
1680 */
1681 ext4_mb_mark_bb(inode->i_sb, map.m_pblk, map.m_len, 0);
1682 goto next;
1683 }
1684
1685 /* Range is mapped and needs a state change */
1686 jbd_debug(1, "Converting from %d to %d %lld",
1687 map.m_flags & EXT4_MAP_UNWRITTEN,
1688 ext4_ext_is_unwritten(ex), map.m_pblk);
1689 ret = ext4_ext_replay_update_ex(inode, cur, map.m_len,
1690 ext4_ext_is_unwritten(ex), map.m_pblk);
1691 if (ret) {
1692 iput(inode);
1693 return 0;
1694 }
1695 /*
1696 * We may have split the extent tree while toggling the state.
1697 * Try to shrink the extent tree now.
1698 */
1699 ext4_ext_replay_shrink_inode(inode, start + len);
1700next:
1701 cur += map.m_len;
1702 remaining -= map.m_len;
1703 }
1704 ext4_ext_replay_shrink_inode(inode, i_size_read(inode) >>
1705 sb->s_blocksize_bits);
1706 iput(inode);
1707 return 0;
1708}
1709
1710/* Replay DEL_RANGE tag */
1711static int
1712ext4_fc_replay_del_range(struct super_block *sb, struct ext4_fc_tl *tl)
1713{
1714 struct inode *inode;
1715 struct ext4_fc_del_range *lrange;
1716 struct ext4_map_blocks map;
1717 ext4_lblk_t cur, remaining;
1718 int ret;
1719
1720 lrange = (struct ext4_fc_del_range *)ext4_fc_tag_val(tl);
1721 cur = le32_to_cpu(lrange->fc_lblk);
1722 remaining = le32_to_cpu(lrange->fc_len);
1723
1724 trace_ext4_fc_replay(sb, EXT4_FC_TAG_DEL_RANGE,
1725 le32_to_cpu(lrange->fc_ino), cur, remaining);
1726
1727 inode = ext4_iget(sb, le32_to_cpu(lrange->fc_ino), EXT4_IGET_NORMAL);
1728 if (IS_ERR_OR_NULL(inode)) {
1729 jbd_debug(1, "Inode %d not found", le32_to_cpu(lrange->fc_ino));
1730 return 0;
1731 }
1732
1733 ret = ext4_fc_record_modified_inode(sb, inode->i_ino);
1734
1735 jbd_debug(1, "DEL_RANGE, inode %ld, lblk %d, len %d\n",
1736 inode->i_ino, le32_to_cpu(lrange->fc_lblk),
1737 le32_to_cpu(lrange->fc_len));
1738 while (remaining > 0) {
1739 map.m_lblk = cur;
1740 map.m_len = remaining;
1741
1742 ret = ext4_map_blocks(NULL, inode, &map, 0);
1743 if (ret < 0) {
1744 iput(inode);
1745 return 0;
1746 }
1747 if (ret > 0) {
1748 remaining -= ret;
1749 cur += ret;
1750 ext4_mb_mark_bb(inode->i_sb, map.m_pblk, map.m_len, 0);
1751 } else {
1752 remaining -= map.m_len;
1753 cur += map.m_len;
1754 }
1755 }
1756
1757 ret = ext4_punch_hole(inode,
1758 le32_to_cpu(lrange->fc_lblk) << sb->s_blocksize_bits,
1759 le32_to_cpu(lrange->fc_len) << sb->s_blocksize_bits);
1760 if (ret)
1761 jbd_debug(1, "ext4_punch_hole returned %d", ret);
1762 ext4_ext_replay_shrink_inode(inode,
1763 i_size_read(inode) >> sb->s_blocksize_bits);
1764 ext4_mark_inode_dirty(NULL, inode);
1765 iput(inode);
1766
1767 return 0;
1768}
1769
1770static inline const char *tag2str(u16 tag)
1771{
1772 switch (tag) {
1773 case EXT4_FC_TAG_LINK:
1774 return "TAG_ADD_ENTRY";
1775 case EXT4_FC_TAG_UNLINK:
1776 return "TAG_DEL_ENTRY";
1777 case EXT4_FC_TAG_ADD_RANGE:
1778 return "TAG_ADD_RANGE";
1779 case EXT4_FC_TAG_CREAT:
1780 return "TAG_CREAT_DENTRY";
1781 case EXT4_FC_TAG_DEL_RANGE:
1782 return "TAG_DEL_RANGE";
1783 case EXT4_FC_TAG_INODE:
1784 return "TAG_INODE";
1785 case EXT4_FC_TAG_PAD:
1786 return "TAG_PAD";
1787 case EXT4_FC_TAG_TAIL:
1788 return "TAG_TAIL";
1789 case EXT4_FC_TAG_HEAD:
1790 return "TAG_HEAD";
1791 default:
1792 return "TAG_ERROR";
1793 }
1794}
1795
1796static void ext4_fc_set_bitmaps_and_counters(struct super_block *sb)
1797{
1798 struct ext4_fc_replay_state *state;
1799 struct inode *inode;
1800 struct ext4_ext_path *path = NULL;
1801 struct ext4_map_blocks map;
1802 int i, ret, j;
1803 ext4_lblk_t cur, end;
1804
1805 state = &EXT4_SB(sb)->s_fc_replay_state;
1806 for (i = 0; i < state->fc_modified_inodes_used; i++) {
1807 inode = ext4_iget(sb, state->fc_modified_inodes[i],
1808 EXT4_IGET_NORMAL);
1809 if (IS_ERR_OR_NULL(inode)) {
1810 jbd_debug(1, "Inode %d not found.",
1811 state->fc_modified_inodes[i]);
1812 continue;
1813 }
1814 cur = 0;
1815 end = EXT_MAX_BLOCKS;
1816 while (cur < end) {
1817 map.m_lblk = cur;
1818 map.m_len = end - cur;
1819
1820 ret = ext4_map_blocks(NULL, inode, &map, 0);
1821 if (ret < 0)
1822 break;
1823
1824 if (ret > 0) {
1825 path = ext4_find_extent(inode, map.m_lblk, NULL, 0);
1826 if (!IS_ERR_OR_NULL(path)) {
1827 for (j = 0; j < path->p_depth; j++)
1828 ext4_mb_mark_bb(inode->i_sb,
1829 path[j].p_block, 1, 1);
1830 ext4_ext_drop_refs(path);
1831 kfree(path);
1832 }
1833 cur += ret;
1834 ext4_mb_mark_bb(inode->i_sb, map.m_pblk,
1835 map.m_len, 1);
1836 } else {
1837 cur = cur + (map.m_len ? map.m_len : 1);
1838 }
1839 }
1840 iput(inode);
1841 }
1842}
1843
1844/*
1845 * Check if block is in excluded regions for block allocation. The simple
1846 * allocator that runs during replay phase is calls this function to see
1847 * if it is okay to use a block.
1848 */
1849bool ext4_fc_replay_check_excluded(struct super_block *sb, ext4_fsblk_t blk)
1850{
1851 int i;
1852 struct ext4_fc_replay_state *state;
1853
1854 state = &EXT4_SB(sb)->s_fc_replay_state;
1855 for (i = 0; i < state->fc_regions_valid; i++) {
1856 if (state->fc_regions[i].ino == 0 ||
1857 state->fc_regions[i].len == 0)
1858 continue;
1859 if (blk >= state->fc_regions[i].pblk &&
1860 blk < state->fc_regions[i].pblk + state->fc_regions[i].len)
1861 return true;
1862 }
1863 return false;
1864}
1865
1866/* Cleanup function called after replay */
1867void ext4_fc_replay_cleanup(struct super_block *sb)
1868{
1869 struct ext4_sb_info *sbi = EXT4_SB(sb);
1870
1871 sbi->s_mount_state &= ~EXT4_FC_REPLAY;
1872 kfree(sbi->s_fc_replay_state.fc_regions);
1873 kfree(sbi->s_fc_replay_state.fc_modified_inodes);
1874}
1875
1876/*
1877 * Recovery Scan phase handler
1878 *
1879 * This function is called during the scan phase and is responsible
1880 * for doing following things:
1881 * - Make sure the fast commit area has valid tags for replay
1882 * - Count number of tags that need to be replayed by the replay handler
1883 * - Verify CRC
1884 * - Create a list of excluded blocks for allocation during replay phase
1885 *
1886 * This function returns JBD2_FC_REPLAY_CONTINUE to indicate that SCAN is
1887 * incomplete and JBD2 should send more blocks. It returns JBD2_FC_REPLAY_STOP
1888 * to indicate that scan has finished and JBD2 can now start replay phase.
1889 * It returns a negative error to indicate that there was an error. At the end
1890 * of a successful scan phase, sbi->s_fc_replay_state.fc_replay_num_tags is set
1891 * to indicate the number of tags that need to replayed during the replay phase.
1892 */
1893static int ext4_fc_replay_scan(journal_t *journal,
1894 struct buffer_head *bh, int off,
1895 tid_t expected_tid)
1896{
1897 struct super_block *sb = journal->j_private;
1898 struct ext4_sb_info *sbi = EXT4_SB(sb);
1899 struct ext4_fc_replay_state *state;
1900 int ret = JBD2_FC_REPLAY_CONTINUE;
1901 struct ext4_fc_add_range *ext;
1902 struct ext4_fc_tl *tl;
1903 struct ext4_fc_tail *tail;
1904 __u8 *start, *end;
1905 struct ext4_fc_head *head;
1906 struct ext4_extent *ex;
1907
1908 state = &sbi->s_fc_replay_state;
1909
1910 start = (u8 *)bh->b_data;
1911 end = (__u8 *)bh->b_data + journal->j_blocksize - 1;
1912
1913 if (state->fc_replay_expected_off == 0) {
1914 state->fc_cur_tag = 0;
1915 state->fc_replay_num_tags = 0;
1916 state->fc_crc = 0;
1917 state->fc_regions = NULL;
1918 state->fc_regions_valid = state->fc_regions_used =
1919 state->fc_regions_size = 0;
1920 /* Check if we can stop early */
1921 if (le16_to_cpu(((struct ext4_fc_tl *)start)->fc_tag)
1922 != EXT4_FC_TAG_HEAD)
1923 return 0;
1924 }
1925
1926 if (off != state->fc_replay_expected_off) {
1927 ret = -EFSCORRUPTED;
1928 goto out_err;
1929 }
1930
1931 state->fc_replay_expected_off++;
1932 fc_for_each_tl(start, end, tl) {
1933 jbd_debug(3, "Scan phase, tag:%s, blk %lld\n",
1934 tag2str(le16_to_cpu(tl->fc_tag)), bh->b_blocknr);
1935 switch (le16_to_cpu(tl->fc_tag)) {
1936 case EXT4_FC_TAG_ADD_RANGE:
1937 ext = (struct ext4_fc_add_range *)ext4_fc_tag_val(tl);
1938 ex = (struct ext4_extent *)&ext->fc_ex;
1939 ret = ext4_fc_record_regions(sb,
1940 le32_to_cpu(ext->fc_ino),
1941 le32_to_cpu(ex->ee_block), ext4_ext_pblock(ex),
1942 ext4_ext_get_actual_len(ex));
1943 if (ret < 0)
1944 break;
1945 ret = JBD2_FC_REPLAY_CONTINUE;
1946 fallthrough;
1947 case EXT4_FC_TAG_DEL_RANGE:
1948 case EXT4_FC_TAG_LINK:
1949 case EXT4_FC_TAG_UNLINK:
1950 case EXT4_FC_TAG_CREAT:
1951 case EXT4_FC_TAG_INODE:
1952 case EXT4_FC_TAG_PAD:
1953 state->fc_cur_tag++;
1954 state->fc_crc = ext4_chksum(sbi, state->fc_crc, tl,
1955 sizeof(*tl) + ext4_fc_tag_len(tl));
1956 break;
1957 case EXT4_FC_TAG_TAIL:
1958 state->fc_cur_tag++;
1959 tail = (struct ext4_fc_tail *)ext4_fc_tag_val(tl);
1960 state->fc_crc = ext4_chksum(sbi, state->fc_crc, tl,
1961 sizeof(*tl) +
1962 offsetof(struct ext4_fc_tail,
1963 fc_crc));
1964 if (le32_to_cpu(tail->fc_tid) == expected_tid &&
1965 le32_to_cpu(tail->fc_crc) == state->fc_crc) {
1966 state->fc_replay_num_tags = state->fc_cur_tag;
1967 state->fc_regions_valid =
1968 state->fc_regions_used;
1969 } else {
1970 ret = state->fc_replay_num_tags ?
1971 JBD2_FC_REPLAY_STOP : -EFSBADCRC;
1972 }
1973 state->fc_crc = 0;
1974 break;
1975 case EXT4_FC_TAG_HEAD:
1976 head = (struct ext4_fc_head *)ext4_fc_tag_val(tl);
1977 if (le32_to_cpu(head->fc_features) &
1978 ~EXT4_FC_SUPPORTED_FEATURES) {
1979 ret = -EOPNOTSUPP;
1980 break;
1981 }
1982 if (le32_to_cpu(head->fc_tid) != expected_tid) {
1983 ret = JBD2_FC_REPLAY_STOP;
1984 break;
1985 }
1986 state->fc_cur_tag++;
1987 state->fc_crc = ext4_chksum(sbi, state->fc_crc, tl,
1988 sizeof(*tl) + ext4_fc_tag_len(tl));
1989 break;
1990 default:
1991 ret = state->fc_replay_num_tags ?
1992 JBD2_FC_REPLAY_STOP : -ECANCELED;
1993 }
1994 if (ret < 0 || ret == JBD2_FC_REPLAY_STOP)
1995 break;
1996 }
1997
1998out_err:
1999 trace_ext4_fc_replay_scan(sb, ret, off);
2000 return ret;
2001}
2002
Harshad Shirwadkar5b849b52020-10-15 13:37:58 -07002003/*
2004 * Main recovery path entry point.
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002005 * The meaning of return codes is similar as above.
Harshad Shirwadkar5b849b52020-10-15 13:37:58 -07002006 */
2007static int ext4_fc_replay(journal_t *journal, struct buffer_head *bh,
2008 enum passtype pass, int off, tid_t expected_tid)
2009{
Harshad Shirwadkar8016e292020-10-15 13:37:59 -07002010 struct super_block *sb = journal->j_private;
2011 struct ext4_sb_info *sbi = EXT4_SB(sb);
2012 struct ext4_fc_tl *tl;
2013 __u8 *start, *end;
2014 int ret = JBD2_FC_REPLAY_CONTINUE;
2015 struct ext4_fc_replay_state *state = &sbi->s_fc_replay_state;
2016 struct ext4_fc_tail *tail;
2017
2018 if (pass == PASS_SCAN) {
2019 state->fc_current_pass = PASS_SCAN;
2020 return ext4_fc_replay_scan(journal, bh, off, expected_tid);
2021 }
2022
2023 if (state->fc_current_pass != pass) {
2024 state->fc_current_pass = pass;
2025 sbi->s_mount_state |= EXT4_FC_REPLAY;
2026 }
2027 if (!sbi->s_fc_replay_state.fc_replay_num_tags) {
2028 jbd_debug(1, "Replay stops\n");
2029 ext4_fc_set_bitmaps_and_counters(sb);
2030 return 0;
2031 }
2032
2033#ifdef CONFIG_EXT4_DEBUG
2034 if (sbi->s_fc_debug_max_replay && off >= sbi->s_fc_debug_max_replay) {
2035 pr_warn("Dropping fc block %d because max_replay set\n", off);
2036 return JBD2_FC_REPLAY_STOP;
2037 }
2038#endif
2039
2040 start = (u8 *)bh->b_data;
2041 end = (__u8 *)bh->b_data + journal->j_blocksize - 1;
2042
2043 fc_for_each_tl(start, end, tl) {
2044 if (state->fc_replay_num_tags == 0) {
2045 ret = JBD2_FC_REPLAY_STOP;
2046 ext4_fc_set_bitmaps_and_counters(sb);
2047 break;
2048 }
2049 jbd_debug(3, "Replay phase, tag:%s\n",
2050 tag2str(le16_to_cpu(tl->fc_tag)));
2051 state->fc_replay_num_tags--;
2052 switch (le16_to_cpu(tl->fc_tag)) {
2053 case EXT4_FC_TAG_LINK:
2054 ret = ext4_fc_replay_link(sb, tl);
2055 break;
2056 case EXT4_FC_TAG_UNLINK:
2057 ret = ext4_fc_replay_unlink(sb, tl);
2058 break;
2059 case EXT4_FC_TAG_ADD_RANGE:
2060 ret = ext4_fc_replay_add_range(sb, tl);
2061 break;
2062 case EXT4_FC_TAG_CREAT:
2063 ret = ext4_fc_replay_create(sb, tl);
2064 break;
2065 case EXT4_FC_TAG_DEL_RANGE:
2066 ret = ext4_fc_replay_del_range(sb, tl);
2067 break;
2068 case EXT4_FC_TAG_INODE:
2069 ret = ext4_fc_replay_inode(sb, tl);
2070 break;
2071 case EXT4_FC_TAG_PAD:
2072 trace_ext4_fc_replay(sb, EXT4_FC_TAG_PAD, 0,
2073 ext4_fc_tag_len(tl), 0);
2074 break;
2075 case EXT4_FC_TAG_TAIL:
2076 trace_ext4_fc_replay(sb, EXT4_FC_TAG_TAIL, 0,
2077 ext4_fc_tag_len(tl), 0);
2078 tail = (struct ext4_fc_tail *)ext4_fc_tag_val(tl);
2079 WARN_ON(le32_to_cpu(tail->fc_tid) != expected_tid);
2080 break;
2081 case EXT4_FC_TAG_HEAD:
2082 break;
2083 default:
2084 trace_ext4_fc_replay(sb, le16_to_cpu(tl->fc_tag), 0,
2085 ext4_fc_tag_len(tl), 0);
2086 ret = -ECANCELED;
2087 break;
2088 }
2089 if (ret < 0)
2090 break;
2091 ret = JBD2_FC_REPLAY_CONTINUE;
2092 }
2093 return ret;
Harshad Shirwadkar5b849b52020-10-15 13:37:58 -07002094}
2095
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07002096void ext4_fc_init(struct super_block *sb, journal_t *journal)
2097{
Harshad Shirwadkar5b849b52020-10-15 13:37:58 -07002098 /*
2099 * We set replay callback even if fast commit disabled because we may
2100 * could still have fast commit blocks that need to be replayed even if
2101 * fast commit has now been turned off.
2102 */
2103 journal->j_fc_replay_callback = ext4_fc_replay;
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07002104 if (!test_opt2(sb, JOURNAL_FAST_COMMIT))
2105 return;
Harshad Shirwadkarff780b92020-10-15 13:37:56 -07002106 journal->j_fc_cleanup_callback = ext4_fc_cleanup;
Harshad Shirwadkar6866d7b2020-10-15 13:37:55 -07002107}
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002108
Harshad Shirwadkarce8c59d2020-10-15 13:38:01 -07002109const char *fc_ineligible_reasons[] = {
2110 "Extended attributes changed",
2111 "Cross rename",
2112 "Journal flag changed",
2113 "Insufficient memory",
2114 "Swap boot",
2115 "Resize",
2116 "Dir renamed",
2117 "Falloc range op",
Harshad Shirwadkar556e0312020-11-05 19:59:07 -08002118 "Data journalling",
Harshad Shirwadkarce8c59d2020-10-15 13:38:01 -07002119 "FC Commit Failed"
2120};
2121
2122int ext4_fc_info_show(struct seq_file *seq, void *v)
2123{
2124 struct ext4_sb_info *sbi = EXT4_SB((struct super_block *)seq->private);
2125 struct ext4_fc_stats *stats = &sbi->s_fc_stats;
2126 int i;
2127
2128 if (v != SEQ_START_TOKEN)
2129 return 0;
2130
2131 seq_printf(seq,
2132 "fc stats:\n%ld commits\n%ld ineligible\n%ld numblks\n%lluus avg_commit_time\n",
2133 stats->fc_num_commits, stats->fc_ineligible_commits,
2134 stats->fc_numblks,
2135 div_u64(sbi->s_fc_avg_commit_time, 1000));
2136 seq_puts(seq, "Ineligible reasons:\n");
2137 for (i = 0; i < EXT4_FC_REASON_MAX; i++)
2138 seq_printf(seq, "\"%s\":\t%d\n", fc_ineligible_reasons[i],
2139 stats->fc_ineligible_reason_count[i]);
2140
2141 return 0;
2142}
2143
Harshad Shirwadkaraa75f4d2020-10-15 13:37:57 -07002144int __init ext4_fc_init_dentry_cache(void)
2145{
2146 ext4_fc_dentry_cachep = KMEM_CACHE(ext4_fc_dentry_update,
2147 SLAB_RECLAIM_ACCOUNT);
2148
2149 if (ext4_fc_dentry_cachep == NULL)
2150 return -ENOMEM;
2151
2152 return 0;
2153}