Commit | Line | Data |
---|---|---|
d7e09d03 PT |
1 | /* |
2 | * GPL HEADER START | |
3 | * | |
4 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
5 | * | |
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. | |
9 | * | |
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). | |
15 | * | |
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 | |
18 | * | |
d7e09d03 PT |
19 | * GPL HEADER END |
20 | */ | |
21 | /* | |
22 | * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. | |
23 | * Use is subject to license terms. | |
24 | * | |
25 | * Copyright (c) 2011, 2012, Intel Corporation. | |
26 | */ | |
27 | /* | |
28 | * This file is part of Lustre, http://www.lustre.org/ | |
29 | * Lustre is a trademark of Oracle Corporation, Inc. | |
30 | */ | |
31 | ||
32 | #ifndef _LIBCFS_FAIL_H | |
33 | #define _LIBCFS_FAIL_H | |
34 | ||
35 | extern unsigned long cfs_fail_loc; | |
36 | extern unsigned int cfs_fail_val; | |
d47b7026 | 37 | extern int cfs_fail_err; |
d7e09d03 PT |
38 | |
39 | extern wait_queue_head_t cfs_race_waitq; | |
40 | extern int cfs_race_state; | |
41 | ||
42 | int __cfs_fail_check_set(__u32 id, __u32 value, int set); | |
43 | int __cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set); | |
44 | ||
45 | enum { | |
46 | CFS_FAIL_LOC_NOSET = 0, | |
47 | CFS_FAIL_LOC_ORSET = 1, | |
48 | CFS_FAIL_LOC_RESET = 2, | |
49 | CFS_FAIL_LOC_VALUE = 3 | |
50 | }; | |
51 | ||
52 | /* Failure injection control */ | |
53 | #define CFS_FAIL_MASK_SYS 0x0000FF00 | |
54 | #define CFS_FAIL_MASK_LOC (0x000000FF | CFS_FAIL_MASK_SYS) | |
55 | ||
56 | #define CFS_FAILED_BIT 30 | |
57 | /* CFS_FAILED is 0x40000000 */ | |
58 | #define CFS_FAILED (1 << CFS_FAILED_BIT) | |
59 | ||
60 | #define CFS_FAIL_ONCE_BIT 31 | |
61 | /* CFS_FAIL_ONCE is 0x80000000 */ | |
62 | #define CFS_FAIL_ONCE (1 << CFS_FAIL_ONCE_BIT) | |
63 | ||
64 | /* The following flags aren't made to be combined */ | |
65 | #define CFS_FAIL_SKIP 0x20000000 /* skip N times then fail */ | |
66 | #define CFS_FAIL_SOME 0x10000000 /* only fail N times */ | |
67 | #define CFS_FAIL_RAND 0x08000000 /* fail 1/N of the times */ | |
68 | #define CFS_FAIL_USR1 0x04000000 /* user flag */ | |
69 | ||
d47b7026 JS |
70 | #define CFS_FAULT 0x02000000 /* match any CFS_FAULT_CHECK */ |
71 | ||
72 | static inline bool CFS_FAIL_PRECHECK(__u32 id) | |
73 | { | |
74 | return cfs_fail_loc != 0 && | |
75 | ((cfs_fail_loc & CFS_FAIL_MASK_LOC) == (id & CFS_FAIL_MASK_LOC) || | |
76 | (cfs_fail_loc & id & CFS_FAULT)); | |
77 | } | |
d7e09d03 PT |
78 | |
79 | static inline int cfs_fail_check_set(__u32 id, __u32 value, | |
80 | int set, int quiet) | |
81 | { | |
82 | int ret = 0; | |
83 | ||
3e9f88e6 PH |
84 | if (unlikely(CFS_FAIL_PRECHECK(id))) { |
85 | ret = __cfs_fail_check_set(id, value, set); | |
86 | if (ret) { | |
87 | if (quiet) { | |
88 | CDEBUG(D_INFO, "*** cfs_fail_loc=%x, val=%u***\n", | |
89 | id, value); | |
90 | } else { | |
91 | LCONSOLE_INFO("*** cfs_fail_loc=%x, val=%u***\n", | |
92 | id, value); | |
93 | } | |
d7e09d03 PT |
94 | } |
95 | } | |
96 | ||
97 | return ret; | |
98 | } | |
99 | ||
100 | /* If id hit cfs_fail_loc, return 1, otherwise return 0 */ | |
101 | #define CFS_FAIL_CHECK(id) \ | |
102 | cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 0) | |
103 | #define CFS_FAIL_CHECK_QUIET(id) \ | |
104 | cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 1) | |
105 | ||
106 | /* If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1, | |
107 | * otherwise return 0 */ | |
108 | #define CFS_FAIL_CHECK_VALUE(id, value) \ | |
109 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 0) | |
110 | #define CFS_FAIL_CHECK_VALUE_QUIET(id, value) \ | |
111 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 1) | |
112 | ||
113 | /* If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1, | |
114 | * otherwise return 0 */ | |
115 | #define CFS_FAIL_CHECK_ORSET(id, value) \ | |
116 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 0) | |
117 | #define CFS_FAIL_CHECK_ORSET_QUIET(id, value) \ | |
118 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 1) | |
119 | ||
120 | /* If id hit cfs_fail_loc, cfs_fail_loc = value and return 1, | |
121 | * otherwise return 0 */ | |
122 | #define CFS_FAIL_CHECK_RESET(id, value) \ | |
123 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 0) | |
124 | #define CFS_FAIL_CHECK_RESET_QUIET(id, value) \ | |
125 | cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 1) | |
126 | ||
127 | static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set) | |
128 | { | |
129 | if (unlikely(CFS_FAIL_PRECHECK(id))) | |
130 | return __cfs_fail_timeout_set(id, value, ms, set); | |
4467a945 | 131 | return 0; |
d7e09d03 PT |
132 | } |
133 | ||
134 | /* If id hit cfs_fail_loc, sleep for seconds or milliseconds */ | |
135 | #define CFS_FAIL_TIMEOUT(id, secs) \ | |
136 | cfs_fail_timeout_set(id, 0, secs * 1000, CFS_FAIL_LOC_NOSET) | |
137 | ||
138 | #define CFS_FAIL_TIMEOUT_MS(id, ms) \ | |
139 | cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET) | |
140 | ||
141 | /* If id hit cfs_fail_loc, cfs_fail_loc |= value and | |
142 | * sleep seconds or milliseconds */ | |
143 | #define CFS_FAIL_TIMEOUT_ORSET(id, value, secs) \ | |
144 | cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_ORSET) | |
145 | ||
c68c3fa4 VF |
146 | #define CFS_FAIL_TIMEOUT_RESET(id, value, secs) \ |
147 | cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_RESET) | |
148 | ||
d7e09d03 PT |
149 | #define CFS_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \ |
150 | cfs_fail_timeout_set(id, value, ms, CFS_FAIL_LOC_ORSET) | |
151 | ||
d47b7026 JS |
152 | #define CFS_FAULT_CHECK(id) \ |
153 | CFS_FAIL_CHECK(CFS_FAULT | (id)) | |
154 | ||
d7e09d03 PT |
155 | /* The idea here is to synchronise two threads to force a race. The |
156 | * first thread that calls this with a matching fail_loc is put to | |
157 | * sleep. The next thread that calls with the same fail_loc wakes up | |
158 | * the first and continues. */ | |
159 | static inline void cfs_race(__u32 id) | |
160 | { | |
161 | ||
162 | if (CFS_FAIL_PRECHECK(id)) { | |
163 | if (unlikely(__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) { | |
164 | int rc; | |
a393fd54 | 165 | |
d7e09d03 PT |
166 | cfs_race_state = 0; |
167 | CERROR("cfs_race id %x sleeping\n", id); | |
46ffc934 JS |
168 | rc = wait_event_interruptible(cfs_race_waitq, |
169 | cfs_race_state != 0); | |
d7e09d03 PT |
170 | CERROR("cfs_fail_race id %x awake, rc=%d\n", id, rc); |
171 | } else { | |
172 | CERROR("cfs_fail_race id %x waking\n", id); | |
173 | cfs_race_state = 1; | |
174 | wake_up(&cfs_race_waitq); | |
175 | } | |
176 | } | |
177 | } | |
a393fd54 | 178 | |
d7e09d03 PT |
179 | #define CFS_RACE(id) cfs_race(id) |
180 | ||
181 | #endif /* _LIBCFS_FAIL_H */ |