blob: 0c93051c46515efb60a898c9c5ac4af4b826be39 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_ERROR_H__
19#define __XFS_ERROR_H__
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#ifdef DEBUG
22#define XFS_ERROR_NTRAP 10
23extern int xfs_etrap[XFS_ERROR_NTRAP];
24extern 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
30struct xfs_mount;
31
Nathan Scotta844f452005-11-02 14:38:42 +110032extern void xfs_error_report(char *tag, int level, struct xfs_mount *mp,
33 char *fname, int linenum, inst_t *ra);
34extern void xfs_corruption_error(char *tag, int level, struct xfs_mount *mp,
35 void *p, char *fname, int linenum, inst_t *ra);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#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/*
Nathan Scotta844f452005-11-02 14:38:42 +110048 * 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/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * 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
Christoph Hellwig1550d0b2008-08-13 16:17:37 +1000128#ifdef DEBUG
Nathan Scotta844f452005-11-02 14:38:42 +1100129extern int xfs_error_test(int, int *, char *, int, char *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131#define XFS_NUM_INJECT_ERROR 10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#define XFS_TEST_ERROR(expr, mp, tag, rf) \
133 ((expr) || \
134 xfs_error_test((tag), (mp)->m_fixedfsid, "expr", __LINE__, __FILE__, \
135 (rf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Nathan Scotta844f452005-11-02 14:38:42 +1100137extern int xfs_errortag_add(int error_tag, xfs_mount_t *mp);
Christoph Hellwig0ce4cfd2007-08-30 17:20:53 +1000138extern int xfs_errortag_clearall(xfs_mount_t *mp, int loud);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139#else
140#define XFS_TEST_ERROR(expr, mp, tag, rf) (expr)
141#define xfs_errortag_add(tag, mp) (ENOSYS)
Christoph Hellwig0ce4cfd2007-08-30 17:20:53 +1000142#define xfs_errortag_clearall(mp, loud) (ENOSYS)
Christoph Hellwig1550d0b2008-08-13 16:17:37 +1000143#endif /* DEBUG */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
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
Nathan Scott572d95f2006-09-28 11:03:20 +1000159#define XFS_PTAG_FSBLOCK_ZERO 0x00000080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161struct xfs_mount;
Christoph Hellwigefc55752008-12-17 12:27:36 -0500162
163extern void xfs_fs_vcmn_err(int level, struct xfs_mount *mp,
164 char *fmt, va_list ap)
165 __attribute__ ((format (printf, 3, 0)));
Nathan Scotta844f452005-11-02 14:38:42 +1100166extern void xfs_cmn_err(int panic_tag, int level, struct xfs_mount *mp,
Christoph Hellwigefc55752008-12-17 12:27:36 -0500167 char *fmt, ...)
168 __attribute__ ((format (printf, 4, 5)));
169extern void xfs_fs_cmn_err(int level, struct xfs_mount *mp, char *fmt, ...)
170 __attribute__ ((format (printf, 3, 4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Eric Sandeend4f3cc02007-10-12 11:13:08 +1000172extern void xfs_hex_dump(void *p, int length);
173
Nathan Scott3762ec62006-01-12 10:29:53 +1100174#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
Nathan Scott764d1f82006-03-31 13:04:17 +1000177#define xfs_fs_mount_cmn_err(f, fmt, args...) \
David Chinnerdac61f52007-02-10 18:27:56 +1100178 ((f & XFS_MFSI_QUIET)? (void)0 : cmn_err(CE_WARN, "XFS: " fmt, ## args))
Nathan Scott764d1f82006-03-31 13:04:17 +1000179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180#endif /* __XFS_ERROR_H__ */