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