xref: /openbmc/linux/fs/xfs/xfs_error.h (revision 94cdda6b)
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, inst_t *ra);
25 extern void xfs_corruption_error(const char *tag, int level,
26 			struct xfs_mount *mp, void *p, const char *filename,
27 			int linenum, inst_t *ra);
28 extern void xfs_verifier_error(struct xfs_buf *bp);
29 
30 #define	XFS_ERROR_REPORT(e, lvl, mp)	\
31 	xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
32 #define	XFS_CORRUPTION_ERROR(e, lvl, mp, mem)	\
33 	xfs_corruption_error(e, lvl, mp, mem, \
34 			     __FILE__, __LINE__, __return_address)
35 
36 #define XFS_ERRLEVEL_OFF	0
37 #define XFS_ERRLEVEL_LOW	1
38 #define XFS_ERRLEVEL_HIGH	5
39 
40 /*
41  * Macros to set EFSCORRUPTED & return/branch.
42  */
43 #define	XFS_WANT_CORRUPTED_GOTO(mp, x, l)	\
44 	{ \
45 		int fs_is_ok = (x); \
46 		ASSERT(fs_is_ok); \
47 		if (unlikely(!fs_is_ok)) { \
48 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
49 					 XFS_ERRLEVEL_LOW, mp); \
50 			error = -EFSCORRUPTED; \
51 			goto l; \
52 		} \
53 	}
54 
55 #define	XFS_WANT_CORRUPTED_RETURN(mp, x)	\
56 	{ \
57 		int fs_is_ok = (x); \
58 		ASSERT(fs_is_ok); \
59 		if (unlikely(!fs_is_ok)) { \
60 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
61 					 XFS_ERRLEVEL_LOW, mp); \
62 			return -EFSCORRUPTED; \
63 		} \
64 	}
65 
66 /*
67  * error injection tags - the labels can be anything you want
68  * but each tag should have its own unique number
69  */
70 
71 #define XFS_ERRTAG_NOERROR				0
72 #define XFS_ERRTAG_IFLUSH_1				1
73 #define XFS_ERRTAG_IFLUSH_2				2
74 #define XFS_ERRTAG_IFLUSH_3				3
75 #define XFS_ERRTAG_IFLUSH_4				4
76 #define XFS_ERRTAG_IFLUSH_5				5
77 #define XFS_ERRTAG_IFLUSH_6				6
78 #define	XFS_ERRTAG_DA_READ_BUF				7
79 #define	XFS_ERRTAG_BTREE_CHECK_LBLOCK			8
80 #define	XFS_ERRTAG_BTREE_CHECK_SBLOCK			9
81 #define	XFS_ERRTAG_ALLOC_READ_AGF			10
82 #define	XFS_ERRTAG_IALLOC_READ_AGI			11
83 #define	XFS_ERRTAG_ITOBP_INOTOBP			12
84 #define	XFS_ERRTAG_IUNLINK				13
85 #define	XFS_ERRTAG_IUNLINK_REMOVE			14
86 #define	XFS_ERRTAG_DIR_INO_VALIDATE			15
87 #define XFS_ERRTAG_BULKSTAT_READ_CHUNK			16
88 #define XFS_ERRTAG_IODONE_IOERR				17
89 #define XFS_ERRTAG_STRATREAD_IOERR			18
90 #define XFS_ERRTAG_STRATCMPL_IOERR			19
91 #define XFS_ERRTAG_DIOWRITE_IOERR			20
92 #define XFS_ERRTAG_BMAPIFORMAT				21
93 #define XFS_ERRTAG_MAX					22
94 
95 /*
96  * Random factors for above tags, 1 means always, 2 means 1/2 time, etc.
97  */
98 #define XFS_RANDOM_DEFAULT				100
99 #define XFS_RANDOM_IFLUSH_1				XFS_RANDOM_DEFAULT
100 #define XFS_RANDOM_IFLUSH_2				XFS_RANDOM_DEFAULT
101 #define XFS_RANDOM_IFLUSH_3				XFS_RANDOM_DEFAULT
102 #define XFS_RANDOM_IFLUSH_4				XFS_RANDOM_DEFAULT
103 #define XFS_RANDOM_IFLUSH_5				XFS_RANDOM_DEFAULT
104 #define XFS_RANDOM_IFLUSH_6				XFS_RANDOM_DEFAULT
105 #define XFS_RANDOM_DA_READ_BUF				XFS_RANDOM_DEFAULT
106 #define XFS_RANDOM_BTREE_CHECK_LBLOCK			(XFS_RANDOM_DEFAULT/4)
107 #define XFS_RANDOM_BTREE_CHECK_SBLOCK			XFS_RANDOM_DEFAULT
108 #define XFS_RANDOM_ALLOC_READ_AGF			XFS_RANDOM_DEFAULT
109 #define XFS_RANDOM_IALLOC_READ_AGI			XFS_RANDOM_DEFAULT
110 #define XFS_RANDOM_ITOBP_INOTOBP			XFS_RANDOM_DEFAULT
111 #define XFS_RANDOM_IUNLINK				XFS_RANDOM_DEFAULT
112 #define XFS_RANDOM_IUNLINK_REMOVE			XFS_RANDOM_DEFAULT
113 #define XFS_RANDOM_DIR_INO_VALIDATE			XFS_RANDOM_DEFAULT
114 #define XFS_RANDOM_BULKSTAT_READ_CHUNK			XFS_RANDOM_DEFAULT
115 #define XFS_RANDOM_IODONE_IOERR				(XFS_RANDOM_DEFAULT/10)
116 #define XFS_RANDOM_STRATREAD_IOERR			(XFS_RANDOM_DEFAULT/10)
117 #define XFS_RANDOM_STRATCMPL_IOERR			(XFS_RANDOM_DEFAULT/10)
118 #define XFS_RANDOM_DIOWRITE_IOERR			(XFS_RANDOM_DEFAULT/10)
119 #define	XFS_RANDOM_BMAPIFORMAT				XFS_RANDOM_DEFAULT
120 
121 #ifdef DEBUG
122 extern int xfs_error_test_active;
123 extern int xfs_error_test(int, int *, char *, int, char *, unsigned long);
124 
125 #define	XFS_NUM_INJECT_ERROR				10
126 #define XFS_TEST_ERROR(expr, mp, tag, rf)		\
127 	((expr) || (xfs_error_test_active && \
128 	 xfs_error_test((tag), (mp)->m_fixedfsid, "expr", __LINE__, __FILE__, \
129 			(rf))))
130 
131 extern int xfs_errortag_add(int error_tag, struct xfs_mount *mp);
132 extern int xfs_errortag_clearall(struct xfs_mount *mp, int loud);
133 #else
134 #define XFS_TEST_ERROR(expr, mp, tag, rf)	(expr)
135 #define xfs_errortag_add(tag, mp)		(ENOSYS)
136 #define xfs_errortag_clearall(mp, loud)		(ENOSYS)
137 #endif /* DEBUG */
138 
139 /*
140  * XFS panic tags -- allow a call to xfs_alert_tag() be turned into
141  *			a panic by setting xfs_panic_mask in a sysctl.
142  */
143 #define		XFS_NO_PTAG			0
144 #define		XFS_PTAG_IFLUSH			0x00000001
145 #define		XFS_PTAG_LOGRES			0x00000002
146 #define		XFS_PTAG_AILDELETE		0x00000004
147 #define		XFS_PTAG_ERROR_REPORT		0x00000008
148 #define		XFS_PTAG_SHUTDOWN_CORRUPT	0x00000010
149 #define		XFS_PTAG_SHUTDOWN_IOERROR	0x00000020
150 #define		XFS_PTAG_SHUTDOWN_LOGERROR	0x00000040
151 #define		XFS_PTAG_FSBLOCK_ZERO		0x00000080
152 
153 #endif	/* __XFS_ERROR_H__ */
154