[linux-2.6-block.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,
			xfs_failaddr_t failaddr);
extern void xfs_corruption_error(const char *tag, int level,
			struct xfs_mount *mp, void *p, const char *filename,
			int linenum, xfs_failaddr_t failaddr);
extern void xfs_verifier_error(struct xfs_buf *bp, int error,
			xfs_failaddr_t failaddr);
extern void xfs_inode_verifier_error(struct xfs_inode *ip, int error,
			const char *name, void *buf, size_t bufsz,
			xfs_failaddr_t failaddr);

#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

/* Dump 128 bytes of any corrupt buffer */
#define XFS_CORRUPTION_DUMP_LEN		(128)

/*
 * 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; \
		} \
	}

#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,
d9418ed0 DW	24	const char *filename, int linenum,
d9418ed0 DW	25	xfs_failaddr_t failaddr);
a0e856b0 AE	26	extern void xfs_corruption_error(const char *tag, int level,
a0e856b0 AE	27	struct xfs_mount mp, void p, const char *filename,
d9418ed0	28	int linenum, xfs_failaddr_t failaddr);
bc1a09b8 DW	29	extern void xfs_verifier_error(struct xfs_buf *bp, int error,
bc1a09b8 DW	30	xfs_failaddr_t failaddr);
22431bf3 DW	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);
1da177e4	34
1da177e4 LT	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
9c712a13 DW	45	/* Dump 128 bytes of any corrupt buffer */
	46	#define XFS_CORRUPTION_DUMP_LEN (128)
	47
a844f451 NS	48	/*
	49	* Macros to set EFSCORRUPTED & return/branch.
	50	*/
c29aad41	51	#define XFS_WANT_CORRUPTED_GOTO(mp, x, l) \
a844f451 NS	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", \
c29aad41	57	XFS_ERRLEVEL_LOW, mp); \
2451337d	58	error = -EFSCORRUPTED; \
a844f451 NS	59	goto l; \
	60	} \
	61	}
	62
5fb5aeee	63	#define XFS_WANT_CORRUPTED_RETURN(mp, x) \
a844f451 NS	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", \
5fb5aeee	69	XFS_ERRLEVEL_LOW, mp); \
2451337d	70	return -EFSCORRUPTED; \
a844f451 NS	71	} \
	72	}
	73
1550d0b0	74	#ifdef DEBUG
31965ef3 DW	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);
9e24cfd0	79	#define XFS_TEST_ERROR(expr, mp, tag) \
31965ef3	80	((expr) \|\| xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))
1da177e4	81
c6840101	82	extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
31965ef3 DW	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);
1da177e4	87	#else
31965ef3 DW	88	#define xfs_errortag_init(mp) (0)
31965ef3 DW	89	#define xfs_errortag_del(mp)
9e24cfd0	90	#define XFS_TEST_ERROR(expr, mp, tag) (expr)
31965ef3 DW	91	#define xfs_errortag_set(mp, tag, val) (ENOSYS)
	92	#define xfs_errortag_add(mp, tag) (ENOSYS)
	93	#define xfs_errortag_clearall(mp) (ENOSYS)
1550d0b0	94	#endif /* DEBUG */
1da177e4 LT	95
1da177e4 LT	96	/*
6a19d939 DC	97	* XFS panic tags -- allow a call to xfs_alert_tag() be turned into
6a19d939 DC	98	* a panic by setting xfs_panic_mask in a sysctl.
1da177e4 LT	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
572d95f4	108	#define XFS_PTAG_FSBLOCK_ZERO 0x00000080
1da177e4	109
1da177e4	110	#endif /* __XFS_ERROR_H__ */