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