Whamcloud - gitweb
665dc897b461ab4924e72bf828605ebf4df3996e
[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
293 #define OBD_FAIL_LDLM                    0x300
294 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
295 #define OBD_FAIL_LDLM_ENQUEUE            0x302
296 #define OBD_FAIL_LDLM_CONVERT            0x303
297 #define OBD_FAIL_LDLM_CANCEL             0x304
298 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
299 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
300 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
301 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
302 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
303 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
304 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
305 #define OBD_FAIL_LDLM_REPLY              0x30c
306 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
307 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
308 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
309 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
310 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
311 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
312 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
313 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
314 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
315 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
316 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
317 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
318 #define OBD_FAIL_LDLM_NEW_LOCK           0x319
319 #define OBD_FAIL_LDLM_AGL_DELAY          0x31a
320 #define OBD_FAIL_LDLM_AGL_NOLOCK         0x31b
321
322 /* LOCKLESS IO */
323 #define OBD_FAIL_LDLM_SET_CONTENTION     0x385
324
325 #define OBD_FAIL_OSC                     0x400
326 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
327 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
328 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
329 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
330 #define OBD_FAIL_OSC_MATCH               0x405
331 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
332 #define OBD_FAIL_OSC_SHUTDOWN            0x407
333 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
334 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
335 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
336 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
337 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
338 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
339 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
340 #define OBD_FAIL_OSC_CP_CANCEL_RACE      0x40f
341 #define OBD_FAIL_OSC_CP_ENQ_RACE         0x410
342 #define OBD_FAIL_OSC_NO_GRANT            0x411
343 #define OBD_FAIL_OSC_DELAY_SETTIME       0x412
344
345 #define OBD_FAIL_PTLRPC                  0x500
346 #define OBD_FAIL_PTLRPC_ACK              0x501
347 #define OBD_FAIL_PTLRPC_RQBD             0x502
348 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
349 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
350 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
351 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
352 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
353 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
354 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
355 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
356 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
357 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
358 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
359 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
360 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
361 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
362 #define OBD_FAIL_PTLRPC_DROP_REQ_OPC     0x513
363 #define OBD_FAIL_PTLRPC_FINISH_REPLAY    0x514
364 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB2  0x515
365
366 #define OBD_FAIL_OBD_PING_NET            0x600
367 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
368 #define OBD_FAIL_OBD_LOGD_NET            0x602
369 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
370 #define OBD_FAIL_OBD_DQACQ               0x604
371 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
372 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
373
374 #define OBD_FAIL_TGT_REPLY_NET           0x700
375 #define OBD_FAIL_TGT_CONN_RACE           0x701
376 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
377 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
378 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
379 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
380 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
381 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
382 #define OBD_FAIL_TGT_FAKE_EXP            0x708
383 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
384 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
385 #define OBD_FAIL_TGT_CLIENT_ADD          0x711
386 #define OBD_FAIL_TGT_RCVG_FLAG           0x712
387
388 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
389 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
390 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
391 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
392 #define OBD_FAIL_MDC_RPCS_SEM            0x804
393
394 #define OBD_FAIL_MGS                     0x900
395 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
396 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
397 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
398 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
399 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
400
401 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
402 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
403 #define OBD_FAIL_QUOTA_DELAY_SD          0xA04
404
405 #define OBD_FAIL_LPROC_REMOVE            0xB00
406
407 #define OBD_FAIL_GENERAL_ALLOC           0xC00
408
409 #define OBD_FAIL_SEQ                     0x1000
410 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
411
412 #define OBD_FAIL_FLD                     0x1100
413 #define OBD_FAIL_FLD_QUERY_NET           0x1101
414
415 #define OBD_FAIL_SEC_CTX                 0x1200
416 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
417 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
418 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
419 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
420
421 #define OBD_FAIL_LLOG                               0x1300
422 #define OBD_FAIL_LLOG_ORIGIN_CONNECT_NET            0x1301
423 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CREATE_NET      0x1302
424 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_DESTROY_NET     0x1303
425 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_READ_HEADER_NET 0x1304
426 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_NEXT_BLOCK_NET  0x1305
427 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_PREV_BLOCK_NET  0x1306
428 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_WRITE_REC_NET   0x1307
429 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CLOSE_NET       0x1308
430 #define OBD_FAIL_LLOG_CATINFO_NET                   0x1309
431 #define OBD_FAIL_MDS_SYNC_CAPA_SL                   0x1310
432 #define OBD_FAIL_SEQ_ALLOC                          0x1311
433
434 #define OBD_FAIL_LLITE                              0x1400
435 #define OBD_FAIL_LLITE_FAULT_TRUNC_RACE             0x1401
436 #define OBD_FAIL_LOCK_STATE_WAIT_INTR               0x1402
437
438 /* Assign references to moved code to reduce code changes */
439 #define OBD_FAIL_PRECHECK(id)                   CFS_FAIL_PRECHECK(id)
440 #define OBD_FAIL_CHECK(id)                      CFS_FAIL_CHECK(id)
441 #define OBD_FAIL_CHECK_VALUE(id, value)         CFS_FAIL_CHECK_VALUE(id, value)
442 #define OBD_FAIL_CHECK_ORSET(id, value)         CFS_FAIL_CHECK_ORSET(id, value)
443 #define OBD_FAIL_CHECK_RESET(id, value)         CFS_FAIL_CHECK_RESET(id, value)
444 #define OBD_FAIL_RETURN(id, ret)                CFS_FAIL_RETURN(id, ret)
445 #define OBD_FAIL_TIMEOUT(id, secs)              CFS_FAIL_TIMEOUT(id, secs)
446 #define OBD_FAIL_TIMEOUT_MS(id, ms)             CFS_FAIL_TIMEOUT_MS(id, ms)
447 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) CFS_FAIL_TIMEOUT_ORSET(id, value, secs)
448 #define OBD_RACE(id)                            CFS_RACE(id)
449 #define OBD_FAIL_ONCE                           CFS_FAIL_ONCE
450 #define OBD_FAILED                              CFS_FAILED
451
452 extern cfs_atomic_t libcfs_kmemory;
453
454 #ifdef LPROCFS
455 #define obd_memory_add(size)                                                  \
456         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
457 #define obd_memory_sub(size)                                                  \
458         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
459 #define obd_memory_sum()                                                      \
460         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
461                                 LPROCFS_FIELDS_FLAGS_SUM)
462 #define obd_pages_add(order)                                                  \
463         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
464                             (long)(1 << (order)))
465 #define obd_pages_sub(order)                                                  \
466         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
467                             (long)(1 << (order)))
468 #define obd_pages_sum()                                                       \
469         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
470                                 LPROCFS_FIELDS_FLAGS_SUM)
471
472 extern void obd_update_maxusage(void);
473 extern __u64 obd_memory_max(void);
474 extern __u64 obd_pages_max(void);
475
476 #else
477
478 extern __u64 obd_alloc;
479 extern __u64 obd_pages;
480
481 extern __u64 obd_max_alloc;
482 extern __u64 obd_max_pages;
483
484 static inline void obd_memory_add(long size)
485 {
486         obd_alloc += size;
487         if (obd_alloc > obd_max_alloc)
488                 obd_max_alloc = obd_alloc;
489 }
490
491 static inline void obd_memory_sub(long size)
492 {
493         obd_alloc -= size;
494 }
495
496 static inline void obd_pages_add(int order)
497 {
498         obd_pages += 1<< order;
499         if (obd_pages > obd_max_pages)
500                 obd_max_pages = obd_pages;
501 }
502
503 static inline void obd_pages_sub(int order)
504 {
505         obd_pages -= 1<< order;
506 }
507
508 #define obd_memory_sum() (obd_alloc)
509 #define obd_pages_sum()  (obd_pages)
510
511 #define obd_memory_max() (obd_max_alloc)
512 #define obd_pages_max() (obd_max_pages)
513
514 #endif
515
516 #define OBD_DEBUG_MEMUSAGE (1)
517
518 #if OBD_DEBUG_MEMUSAGE
519 #define OBD_ALLOC_POST(ptr, size, name)                                 \
520                 obd_memory_add(size);                                   \
521                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
522                        (int)(size), ptr)
523
524 #define OBD_FREE_PRE(ptr, size, name)                                   \
525         LASSERT(ptr);                                                   \
526         obd_memory_sub(size);                                           \
527         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
528                (int)(size), ptr);                                       \
529         POISON(ptr, 0x5a, size)
530
531 #else /* !OBD_DEBUG_MEMUSAGE */
532
533 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
534 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
535
536 #endif /* !OBD_DEBUG_MEMUSAGE */
537
538 #ifdef RANDOM_FAIL_ALLOC
539 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
540 #else
541 #define HAS_FAIL_ALLOC_FLAG 0
542 #endif
543
544 #define OBD_ALLOC_FAIL_BITS 24
545 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
546 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
547
548 #if defined(LUSTRE_UTILS) /* this version is for utils only */
549 #define __OBD_MALLOC_VERBOSE(ptr, cptab, cpt, size, flags)                    \
550 do {                                                                          \
551         (ptr) = (cptab) == NULL ?                                             \
552                 cfs_alloc(size, flags) :                                      \
553                 cfs_cpt_malloc(cptab, cpt, size, flags);                      \
554         if (unlikely((ptr) == NULL)) {                                        \
555                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
556                        (int)(size), __FILE__, __LINE__);                      \
557         } else {                                                              \
558                 memset(ptr, 0, size);                                         \
559                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
560                        (int)(size), ptr);                                     \
561         }                                                                     \
562 } while (0)
563
564 #else /* this version is for the kernel and liblustre */
565 #define OBD_FREE_RTN0(ptr)                                                    \
566 ({                                                                            \
567         cfs_free(ptr);                                                        \
568         (ptr) = NULL;                                                         \
569         0;                                                                    \
570 })
571
572 #define __OBD_MALLOC_VERBOSE(ptr, cptab, cpt, size, flags)                    \
573 do {                                                                          \
574         (ptr) = (cptab) == NULL ?                                             \
575                 cfs_alloc(size, flags) :                                      \
576                 cfs_cpt_malloc(cptab, cpt, size, flags);                      \
577         if (likely((ptr) != NULL &&                                           \
578                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
579                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
580                                     __FILE__, __LINE__) ||                    \
581                     OBD_FREE_RTN0(ptr)))){                                    \
582                 memset(ptr, 0, size);                                         \
583                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
584         }                                                                     \
585 } while (0)
586 #endif
587
588 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
589         __OBD_MALLOC_VERBOSE(ptr, NULL, 0, size, gfp_mask)
590
591 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_IO)
592 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
593 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
594 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
595
596 #define OBD_CPT_ALLOC_GFP(ptr, cptab, cpt, size, gfp_mask)                    \
597         __OBD_MALLOC_VERBOSE(ptr, cptab, cpt, size, gfp_mask)
598
599 #define OBD_CPT_ALLOC(ptr, cptab, cpt, size)                                  \
600         OBD_CPT_ALLOC_GFP(ptr, cptab, cpt, size, CFS_ALLOC_IO)
601
602 #define OBD_CPT_ALLOC_PTR(ptr, cptab, cpt)                                    \
603         OBD_CPT_ALLOC(ptr, cptab, cpt, sizeof *(ptr))
604
605 #ifdef __arch_um__
606
607 # define OBD_VMALLOC(ptr, size)                                               \
608          OBD_ALLOC(ptr, size)
609 # define OBD_CPT_VMALLOC(ptr, cptab, cpt, size)                               \
610          OBD_CPT_ALLOC(ptr, cptab, cpt, size)
611
612 #else /* !__arch_um__ */
613
614 # define __OBD_VMALLOC_VEROBSE(ptr, cptab, cpt, size)                         \
615 do {                                                                          \
616         (ptr) = cptab == NULL ?                                               \
617                 cfs_alloc_large(size) :                                       \
618                 cfs_cpt_vmalloc(cptab, cpt, size);                            \
619         if (unlikely((ptr) == NULL)) {                                        \
620                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
621                        (int)(size));                                          \
622                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
623                        obd_memory_sum(), cfs_atomic_read(&libcfs_kmemory));   \
624         } else {                                                              \
625                 memset(ptr, 0, size);                                         \
626                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
627         }                                                                     \
628 } while(0)
629
630 # define OBD_VMALLOC(ptr, size)                                               \
631          __OBD_VMALLOC_VEROBSE(ptr, NULL, 0, size)
632 # define OBD_CPT_VMALLOC(ptr, cptab, cpt, size)                               \
633          __OBD_VMALLOC_VEROBSE(ptr, cptab, cpt, size)
634
635 #endif
636
637 #ifdef __KERNEL__
638
639 /* Allocations above this size are considered too big and could not be done
640  * atomically.
641  *
642  * Be very careful when changing this value, especially when decreasing it,
643  * since vmalloc in Linux doesn't perform well on multi-cores system, calling
644  * vmalloc in critical path would hurt peformance badly. See LU-66.
645  */
646 #define OBD_ALLOC_BIG (4 * CFS_PAGE_SIZE)
647
648 #define OBD_ALLOC_LARGE(ptr, size)                                            \
649 do {                                                                          \
650         if (size > OBD_ALLOC_BIG)                                             \
651                 OBD_VMALLOC(ptr, size);                                       \
652         else                                                                  \
653                 OBD_ALLOC(ptr, size);                                         \
654 } while (0)
655
656 #define OBD_CPT_ALLOC_LARGE(ptr, cptab, cpt, size)                            \
657 do {                                                                          \
658         if (size > OBD_ALLOC_BIG)                                             \
659                 OBD_CPT_VMALLOC(ptr, cptab, cpt, size);                       \
660         else                                                                  \
661                 OBD_CPT_ALLOC(ptr, cptab, cpt, size);                         \
662 } while (0)
663
664 #define OBD_FREE_LARGE(ptr, size)                                             \
665 do {                                                                          \
666         if (size > OBD_ALLOC_BIG)                                             \
667                 OBD_VFREE(ptr, size);                                         \
668         else                                                                  \
669                 OBD_FREE(ptr, size);                                          \
670 } while (0)
671
672 #else /* !__KERNEL__ */
673
674 #define OBD_ALLOC_LARGE(ptr, size)                                            \
675         OBD_ALLOC(ptr, size)
676 #define OBD_CPT_ALLOC_LARGE(ptr, cptab, cpt, size)                            \
677         OBD_ALLOC(ptr, size)
678 #define OBD_FREE_LARGE(ptr, size)                                             \
679         OBD_FREE(ptr, size)
680
681 #endif /* __KERNEL__ */
682
683 #ifdef CONFIG_DEBUG_SLAB
684 #define POISON(ptr, c, s) do {} while (0)
685 #define POISON_PTR(ptr)  ((void)0)
686 #else
687 #define POISON(ptr, c, s) memset(ptr, c, s)
688 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
689 #endif
690
691 #ifdef POISON_BULK
692 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
693                                     kunmap(page); } while (0)
694 #else
695 #define POISON_PAGE(page, val) do { } while (0)
696 #endif
697
698 #ifdef __KERNEL__
699 #define OBD_FREE(ptr, size)                                                   \
700 do {                                                                          \
701         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
702         cfs_free(ptr);                                                        \
703         POISON_PTR(ptr);                                                      \
704 } while(0)
705
706
707 #define OBD_FREE_RCU(ptr, size, handle)                                       \
708 do {                                                                          \
709         struct portals_handle *__h = (handle);                                \
710                                                                               \
711         LASSERT(handle != NULL);                                              \
712         __h->h_cookie = (unsigned long)(ptr);                                 \
713         __h->h_size = (size);                                                 \
714         call_rcu(&__h->h_rcu, class_handle_free_cb);                          \
715         POISON_PTR(ptr);                                                      \
716 } while(0)
717
718 #else
719 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
720 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
721 #endif /* ifdef __KERNEL__ */
722
723 #ifdef __arch_um__
724 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
725 #else
726 # define OBD_VFREE(ptr, size)                                                 \
727 do {                                                                          \
728         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
729         cfs_free_large(ptr);                                                  \
730         POISON_PTR(ptr);                                                      \
731 } while(0)
732 #endif
733
734 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
735  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
736  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
737 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
738 ({                                                                            \
739         cfs_mem_cache_free((slab), (ptr));                                    \
740         (ptr) = NULL;                                                         \
741         0;                                                                    \
742 })
743
744 #define __OBD_SLAB_ALLOC_VERBOSE(ptr, slab, cptab, cpt, size, type)           \
745 do {                                                                          \
746         LASSERT(ergo(type != CFS_ALLOC_ATOMIC, !cfs_in_interrupt()));         \
747         (ptr) = (cptab) == NULL ?                                             \
748                 cfs_mem_cache_alloc(slab, type) :                             \
749                 cfs_mem_cache_cpt_alloc(slab, cptab, cpt, type);              \
750         if (likely((ptr) != NULL &&                                           \
751                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
752                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
753                                     __FILE__, __LINE__) ||                    \
754                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
755                 memset(ptr, 0, size);                                         \
756                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
757         }                                                                     \
758 } while(0)
759
760 #define OBD_SLAB_ALLOC_GFP(ptr, slab, size, flags)                            \
761         __OBD_SLAB_ALLOC_VERBOSE(ptr, slab, NULL, 0, size, flags)
762 #define OBD_SLAB_CPT_ALLOC_GFP(ptr, slab, cptab, cpt, size, flags)            \
763         __OBD_SLAB_ALLOC_VERBOSE(ptr, slab, cptab, cpt, size, flags)
764
765 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
766
767 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
768 do {                                                                          \
769         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
770         cfs_mem_cache_free(slab, ptr);                                        \
771         POISON_PTR(ptr);                                                      \
772 } while(0)
773
774 #define OBD_SLAB_ALLOC(ptr, slab, size)                                       \
775         OBD_SLAB_ALLOC_GFP(ptr, slab, size, CFS_ALLOC_IO)
776
777 #define OBD_SLAB_CPT_ALLOC(ptr, slab, cptab, cpt, size)                       \
778         OBD_SLAB_CPT_ALLOC_GFP(ptr, slab, cptab, cpt, size, CFS_ALLOC_IO)
779
780 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
781         OBD_SLAB_ALLOC(ptr, slab, sizeof *(ptr))
782
783 #define OBD_SLAB_CPT_ALLOC_PTR(ptr, slab, cptab, cpt)                         \
784         OBD_SLAB_CPT_ALLOC(ptr, slab, cptab, cpt, sizeof *(ptr))
785
786 #define OBD_SLAB_ALLOC_PTR_GFP(ptr, slab, flags)                              \
787         OBD_SLAB_ALLOC_GFP(ptr, slab, sizeof *(ptr), flags)
788
789 #define OBD_SLAB_CPT_ALLOC_PTR_GFP(ptr, slab, ctab, cpt, flags)               \
790         OBD_SLAB_CPT_ALLOC_GFP(ptr, slab, cptab, cpt, sizeof *(ptr), flags)
791
792 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
793         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
794
795 #define KEY_IS(str) \
796         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
797
798 /* Wrapper for contiguous page frame allocation */
799 #define __OBD_PAGE_ALLOC_VERBOSE(ptr, cptab, cpt, gfp_mask)                   \
800 do {                                                                          \
801         (ptr) = (cptab) == NULL ?                                             \
802                 cfs_alloc_page(gfp_mask) :                                    \
803                 cfs_page_cpt_alloc(cptab, cpt, gfp_mask);                     \
804         if (unlikely((ptr) == NULL)) {                                        \
805                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
806                        "failed\n", (int)1,                                    \
807                        (__u64)(1 << CFS_PAGE_SHIFT));                         \
808                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
809                        "("LPU64" bytes) allocated by Lustre, "                \
810                        "%d total bytes by LNET\n",                            \
811                        obd_memory_sum(),                                      \
812                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
813                        obd_pages_sum(),                                       \
814                        cfs_atomic_read(&libcfs_kmemory));                     \
815         } else {                                                              \
816                 obd_pages_add(0);                                             \
817                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
818                        LPU64" bytes at %p.\n",                                \
819                        (int)1,                                                \
820                        (__u64)(1 << CFS_PAGE_SHIFT), ptr);                    \
821         }                                                                     \
822 } while (0)
823
824 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
825         __OBD_PAGE_ALLOC_VERBOSE(ptr, NULL, 0, gfp_mask)
826 #define OBD_PAGE_CPT_ALLOC(ptr, cptab, cpt, gfp_mask)                         \
827         __OBD_PAGE_ALLOC_VERBOSE(ptr, cptab, cpt, gfp_mask)
828
829 #define OBD_PAGE_FREE(ptr)                                                    \
830 do {                                                                          \
831         LASSERT(ptr);                                                         \
832         obd_pages_sub(0);                                                     \
833         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
834                "at %p.\n",                                                    \
835                (int)1, (__u64)(1 << CFS_PAGE_SHIFT),                          \
836                ptr);                                                          \
837         cfs_free_page(ptr);                                                   \
838         (ptr) = (void *)0xdeadbeef;                                           \
839 } while (0)
840
841 #endif