xref: /openbmc/linux/fs/xfs/xfs_error.h (revision 6ab3d562)
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 #define XFS_ERECOVER	1	/* Failure to recover log */
22 #define XFS_ELOGSTAT	2	/* Failure to stat log in user space */
23 #define XFS_ENOLOGSPACE	3	/* Reservation too large */
24 #define XFS_ENOTSUP	4	/* Operation not supported */
25 #define	XFS_ENOLSN	5	/* Can't find the lsn you asked for */
26 #define XFS_ENOTFOUND	6
27 #define XFS_ENOTXFS	7	/* Not XFS filesystem */
28 
29 #ifdef DEBUG
30 #define	XFS_ERROR_NTRAP	10
31 extern int	xfs_etrap[XFS_ERROR_NTRAP];
32 extern int	xfs_error_trap(int);
33 #define	XFS_ERROR(e)	xfs_error_trap(e)
34 #else
35 #define	XFS_ERROR(e)	(e)
36 #endif
37 
38 struct xfs_mount;
39 
40 extern void xfs_error_report(char *tag, int level, struct xfs_mount *mp,
41 				char *fname, int linenum, inst_t *ra);
42 extern void xfs_corruption_error(char *tag, int level, struct xfs_mount *mp,
43 				void *p, char *fname, int linenum, inst_t *ra);
44 
45 #define	XFS_ERROR_REPORT(e, lvl, mp)	\
46 	xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
47 #define	XFS_CORRUPTION_ERROR(e, lvl, mp, mem)	\
48 	xfs_corruption_error(e, lvl, mp, mem, \
49 			     __FILE__, __LINE__, __return_address)
50 
51 #define XFS_ERRLEVEL_OFF	0
52 #define XFS_ERRLEVEL_LOW	1
53 #define XFS_ERRLEVEL_HIGH	5
54 
55 /*
56  * Macros to set EFSCORRUPTED & return/branch.
57  */
58 #define	XFS_WANT_CORRUPTED_GOTO(x,l)	\
59 	{ \
60 		int fs_is_ok = (x); \
61 		ASSERT(fs_is_ok); \
62 		if (unlikely(!fs_is_ok)) { \
63 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
64 					 XFS_ERRLEVEL_LOW, NULL); \
65 			error = XFS_ERROR(EFSCORRUPTED); \
66 			goto l; \
67 		} \
68 	}
69 
70 #define	XFS_WANT_CORRUPTED_RETURN(x)	\
71 	{ \
72 		int fs_is_ok = (x); \
73 		ASSERT(fs_is_ok); \
74 		if (unlikely(!fs_is_ok)) { \
75 			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
76 					 XFS_ERRLEVEL_LOW, NULL); \
77 			return XFS_ERROR(EFSCORRUPTED); \
78 		} \
79 	}
80 
81 /*
82  * error injection tags - the labels can be anything you want
83  * but each tag should have its own unique number
84  */
85 
86 #define XFS_ERRTAG_NOERROR				0
87 #define XFS_ERRTAG_IFLUSH_1				1
88 #define XFS_ERRTAG_IFLUSH_2				2
89 #define XFS_ERRTAG_IFLUSH_3				3
90 #define XFS_ERRTAG_IFLUSH_4				4
91 #define XFS_ERRTAG_IFLUSH_5				5
92 #define XFS_ERRTAG_IFLUSH_6				6
93 #define	XFS_ERRTAG_DA_READ_BUF				7
94 #define	XFS_ERRTAG_BTREE_CHECK_LBLOCK			8
95 #define	XFS_ERRTAG_BTREE_CHECK_SBLOCK			9
96 #define	XFS_ERRTAG_ALLOC_READ_AGF			10
97 #define	XFS_ERRTAG_IALLOC_READ_AGI			11
98 #define	XFS_ERRTAG_ITOBP_INOTOBP			12
99 #define	XFS_ERRTAG_IUNLINK				13
100 #define	XFS_ERRTAG_IUNLINK_REMOVE			14
101 #define	XFS_ERRTAG_DIR_INO_VALIDATE			15
102 #define XFS_ERRTAG_BULKSTAT_READ_CHUNK			16
103 #define XFS_ERRTAG_IODONE_IOERR				17
104 #define XFS_ERRTAG_STRATREAD_IOERR			18
105 #define XFS_ERRTAG_STRATCMPL_IOERR			19
106 #define XFS_ERRTAG_DIOWRITE_IOERR			20
107 #define XFS_ERRTAG_BMAPIFORMAT				21
108 #define XFS_ERRTAG_MAX					22
109 
110 /*
111  * Random factors for above tags, 1 means always, 2 means 1/2 time, etc.
112  */
113 #define XFS_RANDOM_DEFAULT				100
114 #define XFS_RANDOM_IFLUSH_1				XFS_RANDOM_DEFAULT
115 #define XFS_RANDOM_IFLUSH_2				XFS_RANDOM_DEFAULT
116 #define XFS_RANDOM_IFLUSH_3				XFS_RANDOM_DEFAULT
117 #define XFS_RANDOM_IFLUSH_4				XFS_RANDOM_DEFAULT
118 #define XFS_RANDOM_IFLUSH_5				XFS_RANDOM_DEFAULT
119 #define XFS_RANDOM_IFLUSH_6				XFS_RANDOM_DEFAULT
120 #define XFS_RANDOM_DA_READ_BUF				XFS_RANDOM_DEFAULT
121 #define XFS_RANDOM_BTREE_CHECK_LBLOCK			(XFS_RANDOM_DEFAULT/4)
122 #define XFS_RANDOM_BTREE_CHECK_SBLOCK			XFS_RANDOM_DEFAULT
123 #define XFS_RANDOM_ALLOC_READ_AGF			XFS_RANDOM_DEFAULT
124 #define XFS_RANDOM_IALLOC_READ_AGI			XFS_RANDOM_DEFAULT
125 #define XFS_RANDOM_ITOBP_INOTOBP			XFS_RANDOM_DEFAULT
126 #define XFS_RANDOM_IUNLINK				XFS_RANDOM_DEFAULT
127 #define XFS_RANDOM_IUNLINK_REMOVE			XFS_RANDOM_DEFAULT
128 #define XFS_RANDOM_DIR_INO_VALIDATE			XFS_RANDOM_DEFAULT
129 #define XFS_RANDOM_BULKSTAT_READ_CHUNK			XFS_RANDOM_DEFAULT
130 #define XFS_RANDOM_IODONE_IOERR				(XFS_RANDOM_DEFAULT/10)
131 #define XFS_RANDOM_STRATREAD_IOERR			(XFS_RANDOM_DEFAULT/10)
132 #define XFS_RANDOM_STRATCMPL_IOERR			(XFS_RANDOM_DEFAULT/10)
133 #define XFS_RANDOM_DIOWRITE_IOERR			(XFS_RANDOM_DEFAULT/10)
134 #define	XFS_RANDOM_BMAPIFORMAT				XFS_RANDOM_DEFAULT
135 
136 #if (defined(DEBUG) || defined(INDUCE_IO_ERROR))
137 extern int xfs_error_test(int, int *, char *, int, char *, unsigned long);
138 extern void xfs_error_test_init(void);
139 
140 #define	XFS_NUM_INJECT_ERROR				10
141 
142 #ifdef __ANSI_CPP__
143 #define XFS_TEST_ERROR(expr, mp, tag, rf)		\
144 	((expr) || \
145 	 xfs_error_test((tag), (mp)->m_fixedfsid, #expr, __LINE__, __FILE__, \
146 			 (rf)))
147 #else
148 #define XFS_TEST_ERROR(expr, mp, tag, rf)		\
149 	((expr) || \
150 	 xfs_error_test((tag), (mp)->m_fixedfsid, "expr", __LINE__, __FILE__, \
151 			(rf)))
152 #endif /* __ANSI_CPP__ */
153 
154 extern int xfs_errortag_add(int error_tag, xfs_mount_t *mp);
155 extern int xfs_errortag_clear(int error_tag, xfs_mount_t *mp);
156 extern int xfs_errortag_clearall(xfs_mount_t *mp);
157 extern int xfs_errortag_clearall_umount(int64_t fsid, char *fsname, int loud);
158 #else
159 #define XFS_TEST_ERROR(expr, mp, tag, rf)	(expr)
160 #define xfs_errortag_add(tag, mp)		(ENOSYS)
161 #define xfs_errortag_clearall(mp)		(ENOSYS)
162 #endif /* (DEBUG || INDUCE_IO_ERROR) */
163 
164 /*
165  * XFS panic tags -- allow a call to xfs_cmn_err() be turned into
166  *			a panic by setting xfs_panic_mask in a
167  *			sysctl.  update xfs_max[XFS_PARAM] if
168  *			more are added.
169  */
170 #define		XFS_NO_PTAG			0
171 #define		XFS_PTAG_IFLUSH			0x00000001
172 #define		XFS_PTAG_LOGRES			0x00000002
173 #define		XFS_PTAG_AILDELETE		0x00000004
174 #define		XFS_PTAG_ERROR_REPORT		0x00000008
175 #define		XFS_PTAG_SHUTDOWN_CORRUPT	0x00000010
176 #define		XFS_PTAG_SHUTDOWN_IOERROR	0x00000020
177 #define		XFS_PTAG_SHUTDOWN_LOGERROR	0x00000040
178 
179 struct xfs_mount;
180 /* PRINTFLIKE4 */
181 extern void xfs_cmn_err(int panic_tag, int level, struct xfs_mount *mp,
182 			char *fmt, ...);
183 /* PRINTFLIKE3 */
184 extern void xfs_fs_cmn_err(int level, struct xfs_mount *mp, char *fmt, ...);
185 
186 #define xfs_fs_repair_cmn_err(level, mp, fmt, args...) \
187 	xfs_fs_cmn_err(level, mp, fmt "  Unmount and run xfs_repair.", ## args)
188 
189 #define xfs_fs_mount_cmn_err(f, fmt, args...) \
190 	((f & XFS_MFSI_QUIET)? cmn_err(CE_WARN, "XFS: " fmt, ## args) : (void)0)
191 
192 #endif	/* __XFS_ERROR_H__ */
193