Whamcloud - gitweb
6cdcc9a59d18a50f30ab39fc1b9ae954043b31bb
[fs/lustre-release.git] / lustre / include / obd_support.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (C) 2001, 2002 Cluster File Systems, Inc.
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
8  *   Lustre is free software; you can redistribute it and/or
9  *   modify it under the terms of version 2 of the GNU General Public
10  *   License as published by the Free Software Foundation.
11  *
12  *   Lustre is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *   GNU General Public License for more details.
16  *
17  *   You should have received a copy of the GNU General Public License
18  *   along with Lustre; if not, write to the Free Software
19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  */
22
23 #ifndef _OBD_SUPPORT
24 #define _OBD_SUPPORT
25
26 #include <libcfs/kp30.h>
27
28 /* global variables */
29 extern atomic_t obd_memory;
30 extern int obd_memmax;
31 extern unsigned int obd_fail_loc;
32 extern unsigned int obd_debug_peer_on_timeout;
33 extern unsigned int obd_dump_on_timeout;
34 extern unsigned int obd_dump_on_eviction;
35 extern unsigned int obd_timeout;          /* seconds */
36 #define PING_INTERVAL max(obd_timeout / 4, 1U)
37 #define RECONNECT_INTERVAL max(obd_timeout / 10, 10U)
38 extern unsigned int ldlm_timeout;
39 extern unsigned int obd_health_check_timeout;
40 extern unsigned int obd_sync_filter;
41 extern unsigned int obd_max_dirty_pages;
42 extern atomic_t obd_dirty_pages;
43 extern cfs_waitq_t obd_race_waitq;
44 extern int obd_race_state;
45
46
47 #define OBD_FAIL_MDS                     0x100
48 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
49 #define OBD_FAIL_MDS_GETATTR_NET         0x102
50 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
51 #define OBD_FAIL_MDS_READPAGE_NET        0x104
52 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
53 #define OBD_FAIL_MDS_SENDPAGE            0x106
54 #define OBD_FAIL_MDS_REINT_NET           0x107
55 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
56 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
57 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
58 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
59 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
60 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
61 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
62 #define OBD_FAIL_MDS_REINT_LINK          0x10f
63 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
64 #define OBD_FAIL_MDS_REINT_RENAME        0x111
65 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
66 #define OBD_FAIL_MDS_OPEN_NET            0x113
67 #define OBD_FAIL_MDS_OPEN_PACK           0x114
68 #define OBD_FAIL_MDS_CLOSE_NET           0x115
69 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
70 #define OBD_FAIL_MDS_CONNECT_NET         0x117
71 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
72 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
73 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
74 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
75 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
76 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
77 #define OBD_FAIL_MDS_STATFS_NET          0x11e
78 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
79 #define OBD_FAIL_MDS_PIN_NET             0x120
80 #define OBD_FAIL_MDS_UNPIN_NET           0x121
81 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
82 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
83 #define OBD_FAIL_MDS_SYNC_NET            0x124
84 #define OBD_FAIL_MDS_SYNC_PACK           0x125
85 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
86 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
87 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
88 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
89 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
90 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
91 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
92 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
93 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
94 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
95 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
96 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
97 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
98 #define OBD_FAIL_MDS_SETXATTR            0x133
99 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
100 #define OBD_FAIL_MDS_FS_SETUP            0x135
101 #define OBD_FAIL_MDS_RESEND              0x136
102
103 #define OBD_FAIL_OST                     0x200
104 #define OBD_FAIL_OST_CONNECT_NET         0x201
105 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
106 #define OBD_FAIL_OST_GET_INFO_NET        0x203
107 #define OBD_FAIL_OST_CREATE_NET          0x204
108 #define OBD_FAIL_OST_DESTROY_NET         0x205
109 #define OBD_FAIL_OST_GETATTR_NET         0x206
110 #define OBD_FAIL_OST_SETATTR_NET         0x207
111 #define OBD_FAIL_OST_OPEN_NET            0x208
112 #define OBD_FAIL_OST_CLOSE_NET           0x209
113 #define OBD_FAIL_OST_BRW_NET             0x20a
114 #define OBD_FAIL_OST_PUNCH_NET           0x20b
115 #define OBD_FAIL_OST_STATFS_NET          0x20c
116 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
117 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
118 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
119 #define OBD_FAIL_OST_SYNC_NET            0x210
120 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
121 #define OBD_FAIL_OST_ALL_REQUESTS_NET    0x212
122 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
123 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
124 #define OBD_FAIL_OST_ENOSPC              0x215
125 #define OBD_FAIL_OST_EROFS               0x216
126 #define OBD_FAIL_OST_ENOENT              0x217
127 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
128 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
129 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
130 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
131 #define OBD_FAIL_OST_BRW_SIZE            0x21c
132 #define OBD_FAIL_OST_DROP_REQ            0x21d
133 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
134
135 #define OBD_FAIL_LDLM                    0x300
136 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
137 #define OBD_FAIL_LDLM_ENQUEUE            0x302
138 #define OBD_FAIL_LDLM_CONVERT            0x303
139 #define OBD_FAIL_LDLM_CANCEL             0x304
140 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
141 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
142 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
143 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
144 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
145 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
146 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
147 #define OBD_FAIL_LDLM_REPLY              0x30c
148 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
149 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
150 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
151
152 #define OBD_FAIL_OSC                     0x400
153 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
154 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
155 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
156 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
157 #define OBD_FAIL_OSC_MATCH               0x405
158 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
159 #define OBD_FAIL_OSC_SHUTDOWN            0x407
160 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
161 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
162
163 #define OBD_FAIL_PTLRPC                  0x500
164 #define OBD_FAIL_PTLRPC_ACK              0x501
165 #define OBD_FAIL_PTLRPC_RQBD             0x502
166 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
167 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
168 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
169 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
170
171 #define OBD_FAIL_OBD_PING_NET            0x600
172 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
173 #define OBD_FAIL_OBD_LOGD_NET            0x602
174 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
175 #define OBD_FAIL_OBD_DQACQ               0x604
176
177 #define OBD_FAIL_TGT_REPLY_NET           0x700
178 #define OBD_FAIL_TGT_CONN_RACE           0x701
179 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
180 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
181 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
182 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
183
184 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
185
186 #define OBD_FAIL_MGS                     0x900
187 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
188 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
189 #define OBD_FAIL_MGC_PROCESS_LOG         0x903
190 #define OBD_FAIL_MGS_SLOW_REQUEST_NET    0x904
191
192 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT    0xA00
193
194 #define OBD_FAIL_LPROC_REMOVE            0xB00
195
196 /* preparation for a more advanced failure testbed (not functional yet) */
197 #define OBD_FAIL_MASK_SYS    0x0000FF00
198 #define OBD_FAIL_MASK_LOC    (0x000000FF | OBD_FAIL_MASK_SYS)
199 #define OBD_FAIL_ONCE        0x80000000
200 #define OBD_FAILED           0x40000000
201
202 #define OBD_FAIL_CHECK(id)   (((obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
203                               ((id) & OBD_FAIL_MASK_LOC)) &&                   \
204                               ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE))!= \
205                                 (OBD_FAILED | OBD_FAIL_ONCE)))
206
207 #define OBD_FAIL_CHECK_ONCE(id)                                              \
208 ({      int _ret_ = 0;                                                       \
209         if (OBD_FAIL_CHECK(id)) {                                            \
210                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
211                 obd_fail_loc |= OBD_FAILED;                                  \
212                 if ((id) & OBD_FAIL_ONCE)                                    \
213                         obd_fail_loc |= OBD_FAIL_ONCE;                       \
214                 _ret_ = 1;                                                   \
215         }                                                                    \
216         _ret_;                                                               \
217 })
218
219 #define OBD_FAIL_RETURN(id, ret)                                             \
220 do {                                                                         \
221         if (OBD_FAIL_CHECK_ONCE(id)) {                                       \
222                 RETURN(ret);                                                 \
223         }                                                                    \
224 } while(0)
225
226 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
227 do {                                                                         \
228         if (OBD_FAIL_CHECK_ONCE(id)) {                                       \
229                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
230                        (id), (secs));                                        \
231                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
232                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
233                                     cfs_time_seconds(secs));                 \
234                 set_current_state(TASK_RUNNING);                             \
235                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
236        }                                                                     \
237 } while(0)
238
239 #ifdef __KERNEL__
240 /* The idea here is to synchronise two threads to force a race. The
241  * first thread that calls this with a matching fail_loc is put to
242  * sleep. The next thread that calls with the same fail_loc wakes up
243  * the first and continues. */
244 #define OBD_RACE(id)                                                         \
245 do {                                                                         \
246         if  (OBD_FAIL_CHECK_ONCE(id)) {                                      \
247                 obd_race_state = 0;                                          \
248                 CERROR("obd_race id %x sleeping\n", (id));                   \
249                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
250                 CERROR("obd_fail_race id %x awake\n", (id));                 \
251         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
252                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
253                 CERROR("obd_fail_race id %x waking\n", (id));                \
254                 obd_race_state = 1;                                          \
255                 wake_up(&obd_race_waitq);                                    \
256         }                                                                    \
257 } while(0)
258 #else
259 /* sigh.  an expedient fix until OBD_RACE is fixed up */
260 #define OBD_RACE(foo) do {} while(0)
261 #endif
262
263 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
264
265 extern atomic_t libcfs_kmemory;
266
267 #if defined(LUSTRE_UTILS) /* this version is for utils only */
268 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
269 do {                                                                          \
270         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
271         if ((ptr) == NULL) {                                                  \
272                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
273                        (int)(size), __FILE__, __LINE__);                      \
274         } else {                                                              \
275                 memset(ptr, 0, size);                                         \
276                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
277                        (int)(size), ptr);                                     \
278         }                                                                     \
279 } while (0)
280 #else /* this version is for the kernel and liblustre */
281 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
282 do {                                                                          \
283         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
284         if ((ptr) == NULL) {                                                  \
285                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
286                        (int)(size), __FILE__, __LINE__);                      \
287                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
288                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
289         } else {                                                              \
290                 memset(ptr, 0, size);                                         \
291                 atomic_add(size, &obd_memory);                                \
292                 if (atomic_read(&obd_memory) > obd_memmax)                    \
293                         obd_memmax = atomic_read(&obd_memory);                \
294                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d)\n", \
295                        (int)(size), ptr, atomic_read(&obd_memory));           \
296         }                                                                     \
297 } while (0)
298 #endif
299
300 #ifndef OBD_ALLOC_MASK
301 # define OBD_ALLOC_MASK CFS_ALLOC_IO
302 #endif
303
304 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
305 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
306 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
307 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
308
309 #ifdef __arch_um__
310 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
311 #else
312 # define OBD_VMALLOC(ptr, size)                                               \
313 do {                                                                          \
314         (ptr) = cfs_alloc_large(size);                                        \
315         if ((ptr) == NULL) {                                                  \
316                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
317                        (int)(size), __FILE__, __LINE__);                      \
318                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
319                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
320         } else {                                                              \
321                 memset(ptr, 0, size);                                         \
322                 atomic_add(size, &obd_memory);                                \
323                 if (atomic_read(&obd_memory) > obd_memmax)                    \
324                         obd_memmax = atomic_read(&obd_memory);                \
325                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p (tot %d)\n", \
326                        (int)(size), ptr, atomic_read(&obd_memory));           \
327         }                                                                     \
328 } while (0)
329 #endif
330
331 #ifdef CONFIG_DEBUG_SLAB
332 #define POISON(ptr, c, s) do {} while (0)
333 #else
334 #define POISON(ptr, c, s) memset(ptr, c, s)
335 #endif
336
337 #ifdef POISON_BULK
338 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
339                                     kunmap(page); } while (0)
340 #else
341 #define POISON_PAGE(page, val) do { } while (0)
342 #endif
343
344 #ifdef __KERNEL__
345 #define OBD_FREE(ptr, size)                                                   \
346 do {                                                                          \
347         LASSERT(ptr);                                                         \
348         atomic_sub(size, &obd_memory);                                        \
349         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",           \
350                (int)(size), ptr, atomic_read(&obd_memory));                   \
351         POISON(ptr, 0x5a, size);                                              \
352         cfs_free(ptr);                                                        \
353         (ptr) = (void *)0xdeadbeef;                                           \
354 } while (0)
355 #else
356 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
357 #endif
358
359 #ifdef __arch_um__
360 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
361 #else
362 # define OBD_VFREE(ptr, size)                                                 \
363 do {                                                                          \
364         LASSERT(ptr);                                                         \
365         atomic_sub(size, &obd_memory);                                        \
366         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p (tot %d).\n",           \
367                (int)(size), ptr, atomic_read(&obd_memory));                   \
368         POISON(ptr, 0x5a, size);                                              \
369         cfs_free_large(ptr);                                                  \
370         (ptr) = (void *)0xdeadbeef;                                           \
371 } while (0)
372 #endif
373
374 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
375  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
376  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
377 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
378 do {                                                                          \
379         LASSERT(!in_interrupt());                                             \
380         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
381         if ((ptr) == NULL) {                                                  \
382                 CERROR("slab-alloc of '"#ptr"' (%d bytes) failed at %s:%d\n", \
383                        (int)(size), __FILE__, __LINE__);                      \
384                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
385                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
386         } else {                                                              \
387                 memset(ptr, 0, size);                                         \
388                 atomic_add(size, &obd_memory);                                \
389                 if (atomic_read(&obd_memory) > obd_memmax)                    \
390                         obd_memmax = atomic_read(&obd_memory);                \
391                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p (tot %d)\n",\
392                        (int)(size), ptr, atomic_read(&obd_memory));           \
393         }                                                                     \
394 } while (0)
395
396 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
397
398 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
399 do {                                                                          \
400         LASSERT(ptr);                                                         \
401         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p (tot %d).\n",       \
402                (int)(size), ptr, atomic_read(&obd_memory));                   \
403         atomic_sub(size, &obd_memory);                                        \
404         POISON(ptr, 0x5a, size);                                              \
405         cfs_mem_cache_free(slab, ptr);                                        \
406         (ptr) = (void *)0xdeadbeef;                                           \
407 } while (0)
408
409 #define KEY_IS(str) (keylen >= strlen(key) && strcmp(key, str) == 0)
410
411 #if defined(__linux__)
412 #include <linux/obd_support.h>
413 #elif defined(__APPLE__)
414 #include <darwin/obd_support.h>
415 #elif defined(__WINNT__)
416 #include <winnt/obd_support.h>
417 #else
418 #error Unsupported operating system.
419 #endif
420
421 #endif