[mirror_ubuntu-bionic-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; \
		} \
	}

#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
1550d0b0	66	#ifdef DEBUG
31965ef3 DW	67	extern int xfs_errortag_init(struct xfs_mount *mp);
	68	extern void xfs_errortag_del(struct xfs_mount *mp);
	69	extern bool xfs_errortag_test(struct xfs_mount mp, const char expression,
	70	const char *file, int line, unsigned int error_tag);
9e24cfd0	71	#define XFS_TEST_ERROR(expr, mp, tag) \
31965ef3	72	((expr) \|\| xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))
1da177e4	73
c6840101	74	extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
31965ef3 DW	75	extern int xfs_errortag_set(struct xfs_mount *mp, unsigned int error_tag,
	76	unsigned int tag_value);
	77	extern int xfs_errortag_add(struct xfs_mount *mp, unsigned int error_tag);
	78	extern int xfs_errortag_clearall(struct xfs_mount *mp);
1da177e4	79	#else
31965ef3 DW	80	#define xfs_errortag_init(mp) (0)
31965ef3 DW	81	#define xfs_errortag_del(mp)
9e24cfd0	82	#define XFS_TEST_ERROR(expr, mp, tag) (expr)
31965ef3 DW	83	#define xfs_errortag_set(mp, tag, val) (ENOSYS)
	84	#define xfs_errortag_add(mp, tag) (ENOSYS)
	85	#define xfs_errortag_clearall(mp) (ENOSYS)
1550d0b0	86	#endif /* DEBUG */
1da177e4 LT	87
1da177e4 LT	88	/*
6a19d939 DC	89	* XFS panic tags -- allow a call to xfs_alert_tag() be turned into
6a19d939 DC	90	* a panic by setting xfs_panic_mask in a sysctl.
1da177e4 LT	91	*/
	92	#define XFS_NO_PTAG 0
	93	#define XFS_PTAG_IFLUSH 0x00000001
	94	#define XFS_PTAG_LOGRES 0x00000002
	95	#define XFS_PTAG_AILDELETE 0x00000004
	96	#define XFS_PTAG_ERROR_REPORT 0x00000008
	97	#define XFS_PTAG_SHUTDOWN_CORRUPT 0x00000010
	98	#define XFS_PTAG_SHUTDOWN_IOERROR 0x00000020
	99	#define XFS_PTAG_SHUTDOWN_LOGERROR 0x00000040
572d95f4	100	#define XFS_PTAG_FSBLOCK_ZERO 0x00000080
1da177e4	101
1da177e4	102	#endif /* __XFS_ERROR_H__ */