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