[mirror_ubuntu-artful-kernel.git] / fs / xfs / xfs_error.h

/*
 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef	__XFS_ERROR_H__
#define	__XFS_ERROR_H__

struct xfs_mount;

extern void xfs_error_report(const char *tag, int level, struct xfs_mount *mp,
			const char *filename, int linenum, void *ra);
extern void xfs_corruption_error(const char *tag, int level,
			struct xfs_mount *mp, void *p, const char *filename,
			int linenum, void *ra);
extern void xfs_verifier_error(struct xfs_buf *bp);

#define	XFS_ERROR_REPORT(e, lvl, mp)	\
	xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
#define	XFS_CORRUPTION_ERROR(e, lvl, mp, mem)	\
	xfs_corruption_error(e, lvl, mp, mem, \
			     __FILE__, __LINE__, __return_address)

#define XFS_ERRLEVEL_OFF	0
#define XFS_ERRLEVEL_LOW	1
#define XFS_ERRLEVEL_HIGH	5

/*
 * Macros to set EFSCORRUPTED & return/branch.
 */
#define	XFS_WANT_CORRUPTED_GOTO(mp, x, l)	\
	{ \
		int fs_is_ok = (x); \
		ASSERT(fs_is_ok); \
		if (unlikely(!fs_is_ok)) { \
			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
					 XFS_ERRLEVEL_LOW, mp); \
			error = -EFSCORRUPTED; \
			goto l; \
		} \
	}

#define	XFS_WANT_CORRUPTED_RETURN(mp, x)	\
	{ \
		int fs_is_ok = (x); \
		ASSERT(fs_is_ok); \
		if (unlikely(!fs_is_ok)) { \
			XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
					 XFS_ERRLEVEL_LOW, mp); \
			return -EFSCORRUPTED; \
		} \
	}

/*
 * error injection tags - the labels can be anything you want
 * but each tag should have its own unique number
 */

#define XFS_ERRTAG_NOERROR				0
#define XFS_ERRTAG_IFLUSH_1				1
#define XFS_ERRTAG_IFLUSH_2				2
#define XFS_ERRTAG_IFLUSH_3				3
#define XFS_ERRTAG_IFLUSH_4				4
#define XFS_ERRTAG_IFLUSH_5				5
#define XFS_ERRTAG_IFLUSH_6				6
#define	XFS_ERRTAG_DA_READ_BUF				7
#define	XFS_ERRTAG_BTREE_CHECK_LBLOCK			8
#define	XFS_ERRTAG_BTREE_CHECK_SBLOCK			9
#define	XFS_ERRTAG_ALLOC_READ_AGF			10
#define	XFS_ERRTAG_IALLOC_READ_AGI			11
#define	XFS_ERRTAG_ITOBP_INOTOBP			12
#define	XFS_ERRTAG_IUNLINK				13
#define	XFS_ERRTAG_IUNLINK_REMOVE			14
#define	XFS_ERRTAG_DIR_INO_VALIDATE			15
#define XFS_ERRTAG_BULKSTAT_READ_CHUNK			16
#define XFS_ERRTAG_IODONE_IOERR				17
#define XFS_ERRTAG_STRATREAD_IOERR			18
#define XFS_ERRTAG_STRATCMPL_IOERR			19
#define XFS_ERRTAG_DIOWRITE_IOERR			20
#define XFS_ERRTAG_BMAPIFORMAT				21
#define XFS_ERRTAG_FREE_EXTENT				22
#define XFS_ERRTAG_RMAP_FINISH_ONE			23
#define XFS_ERRTAG_REFCOUNT_CONTINUE_UPDATE		24
#define XFS_ERRTAG_REFCOUNT_FINISH_ONE			25
#define XFS_ERRTAG_BMAP_FINISH_ONE			26
#define XFS_ERRTAG_AG_RESV_CRITICAL			27
/*
 * DEBUG mode instrumentation to test and/or trigger delayed allocation
 * block killing in the event of failed writes. When enabled, all
 * buffered writes are silenty dropped and handled as if they failed.
 * All delalloc blocks in the range of the write (including pre-existing
 * delalloc blocks!) are tossed as part of the write failure error
 * handling sequence.
 */
#define XFS_ERRTAG_DROP_WRITES				28
#define XFS_ERRTAG_LOG_BAD_CRC				29
#define XFS_ERRTAG_MAX					30

/*
 * Random factors for above tags, 1 means always, 2 means 1/2 time, etc.
 */
#define XFS_RANDOM_DEFAULT				100
#define XFS_RANDOM_IFLUSH_1				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IFLUSH_2				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IFLUSH_3				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IFLUSH_4				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IFLUSH_5				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IFLUSH_6				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_DA_READ_BUF				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_BTREE_CHECK_LBLOCK			(XFS_RANDOM_DEFAULT/4)
#define XFS_RANDOM_BTREE_CHECK_SBLOCK			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_ALLOC_READ_AGF			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IALLOC_READ_AGI			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_ITOBP_INOTOBP			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IUNLINK				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IUNLINK_REMOVE			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_DIR_INO_VALIDATE			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_BULKSTAT_READ_CHUNK			XFS_RANDOM_DEFAULT
#define XFS_RANDOM_IODONE_IOERR				(XFS_RANDOM_DEFAULT/10)
#define XFS_RANDOM_STRATREAD_IOERR			(XFS_RANDOM_DEFAULT/10)
#define XFS_RANDOM_STRATCMPL_IOERR			(XFS_RANDOM_DEFAULT/10)
#define XFS_RANDOM_DIOWRITE_IOERR			(XFS_RANDOM_DEFAULT/10)
#define	XFS_RANDOM_BMAPIFORMAT				XFS_RANDOM_DEFAULT
#define XFS_RANDOM_FREE_EXTENT				1
#define XFS_RANDOM_RMAP_FINISH_ONE			1
#define XFS_RANDOM_REFCOUNT_CONTINUE_UPDATE		1
#define XFS_RANDOM_REFCOUNT_FINISH_ONE			1
#define XFS_RANDOM_BMAP_FINISH_ONE			1
#define XFS_RANDOM_AG_RESV_CRITICAL			4
#define XFS_RANDOM_DROP_WRITES				1
#define XFS_RANDOM_LOG_BAD_CRC				1

#ifdef DEBUG
extern int xfs_errortag_init(struct xfs_mount *mp);
extern void xfs_errortag_del(struct xfs_mount *mp);
extern bool xfs_errortag_test(struct xfs_mount *mp, const char *expression,
		const char *file, int line, unsigned int error_tag);
#define XFS_TEST_ERROR(expr, mp, tag)		\
	((expr) || xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))

extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
extern int xfs_errortag_set(struct xfs_mount *mp, unsigned int error_tag,
		unsigned int tag_value);
extern int xfs_errortag_add(struct xfs_mount *mp, unsigned int error_tag);
extern int xfs_errortag_clearall(struct xfs_mount *mp);
#else
#define xfs_errortag_init(mp)			(0)
#define xfs_errortag_del(mp)
#define XFS_TEST_ERROR(expr, mp, tag)		(expr)
#define xfs_errortag_set(mp, tag, val)		(ENOSYS)
#define xfs_errortag_add(mp, tag)		(ENOSYS)
#define xfs_errortag_clearall(mp)		(ENOSYS)
#endif /* DEBUG */

/*
 * XFS panic tags -- allow a call to xfs_alert_tag() be turned into
 *			a panic by setting xfs_panic_mask in a sysctl.
 */
#define		XFS_NO_PTAG			0
#define		XFS_PTAG_IFLUSH			0x00000001
#define		XFS_PTAG_LOGRES			0x00000002
#define		XFS_PTAG_AILDELETE		0x00000004
#define		XFS_PTAG_ERROR_REPORT		0x00000008
#define		XFS_PTAG_SHUTDOWN_CORRUPT	0x00000010
#define		XFS_PTAG_SHUTDOWN_IOERROR	0x00000020
#define		XFS_PTAG_SHUTDOWN_LOGERROR	0x00000040
#define		XFS_PTAG_FSBLOCK_ZERO		0x00000080

#endif	/* __XFS_ERROR_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	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.
1da177e4	13	*
7b718769 NS	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
1da177e4 LT	17	*/
	18	#ifndef __XFS_ERROR_H__
	19	#define __XFS_ERROR_H__
	20
1da177e4 LT	21	struct xfs_mount;
1da177e4 LT	22
a0e856b0	23	extern void xfs_error_report(const char tag, int level, struct xfs_mount mp,
fc51c2b5	24	const char filename, int linenum, void ra);
a0e856b0 AE	25	extern void xfs_corruption_error(const char *tag, int level,
a0e856b0 AE	26	struct xfs_mount mp, void p, const char *filename,
fc51c2b5	27	int linenum, void *ra);
ca23f8fd	28	extern void xfs_verifier_error(struct xfs_buf *bp);
1da177e4	29
1da177e4 LT	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
a844f451 NS	40	/*
	41	* Macros to set EFSCORRUPTED & return/branch.
	42	*/
c29aad41	43	#define XFS_WANT_CORRUPTED_GOTO(mp, x, l) \
a844f451 NS	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", \
c29aad41	49	XFS_ERRLEVEL_LOW, mp); \
2451337d	50	error = -EFSCORRUPTED; \
a844f451 NS	51	goto l; \
	52	} \
	53	}
	54
5fb5aeee	55	#define XFS_WANT_CORRUPTED_RETURN(mp, x) \
a844f451 NS	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", \
5fb5aeee	61	XFS_ERRLEVEL_LOW, mp); \
2451337d	62	return -EFSCORRUPTED; \
a844f451 NS	63	} \
	64	}
	65
1da177e4 LT	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
ba9e7802	93	#define XFS_ERRTAG_FREE_EXTENT 22
9c194644	94	#define XFS_ERRTAG_RMAP_FINISH_ONE 23
31727258	95	#define XFS_ERRTAG_REFCOUNT_CONTINUE_UPDATE 24
33ba6129	96	#define XFS_ERRTAG_REFCOUNT_FINISH_ONE 25
9f3afb57	97	#define XFS_ERRTAG_BMAP_FINISH_ONE 26
a35eb415	98	#define XFS_ERRTAG_AG_RESV_CRITICAL 27
f8c47250 DW	99	/*
	100	* DEBUG mode instrumentation to test and/or trigger delayed allocation
	101	* block killing in the event of failed writes. When enabled, all
	102	* buffered writes are silenty dropped and handled as if they failed.
	103	* All delalloc blocks in the range of the write (including pre-existing
	104	* delalloc blocks!) are tossed as part of the write failure error
	105	* handling sequence.
	106	*/
	107	#define XFS_ERRTAG_DROP_WRITES 28
3e88a007 BF	108	#define XFS_ERRTAG_LOG_BAD_CRC 29
3e88a007 BF	109	#define XFS_ERRTAG_MAX 30
1da177e4 LT	110
	111	/*
	112	* Random factors for above tags, 1 means always, 2 means 1/2 time, etc.
	113	*/
	114	#define XFS_RANDOM_DEFAULT 100
	115	#define XFS_RANDOM_IFLUSH_1 XFS_RANDOM_DEFAULT
	116	#define XFS_RANDOM_IFLUSH_2 XFS_RANDOM_DEFAULT
	117	#define XFS_RANDOM_IFLUSH_3 XFS_RANDOM_DEFAULT
	118	#define XFS_RANDOM_IFLUSH_4 XFS_RANDOM_DEFAULT
	119	#define XFS_RANDOM_IFLUSH_5 XFS_RANDOM_DEFAULT
	120	#define XFS_RANDOM_IFLUSH_6 XFS_RANDOM_DEFAULT
	121	#define XFS_RANDOM_DA_READ_BUF XFS_RANDOM_DEFAULT
	122	#define XFS_RANDOM_BTREE_CHECK_LBLOCK (XFS_RANDOM_DEFAULT/4)
	123	#define XFS_RANDOM_BTREE_CHECK_SBLOCK XFS_RANDOM_DEFAULT
	124	#define XFS_RANDOM_ALLOC_READ_AGF XFS_RANDOM_DEFAULT
	125	#define XFS_RANDOM_IALLOC_READ_AGI XFS_RANDOM_DEFAULT
	126	#define XFS_RANDOM_ITOBP_INOTOBP XFS_RANDOM_DEFAULT
	127	#define XFS_RANDOM_IUNLINK XFS_RANDOM_DEFAULT
	128	#define XFS_RANDOM_IUNLINK_REMOVE XFS_RANDOM_DEFAULT
	129	#define XFS_RANDOM_DIR_INO_VALIDATE XFS_RANDOM_DEFAULT
	130	#define XFS_RANDOM_BULKSTAT_READ_CHUNK XFS_RANDOM_DEFAULT
	131	#define XFS_RANDOM_IODONE_IOERR (XFS_RANDOM_DEFAULT/10)
	132	#define XFS_RANDOM_STRATREAD_IOERR (XFS_RANDOM_DEFAULT/10)
	133	#define XFS_RANDOM_STRATCMPL_IOERR (XFS_RANDOM_DEFAULT/10)
	134	#define XFS_RANDOM_DIOWRITE_IOERR (XFS_RANDOM_DEFAULT/10)
	135	#define XFS_RANDOM_BMAPIFORMAT XFS_RANDOM_DEFAULT
ba9e7802	136	#define XFS_RANDOM_FREE_EXTENT 1
9c194644	137	#define XFS_RANDOM_RMAP_FINISH_ONE 1
31727258	138	#define XFS_RANDOM_REFCOUNT_CONTINUE_UPDATE 1
33ba6129	139	#define XFS_RANDOM_REFCOUNT_FINISH_ONE 1
9f3afb57	140	#define XFS_RANDOM_BMAP_FINISH_ONE 1
a35eb415	141	#define XFS_RANDOM_AG_RESV_CRITICAL 4
f8c47250	142	#define XFS_RANDOM_DROP_WRITES 1
3e88a007	143	#define XFS_RANDOM_LOG_BAD_CRC 1
1da177e4	144
1550d0b0	145	#ifdef DEBUG
31965ef3 DW	146	extern int xfs_errortag_init(struct xfs_mount *mp);
	147	extern void xfs_errortag_del(struct xfs_mount *mp);
	148	extern bool xfs_errortag_test(struct xfs_mount mp, const char expression,
	149	const char *file, int line, unsigned int error_tag);
9e24cfd0	150	#define XFS_TEST_ERROR(expr, mp, tag) \
31965ef3	151	((expr) \|\| xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))
1da177e4	152
c6840101	153	extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
31965ef3 DW	154	extern int xfs_errortag_set(struct xfs_mount *mp, unsigned int error_tag,
	155	unsigned int tag_value);
	156	extern int xfs_errortag_add(struct xfs_mount *mp, unsigned int error_tag);
	157	extern int xfs_errortag_clearall(struct xfs_mount *mp);
1da177e4	158	#else
31965ef3 DW	159	#define xfs_errortag_init(mp) (0)
31965ef3 DW	160	#define xfs_errortag_del(mp)
9e24cfd0	161	#define XFS_TEST_ERROR(expr, mp, tag) (expr)
31965ef3 DW	162	#define xfs_errortag_set(mp, tag, val) (ENOSYS)
	163	#define xfs_errortag_add(mp, tag) (ENOSYS)
	164	#define xfs_errortag_clearall(mp) (ENOSYS)
1550d0b0	165	#endif /* DEBUG */
1da177e4 LT	166
1da177e4 LT	167	/*
6a19d939 DC	168	* XFS panic tags -- allow a call to xfs_alert_tag() be turned into
6a19d939 DC	169	* a panic by setting xfs_panic_mask in a sysctl.
1da177e4 LT	170	*/
	171	#define XFS_NO_PTAG 0
	172	#define XFS_PTAG_IFLUSH 0x00000001
	173	#define XFS_PTAG_LOGRES 0x00000002
	174	#define XFS_PTAG_AILDELETE 0x00000004
	175	#define XFS_PTAG_ERROR_REPORT 0x00000008
	176	#define XFS_PTAG_SHUTDOWN_CORRUPT 0x00000010
	177	#define XFS_PTAG_SHUTDOWN_IOERROR 0x00000020
	178	#define XFS_PTAG_SHUTDOWN_LOGERROR 0x00000040
572d95f4	179	#define XFS_PTAG_FSBLOCK_ZERO 0x00000080
1da177e4	180
1da177e4	181	#endif /* __XFS_ERROR_H__ */