4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see http://www.gnu.org/licenses
19 * Please contact Oracle Corporation, Inc., 500 Oracle Parkway, Redwood Shores,
20 * CA 94065 USA or visit www.oracle.com if you need additional information or
26 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
27 * Use is subject to license terms.
29 * Copyright (c) 2011, 2014, Intel Corporation.
32 * This file is part of Lustre, http://www.lustre.org/
33 * Lustre is a trademark of Oracle Corporation, Inc.
36 #ifndef _LIBCFS_FAIL_H
37 #define _LIBCFS_FAIL_H
39 extern unsigned long cfs_fail_loc;
40 extern unsigned int cfs_fail_val;
41 extern int cfs_fail_err;
43 extern wait_queue_head_t cfs_race_waitq;
44 extern int cfs_race_state;
46 int __cfs_fail_check_set(__u32 id, __u32 value, int set);
47 int __cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set);
50 CFS_FAIL_LOC_NOSET = 0,
51 CFS_FAIL_LOC_ORSET = 1,
52 CFS_FAIL_LOC_RESET = 2,
53 CFS_FAIL_LOC_VALUE = 3
56 /* Failure injection control */
57 #define CFS_FAIL_MASK_SYS 0x0000FF00
58 #define CFS_FAIL_MASK_LOC (0x000000FF | CFS_FAIL_MASK_SYS)
60 #define CFS_FAILED_BIT 30
61 /* CFS_FAILED is 0x40000000 */
62 #define CFS_FAILED (1 << CFS_FAILED_BIT)
64 #define CFS_FAIL_ONCE_BIT 31
65 /* CFS_FAIL_ONCE is 0x80000000 */
66 #define CFS_FAIL_ONCE (1 << CFS_FAIL_ONCE_BIT)
68 /* The following flags aren't made to be combined */
69 #define CFS_FAIL_SKIP 0x20000000 /* skip N times then fail */
70 #define CFS_FAIL_SOME 0x10000000 /* only fail N times */
71 #define CFS_FAIL_RAND 0x08000000 /* fail 1/N of the times */
72 #define CFS_FAIL_USR1 0x04000000 /* user flag */
74 /* CFS_FAULT may be combined with any one of the above flags. */
75 #define CFS_FAULT 0x02000000 /* match any CFS_FAULT_CHECK */
77 static inline bool CFS_FAIL_PRECHECK(__u32 id)
79 return cfs_fail_loc != 0 &&
80 ((cfs_fail_loc & CFS_FAIL_MASK_LOC) == (id & CFS_FAIL_MASK_LOC) ||
81 (cfs_fail_loc & id & CFS_FAULT));
84 static inline int cfs_fail_check_set(__u32 id, __u32 value,
89 if (unlikely(CFS_FAIL_PRECHECK(id) &&
90 (ret = __cfs_fail_check_set(id, value, set)))) {
92 CDEBUG(D_INFO, "*** cfs_fail_loc=%x, val=%u***\n",
95 LCONSOLE_INFO("*** cfs_fail_loc=%x, val=%u***\n",
103 /* If id hit cfs_fail_loc, return 1, otherwise return 0 */
104 #define CFS_FAIL_CHECK(id) \
105 cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 0)
106 #define CFS_FAIL_CHECK_QUIET(id) \
107 cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 1)
109 /* If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
110 * otherwise return 0 */
111 #define CFS_FAIL_CHECK_VALUE(id, value) \
112 cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 0)
113 #define CFS_FAIL_CHECK_VALUE_QUIET(id, value) \
114 cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 1)
116 /* If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
117 * otherwise return 0 */
118 #define CFS_FAIL_CHECK_ORSET(id, value) \
119 cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 0)
120 #define CFS_FAIL_CHECK_ORSET_QUIET(id, value) \
121 cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 1)
123 /* If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
124 * otherwise return 0 */
125 #define CFS_FAIL_CHECK_RESET(id, value) \
126 cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 0)
127 #define CFS_FAIL_CHECK_RESET_QUIET(id, value) \
128 cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 1)
130 static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
132 if (unlikely(CFS_FAIL_PRECHECK(id)))
133 return __cfs_fail_timeout_set(id, value, ms, set);
138 /* If id hit cfs_fail_loc, sleep for seconds or milliseconds */
139 #define CFS_FAIL_TIMEOUT(id, secs) \
140 cfs_fail_timeout_set(id, 0, (secs) * 1000, CFS_FAIL_LOC_NOSET)
142 #define CFS_FAIL_TIMEOUT_MS(id, ms) \
143 cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET)
145 /* If id hit cfs_fail_loc, cfs_fail_loc |= value and
146 * sleep seconds or milliseconds */
147 #define CFS_FAIL_TIMEOUT_ORSET(id, value, secs) \
148 cfs_fail_timeout_set(id, value, (secs) * 1000, CFS_FAIL_LOC_ORSET)
150 #define CFS_FAIL_TIMEOUT_RESET(id, value, secs) \
151 cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_RESET)
153 #define CFS_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
154 cfs_fail_timeout_set(id, value, ms, CFS_FAIL_LOC_ORSET)
156 #define CFS_FAULT_CHECK(id) \
157 CFS_FAIL_CHECK(CFS_FAULT | (id))
160 /* The idea here is to synchronise two threads to force a race. The
161 * first thread that calls this with a matching fail_loc is put to
162 * sleep. The next thread that calls with the same fail_loc wakes up
163 * the first and continues. */
164 static inline void cfs_race(__u32 id)
166 if (CFS_FAIL_PRECHECK(id)) {
167 if (unlikely(__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) {
170 CERROR("cfs_race id %x sleeping\n", id);
171 rc = wait_event_interruptible(cfs_race_waitq,
172 cfs_race_state != 0);
173 CERROR("cfs_fail_race id %x awake, rc=%d\n", id, rc);
175 CERROR("cfs_fail_race id %x waking\n", id);
177 wake_up(&cfs_race_waitq);
181 #define CFS_RACE(id) cfs_race(id)
183 /* sigh. an expedient fix until CFS_RACE is fixed up */
184 #define CFS_RACE(foo) do {} while(0)
187 #endif /* _LIBCFS_FAIL_H */