Whamcloud - gitweb
LU-687 clio: retry if fault page was truncated
[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 (c) 2007, 2010, Oracle and/or its affiliates. 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 extern unsigned int obd_debug_peer_on_timeout;
63 extern unsigned int obd_dump_on_timeout;
64 extern unsigned int obd_dump_on_eviction;
65 /* obd_timeout should only be used for recovery, not for
66    networking / disk / timings affected by load (use Adaptive Timeouts) */
67 extern unsigned int obd_timeout;          /* seconds */
68 extern unsigned int ldlm_timeout;         /* seconds */
69 extern unsigned int at_min;
70 extern unsigned int at_max;
71 extern unsigned int at_history;
72 extern int at_early_margin;
73 extern int at_extra;
74 extern unsigned int obd_sync_filter;
75 extern unsigned int obd_max_dirty_pages;
76 extern cfs_atomic_t obd_dirty_pages;
77 extern cfs_atomic_t obd_dirty_transit_pages;
78 extern unsigned int obd_alloc_fail_rate;
79
80 /* lvfs.c */
81 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
82                    size_t size, const char *file, int line);
83
84 /* Some hash init argument constants */
85 #define HASH_POOLS_BKT_BITS 3
86 #define HASH_POOLS_CUR_BITS 3
87 #define HASH_POOLS_MAX_BITS 7
88 #define HASH_UUID_BKT_BITS 5
89 #define HASH_UUID_CUR_BITS 7
90 #define HASH_UUID_MAX_BITS 12
91 #define HASH_NID_BKT_BITS 5
92 #define HASH_NID_CUR_BITS 7
93 #define HASH_NID_MAX_BITS 12
94 #define HASH_NID_STATS_BKT_BITS 5
95 #define HASH_NID_STATS_CUR_BITS 7
96 #define HASH_NID_STATS_MAX_BITS 12
97 #define HASH_LQS_BKT_BITS 5
98 #define HASH_LQS_CUR_BITS 7
99 #define HASH_LQS_MAX_BITS 12
100 #define HASH_CONN_BKT_BITS 5
101 #define HASH_CONN_CUR_BITS 5
102 #define HASH_CONN_MAX_BITS 15
103 #define HASH_EXP_LOCK_BKT_BITS  5
104 #define HASH_EXP_LOCK_CUR_BITS  7
105 #define HASH_EXP_LOCK_MAX_BITS  16
106 #define HASH_CL_ENV_BKT_BITS    5
107 #define HASH_CL_ENV_BITS        10
108
109 /* Timeout definitions */
110 #define OBD_TIMEOUT_DEFAULT             100
111 #define LDLM_TIMEOUT_DEFAULT            20
112 #define MDS_LDLM_TIMEOUT_DEFAULT        6
113 /* Time to wait for all clients to reconnect during recovery (hard limit) */
114 #define OBD_RECOVERY_TIME_HARD          (obd_timeout * 9)
115 /* Time to wait for all clients to reconnect during recovery (soft limit) */
116 /* Should be very conservative; must catch the first reconnect after reboot */
117 #define OBD_RECOVERY_TIME_SOFT          (obd_timeout * 3)
118 /* Change recovery-small 26b time if you change this */
119 #define PING_INTERVAL max(obd_timeout / 4, 1U)
120 /* a bit more than maximal journal commit time in seconds */
121 #define PING_INTERVAL_SHORT min(PING_INTERVAL, 7U)
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 /* The min time a target should wait for clients to reconnect in recovery */
151 #define OBD_RECOVERY_TIME_MIN    (2*RECONNECT_DELAY_MAX)
152 #define OBD_IR_FACTOR_MIN         1
153 #define OBD_IR_FACTOR_MAX         10
154 #define OBD_IR_FACTOR_DEFAULT    (OBD_IR_FACTOR_MAX/2)
155 /* default timeout for the MGS to become IR_FULL */
156 #define OBD_IR_MGS_TIMEOUT       (4*obd_timeout)
157 #define LONG_UNLINK 300          /* Unlink should happen before now */
158
159 /**
160  * Time interval of shrink, if the client is "idle" more than this interval,
161  * then the ll_grant thread will return the requested grant space to filter
162  */
163 #define GRANT_SHRINK_INTERVAL            1200/*20 minutes*/
164
165 #define OBD_FAIL_MDS                     0x100
166 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
167 #define OBD_FAIL_MDS_GETATTR_NET         0x102
168 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
169 #define OBD_FAIL_MDS_READPAGE_NET        0x104
170 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
171 #define OBD_FAIL_MDS_SENDPAGE            0x106
172 #define OBD_FAIL_MDS_REINT_NET           0x107
173 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
174 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
175 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
176 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
177 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
178 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
179 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
180 #define OBD_FAIL_MDS_REINT_LINK          0x10f
181 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
182 #define OBD_FAIL_MDS_REINT_RENAME        0x111
183 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
184 #define OBD_FAIL_MDS_OPEN_NET            0x113
185 #define OBD_FAIL_MDS_OPEN_PACK           0x114
186 #define OBD_FAIL_MDS_CLOSE_NET           0x115
187 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
188 #define OBD_FAIL_MDS_CONNECT_NET         0x117
189 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
190 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
191 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
192 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
193 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
194 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
195 #define OBD_FAIL_MDS_STATFS_NET          0x11e
196 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
197 #define OBD_FAIL_MDS_PIN_NET             0x120
198 #define OBD_FAIL_MDS_UNPIN_NET           0x121
199 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
200 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
201 #define OBD_FAIL_MDS_SYNC_NET            0x124
202 #define OBD_FAIL_MDS_SYNC_PACK           0x125
203 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
204 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
205 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
206 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
207 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
208 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
209 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
210 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
211 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
212 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
213 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
214 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
215 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
216 #define OBD_FAIL_MDS_SETXATTR            0x133
217 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
218 #define OBD_FAIL_MDS_FS_SETUP            0x135
219 #define OBD_FAIL_MDS_RESEND              0x136
220 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
221 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
222 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
223 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
224 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13b
225 #define OBD_FAIL_MDS_BLOCK_QUOTA_REQ     0x13c
226 #define OBD_FAIL_MDS_DROP_QUOTA_REQ      0x13d
227 #define OBD_FAIL_MDS_REMOVE_COMMON_EA    0x13e
228 #define OBD_FAIL_MDS_ALLOW_COMMON_EA_SETTING   0x13f
229 #define OBD_FAIL_MDS_FAIL_LOV_LOG_ADD    0x140
230 #define OBD_FAIL_MDS_LOV_PREP_CREATE     0x141
231 #define OBD_FAIL_MDS_REINT_DELAY         0x142
232 #define OBD_FAIL_MDS_READLINK_EPROTO     0x143
233 #define OBD_FAIL_MDS_OPEN_WAIT_CREATE    0x144
234 #define OBD_FAIL_MDS_PDO_LOCK            0x145
235 #define OBD_FAIL_MDS_PDO_LOCK2           0x146
236 #define OBD_FAIL_MDS_OSC_CREATE_FAIL     0x147
237
238 /* CMD */
239 #define OBD_FAIL_MDS_IS_SUBDIR_NET       0x180
240 #define OBD_FAIL_MDS_IS_SUBDIR_PACK      0x181
241 #define OBD_FAIL_MDS_SET_INFO_NET        0x182
242 #define OBD_FAIL_MDS_WRITEPAGE_NET       0x183
243 #define OBD_FAIL_MDS_WRITEPAGE_PACK      0x184
244 #define OBD_FAIL_MDS_RECOVERY_ACCEPTS_GAPS 0x185
245 #define OBD_FAIL_MDS_GET_INFO_NET        0x186
246
247 #define OBD_FAIL_OST                     0x200
248 #define OBD_FAIL_OST_CONNECT_NET         0x201
249 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
250 #define OBD_FAIL_OST_GET_INFO_NET        0x203
251 #define OBD_FAIL_OST_CREATE_NET          0x204
252 #define OBD_FAIL_OST_DESTROY_NET         0x205
253 #define OBD_FAIL_OST_GETATTR_NET         0x206
254 #define OBD_FAIL_OST_SETATTR_NET         0x207
255 #define OBD_FAIL_OST_OPEN_NET            0x208
256 #define OBD_FAIL_OST_CLOSE_NET           0x209
257 #define OBD_FAIL_OST_BRW_NET             0x20a
258 #define OBD_FAIL_OST_PUNCH_NET           0x20b
259 #define OBD_FAIL_OST_STATFS_NET          0x20c
260 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
261 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
262 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
263 #define OBD_FAIL_OST_SYNC_NET            0x210
264 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
265 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
266 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
267 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
268 #define OBD_FAIL_OST_ENOSPC              0x215
269 #define OBD_FAIL_OST_EROFS               0x216
270 #define OBD_FAIL_OST_ENOENT              0x217
271 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
272 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
273 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
274 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
275 #define OBD_FAIL_OST_BRW_SIZE            0x21c
276 #define OBD_FAIL_OST_DROP_REQ            0x21d
277 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
278 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
279 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
280 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
281 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
282 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
283 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
284 #define OBD_FAIL_OST_CONNECT_NET2        0x225
285 #define OBD_FAIL_OST_NOMEM               0x226
286 #define OBD_FAIL_OST_BRW_PAUSE_BULK2     0x227
287 #define OBD_FAIL_OST_MAPBLK_ENOSPC       0x228
288
289 #define OBD_FAIL_LDLM                    0x300
290 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
291 #define OBD_FAIL_LDLM_ENQUEUE            0x302
292 #define OBD_FAIL_LDLM_CONVERT            0x303
293 #define OBD_FAIL_LDLM_CANCEL             0x304
294 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
295 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
296 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
297 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
298 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
299 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
300 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
301 #define OBD_FAIL_LDLM_REPLY              0x30c
302 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
303 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
304 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
305 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
306 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
307 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
308 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
309 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
310 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
311 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
312 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
313 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
314 #define OBD_FAIL_LDLM_NEW_LOCK           0x319
315
316 /* LOCKLESS IO */
317 #define OBD_FAIL_LDLM_SET_CONTENTION     0x385
318
319 #define OBD_FAIL_OSC                     0x400
320 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
321 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
322 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
323 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
324 #define OBD_FAIL_OSC_MATCH               0x405
325 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
326 #define OBD_FAIL_OSC_SHUTDOWN            0x407
327 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
328 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
329 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
330 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
331 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
332 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
333 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
334 #define OBD_FAIL_OSC_CP_CANCEL_RACE      0x40f
335 #define OBD_FAIL_OSC_CP_ENQ_RACE         0x410
336 #define OBD_FAIL_OSC_NO_GRANT            0x411
337
338 #define OBD_FAIL_PTLRPC                  0x500
339 #define OBD_FAIL_PTLRPC_ACK              0x501
340 #define OBD_FAIL_PTLRPC_RQBD             0x502
341 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
342 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
343 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
344 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
345 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
346 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
347 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
348 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
349 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
350 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
351 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
352 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
353 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
354 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
355 #define OBD_FAIL_PTLRPC_DROP_REQ_OPC     0x513
356 #define OBD_FAIL_PTLRPC_FINISH_REPLAY    0x514
357
358 #define OBD_FAIL_OBD_PING_NET            0x600
359 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
360 #define OBD_FAIL_OBD_LOGD_NET            0x602
361 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
362 #define OBD_FAIL_OBD_DQACQ               0x604
363 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
364 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
365
366 #define OBD_FAIL_TGT_REPLY_NET           0x700
367 #define OBD_FAIL_TGT_CONN_RACE           0x701
368 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
369 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
370 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
371 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
372 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
373 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
374 #define OBD_FAIL_TGT_FAKE_EXP            0x708
375 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
376 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
377 #define OBD_FAIL_TGT_CLIENT_ADD          0x711
378 #define OBD_FAIL_TGT_RCVG_FLAG           0x712
379
380 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
381 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
382 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
383 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
384
385 #define OBD_FAIL_MGS                     0x900
386 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
387 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
388 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
389 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
390 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
391
392 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
393 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
394 #define OBD_FAIL_QUOTA_DELAY_SD          0xA04
395
396 #define OBD_FAIL_LPROC_REMOVE            0xB00
397
398 #define OBD_FAIL_GENERAL_ALLOC           0xC00
399
400 #define OBD_FAIL_SEQ                     0x1000
401 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
402
403 #define OBD_FAIL_FLD                     0x1100
404 #define OBD_FAIL_FLD_QUERY_NET           0x1101
405
406 #define OBD_FAIL_SEC_CTX                 0x1200
407 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
408 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
409 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
410 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
411
412 #define OBD_FAIL_LLOG                               0x1300
413 #define OBD_FAIL_LLOG_ORIGIN_CONNECT_NET            0x1301
414 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CREATE_NET      0x1302
415 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_DESTROY_NET     0x1303
416 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_READ_HEADER_NET 0x1304
417 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_NEXT_BLOCK_NET  0x1305
418 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_PREV_BLOCK_NET  0x1306
419 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_WRITE_REC_NET   0x1307
420 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CLOSE_NET       0x1308
421 #define OBD_FAIL_LLOG_CATINFO_NET                   0x1309
422 #define OBD_FAIL_MDS_SYNC_CAPA_SL                   0x1310
423 #define OBD_FAIL_SEQ_ALLOC                          0x1311
424
425 #define OBD_FAIL_LLITE                              0x1400
426 #define OBD_FAIL_LLITE_FAULT_TRUNC_RACE             0x1401
427
428 /* Assign references to moved code to reduce code changes */
429 #define OBD_FAIL_PRECHECK(id)                   CFS_FAIL_PRECHECK(id)
430 #define OBD_FAIL_CHECK(id)                      CFS_FAIL_CHECK(id)
431 #define OBD_FAIL_CHECK_ORSET(id, value)         CFS_FAIL_CHECK_ORSET(id, value)
432 #define OBD_FAIL_CHECK_RESET(id, value)         CFS_FAIL_CHECK_RESET(id, value)
433 #define OBD_FAIL_RETURN(id, ret)                CFS_FAIL_RETURN(id, ret)
434 #define OBD_FAIL_TIMEOUT(id, secs)              CFS_FAIL_TIMEOUT(id, secs)
435 #define OBD_FAIL_TIMEOUT_MS(id, ms)             CFS_FAIL_TIMEOUT_MS(id, ms)
436 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) CFS_FAIL_TIMEOUT_ORSET(id, value, secs)
437 #define OBD_RACE(id)                            CFS_RACE(id)
438 #define OBD_FAIL_ONCE                           CFS_FAIL_ONCE
439 #define OBD_FAILED                              CFS_FAILED
440
441 #ifdef __KERNEL__
442 static inline void obd_fail_write(int id, struct super_block *sb)
443 {
444         /* We set FAIL_ONCE because we never "un-fail" a device */
445         if (OBD_FAIL_CHECK_ORSET(id & ~OBD_FAIL_ONCE, OBD_FAIL_ONCE)) {
446 #ifdef LIBCFS_DEBUG
447                 BDEVNAME_DECLARE_STORAGE(tmp);
448                 CERROR("cfs_fail_loc=%x, fail write operation on %s\n",
449                        id, ll_bdevname(sb, tmp));
450 #endif
451                 /* TODO-CMD: fix getting jdev */
452                 __lvfs_set_rdonly(lvfs_sbdev(sb), (lvfs_sbdev_type)0);
453         }
454 }
455 #define OBD_FAIL_WRITE(id, sb) obd_fail_write(id, sb)
456 #endif
457
458 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
459
460 extern cfs_atomic_t libcfs_kmemory;
461
462 #ifdef LPROCFS
463 #define obd_memory_add(size)                                                  \
464         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
465 #define obd_memory_sub(size)                                                  \
466         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
467 #define obd_memory_sum()                                                      \
468         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
469                                 LPROCFS_FIELDS_FLAGS_SUM)
470 #define obd_pages_add(order)                                                  \
471         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
472                             (long)(1 << (order)))
473 #define obd_pages_sub(order)                                                  \
474         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
475                             (long)(1 << (order)))
476 #define obd_pages_sum()                                                       \
477         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
478                                 LPROCFS_FIELDS_FLAGS_SUM)
479
480 extern void obd_update_maxusage(void);
481 extern __u64 obd_memory_max(void);
482 extern __u64 obd_pages_max(void);
483
484 #else
485
486 extern __u64 obd_alloc;
487 extern __u64 obd_pages;
488
489 extern __u64 obd_max_alloc;
490 extern __u64 obd_max_pages;
491
492 static inline void obd_memory_add(long size)
493 {
494         obd_alloc += size;
495         if (obd_alloc > obd_max_alloc)
496                 obd_max_alloc = obd_alloc;
497 }
498
499 static inline void obd_memory_sub(long size)
500 {
501         obd_alloc -= size;
502 }
503
504 static inline void obd_pages_add(int order)
505 {
506         obd_pages += 1<< order;
507         if (obd_pages > obd_max_pages)
508                 obd_max_pages = obd_pages;
509 }
510
511 static inline void obd_pages_sub(int order)
512 {
513         obd_pages -= 1<< order;
514 }
515
516 #define obd_memory_sum() (obd_alloc)
517 #define obd_pages_sum()  (obd_pages)
518
519 #define obd_memory_max() (obd_max_alloc)
520 #define obd_pages_max() (obd_max_pages)
521
522 #endif
523
524 #define OBD_DEBUG_MEMUSAGE (1)
525
526 #if OBD_DEBUG_MEMUSAGE
527 #define OBD_ALLOC_POST(ptr, size, name)                                 \
528                 obd_memory_add(size);                                   \
529                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
530                        (int)(size), ptr)
531
532 #define OBD_FREE_PRE(ptr, size, name)                                   \
533         LASSERT(ptr);                                                   \
534         obd_memory_sub(size);                                           \
535         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
536                (int)(size), ptr);                                       \
537         POISON(ptr, 0x5a, size)
538
539 #else /* !OBD_DEBUG_MEMUSAGE */
540
541 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
542 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
543
544 #endif /* !OBD_DEBUG_MEMUSAGE */
545
546 #ifdef RANDOM_FAIL_ALLOC
547 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
548 #else
549 #define HAS_FAIL_ALLOC_FLAG 0
550 #endif
551
552 #define OBD_ALLOC_FAIL_BITS 24
553 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
554 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
555
556 #if defined(LUSTRE_UTILS) /* this version is for utils only */
557 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
558 do {                                                                          \
559         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
560         if (unlikely((ptr) == NULL)) {                                        \
561                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
562                        (int)(size), __FILE__, __LINE__);                      \
563         } else {                                                              \
564                 memset(ptr, 0, size);                                         \
565                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
566                        (int)(size), ptr);                                     \
567         }                                                                     \
568 } while (0)
569 #else /* this version is for the kernel and liblustre */
570 #define OBD_FREE_RTN0(ptr)                                                    \
571 ({                                                                            \
572         cfs_free(ptr);                                                        \
573         (ptr) = NULL;                                                         \
574         0;                                                                    \
575 })
576 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
577 do {                                                                          \
578         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
579         if (likely((ptr) != NULL &&                                           \
580                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
581                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
582                                     __FILE__, __LINE__) ||                    \
583                     OBD_FREE_RTN0(ptr)))){                                    \
584                 memset(ptr, 0, size);                                         \
585                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
586         }                                                                     \
587 } while (0)
588 #endif
589
590 #ifndef OBD_ALLOC_MASK
591 # define OBD_ALLOC_MASK CFS_ALLOC_IO
592 #endif
593
594 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
595 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
596 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
597 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
598
599 #ifdef __arch_um__
600 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
601 #else
602 # define OBD_VMALLOC(ptr, size)                                               \
603 do {                                                                          \
604         (ptr) = cfs_alloc_large(size);                                        \
605         if (unlikely((ptr) == NULL)) {                                        \
606                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
607                        (int)(size));                                          \
608                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
609                        obd_memory_sum(), cfs_atomic_read(&libcfs_kmemory));   \
610         } else {                                                              \
611                 memset(ptr, 0, size);                                         \
612                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
613         }                                                                     \
614 } while(0)
615 #endif
616
617 #ifdef __KERNEL__
618
619 /* Allocations above this size are considered too big and could not be done
620  * atomically. 
621  *
622  * Be very careful when changing this value, especially when decreasing it,
623  * since vmalloc in Linux doesn't perform well on multi-cores system, calling 
624  * vmalloc in critical path would hurt peformance badly. See LU-66.
625  */
626 #define OBD_ALLOC_BIG (4 * CFS_PAGE_SIZE)
627
628 #define OBD_ALLOC_LARGE(ptr, size)                                            \
629 do {                                                                          \
630         if (size > OBD_ALLOC_BIG)                                             \
631                 OBD_VMALLOC(ptr, size);                                       \
632         else                                                                  \
633                 OBD_ALLOC(ptr, size);                                         \
634 } while (0)
635
636 #define OBD_FREE_LARGE(ptr, size)                                             \
637 do {                                                                          \
638         if (size > OBD_ALLOC_BIG)                                             \
639                 OBD_VFREE(ptr, size);                                         \
640         else                                                                  \
641                 OBD_FREE(ptr, size);                                          \
642 } while (0)
643 #else
644 #define OBD_ALLOC_LARGE(ptr, size) OBD_ALLOC(ptr, size)
645 #define OBD_FREE_LARGE(ptr, size) OBD_FREE(ptr,size)
646 #endif
647
648 #ifdef CONFIG_DEBUG_SLAB
649 #define POISON(ptr, c, s) do {} while (0)
650 #define POISON_PTR(ptr)  ((void)0)
651 #else
652 #define POISON(ptr, c, s) memset(ptr, c, s)
653 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
654 #endif
655
656 #ifdef POISON_BULK
657 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
658                                     kunmap(page); } while (0)
659 #else
660 #define POISON_PAGE(page, val) do { } while (0)
661 #endif
662
663 #ifdef __KERNEL__
664 #define OBD_FREE(ptr, size)                                                   \
665 do {                                                                          \
666         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
667         cfs_free(ptr);                                                        \
668         POISON_PTR(ptr);                                                      \
669 } while(0)
670
671
672 #ifdef HAVE_RCU
673 # ifdef HAVE_CALL_RCU_PARAM
674 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
675 # else
676 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
677 # endif
678 #else
679 # define my_call_rcu(rcu, cb)             (cb)(rcu)
680 #endif
681
682 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
683 do {                                                                          \
684         struct portals_handle *__h = (handle);                                \
685         LASSERT(handle);                                                      \
686         __h->h_ptr = (ptr);                                                   \
687         __h->h_size = (size);                                                 \
688         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
689         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
690         POISON_PTR(ptr);                                                      \
691 } while(0)
692 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
693
694 #else
695 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
696 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
697 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
698 #endif /* ifdef __KERNEL__ */
699
700 #ifdef __arch_um__
701 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
702 #else
703 # define OBD_VFREE(ptr, size)                                                 \
704 do {                                                                          \
705         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
706         cfs_free_large(ptr);                                                  \
707         POISON_PTR(ptr);                                                      \
708 } while(0)
709 #endif
710
711 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
712  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
713  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
714 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
715 ({                                                                            \
716         cfs_mem_cache_free((slab), (ptr));                                    \
717         (ptr) = NULL;                                                         \
718         0;                                                                    \
719 })
720 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
721 do {                                                                          \
722         LASSERT(ergo(type != CFS_ALLOC_ATOMIC, !cfs_in_interrupt()));         \
723         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
724         if (likely((ptr) != NULL &&                                           \
725                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
726                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
727                                     __FILE__, __LINE__) ||                    \
728                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
729                 memset(ptr, 0, size);                                         \
730                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
731         }                                                                     \
732 } while(0)
733
734 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
735
736 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
737 do {                                                                          \
738         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
739         cfs_mem_cache_free(slab, ptr);                                        \
740         POISON_PTR(ptr);                                                      \
741 } while(0)
742
743 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
744         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
745 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
746         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
747 #define OBD_SLAB_ALLOC_PTR_GFP(ptr, slab, gfp)                              \
748         OBD_SLAB_ALLOC((ptr), (slab), (gfp), sizeof *(ptr))
749
750 #define KEY_IS(str) \
751         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
752
753 /* Wrapper for contiguous page frame allocation */
754 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
755 do {                                                                          \
756         (ptr) = cfs_alloc_page(gfp_mask);                                     \
757         if (unlikely((ptr) == NULL)) {                                        \
758                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
759                        "failed\n", (int)1,                                    \
760                        (__u64)(1 << CFS_PAGE_SHIFT));                         \
761                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
762                        "("LPU64" bytes) allocated by Lustre, "                \
763                        "%d total bytes by LNET\n",                            \
764                        obd_memory_sum(),                                      \
765                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
766                        obd_pages_sum(),                                       \
767                        cfs_atomic_read(&libcfs_kmemory));                     \
768         } else {                                                              \
769                 obd_pages_add(0);                                             \
770                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
771                        LPU64" bytes at %p.\n",                                \
772                        (int)1,                                                \
773                        (__u64)(1 << CFS_PAGE_SHIFT), ptr);                    \
774         }                                                                     \
775 } while (0)
776
777 #define OBD_PAGE_FREE(ptr)                                                    \
778 do {                                                                          \
779         LASSERT(ptr);                                                         \
780         obd_pages_sub(0);                                                     \
781         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
782                "at %p.\n",                                                    \
783                (int)1, (__u64)(1 << CFS_PAGE_SHIFT),                          \
784                ptr);                                                          \
785         cfs_free_page(ptr);                                                   \
786         (ptr) = (void *)0xdeadbeef;                                           \
787 } while (0)
788
789 #endif