1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <libcfs/libcfs.h>
28 #include <lprocfs_status.h>
30 #if defined(__linux__)
31 #include <linux/obd_support.h>
32 #elif defined(__APPLE__)
33 #include <darwin/obd_support.h>
34 #elif defined(__WINNT__)
35 #include <winnt/obd_support.h>
37 #error Unsupported operating system.
40 /* global variables */
41 extern struct lprocfs_stats *obd_memory;
44 OBD_MEMORY_PAGES_STAT = 1,
49 OBD_FAIL_LOC_NOSET = 0,
50 OBD_FAIL_LOC_ORSET = 1,
51 OBD_FAIL_LOC_RESET = 2
54 extern unsigned long obd_fail_loc;
55 extern unsigned int obd_fail_val;
56 extern unsigned int obd_debug_peer_on_timeout;
57 extern unsigned int obd_dump_on_timeout;
58 extern unsigned int obd_dump_on_eviction;
59 extern unsigned int obd_timeout; /* seconds */
60 #define PING_INTERVAL max(obd_timeout / 4, 1U)
61 #define RECONNECT_INTERVAL max(obd_timeout / 10, 10U)
62 extern unsigned int ldlm_timeout;
63 extern unsigned int obd_health_check_timeout;
64 extern unsigned int obd_sync_filter;
65 extern unsigned int obd_max_dirty_pages;
66 extern atomic_t obd_dirty_pages;
67 extern cfs_waitq_t obd_race_waitq;
68 extern int obd_race_state;
69 extern unsigned int obd_alloc_fail_rate;
71 int __obd_fail_check_set(__u32 id, __u32 value, int set);
74 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
75 size_t size, const char *file, int line);
77 /* Timeout definitions */
78 #define LDLM_TIMEOUT_DEFAULT 20
79 #define OBD_TIMEOUT_DEFAULT 100
80 #define HEALTH_CHECK_COEF 3 / 2
81 #define HEALTH_CHECK_TIMEOUT_DEFAULT (OBD_TIMEOUT_DEFAULT * HEALTH_CHECK_COEF)
82 #define HEALTH_CHECK_TIMEOUT (obd_timeout * HEALTH_CHECK_COEF)
84 #define OBD_FAIL_MDS 0x100
85 #define OBD_FAIL_MDS_HANDLE_UNPACK 0x101
86 #define OBD_FAIL_MDS_GETATTR_NET 0x102
87 #define OBD_FAIL_MDS_GETATTR_PACK 0x103
88 #define OBD_FAIL_MDS_READPAGE_NET 0x104
89 #define OBD_FAIL_MDS_READPAGE_PACK 0x105
90 #define OBD_FAIL_MDS_SENDPAGE 0x106
91 #define OBD_FAIL_MDS_REINT_NET 0x107
92 #define OBD_FAIL_MDS_REINT_UNPACK 0x108
93 #define OBD_FAIL_MDS_REINT_SETATTR 0x109
94 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
95 #define OBD_FAIL_MDS_REINT_CREATE 0x10b
96 #define OBD_FAIL_MDS_REINT_CREATE_WRITE 0x10c
97 #define OBD_FAIL_MDS_REINT_UNLINK 0x10d
98 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE 0x10e
99 #define OBD_FAIL_MDS_REINT_LINK 0x10f
100 #define OBD_FAIL_MDS_REINT_LINK_WRITE 0x110
101 #define OBD_FAIL_MDS_REINT_RENAME 0x111
102 #define OBD_FAIL_MDS_REINT_RENAME_WRITE 0x112
103 #define OBD_FAIL_MDS_OPEN_NET 0x113
104 #define OBD_FAIL_MDS_OPEN_PACK 0x114
105 #define OBD_FAIL_MDS_CLOSE_NET 0x115
106 #define OBD_FAIL_MDS_CLOSE_PACK 0x116
107 #define OBD_FAIL_MDS_CONNECT_NET 0x117
108 #define OBD_FAIL_MDS_CONNECT_PACK 0x118
109 #define OBD_FAIL_MDS_REINT_NET_REP 0x119
110 #define OBD_FAIL_MDS_DISCONNECT_NET 0x11a
111 #define OBD_FAIL_MDS_GETSTATUS_NET 0x11b
112 #define OBD_FAIL_MDS_GETSTATUS_PACK 0x11c
113 #define OBD_FAIL_MDS_STATFS_PACK 0x11d
114 #define OBD_FAIL_MDS_STATFS_NET 0x11e
115 #define OBD_FAIL_MDS_GETATTR_NAME_NET 0x11f
116 #define OBD_FAIL_MDS_PIN_NET 0x120
117 #define OBD_FAIL_MDS_UNPIN_NET 0x121
118 #define OBD_FAIL_MDS_ALL_REPLY_NET 0x122
119 #define OBD_FAIL_MDS_ALL_REQUEST_NET 0x123
120 #define OBD_FAIL_MDS_SYNC_NET 0x124
121 #define OBD_FAIL_MDS_SYNC_PACK 0x125
122 #define OBD_FAIL_MDS_DONE_WRITING_NET 0x126
123 #define OBD_FAIL_MDS_DONE_WRITING_PACK 0x127
124 #define OBD_FAIL_MDS_ALLOC_OBDO 0x128
125 #define OBD_FAIL_MDS_PAUSE_OPEN 0x129
126 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP 0x12a
127 #define OBD_FAIL_MDS_OPEN_CREATE 0x12b
128 #define OBD_FAIL_MDS_OST_SETATTR 0x12c
129 #define OBD_FAIL_MDS_QUOTACHECK_NET 0x12d
130 #define OBD_FAIL_MDS_QUOTACTL_NET 0x12e
131 #define OBD_FAIL_MDS_CLIENT_ADD 0x12f
132 #define OBD_FAIL_MDS_GETXATTR_NET 0x130
133 #define OBD_FAIL_MDS_GETXATTR_PACK 0x131
134 #define OBD_FAIL_MDS_SETXATTR_NET 0x132
135 #define OBD_FAIL_MDS_SETXATTR 0x133
136 #define OBD_FAIL_MDS_SETXATTR_WRITE 0x134
137 #define OBD_FAIL_MDS_FS_SETUP 0x135
138 #define OBD_FAIL_MDS_RESEND 0x136
139 #define OBD_FAIL_MDS_IS_SUBDIR_NET 0x137
140 #define OBD_FAIL_MDS_IS_SUBDIR_PACK 0x138
141 #define OBD_FAIL_MDS_SET_INFO_NET 0x139
142 #define OBD_FAIL_MDS_WRITEPAGE_NET 0x13a
143 #define OBD_FAIL_MDS_WRITEPAGE_PACK 0x13b
144 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED 0x13c
145 #define OBD_FAIL_MDS_OSC_PRECREATE 0x13d
146 #define OBD_FAIL_MDS_LOV_SYNC_RACE 0x13e
147 #define OBD_FAIL_MDS_CLOSE_NET_REP 0x13f
148 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT 0x140
150 #define OBD_FAIL_OST 0x200
151 #define OBD_FAIL_OST_CONNECT_NET 0x201
152 #define OBD_FAIL_OST_DISCONNECT_NET 0x202
153 #define OBD_FAIL_OST_GET_INFO_NET 0x203
154 #define OBD_FAIL_OST_CREATE_NET 0x204
155 #define OBD_FAIL_OST_DESTROY_NET 0x205
156 #define OBD_FAIL_OST_GETATTR_NET 0x206
157 #define OBD_FAIL_OST_SETATTR_NET 0x207
158 #define OBD_FAIL_OST_OPEN_NET 0x208
159 #define OBD_FAIL_OST_CLOSE_NET 0x209
160 #define OBD_FAIL_OST_BRW_NET 0x20a
161 #define OBD_FAIL_OST_PUNCH_NET 0x20b
162 #define OBD_FAIL_OST_STATFS_NET 0x20c
163 #define OBD_FAIL_OST_HANDLE_UNPACK 0x20d
164 #define OBD_FAIL_OST_BRW_WRITE_BULK 0x20e
165 #define OBD_FAIL_OST_BRW_READ_BULK 0x20f
166 #define OBD_FAIL_OST_SYNC_NET 0x210
167 #define OBD_FAIL_OST_ALL_REPLY_NET 0x211
168 #define OBD_FAIL_OST_ALL_REQUESTS_NET 0x212
169 #define OBD_FAIL_OST_LDLM_REPLY_NET 0x213
170 #define OBD_FAIL_OST_BRW_PAUSE_BULK 0x214
171 #define OBD_FAIL_OST_ENOSPC 0x215
172 #define OBD_FAIL_OST_EROFS 0x216
173 #define OBD_FAIL_OST_ENOENT 0x217
174 #define OBD_FAIL_OST_QUOTACHECK_NET 0x218
175 #define OBD_FAIL_OST_QUOTACTL_NET 0x219
176 #define OBD_FAIL_OST_CHECKSUM_RECEIVE 0x21a
177 #define OBD_FAIL_OST_CHECKSUM_SEND 0x21b
178 #define OBD_FAIL_OST_BRW_SIZE 0x21c
179 #define OBD_FAIL_OST_DROP_REQ 0x21d
180 #define OBD_FAIL_OST_SETATTR_CREDITS 0x21e
181 #define OBD_FAIL_OST_HOLD_WRITE_RPC 0x21f
182 #define OBD_FAIL_OST_BRW_WRITE_BULK2 0x220
183 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
184 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
185 #define OBD_FAIL_OST_CONNECT_NET2 0x225
187 #define OBD_FAIL_LDLM 0x300
188 #define OBD_FAIL_LDLM_NAMESPACE_NEW 0x301
189 #define OBD_FAIL_LDLM_ENQUEUE 0x302
190 #define OBD_FAIL_LDLM_CONVERT 0x303
191 #define OBD_FAIL_LDLM_CANCEL 0x304
192 #define OBD_FAIL_LDLM_BL_CALLBACK 0x305
193 #define OBD_FAIL_LDLM_CP_CALLBACK 0x306
194 #define OBD_FAIL_LDLM_GL_CALLBACK 0x307
195 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
196 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
197 #define OBD_FAIL_LDLM_CREATE_RESOURCE 0x30a
198 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED 0x30b
199 #define OBD_FAIL_LDLM_REPLY 0x30c
200 #define OBD_FAIL_LDLM_RECOV_CLIENTS 0x30d
201 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
202 #define OBD_FAIL_LDLM_GLIMPSE 0x30f
203 #define OBD_FAIL_LDLM_CANCEL_RACE 0x310
204 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE 0x311
206 #define OBD_FAIL_LDLM_PAUSE_CANCEL 0x312
208 #define OBD_FAIL_LDLM_CLOSE_THREAD 0x313
209 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE 0x314
211 #define OBD_FAIL_OSC 0x400
212 #define OBD_FAIL_OSC_BRW_READ_BULK 0x401
213 #define OBD_FAIL_OSC_BRW_WRITE_BULK 0x402
214 #define OBD_FAIL_OSC_LOCK_BL_AST 0x403
215 #define OBD_FAIL_OSC_LOCK_CP_AST 0x404
216 #define OBD_FAIL_OSC_MATCH 0x405
217 #define OBD_FAIL_OSC_BRW_PREP_REQ 0x406
218 #define OBD_FAIL_OSC_SHUTDOWN 0x407
219 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE 0x408
220 #define OBD_FAIL_OSC_CHECKSUM_SEND 0x409
221 #define OBD_FAIL_OSC_BRW_PREP_REQ2 0x40a
222 #define OBD_FAIL_OSC_CONNECT_CKSUM 0x40b
223 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY 0x40c
224 #define OBD_FAIL_OSC_DIO_PAUSE 0x40d
226 #define OBD_FAIL_PTLRPC 0x500
227 #define OBD_FAIL_PTLRPC_ACK 0x501
228 #define OBD_FAIL_PTLRPC_RQBD 0x502
229 #define OBD_FAIL_PTLRPC_BULK_GET_NET 0x503
230 #define OBD_FAIL_PTLRPC_BULK_PUT_NET 0x504
231 #define OBD_FAIL_PTLRPC_DROP_RPC 0x505
232 #define OBD_FAIL_PTLRPC_DELAY_SEND 0x506
233 #define OBD_FAIL_PTLRPC_DELAY_RECOV 0x507
235 #define OBD_FAIL_OBD_PING_NET 0x600
236 #define OBD_FAIL_OBD_LOG_CANCEL_NET 0x601
237 #define OBD_FAIL_OBD_LOGD_NET 0x602
238 #define OBD_FAIL_OBD_QC_CALLBACK_NET 0x603
239 #define OBD_FAIL_OBD_DQACQ 0x604
241 #define OBD_FAIL_TGT_REPLY_NET 0x700
242 #define OBD_FAIL_TGT_CONN_RACE 0x701
243 #define OBD_FAIL_TGT_FORCE_RECONNECT 0x702
244 #define OBD_FAIL_TGT_DELAY_CONNECT 0x703
245 #define OBD_FAIL_TGT_DELAY_RECONNECT 0x704
246 #define OBD_FAIL_TGT_DELAY_PRECREATE 0x705
247 #define OBD_FAIL_TGT_TOOMANY_THREADS 0x706
249 #define OBD_FAIL_MDC_REVALIDATE_PAUSE 0x800
250 #define OBD_FAIL_MDC_ENQUEUE_PAUSE 0x801
251 #define OBD_FAIL_MDC_GETATTR_ENQUEUE 0x803
253 #define OBD_FAIL_MGS 0x900
254 #define OBD_FAIL_MGS_ALL_REQUEST_NET 0x901
255 #define OBD_FAIL_MGS_ALL_REPLY_NET 0x902
256 #define OBD_FAIL_MGC_PROCESS_LOG 0x903
257 #define OBD_FAIL_MGS_SLOW_REQUEST_NET 0x904
258 #define OBD_FAIL_MGS_SLOW_TARGET_REG 0x905
260 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT 0xa00
262 #define OBD_FAIL_LPROC_REMOVE 0xb00
264 #define OBD_FAIL_GENERAL_ALLOC 0xc00
266 #define OBD_FAIL_SEQ 0x1000
267 #define OBD_FAIL_SEQ_QUERY_NET 0x1001
269 #define OBD_FAIL_FLD 0x1100
270 #define OBD_FAIL_FLD_QUERY_NET 0x1101
272 #define OBD_FAIL_SEC_CTX 0x1200
273 #define OBD_FAIL_SEC_CTX_INIT_NET 0x1201
274 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET 0x1202
275 #define OBD_FAIL_SEC_CTX_FINI_NET 0x1203
277 /* Failure injection control */
278 #define OBD_FAIL_MASK_SYS 0x0000FF00
279 #define OBD_FAIL_MASK_LOC (0x000000FF | OBD_FAIL_MASK_SYS)
281 #define OBD_FAILED_BIT 30
282 /* OBD_FAILED is 0x40000000 */
283 #define OBD_FAILED (1 << OBD_FAILED_BIT)
285 #define OBD_FAIL_ONCE_BIT 31
286 /* OBD_FAIL_ONCE is 0x80000000 */
287 #define OBD_FAIL_ONCE (1 << OBD_FAIL_ONCE_BIT)
289 /* The following flags aren't made to be combined */
290 #define OBD_FAIL_SKIP 0x20000000 /* skip N times then fail */
291 #define OBD_FAIL_SOME 0x10000000 /* only fail N times */
292 #define OBD_FAIL_RAND 0x08000000 /* fail 1/N of the times */
293 #define OBD_FAIL_USR1 0x04000000 /* user flag */
295 #define OBD_FAIL_PRECHECK(id) (obd_fail_loc && \
296 (obd_fail_loc & OBD_FAIL_MASK_LOC) == \
297 ((id) & OBD_FAIL_MASK_LOC))
299 static inline int obd_fail_check_set(__u32 id, __u32 value, int set)
302 if (unlikely(OBD_FAIL_PRECHECK(id) &&
303 (ret = __obd_fail_check_set(id, value, set)))) {
304 CERROR("*** obd_fail_loc=%x ***\n", id);
309 /* If id hit obd_fail_loc, return 1, otherwise return 0 */
310 #define OBD_FAIL_CHECK(id) \
311 obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET)
313 /* If id hit obd_fail_loc, obd_fail_loc |= value and return 1,
314 * otherwise return 0 */
315 #define OBD_FAIL_CHECK_ORSET(id, value) \
316 obd_fail_check_set(id, value, OBD_FAIL_LOC_ORSET)
318 /* If id hit obd_fail_loc, obd_fail_loc = value and return 1,
319 * otherwise return 0 */
320 #define OBD_FAIL_CHECK_RESET(id, value) \
321 obd_fail_check_set(id, value, OBD_FAIL_LOC_RESET)
324 static inline int obd_fail_timeout_set(__u32 id, __u32 value, int secs, int set)
327 if (unlikely(OBD_FAIL_PRECHECK(id) &&
328 (ret = __obd_fail_check_set(id, value, set)))) {
329 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",
331 set_current_state(TASK_UNINTERRUPTIBLE);
332 cfs_schedule_timeout(CFS_TASK_UNINT, cfs_time_seconds(secs));
333 set_current_state(TASK_RUNNING);
334 CERROR("obd_fail_timeout id %x awake\n", id);
339 /* If id hit obd_fail_loc, sleep secs */
340 #define OBD_FAIL_TIMEOUT(id, secs) \
341 obd_fail_timeout_set(id, 0, secs, OBD_FAIL_LOC_NOSET)
343 /* If id hit obd_fail_loc, obd_fail_loc |= value and sleep secs */
344 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) \
345 obd_fail_timeout_set(id, value, secs, OBD_FAIL_LOC_ORSET)
348 static inline void obd_fail_write(int id, struct super_block *sb)
350 /* We set FAIL_ONCE because we never "un-fail" a device */
351 if (OBD_FAIL_CHECK_ORSET(id & ~OBD_FAIL_ONCE, OBD_FAIL_ONCE)) {
353 BDEVNAME_DECLARE_STORAGE(tmp);
354 CERROR("obd_fail_loc=%x, fail write operation on %s\n",
355 id, ll_bdevname(sb, tmp));
357 /* TODO-CMD: fix getting jdev */
358 __lvfs_set_rdonly(lvfs_sbdev(sb), (lvfs_sbdev_type)0);
361 #define OBD_FAIL_WRITE(id, sb) obd_fail_write(id, sb)
363 /* The idea here is to synchronise two threads to force a race. The
364 * first thread that calls this with a matching fail_loc is put to
365 * sleep. The next thread that calls with the same fail_loc wakes up
366 * the first and continues. */
367 static inline void obd_race(__u32 id)
369 if (OBD_FAIL_PRECHECK(id)) {
370 if (unlikely(__obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET))) {
372 CERROR("obd_race id %x sleeping\n", id);
373 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);
374 CERROR("obd_fail_race id %x awake\n", id);
376 CERROR("obd_fail_race id %x waking\n", id);
378 wake_up(&obd_race_waitq);
382 #define OBD_RACE(id) obd_race(id)
384 /* sigh. an expedient fix until OBD_RACE is fixed up */
385 #define OBD_RACE(foo) do {} while(0)
388 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
390 extern atomic_t libcfs_kmemory;
393 #define obd_memory_add(size) \
394 lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
395 #define obd_memory_sub(size) \
396 lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
397 #define obd_memory_sum() \
398 lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT, \
399 LPROCFS_FIELDS_FLAGS_SUM)
400 #define obd_pages_add(order) \
401 lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT, \
402 (long)(1 << (order)))
403 #define obd_pages_sub(order) \
404 lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT, \
405 (long)(1 << (order)))
406 #define obd_pages_sum() \
407 lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT, \
408 LPROCFS_FIELDS_FLAGS_SUM)
410 extern void obd_update_maxusage(void);
411 extern __u64 obd_memory_max(void);
412 extern __u64 obd_pages_max(void);
416 extern __u64 obd_alloc;
417 extern __u64 obd_pages;
419 extern __u64 obd_max_alloc;
420 extern __u64 obd_max_pages;
422 static inline void obd_memory_add(long size)
425 if (obd_alloc > obd_max_alloc)
426 obd_max_alloc = obd_alloc;
429 static inline void obd_memory_sub(long size)
434 static inline void obd_pages_add(int order)
436 obd_pages += 1<< order;
437 if (obd_pages > obd_max_pages)
438 obd_max_pages = obd_pages;
441 static inline void obd_pages_sub(int order)
443 obd_pages -= 1<< order;
446 #define obd_memory_sum() (obd_alloc)
447 #define obd_pages_sum() (obd_pages)
449 #define obd_memory_max() (obd_max_alloc)
450 #define obd_pages_max() (obd_max_pages)
454 #if defined (CONFIG_DEBUG_MEMORY) && defined(__KERNEL__)
456 #define OBD_MT_WRONG_SIZE (1 << 0)
457 #define OBD_MT_ALREADY_FREED (1 << 1)
458 #define OBD_MT_LOC_LEN 128
460 struct obd_mem_track {
461 struct hlist_node mt_hash;
462 char mt_loc[OBD_MT_LOC_LEN];
468 void lvfs_memdbg_show(void);
469 void lvfs_memdbg_insert(struct obd_mem_track *mt);
470 void lvfs_memdbg_remove(struct obd_mem_track *mt);
471 struct obd_mem_track *lvfs_memdbg_find(void *ptr);
473 int lvfs_memdbg_check_insert(struct obd_mem_track *mt);
474 struct obd_mem_track *lvfs_memdbg_check_remove(void *ptr);
476 static inline struct obd_mem_track *
477 __new_mem_track(void *ptr, int size,
478 char *file, int line)
480 struct obd_mem_track *mt;
482 mt = kmalloc(sizeof(*mt), GFP_KERNEL);
486 snprintf(mt->mt_loc, sizeof(mt->mt_loc) - 1,
487 "%s:%d", file, line);
496 __free_mem_track(struct obd_mem_track *mt)
502 __get_mem_track(void *ptr, int size,
503 char *file, int line)
505 struct obd_mem_track *mt;
507 mt = __new_mem_track(ptr, size, file, line);
509 CWARN("Can't allocate new memory track\n");
513 if (!lvfs_memdbg_check_insert(mt))
514 __free_mem_track(mt);
520 __put_mem_track(void *ptr, int size,
521 char *file, int line)
523 struct obd_mem_track *mt;
525 if (unlikely(!(mt = lvfs_memdbg_check_remove(ptr)))) {
526 CWARN("Ptr 0x%p is not allocated. Attempt to free "
527 "not allocated memory at %s:%d\n", ptr,
532 if (unlikely(mt->mt_size != size)) {
533 if (!(mt->mt_flags & OBD_MT_ALREADY_FREED)) {
534 mt->mt_flags |= (OBD_MT_WRONG_SIZE |
535 OBD_MT_ALREADY_FREED);
537 CWARN("Freeing memory chunk (at 0x%p) of "
538 "different size than allocated "
539 "(%d != %d) at %s:%d, allocated at %s\n",
540 ptr, mt->mt_size, size, file, line,
544 __free_mem_track(mt);
550 #define get_mem_track(ptr, size, file, line) \
551 __get_mem_track((ptr), (size), (file), (line))
553 #define put_mem_track(ptr, size, file, line) \
554 __put_mem_track((ptr), (size), (file), (line))
556 #else /* !CONFIG_DEBUG_MEMORY */
558 #define get_mem_track(ptr, size, file, line) \
561 #define put_mem_track(ptr, size, file, line) \
563 #endif /* !CONFIG_DEBUG_MEMORY */
565 #define OBD_DEBUG_MEMUSAGE (1)
567 #if OBD_DEBUG_MEMUSAGE
568 #define OBD_ALLOC_POST(ptr, size, name) \
569 obd_memory_add(size); \
570 get_mem_track((ptr), (size), __FILE__, __LINE__); \
571 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n", \
574 #define OBD_FREE_PRE(ptr, size, name) \
576 put_mem_track((ptr), (size), __FILE__, __LINE__); \
577 obd_memory_sub(size); \
578 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n", \
580 POISON(ptr, 0x5a, size)
582 #else /* !OBD_DEBUG_MEMUSAGE */
584 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
585 #define OBD_FREE_PRE(ptr, size, name) ((void)0)
587 #endif /* !OBD_DEBUG_MEMUSAGE */
589 #ifdef RANDOM_FAIL_ALLOC
590 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
592 #define HAS_FAIL_ALLOC_FLAG 0
595 #define OBD_ALLOC_FAIL_BITS 24
596 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
597 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
599 #if defined(LUSTRE_UTILS) /* this version is for utils only */
600 #define OBD_ALLOC_GFP(ptr, size, gfp_mask) \
602 (ptr) = cfs_alloc(size, (gfp_mask)); \
603 if (unlikely((ptr) == NULL)) { \
604 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n", \
605 (int)(size), __FILE__, __LINE__); \
607 memset(ptr, 0, size); \
608 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n", \
612 #else /* this version is for the kernel and liblustre */
613 #define OBD_FREE_RTN0(ptr) \
619 #define OBD_ALLOC_GFP(ptr, size, gfp_mask) \
621 (ptr) = cfs_alloc(size, (gfp_mask)); \
622 if (likely((ptr) != NULL && \
623 (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 || \
624 !obd_alloc_fail(ptr, #ptr, "km", size, \
625 __FILE__, __LINE__) || \
626 OBD_FREE_RTN0(ptr)))){ \
627 memset(ptr, 0, size); \
628 OBD_ALLOC_POST(ptr, size, "kmalloced"); \
633 #ifndef OBD_ALLOC_MASK
634 # define OBD_ALLOC_MASK CFS_ALLOC_IO
637 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
638 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
639 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
640 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
643 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
645 # define OBD_VMALLOC(ptr, size) \
647 (ptr) = cfs_alloc_large(size); \
648 if (unlikely((ptr) == NULL)) { \
649 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n", \
651 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
652 obd_memory_sum(), atomic_read(&libcfs_kmemory)); \
654 memset(ptr, 0, size); \
655 OBD_ALLOC_POST(ptr, size, "vmalloced"); \
660 #ifdef CONFIG_DEBUG_SLAB
661 #define POISON(ptr, c, s) do {} while (0)
662 #define POISON_PTR(ptr) ((void)0)
664 #define POISON(ptr, c, s) memset(ptr, c, s)
665 #define POISON_PTR(ptr) (ptr) = (void *)0xdeadbeef
669 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE); \
670 kunmap(page); } while (0)
672 #define POISON_PAGE(page, val) do { } while (0)
676 #define OBD_FREE(ptr, size) \
678 OBD_FREE_PRE(ptr, size, "kfreed"); \
685 # ifdef HAVE_CALL_RCU_PARAM
686 # define my_call_rcu(rcu, cb) call_rcu(rcu, cb, rcu)
688 # define my_call_rcu(rcu, cb) call_rcu(rcu, cb)
691 # define my_call_rcu(rcu, cb) (cb)(rcu)
694 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb) \
696 struct portals_handle *__h = (handle); \
698 __h->h_ptr = (ptr); \
699 __h->h_size = (size); \
700 __h->h_free_cb = (void (*)(void *, size_t))(free_cb); \
701 my_call_rcu(&__h->h_rcu, class_handle_free_cb); \
704 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
707 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
708 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
709 #define OBD_FREE_RCU_CB(ptr, size, handle, cb) ((*(cb))(ptr, size))
710 #endif /* ifdef __KERNEL__ */
713 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
715 # define OBD_VFREE(ptr, size) \
717 OBD_FREE_PRE(ptr, size, "vfreed"); \
718 cfs_free_large(ptr); \
723 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
724 * HAVE A CTOR THAT DOES ANYTHING. its work will be cleared here. we'd
725 * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
726 #define OBD_SLAB_FREE_RTN0(ptr, slab) \
728 cfs_mem_cache_free((slab), (ptr)); \
732 #define OBD_SLAB_ALLOC(ptr, slab, type, size) \
734 LASSERT(!in_interrupt()); \
735 (ptr) = cfs_mem_cache_alloc(slab, (type)); \
736 if (likely((ptr) != NULL && \
737 (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 || \
738 !obd_alloc_fail(ptr, #ptr, "slab-", size, \
739 __FILE__, __LINE__) || \
740 OBD_SLAB_FREE_RTN0(ptr, slab)))) { \
741 memset(ptr, 0, size); \
742 OBD_ALLOC_POST(ptr, size, "slab-alloced"); \
746 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
748 #define OBD_SLAB_FREE(ptr, slab, size) \
750 OBD_FREE_PRE(ptr, size, "slab-freed"); \
751 cfs_mem_cache_free(slab, ptr); \
755 #define OBD_SLAB_ALLOC_PTR(ptr, slab) \
756 OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
757 #define OBD_SLAB_FREE_PTR(ptr, slab) \
758 OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
760 #define KEY_IS(str) \
761 (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
763 /* Wrapper for contiguous page frame allocation */
764 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask) \
766 (ptr) = cfs_alloc_pages(gfp_mask, order); \
767 if (unlikely((ptr) == NULL)) { \
768 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
769 "failed\n", (int)(1 << (order)), \
770 (__u64)((1 << (order)) << CFS_PAGE_SHIFT)); \
771 CERROR(LPU64" total bytes and "LPU64" total pages " \
772 "("LPU64" bytes) allocated by Lustre, " \
773 "%d total bytes by LNET\n", \
775 obd_pages_sum() << CFS_PAGE_SHIFT, \
777 atomic_read(&libcfs_kmemory)); \
779 obd_pages_add(order); \
780 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / " \
781 LPU64" bytes at %p.\n", \
782 (int)(1 << (order)), \
783 (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr); \
787 #define OBD_PAGE_ALLOC(ptr, gfp_mask) \
788 OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
790 #define OBD_PAGES_FREE(ptr, order) \
793 obd_pages_sub(order); \
794 CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
796 (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
798 __cfs_free_pages(ptr, order); \
799 (ptr) = (void *)0xdeadbeef; \
802 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)