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