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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/libcfs_private.h
38 * Various defines for libcfs.
42 #ifndef __LIBCFS_PRIVATE_H__
43 #define __LIBCFS_PRIVATE_H__
45 /* XXX this layering violation is for nidstrings */
46 #include <linux/lnet/types.h>
48 #ifndef DEBUG_SUBSYSTEM
49 # define DEBUG_SUBSYSTEM S_UNDEFINED
55 * When this is on, LASSERT macro includes check for assignment used instead
56 * of equality check, but doesn't have unlikely(). Turn this on from time to
57 * time to make test-builds. This shouldn't be on for production release.
59 #define LASSERT_CHECKED (0)
62 #define LASSERTF(cond, fmt, ...) \
64 if (unlikely(!(cond))) { \
65 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL); \
66 libcfs_debug_msg(&__msg_data, \
67 "ASSERTION( %s ) failed: " fmt, #cond, \
69 lbug_with_loc(&__msg_data); \
73 #define LASSERT(cond) LASSERTF(cond, "\n")
75 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
77 * This is for more expensive checks that one doesn't want to be enabled all
78 * the time. LINVRNT() has to be explicitly enabled by
79 * CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK option.
81 # define LINVRNT(exp) LASSERT(exp)
83 # define LINVRNT(exp) ((void)sizeof!!(exp))
86 #define KLASSERT(e) LASSERT(e)
88 void lbug_with_loc(struct libcfs_debug_msg_data *) __attribute__((noreturn));
92 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
93 lbug_with_loc(&msgdata); \
96 extern atomic_t libcfs_kmemory;
101 # define libcfs_kmem_inc(ptr, size) \
103 atomic_add(size, &libcfs_kmemory); \
106 # define libcfs_kmem_dec(ptr, size) \
108 atomic_sub(size, &libcfs_kmemory); \
111 # define libcfs_kmem_read() \
112 atomic_read(&libcfs_kmemory)
115 #ifndef LIBCFS_VMALLOC_SIZE
116 #define LIBCFS_VMALLOC_SIZE (2 << PAGE_CACHE_SHIFT) /* 2 pages */
119 #define LIBCFS_ALLOC_PRE(size, mask) \
121 LASSERT(!in_interrupt() || \
122 ((size) <= LIBCFS_VMALLOC_SIZE && \
123 ((mask) & GFP_ATOMIC)) != 0); \
126 #define LIBCFS_ALLOC_POST(ptr, size) \
128 if (unlikely((ptr) == NULL)) { \
129 CERROR("LNET: out of memory at %s:%d (tried to alloc '" \
130 #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size)); \
131 CERROR("LNET: %d total bytes allocated by lnet\n", \
132 libcfs_kmem_read()); \
134 memset((ptr), 0, (size)); \
135 libcfs_kmem_inc((ptr), (size)); \
136 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n", \
137 (int)(size), (ptr), libcfs_kmem_read()); \
142 * allocate memory with GFP flags @mask
144 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
146 LIBCFS_ALLOC_PRE((size), (mask)); \
147 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
148 kmalloc((size), (mask)) : vmalloc(size); \
149 LIBCFS_ALLOC_POST((ptr), (size)); \
155 #define LIBCFS_ALLOC(ptr, size) \
156 LIBCFS_ALLOC_GFP(ptr, size, __GFP_IO)
159 * non-sleeping allocator
161 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
162 LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
165 * allocate memory for specified CPU partition
166 * \a cptab != NULL, \a cpt is CPU partition id of \a cptab
167 * \a cptab == NULL, \a cpt is HW NUMA node id
169 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask) \
171 LIBCFS_ALLOC_PRE((size), (mask)); \
172 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
173 kmalloc_node((size), (mask), cfs_cpt_spread_node(cptab, cpt)) :\
174 vmalloc_node(size, cfs_cpt_spread_node(cptab, cpt)); \
175 LIBCFS_ALLOC_POST((ptr), (size)); \
178 /** default numa allocator */
179 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size) \
180 LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, __GFP_IO)
182 #define LIBCFS_FREE(ptr, size) \
185 if (unlikely((ptr) == NULL)) { \
186 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \
187 "%s:%d\n", s, __FILE__, __LINE__); \
190 libcfs_kmem_dec((ptr), s); \
191 CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n", \
192 s, (ptr), libcfs_kmem_read()); \
193 if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \
199 /******************************************************************************/
201 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
202 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
203 #define ___htonl(x) __cpu_to_be32(x)
204 #define ___htons(x) __cpu_to_be16(x)
205 #define ___ntohl(x) __be32_to_cpu(x)
206 #define ___ntohs(x) __be16_to_cpu(x)
207 #define htonl(x) ___htonl(x)
208 #define ntohl(x) ___ntohl(x)
209 #define htons(x) ___htons(x)
210 #define ntohs(x) ___ntohs(x)
213 void libcfs_run_upcall(char **argv);
214 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *);
215 void libcfs_debug_dumplog(void);
216 int libcfs_debug_init(unsigned long bufsize);
217 int libcfs_debug_cleanup(void);
218 int libcfs_debug_clear_buffer(void);
219 int libcfs_debug_mark_buffer(const char *text);
221 void libcfs_debug_set_level(unsigned int debug_level);
225 * allocate per-cpu-partition data, returned value is an array of pointers,
226 * variable can be indexed by CPU ID.
227 * cptable != NULL: size of array is number of CPU partitions
228 * cptable == NULL: size of array is number of HW cores
230 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
232 * destroy per-cpu-partition variable
234 void cfs_percpt_free(void *vars);
235 int cfs_percpt_number(void *vars);
236 void *cfs_percpt_current(void *vars);
237 void *cfs_percpt_index(void *vars, int idx);
239 #define cfs_percpt_for_each(var, i, vars) \
240 for (i = 0; i < cfs_percpt_number(vars) && \
241 ((var) = (vars)[i]) != NULL; i++)
244 * allocate a variable array, returned value is an array of pointers.
245 * Caller can specify length of array by count.
247 void *cfs_array_alloc(int count, unsigned int size);
248 void cfs_array_free(void *vars);
250 #define LASSERT_ATOMIC_ENABLED (1)
252 #if LASSERT_ATOMIC_ENABLED
254 /** assert value of @a is equal to @v */
255 #define LASSERT_ATOMIC_EQ(a, v) \
257 LASSERTF(atomic_read(a) == v, \
258 "value: %d\n", atomic_read((a))); \
261 /** assert value of @a is unequal to @v */
262 #define LASSERT_ATOMIC_NE(a, v) \
264 LASSERTF(atomic_read(a) != v, \
265 "value: %d\n", atomic_read((a))); \
268 /** assert value of @a is little than @v */
269 #define LASSERT_ATOMIC_LT(a, v) \
271 LASSERTF(atomic_read(a) < v, \
272 "value: %d\n", atomic_read((a))); \
275 /** assert value of @a is little/equal to @v */
276 #define LASSERT_ATOMIC_LE(a, v) \
278 LASSERTF(atomic_read(a) <= v, \
279 "value: %d\n", atomic_read((a))); \
282 /** assert value of @a is great than @v */
283 #define LASSERT_ATOMIC_GT(a, v) \
285 LASSERTF(atomic_read(a) > v, \
286 "value: %d\n", atomic_read((a))); \
289 /** assert value of @a is great/equal to @v */
290 #define LASSERT_ATOMIC_GE(a, v) \
292 LASSERTF(atomic_read(a) >= v, \
293 "value: %d\n", atomic_read((a))); \
296 /** assert value of @a is great than @v1 and little than @v2 */
297 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) \
299 int __v = atomic_read(a); \
300 LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v); \
303 /** assert value of @a is great than @v1 and little/equal to @v2 */
304 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) \
306 int __v = atomic_read(a); \
307 LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v); \
310 /** assert value of @a is great/equal to @v1 and little than @v2 */
311 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) \
313 int __v = atomic_read(a); \
314 LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v); \
317 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
318 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) \
320 int __v = atomic_read(a); \
321 LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v); \
324 #else /* !LASSERT_ATOMIC_ENABLED */
326 #define LASSERT_ATOMIC_EQ(a, v) do {} while (0)
327 #define LASSERT_ATOMIC_NE(a, v) do {} while (0)
328 #define LASSERT_ATOMIC_LT(a, v) do {} while (0)
329 #define LASSERT_ATOMIC_LE(a, v) do {} while (0)
330 #define LASSERT_ATOMIC_GT(a, v) do {} while (0)
331 #define LASSERT_ATOMIC_GE(a, v) do {} while (0)
332 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) do {} while (0)
333 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) do {} while (0)
334 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) do {} while (0)
335 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) do {} while (0)
337 #endif /* LASSERT_ATOMIC_ENABLED */
339 #define LASSERT_ATOMIC_ZERO(a) LASSERT_ATOMIC_EQ(a, 0)
340 #define LASSERT_ATOMIC_POS(a) LASSERT_ATOMIC_GT(a, 0)
342 #define CFS_ALLOC_PTR(ptr) LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
343 #define CFS_FREE_PTR(ptr) LIBCFS_FREE(ptr, sizeof (*(ptr)));
346 * percpu partition lock
348 * There are some use-cases like this in Lustre:
349 * . each CPU partition has it's own private data which is frequently changed,
350 * and mostly by the local CPU partition.
351 * . all CPU partitions share some global data, these data are rarely changed.
353 * LNet is typical example.
354 * CPU partition lock is designed for this kind of use-cases:
355 * . each CPU partition has it's own private lock
356 * . change on private data just needs to take the private lock
357 * . read on shared data just needs to take _any_ of private locks
358 * . change on shared data needs to take _all_ private locks,
359 * which is slow and should be really rare.
363 CFS_PERCPT_LOCK_EX = -1, /* negative */
367 struct cfs_percpt_lock {
368 /* cpu-partition-table for this lock */
369 struct cfs_cpt_table *pcl_cptab;
370 /* exclusively locked */
371 unsigned int pcl_locked;
372 /* private lock table */
373 spinlock_t **pcl_locks;
376 /* return number of private locks */
378 cfs_percpt_lock_num(struct cfs_percpt_lock *pcl)
380 return cfs_cpt_number(pcl->pcl_cptab);
385 * create a cpu-partition lock based on CPU partition table \a cptab,
386 * each private lock has extra \a psize bytes padding data
388 struct cfs_percpt_lock *cfs_percpt_lock_alloc(struct cfs_cpt_table *cptab);
389 /* destroy a cpu-partition lock */
390 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
392 /* lock private lock \a index of \a pcl */
393 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
394 /* unlock private lock \a index of \a pcl */
395 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
396 /* create percpt (atomic) refcount based on @cptab */
397 atomic_t **cfs_percpt_atomic_alloc(struct cfs_cpt_table *cptab, int val);
398 /* destroy percpt refcount */
399 void cfs_percpt_atomic_free(atomic_t **refs);
400 /* return sum of all percpu refs */
401 int cfs_percpt_atomic_summary(atomic_t **refs);
404 /** Compile-time assertion.
406 * Check an invariant described by a constant expression at compile time by
407 * forcing a compiler error if it does not hold. \a cond must be a constant
408 * expression as defined by the ISO C Standard:
410 * 6.8.4.2 The switch statement
412 * [#3] The expression of each case label shall be an integer
413 * constant expression and no two of the case constant
414 * expressions in the same switch statement shall have the same
415 * value after conversion...
418 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
420 /* support decl needed both by kernel and liblustre */
421 int libcfs_isknown_lnd(int type);
422 char *libcfs_lnd2modname(int type);
423 char *libcfs_lnd2str(int type);
424 int libcfs_str2lnd(const char *str);
425 char *libcfs_net2str(__u32 net);
426 char *libcfs_nid2str(lnet_nid_t nid);
427 __u32 libcfs_str2net(const char *str);
428 lnet_nid_t libcfs_str2nid(const char *str);
429 int libcfs_str2anynid(lnet_nid_t *nid, const char *str);
430 char *libcfs_id2str(lnet_process_id_t id);
431 void cfs_free_nidlist(struct list_head *list);
432 int cfs_parse_nidlist(char *str, int len, struct list_head *list);
433 int cfs_match_nid(lnet_nid_t nid, struct list_head *list);
435 /** \addtogroup lnet_addr
437 /* how an LNET NID encodes net:address */
438 /** extract the address part of an lnet_nid_t */
439 #define LNET_NIDADDR(nid) ((__u32)((nid) & 0xffffffff))
440 /** extract the network part of an lnet_nid_t */
441 #define LNET_NIDNET(nid) ((__u32)(((nid) >> 32)) & 0xffffffff)
442 /** make an lnet_nid_t from a network part and an address part */
443 #define LNET_MKNID(net,addr) ((((__u64)(net))<<32)|((__u64)(addr)))
444 /* how net encodes type:number */
445 #define LNET_NETNUM(net) ((net) & 0xffff)
446 #define LNET_NETTYP(net) (((net) >> 16) & 0xffff)
447 #define LNET_MKNET(typ,num) ((((__u32)(typ))<<16)|((__u32)(num)))
450 /* max value for numeric network address */
451 #define MAX_NUMERIC_VALUE 0xffffffff
454 #define ergo(a, b) (!(a) || (b))
455 /* logical equivalence */
456 #define equi(a, b) (!!(a) == !!(b))
458 /* --------------------------------------------------------------------
460 * Support for temporary event tracing with minimal Heisenberg effect.
461 * All stuff about lwt are put in arch/kp30.h
462 * -------------------------------------------------------------------- */
464 struct libcfs_device_userstate
466 int ldu_memhog_pages;
467 struct page *ldu_memhog_root_page;
470 /* what used to be in portals_lib.h */
472 # define MIN(a,b) (((a)<(b)) ? (a): (b))
475 # define MAX(a,b) (((a)>(b)) ? (a): (b))
478 #define MKSTR(ptr) ((ptr))? (ptr) : ""
480 static inline int cfs_size_round4 (int val)
482 return (val + 3) & (~0x3);
485 #ifndef HAVE_CFS_SIZE_ROUND
486 static inline int cfs_size_round (int val)
488 return (val + 7) & (~0x7);
490 #define HAVE_CFS_SIZE_ROUND
493 static inline int cfs_size_round16(int val)
495 return (val + 0xf) & (~0xf);
498 static inline int cfs_size_round32(int val)
500 return (val + 0x1f) & (~0x1f);
503 static inline int cfs_size_round0(int val)
507 return (val + 1 + 7) & (~0x7);
510 static inline size_t cfs_round_strlen(char *fset)
512 return (size_t)cfs_size_round((int)strlen(fset) + 1);
515 /* roundup \a val to power2 */
516 static inline unsigned int cfs_power2_roundup(unsigned int val)
518 if (val != LOWEST_BIT_SET(val)) { /* not a power of 2 already */
520 val &= ~LOWEST_BIT_SET(val);
521 } while (val != LOWEST_BIT_SET(val));
522 /* ...and round up */
528 #define LOGL(var,len,ptr) \
531 memcpy((char *)ptr, (const char *)var, len); \
532 ptr += cfs_size_round(len); \
535 #define LOGU(var,len,ptr) \
538 memcpy((char *)var, (const char *)ptr, len); \
539 ptr += cfs_size_round(len); \
542 #define LOGL0(var,len,ptr) \
546 memcpy((char *)ptr, (const char *)var, len); \
547 *((char *)(ptr) + len) = 0; \
548 ptr += cfs_size_round(len + 1); \
552 * Lustre Network Driver types.
555 /* Only add to these values (i.e. don't ever change or redefine them):
556 * network addresses depend on them... */
559 GMLND = 3, /* obsolete, keep it so that libcfs_nid2str works */