fs/xfs/xfs_error.h

   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 struct xfs_mount;
  22
  23 extern void xfs_error_report(const char *tag, int level, struct xfs_mount *mp,
  24                         const char *filename, int linenum,
  25                         xfs_failaddr_t failaddr);
  26 extern void xfs_corruption_error(const char *tag, int level,
  27                         struct xfs_mount *mp, void *p, const char *filename,
  28                         int linenum, xfs_failaddr_t failaddr);
  29 extern void xfs_buf_verifier_error(struct xfs_buf *bp, int error,
  30                         const char *name, void *buf, size_t bufsz,
  31                         xfs_failaddr_t failaddr);
  32 extern void xfs_verifier_error(struct xfs_buf *bp, int error,
  33                         xfs_failaddr_t failaddr);
  34 extern void xfs_inode_verifier_error(struct xfs_inode *ip, int error,
  35                         const char *name, void *buf, size_t bufsz,
  36                         xfs_failaddr_t failaddr);
  37
  38 #define XFS_ERROR_REPORT(e, lvl, mp)    \
  39         xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
  40 #define XFS_CORRUPTION_ERROR(e, lvl, mp, mem)   \
  41         xfs_corruption_error(e, lvl, mp, mem, \
  42                              __FILE__, __LINE__, __return_address)
  43
  44 #define XFS_ERRLEVEL_OFF        0
  45 #define XFS_ERRLEVEL_LOW        1
  46 #define XFS_ERRLEVEL_HIGH       5
  47
  48 /* Dump 128 bytes of any corrupt buffer */
  49 #define XFS_CORRUPTION_DUMP_LEN         (128)
  50
  51 /*
  52  * Macros to set EFSCORRUPTED & return/branch.
  53  */
  54 #define XFS_WANT_CORRUPTED_GOTO(mp, x, l)       \
  55         { \
  56                 int fs_is_ok = (x); \
  57                 ASSERT(fs_is_ok); \
  58                 if (unlikely(!fs_is_ok)) { \
  59                         XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
  60                                          XFS_ERRLEVEL_LOW, mp); \
  61                         error = -EFSCORRUPTED; \
  62                         goto l; \
  63                 } \
  64         }
  65
  66 #define XFS_WANT_CORRUPTED_RETURN(mp, x)        \
  67         { \
  68                 int fs_is_ok = (x); \
  69                 ASSERT(fs_is_ok); \
  70                 if (unlikely(!fs_is_ok)) { \
  71                         XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
  72                                          XFS_ERRLEVEL_LOW, mp); \
  73                         return -EFSCORRUPTED; \
  74                 } \
  75         }
  76
  77 #ifdef DEBUG
  78 extern int xfs_errortag_init(struct xfs_mount *mp);
  79 extern void xfs_errortag_del(struct xfs_mount *mp);
  80 extern bool xfs_errortag_test(struct xfs_mount *mp, const char *expression,
  81                 const char *file, int line, unsigned int error_tag);
  82 #define XFS_TEST_ERROR(expr, mp, tag)           \
  83         ((expr) || xfs_errortag_test((mp), #expr, __FILE__, __LINE__, (tag)))
  84
  85 extern int xfs_errortag_get(struct xfs_mount *mp, unsigned int error_tag);
  86 extern int xfs_errortag_set(struct xfs_mount *mp, unsigned int error_tag,
  87                 unsigned int tag_value);
  88 extern int xfs_errortag_add(struct xfs_mount *mp, unsigned int error_tag);
  89 extern int xfs_errortag_clearall(struct xfs_mount *mp);
  90 #else
  91 #define xfs_errortag_init(mp)                   (0)
  92 #define xfs_errortag_del(mp)
  93 #define XFS_TEST_ERROR(expr, mp, tag)           (expr)
  94 #define xfs_errortag_set(mp, tag, val)          (ENOSYS)
  95 #define xfs_errortag_add(mp, tag)               (ENOSYS)
  96 #define xfs_errortag_clearall(mp)               (ENOSYS)
  97 #endif /* DEBUG */
  98
  99 /*
 100  * XFS panic tags -- allow a call to xfs_alert_tag() be turned into
 101  *                      a panic by setting xfs_panic_mask in a sysctl.
 102  */
 103 #define         XFS_NO_PTAG                     0
 104 #define         XFS_PTAG_IFLUSH                 0x00000001
 105 #define         XFS_PTAG_LOGRES                 0x00000002
 106 #define         XFS_PTAG_AILDELETE              0x00000004
 107 #define         XFS_PTAG_ERROR_REPORT           0x00000008
 108 #define         XFS_PTAG_SHUTDOWN_CORRUPT       0x00000010
 109 #define         XFS_PTAG_SHUTDOWN_IOERROR       0x00000020
 110 #define         XFS_PTAG_SHUTDOWN_LOGERROR      0x00000040
 111 #define         XFS_PTAG_FSBLOCK_ZERO           0x00000080
 112
 113 #endif  /* __XFS_ERROR_H__ */