xref: /linux/fs/xfs/xfs_error.h (revision a5155b870d687de1a5f07e774b49b1e8ef0f6f50)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef	__XFS_ERROR_H__
7 #define	__XFS_ERROR_H__
8 
9 struct xfs_mount;
10 
11 extern void xfs_error_report(const char *tag, int level, struct xfs_mount *mp,
12 			const char *filename, int linenum,
13 			xfs_failaddr_t failaddr);
14 extern void xfs_corruption_error(const char *tag, int level,
15 			struct xfs_mount *mp, const void *buf, size_t bufsize,
16 			const char *filename, int linenum,
17 			xfs_failaddr_t failaddr);
18 void xfs_buf_corruption_error(struct xfs_buf *bp);
19 extern void xfs_buf_verifier_error(struct xfs_buf *bp, int error,
20 			const char *name, const void *buf, size_t bufsz,
21 			xfs_failaddr_t failaddr);
22 extern void xfs_verifier_error(struct xfs_buf *bp, int error,
23 			xfs_failaddr_t failaddr);
24 extern void xfs_inode_verifier_error(struct xfs_inode *ip, int error,
25 			const char *name, const void *buf, size_t bufsz,
26 			xfs_failaddr_t failaddr);
27 
28 #define	XFS_ERROR_REPORT(e, lvl, mp)	\
29 	xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
30 #define	XFS_CORRUPTION_ERROR(e, lvl, mp, buf, bufsize)	\
31 	xfs_corruption_error(e, lvl, mp, buf, bufsize, \
32 			     __FILE__, __LINE__, __return_address)
33 
34 #define XFS_ERRLEVEL_OFF	0
35 #define XFS_ERRLEVEL_LOW	1
36 #define XFS_ERRLEVEL_HIGH	5
37 
38 /* Dump 128 bytes of any corrupt buffer */
39 #define XFS_CORRUPTION_DUMP_LEN		(128)
40 
41 /*
42  * Macros to set EFSCORRUPTED & return/branch.
43  */
44 #define	XFS_WANT_CORRUPTED_GOTO(mp, x, l)	\
45 	{ \
46 		int fs_is_ok = (x); \
47 		ASSERT(fs_is_ok); \
48 		if (unlikely(!fs_is_ok)) { \
49 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
50 					 XFS_ERRLEVEL_LOW, mp); \
51 			error = -EFSCORRUPTED; \
52 			goto l; \
53 		} \
54 	}
55 
56 #define	XFS_WANT_CORRUPTED_RETURN(mp, x)	\
57 	{ \
58 		int fs_is_ok = (x); \
59 		ASSERT(fs_is_ok); \
60 		if (unlikely(!fs_is_ok)) { \
61 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
62 					 XFS_ERRLEVEL_LOW, mp); \
63 			return -EFSCORRUPTED; \
64 		} \
65 	}
66 
67 #ifdef DEBUG
68 extern int xfs_errortag_init(struct xfs_mount *mp);
69 extern void xfs_errortag_del(struct xfs_mount *mp);
70 extern bool xfs_errortag_test(struct xfs_mount *mp, const char *expression,
71 		const char *file, int line, unsigned int error_tag);
72 #define XFS_TEST_ERROR(expr, mp, tag)		\
73 	((expr) || xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))
74 
75 extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
76 extern int xfs_errortag_set(struct xfs_mount *mp, unsigned int error_tag,
77 		unsigned int tag_value);
78 extern int xfs_errortag_add(struct xfs_mount *mp, unsigned int error_tag);
79 extern int xfs_errortag_clearall(struct xfs_mount *mp);
80 #else
81 #define xfs_errortag_init(mp)			(0)
82 #define xfs_errortag_del(mp)
83 #define XFS_TEST_ERROR(expr, mp, tag)		(expr)
84 #define xfs_errortag_set(mp, tag, val)		(ENOSYS)
85 #define xfs_errortag_add(mp, tag)		(ENOSYS)
86 #define xfs_errortag_clearall(mp)		(ENOSYS)
87 #endif /* DEBUG */
88 
89 /*
90  * XFS panic tags -- allow a call to xfs_alert_tag() be turned into
91  *			a panic by setting xfs_panic_mask in a sysctl.
92  */
93 #define		XFS_NO_PTAG			0
94 #define		XFS_PTAG_IFLUSH			0x00000001
95 #define		XFS_PTAG_LOGRES			0x00000002
96 #define		XFS_PTAG_AILDELETE		0x00000004
97 #define		XFS_PTAG_ERROR_REPORT		0x00000008
98 #define		XFS_PTAG_SHUTDOWN_CORRUPT	0x00000010
99 #define		XFS_PTAG_SHUTDOWN_IOERROR	0x00000020
100 #define		XFS_PTAG_SHUTDOWN_LOGERROR	0x00000040
101 #define		XFS_PTAG_FSBLOCK_ZERO		0x00000080
102 #define		XFS_PTAG_VERIFIER_ERROR		0x00000100
103 
104 #endif	/* __XFS_ERROR_H__ */
105