ext4: save the error code which triggered an ext4_error() in the superblock
[linux-block.git] / fs / ext4 / mmp.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
c5e06d10
JL
2#include <linux/fs.h>
3#include <linux/random.h>
4#include <linux/buffer_head.h>
5#include <linux/utsname.h>
6#include <linux/kthread.h>
7
8#include "ext4.h"
9
5c359a47 10/* Checksumming functions */
171a7f21 11static __le32 ext4_mmp_csum(struct super_block *sb, struct mmp_struct *mmp)
5c359a47
DW
12{
13 struct ext4_sb_info *sbi = EXT4_SB(sb);
14 int offset = offsetof(struct mmp_struct, mmp_checksum);
15 __u32 csum;
16
17 csum = ext4_chksum(sbi, sbi->s_csum_seed, (char *)mmp, offset);
18
19 return cpu_to_le32(csum);
20}
21
c197855e 22static int ext4_mmp_csum_verify(struct super_block *sb, struct mmp_struct *mmp)
5c359a47 23{
9aa5d32b 24 if (!ext4_has_metadata_csum(sb))
5c359a47
DW
25 return 1;
26
27 return mmp->mmp_checksum == ext4_mmp_csum(sb, mmp);
28}
29
c197855e 30static void ext4_mmp_csum_set(struct super_block *sb, struct mmp_struct *mmp)
5c359a47 31{
9aa5d32b 32 if (!ext4_has_metadata_csum(sb))
5c359a47
DW
33 return;
34
35 mmp->mmp_checksum = ext4_mmp_csum(sb, mmp);
36}
37
c5e06d10 38/*
70fd7614 39 * Write the MMP block using REQ_SYNC to try to get the block on-disk
c5e06d10
JL
40 * faster.
41 */
5c359a47 42static int write_mmp_block(struct super_block *sb, struct buffer_head *bh)
c5e06d10 43{
5c359a47
DW
44 struct mmp_struct *mmp = (struct mmp_struct *)(bh->b_data);
45
8e8ad8a5
JK
46 /*
47 * We protect against freezing so that we don't create dirty buffers
48 * on frozen filesystem.
49 */
50 sb_start_write(sb);
5c359a47 51 ext4_mmp_csum_set(sb, mmp);
c5e06d10
JL
52 lock_buffer(bh);
53 bh->b_end_io = end_buffer_write_sync;
54 get_bh(bh);
70fd7614 55 submit_bh(REQ_OP_WRITE, REQ_SYNC | REQ_META | REQ_PRIO, bh);
c5e06d10 56 wait_on_buffer(bh);
8e8ad8a5 57 sb_end_write(sb);
c5e06d10
JL
58 if (unlikely(!buffer_uptodate(bh)))
59 return 1;
60
61 return 0;
62}
63
64/*
65 * Read the MMP block. It _must_ be read from disk and hence we clear the
66 * uptodate flag on the buffer.
67 */
68static int read_mmp_block(struct super_block *sb, struct buffer_head **bh,
69 ext4_fsblk_t mmp_block)
70{
71 struct mmp_struct *mmp;
98104468 72 int ret;
c5e06d10
JL
73
74 if (*bh)
75 clear_buffer_uptodate(*bh);
76
77 /* This would be sb_bread(sb, mmp_block), except we need to be sure
78 * that the MD RAID device cache has been bypassed, and that the read
79 * is not blocked in the elevator. */
98104468 80 if (!*bh) {
c5e06d10 81 *bh = sb_getblk(sb, mmp_block);
98104468
DC
82 if (!*bh) {
83 ret = -ENOMEM;
84 goto warn_exit;
c5e06d10
JL
85 }
86 }
98104468
DC
87
88 get_bh(*bh);
89 lock_buffer(*bh);
90 (*bh)->b_end_io = end_buffer_read_sync;
70fd7614 91 submit_bh(REQ_OP_READ, REQ_META | REQ_PRIO, *bh);
98104468
DC
92 wait_on_buffer(*bh);
93 if (!buffer_uptodate(*bh)) {
98104468
DC
94 ret = -EIO;
95 goto warn_exit;
c5e06d10 96 }
c5e06d10 97 mmp = (struct mmp_struct *)((*bh)->b_data);
03046886 98 if (le32_to_cpu(mmp->mmp_magic) != EXT4_MMP_MAGIC) {
6a797d27 99 ret = -EFSCORRUPTED;
03046886 100 goto warn_exit;
101 }
102 if (!ext4_mmp_csum_verify(sb, mmp)) {
6a797d27 103 ret = -EFSBADCRC;
03046886 104 goto warn_exit;
105 }
106 return 0;
98104468 107warn_exit:
03046886 108 brelse(*bh);
109 *bh = NULL;
98104468
DC
110 ext4_warning(sb, "Error %d while reading MMP block %llu",
111 ret, mmp_block);
112 return ret;
c5e06d10
JL
113}
114
115/*
116 * Dump as much information as possible to help the admin.
117 */
118void __dump_mmp_msg(struct super_block *sb, struct mmp_struct *mmp,
119 const char *function, unsigned int line, const char *msg)
120{
da0b5e40 121 __ext4_warning(sb, function, line, "%s", msg);
c5e06d10
JL
122 __ext4_warning(sb, function, line,
123 "MMP failure info: last update time: %llu, last update "
8d2ae1cb 124 "node: %s, last update device: %s",
c5e06d10
JL
125 (long long unsigned int) le64_to_cpu(mmp->mmp_time),
126 mmp->mmp_nodename, mmp->mmp_bdevname);
127}
128
129/*
130 * kmmpd will update the MMP sequence every s_mmp_update_interval seconds
131 */
132static int kmmpd(void *data)
133{
134 struct super_block *sb = ((struct mmpd_data *) data)->sb;
135 struct buffer_head *bh = ((struct mmpd_data *) data)->bh;
136 struct ext4_super_block *es = EXT4_SB(sb)->s_es;
137 struct mmp_struct *mmp;
138 ext4_fsblk_t mmp_block;
139 u32 seq = 0;
140 unsigned long failed_writes = 0;
141 int mmp_update_interval = le16_to_cpu(es->s_mmp_update_interval);
142 unsigned mmp_check_interval;
143 unsigned long last_update_time;
144 unsigned long diff;
145 int retval;
146
147 mmp_block = le64_to_cpu(es->s_mmp_block);
148 mmp = (struct mmp_struct *)(bh->b_data);
af123b37 149 mmp->mmp_time = cpu_to_le64(ktime_get_real_seconds());
c5e06d10
JL
150 /*
151 * Start with the higher mmp_check_interval and reduce it if
152 * the MMP block is being updated on time.
153 */
154 mmp_check_interval = max(EXT4_MMP_CHECK_MULT * mmp_update_interval,
155 EXT4_MMP_MIN_CHECK_INTERVAL);
156 mmp->mmp_check_interval = cpu_to_le16(mmp_check_interval);
157 bdevname(bh->b_bdev, mmp->mmp_bdevname);
158
215fc6af 159 memcpy(mmp->mmp_nodename, init_utsname()->nodename,
c5e06d10
JL
160 sizeof(mmp->mmp_nodename));
161
162 while (!kthread_should_stop()) {
163 if (++seq > EXT4_MMP_SEQ_MAX)
164 seq = 1;
165
166 mmp->mmp_seq = cpu_to_le32(seq);
af123b37 167 mmp->mmp_time = cpu_to_le64(ktime_get_real_seconds());
c5e06d10
JL
168 last_update_time = jiffies;
169
5c359a47 170 retval = write_mmp_block(sb, bh);
c5e06d10
JL
171 /*
172 * Don't spew too many error messages. Print one every
173 * (s_mmp_update_interval * 60) seconds.
174 */
bdfc230f 175 if (retval) {
878520ac
TT
176 if ((failed_writes % 60) == 0) {
177 ext4_set_errno(sb, -retval);
bdfc230f 178 ext4_error(sb, "Error writing to MMP block");
878520ac 179 }
c5e06d10
JL
180 failed_writes++;
181 }
182
183 if (!(le32_to_cpu(es->s_feature_incompat) &
184 EXT4_FEATURE_INCOMPAT_MMP)) {
185 ext4_warning(sb, "kmmpd being stopped since MMP feature"
186 " has been disabled.");
03046886 187 goto exit_thread;
c5e06d10
JL
188 }
189
2dca60d9
TT
190 if (sb_rdonly(sb))
191 break;
c5e06d10
JL
192
193 diff = jiffies - last_update_time;
194 if (diff < mmp_update_interval * HZ)
195 schedule_timeout_interruptible(mmp_update_interval *
196 HZ - diff);
197
198 /*
199 * We need to make sure that more than mmp_check_interval
200 * seconds have not passed since writing. If that has happened
201 * we need to check if the MMP block is as we left it.
202 */
203 diff = jiffies - last_update_time;
204 if (diff > mmp_check_interval * HZ) {
205 struct buffer_head *bh_check = NULL;
206 struct mmp_struct *mmp_check;
207
208 retval = read_mmp_block(sb, &bh_check, mmp_block);
209 if (retval) {
878520ac 210 ext4_set_errno(sb, -retval);
c5e06d10
JL
211 ext4_error(sb, "error reading MMP data: %d",
212 retval);
03046886 213 goto exit_thread;
c5e06d10
JL
214 }
215
216 mmp_check = (struct mmp_struct *)(bh_check->b_data);
217 if (mmp->mmp_seq != mmp_check->mmp_seq ||
218 memcmp(mmp->mmp_nodename, mmp_check->mmp_nodename,
219 sizeof(mmp->mmp_nodename))) {
220 dump_mmp_msg(sb, mmp_check,
221 "Error while updating MMP info. "
222 "The filesystem seems to have been"
223 " multiply mounted.");
878520ac 224 ext4_set_errno(sb, EBUSY);
c5e06d10 225 ext4_error(sb, "abort");
03046886 226 put_bh(bh_check);
227 retval = -EBUSY;
228 goto exit_thread;
c5e06d10
JL
229 }
230 put_bh(bh_check);
231 }
232
233 /*
234 * Adjust the mmp_check_interval depending on how much time
235 * it took for the MMP block to be written.
236 */
237 mmp_check_interval = max(min(EXT4_MMP_CHECK_MULT * diff / HZ,
238 EXT4_MMP_MAX_CHECK_INTERVAL),
239 EXT4_MMP_MIN_CHECK_INTERVAL);
240 mmp->mmp_check_interval = cpu_to_le16(mmp_check_interval);
241 }
242
243 /*
244 * Unmount seems to be clean.
245 */
246 mmp->mmp_seq = cpu_to_le32(EXT4_MMP_SEQ_CLEAN);
af123b37 247 mmp->mmp_time = cpu_to_le64(ktime_get_real_seconds());
c5e06d10 248
5c359a47 249 retval = write_mmp_block(sb, bh);
c5e06d10 250
03046886 251exit_thread:
252 EXT4_SB(sb)->s_mmp_tsk = NULL;
c5e06d10
JL
253 kfree(data);
254 brelse(bh);
255 return retval;
256}
257
258/*
259 * Get a random new sequence number but make sure it is not greater than
260 * EXT4_MMP_SEQ_MAX.
261 */
262static unsigned int mmp_new_seq(void)
263{
264 u32 new_seq;
265
266 do {
dd1f723b 267 new_seq = prandom_u32();
c5e06d10
JL
268 } while (new_seq > EXT4_MMP_SEQ_MAX);
269
270 return new_seq;
271}
272
273/*
274 * Protect the filesystem from being mounted more than once.
275 */
276int ext4_multi_mount_protect(struct super_block *sb,
277 ext4_fsblk_t mmp_block)
278{
279 struct ext4_super_block *es = EXT4_SB(sb)->s_es;
280 struct buffer_head *bh = NULL;
281 struct mmp_struct *mmp = NULL;
282 struct mmpd_data *mmpd_data;
283 u32 seq;
284 unsigned int mmp_check_interval = le16_to_cpu(es->s_mmp_update_interval);
285 unsigned int wait_time = 0;
286 int retval;
287
288 if (mmp_block < le32_to_cpu(es->s_first_data_block) ||
289 mmp_block >= ext4_blocks_count(es)) {
290 ext4_warning(sb, "Invalid MMP block in superblock");
291 goto failed;
292 }
293
294 retval = read_mmp_block(sb, &bh, mmp_block);
295 if (retval)
296 goto failed;
297
298 mmp = (struct mmp_struct *)(bh->b_data);
299
300 if (mmp_check_interval < EXT4_MMP_MIN_CHECK_INTERVAL)
301 mmp_check_interval = EXT4_MMP_MIN_CHECK_INTERVAL;
302
303 /*
304 * If check_interval in MMP block is larger, use that instead of
305 * update_interval from the superblock.
306 */
85d21650
SN
307 if (le16_to_cpu(mmp->mmp_check_interval) > mmp_check_interval)
308 mmp_check_interval = le16_to_cpu(mmp->mmp_check_interval);
c5e06d10
JL
309
310 seq = le32_to_cpu(mmp->mmp_seq);
311 if (seq == EXT4_MMP_SEQ_CLEAN)
312 goto skip;
313
314 if (seq == EXT4_MMP_SEQ_FSCK) {
315 dump_mmp_msg(sb, mmp, "fsck is running on the filesystem");
316 goto failed;
317 }
318
319 wait_time = min(mmp_check_interval * 2 + 1,
320 mmp_check_interval + 60);
321
322 /* Print MMP interval if more than 20 secs. */
323 if (wait_time > EXT4_MMP_MIN_CHECK_INTERVAL * 4)
324 ext4_warning(sb, "MMP interval %u higher than expected, please"
325 " wait.\n", wait_time * 2);
326
327 if (schedule_timeout_interruptible(HZ * wait_time) != 0) {
328 ext4_warning(sb, "MMP startup interrupted, failing mount\n");
329 goto failed;
330 }
331
332 retval = read_mmp_block(sb, &bh, mmp_block);
333 if (retval)
334 goto failed;
335 mmp = (struct mmp_struct *)(bh->b_data);
336 if (seq != le32_to_cpu(mmp->mmp_seq)) {
337 dump_mmp_msg(sb, mmp,
338 "Device is already active on another node.");
339 goto failed;
340 }
341
342skip:
343 /*
344 * write a new random sequence number.
345 */
f6f96fdb
DW
346 seq = mmp_new_seq();
347 mmp->mmp_seq = cpu_to_le32(seq);
c5e06d10 348
5c359a47 349 retval = write_mmp_block(sb, bh);
c5e06d10
JL
350 if (retval)
351 goto failed;
352
353 /*
354 * wait for MMP interval and check mmp_seq.
355 */
356 if (schedule_timeout_interruptible(HZ * wait_time) != 0) {
8d2ae1cb 357 ext4_warning(sb, "MMP startup interrupted, failing mount");
c5e06d10
JL
358 goto failed;
359 }
360
361 retval = read_mmp_block(sb, &bh, mmp_block);
362 if (retval)
363 goto failed;
364 mmp = (struct mmp_struct *)(bh->b_data);
365 if (seq != le32_to_cpu(mmp->mmp_seq)) {
366 dump_mmp_msg(sb, mmp,
367 "Device is already active on another node.");
368 goto failed;
369 }
370
d695a1be 371 mmpd_data = kmalloc(sizeof(*mmpd_data), GFP_KERNEL);
c5e06d10
JL
372 if (!mmpd_data) {
373 ext4_warning(sb, "not enough memory for mmpd_data");
374 goto failed;
375 }
376 mmpd_data->sb = sb;
377 mmpd_data->bh = bh;
378
379 /*
380 * Start a kernel thread to update the MMP block periodically.
381 */
382 EXT4_SB(sb)->s_mmp_tsk = kthread_run(kmmpd, mmpd_data, "kmmpd-%s",
383 bdevname(bh->b_bdev,
384 mmp->mmp_bdevname));
385 if (IS_ERR(EXT4_SB(sb)->s_mmp_tsk)) {
386 EXT4_SB(sb)->s_mmp_tsk = NULL;
387 kfree(mmpd_data);
388 ext4_warning(sb, "Unable to create kmmpd thread for %s.",
389 sb->s_id);
390 goto failed;
391 }
392
393 return 0;
394
395failed:
396 brelse(bh);
397 return 1;
398}
399
400