Whamcloud - gitweb
i=liangzhen,b=18075:
[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  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef _OBD_SUPPORT
38 #define _OBD_SUPPORT
39
40 #include <libcfs/libcfs.h>
41 #include <lvfs.h>
42 #include <lprocfs_status.h>
43
44 #if defined(__linux__)
45 #include <linux/obd_support.h>
46 #elif defined(__APPLE__)
47 #include <darwin/obd_support.h>
48 #elif defined(__WINNT__)
49 #include <winnt/obd_support.h>
50 #else
51 #error Unsupported operating system.
52 #endif
53
54 /* global variables */
55 extern struct lprocfs_stats *obd_memory;
56 enum {
57         OBD_MEMORY_STAT = 0,
58         OBD_MEMORY_PAGES_STAT = 1,
59         OBD_STATS_NUM,
60 };
61
62 enum {
63         OBD_FAIL_LOC_NOSET      = 0,
64         OBD_FAIL_LOC_ORSET      = 1,
65         OBD_FAIL_LOC_RESET      = 2
66 };
67
68 extern unsigned long obd_fail_loc;
69 extern unsigned int obd_fail_val;
70 extern unsigned int obd_debug_peer_on_timeout;
71 extern unsigned int obd_dump_on_timeout;
72 extern unsigned int obd_dump_on_eviction;
73 /* obd_timeout should only be used for recovery, not for
74    networking / disk / timings affected by load (use Adaptive Timeouts) */
75 extern unsigned int obd_timeout;          /* seconds */
76 extern unsigned int ldlm_timeout;         /* seconds */
77 extern unsigned int at_min;
78 extern unsigned int at_max;
79 extern unsigned int at_history;
80 extern int at_early_margin;
81 extern int at_extra;
82 extern unsigned int obd_sync_filter;
83 extern unsigned int obd_max_dirty_pages;
84 extern atomic_t obd_dirty_pages;
85 extern atomic_t obd_dirty_transit_pages;
86 extern cfs_waitq_t obd_race_waitq;
87 extern int obd_race_state;
88 extern unsigned int obd_alloc_fail_rate;
89
90 int __obd_fail_check_set(__u32 id, __u32 value, int set);
91 int __obd_fail_timeout_set(__u32 id, __u32 value, int ms, int set);
92
93 /* lvfs.c */
94 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
95                    size_t size, const char *file, int line);
96
97 /* Timeout definitions */
98 #define OBD_TIMEOUT_DEFAULT             100
99 #define LDLM_TIMEOUT_DEFAULT            20
100 #define MDS_LDLM_TIMEOUT_DEFAULT        6
101 /* Time to wait for all clients to reconnect during recovery */
102 /* Should be very conservative; must catch the first reconnect after reboot */
103 #define OBD_RECOVERY_FACTOR (3) /* times obd_timeout */
104 /* Change recovery-small 26b time if you change this */
105 #define PING_INTERVAL max(obd_timeout / 4, 1U)
106 /* Client may skip 1 ping; we must wait at least 2.5. But for multiple
107  * failover targets the client only pings one server at a time, and pings
108  * can be lost on a loaded network. Since eviction has serious consequences,
109  * and there's no urgent need to evict a client just because it's idle, we
110  * should be very conservative here. */
111 #define PING_EVICT_TIMEOUT (PING_INTERVAL * 6)
112 #define DISK_TIMEOUT 50          /* Beyond this we warn about disk speed */
113 #define CONNECTION_SWITCH_MIN 5U /* Connection switching rate limiter */
114  /* Max connect interval for nonresponsive servers; ~50s to avoid building up
115     connect requests in the LND queues, but within obd_timeout so we don't
116     miss the recovery window */
117 #define CONNECTION_SWITCH_MAX min(50U, max(CONNECTION_SWITCH_MIN,obd_timeout))
118 #define CONNECTION_SWITCH_INC 5  /* Connection timeout backoff */
119 #ifndef CRAY_XT3
120 /* In general this should be low to have quick detection of a system
121    running on a backup server. (If it's too low, import_select_connection
122    will increase the timeout anyhow.)  */
123 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/20)
124 #else
125 /* ...but for very large systems (e.g. CRAY) we need to keep the initial
126    connect t.o. high (bz 10803), because they will nearly ALWAYS be doing the
127    connects for the first time (clients "reboot" after every process, so no
128    chance to generate adaptive timeout data. */
129 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/2)
130 #endif
131 /* The max delay between connects is SWITCH_MAX + SWITCH_INC + INITIAL */
132 #define RECONNECT_DELAY_MAX (CONNECTION_SWITCH_MAX + CONNECTION_SWITCH_INC + \
133                              INITIAL_CONNECT_TIMEOUT)
134 #define LONG_UNLINK 300          /* Unlink should happen before now */
135
136 /**
137  * Time interval of shrink, if the client is "idle" more than this interval,
138  * then the ll_grant thread will return the requested grant space to filter
139  */
140 #define GRANT_SHRINK_INTERVAL             360/*6 minutes*/
141
142
143 #define OBD_FAIL_MDS                     0x100
144 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
145 #define OBD_FAIL_MDS_GETATTR_NET         0x102
146 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
147 #define OBD_FAIL_MDS_READPAGE_NET        0x104
148 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
149 #define OBD_FAIL_MDS_SENDPAGE            0x106
150 #define OBD_FAIL_MDS_REINT_NET           0x107
151 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
152 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
153 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
154 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
155 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
156 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
157 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
158 #define OBD_FAIL_MDS_REINT_LINK          0x10f
159 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
160 #define OBD_FAIL_MDS_REINT_RENAME        0x111
161 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
162 #define OBD_FAIL_MDS_OPEN_NET            0x113
163 #define OBD_FAIL_MDS_OPEN_PACK           0x114
164 #define OBD_FAIL_MDS_CLOSE_NET           0x115
165 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
166 #define OBD_FAIL_MDS_CONNECT_NET         0x117
167 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
168 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
169 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
170 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
171 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
172 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
173 #define OBD_FAIL_MDS_STATFS_NET          0x11e
174 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
175 #define OBD_FAIL_MDS_PIN_NET             0x120
176 #define OBD_FAIL_MDS_UNPIN_NET           0x121
177 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
178 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
179 #define OBD_FAIL_MDS_SYNC_NET            0x124
180 #define OBD_FAIL_MDS_SYNC_PACK           0x125
181 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
182 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
183 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
184 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
185 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
186 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
187 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
188 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
189 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
190 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
191 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
192 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
193 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
194 #define OBD_FAIL_MDS_SETXATTR            0x133
195 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
196 #define OBD_FAIL_MDS_FS_SETUP            0x135
197 #define OBD_FAIL_MDS_RESEND              0x136
198 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
199 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
200 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
201 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
202 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13b
203 #define OBD_FAIL_MDS_BLOCK_QUOTA_REQ     0x13c
204 #define OBD_FAIL_MDS_DROP_QUOTA_REQ      0x13d
205 #define OBD_FAIL_MDS_REMOVE_COMMON_EA    0x13e
206 #define OBD_FAIL_MDS_ALLOW_COMMON_EA_SETTING   0x13f
207 #define OBD_FAIL_MDS_LOV_PREP_CREATE     0x141
208 #define OBD_FAIL_MDS_REINT_DELAY         0x142
209
210 /* CMD */
211 #define OBD_FAIL_MDS_IS_SUBDIR_NET       0x180
212 #define OBD_FAIL_MDS_IS_SUBDIR_PACK      0x181
213 #define OBD_FAIL_MDS_SET_INFO_NET        0x182
214 #define OBD_FAIL_MDS_WRITEPAGE_NET       0x183
215 #define OBD_FAIL_MDS_WRITEPAGE_PACK      0x184
216 #define OBD_FAIL_MDS_RECOVERY_ACCEPTS_GAPS 0x185
217 #define OBD_FAIL_MDS_GET_INFO_NET        0x186
218
219 #define OBD_FAIL_OST                     0x200
220 #define OBD_FAIL_OST_CONNECT_NET         0x201
221 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
222 #define OBD_FAIL_OST_GET_INFO_NET        0x203
223 #define OBD_FAIL_OST_CREATE_NET          0x204
224 #define OBD_FAIL_OST_DESTROY_NET         0x205
225 #define OBD_FAIL_OST_GETATTR_NET         0x206
226 #define OBD_FAIL_OST_SETATTR_NET         0x207
227 #define OBD_FAIL_OST_OPEN_NET            0x208
228 #define OBD_FAIL_OST_CLOSE_NET           0x209
229 #define OBD_FAIL_OST_BRW_NET             0x20a
230 #define OBD_FAIL_OST_PUNCH_NET           0x20b
231 #define OBD_FAIL_OST_STATFS_NET          0x20c
232 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
233 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
234 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
235 #define OBD_FAIL_OST_SYNC_NET            0x210
236 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
237 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
238 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
239 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
240 #define OBD_FAIL_OST_ENOSPC              0x215
241 #define OBD_FAIL_OST_EROFS               0x216
242 #define OBD_FAIL_OST_ENOENT              0x217
243 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
244 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
245 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
246 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
247 #define OBD_FAIL_OST_BRW_SIZE            0x21c
248 #define OBD_FAIL_OST_DROP_REQ            0x21d
249 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
250 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
251 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
252 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
253 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
254 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
255 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
256 #define OBD_FAIL_OST_CONNECT_NET2        0x225
257 #define OBD_FAIL_OST_NOMEM               0x226
258
259 #define OBD_FAIL_LDLM                    0x300
260 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
261 #define OBD_FAIL_LDLM_ENQUEUE            0x302
262 #define OBD_FAIL_LDLM_CONVERT            0x303
263 #define OBD_FAIL_LDLM_CANCEL             0x304
264 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
265 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
266 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
267 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
268 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
269 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
270 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
271 #define OBD_FAIL_LDLM_REPLY              0x30c
272 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
273 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
274 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
275 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
276 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
277 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
278 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
279 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
280 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
281 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
282 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
283 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
284
285 /* LOCKLESS IO */
286 #define OBD_FAIL_LDLM_SET_CONTENTION     0x385
287
288 #define OBD_FAIL_OSC                     0x400
289 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
290 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
291 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
292 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
293 #define OBD_FAIL_OSC_MATCH               0x405
294 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
295 #define OBD_FAIL_OSC_SHUTDOWN            0x407
296 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
297 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
298 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
299 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
300 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
301 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
302 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
303 #define OBD_FAIL_OSC_CP_CANCEL_RACE      0x40f
304
305 #define OBD_FAIL_PTLRPC                  0x500
306 #define OBD_FAIL_PTLRPC_ACK              0x501
307 #define OBD_FAIL_PTLRPC_RQBD             0x502
308 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
309 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
310 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
311 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
312 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
313 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
314 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
315 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
316 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
317
318 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
319 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
320 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
321 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
322 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
323
324 #define OBD_FAIL_OBD_PING_NET            0x600
325 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
326 #define OBD_FAIL_OBD_LOGD_NET            0x602
327 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
328 #define OBD_FAIL_OBD_DQACQ               0x604
329 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
330 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
331
332 #define OBD_FAIL_TGT_REPLY_NET           0x700
333 #define OBD_FAIL_TGT_CONN_RACE           0x701
334 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
335 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
336 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
337 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
338 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
339 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
340 #define OBD_FAIL_TGT_FAKE_EXP            0x708
341 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
342 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
343
344 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
345 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
346 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
347 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
348
349 #define OBD_FAIL_MGS                     0x900
350 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
351 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
352 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
353 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
354 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
355
356 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
357 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
358
359 #define OBD_FAIL_LPROC_REMOVE            0xB00
360
361 #define OBD_FAIL_GENERAL_ALLOC           0xC00
362
363 #define OBD_FAIL_SEQ                     0x1000
364 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
365
366 #define OBD_FAIL_FLD                     0x1100
367 #define OBD_FAIL_FLD_QUERY_NET           0x1101
368
369 #define OBD_FAIL_SEC_CTX                 0x1200
370 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
371 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
372 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
373 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
374
375 #define OBD_FAIL_LLOG                               0x1300
376 #define OBD_FAIL_LLOG_ORIGIN_CONNECT_NET            0x1301
377 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CREATE_NET      0x1302
378 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_DESTROY_NET     0x1303
379 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_READ_HEADER_NET 0x1304
380 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_NEXT_BLOCK_NET  0x1305
381 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_PREV_BLOCK_NET  0x1306
382 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_WRITE_REC_NET   0x1307
383 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CLOSE_NET       0x1308
384 #define OBD_FAIL_LLOG_CATINFO_NET                   0x1309
385
386
387 /* Failure injection control */
388 #define OBD_FAIL_MASK_SYS    0x0000FF00
389 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
390
391 #define OBD_FAILED_BIT       30
392 /* OBD_FAILED is 0x40000000 */
393 #define OBD_FAILED          (1 << OBD_FAILED_BIT)
394
395 #define OBD_FAIL_ONCE_BIT    31
396 /* OBD_FAIL_ONCE is 0x80000000 */
397 #define OBD_FAIL_ONCE       (1 << OBD_FAIL_ONCE_BIT)
398
399 /* The following flags aren't made to be combined */
400 #define OBD_FAIL_SKIP        0x20000000 /* skip N times then fail */
401 #define OBD_FAIL_SOME        0x10000000 /* only fail N times */
402 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the times */
403 #define OBD_FAIL_USR1        0x04000000 /* user flag */
404
405 #define OBD_FAIL_PRECHECK(id) (obd_fail_loc &&                                \
406                               (obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
407                               ((id) & OBD_FAIL_MASK_LOC))
408
409 static inline int obd_fail_check_set(__u32 id, __u32 value, int set)
410 {
411         int ret = 0;
412         if (unlikely(OBD_FAIL_PRECHECK(id) &&
413             (ret = __obd_fail_check_set(id, value, set)))) {
414                 CERROR("*** obd_fail_loc=%x ***\n", id);
415         }
416         return ret;
417 }
418
419 /* If id hit obd_fail_loc, return 1, otherwise return 0 */
420 #define OBD_FAIL_CHECK(id) \
421         obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET)
422
423 /* If id hit obd_fail_loc, obd_fail_loc |= value and return 1,
424  * otherwise return 0 */
425 #define OBD_FAIL_CHECK_ORSET(id, value) \
426         obd_fail_check_set(id, value, OBD_FAIL_LOC_ORSET)
427
428 /* If id hit obd_fail_loc, obd_fail_loc = value and return 1,
429  * otherwise return 0 */
430 #define OBD_FAIL_CHECK_RESET(id, value) \
431         obd_fail_check_set(id, value, OBD_FAIL_LOC_RESET)
432
433
434 static inline int obd_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
435 {
436         if (unlikely(OBD_FAIL_PRECHECK(id)))
437                 return __obd_fail_timeout_set(id, value, ms, set);
438         else
439                 return 0;
440 }
441
442 /* If id hit obd_fail_loc, sleep for seconds or milliseconds */
443 #define OBD_FAIL_TIMEOUT(id, secs) \
444         obd_fail_timeout_set(id, 0, secs * 1000, OBD_FAIL_LOC_NOSET)
445
446 #define OBD_FAIL_TIMEOUT_MS(id, ms) \
447         obd_fail_timeout_set(id, 0, ms, OBD_FAIL_LOC_NOSET)
448
449 /* If id hit obd_fail_loc, obd_fail_loc |= value and
450  * sleep seconds or milliseconds */
451 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) \
452         obd_fail_timeout_set(id, value, secs * 1000, OBD_FAIL_LOC_ORSET)
453
454 #define OBD_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
455         obd_fail_timeout_set(id, value, ms, OBD_FAIL_LOC_ORSET)
456
457 #ifdef __KERNEL__
458 static inline void obd_fail_write(int id, struct super_block *sb)
459 {
460         /* We set FAIL_ONCE because we never "un-fail" a device */
461         if (OBD_FAIL_CHECK_ORSET(id & ~OBD_FAIL_ONCE, OBD_FAIL_ONCE)) {
462 #ifdef LIBCFS_DEBUG
463                 BDEVNAME_DECLARE_STORAGE(tmp);
464                 CERROR("obd_fail_loc=%x, fail write operation on %s\n",
465                        id, ll_bdevname(sb, tmp));
466 #endif
467                 /* TODO-CMD: fix getting jdev */
468                 __lvfs_set_rdonly(lvfs_sbdev(sb), (lvfs_sbdev_type)0);
469         }
470 }
471 #define OBD_FAIL_WRITE(id, sb) obd_fail_write(id, sb)
472
473 /* The idea here is to synchronise two threads to force a race. The
474  * first thread that calls this with a matching fail_loc is put to
475  * sleep. The next thread that calls with the same fail_loc wakes up
476  * the first and continues. */
477 static inline void obd_race(__u32 id)
478 {
479         if (OBD_FAIL_PRECHECK(id)) {
480                 if (unlikely(__obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET))) {
481                         obd_race_state = 0;
482                         CERROR("obd_race id %x sleeping\n", id);
483                         OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);
484                         CERROR("obd_fail_race id %x awake\n", id);
485                 } else {
486                         CERROR("obd_fail_race id %x waking\n", id);
487                         obd_race_state = 1;
488                         wake_up(&obd_race_waitq);
489                 }
490         }
491 }
492 #define OBD_RACE(id) obd_race(id)
493 #else
494 /* sigh.  an expedient fix until OBD_RACE is fixed up */
495 #define OBD_RACE(foo) do {} while(0)
496 #endif
497
498 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
499
500 extern atomic_t libcfs_kmemory;
501
502 #ifdef LPROCFS
503 #define obd_memory_add(size)                                                  \
504         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
505 #define obd_memory_sub(size)                                                  \
506         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
507 #define obd_memory_sum()                                                      \
508         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
509                                 LPROCFS_FIELDS_FLAGS_SUM)
510 #define obd_pages_add(order)                                                  \
511         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
512                             (long)(1 << (order)))
513 #define obd_pages_sub(order)                                                  \
514         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
515                             (long)(1 << (order)))
516 #define obd_pages_sum()                                                       \
517         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
518                                 LPROCFS_FIELDS_FLAGS_SUM)
519
520 extern void obd_update_maxusage(void);
521 extern __u64 obd_memory_max(void);
522 extern __u64 obd_pages_max(void);
523
524 #else
525
526 extern __u64 obd_alloc;
527 extern __u64 obd_pages;
528
529 extern __u64 obd_max_alloc;
530 extern __u64 obd_max_pages;
531
532 static inline void obd_memory_add(long size)
533 {
534         obd_alloc += size;
535         if (obd_alloc > obd_max_alloc)
536                 obd_max_alloc = obd_alloc;
537 }
538
539 static inline void obd_memory_sub(long size)
540 {
541         obd_alloc -= size;
542 }
543
544 static inline void obd_pages_add(int order)
545 {
546         obd_pages += 1<< order;
547         if (obd_pages > obd_max_pages)
548                 obd_max_pages = obd_pages;
549 }
550
551 static inline void obd_pages_sub(int order)
552 {
553         obd_pages -= 1<< order;
554 }
555
556 #define obd_memory_sum() (obd_alloc)
557 #define obd_pages_sum()  (obd_pages)
558
559 #define obd_memory_max() (obd_max_alloc)
560 #define obd_pages_max() (obd_max_pages)
561
562 #endif
563
564 #define OBD_DEBUG_MEMUSAGE (1)
565
566 #if OBD_DEBUG_MEMUSAGE
567 #define OBD_ALLOC_POST(ptr, size, name)                                 \
568                 obd_memory_add(size);                                   \
569                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
570                        (int)(size), ptr)
571
572 #define OBD_FREE_PRE(ptr, size, name)                                   \
573         LASSERT(ptr);                                                   \
574         obd_memory_sub(size);                                           \
575         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
576                (int)(size), ptr);                                       \
577         POISON(ptr, 0x5a, size)
578
579 #else /* !OBD_DEBUG_MEMUSAGE */
580
581 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
582 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
583
584 #endif /* !OBD_DEBUG_MEMUSAGE */
585
586 #ifdef RANDOM_FAIL_ALLOC
587 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
588 #else
589 #define HAS_FAIL_ALLOC_FLAG 0
590 #endif
591
592 #define OBD_ALLOC_FAIL_BITS 24
593 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
594 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
595
596 #if defined(LUSTRE_UTILS) /* this version is for utils only */
597 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
598 do {                                                                          \
599         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
600         if (unlikely((ptr) == NULL)) {                                        \
601                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
602                        (int)(size), __FILE__, __LINE__);                      \
603         } else {                                                              \
604                 memset(ptr, 0, size);                                         \
605                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
606                        (int)(size), ptr);                                     \
607         }                                                                     \
608 } while (0)
609 #else /* this version is for the kernel and liblustre */
610 #define OBD_FREE_RTN0(ptr)                                                    \
611 ({                                                                            \
612         cfs_free(ptr);                                                        \
613         (ptr) = NULL;                                                         \
614         0;                                                                    \
615 })
616 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
617 do {                                                                          \
618         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
619         if (likely((ptr) != NULL &&                                           \
620                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
621                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
622                                     __FILE__, __LINE__) ||                    \
623                     OBD_FREE_RTN0(ptr)))){                                    \
624                 memset(ptr, 0, size);                                         \
625                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
626         }                                                                     \
627 } while (0)
628 #endif
629
630 #ifndef OBD_ALLOC_MASK
631 # define OBD_ALLOC_MASK CFS_ALLOC_IO
632 #endif
633
634 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
635 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
636 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
637 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
638
639 #ifdef __arch_um__
640 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
641 #else
642 # define OBD_VMALLOC(ptr, size)                                               \
643 do {                                                                          \
644         (ptr) = cfs_alloc_large(size);                                        \
645         if (unlikely((ptr) == NULL)) {                                        \
646                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
647                        (int)(size));                                          \
648                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
649                        obd_memory_sum(), atomic_read(&libcfs_kmemory));       \
650         } else {                                                              \
651                 memset(ptr, 0, size);                                         \
652                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
653         }                                                                     \
654 } while(0)
655 #endif
656
657 #ifdef CONFIG_DEBUG_SLAB
658 #define POISON(ptr, c, s) do {} while (0)
659 #define POISON_PTR(ptr)  ((void)0)
660 #else
661 #define POISON(ptr, c, s) memset(ptr, c, s)
662 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
663 #endif
664
665 #ifdef POISON_BULK
666 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
667                                     kunmap(page); } while (0)
668 #else
669 #define POISON_PAGE(page, val) do { } while (0)
670 #endif
671
672 #ifdef __KERNEL__
673 #define OBD_FREE(ptr, size)                                                   \
674 do {                                                                          \
675         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
676         cfs_free(ptr);                                                        \
677         POISON_PTR(ptr);                                                      \
678 } while(0)
679
680
681 #ifdef HAVE_RCU
682 # ifdef HAVE_CALL_RCU_PARAM
683 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
684 # else
685 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
686 # endif
687 #else
688 # define my_call_rcu(rcu, cb)             (cb)(rcu)
689 #endif
690
691 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
692 do {                                                                          \
693         struct portals_handle *__h = (handle);                                \
694         LASSERT(handle);                                                      \
695         __h->h_ptr = (ptr);                                                   \
696         __h->h_size = (size);                                                 \
697         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
698         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
699         POISON_PTR(ptr);                                                      \
700 } while(0)
701 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
702
703 #else
704 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
705 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
706 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
707 #endif /* ifdef __KERNEL__ */
708
709 #ifdef __arch_um__
710 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
711 #else
712 # define OBD_VFREE(ptr, size)                                                 \
713 do {                                                                          \
714         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
715         cfs_free_large(ptr);                                                  \
716         POISON_PTR(ptr);                                                      \
717 } while(0)
718 #endif
719
720 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
721  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
722  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
723 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
724 ({                                                                            \
725         cfs_mem_cache_free((slab), (ptr));                                    \
726         (ptr) = NULL;                                                         \
727         0;                                                                    \
728 })
729 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
730 do {                                                                          \
731         LASSERT(ergo(type != CFS_ALLOC_ATOMIC, !in_interrupt()));             \
732         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
733         if (likely((ptr) != NULL &&                                           \
734                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
735                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
736                                     __FILE__, __LINE__) ||                    \
737                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
738                 memset(ptr, 0, size);                                         \
739                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
740         }                                                                     \
741 } while(0)
742
743 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
744
745 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
746 do {                                                                          \
747         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
748         cfs_mem_cache_free(slab, ptr);                                        \
749         POISON_PTR(ptr);                                                      \
750 } while(0)
751
752 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
753         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
754 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
755         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
756 #define OBD_SLAB_ALLOC_PTR_GFP(ptr, slab, gfp)                              \
757         OBD_SLAB_ALLOC((ptr), (slab), (gfp), sizeof *(ptr))
758
759 #define KEY_IS(str) \
760         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
761
762 /* Wrapper for contiguous page frame allocation */
763 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask)                                 \
764 do {                                                                          \
765         (ptr) = cfs_alloc_pages(gfp_mask, order);                             \
766         if (unlikely((ptr) == NULL)) {                                        \
767                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
768                        "failed\n", (int)(1 << (order)),                       \
769                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT));            \
770                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
771                        "("LPU64" bytes) allocated by Lustre, "                \
772                        "%d total bytes by LNET\n",                            \
773                        obd_memory_sum(),                                      \
774                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
775                        obd_pages_sum(),                                       \
776                        atomic_read(&libcfs_kmemory));                         \
777         } else {                                                              \
778                 obd_pages_add(order);                                         \
779                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
780                        LPU64" bytes at %p.\n",                                \
781                        (int)(1 << (order)),                                   \
782                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr);       \
783         }                                                                     \
784 } while (0)
785
786 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
787         OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
788
789 #define OBD_PAGES_FREE(ptr, order)                                            \
790 do {                                                                          \
791         LASSERT(ptr);                                                         \
792         obd_pages_sub(order);                                                 \
793         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
794                "at %p.\n",                                                    \
795                (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
796                ptr);                                                          \
797         __cfs_free_pages(ptr, order);                                         \
798         (ptr) = (void *)0xdeadbeef;                                           \
799 } while (0)
800
801 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)
802
803 #endif