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 #define prdev(fmt,targ,args...) \
  22         printk("XFS: device %s - " fmt "\n", XFS_BUFTARG_NAME(targ), ## args)
  23
  24 #define XFS_ERECOVER    1       /* Failure to recover log */
  25 #define XFS_ELOGSTAT    2       /* Failure to stat log in user space */
  26 #define XFS_ENOLOGSPACE 3       /* Reservation too large */
  27 #define XFS_ENOTSUP     4       /* Operation not supported */
  28 #define XFS_ENOLSN      5       /* Can't find the lsn you asked for */
  29 #define XFS_ENOTFOUND   6
  30 #define XFS_ENOTXFS     7       /* Not XFS filesystem */
  31
  32 #ifdef DEBUG
  33 #define XFS_ERROR_NTRAP 10
  34 extern int      xfs_etrap[XFS_ERROR_NTRAP];
  35 extern int      xfs_error_trap(int);
  36 #define XFS_ERROR(e)    xfs_error_trap(e)
  37 #else
  38 #define XFS_ERROR(e)    (e)
  39 #endif
  40
  41 struct xfs_mount;
  42
  43 extern void xfs_error_report(char *tag, int level, struct xfs_mount *mp,
  44                                 char *fname, int linenum, inst_t *ra);
  45 extern void xfs_corruption_error(char *tag, int level, struct xfs_mount *mp,
  46                                 void *p, char *fname, int linenum, inst_t *ra);
  47
  48 #define XFS_ERROR_REPORT(e, lvl, mp)    \
  49         xfs_error_report(e, lvl, mp, __FILE__, __LINE__, __return_address)
  50 #define XFS_CORRUPTION_ERROR(e, lvl, mp, mem)   \
  51         xfs_corruption_error(e, lvl, mp, mem, \
  52                              __FILE__, __LINE__, __return_address)
  53
  54 #define XFS_ERRLEVEL_OFF        0
  55 #define XFS_ERRLEVEL_LOW        1
  56 #define XFS_ERRLEVEL_HIGH       5
  57
  58 /*
  59  * Macros to set EFSCORRUPTED & return/branch.
  60  */
  61 #define XFS_WANT_CORRUPTED_GOTO(x,l)    \
  62         { \
  63                 int fs_is_ok = (x); \
  64                 ASSERT(fs_is_ok); \
  65                 if (unlikely(!fs_is_ok)) { \
  66                         XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_GOTO", \
  67                                          XFS_ERRLEVEL_LOW, NULL); \
  68                         error = XFS_ERROR(EFSCORRUPTED); \
  69                         goto l; \
  70                 } \
  71         }
  72
  73 #define XFS_WANT_CORRUPTED_RETURN(x)    \
  74         { \
  75                 int fs_is_ok = (x); \
  76                 ASSERT(fs_is_ok); \
  77                 if (unlikely(!fs_is_ok)) { \
  78                         XFS_ERROR_REPORT("XFS_WANT_CORRUPTED_RETURN", \
  79                                          XFS_ERRLEVEL_LOW, NULL); \
  80                         return XFS_ERROR(EFSCORRUPTED); \
  81                 } \
  82         }
  83
  84 /*
  85  * error injection tags - the labels can be anything you want
  86  * but each tag should have its own unique number
  87  */
  88
  89 #define XFS_ERRTAG_NOERROR                              0
  90 #define XFS_ERRTAG_IFLUSH_1                             1
  91 #define XFS_ERRTAG_IFLUSH_2                             2
  92 #define XFS_ERRTAG_IFLUSH_3                             3
  93 #define XFS_ERRTAG_IFLUSH_4                             4
  94 #define XFS_ERRTAG_IFLUSH_5                             5
  95 #define XFS_ERRTAG_IFLUSH_6                             6
  96 #define XFS_ERRTAG_DA_READ_BUF                          7
  97 #define XFS_ERRTAG_BTREE_CHECK_LBLOCK                   8
  98 #define XFS_ERRTAG_BTREE_CHECK_SBLOCK                   9
  99 #define XFS_ERRTAG_ALLOC_READ_AGF                       10
 100 #define XFS_ERRTAG_IALLOC_READ_AGI                      11
 101 #define XFS_ERRTAG_ITOBP_INOTOBP                        12
 102 #define XFS_ERRTAG_IUNLINK                              13
 103 #define XFS_ERRTAG_IUNLINK_REMOVE                       14
 104 #define XFS_ERRTAG_DIR_INO_VALIDATE                     15
 105 #define XFS_ERRTAG_BULKSTAT_READ_CHUNK                  16
 106 #define XFS_ERRTAG_IODONE_IOERR                         17
 107 #define XFS_ERRTAG_STRATREAD_IOERR                      18
 108 #define XFS_ERRTAG_STRATCMPL_IOERR                      19
 109 #define XFS_ERRTAG_DIOWRITE_IOERR                       20
 110 #define XFS_ERRTAG_BMAPIFORMAT                          21
 111 #define XFS_ERRTAG_MAX                                  22
 112
 113 /*
 114  * Random factors for above tags, 1 means always, 2 means 1/2 time, etc.
 115  */
 116 #define XFS_RANDOM_DEFAULT                              100
 117 #define XFS_RANDOM_IFLUSH_1                             XFS_RANDOM_DEFAULT
 118 #define XFS_RANDOM_IFLUSH_2                             XFS_RANDOM_DEFAULT
 119 #define XFS_RANDOM_IFLUSH_3                             XFS_RANDOM_DEFAULT
 120 #define XFS_RANDOM_IFLUSH_4                             XFS_RANDOM_DEFAULT
 121 #define XFS_RANDOM_IFLUSH_5                             XFS_RANDOM_DEFAULT
 122 #define XFS_RANDOM_IFLUSH_6                             XFS_RANDOM_DEFAULT
 123 #define XFS_RANDOM_DA_READ_BUF                          XFS_RANDOM_DEFAULT
 124 #define XFS_RANDOM_BTREE_CHECK_LBLOCK                   (XFS_RANDOM_DEFAULT/4)
 125 #define XFS_RANDOM_BTREE_CHECK_SBLOCK                   XFS_RANDOM_DEFAULT
 126 #define XFS_RANDOM_ALLOC_READ_AGF                       XFS_RANDOM_DEFAULT
 127 #define XFS_RANDOM_IALLOC_READ_AGI                      XFS_RANDOM_DEFAULT
 128 #define XFS_RANDOM_ITOBP_INOTOBP                        XFS_RANDOM_DEFAULT
 129 #define XFS_RANDOM_IUNLINK                              XFS_RANDOM_DEFAULT
 130 #define XFS_RANDOM_IUNLINK_REMOVE                       XFS_RANDOM_DEFAULT
 131 #define XFS_RANDOM_DIR_INO_VALIDATE                     XFS_RANDOM_DEFAULT
 132 #define XFS_RANDOM_BULKSTAT_READ_CHUNK                  XFS_RANDOM_DEFAULT
 133 #define XFS_RANDOM_IODONE_IOERR                         (XFS_RANDOM_DEFAULT/10)
 134 #define XFS_RANDOM_STRATREAD_IOERR                      (XFS_RANDOM_DEFAULT/10)
 135 #define XFS_RANDOM_STRATCMPL_IOERR                      (XFS_RANDOM_DEFAULT/10)
 136 #define XFS_RANDOM_DIOWRITE_IOERR                       (XFS_RANDOM_DEFAULT/10)
 137 #define XFS_RANDOM_BMAPIFORMAT                          XFS_RANDOM_DEFAULT
 138
 139 #if (defined(DEBUG) || defined(INDUCE_IO_ERROR))
 140 extern int xfs_error_test(int, int *, char *, int, char *, unsigned long);
 141 extern void xfs_error_test_init(void);
 142
 143 #define XFS_NUM_INJECT_ERROR                            10
 144
 145 #ifdef __ANSI_CPP__
 146 #define XFS_TEST_ERROR(expr, mp, tag, rf)               \
 147         ((expr) || \
 148          xfs_error_test((tag), (mp)->m_fixedfsid, #expr, __LINE__, __FILE__, \
 149                          (rf)))
 150 #else
 151 #define XFS_TEST_ERROR(expr, mp, tag, rf)               \
 152         ((expr) || \
 153          xfs_error_test((tag), (mp)->m_fixedfsid, "expr", __LINE__, __FILE__, \
 154                         (rf)))
 155 #endif /* __ANSI_CPP__ */
 156
 157 extern int xfs_errortag_add(int error_tag, xfs_mount_t *mp);
 158 extern int xfs_errortag_clear(int error_tag, xfs_mount_t *mp);
 159 extern int xfs_errortag_clearall(xfs_mount_t *mp);
 160 extern int xfs_errortag_clearall_umount(int64_t fsid, char *fsname, int loud);
 161 #else
 162 #define XFS_TEST_ERROR(expr, mp, tag, rf)       (expr)
 163 #define xfs_errortag_add(tag, mp)               (ENOSYS)
 164 #define xfs_errortag_clearall(mp)               (ENOSYS)
 165 #endif /* (DEBUG || INDUCE_IO_ERROR) */
 166
 167 /*
 168  * XFS panic tags -- allow a call to xfs_cmn_err() be turned into
 169  *                      a panic by setting xfs_panic_mask in a
 170  *                      sysctl.  update xfs_max[XFS_PARAM] if
 171  *                      more are added.
 172  */
 173 #define         XFS_NO_PTAG                     0
 174 #define         XFS_PTAG_IFLUSH                 0x00000001
 175 #define         XFS_PTAG_LOGRES                 0x00000002
 176 #define         XFS_PTAG_AILDELETE              0x00000004
 177 #define         XFS_PTAG_ERROR_REPORT           0x00000008
 178 #define         XFS_PTAG_SHUTDOWN_CORRUPT       0x00000010
 179 #define         XFS_PTAG_SHUTDOWN_IOERROR       0x00000020
 180 #define         XFS_PTAG_SHUTDOWN_LOGERROR      0x00000040
 181
 182 struct xfs_mount;
 183 /* PRINTFLIKE4 */
 184 extern void xfs_cmn_err(int panic_tag, int level, struct xfs_mount *mp,
 185                             char *fmt, ...);
 186 /* PRINTFLIKE3 */
 187 extern void xfs_fs_cmn_err(int level, struct xfs_mount *mp, char *fmt, ...);
 188
 189 #endif  /* __XFS_ERROR_H__ */