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