Whamcloud - gitweb
18a51d97a203ff0773745d234cf9ed1f99966259
[fs/lustre-release.git] / libcfs / include / libcfs / libcfs_fail.h
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  *
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, 2014, 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;
37 extern int cfs_fail_err;
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 ranges
53         "0x0100 - 0x3fff" for Lustre
54         "0xe000 - 0xefff" for LNet
55         "0xf000 - 0xffff" for LNDs */
56 /* Failure injection control */
57 #define CFS_FAIL_MASK_SYS    0x0000FF00
58 #define CFS_FAIL_MASK_LOC   (0x000000FF | CFS_FAIL_MASK_SYS)
59
60 #define CFS_FAILED_BIT       30
61 /* CFS_FAILED is 0x40000000 */
62 #define CFS_FAILED          BIT(CFS_FAILED_BIT)
63
64 #define CFS_FAIL_ONCE_BIT    31
65 /* CFS_FAIL_ONCE is 0x80000000 */
66 #define CFS_FAIL_ONCE       BIT(CFS_FAIL_ONCE_BIT)
67
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 */
73
74 /* CFS_FAULT may be combined with any one of the above flags. */
75 #define CFS_FAULT            0x02000000 /* match any CFS_FAULT_CHECK */
76
77 static inline bool CFS_FAIL_PRECHECK(__u32 id)
78 {
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));
82 }
83
84 static inline int cfs_fail_check_set(__u32 id, __u32 value,
85                                      int set, int quiet)
86 {
87         int ret = 0;
88
89         if (unlikely(CFS_FAIL_PRECHECK(id) &&
90                      (ret = __cfs_fail_check_set(id, value, set)))) {
91                 if (quiet) {
92                         CDEBUG(D_INFO, "*** cfs_fail_loc=%x, val=%u***\n",
93                                id, value);
94                 } else {
95                         LCONSOLE_INFO("*** cfs_fail_loc=%x, val=%u***\n",
96                                       id, value);
97                 }
98         }
99
100         return ret;
101 }
102
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)
108
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)
115
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)
122
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)
129
130 static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
131 {
132         if (unlikely(CFS_FAIL_PRECHECK(id)))
133                 return __cfs_fail_timeout_set(id, value, ms, set);
134         else
135                 return 0;
136 }
137
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)
141
142 #define CFS_FAIL_TIMEOUT_MS(id, ms) \
143         cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET)
144
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)
149
150 #define CFS_FAIL_TIMEOUT_RESET(id, value, secs) \
151         cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_RESET)
152
153 #define CFS_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
154         cfs_fail_timeout_set(id, value, ms, CFS_FAIL_LOC_ORSET)
155
156 #define CFS_FAULT_CHECK(id)                     \
157         CFS_FAIL_CHECK(CFS_FAULT | (id))
158
159 /* The idea here is to synchronise two threads to force a race. The
160  * first thread that calls this with a matching fail_loc is put to
161  * sleep. The next thread that calls with the same fail_loc wakes up
162  * the first and continues. */
163 static inline void cfs_race(__u32 id)
164 {
165         if (CFS_FAIL_PRECHECK(id)) {
166                 if (unlikely(__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) {
167                         int rc;
168                         cfs_race_state = 0;
169                         CERROR("cfs_race id %x sleeping\n", id);
170                         rc = wait_event_interruptible(cfs_race_waitq,
171                                                       cfs_race_state != 0);
172                         CERROR("cfs_fail_race id %x awake: rc=%d\n", id, rc);
173                 } else {
174                         CERROR("cfs_fail_race id %x waking\n", id);
175                         cfs_race_state = 1;
176                         wake_up(&cfs_race_waitq);
177                 }
178         }
179 }
180 #define CFS_RACE(id) cfs_race(id)
181
182 /**
183  * Wait on race.
184  *
185  * The first thread that calls this with a matching fail_loc is put to sleep,
186  * but subseqent callers of this won't sleep. Until another thread that calls
187  * cfs_race_wakeup(), the first thread will be woken up and continue.
188  */
189 static inline void cfs_race_wait(__u32 id)
190 {
191         if (CFS_FAIL_PRECHECK(id)) {
192                 if (unlikely(__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) {
193                         int rc;
194
195                         cfs_race_state = 0;
196                         CERROR("cfs_race id %x sleeping\n", id);
197                         rc = wait_event_interruptible(cfs_race_waitq,
198                                                       cfs_race_state != 0);
199                         CERROR("cfs_fail_race id %x awake: rc=%d\n", id, rc);
200                 }
201         }
202 }
203 #define CFS_RACE_WAIT(id) cfs_race_wait(id)
204
205 /**
206  * Wake up the thread that is waiting on the matching fail_loc.
207  */
208 static inline void cfs_race_wakeup(__u32 id)
209 {
210         if (CFS_FAIL_PRECHECK(id)) {
211                 if (likely(!__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) {
212                         CERROR("cfs_fail_race id %x waking\n", id);
213                         cfs_race_state = 1;
214                         wake_up(&cfs_race_waitq);
215                 }
216         }
217 }
218 #define CFS_RACE_WAKEUP(id) cfs_race_wakeup(id)
219
220 #endif /* _LIBCFS_FAIL_H */