1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
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 LASSERT(cond) \
79 libcfs_assertion_failed( #cond , __FILE__, \
80 __FUNCTION__, __LINE__); \
83 #define LASSERTF(cond, fmt, ...) \
88 libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG, \
89 __FILE__, __FUNCTION__,__LINE__, \
90 "ASSERTION(" #cond ") failed: " fmt, \
96 #else /* !LASSERT_CHECKED */
98 #define LASSERT(cond) \
100 if (unlikely(!(cond))) \
101 libcfs_assertion_failed(#cond , __FILE__, \
102 __FUNCTION__, __LINE__); \
105 #define LASSERTF(cond, fmt, ...) \
107 if (unlikely(!(cond))) { \
108 libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG, \
109 __FILE__, __FUNCTION__,__LINE__, \
110 "ASSERTION(" #cond ") failed: " fmt, \
116 #endif /* !LASSERT_CHECKED */
117 #else /* !LIBCFS_DEBUG */
118 /* sizeof is to use expression without evaluating it. */
119 # define LASSERT(e) ((void)sizeof!!(e))
120 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
121 #endif /* !LIBCFS_DEBUG */
123 #ifdef INVARIANT_CHECK
125 * This is for more expensive checks that one doesn't want to be enabled all
126 * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
129 # define LINVRNT(exp) LASSERT(exp)
131 # define LINVRNT(exp) ((void)sizeof!!(exp))
134 #define KLASSERT(e) LASSERT(e)
136 void lbug_with_loc(const char *file, const char *func, const int line)
137 __attribute__((noreturn));
139 #define LBUG() lbug_with_loc(__FILE__, __FUNCTION__, __LINE__)
141 extern cfs_atomic_t libcfs_kmemory;
147 # define libcfs_kmem_inc(ptr, size) \
149 cfs_atomic_add(size, &libcfs_kmemory); \
152 # define libcfs_kmem_dec(ptr, size) do { \
153 cfs_atomic_sub(size, &libcfs_kmemory); \
157 # define libcfs_kmem_inc(ptr, size) do {} while (0)
158 # define libcfs_kmem_dec(ptr, size) do {} while (0)
159 #endif /* LIBCFS_DEBUG */
161 #ifndef LIBCFS_VMALLOC_SIZE
162 #define LIBCFS_VMALLOC_SIZE (2 << CFS_PAGE_SHIFT) /* 2 pages */
165 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \
167 LASSERT(!cfs_in_interrupt() || \
168 (size <= LIBCFS_VMALLOC_SIZE && mask == CFS_ALLOC_ATOMIC));\
169 if (unlikely((size) > LIBCFS_VMALLOC_SIZE)) \
170 (ptr) = cfs_alloc_large(size); \
172 (ptr) = cfs_alloc((size), (mask)); \
173 if (unlikely((ptr) == NULL)) { \
174 CERROR("LNET: out of memory at %s:%d (tried to alloc '" \
175 #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size));\
176 CERROR("LNET: %d total bytes allocated by lnet\n", \
177 cfs_atomic_read(&libcfs_kmemory)); \
180 libcfs_kmem_inc((ptr), (size)); \
181 memset((ptr), 0, (size)); \
182 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d).\n", \
183 (int)(size), (ptr), cfs_atomic_read (&libcfs_kmemory)); \
186 #define LIBCFS_ALLOC(ptr, size) \
187 LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_IO)
189 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
190 LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_ATOMIC)
192 #define LIBCFS_FREE(ptr, size) \
195 if (unlikely((ptr) == NULL)) { \
196 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \
197 "%s:%d\n", s, __FILE__, __LINE__); \
200 libcfs_kmem_dec((ptr), s); \
201 CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n", \
202 s, (ptr), cfs_atomic_read(&libcfs_kmemory)); \
203 if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \
204 cfs_free_large(ptr); \
209 /******************************************************************************/
211 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
212 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
213 #define ___htonl(x) __cpu_to_be32(x)
214 #define ___htons(x) __cpu_to_be16(x)
215 #define ___ntohl(x) __be32_to_cpu(x)
216 #define ___ntohs(x) __be16_to_cpu(x)
217 #define htonl(x) ___htonl(x)
218 #define ntohl(x) ___ntohl(x)
219 #define htons(x) ___htons(x)
220 #define ntohs(x) ___ntohs(x)
223 void libcfs_debug_dumpstack(cfs_task_t *tsk);
224 void libcfs_run_upcall(char **argv);
225 void libcfs_run_lbug_upcall(const char * file, const char *fn, const int line);
226 void libcfs_debug_dumplog(void);
227 int libcfs_debug_init(unsigned long bufsize);
228 int libcfs_debug_cleanup(void);
229 int libcfs_debug_clear_buffer(void);
230 int libcfs_debug_mark_buffer(const char *text);
232 void libcfs_debug_set_level(unsigned int debug_level);
234 #else /* !__KERNEL__ */
238 # define LASSERT(e) assert(e)
239 # define LASSERTF(cond, ...) \
242 CERROR(__VA_ARGS__); \
245 # define LBUG() assert(0)
246 # ifdef INVARIANT_CHECK
247 # define LINVRNT(exp) LASSERT(exp)
249 # define LINVRNT(exp) ((void)sizeof!!(exp))
252 # define LASSERT(e) ((void)sizeof!!(e))
253 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
254 # define LBUG() ((void)(0))
255 # define LINVRNT(exp) ((void)sizeof!!(exp))
256 # endif /* LIBCFS_DEBUG */
257 # define KLASSERT(e) ((void)0)
258 # define printk printf
259 # ifdef CRAY_XT3 /* buggy calloc! */
260 # define LIBCFS_ALLOC(ptr, size) \
262 (ptr) = malloc(size); \
263 memset(ptr, 0, size); \
266 # define LIBCFS_ALLOC(ptr, size) do { (ptr) = calloc(1,size); } while (0)
268 # define LIBCFS_FREE(a, b) do { free(a); } while (0)
270 void libcfs_debug_dumplog(void);
271 int libcfs_debug_init(unsigned long bufsize);
272 int libcfs_debug_cleanup(void);
274 #define libcfs_debug_dumpstack(tsk) ((void)0)
277 * Generic compiler-dependent macros required for kernel
278 * build go below this comment. Actual compiler/compiler version
279 * specific implementations come from the above header files
282 #define likely(x) __builtin_expect(!!(x), 1)
283 #define unlikely(x) __builtin_expect(!!(x), 0)
285 #define likely(x) (!!(x))
286 #define unlikely(x) (!!(x))
291 #define LASSERT_ATOMIC_ENABLED (1)
293 #if LASSERT_ATOMIC_ENABLED
295 /** assert value of @a is equal to @v */
296 #define LASSERT_ATOMIC_EQ(a, v) \
298 LASSERTF(cfs_atomic_read(a) == v, \
299 "value: %d\n", cfs_atomic_read((a))); \
302 /** assert value of @a is unequal to @v */
303 #define LASSERT_ATOMIC_NE(a, v) \
305 LASSERTF(cfs_atomic_read(a) != v, \
306 "value: %d\n", cfs_atomic_read((a))); \
309 /** assert value of @a is little than @v */
310 #define LASSERT_ATOMIC_LT(a, v) \
312 LASSERTF(cfs_atomic_read(a) < v, \
313 "value: %d\n", cfs_atomic_read((a))); \
316 /** assert value of @a is little/equal to @v */
317 #define LASSERT_ATOMIC_LE(a, v) \
319 LASSERTF(cfs_atomic_read(a) <= v, \
320 "value: %d\n", cfs_atomic_read((a))); \
323 /** assert value of @a is great than @v */
324 #define LASSERT_ATOMIC_GT(a, v) \
326 LASSERTF(cfs_atomic_read(a) > v, \
327 "value: %d\n", cfs_atomic_read((a))); \
330 /** assert value of @a is great/equal to @v */
331 #define LASSERT_ATOMIC_GE(a, v) \
333 LASSERTF(cfs_atomic_read(a) >= v, \
334 "value: %d\n", cfs_atomic_read((a))); \
337 /** assert value of @a is great than @v1 and little than @v2 */
338 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) \
340 int __v = cfs_atomic_read(a); \
341 LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v); \
344 /** assert value of @a is great than @v1 and little/equal to @v2 */
345 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) \
347 int __v = cfs_atomic_read(a); \
348 LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v); \
351 /** assert value of @a is great/equal to @v1 and little than @v2 */
352 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) \
354 int __v = cfs_atomic_read(a); \
355 LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v); \
358 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
359 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) \
361 int __v = cfs_atomic_read(a); \
362 LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v); \
365 #else /* !LASSERT_ATOMIC_ENABLED */
367 #define LASSERT_ATOMIC_EQ(a, v) do {} while (0)
368 #define LASSERT_ATOMIC_NE(a, v) do {} while (0)
369 #define LASSERT_ATOMIC_LT(a, v) do {} while (0)
370 #define LASSERT_ATOMIC_LE(a, v) do {} while (0)
371 #define LASSERT_ATOMIC_GT(a, v) do {} while (0)
372 #define LASSERT_ATOMIC_GE(a, v) do {} while (0)
373 #define LASSERT_ATOMIC_GT_LT(a, v1, v2) do {} while (0)
374 #define LASSERT_ATOMIC_GT_LE(a, v1, v2) do {} while (0)
375 #define LASSERT_ATOMIC_GE_LT(a, v1, v2) do {} while (0)
376 #define LASSERT_ATOMIC_GE_LE(a, v1, v2) do {} while (0)
378 #endif /* LASSERT_ATOMIC_ENABLED */
380 #define LASSERT_ATOMIC_ZERO(a) LASSERT_ATOMIC_EQ(a, 0)
381 #define LASSERT_ATOMIC_POS(a) LASSERT_ATOMIC_GT(a, 0)
383 #define CFS_ALLOC_PTR(ptr) LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
384 #define CFS_FREE_PTR(ptr) LIBCFS_FREE(ptr, sizeof (*(ptr)));
386 /** Compile-time assertion.
388 * Check an invariant described by a constant expression at compile time by
389 * forcing a compiler error if it does not hold. \a cond must be a constant
390 * expression as defined by the ISO C Standard:
392 * 6.8.4.2 The switch statement
394 * [#3] The expression of each case label shall be an integer
395 * constant expression and no two of the case constant
396 * expressions in the same switch statement shall have the same
397 * value after conversion...
400 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
402 /* support decl needed both by kernel and liblustre */
403 int libcfs_isknown_lnd(int type);
404 char *libcfs_lnd2modname(int type);
405 char *libcfs_lnd2str(int type);
406 int libcfs_str2lnd(const char *str);
407 char *libcfs_net2str(__u32 net);
408 char *libcfs_nid2str(lnet_nid_t nid);
409 __u32 libcfs_str2net(const char *str);
410 lnet_nid_t libcfs_str2nid(const char *str);
411 int libcfs_str2anynid(lnet_nid_t *nid, const char *str);
412 char *libcfs_id2str(lnet_process_id_t id);
413 int cfs_iswhite(char c);
414 void cfs_free_nidlist(cfs_list_t *list);
415 int cfs_parse_nidlist(char *str, int len, cfs_list_t *list);
416 int cfs_match_nid(lnet_nid_t nid, cfs_list_t *list);
418 /** \addtogroup lnet_addr
420 /* how an LNET NID encodes net:address */
421 /** extract the address part of an lnet_nid_t */
422 #define LNET_NIDADDR(nid) ((__u32)((nid) & 0xffffffff))
423 /** extract the network part of an lnet_nid_t */
424 #define LNET_NIDNET(nid) ((__u32)(((nid) >> 32)) & 0xffffffff)
425 /** make an lnet_nid_t from a network part and an address part */
426 #define LNET_MKNID(net,addr) ((((__u64)(net))<<32)|((__u64)(addr)))
427 /* how net encodes type:number */
428 #define LNET_NETNUM(net) ((net) & 0xffff)
429 #define LNET_NETTYP(net) (((net) >> 16) & 0xffff)
430 #define LNET_MKNET(typ,num) ((((__u32)(typ))<<16)|((__u32)(num)))
433 /* max value for numeric network address */
434 #define MAX_NUMERIC_VALUE 0xffffffff
437 #define ergo(a, b) (!(a) || (b))
438 /* logical equivalence */
439 #define equi(a, b) (!!(a) == !!(b))
441 #ifndef CFS_CURRENT_TIME
442 # define CFS_CURRENT_TIME time(0)
445 /* --------------------------------------------------------------------
447 * Support for temporary event tracing with minimal Heisenberg effect.
448 * All stuff about lwt are put in arch/kp30.h
449 * -------------------------------------------------------------------- */
451 struct libcfs_device_userstate
453 int ldu_memhog_pages;
454 cfs_page_t *ldu_memhog_root_page;
457 /* what used to be in portals_lib.h */
459 # define MIN(a,b) (((a)<(b)) ? (a): (b))
462 # define MAX(a,b) (((a)>(b)) ? (a): (b))
465 #define MKSTR(ptr) ((ptr))? (ptr) : ""
467 static inline int cfs_size_round4 (int val)
469 return (val + 3) & (~0x3);
472 static inline int cfs_size_round (int val)
474 return (val + 7) & (~0x7);
477 static inline int cfs_size_round16(int val)
479 return (val + 0xf) & (~0xf);
482 static inline int cfs_size_round32(int val)
484 return (val + 0x1f) & (~0x1f);
487 static inline int cfs_size_round0(int val)
491 return (val + 1 + 7) & (~0x7);
494 static inline size_t cfs_round_strlen(char *fset)
496 return (size_t)cfs_size_round((int)strlen(fset) + 1);
499 #define LOGL(var,len,ptr) \
502 memcpy((char *)ptr, (const char *)var, len); \
503 ptr += cfs_size_round(len); \
506 #define LOGU(var,len,ptr) \
509 memcpy((char *)var, (const char *)ptr, len); \
510 ptr += cfs_size_round(len); \
513 #define LOGL0(var,len,ptr) \
517 memcpy((char *)ptr, (const char *)var, len); \
518 *((char *)(ptr) + len) = 0; \
519 ptr += cfs_size_round(len + 1); \
523 * Lustre Network Driver types.
526 /* Only add to these values (i.e. don't ever change or redefine them):
527 * network addresses depend on them... */
530 GMLND = 3, /* obsolete, keep it so that libcfs_nid2str works */