Whamcloud - gitweb
92f98544336b081baadfbd82fe6a5895ecb40dc7
[fs/lustre-release.git] / libcfs / include / libcfs / libcfs_private.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
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.
11  *
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).
17  *
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
21  *
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
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * libcfs/include/libcfs/libcfs_private.h
37  *
38  * Various defines for libcfs.
39  *
40  */
41
42 #ifndef __LIBCFS_PRIVATE_H__
43 #define __LIBCFS_PRIVATE_H__
44
45 /* XXX this layering violation is for nidstrings */
46 #include <lnet/types.h>
47
48 #ifndef DEBUG_SUBSYSTEM
49 # define DEBUG_SUBSYSTEM S_UNDEFINED
50 #endif
51
52 #ifdef __KERNEL__
53
54 #ifdef LIBCFS_DEBUG
55
56 /*
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.
60  */
61 #define LASSERT_CHECKED (0)
62
63 #if LASSERT_CHECKED
64 /*
65  * Assertion.
66  *
67  * Strange construction with empty "then" clause is used to trigger compiler
68  * warnings on the assertions of the form LASSERT(a = b);
69  *
70  * "warning: suggest parentheses around assignment used as truth value"
71  *
72  * requires -Wall. Unfortunately this rules out use of likely/unlikely.
73  */
74 #define LASSERT(cond)                                                   \
75 do {                                                                    \
76         if (cond)                                                       \
77                 ;                                                       \
78         else                                                            \
79                 libcfs_assertion_failed( #cond , __FILE__,              \
80                         __FUNCTION__, __LINE__);                        \
81 } while(0)
82
83 #define LASSERTF(cond, fmt, ...)                                        \
84 do {                                                                    \
85          if (cond)                                                      \
86                  ;                                                      \
87          else {                                                         \
88                  libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG,       \
89                                   __FILE__, __FUNCTION__,__LINE__,      \
90                                   "ASSERTION(" #cond ") failed: " fmt,  \
91                                   ## __VA_ARGS__);                      \
92                  LBUG();                                                \
93          }                                                              \
94 } while(0)
95
96 #else /* !LASSERT_CHECKED */
97
98 #define LASSERT(cond)                                                   \
99 do {                                                                    \
100         if (unlikely(!(cond)))                                          \
101                 libcfs_assertion_failed(#cond , __FILE__,               \
102                         __FUNCTION__, __LINE__);                        \
103 } while(0)
104
105 #define LASSERTF(cond, fmt, ...)                                        \
106 do {                                                                    \
107         if (unlikely(!(cond))) {                                        \
108                 libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG,        \
109                                  __FILE__, __FUNCTION__,__LINE__,       \
110                                  "ASSERTION(" #cond ") failed: " fmt,   \
111                                  ## __VA_ARGS__ );                      \
112                 LBUG();                                                 \
113         }                                                               \
114 } while(0)
115
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 */
122
123 #ifdef INVARIANT_CHECK
124 /**
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
127  * configure option.
128  */
129 # define LINVRNT(exp) LASSERT(exp)
130 #else
131 # define LINVRNT(exp) ((void)sizeof!!(exp))
132 #endif
133
134 #define KLASSERT(e) LASSERT(e)
135
136 void lbug_with_loc(const char *file, const char *func, const int line)
137         __attribute__((noreturn));
138
139 #define LBUG() lbug_with_loc(__FILE__, __FUNCTION__, __LINE__)
140
141 extern cfs_atomic_t libcfs_kmemory;
142 /*
143  * Memory
144  */
145 #ifdef LIBCFS_DEBUG
146
147 # define libcfs_kmem_inc(ptr, size)             \
148 do {                                            \
149         cfs_atomic_add(size, &libcfs_kmemory);  \
150 } while (0)
151
152 # define libcfs_kmem_dec(ptr, size) do {        \
153         cfs_atomic_sub(size, &libcfs_kmemory);  \
154 } while (0)
155
156 #else
157 # define libcfs_kmem_inc(ptr, size) do {} while (0)
158 # define libcfs_kmem_dec(ptr, size) do {} while (0)
159 #endif /* LIBCFS_DEBUG */
160
161 #ifndef LIBCFS_VMALLOC_SIZE
162 #define LIBCFS_VMALLOC_SIZE        (2 << CFS_PAGE_SHIFT) /* 2 pages */
163 #endif
164
165 #define LIBCFS_ALLOC_GFP(ptr, size, mask)                                 \
166 do {                                                                      \
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);                            \
171         else                                                              \
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));                 \
178                 break;                                                    \
179         }                                                                 \
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));    \
184 } while (0)
185
186 #define LIBCFS_ALLOC(ptr, size) \
187         LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_IO)
188
189 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
190         LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_ATOMIC)
191
192 #define LIBCFS_FREE(ptr, size)                                          \
193 do {                                                                    \
194         int s = (size);                                                 \
195         if (unlikely((ptr) == NULL)) {                                  \
196                 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at "    \
197                        "%s:%d\n", s, __FILE__, __LINE__);               \
198                 break;                                                  \
199         }                                                               \
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);                                    \
205         else                                                            \
206                 cfs_free(ptr);                                          \
207 } while (0)
208
209 /******************************************************************************/
210
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)
221 #endif
222
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);
231
232 void libcfs_debug_set_level(unsigned int debug_level);
233
234 #else  /* !__KERNEL__ */
235 # ifdef LIBCFS_DEBUG
236 #  undef NDEBUG
237 #  include <assert.h>
238 #  define LASSERT(e)     assert(e)
239 #  define LASSERTF(cond, ...)                                                  \
240 do {                                                                           \
241           if (!(cond))                                                         \
242                 CERROR(__VA_ARGS__);                                           \
243           assert(cond);                                                        \
244 } while (0)
245 #  define LBUG()   assert(0)
246 #  ifdef INVARIANT_CHECK
247 #   define LINVRNT(exp) LASSERT(exp)
248 #  else
249 #   define LINVRNT(exp) ((void)sizeof!!(exp))
250 #  endif
251 # else
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)               \
261    do {                                         \
262         (ptr) = malloc(size);                   \
263         memset(ptr, 0, size);                   \
264    } while (0)
265 # else
266 #  define LIBCFS_ALLOC(ptr, size) do { (ptr) = calloc(1,size); } while (0)
267 # endif
268 # define LIBCFS_FREE(a, b) do { free(a); } while (0)
269
270 void libcfs_debug_dumplog(void);
271 int libcfs_debug_init(unsigned long bufsize);
272 int libcfs_debug_cleanup(void);
273
274 #define libcfs_debug_dumpstack(tsk)     ((void)0)
275
276 /*
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
280  */
281 #ifdef __GNUC__
282 #define likely(x)      __builtin_expect(!!(x), 1)
283 #define unlikely(x)    __builtin_expect(!!(x), 0)
284 #else
285 #define likely(x)       (!!(x))
286 #define unlikely(x)     (!!(x))
287 #endif
288 /* !__KERNEL__ */
289 #endif
290
291 #define LASSERT_ATOMIC_ENABLED          (1)
292
293 #if LASSERT_ATOMIC_ENABLED
294
295 /** assert value of @a is equal to @v */
296 #define LASSERT_ATOMIC_EQ(a, v)                                 \
297 do {                                                            \
298         LASSERTF(cfs_atomic_read(a) == v,                       \
299                  "value: %d\n", cfs_atomic_read((a)));          \
300 } while (0)
301
302 /** assert value of @a is unequal to @v */
303 #define LASSERT_ATOMIC_NE(a, v)                                 \
304 do {                                                            \
305         LASSERTF(cfs_atomic_read(a) != v,                       \
306                  "value: %d\n", cfs_atomic_read((a)));          \
307 } while (0)
308
309 /** assert value of @a is little than @v */
310 #define LASSERT_ATOMIC_LT(a, v)                                 \
311 do {                                                            \
312         LASSERTF(cfs_atomic_read(a) < v,                        \
313                  "value: %d\n", cfs_atomic_read((a)));          \
314 } while (0)
315
316 /** assert value of @a is little/equal to @v */
317 #define LASSERT_ATOMIC_LE(a, v)                                 \
318 do {                                                            \
319         LASSERTF(cfs_atomic_read(a) <= v,                       \
320                  "value: %d\n", cfs_atomic_read((a)));          \
321 } while (0)
322
323 /** assert value of @a is great than @v */
324 #define LASSERT_ATOMIC_GT(a, v)                                 \
325 do {                                                            \
326         LASSERTF(cfs_atomic_read(a) > v,                        \
327                  "value: %d\n", cfs_atomic_read((a)));          \
328 } while (0)
329
330 /** assert value of @a is great/equal to @v */
331 #define LASSERT_ATOMIC_GE(a, v)                                 \
332 do {                                                            \
333         LASSERTF(cfs_atomic_read(a) >= v,                       \
334                  "value: %d\n", cfs_atomic_read((a)));          \
335 } while (0)
336
337 /** assert value of @a is great than @v1 and little than @v2 */
338 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)                         \
339 do {                                                            \
340         int __v = cfs_atomic_read(a);                           \
341         LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);     \
342 } while (0)
343
344 /** assert value of @a is great than @v1 and little/equal to @v2 */
345 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)                         \
346 do {                                                            \
347         int __v = cfs_atomic_read(a);                           \
348         LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);    \
349 } while (0)
350
351 /** assert value of @a is great/equal to @v1 and little than @v2 */
352 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)                         \
353 do {                                                            \
354         int __v = cfs_atomic_read(a);                           \
355         LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);    \
356 } while (0)
357
358 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
359 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)                         \
360 do {                                                            \
361         int __v = cfs_atomic_read(a);                           \
362         LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v);   \
363 } while (0)
364
365 #else /* !LASSERT_ATOMIC_ENABLED */
366
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)
377
378 #endif /* LASSERT_ATOMIC_ENABLED */
379
380 #define LASSERT_ATOMIC_ZERO(a)                  LASSERT_ATOMIC_EQ(a, 0)
381 #define LASSERT_ATOMIC_POS(a)                   LASSERT_ATOMIC_GT(a, 0)
382
383 #define CFS_ALLOC_PTR(ptr)      LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
384 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof (*(ptr)));
385
386 /** Compile-time assertion.
387
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:
391  *
392  *       6.8.4.2  The switch statement
393  *       ....
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...
398  *
399  */
400 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
401
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);
417
418 /** \addtogroup lnet_addr
419  * @{ */
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)))
431 /** @} lnet_addr */
432
433 /* max value for numeric network address */
434 #define MAX_NUMERIC_VALUE 0xffffffff
435
436 /* implication */
437 #define ergo(a, b) (!(a) || (b))
438 /* logical equivalence */
439 #define equi(a, b) (!!(a) == !!(b))
440
441 #ifndef CFS_CURRENT_TIME
442 # define CFS_CURRENT_TIME time(0)
443 #endif
444
445 /* --------------------------------------------------------------------
446  * Light-weight trace
447  * Support for temporary event tracing with minimal Heisenberg effect.
448  * All stuff about lwt are put in arch/kp30.h
449  * -------------------------------------------------------------------- */
450
451 struct libcfs_device_userstate
452 {
453         int           ldu_memhog_pages;
454         cfs_page_t   *ldu_memhog_root_page;
455 };
456
457 /* what used to be in portals_lib.h */
458 #ifndef MIN
459 # define MIN(a,b) (((a)<(b)) ? (a): (b))
460 #endif
461 #ifndef MAX
462 # define MAX(a,b) (((a)>(b)) ? (a): (b))
463 #endif
464
465 #define MKSTR(ptr) ((ptr))? (ptr) : ""
466
467 static inline int cfs_size_round4 (int val)
468 {
469         return (val + 3) & (~0x3);
470 }
471
472 static inline int cfs_size_round (int val)
473 {
474         return (val + 7) & (~0x7);
475 }
476
477 static inline int cfs_size_round16(int val)
478 {
479         return (val + 0xf) & (~0xf);
480 }
481
482 static inline int cfs_size_round32(int val)
483 {
484         return (val + 0x1f) & (~0x1f);
485 }
486
487 static inline int cfs_size_round0(int val)
488 {
489         if (!val)
490                 return 0;
491         return (val + 1 + 7) & (~0x7);
492 }
493
494 static inline size_t cfs_round_strlen(char *fset)
495 {
496         return (size_t)cfs_size_round((int)strlen(fset) + 1);
497 }
498
499 #define LOGL(var,len,ptr)                                       \
500 do {                                                            \
501         if (var)                                                \
502                 memcpy((char *)ptr, (const char *)var, len);    \
503         ptr += cfs_size_round(len);                             \
504 } while (0)
505
506 #define LOGU(var,len,ptr)                                       \
507 do {                                                            \
508         if (var)                                                \
509                 memcpy((char *)var, (const char *)ptr, len);    \
510         ptr += cfs_size_round(len);                             \
511 } while (0)
512
513 #define LOGL0(var,len,ptr)                              \
514 do {                                                    \
515         if (!len)                                       \
516                 break;                                  \
517         memcpy((char *)ptr, (const char *)var, len);    \
518         *((char *)(ptr) + len) = 0;                     \
519         ptr += cfs_size_round(len + 1);                 \
520 } while (0)
521
522 /**
523  *  Lustre Network Driver types.
524  */
525 enum {
526         /* Only add to these values (i.e. don't ever change or redefine them):
527          * network addresses depend on them... */
528         QSWLND    = 1,
529         SOCKLND   = 2,
530         GMLND     = 3, /* obsolete, keep it so that libcfs_nid2str works */
531         PTLLND    = 4,
532         O2IBLND   = 5,
533         CIBLND    = 6,
534         OPENIBLND = 7,
535         IIBLND    = 8,
536         LOLND     = 9,
537         RALND     = 10,
538         VIBLND    = 11,
539         MXLND     = 12,
540 };
541
542 #endif