libcfs/include/libcfs/libcfs_private.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  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 #ifndef DEBUG_SUBSYSTEM
  46 # define DEBUG_SUBSYSTEM S_UNDEFINED
  47 #endif
  48
  49 #ifdef __KERNEL__
  50
  51 #ifdef LIBCFS_DEBUG
  52
  53 /*
  54  * When this is on, LASSERT macro includes check for assignment used instead
  55  * of equality check, but doesn't have unlikely(). Turn this on from time to
  56  * time to make test-builds. This shouldn't be on for production release.
  57  */
  58 #define LASSERT_CHECKED (0)
  59
  60 #if LASSERT_CHECKED
  61 /*
  62  * Assertion.
  63  *
  64  * Strange construction with empty "then" clause is used to trigger compiler
  65  * warnings on the assertions of the form LASSERT(a = b);
  66  *
  67  * "warning: suggest parentheses around assignment used as truth value"
  68  *
  69  * requires -Wall. Unfortunately this rules out use of likely/unlikely.
  70  */
  71 #define LASSERTF(cond, fmt, ...)                                        \
  72 do {                                                                    \
  73         if (cond)                                                       \
  74                 ;                                                       \
  75         else {                                                          \
  76                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  77                 libcfs_debug_msg(&__msg_data,                           \
  78                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  79                                  ## __VA_ARGS__);                       \
  80                 lbug_with_loc(&__msg_data);                             \
  81         }                                                               \
  82 } while (0)
  83
  84 #define LASSERT(cond) LASSERTF(cond, "\n")
  85
  86 #else /* !LASSERT_CHECKED */
  87
  88 #define LASSERTF(cond, fmt, ...)                                        \
  89 do {                                                                    \
  90         if (unlikely(!(cond))) {                                        \
  91                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  92                 libcfs_debug_msg(&__msg_data,                           \
  93                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  94                                  ## __VA_ARGS__);                       \
  95                 lbug_with_loc(&__msg_data);                             \
  96         }                                                               \
  97 } while (0)
  98
  99 #define LASSERT(cond) LASSERTF(cond, "\n")
 100 #endif /* !LASSERT_CHECKED */
 101 #else /* !LIBCFS_DEBUG */
 102 /* sizeof is to use expression without evaluating it. */
 103 # define LASSERT(e) ((void)sizeof!!(e))
 104 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
 105 #endif /* !LIBCFS_DEBUG */
 106
 107 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 108 /**
 109  * This is for more expensive checks that one doesn't want to be enabled all
 110  * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
 111  * configure option.
 112  */
 113 # define LINVRNT(exp) LASSERT(exp)
 114 #else
 115 # define LINVRNT(exp) ((void)sizeof!!(exp))
 116 #endif
 117
 118 #define KLASSERT(e) LASSERT(e)
 119
 120 void lbug_with_loc(struct libcfs_debug_msg_data *) __attribute__((noreturn));
 121
 122 #define LBUG()                                                          \
 123 do {                                                                    \
 124         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);             \
 125         lbug_with_loc(&msgdata);                                        \
 126 } while(0)
 127
 128 extern atomic_t libcfs_kmemory;
 129 /*
 130  * Memory
 131  */
 132 #ifdef LIBCFS_DEBUG
 133
 134 # define libcfs_kmem_inc(ptr, size)             \
 135 do {                                            \
 136         atomic_add(size, &libcfs_kmemory);      \
 137 } while (0)
 138
 139 # define libcfs_kmem_dec(ptr, size)             \
 140 do {                                            \
 141         atomic_sub(size, &libcfs_kmemory);      \
 142 } while (0)
 143
 144 # define libcfs_kmem_read()                     \
 145         atomic_read(&libcfs_kmemory)
 146
 147 #else
 148 # define libcfs_kmem_inc(ptr, size) do {} while (0)
 149 # define libcfs_kmem_dec(ptr, size) do {} while (0)
 150 # define libcfs_kmem_read()     (0)
 151 #endif /* LIBCFS_DEBUG */
 152
 153 #ifndef LIBCFS_VMALLOC_SIZE
 154 #define LIBCFS_VMALLOC_SIZE        (2 << PAGE_SHIFT) /* 2 pages */
 155 #endif
 156
 157 #define LIBCFS_ALLOC_PRE(size, mask)                                        \
 158 do {                                                                        \
 159         LASSERT(!in_interrupt() ||                                          \
 160                 ((size) <= LIBCFS_VMALLOC_SIZE &&                           \
 161                  ((mask) & GFP_ATOMIC)) != 0);                      \
 162 } while (0)
 163
 164 #define LIBCFS_ALLOC_POST(ptr, size)                                        \
 165 do {                                                                        \
 166         if (unlikely((ptr) == NULL)) {                                      \
 167                 CERROR("LNET: out of memory at %s:%d (tried to alloc '"     \
 168                        #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size));  \
 169                 CERROR("LNET: %d total bytes allocated by lnet\n",          \
 170                        libcfs_kmem_read());                                 \
 171         } else {                                                            \
 172                 libcfs_kmem_inc((ptr), (size));                             \
 173                 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n",  \
 174                        (int)(size), (ptr), libcfs_kmem_read());             \
 175         }                                                                   \
 176 } while (0)
 177
 178 /**
 179  * allocate memory with GFP flags @mask
 180  * The allocated memory is zeroed-out.
 181  */
 182 #define LIBCFS_ALLOC_GFP(ptr, size, mask)                                   \
 183 do {                                                                        \
 184         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 185         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 186                 kzalloc((size), (mask)) : vzalloc(size);                    \
 187         LIBCFS_ALLOC_POST((ptr), (size));                                   \
 188 } while (0)
 189
 190 /**
 191  * default allocator
 192  */
 193 #define LIBCFS_ALLOC(ptr, size) \
 194         LIBCFS_ALLOC_GFP(ptr, size, GFP_NOFS)
 195
 196 /**
 197  * non-sleeping allocator
 198  */
 199 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
 200         LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
 201
 202 /**
 203  * allocate memory for specified CPU partition
 204  *   \a cptab != NULL, \a cpt is CPU partition id of \a cptab
 205  *   \a cptab == NULL, \a cpt is HW NUMA node id
 206  * The allocated memory is zeroed-out.
 207  */
 208 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)                   \
 209 do {                                                                        \
 210         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 211         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 212                 cfs_cpt_malloc((cptab), (cpt), (size), (mask) | __GFP_ZERO) : \
 213                 cfs_cpt_vzalloc((cptab), (cpt), (size));                    \
 214         LIBCFS_ALLOC_POST((ptr), (size));                                   \
 215 } while (0)
 216
 217 /** default numa allocator */
 218 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                             \
 219         LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, GFP_NOFS)
 220
 221 #define LIBCFS_FREE(ptr, size)                                          \
 222 do {                                                                    \
 223         int s = (size);                                                 \
 224         if (unlikely((ptr) == NULL)) {                                  \
 225                 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at "    \
 226                        "%s:%d\n", s, __FILE__, __LINE__);               \
 227                 break;                                                  \
 228         }                                                               \
 229         libcfs_kmem_dec((ptr), s);                                      \
 230         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",     \
 231                s, (ptr), libcfs_kmem_read());                           \
 232         if (unlikely(s > LIBCFS_VMALLOC_SIZE))                          \
 233                 vfree(ptr);                                             \
 234         else                                                            \
 235                 kfree(ptr);                                             \
 236 } while (0)
 237
 238 /******************************************************************************/
 239
 240 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
 241 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
 242 #define ___htonl(x) __cpu_to_be32(x)
 243 #define ___htons(x) __cpu_to_be16(x)
 244 #define ___ntohl(x) __be32_to_cpu(x)
 245 #define ___ntohs(x) __be16_to_cpu(x)
 246 #define htonl(x) ___htonl(x)
 247 #define ntohl(x) ___ntohl(x)
 248 #define htons(x) ___htons(x)
 249 #define ntohs(x) ___ntohs(x)
 250 #endif
 251
 252 void libcfs_debug_dumpstack(struct task_struct *tsk);
 253 void libcfs_run_upcall(char **argv);
 254 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *);
 255 void libcfs_debug_dumplog(void);
 256 int libcfs_debug_init(unsigned long bufsize);
 257 int libcfs_debug_cleanup(void);
 258 int libcfs_debug_clear_buffer(void);
 259 int libcfs_debug_mark_buffer(const char *text);
 260
 261 #else  /* !__KERNEL__ */
 262 # ifdef LIBCFS_DEBUG
 263 #  undef NDEBUG
 264 #  include <assert.h>
 265 #  define LASSERT(e)     assert(e)
 266 #  define LASSERTF(cond, ...)                                                  \
 267 do {                                                                           \
 268           if (!(cond))                                                         \
 269                 CERROR(__VA_ARGS__);                                           \
 270           assert(cond);                                                        \
 271 } while (0)
 272 #  define LBUG()   assert(0)
 273 #  ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 274 #   define LINVRNT(exp) LASSERT(exp)
 275 #  else
 276 #   define LINVRNT(exp) ((void)sizeof!!(exp))
 277 #  endif
 278 # else
 279 #  define LASSERT(e) ((void)sizeof!!(e))
 280 #  define LASSERTF(cond, ...) ((void)sizeof!!(cond))
 281 #  define LBUG()   ((void)(0))
 282 #  define LINVRNT(exp) ((void)sizeof!!(exp))
 283 # endif /* LIBCFS_DEBUG */
 284 # define KLASSERT(e) ((void)0)
 285 # define printk printf
 286 #define LIBCFS_ALLOC_GFP(ptr, size, mask)       \
 287 do {                                            \
 288         (ptr) = calloc(1, size);                \
 289 } while (0)
 290 # define LIBCFS_FREE(ptr, size) do { free(ptr); } while((size) - (size))
 291 # define LIBCFS_ALLOC(ptr, size)                                \
 292          LIBCFS_ALLOC_GFP(ptr, size, 0)
 293 # define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)      \
 294          LIBCFS_ALLOC(ptr, size)
 295 # define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                \
 296          LIBCFS_ALLOC(ptr, size)
 297
 298 void libcfs_debug_dumplog(void);
 299 int libcfs_debug_init(unsigned long bufsize);
 300 int libcfs_debug_cleanup(void);
 301
 302 #define libcfs_debug_dumpstack(tsk)     ((void)0)
 303
 304 /*
 305  * Generic compiler-dependent macros required for kernel
 306  * build go below this comment. Actual compiler/compiler version
 307  * specific implementations come from the above header files
 308  */
 309 #define likely(x)      __builtin_expect(!!(x), 1)
 310 #define unlikely(x)    __builtin_expect(!!(x), 0)
 311 /* !__KERNEL__ */
 312 #endif
 313
 314 /*
 315  * allocate a variable array, returned value is an array of pointers.
 316  * Caller can specify length of array by count.
 317  */
 318 void *cfs_array_alloc(int count, unsigned int size);
 319 void  cfs_array_free(void *vars);
 320
 321 #define LASSERT_ATOMIC_ENABLED          (1)
 322
 323 #if LASSERT_ATOMIC_ENABLED
 324
 325 /** assert value of @a is equal to @v */
 326 #define LASSERT_ATOMIC_EQ(a, v)                                 \
 327 do {                                                            \
 328         LASSERTF(atomic_read(a) == v,                       \
 329                  "value: %d\n", atomic_read((a)));          \
 330 } while (0)
 331
 332 /** assert value of @a is unequal to @v */
 333 #define LASSERT_ATOMIC_NE(a, v)                                 \
 334 do {                                                            \
 335         LASSERTF(atomic_read(a) != v,                       \
 336                  "value: %d\n", atomic_read((a)));          \
 337 } while (0)
 338
 339 /** assert value of @a is little than @v */
 340 #define LASSERT_ATOMIC_LT(a, v)                                 \
 341 do {                                                            \
 342         LASSERTF(atomic_read(a) < v,                        \
 343                  "value: %d\n", atomic_read((a)));          \
 344 } while (0)
 345
 346 /** assert value of @a is little/equal to @v */
 347 #define LASSERT_ATOMIC_LE(a, v)                                 \
 348 do {                                                            \
 349         LASSERTF(atomic_read(a) <= v,                       \
 350                  "value: %d\n", atomic_read((a)));          \
 351 } while (0)
 352
 353 /** assert value of @a is great than @v */
 354 #define LASSERT_ATOMIC_GT(a, v)                                 \
 355 do {                                                            \
 356         LASSERTF(atomic_read(a) > v,                        \
 357                  "value: %d\n", atomic_read((a)));          \
 358 } while (0)
 359
 360 /** assert value of @a is great/equal to @v */
 361 #define LASSERT_ATOMIC_GE(a, v)                                 \
 362 do {                                                            \
 363         LASSERTF(atomic_read(a) >= v,                       \
 364                  "value: %d\n", atomic_read((a)));          \
 365 } while (0)
 366
 367 /** assert value of @a is great than @v1 and little than @v2 */
 368 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)                         \
 369 do {                                                            \
 370         int __v = atomic_read(a);                           \
 371         LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);     \
 372 } while (0)
 373
 374 /** assert value of @a is great than @v1 and little/equal to @v2 */
 375 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)                         \
 376 do {                                                            \
 377         int __v = atomic_read(a);                           \
 378         LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);    \
 379 } while (0)
 380
 381 /** assert value of @a is great/equal to @v1 and little than @v2 */
 382 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)                         \
 383 do {                                                            \
 384         int __v = atomic_read(a);                           \
 385         LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);    \
 386 } while (0)
 387
 388 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
 389 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)                         \
 390 do {                                                            \
 391         int __v = atomic_read(a);                           \
 392         LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v);   \
 393 } while (0)
 394
 395 #else /* !LASSERT_ATOMIC_ENABLED */
 396
 397 #define LASSERT_ATOMIC_EQ(a, v)                 do {} while (0)
 398 #define LASSERT_ATOMIC_NE(a, v)                 do {} while (0)
 399 #define LASSERT_ATOMIC_LT(a, v)                 do {} while (0)
 400 #define LASSERT_ATOMIC_LE(a, v)                 do {} while (0)
 401 #define LASSERT_ATOMIC_GT(a, v)                 do {} while (0)
 402 #define LASSERT_ATOMIC_GE(a, v)                 do {} while (0)
 403 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)         do {} while (0)
 404 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)         do {} while (0)
 405 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)         do {} while (0)
 406 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)         do {} while (0)
 407
 408 #endif /* LASSERT_ATOMIC_ENABLED */
 409
 410 #define LASSERT_ATOMIC_ZERO(a)                  LASSERT_ATOMIC_EQ(a, 0)
 411 #define LASSERT_ATOMIC_POS(a)                   LASSERT_ATOMIC_GT(a, 0)
 412
 413 #define CFS_ALLOC_PTR(ptr)      LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
 414 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof (*(ptr)));
 415
 416 /** Compile-time assertion.
 417
 418  * Check an invariant described by a constant expression at compile time by
 419  * forcing a compiler error if it does not hold.  \a cond must be a constant
 420  * expression as defined by the ISO C Standard:
 421  *
 422  *       6.8.4.2  The switch statement
 423  *       ....
 424  *       [#3] The expression of each case label shall be  an  integer
 425  *       constant   expression  and  no  two  of  the  case  constant
 426  *       expressions in the same switch statement shall have the same
 427  *       value  after  conversion...
 428  *
 429  */
 430 #define CLASSERT(cond) do {switch (1) {case (cond): case 0: break; } } while (0)
 431
 432 /* implication */
 433 #define ergo(a, b) (!(a) || (b))
 434 /* logical equivalence */
 435 #define equi(a, b) (!!(a) == !!(b))
 436
 437 /* what used to be in portals_lib.h */
 438 #ifndef MIN
 439 # define MIN(a,b) (((a)<(b)) ? (a): (b))
 440 #endif
 441 #ifndef MAX
 442 # define MAX(a,b) (((a)>(b)) ? (a): (b))
 443 #endif
 444
 445 #define MKSTR(ptr) ((ptr))? (ptr) : ""
 446
 447 static inline size_t cfs_size_round4(size_t val)
 448 {
 449         return (val + 3) & (~0x3);
 450 }
 451
 452 #ifndef HAVE_CFS_SIZE_ROUND
 453 static inline size_t cfs_size_round(size_t val)
 454 {
 455         return (val + 7) & (~0x7);
 456 }
 457 #define HAVE_CFS_SIZE_ROUND
 458 #endif
 459
 460 static inline size_t cfs_size_round16(size_t val)
 461 {
 462         return (val + 0xf) & (~0xf);
 463 }
 464
 465 static inline size_t cfs_size_round32(size_t val)
 466 {
 467         return (val + 0x1f) & (~0x1f);
 468 }
 469
 470 static inline size_t cfs_size_round0(size_t val)
 471 {
 472         if (!val)
 473                 return 0;
 474         return (val + 1 + 7) & (~0x7);
 475 }
 476
 477 static inline size_t cfs_round_strlen(char *fset)
 478 {
 479         return cfs_size_round(strlen(fset) + 1);
 480 }
 481
 482 #define LOGL(var,len,ptr)                                       \
 483 do {                                                            \
 484         if (var)                                                \
 485                 memcpy((char *)ptr, (const char *)var, len);    \
 486         ptr += cfs_size_round(len);                             \
 487 } while (0)
 488
 489 #define LOGU(var,len,ptr)                                       \
 490 do {                                                            \
 491         if (var)                                                \
 492                 memcpy((char *)var, (const char *)ptr, len);    \
 493         ptr += cfs_size_round(len);                             \
 494 } while (0)
 495
 496 extern struct cfs_psdev_ops libcfs_psdev_ops;
 497 extern struct miscdevice libcfs_dev;
 498 extern struct cfs_wi_sched *cfs_sched_rehash;
 499
 500 #endif