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