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, Whamcloud, Inc.
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 <lnet/types.h>
48 #ifndef DEBUG_SUBSYSTEM
49 # define DEBUG_SUBSYSTEM S_UNDEFINED
57 * When this is on, LASSERT macro includes check for assignment used instead
58 * of equality check, but doesn't have unlikely(). Turn this on from time to
59 * time to make test-builds. This shouldn't be on for production release.
61 #define LASSERT_CHECKED (0)
67 * Strange construction with empty "then" clause is used to trigger compiler
68 * warnings on the assertions of the form LASSERT(a = b);
70 * "warning: suggest parentheses around assignment used as truth value"
72 * requires -Wall. Unfortunately this rules out use of likely/unlikely.
74 #define LASSERTF(cond, fmt, ...) \
79 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
80 libcfs_debug_msg(&msgdata, \
81 "ASSERTION( %s ) failed: " fmt, #cond, \
87 #define LASSERT(cond) LASSERTF(cond, "\n")
89 #else /* !LASSERT_CHECKED */
91 #define LASSERTF(cond, fmt, ...) \
93 if (unlikely(!(cond))) { \
94 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
95 libcfs_debug_msg(&msgdata, \
96 "ASSERTION( %s ) failed: " fmt, #cond, \
102 #define LASSERT(cond) LASSERTF(cond, "\n")
103 #endif /* !LASSERT_CHECKED */
104 #else /* !LIBCFS_DEBUG */
105 /* sizeof is to use expression without evaluating it. */
106 # define LASSERT(e) ((void)sizeof!!(e))
107 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
108 #endif /* !LIBCFS_DEBUG */
110 #ifdef INVARIANT_CHECK
112 * This is for more expensive checks that one doesn't want to be enabled all
113 * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
116 # define LINVRNT(exp) LASSERT(exp)
118 # define LINVRNT(exp) ((void)sizeof!!(exp))
121 #define KLASSERT(e) LASSERT(e)
123 void lbug_with_loc(struct libcfs_debug_msg_data *) __attribute__((noreturn));
127 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
128 lbug_with_loc(&msgdata); \
131 extern cfs_atomic_t libcfs_kmemory;
137 # define libcfs_kmem_inc(ptr, size) \
139 cfs_atomic_add(size, &libcfs_kmemory); \
142 # define libcfs_kmem_dec(ptr, size) \
144 cfs_atomic_sub(size, &libcfs_kmemory); \
147 # define libcfs_kmem_read() \
148 cfs_atomic_read(&libcfs_kmemory)
151 # define libcfs_kmem_inc(ptr, size) do {} while (0)
152 # define libcfs_kmem_dec(ptr, size) do {} while (0)
153 # define libcfs_kmem_read() (0)
154 #endif /* LIBCFS_DEBUG */
156 #ifndef LIBCFS_VMALLOC_SIZE
157 #define LIBCFS_VMALLOC_SIZE (2 << CFS_PAGE_SHIFT) /* 2 pages */
160 #define LIBCFS_ALLOC_PRE(size, mask) \
162 LASSERT(!cfs_in_interrupt() || \
163 ((size) <= LIBCFS_VMALLOC_SIZE && \
164 ((mask) & CFS_ALLOC_ATOMIC)) != 0); \
167 #define LIBCFS_ALLOC_POST(ptr, size) \
169 if (unlikely((ptr) == NULL)) { \
170 CERROR("LNET: out of memory at %s:%d (tried to alloc '" \
171 #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size)); \
172 CERROR("LNET: %d total bytes allocated by lnet\n", \
173 libcfs_kmem_read()); \
175 memset((ptr), 0, (size)); \
176 libcfs_kmem_inc((ptr), (size)); \
177 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n", \
178 (int)(size), (ptr), libcfs_kmem_read()); \
183 * allocate memory with GFP flags @mask
185 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
187 LIBCFS_ALLOC_PRE((size), (mask)); \
188 (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ? \
189 cfs_alloc((size), (mask)) : cfs_alloc_large(size); \
190 LIBCFS_ALLOC_POST((ptr), (size)); \
196 #define LIBCFS_ALLOC(ptr, size) \
197 LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_IO)
200 * non-sleeping allocator
202 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
203 LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_ATOMIC)
206 * allocate memory for specified CPU partition
207 * \a cptab != NULL, \a cpt is CPU partition id of \a cptab
208 * \a cptab == NULL, \a cpt is HW NUMA node id
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)) : \
215 cfs_cpt_vmalloc((cptab), (cpt), (size)); \
216 LIBCFS_ALLOC_POST((ptr), (size)); \
219 /** default numa allocator */
220 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size) \
221 LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, CFS_ALLOC_IO)
223 #define LIBCFS_FREE(ptr, size) \
226 if (unlikely((ptr) == NULL)) { \
227 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \
228 "%s:%d\n", s, __FILE__, __LINE__); \
231 libcfs_kmem_dec((ptr), s); \
232 CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n", \
233 s, (ptr), libcfs_kmem_read()); \
234 if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \
235 cfs_free_large(ptr); \
240 /******************************************************************************/
242 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
243 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
244 #define ___htonl(x) __cpu_to_be32(x)
245 #define ___htons(x) __cpu_to_be16(x)
246 #define ___ntohl(x) __be32_to_cpu(x)
247 #define ___ntohs(x) __be16_to_cpu(x)
248 #define htonl(x) ___htonl(x)
249 #define ntohl(x) ___ntohl(x)
250 #define htons(x) ___htons(x)
251 #define ntohs(x) ___ntohs(x)
254 void libcfs_debug_dumpstack(cfs_task_t *tsk);
255 void libcfs_run_upcall(char **argv);
256 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *);
257 void libcfs_debug_dumplog(void);
258 int libcfs_debug_init(unsigned long bufsize);
259 int libcfs_debug_cleanup(void);
260 int libcfs_debug_clear_buffer(void);
261 int libcfs_debug_mark_buffer(const char *text);
263 void libcfs_debug_set_level(unsigned int debug_level);
265 #else /* !__KERNEL__ */
269 # define LASSERT(e) assert(e)
270 # define LASSERTF(cond, ...) \
273 CERROR(__VA_ARGS__); \
276 # define LBUG() assert(0)
277 # ifdef INVARIANT_CHECK
278 # define LINVRNT(exp) LASSERT(exp)
280 # define LINVRNT(exp) ((void)sizeof!!(exp))
283 # define LASSERT(e) ((void)sizeof!!(e))
284 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
285 # define LBUG() ((void)(0))
286 # define LINVRNT(exp) ((void)sizeof!!(exp))
287 # endif /* LIBCFS_DEBUG */
288 # define KLASSERT(e) ((void)0)
289 # define printk printf
290 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
292 (ptr) = calloc(1, size); \
294 # define LIBCFS_FREE(ptr, size) do { free(ptr); } while((size) - (size))
295 # define LIBCFS_ALLOC(ptr, size) \
296 LIBCFS_ALLOC_GFP(ptr, size, 0)
297 # define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask) \
298 LIBCFS_ALLOC(ptr, size)
299 # define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size) \
300 LIBCFS_ALLOC(ptr, size)
302 void libcfs_debug_dumplog(void);
303 int libcfs_debug_init(unsigned long bufsize);
304 int libcfs_debug_cleanup(void);
306 #define libcfs_debug_dumpstack(tsk) ((void)0)
309 * Generic compiler-dependent macros required for kernel
310 * build go below this comment. Actual compiler/compiler version
311 * specific implementations come from the above header files
314 #define likely(x) __builtin_expect(!!(x), 1)
315 #define unlikely(x) __builtin_expect(!!(x), 0)
317 #define likely(x) (!!(x))
318 #define unlikely(x) (!!(x))
324 * allocate per-cpu-partition data, returned value is an array of pointers,
325 * variable can be indexed by CPU ID.
326 * cptable != NULL: size of array is number of CPU partitions
327 * cptable == NULL: size of array is number of HW cores
329 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
331 * destory per-cpu-partition variable
333 void cfs_percpt_free(void *vars);
334 int cfs_percpt_number(void *vars);
335 void *cfs_percpt_current(void *vars);
336 void *cfs_percpt_index(void *vars, int idx);
338 #define cfs_percpt_for_each(var, i, vars) \
339 for (i = 0; i < cfs_percpt_number(vars) && \
340 ((var) = (vars)[i]) != NULL; i++)
343 * allocate a variable array, returned value is an array of pointers.
344 * Caller can specify length of array by count.
346 void *cfs_array_alloc(int count, unsigned int size);
347 void cfs_array_free(void *vars);
349 #define LASSERT_ATOMIC_ENABLED (1)
351 #if LASSERT_ATOMIC_ENABLED
353 /** assert value of @a is equal to @v */
354 #define LASSERT_ATOMIC_EQ(a, v) \
356 LASSERTF(cfs_atomic_read(a) == v, \
357 "value: %d\n", cfs_atomic_read((a))); \
360 /** assert value of @a is unequal to @v */
361 #define LASSERT_ATOMIC_NE(a, v) \
363 LASSERTF(cfs_atomic_read(a) != v, \
364 "value: %d\n", cfs_atomic_read((a))); \
367 /** assert value of @a is little than @v */
368 #define LASSERT_ATOMIC_LT(a, v) \
370 LASSERTF(cfs_atomic_read(a) < v, \
371 "value: %d\n", cfs_atomic_read((a))); \
374 /** assert value of @a is little/equal to @v */
375 #define LASSERT_ATOMIC_LE(a, v) \
377 LASSERTF(cfs_atomic_read(a) <= v, \
378 "value: %d\n", cfs_atomic_read((a))); \
381 /** assert value of @a is great than @v */
382 #define LASSERT_ATOMIC_GT(a, v) \
384 LASSERTF(cfs_atomic_read(a) > v, \
385 "value: %d\n", cfs_atomic_read((a))); \
388 /** assert value of @a is great/equal to @v */
389 #define LASSERT_ATOMIC_GE(a, v) \
391 LASSERTF(cfs_atomic_read(a) >= v, \
392 "value: %d\n", cfs_atomic_read((a))); \
395 /** assert value of @a is great than @v1 and little than @v2 */
396 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) \
398 int __v = cfs_atomic_read(a); \
399 LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v); \
402 /** assert value of @a is great than @v1 and little/equal to @v2 */
403 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) \
405 int __v = cfs_atomic_read(a); \
406 LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v); \
409 /** assert value of @a is great/equal to @v1 and little than @v2 */
410 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) \
412 int __v = cfs_atomic_read(a); \
413 LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v); \
416 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
417 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) \
419 int __v = cfs_atomic_read(a); \
420 LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v); \
423 #else /* !LASSERT_ATOMIC_ENABLED */
425 #define LASSERT_ATOMIC_EQ(a, v) do {} while (0)
426 #define LASSERT_ATOMIC_NE(a, v) do {} while (0)
427 #define LASSERT_ATOMIC_LT(a, v) do {} while (0)
428 #define LASSERT_ATOMIC_LE(a, v) do {} while (0)
429 #define LASSERT_ATOMIC_GT(a, v) do {} while (0)
430 #define LASSERT_ATOMIC_GE(a, v) do {} while (0)
431 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) do {} while (0)
432 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) do {} while (0)
433 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) do {} while (0)
434 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) do {} while (0)
436 #endif /* LASSERT_ATOMIC_ENABLED */
438 #define LASSERT_ATOMIC_ZERO(a) LASSERT_ATOMIC_EQ(a, 0)
439 #define LASSERT_ATOMIC_POS(a) LASSERT_ATOMIC_GT(a, 0)
441 #define CFS_ALLOC_PTR(ptr) LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
442 #define CFS_FREE_PTR(ptr) LIBCFS_FREE(ptr, sizeof (*(ptr)));
445 * percpu partition lock
447 * There are some use-cases like this in Lustre:
448 * . each CPU partition has it's own private data which is frequently changed,
449 * and mostly by the local CPU partition.
450 * . all CPU partitions share some global data, these data are rarely changed.
452 * LNet is typical example.
453 * CPU partition lock is designed for this kind of use-cases:
454 * . each CPU partition has it's own private lock
455 * . change on private data just needs to take the private lock
456 * . read on shared data just needs to take _any_ of private locks
457 * . change on shared data needs to take _all_ private locks,
458 * which is slow and should be really rare.
462 CFS_PERCPT_LOCK_EX = -1, /* negative */
467 struct cfs_percpt_lock {
468 /* cpu-partition-table for this lock */
469 struct cfs_cpt_table *pcl_cptab;
470 /* exclusively locked */
471 unsigned int pcl_locked;
472 /* private lock table */
473 cfs_spinlock_t **pcl_locks;
476 /* return number of private locks */
478 cfs_percpt_lock_num(struct cfs_percpt_lock *pcl)
480 return cfs_cpt_number(pcl->pcl_cptab);
483 #else /* !__KERNEL__ */
485 # ifdef HAVE_LIBPTHREAD
487 struct cfs_percpt_lock {
488 pthread_mutex_t pcl_mutex;
491 # else /* !HAVE_LIBPTHREAD */
492 #define CFS_PERCPT_LOCK_MAGIC 0xbabecafe;
494 struct cfs_percpt_lock {
497 # endif /* HAVE_LIBPTHREAD */
498 # define cfs_percpt_lock_num(pcl) 1
499 #endif /* __KERNEL__ */
502 * create a cpu-partition lock based on CPU partition table \a cptab,
503 * each private lock has extra \a psize bytes padding data
505 struct cfs_percpt_lock *cfs_percpt_lock_alloc(struct cfs_cpt_table *cptab);
506 /* destroy a cpu-partition lock */
507 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
509 /* lock private lock \a index of \a pcl */
510 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
511 /* unlock private lock \a index of \a pcl */
512 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
513 /* create percpt (atomic) refcount based on @cptab */
514 cfs_atomic_t **cfs_percpt_atomic_alloc(struct cfs_cpt_table *cptab, int val);
515 /* destroy percpt refcount */
516 void cfs_percpt_atomic_free(cfs_atomic_t **refs);
517 /* return sum of all percpu refs */
518 int cfs_percpt_atomic_summary(cfs_atomic_t **refs);
521 /** Compile-time assertion.
523 * Check an invariant described by a constant expression at compile time by
524 * forcing a compiler error if it does not hold. \a cond must be a constant
525 * expression as defined by the ISO C Standard:
527 * 6.8.4.2 The switch statement
529 * [#3] The expression of each case label shall be an integer
530 * constant expression and no two of the case constant
531 * expressions in the same switch statement shall have the same
532 * value after conversion...
535 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
537 /* support decl needed both by kernel and liblustre */
538 int libcfs_isknown_lnd(int type);
539 char *libcfs_lnd2modname(int type);
540 char *libcfs_lnd2str(int type);
541 int libcfs_str2lnd(const char *str);
542 char *libcfs_net2str(__u32 net);
543 char *libcfs_nid2str(lnet_nid_t nid);
544 __u32 libcfs_str2net(const char *str);
545 lnet_nid_t libcfs_str2nid(const char *str);
546 int libcfs_str2anynid(lnet_nid_t *nid, const char *str);
547 char *libcfs_id2str(lnet_process_id_t id);
548 void cfs_free_nidlist(cfs_list_t *list);
549 int cfs_parse_nidlist(char *str, int len, cfs_list_t *list);
550 int cfs_match_nid(lnet_nid_t nid, cfs_list_t *list);
552 /** \addtogroup lnet_addr
554 /* how an LNET NID encodes net:address */
555 /** extract the address part of an lnet_nid_t */
556 #define LNET_NIDADDR(nid) ((__u32)((nid) & 0xffffffff))
557 /** extract the network part of an lnet_nid_t */
558 #define LNET_NIDNET(nid) ((__u32)(((nid) >> 32)) & 0xffffffff)
559 /** make an lnet_nid_t from a network part and an address part */
560 #define LNET_MKNID(net,addr) ((((__u64)(net))<<32)|((__u64)(addr)))
561 /* how net encodes type:number */
562 #define LNET_NETNUM(net) ((net) & 0xffff)
563 #define LNET_NETTYP(net) (((net) >> 16) & 0xffff)
564 #define LNET_MKNET(typ,num) ((((__u32)(typ))<<16)|((__u32)(num)))
567 /* max value for numeric network address */
568 #define MAX_NUMERIC_VALUE 0xffffffff
571 #define ergo(a, b) (!(a) || (b))
572 /* logical equivalence */
573 #define equi(a, b) (!!(a) == !!(b))
575 #ifndef CFS_CURRENT_TIME
576 # define CFS_CURRENT_TIME time(0)
579 /* --------------------------------------------------------------------
581 * Support for temporary event tracing with minimal Heisenberg effect.
582 * All stuff about lwt are put in arch/kp30.h
583 * -------------------------------------------------------------------- */
585 struct libcfs_device_userstate
587 int ldu_memhog_pages;
588 cfs_page_t *ldu_memhog_root_page;
591 /* what used to be in portals_lib.h */
593 # define MIN(a,b) (((a)<(b)) ? (a): (b))
596 # define MAX(a,b) (((a)>(b)) ? (a): (b))
599 #define MKSTR(ptr) ((ptr))? (ptr) : ""
601 static inline int cfs_size_round4 (int val)
603 return (val + 3) & (~0x3);
606 #ifndef HAVE_CFS_SIZE_ROUND
607 static inline int cfs_size_round (int val)
609 return (val + 7) & (~0x7);
611 #define HAVE_CFS_SIZE_ROUND
614 static inline int cfs_size_round16(int val)
616 return (val + 0xf) & (~0xf);
619 static inline int cfs_size_round32(int val)
621 return (val + 0x1f) & (~0x1f);
624 static inline int cfs_size_round0(int val)
628 return (val + 1 + 7) & (~0x7);
631 static inline size_t cfs_round_strlen(char *fset)
633 return (size_t)cfs_size_round((int)strlen(fset) + 1);
636 /* roundup \a val to power2 */
637 static inline unsigned int cfs_power2_roundup(unsigned int val)
639 if (val != LOWEST_BIT_SET(val)) { /* not a power of 2 already */
641 val &= ~LOWEST_BIT_SET(val);
642 } while (val != LOWEST_BIT_SET(val));
643 /* ...and round up */
649 #define LOGL(var,len,ptr) \
652 memcpy((char *)ptr, (const char *)var, len); \
653 ptr += cfs_size_round(len); \
656 #define LOGU(var,len,ptr) \
659 memcpy((char *)var, (const char *)ptr, len); \
660 ptr += cfs_size_round(len); \
663 #define LOGL0(var,len,ptr) \
667 memcpy((char *)ptr, (const char *)var, len); \
668 *((char *)(ptr) + len) = 0; \
669 ptr += cfs_size_round(len + 1); \
673 * Lustre Network Driver types.
676 /* Only add to these values (i.e. don't ever change or redefine them):
677 * network addresses depend on them... */
680 GMLND = 3, /* obsolete, keep it so that libcfs_nid2str works */