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