4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2014, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * libcfs/include/libcfs/libcfs_private.h
33 * Various defines for libcfs.
37 #ifndef __LIBCFS_PRIVATE_H__
38 #define __LIBCFS_PRIVATE_H__
40 #ifndef DEBUG_SUBSYSTEM
41 # define DEBUG_SUBSYSTEM S_UNDEFINED
44 #include <linux/slab.h>
45 #include <linux/vmalloc.h>
50 * When this is on, LASSERT macro includes check for assignment used instead
51 * of equality check, but doesn't have unlikely(). Turn this on from time to
52 * time to make test-builds. This shouldn't be on for production release.
54 #define LASSERT_CHECKED (0)
60 * Strange construction with empty "then" clause is used to trigger compiler
61 * warnings on the assertions of the form LASSERT(a = b);
63 * "warning: suggest parentheses around assignment used as truth value"
65 * requires -Wall. Unfortunately this rules out use of likely/unlikely.
67 #define LASSERTF(cond, fmt, ...) \
72 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL); \
73 libcfs_debug_msg(&__msg_data, \
74 "ASSERTION( %s ) failed: " fmt, #cond, \
76 lbug_with_loc(&__msg_data); \
80 #define LASSERT(cond) LASSERTF(cond, "\n")
82 #else /* !LASSERT_CHECKED */
84 #define LASSERTF(cond, fmt, ...) \
86 if (unlikely(!(cond))) { \
87 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL); \
88 libcfs_debug_msg(&__msg_data, \
89 "ASSERTION( %s ) failed: " fmt, #cond, \
91 lbug_with_loc(&__msg_data); \
95 #define LASSERT(cond) LASSERTF(cond, "\n")
96 #endif /* !LASSERT_CHECKED */
97 #else /* !LIBCFS_DEBUG */
98 /* sizeof is to use expression without evaluating it. */
99 # define LASSERT(e) ((void)sizeof!!(e))
100 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
101 #endif /* !LIBCFS_DEBUG */
103 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
105 * This is for more expensive checks that one doesn't want to be enabled all
106 * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
109 # define LINVRNT(exp) LASSERT(exp)
111 # define LINVRNT(exp) ((void)sizeof!!(exp))
114 void __noreturn lbug_with_loc(struct libcfs_debug_msg_data *msg);
118 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
119 lbug_with_loc(&msgdata); \
127 extern atomic64_t libcfs_kmem;
129 # define libcfs_kmem_inc(ptr, size) \
131 atomic64_add(size, &libcfs_kmem); \
134 # define libcfs_kmem_dec(ptr, size) \
136 atomic64_sub(size, &libcfs_kmem); \
139 # define libcfs_kmem_read() \
140 (long long)atomic64_read(&libcfs_kmem)
143 # define libcfs_kmem_inc(ptr, size) do {} while (0)
144 # define libcfs_kmem_dec(ptr, size) do {} while (0)
145 # define libcfs_kmem_read() (0)
146 #endif /* LIBCFS_DEBUG */
148 #ifndef LIBCFS_VMALLOC_SIZE
149 #define LIBCFS_VMALLOC_SIZE (2 << PAGE_SHIFT) /* 2 pages */
152 #define LIBCFS_ALLOC_PRE(size, mask) \
154 LASSERT(!in_interrupt() || \
155 ((size) <= LIBCFS_VMALLOC_SIZE && \
156 ((mask) & GFP_ATOMIC)) != 0); \
159 /* message format here needs to match regexp in lustre/tests/leak_finder.pl */
160 #define LIBCFS_MEM_MSG(ptr, size, name) \
161 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n", (int)(size), ptr)
163 #define LIBCFS_ALLOC_POST(ptr, size, name) \
165 if (unlikely((ptr) == NULL)) { \
166 CERROR("LNET: out of memory at %s:%d (tried to alloc '" \
167 #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size)); \
168 CERROR("LNET: %lld total bytes allocated by lnet\n", \
169 libcfs_kmem_read()); \
171 libcfs_kmem_inc((ptr), (size)); \
172 LIBCFS_MEM_MSG(ptr, size, name); \
176 #define LIBCFS_FREE_PRE(ptr, size, name) \
177 libcfs_kmem_dec((ptr), (size)); \
178 LIBCFS_MEM_MSG(ptr, size, name)
181 * allocate memory with GFP flags @mask
182 * The allocated memory is zeroed-out.
184 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
186 LIBCFS_ALLOC_PRE((size), (mask)); \
187 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
188 kzalloc((size), (mask)) : vzalloc(size); \
189 LIBCFS_ALLOC_POST((ptr), (size), "alloc"); \
195 #define LIBCFS_ALLOC(ptr, size) \
196 LIBCFS_ALLOC_GFP(ptr, size, GFP_NOFS)
199 * non-sleeping allocator
201 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
202 LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
205 * allocate memory for specified CPU partition
206 * \a cptab != NULL, \a cpt is CPU partition id of \a cptab
207 * \a cptab == NULL, \a cpt is HW NUMA node id
208 * The allocated memory is zeroed-out.
210 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask) \
212 LIBCFS_ALLOC_PRE((size), (mask)); \
213 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
214 cfs_cpt_malloc((cptab), (cpt), (size), (mask) | __GFP_ZERO) : \
215 cfs_cpt_vzalloc((cptab), (cpt), (size)); \
216 LIBCFS_ALLOC_POST((ptr), (size), "alloc"); \
219 /** default numa allocator */
220 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size) \
221 LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, GFP_NOFS)
223 void init_libcfs_vfree_atomic(void);
224 void exit_libcfs_vfree_atomic(void);
226 #define LIBCFS_FREE(ptr, size) \
229 if (unlikely((ptr) == NULL)) { \
230 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \
231 "%s:%d\n", s, __FILE__, __LINE__); \
234 LIBCFS_FREE_PRE(ptr, size, "kfreed"); \
235 if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \
236 libcfs_vfree_atomic(ptr); \
241 /******************************************************************************/
243 void libcfs_debug_dumplog(void);
244 int libcfs_debug_init(unsigned long bufsize);
245 int libcfs_debug_cleanup(void);
246 int libcfs_debug_clear_buffer(void);
247 int libcfs_debug_mark_buffer(const char *text);
249 #define LASSERT_ATOMIC_ENABLED (1)
251 #if LASSERT_ATOMIC_ENABLED
253 /** assert value of @a is equal to @v */
254 #define LASSERT_ATOMIC_EQ(a, v) \
255 LASSERTF(atomic_read(a) == v, "value: %d\n", atomic_read((a)));
257 /** assert value of @a is unequal to @v */
258 #define LASSERT_ATOMIC_NE(a, v) \
259 LASSERTF(atomic_read(a) != v, "value: %d\n", atomic_read((a)));
261 /** assert value of @a is little than @v */
262 #define LASSERT_ATOMIC_LT(a, v) \
263 LASSERTF(atomic_read(a) < v, "value: %d\n", atomic_read((a)));
265 /** assert value of @a is little/equal to @v */
266 #define LASSERT_ATOMIC_LE(a, v) \
267 LASSERTF(atomic_read(a) <= v, "value: %d\n", atomic_read((a)));
269 /** assert value of @a is great than @v */
270 #define LASSERT_ATOMIC_GT(a, v) \
271 LASSERTF(atomic_read(a) > v, "value: %d\n", atomic_read((a)));
273 /** assert value of @a is great/equal to @v */
274 #define LASSERT_ATOMIC_GE(a, v) \
275 LASSERTF(atomic_read(a) >= v, "value: %d\n", atomic_read((a)));
277 /** assert value of @a is great than @v1 and little than @v2 */
278 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) \
280 int __v = atomic_read(a); \
281 LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);\
284 /** assert value of @a is great than @v1 and little/equal to @v2 */
285 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) \
287 int __v = atomic_read(a); \
288 LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);\
291 /** assert value of @a is great/equal to @v1 and little than @v2 */
292 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) \
294 int __v = atomic_read(a); \
295 LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);\
298 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
299 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) \
301 int __v = atomic_read(a); \
302 LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v); \
305 #else /* !LASSERT_ATOMIC_ENABLED */
307 #define LASSERT_ATOMIC_EQ(a, v) do {} while (0)
308 #define LASSERT_ATOMIC_NE(a, v) do {} while (0)
309 #define LASSERT_ATOMIC_LT(a, v) do {} while (0)
310 #define LASSERT_ATOMIC_LE(a, v) do {} while (0)
311 #define LASSERT_ATOMIC_GT(a, v) do {} while (0)
312 #define LASSERT_ATOMIC_GE(a, v) do {} while (0)
313 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) do {} while (0)
314 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) do {} while (0)
315 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) do {} while (0)
316 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) do {} while (0)
318 #endif /* LASSERT_ATOMIC_ENABLED */
320 #define LASSERT_ATOMIC_ZERO(a) LASSERT_ATOMIC_EQ(a, 0)
321 #define LASSERT_ATOMIC_POS(a) LASSERT_ATOMIC_GT(a, 0)
323 #define CFS_ALLOC_PTR(ptr) LIBCFS_ALLOC(ptr, sizeof(*(ptr)));
324 #define CFS_ALLOC_PTR_ARRAY(ptr, count) \
325 LIBCFS_ALLOC(ptr, (count) * sizeof(*(ptr)))
327 #define CFS_FREE_PTR(ptr) LIBCFS_FREE(ptr, sizeof(*(ptr)));
328 #define CFS_FREE_PTR_ARRAY(ptr, count) \
329 LIBCFS_FREE(ptr, (count) * sizeof(*(ptr)))
332 #define ergo(a, b) (!(a) || (b))
333 /* logical equivalence */
334 #define equi(a, b) (!!(a) == !!(b))
336 #define MKSTR(ptr) ((ptr))? (ptr) : ""
338 #ifndef HAVE_CFS_SIZE_ROUND
339 static inline size_t cfs_size_round(size_t val)
341 return (val + 7) & (~0x7);
343 #define HAVE_CFS_SIZE_ROUND