/*

   * 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_LOG_ITEM_PIN				30
  #define XFS_ERRTAG_MAX					31

  
  /*
   * 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

  #define XFS_RANDOM_LOG_ITEM_PIN				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__ */