Whamcloud - gitweb
42430855885be3403fe5ca106ba40510b5185319
[fs/lustre-release.git] / lustre / include / obd_support.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
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 #define OBD_FAIL_MDS_DQACQ_NET           0x187
247
248 #define OBD_FAIL_OST                     0x200
249 #define OBD_FAIL_OST_CONNECT_NET         0x201
250 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
251 #define OBD_FAIL_OST_GET_INFO_NET        0x203
252 #define OBD_FAIL_OST_CREATE_NET          0x204
253 #define OBD_FAIL_OST_DESTROY_NET         0x205
254 #define OBD_FAIL_OST_GETATTR_NET         0x206
255 #define OBD_FAIL_OST_SETATTR_NET         0x207
256 #define OBD_FAIL_OST_OPEN_NET            0x208
257 #define OBD_FAIL_OST_CLOSE_NET           0x209
258 #define OBD_FAIL_OST_BRW_NET             0x20a
259 #define OBD_FAIL_OST_PUNCH_NET           0x20b
260 #define OBD_FAIL_OST_STATFS_NET          0x20c
261 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
262 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
263 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
264 #define OBD_FAIL_OST_SYNC_NET            0x210
265 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
266 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
267 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
268 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
269 #define OBD_FAIL_OST_ENOSPC              0x215
270 #define OBD_FAIL_OST_EROFS               0x216
271 #define OBD_FAIL_OST_ENOENT              0x217
272 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
273 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
274 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
275 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
276 #define OBD_FAIL_OST_BRW_SIZE            0x21c
277 #define OBD_FAIL_OST_DROP_REQ            0x21d
278 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
279 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
280 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
281 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
282 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
283 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
284 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
285 #define OBD_FAIL_OST_CONNECT_NET2        0x225
286 #define OBD_FAIL_OST_NOMEM               0x226
287 #define OBD_FAIL_OST_BRW_PAUSE_BULK2     0x227
288 #define OBD_FAIL_OST_MAPBLK_ENOSPC       0x228
289 #define OBD_FAIL_OST_ENOINO              0x229
290 #define OBD_FAIL_OST_DQACQ_NET           0x230
291
292 #define OBD_FAIL_LDLM                    0x300
293 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
294 #define OBD_FAIL_LDLM_ENQUEUE            0x302
295 #define OBD_FAIL_LDLM_CONVERT            0x303
296 #define OBD_FAIL_LDLM_CANCEL             0x304
297 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
298 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
299 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
300 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
301 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
302 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
303 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
304 #define OBD_FAIL_LDLM_REPLY              0x30c
305 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
306 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
307 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
308 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
309 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
310 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
311 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
312 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
313 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
314 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
315 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
316 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
317 #define OBD_FAIL_LDLM_NEW_LOCK           0x319
318 #define OBD_FAIL_LDLM_AGL_DELAY          0x31a
319 #define OBD_FAIL_LDLM_AGL_NOLOCK         0x31b
320
321 /* LOCKLESS IO */
322 #define OBD_FAIL_LDLM_SET_CONTENTION     0x385
323
324 #define OBD_FAIL_OSC                     0x400
325 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
326 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
327 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
328 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
329 #define OBD_FAIL_OSC_MATCH               0x405
330 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
331 #define OBD_FAIL_OSC_SHUTDOWN            0x407
332 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
333 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
334 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
335 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
336 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
337 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
338 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
339 #define OBD_FAIL_OSC_CP_CANCEL_RACE      0x40f
340 #define OBD_FAIL_OSC_CP_ENQ_RACE         0x410
341 #define OBD_FAIL_OSC_NO_GRANT            0x411
342
343 #define OBD_FAIL_PTLRPC                  0x500
344 #define OBD_FAIL_PTLRPC_ACK              0x501
345 #define OBD_FAIL_PTLRPC_RQBD             0x502
346 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
347 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
348 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
349 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
350 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
351 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
352 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
353 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
354 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
355 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
356 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
357 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
358 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
359 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
360 #define OBD_FAIL_PTLRPC_DROP_REQ_OPC     0x513
361 #define OBD_FAIL_PTLRPC_FINISH_REPLAY    0x514
362 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB2  0x515
363
364 #define OBD_FAIL_OBD_PING_NET            0x600
365 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
366 #define OBD_FAIL_OBD_LOGD_NET            0x602
367 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
368 #define OBD_FAIL_OBD_DQACQ               0x604
369 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
370 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
371
372 #define OBD_FAIL_TGT_REPLY_NET           0x700
373 #define OBD_FAIL_TGT_CONN_RACE           0x701
374 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
375 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
376 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
377 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
378 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
379 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
380 #define OBD_FAIL_TGT_FAKE_EXP            0x708
381 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
382 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
383 #define OBD_FAIL_TGT_CLIENT_ADD          0x711
384 #define OBD_FAIL_TGT_RCVG_FLAG           0x712
385
386 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
387 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
388 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
389 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
390
391 #define OBD_FAIL_MGS                     0x900
392 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
393 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
394 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
395 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
396 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
397
398 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
399 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
400 #define OBD_FAIL_QUOTA_DELAY_SD          0xA04
401
402 #define OBD_FAIL_LPROC_REMOVE            0xB00
403
404 #define OBD_FAIL_GENERAL_ALLOC           0xC00
405
406 #define OBD_FAIL_SEQ                     0x1000
407 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
408
409 #define OBD_FAIL_FLD                     0x1100
410 #define OBD_FAIL_FLD_QUERY_NET           0x1101
411
412 #define OBD_FAIL_SEC_CTX                 0x1200
413 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
414 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
415 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
416 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
417
418 #define OBD_FAIL_LLOG                               0x1300
419 #define OBD_FAIL_LLOG_ORIGIN_CONNECT_NET            0x1301
420 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CREATE_NET      0x1302
421 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_DESTROY_NET     0x1303
422 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_READ_HEADER_NET 0x1304
423 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_NEXT_BLOCK_NET  0x1305
424 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_PREV_BLOCK_NET  0x1306
425 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_WRITE_REC_NET   0x1307
426 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CLOSE_NET       0x1308
427 #define OBD_FAIL_LLOG_CATINFO_NET                   0x1309
428 #define OBD_FAIL_MDS_SYNC_CAPA_SL                   0x1310
429 #define OBD_FAIL_SEQ_ALLOC                          0x1311
430
431 #define OBD_FAIL_LLITE                              0x1400
432 #define OBD_FAIL_LLITE_FAULT_TRUNC_RACE             0x1401
433
434 /* Assign references to moved code to reduce code changes */
435 #define OBD_FAIL_PRECHECK(id)                   CFS_FAIL_PRECHECK(id)
436 #define OBD_FAIL_CHECK(id)                      CFS_FAIL_CHECK(id)
437 #define OBD_FAIL_CHECK_VALUE(id, value)         CFS_FAIL_CHECK_VALUE(id, value)
438 #define OBD_FAIL_CHECK_ORSET(id, value)         CFS_FAIL_CHECK_ORSET(id, value)
439 #define OBD_FAIL_CHECK_RESET(id, value)         CFS_FAIL_CHECK_RESET(id, value)
440 #define OBD_FAIL_RETURN(id, ret)                CFS_FAIL_RETURN(id, ret)
441 #define OBD_FAIL_TIMEOUT(id, secs)              CFS_FAIL_TIMEOUT(id, secs)
442 #define OBD_FAIL_TIMEOUT_MS(id, ms)             CFS_FAIL_TIMEOUT_MS(id, ms)
443 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) CFS_FAIL_TIMEOUT_ORSET(id, value, secs)
444 #define OBD_RACE(id)                            CFS_RACE(id)
445 #define OBD_FAIL_ONCE                           CFS_FAIL_ONCE
446 #define OBD_FAILED                              CFS_FAILED
447
448 extern cfs_atomic_t libcfs_kmemory;
449
450 #ifdef LPROCFS
451 #define obd_memory_add(size)                                                  \
452         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
453 #define obd_memory_sub(size)                                                  \
454         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
455 #define obd_memory_sum()                                                      \
456         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
457                                 LPROCFS_FIELDS_FLAGS_SUM)
458 #define obd_pages_add(order)                                                  \
459         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
460                             (long)(1 << (order)))
461 #define obd_pages_sub(order)                                                  \
462         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
463                             (long)(1 << (order)))
464 #define obd_pages_sum()                                                       \
465         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
466                                 LPROCFS_FIELDS_FLAGS_SUM)
467
468 extern void obd_update_maxusage(void);
469 extern __u64 obd_memory_max(void);
470 extern __u64 obd_pages_max(void);
471
472 #else
473
474 extern __u64 obd_alloc;
475 extern __u64 obd_pages;
476
477 extern __u64 obd_max_alloc;
478 extern __u64 obd_max_pages;
479
480 static inline void obd_memory_add(long size)
481 {
482         obd_alloc += size;
483         if (obd_alloc > obd_max_alloc)
484                 obd_max_alloc = obd_alloc;
485 }
486
487 static inline void obd_memory_sub(long size)
488 {
489         obd_alloc -= size;
490 }
491
492 static inline void obd_pages_add(int order)
493 {
494         obd_pages += 1<< order;
495         if (obd_pages > obd_max_pages)
496                 obd_max_pages = obd_pages;
497 }
498
499 static inline void obd_pages_sub(int order)
500 {
501         obd_pages -= 1<< order;
502 }
503
504 #define obd_memory_sum() (obd_alloc)
505 #define obd_pages_sum()  (obd_pages)
506
507 #define obd_memory_max() (obd_max_alloc)
508 #define obd_pages_max() (obd_max_pages)
509
510 #endif
511
512 #define OBD_DEBUG_MEMUSAGE (1)
513
514 #if OBD_DEBUG_MEMUSAGE
515 #define OBD_ALLOC_POST(ptr, size, name)                                 \
516                 obd_memory_add(size);                                   \
517                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
518                        (int)(size), ptr)
519
520 #define OBD_FREE_PRE(ptr, size, name)                                   \
521         LASSERT(ptr);                                                   \
522         obd_memory_sub(size);                                           \
523         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
524                (int)(size), ptr);                                       \
525         POISON(ptr, 0x5a, size)
526
527 #else /* !OBD_DEBUG_MEMUSAGE */
528
529 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
530 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
531
532 #endif /* !OBD_DEBUG_MEMUSAGE */
533
534 #ifdef RANDOM_FAIL_ALLOC
535 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
536 #else
537 #define HAS_FAIL_ALLOC_FLAG 0
538 #endif
539
540 #define OBD_ALLOC_FAIL_BITS 24
541 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
542 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
543
544 #if defined(LUSTRE_UTILS) /* this version is for utils only */
545 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
546 do {                                                                          \
547         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
548         if (unlikely((ptr) == NULL)) {                                        \
549                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
550                        (int)(size), __FILE__, __LINE__);                      \
551         } else {                                                              \
552                 memset(ptr, 0, size);                                         \
553                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
554                        (int)(size), ptr);                                     \
555         }                                                                     \
556 } while (0)
557 #else /* this version is for the kernel and liblustre */
558 #define OBD_FREE_RTN0(ptr)                                                    \
559 ({                                                                            \
560         cfs_free(ptr);                                                        \
561         (ptr) = NULL;                                                         \
562         0;                                                                    \
563 })
564 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
565 do {                                                                          \
566         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
567         if (likely((ptr) != NULL &&                                           \
568                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
569                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
570                                     __FILE__, __LINE__) ||                    \
571                     OBD_FREE_RTN0(ptr)))){                                    \
572                 memset(ptr, 0, size);                                         \
573                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
574         }                                                                     \
575 } while (0)
576 #endif
577
578 #ifndef OBD_ALLOC_MASK
579 # define OBD_ALLOC_MASK CFS_ALLOC_IO
580 #endif
581
582 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
583 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
584 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
585 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
586
587 #ifdef __arch_um__
588 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
589 #else
590 # define OBD_VMALLOC(ptr, size)                                               \
591 do {                                                                          \
592         (ptr) = cfs_alloc_large(size);                                        \
593         if (unlikely((ptr) == NULL)) {                                        \
594                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
595                        (int)(size));                                          \
596                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
597                        obd_memory_sum(), cfs_atomic_read(&libcfs_kmemory));   \
598         } else {                                                              \
599                 memset(ptr, 0, size);                                         \
600                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
601         }                                                                     \
602 } while(0)
603 #endif
604
605 #ifdef __KERNEL__
606
607 /* Allocations above this size are considered too big and could not be done
608  * atomically. 
609  *
610  * Be very careful when changing this value, especially when decreasing it,
611  * since vmalloc in Linux doesn't perform well on multi-cores system, calling 
612  * vmalloc in critical path would hurt peformance badly. See LU-66.
613  */
614 #define OBD_ALLOC_BIG (4 * CFS_PAGE_SIZE)
615
616 #define OBD_ALLOC_LARGE(ptr, size)                                            \
617 do {                                                                          \
618         if (size > OBD_ALLOC_BIG)                                             \
619                 OBD_VMALLOC(ptr, size);                                       \
620         else                                                                  \
621                 OBD_ALLOC(ptr, size);                                         \
622 } while (0)
623
624 #define OBD_FREE_LARGE(ptr, size)                                             \
625 do {                                                                          \
626         if (size > OBD_ALLOC_BIG)                                             \
627                 OBD_VFREE(ptr, size);                                         \
628         else                                                                  \
629                 OBD_FREE(ptr, size);                                          \
630 } while (0)
631 #else
632 #define OBD_ALLOC_LARGE(ptr, size) OBD_ALLOC(ptr, size)
633 #define OBD_FREE_LARGE(ptr, size) OBD_FREE(ptr,size)
634 #endif
635
636 #ifdef CONFIG_DEBUG_SLAB
637 #define POISON(ptr, c, s) do {} while (0)
638 #define POISON_PTR(ptr)  ((void)0)
639 #else
640 #define POISON(ptr, c, s) memset(ptr, c, s)
641 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
642 #endif
643
644 #ifdef POISON_BULK
645 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
646                                     kunmap(page); } while (0)
647 #else
648 #define POISON_PAGE(page, val) do { } while (0)
649 #endif
650
651 #ifdef __KERNEL__
652 #define OBD_FREE(ptr, size)                                                   \
653 do {                                                                          \
654         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
655         cfs_free(ptr);                                                        \
656         POISON_PTR(ptr);                                                      \
657 } while(0)
658
659
660 #ifdef HAVE_RCU
661 # ifdef HAVE_CALL_RCU_PARAM
662 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
663 # else
664 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
665 # endif
666 #else
667 # define my_call_rcu(rcu, cb)             (cb)(rcu)
668 #endif
669
670 #define OBD_FREE_RCU(ptr, size, handle)                                       \
671 do {                                                                          \
672         struct portals_handle *__h = (handle);                                \
673                                                                               \
674         LASSERT(handle != NULL);                                              \
675         __h->h_cookie = (unsigned long)(ptr);                                 \
676         __h->h_size = (size);                                                 \
677         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
678         POISON_PTR(ptr);                                                      \
679 } while(0)
680
681 #else
682 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
683 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
684 #endif /* ifdef __KERNEL__ */
685
686 #ifdef __arch_um__
687 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
688 #else
689 # define OBD_VFREE(ptr, size)                                                 \
690 do {                                                                          \
691         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
692         cfs_free_large(ptr);                                                  \
693         POISON_PTR(ptr);                                                      \
694 } while(0)
695 #endif
696
697 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
698  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
699  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
700 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
701 ({                                                                            \
702         cfs_mem_cache_free((slab), (ptr));                                    \
703         (ptr) = NULL;                                                         \
704         0;                                                                    \
705 })
706 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
707 do {                                                                          \
708         LASSERT(ergo(type != CFS_ALLOC_ATOMIC, !cfs_in_interrupt()));         \
709         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
710         if (likely((ptr) != NULL &&                                           \
711                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
712                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
713                                     __FILE__, __LINE__) ||                    \
714                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
715                 memset(ptr, 0, size);                                         \
716                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
717         }                                                                     \
718 } while(0)
719
720 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
721
722 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
723 do {                                                                          \
724         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
725         cfs_mem_cache_free(slab, ptr);                                        \
726         POISON_PTR(ptr);                                                      \
727 } while(0)
728
729 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
730         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
731 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
732         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
733 #define OBD_SLAB_ALLOC_PTR_GFP(ptr, slab, gfp)                              \
734         OBD_SLAB_ALLOC((ptr), (slab), (gfp), sizeof *(ptr))
735
736 #define KEY_IS(str) \
737         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
738
739 /* Wrapper for contiguous page frame allocation */
740 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
741 do {                                                                          \
742         (ptr) = cfs_alloc_page(gfp_mask);                                     \
743         if (unlikely((ptr) == NULL)) {                                        \
744                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
745                        "failed\n", (int)1,                                    \
746                        (__u64)(1 << CFS_PAGE_SHIFT));                         \
747                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
748                        "("LPU64" bytes) allocated by Lustre, "                \
749                        "%d total bytes by LNET\n",                            \
750                        obd_memory_sum(),                                      \
751                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
752                        obd_pages_sum(),                                       \
753                        cfs_atomic_read(&libcfs_kmemory));                     \
754         } else {                                                              \
755                 obd_pages_add(0);                                             \
756                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
757                        LPU64" bytes at %p.\n",                                \
758                        (int)1,                                                \
759                        (__u64)(1 << CFS_PAGE_SHIFT), ptr);                    \
760         }                                                                     \
761 } while (0)
762
763 #define OBD_PAGE_FREE(ptr)                                                    \
764 do {                                                                          \
765         LASSERT(ptr);                                                         \
766         obd_pages_sub(0);                                                     \
767         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
768                "at %p.\n",                                                    \
769                (int)1, (__u64)(1 << CFS_PAGE_SHIFT),                          \
770                ptr);                                                          \
771         cfs_free_page(ptr);                                                   \
772         (ptr) = (void *)0xdeadbeef;                                           \
773 } while (0)
774
775 #endif