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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * libcfs/include/libcfs/libcfs_private.h
34 * Various defines for libcfs.
38 #ifndef __LIBCFS_PRIVATE_H__
39 #define __LIBCFS_PRIVATE_H__
41 #ifndef DEBUG_SUBSYSTEM
42 # define DEBUG_SUBSYSTEM S_UNDEFINED
45 #include <linux/slab.h>
46 #include <linux/vmalloc.h>
51 * When this is on, LASSERT macro includes check for assignment used instead
52 * of equality check, but doesn't have unlikely(). Turn this on from time to
53 * time to make test-builds. This shouldn't be on for production release.
55 #define LASSERT_CHECKED (0)
61 * Strange construction with empty "then" clause is used to trigger compiler
62 * warnings on the assertions of the form LASSERT(a = b);
64 * "warning: suggest parentheses around assignment used as truth value"
66 * requires -Wall. Unfortunately this rules out use of likely/unlikely.
68 #define LASSERTF(cond, fmt, ...) \
73 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL); \
74 libcfs_debug_msg(&__msg_data, \
75 "ASSERTION( %s ) failed: " fmt, #cond, \
77 lbug_with_loc(&__msg_data); \
81 #define LASSERT(cond) LASSERTF(cond, "\n")
83 #else /* !LASSERT_CHECKED */
85 #define LASSERTF(cond, fmt, ...) \
87 if (unlikely(!(cond))) { \
88 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL); \
89 libcfs_debug_msg(&__msg_data, \
90 "ASSERTION( %s ) failed: " fmt, #cond, \
92 lbug_with_loc(&__msg_data); \
96 #define LASSERT(cond) LASSERTF(cond, "\n")
97 #endif /* !LASSERT_CHECKED */
98 #else /* !LIBCFS_DEBUG */
99 /* sizeof is to use expression without evaluating it. */
100 # define LASSERT(e) ((void)sizeof!!(e))
101 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
102 #endif /* !LIBCFS_DEBUG */
104 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
106 * This is for more expensive checks that one doesn't want to be enabled all
107 * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
110 # define LINVRNT(exp) LASSERT(exp)
112 # define LINVRNT(exp) ((void)sizeof!!(exp))
115 #define KLASSERT(e) LASSERT(e)
117 void lbug_with_loc(struct libcfs_debug_msg_data *) __attribute__((noreturn));
121 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
122 lbug_with_loc(&msgdata); \
130 extern atomic_t libcfs_kmemory;
132 # define libcfs_kmem_inc(ptr, size) \
134 atomic_add(size, &libcfs_kmemory); \
137 # define libcfs_kmem_dec(ptr, size) \
139 atomic_sub(size, &libcfs_kmemory); \
142 # define libcfs_kmem_read() \
143 atomic_read(&libcfs_kmemory)
146 # define libcfs_kmem_inc(ptr, size) do {} while (0)
147 # define libcfs_kmem_dec(ptr, size) do {} while (0)
148 # define libcfs_kmem_read() (0)
149 #endif /* LIBCFS_DEBUG */
151 #ifndef LIBCFS_VMALLOC_SIZE
152 #define LIBCFS_VMALLOC_SIZE (2 << PAGE_SHIFT) /* 2 pages */
155 #define LIBCFS_ALLOC_PRE(size, mask) \
157 LASSERT(!in_interrupt() || \
158 ((size) <= LIBCFS_VMALLOC_SIZE && \
159 ((mask) & GFP_ATOMIC)) != 0); \
162 #define LIBCFS_ALLOC_POST(ptr, size) \
164 if (unlikely((ptr) == NULL)) { \
165 CERROR("LNET: out of memory at %s:%d (tried to alloc '" \
166 #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size)); \
167 CERROR("LNET: %d total bytes allocated by lnet\n", \
168 libcfs_kmem_read()); \
170 libcfs_kmem_inc((ptr), (size)); \
171 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n", \
172 (int)(size), (ptr), libcfs_kmem_read()); \
177 * allocate memory with GFP flags @mask
178 * The allocated memory is zeroed-out.
180 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
182 LIBCFS_ALLOC_PRE((size), (mask)); \
183 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
184 kzalloc((size), (mask)) : vzalloc(size); \
185 LIBCFS_ALLOC_POST((ptr), (size)); \
191 #define LIBCFS_ALLOC(ptr, size) \
192 LIBCFS_ALLOC_GFP(ptr, size, GFP_NOFS)
195 * non-sleeping allocator
197 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
198 LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
201 * allocate memory for specified CPU partition
202 * \a cptab != NULL, \a cpt is CPU partition id of \a cptab
203 * \a cptab == NULL, \a cpt is HW NUMA node id
204 * The allocated memory is zeroed-out.
206 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask) \
208 LIBCFS_ALLOC_PRE((size), (mask)); \
209 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
210 cfs_cpt_malloc((cptab), (cpt), (size), (mask) | __GFP_ZERO) : \
211 cfs_cpt_vzalloc((cptab), (cpt), (size)); \
212 LIBCFS_ALLOC_POST((ptr), (size)); \
215 /** default numa allocator */
216 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size) \
217 LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, GFP_NOFS)
219 #define LIBCFS_FREE(ptr, size) \
222 if (unlikely((ptr) == NULL)) { \
223 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \
224 "%s:%d\n", s, __FILE__, __LINE__); \
227 libcfs_kmem_dec((ptr), s); \
228 CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n", \
229 s, (ptr), libcfs_kmem_read()); \
230 if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \
236 /******************************************************************************/
240 void libcfs_debug_dumpstack(struct task_struct *tsk);
241 void libcfs_debug_dumplog(void);
242 int libcfs_debug_init(unsigned long bufsize);
243 int libcfs_debug_cleanup(void);
244 int libcfs_debug_clear_buffer(void);
245 int libcfs_debug_mark_buffer(const char *text);
248 * allocate a variable array, returned value is an array of pointers.
249 * Caller can specify length of array by count.
251 void *cfs_array_alloc(int count, unsigned int size);
252 void cfs_array_free(void *vars);
254 #define LASSERT_ATOMIC_ENABLED (1)
256 #if LASSERT_ATOMIC_ENABLED
258 /** assert value of @a is equal to @v */
259 #define LASSERT_ATOMIC_EQ(a, v) \
261 LASSERTF(atomic_read(a) == v, \
262 "value: %d\n", atomic_read((a))); \
265 /** assert value of @a is unequal to @v */
266 #define LASSERT_ATOMIC_NE(a, v) \
268 LASSERTF(atomic_read(a) != v, \
269 "value: %d\n", atomic_read((a))); \
272 /** assert value of @a is little than @v */
273 #define LASSERT_ATOMIC_LT(a, v) \
275 LASSERTF(atomic_read(a) < v, \
276 "value: %d\n", atomic_read((a))); \
279 /** assert value of @a is little/equal to @v */
280 #define LASSERT_ATOMIC_LE(a, v) \
282 LASSERTF(atomic_read(a) <= v, \
283 "value: %d\n", atomic_read((a))); \
286 /** assert value of @a is great than @v */
287 #define LASSERT_ATOMIC_GT(a, v) \
289 LASSERTF(atomic_read(a) > v, \
290 "value: %d\n", atomic_read((a))); \
293 /** assert value of @a is great/equal to @v */
294 #define LASSERT_ATOMIC_GE(a, v) \
296 LASSERTF(atomic_read(a) >= v, \
297 "value: %d\n", atomic_read((a))); \
300 /** assert value of @a is great than @v1 and little than @v2 */
301 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) \
303 int __v = atomic_read(a); \
304 LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v); \
307 /** assert value of @a is great than @v1 and little/equal to @v2 */
308 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) \
310 int __v = atomic_read(a); \
311 LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v); \
314 /** assert value of @a is great/equal to @v1 and little than @v2 */
315 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) \
317 int __v = atomic_read(a); \
318 LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v); \
321 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
322 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) \
324 int __v = atomic_read(a); \
325 LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v); \
328 #else /* !LASSERT_ATOMIC_ENABLED */
330 #define LASSERT_ATOMIC_EQ(a, v) do {} while (0)
331 #define LASSERT_ATOMIC_NE(a, v) do {} while (0)
332 #define LASSERT_ATOMIC_LT(a, v) do {} while (0)
333 #define LASSERT_ATOMIC_LE(a, v) do {} while (0)
334 #define LASSERT_ATOMIC_GT(a, v) do {} while (0)
335 #define LASSERT_ATOMIC_GE(a, v) do {} while (0)
336 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) do {} while (0)
337 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) do {} while (0)
338 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) do {} while (0)
339 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) do {} while (0)
341 #endif /* LASSERT_ATOMIC_ENABLED */
343 #define LASSERT_ATOMIC_ZERO(a) LASSERT_ATOMIC_EQ(a, 0)
344 #define LASSERT_ATOMIC_POS(a) LASSERT_ATOMIC_GT(a, 0)
346 #define CFS_ALLOC_PTR(ptr) LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
347 #define CFS_FREE_PTR(ptr) LIBCFS_FREE(ptr, sizeof (*(ptr)));
349 /** Compile-time assertion.
351 * Check an invariant described by a constant expression at compile time by
352 * forcing a compiler error if it does not hold. \a cond must be a constant
353 * expression as defined by the ISO C Standard:
355 * 6.8.4.2 The switch statement
357 * [#3] The expression of each case label shall be an integer
358 * constant expression and no two of the case constant
359 * expressions in the same switch statement shall have the same
360 * value after conversion...
363 #define CLASSERT(cond) do {switch (1) {case (cond): case 0: break; } } while (0)
366 #define ergo(a, b) (!(a) || (b))
367 /* logical equivalence */
368 #define equi(a, b) (!!(a) == !!(b))
370 /* what used to be in portals_lib.h */
372 # define MIN(a,b) (((a)<(b)) ? (a): (b))
375 # define MAX(a,b) (((a)>(b)) ? (a): (b))
378 #define MKSTR(ptr) ((ptr))? (ptr) : ""
380 static inline size_t cfs_size_round4(size_t val)
382 return (val + 3) & (~0x3);
385 #ifndef HAVE_CFS_SIZE_ROUND
386 static inline size_t cfs_size_round(size_t val)
388 return (val + 7) & (~0x7);
390 #define HAVE_CFS_SIZE_ROUND
393 static inline size_t cfs_size_round16(size_t val)
395 return (val + 0xf) & (~0xf);
398 static inline size_t cfs_size_round32(size_t val)
400 return (val + 0x1f) & (~0x1f);
403 static inline size_t cfs_size_round0(size_t val)
407 return (val + 1 + 7) & (~0x7);
410 static inline size_t cfs_round_strlen(char *fset)
412 return cfs_size_round(strlen(fset) + 1);
415 extern struct cfs_psdev_ops libcfs_psdev_ops;
416 extern struct miscdevice libcfs_dev;