xref: /kernel/linux/linux-5.10/fs/xfs/xfs_error.c (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6#include "xfs.h"
7#include "xfs_shared.h"
8#include "xfs_format.h"
9#include "xfs_fs.h"
10#include "xfs_log_format.h"
11#include "xfs_trans_resv.h"
12#include "xfs_mount.h"
13#include "xfs_errortag.h"
14#include "xfs_error.h"
15#include "xfs_sysfs.h"
16#include "xfs_inode.h"
17
18#ifdef DEBUG
19
20static unsigned int xfs_errortag_random_default[] = {
21	XFS_RANDOM_DEFAULT,
22	XFS_RANDOM_IFLUSH_1,
23	XFS_RANDOM_IFLUSH_2,
24	XFS_RANDOM_IFLUSH_3,
25	XFS_RANDOM_IFLUSH_4,
26	XFS_RANDOM_IFLUSH_5,
27	XFS_RANDOM_IFLUSH_6,
28	XFS_RANDOM_DA_READ_BUF,
29	XFS_RANDOM_BTREE_CHECK_LBLOCK,
30	XFS_RANDOM_BTREE_CHECK_SBLOCK,
31	XFS_RANDOM_ALLOC_READ_AGF,
32	XFS_RANDOM_IALLOC_READ_AGI,
33	XFS_RANDOM_ITOBP_INOTOBP,
34	XFS_RANDOM_IUNLINK,
35	XFS_RANDOM_IUNLINK_REMOVE,
36	XFS_RANDOM_DIR_INO_VALIDATE,
37	XFS_RANDOM_BULKSTAT_READ_CHUNK,
38	XFS_RANDOM_IODONE_IOERR,
39	XFS_RANDOM_STRATREAD_IOERR,
40	XFS_RANDOM_STRATCMPL_IOERR,
41	XFS_RANDOM_DIOWRITE_IOERR,
42	XFS_RANDOM_BMAPIFORMAT,
43	XFS_RANDOM_FREE_EXTENT,
44	XFS_RANDOM_RMAP_FINISH_ONE,
45	XFS_RANDOM_REFCOUNT_CONTINUE_UPDATE,
46	XFS_RANDOM_REFCOUNT_FINISH_ONE,
47	XFS_RANDOM_BMAP_FINISH_ONE,
48	XFS_RANDOM_AG_RESV_CRITICAL,
49	XFS_RANDOM_DROP_WRITES,
50	XFS_RANDOM_LOG_BAD_CRC,
51	XFS_RANDOM_LOG_ITEM_PIN,
52	XFS_RANDOM_BUF_LRU_REF,
53	XFS_RANDOM_FORCE_SCRUB_REPAIR,
54	XFS_RANDOM_FORCE_SUMMARY_RECALC,
55	XFS_RANDOM_IUNLINK_FALLBACK,
56	XFS_RANDOM_BUF_IOERROR,
57};
58
59struct xfs_errortag_attr {
60	struct attribute	attr;
61	unsigned int		tag;
62};
63
64static inline struct xfs_errortag_attr *
65to_attr(struct attribute *attr)
66{
67	return container_of(attr, struct xfs_errortag_attr, attr);
68}
69
70static inline struct xfs_mount *
71to_mp(struct kobject *kobject)
72{
73	struct xfs_kobj *kobj = to_kobj(kobject);
74
75	return container_of(kobj, struct xfs_mount, m_errortag_kobj);
76}
77
78STATIC ssize_t
79xfs_errortag_attr_store(
80	struct kobject		*kobject,
81	struct attribute	*attr,
82	const char		*buf,
83	size_t			count)
84{
85	struct xfs_mount	*mp = to_mp(kobject);
86	struct xfs_errortag_attr *xfs_attr = to_attr(attr);
87	int			ret;
88	unsigned int		val;
89
90	if (strcmp(buf, "default") == 0) {
91		val = xfs_errortag_random_default[xfs_attr->tag];
92	} else {
93		ret = kstrtouint(buf, 0, &val);
94		if (ret)
95			return ret;
96	}
97
98	ret = xfs_errortag_set(mp, xfs_attr->tag, val);
99	if (ret)
100		return ret;
101	return count;
102}
103
104STATIC ssize_t
105xfs_errortag_attr_show(
106	struct kobject		*kobject,
107	struct attribute	*attr,
108	char			*buf)
109{
110	struct xfs_mount	*mp = to_mp(kobject);
111	struct xfs_errortag_attr *xfs_attr = to_attr(attr);
112
113	return snprintf(buf, PAGE_SIZE, "%u\n",
114			xfs_errortag_get(mp, xfs_attr->tag));
115}
116
117static const struct sysfs_ops xfs_errortag_sysfs_ops = {
118	.show = xfs_errortag_attr_show,
119	.store = xfs_errortag_attr_store,
120};
121
122#define XFS_ERRORTAG_ATTR_RW(_name, _tag) \
123static struct xfs_errortag_attr xfs_errortag_attr_##_name = {		\
124	.attr = {.name = __stringify(_name),				\
125		 .mode = VERIFY_OCTAL_PERMISSIONS(S_IWUSR | S_IRUGO) },	\
126	.tag	= (_tag),						\
127}
128
129#define XFS_ERRORTAG_ATTR_LIST(_name) &xfs_errortag_attr_##_name.attr
130
131XFS_ERRORTAG_ATTR_RW(noerror,		XFS_ERRTAG_NOERROR);
132XFS_ERRORTAG_ATTR_RW(iflush1,		XFS_ERRTAG_IFLUSH_1);
133XFS_ERRORTAG_ATTR_RW(iflush2,		XFS_ERRTAG_IFLUSH_2);
134XFS_ERRORTAG_ATTR_RW(iflush3,		XFS_ERRTAG_IFLUSH_3);
135XFS_ERRORTAG_ATTR_RW(iflush4,		XFS_ERRTAG_IFLUSH_4);
136XFS_ERRORTAG_ATTR_RW(iflush5,		XFS_ERRTAG_IFLUSH_5);
137XFS_ERRORTAG_ATTR_RW(iflush6,		XFS_ERRTAG_IFLUSH_6);
138XFS_ERRORTAG_ATTR_RW(dareadbuf,		XFS_ERRTAG_DA_READ_BUF);
139XFS_ERRORTAG_ATTR_RW(btree_chk_lblk,	XFS_ERRTAG_BTREE_CHECK_LBLOCK);
140XFS_ERRORTAG_ATTR_RW(btree_chk_sblk,	XFS_ERRTAG_BTREE_CHECK_SBLOCK);
141XFS_ERRORTAG_ATTR_RW(readagf,		XFS_ERRTAG_ALLOC_READ_AGF);
142XFS_ERRORTAG_ATTR_RW(readagi,		XFS_ERRTAG_IALLOC_READ_AGI);
143XFS_ERRORTAG_ATTR_RW(itobp,		XFS_ERRTAG_ITOBP_INOTOBP);
144XFS_ERRORTAG_ATTR_RW(iunlink,		XFS_ERRTAG_IUNLINK);
145XFS_ERRORTAG_ATTR_RW(iunlinkrm,		XFS_ERRTAG_IUNLINK_REMOVE);
146XFS_ERRORTAG_ATTR_RW(dirinovalid,	XFS_ERRTAG_DIR_INO_VALIDATE);
147XFS_ERRORTAG_ATTR_RW(bulkstat,		XFS_ERRTAG_BULKSTAT_READ_CHUNK);
148XFS_ERRORTAG_ATTR_RW(logiodone,		XFS_ERRTAG_IODONE_IOERR);
149XFS_ERRORTAG_ATTR_RW(stratread,		XFS_ERRTAG_STRATREAD_IOERR);
150XFS_ERRORTAG_ATTR_RW(stratcmpl,		XFS_ERRTAG_STRATCMPL_IOERR);
151XFS_ERRORTAG_ATTR_RW(diowrite,		XFS_ERRTAG_DIOWRITE_IOERR);
152XFS_ERRORTAG_ATTR_RW(bmapifmt,		XFS_ERRTAG_BMAPIFORMAT);
153XFS_ERRORTAG_ATTR_RW(free_extent,	XFS_ERRTAG_FREE_EXTENT);
154XFS_ERRORTAG_ATTR_RW(rmap_finish_one,	XFS_ERRTAG_RMAP_FINISH_ONE);
155XFS_ERRORTAG_ATTR_RW(refcount_continue_update,	XFS_ERRTAG_REFCOUNT_CONTINUE_UPDATE);
156XFS_ERRORTAG_ATTR_RW(refcount_finish_one,	XFS_ERRTAG_REFCOUNT_FINISH_ONE);
157XFS_ERRORTAG_ATTR_RW(bmap_finish_one,	XFS_ERRTAG_BMAP_FINISH_ONE);
158XFS_ERRORTAG_ATTR_RW(ag_resv_critical,	XFS_ERRTAG_AG_RESV_CRITICAL);
159XFS_ERRORTAG_ATTR_RW(drop_writes,	XFS_ERRTAG_DROP_WRITES);
160XFS_ERRORTAG_ATTR_RW(log_bad_crc,	XFS_ERRTAG_LOG_BAD_CRC);
161XFS_ERRORTAG_ATTR_RW(log_item_pin,	XFS_ERRTAG_LOG_ITEM_PIN);
162XFS_ERRORTAG_ATTR_RW(buf_lru_ref,	XFS_ERRTAG_BUF_LRU_REF);
163XFS_ERRORTAG_ATTR_RW(force_repair,	XFS_ERRTAG_FORCE_SCRUB_REPAIR);
164XFS_ERRORTAG_ATTR_RW(bad_summary,	XFS_ERRTAG_FORCE_SUMMARY_RECALC);
165XFS_ERRORTAG_ATTR_RW(iunlink_fallback,	XFS_ERRTAG_IUNLINK_FALLBACK);
166XFS_ERRORTAG_ATTR_RW(buf_ioerror,	XFS_ERRTAG_BUF_IOERROR);
167
168static struct attribute *xfs_errortag_attrs[] = {
169	XFS_ERRORTAG_ATTR_LIST(noerror),
170	XFS_ERRORTAG_ATTR_LIST(iflush1),
171	XFS_ERRORTAG_ATTR_LIST(iflush2),
172	XFS_ERRORTAG_ATTR_LIST(iflush3),
173	XFS_ERRORTAG_ATTR_LIST(iflush4),
174	XFS_ERRORTAG_ATTR_LIST(iflush5),
175	XFS_ERRORTAG_ATTR_LIST(iflush6),
176	XFS_ERRORTAG_ATTR_LIST(dareadbuf),
177	XFS_ERRORTAG_ATTR_LIST(btree_chk_lblk),
178	XFS_ERRORTAG_ATTR_LIST(btree_chk_sblk),
179	XFS_ERRORTAG_ATTR_LIST(readagf),
180	XFS_ERRORTAG_ATTR_LIST(readagi),
181	XFS_ERRORTAG_ATTR_LIST(itobp),
182	XFS_ERRORTAG_ATTR_LIST(iunlink),
183	XFS_ERRORTAG_ATTR_LIST(iunlinkrm),
184	XFS_ERRORTAG_ATTR_LIST(dirinovalid),
185	XFS_ERRORTAG_ATTR_LIST(bulkstat),
186	XFS_ERRORTAG_ATTR_LIST(logiodone),
187	XFS_ERRORTAG_ATTR_LIST(stratread),
188	XFS_ERRORTAG_ATTR_LIST(stratcmpl),
189	XFS_ERRORTAG_ATTR_LIST(diowrite),
190	XFS_ERRORTAG_ATTR_LIST(bmapifmt),
191	XFS_ERRORTAG_ATTR_LIST(free_extent),
192	XFS_ERRORTAG_ATTR_LIST(rmap_finish_one),
193	XFS_ERRORTAG_ATTR_LIST(refcount_continue_update),
194	XFS_ERRORTAG_ATTR_LIST(refcount_finish_one),
195	XFS_ERRORTAG_ATTR_LIST(bmap_finish_one),
196	XFS_ERRORTAG_ATTR_LIST(ag_resv_critical),
197	XFS_ERRORTAG_ATTR_LIST(drop_writes),
198	XFS_ERRORTAG_ATTR_LIST(log_bad_crc),
199	XFS_ERRORTAG_ATTR_LIST(log_item_pin),
200	XFS_ERRORTAG_ATTR_LIST(buf_lru_ref),
201	XFS_ERRORTAG_ATTR_LIST(force_repair),
202	XFS_ERRORTAG_ATTR_LIST(bad_summary),
203	XFS_ERRORTAG_ATTR_LIST(iunlink_fallback),
204	XFS_ERRORTAG_ATTR_LIST(buf_ioerror),
205	NULL,
206};
207
208static struct kobj_type xfs_errortag_ktype = {
209	.release = xfs_sysfs_release,
210	.sysfs_ops = &xfs_errortag_sysfs_ops,
211	.default_attrs = xfs_errortag_attrs,
212};
213
214int
215xfs_errortag_init(
216	struct xfs_mount	*mp)
217{
218	mp->m_errortag = kmem_zalloc(sizeof(unsigned int) * XFS_ERRTAG_MAX,
219			KM_MAYFAIL);
220	if (!mp->m_errortag)
221		return -ENOMEM;
222
223	return xfs_sysfs_init(&mp->m_errortag_kobj, &xfs_errortag_ktype,
224			       &mp->m_kobj, "errortag");
225}
226
227void
228xfs_errortag_del(
229	struct xfs_mount	*mp)
230{
231	xfs_sysfs_del(&mp->m_errortag_kobj);
232	kmem_free(mp->m_errortag);
233}
234
235bool
236xfs_errortag_test(
237	struct xfs_mount	*mp,
238	const char		*expression,
239	const char		*file,
240	int			line,
241	unsigned int		error_tag)
242{
243	unsigned int		randfactor;
244
245	/*
246	 * To be able to use error injection anywhere, we need to ensure error
247	 * injection mechanism is already initialized.
248	 *
249	 * Code paths like I/O completion can be called before the
250	 * initialization is complete, but be able to inject errors in such
251	 * places is still useful.
252	 */
253	if (!mp->m_errortag)
254		return false;
255
256	ASSERT(error_tag < XFS_ERRTAG_MAX);
257	randfactor = mp->m_errortag[error_tag];
258	if (!randfactor || prandom_u32() % randfactor)
259		return false;
260
261	xfs_warn_ratelimited(mp,
262"Injecting error (%s) at file %s, line %d, on filesystem \"%s\"",
263			expression, file, line, mp->m_super->s_id);
264	return true;
265}
266
267int
268xfs_errortag_get(
269	struct xfs_mount	*mp,
270	unsigned int		error_tag)
271{
272	if (error_tag >= XFS_ERRTAG_MAX)
273		return -EINVAL;
274
275	return mp->m_errortag[error_tag];
276}
277
278int
279xfs_errortag_set(
280	struct xfs_mount	*mp,
281	unsigned int		error_tag,
282	unsigned int		tag_value)
283{
284	if (error_tag >= XFS_ERRTAG_MAX)
285		return -EINVAL;
286
287	mp->m_errortag[error_tag] = tag_value;
288	return 0;
289}
290
291int
292xfs_errortag_add(
293	struct xfs_mount	*mp,
294	unsigned int		error_tag)
295{
296	BUILD_BUG_ON(ARRAY_SIZE(xfs_errortag_random_default) != XFS_ERRTAG_MAX);
297
298	if (error_tag >= XFS_ERRTAG_MAX)
299		return -EINVAL;
300
301	return xfs_errortag_set(mp, error_tag,
302			xfs_errortag_random_default[error_tag]);
303}
304
305int
306xfs_errortag_clearall(
307	struct xfs_mount	*mp)
308{
309	memset(mp->m_errortag, 0, sizeof(unsigned int) * XFS_ERRTAG_MAX);
310	return 0;
311}
312#endif /* DEBUG */
313
314void
315xfs_error_report(
316	const char		*tag,
317	int			level,
318	struct xfs_mount	*mp,
319	const char		*filename,
320	int			linenum,
321	xfs_failaddr_t		failaddr)
322{
323	if (level <= xfs_error_level) {
324		xfs_alert_tag(mp, XFS_PTAG_ERROR_REPORT,
325		"Internal error %s at line %d of file %s.  Caller %pS",
326			    tag, linenum, filename, failaddr);
327
328		xfs_stack_trace();
329	}
330}
331
332void
333xfs_corruption_error(
334	const char		*tag,
335	int			level,
336	struct xfs_mount	*mp,
337	const void		*buf,
338	size_t			bufsize,
339	const char		*filename,
340	int			linenum,
341	xfs_failaddr_t		failaddr)
342{
343	if (buf && level <= xfs_error_level)
344		xfs_hex_dump(buf, bufsize);
345	xfs_error_report(tag, level, mp, filename, linenum, failaddr);
346	xfs_alert(mp, "Corruption detected. Unmount and run xfs_repair");
347}
348
349/*
350 * Complain about the kinds of metadata corruption that we can't detect from a
351 * verifier, such as incorrect inter-block relationship data.  Does not set
352 * bp->b_error.
353 *
354 * Call xfs_buf_mark_corrupt, not this function.
355 */
356void
357xfs_buf_corruption_error(
358	struct xfs_buf		*bp,
359	xfs_failaddr_t		fa)
360{
361	struct xfs_mount	*mp = bp->b_mount;
362
363	xfs_alert_tag(mp, XFS_PTAG_VERIFIER_ERROR,
364		  "Metadata corruption detected at %pS, %s block 0x%llx",
365		  fa, bp->b_ops->name, bp->b_bn);
366
367	xfs_alert(mp, "Unmount and run xfs_repair");
368
369	if (xfs_error_level >= XFS_ERRLEVEL_HIGH)
370		xfs_stack_trace();
371}
372
373/*
374 * Warnings specifically for verifier errors.  Differentiate CRC vs. invalid
375 * values, and omit the stack trace unless the error level is tuned high.
376 */
377void
378xfs_buf_verifier_error(
379	struct xfs_buf		*bp,
380	int			error,
381	const char		*name,
382	const void		*buf,
383	size_t			bufsz,
384	xfs_failaddr_t		failaddr)
385{
386	struct xfs_mount	*mp = bp->b_mount;
387	xfs_failaddr_t		fa;
388	int			sz;
389
390	fa = failaddr ? failaddr : __return_address;
391	__xfs_buf_ioerror(bp, error, fa);
392
393	xfs_alert_tag(mp, XFS_PTAG_VERIFIER_ERROR,
394		  "Metadata %s detected at %pS, %s block 0x%llx %s",
395		  bp->b_error == -EFSBADCRC ? "CRC error" : "corruption",
396		  fa, bp->b_ops->name, bp->b_bn, name);
397
398	xfs_alert(mp, "Unmount and run xfs_repair");
399
400	if (xfs_error_level >= XFS_ERRLEVEL_LOW) {
401		sz = min_t(size_t, XFS_CORRUPTION_DUMP_LEN, bufsz);
402		xfs_alert(mp, "First %d bytes of corrupted metadata buffer:",
403				sz);
404		xfs_hex_dump(buf, sz);
405	}
406
407	if (xfs_error_level >= XFS_ERRLEVEL_HIGH)
408		xfs_stack_trace();
409}
410
411/*
412 * Warnings specifically for verifier errors.  Differentiate CRC vs. invalid
413 * values, and omit the stack trace unless the error level is tuned high.
414 */
415void
416xfs_verifier_error(
417	struct xfs_buf		*bp,
418	int			error,
419	xfs_failaddr_t		failaddr)
420{
421	return xfs_buf_verifier_error(bp, error, "", xfs_buf_offset(bp, 0),
422			XFS_CORRUPTION_DUMP_LEN, failaddr);
423}
424
425/*
426 * Warnings for inode corruption problems.  Don't bother with the stack
427 * trace unless the error level is turned up high.
428 */
429void
430xfs_inode_verifier_error(
431	struct xfs_inode	*ip,
432	int			error,
433	const char		*name,
434	const void		*buf,
435	size_t			bufsz,
436	xfs_failaddr_t		failaddr)
437{
438	struct xfs_mount	*mp = ip->i_mount;
439	xfs_failaddr_t		fa;
440	int			sz;
441
442	fa = failaddr ? failaddr : __return_address;
443
444	xfs_alert(mp, "Metadata %s detected at %pS, inode 0x%llx %s",
445		  error == -EFSBADCRC ? "CRC error" : "corruption",
446		  fa, ip->i_ino, name);
447
448	xfs_alert(mp, "Unmount and run xfs_repair");
449
450	if (buf && xfs_error_level >= XFS_ERRLEVEL_LOW) {
451		sz = min_t(size_t, XFS_CORRUPTION_DUMP_LEN, bufsz);
452		xfs_alert(mp, "First %d bytes of corrupted metadata buffer:",
453				sz);
454		xfs_hex_dump(buf, sz);
455	}
456
457	if (xfs_error_level >= XFS_ERRLEVEL_HIGH)
458		xfs_stack_trace();
459}
460