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