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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * libcfs/include/libcfs/libcfs_private.h
  32  *
  33  * Various defines for libcfs.
  34  *
  35  */
  36
  37 #ifndef __LIBCFS_PRIVATE_H__
  38 #define __LIBCFS_PRIVATE_H__
  39
  40 #ifndef DEBUG_SUBSYSTEM
  41 # define DEBUG_SUBSYSTEM S_UNDEFINED
  42 #endif
  43
  44 #include <linux/slab.h>
  45 #include <linux/vmalloc.h>
  46
  47 #ifdef LIBCFS_DEBUG
  48
  49 /*
  50  * When this is on, LASSERT macro includes check for assignment used instead
  51  * of equality check, but doesn't have unlikely(). Turn this on from time to
  52  * time to make test-builds. This shouldn't be on for production release.
  53  */
  54 #define LASSERT_CHECKED (0)
  55
  56 #if LASSERT_CHECKED
  57 /*
  58  * Assertion.
  59  *
  60  * Strange construction with empty "then" clause is used to trigger compiler
  61  * warnings on the assertions of the form LASSERT(a = b);
  62  *
  63  * "warning: suggest parentheses around assignment used as truth value"
  64  *
  65  * requires -Wall. Unfortunately this rules out use of likely/unlikely.
  66  */
  67 #define LASSERTF(cond, fmt, ...)                                        \
  68 do {                                                                    \
  69         if (cond)                                                       \
  70                 ;                                                       \
  71         else {                                                          \
  72                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  73                 libcfs_debug_msg(&__msg_data,                           \
  74                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  75                                  ## __VA_ARGS__);                       \
  76                 lbug_with_loc(&__msg_data);                             \
  77         }                                                               \
  78 } while (0)
  79
  80 #define LASSERT(cond) LASSERTF(cond, "\n")
  81
  82 #else /* !LASSERT_CHECKED */
  83
  84 #define LASSERTF(cond, fmt, ...)                                        \
  85 do {                                                                    \
  86         if (unlikely(!(cond))) {                                        \
  87                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  88                 libcfs_debug_msg(&__msg_data,                           \
  89                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  90                                  ## __VA_ARGS__);                       \
  91                 lbug_with_loc(&__msg_data);                             \
  92         }                                                               \
  93 } while (0)
  94
  95 #define LASSERT(cond) LASSERTF(cond, "\n")
  96 #endif /* !LASSERT_CHECKED */
  97 #else /* !LIBCFS_DEBUG */
  98 /* sizeof is to use expression without evaluating it. */
  99 # define LASSERT(e) ((void)sizeof!!(e))
 100 # define LASSERTF(cond, ...) ((void)sizeof!!(cond))
 101 #endif /* !LIBCFS_DEBUG */
 102
 103 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 104 /**
 105  * This is for more expensive checks that one doesn't want to be enabled all
 106  * the time. LINVRNT() has to be explicitly enabled by --enable-invariants
 107  * configure option.
 108  */
 109 # define LINVRNT(exp) LASSERT(exp)
 110 #else
 111 # define LINVRNT(exp) ((void)sizeof!!(exp))
 112 #endif
 113
 114 void __noreturn lbug_with_loc(struct libcfs_debug_msg_data *msg);
 115
 116 #define LBUG()                                                          \
 117 do {                                                                    \
 118         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);             \
 119         lbug_with_loc(&msgdata);                                        \
 120 } while(0)
 121
 122 /*
 123  * Memory
 124  */
 125 #ifdef LIBCFS_DEBUG
 126
 127 extern atomic64_t libcfs_kmem;
 128
 129 # define libcfs_kmem_inc(ptr, size)             \
 130 do {                                            \
 131         atomic64_add(size, &libcfs_kmem);       \
 132 } while (0)
 133
 134 # define libcfs_kmem_dec(ptr, size)             \
 135 do {                                            \
 136         atomic64_sub(size, &libcfs_kmem);       \
 137 } while (0)
 138
 139 # define libcfs_kmem_read()                     \
 140         (long long)atomic64_read(&libcfs_kmem)
 141
 142 #else
 143 # define libcfs_kmem_inc(ptr, size) do {} while (0)
 144 # define libcfs_kmem_dec(ptr, size) do {} while (0)
 145 # define libcfs_kmem_read()     (0)
 146 #endif /* LIBCFS_DEBUG */
 147
 148 #ifndef LIBCFS_VMALLOC_SIZE
 149 #define LIBCFS_VMALLOC_SIZE        (2 << PAGE_SHIFT) /* 2 pages */
 150 #endif
 151
 152 #define LIBCFS_ALLOC_PRE(size, mask)                                        \
 153 do {                                                                        \
 154         LASSERT(!in_interrupt() ||                                          \
 155                 ((size) <= LIBCFS_VMALLOC_SIZE &&                           \
 156                  ((mask) & GFP_ATOMIC)) != 0);                              \
 157 } while (0)
 158
 159 /* message format here needs to match regexp in lustre/tests/leak_finder.pl */
 160 #define LIBCFS_MEM_MSG(ptr, size, name)                                       \
 161         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n", (int)(size), ptr)
 162
 163 #define LIBCFS_ALLOC_POST(ptr, size, name)                                    \
 164 do {                                                                          \
 165         if (unlikely((ptr) == NULL)) {                                        \
 166                 CERROR("LNET: out of memory at %s:%d (tried to alloc '"       \
 167                        #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size));    \
 168                 CERROR("LNET: %lld total bytes allocated by lnet\n",          \
 169                        libcfs_kmem_read());                                   \
 170         } else {                                                              \
 171                 libcfs_kmem_inc((ptr), (size));                               \
 172                 LIBCFS_MEM_MSG(ptr, size, name);                              \
 173         }                                                                     \
 174 } while (0)
 175
 176 #define LIBCFS_FREE_PRE(ptr, size, name)                                \
 177         libcfs_kmem_dec((ptr), (size));                                 \
 178         LIBCFS_MEM_MSG(ptr, size, name)
 179
 180 /**
 181  * allocate memory with GFP flags @mask
 182  * The allocated memory is zeroed-out.
 183  */
 184 #define LIBCFS_ALLOC_GFP(ptr, size, mask)                                   \
 185 do {                                                                        \
 186         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 187         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 188                 kzalloc((size), (mask)) : vzalloc(size);                    \
 189         LIBCFS_ALLOC_POST((ptr), (size), "alloc");                          \
 190 } while (0)
 191
 192 /**
 193  * default allocator
 194  */
 195 #define LIBCFS_ALLOC(ptr, size) \
 196         LIBCFS_ALLOC_GFP(ptr, size, GFP_NOFS)
 197
 198 /**
 199  * non-sleeping allocator
 200  */
 201 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
 202         LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
 203
 204 /**
 205  * allocate memory for specified CPU partition
 206  *   \a cptab != NULL, \a cpt is CPU partition id of \a cptab
 207  *   \a cptab == NULL, \a cpt is HW NUMA node id
 208  * The allocated memory is zeroed-out.
 209  */
 210 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)                   \
 211 do {                                                                        \
 212         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 213         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 214                 cfs_cpt_malloc((cptab), (cpt), (size), (mask) | __GFP_ZERO) : \
 215                 cfs_cpt_vzalloc((cptab), (cpt), (size));                    \
 216         LIBCFS_ALLOC_POST((ptr), (size), "alloc");                          \
 217 } while (0)
 218
 219 /** default numa allocator */
 220 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                             \
 221         LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, GFP_NOFS)
 222
 223 void init_libcfs_vfree_atomic(void);
 224 void exit_libcfs_vfree_atomic(void);
 225
 226 #define LIBCFS_FREE(ptr, size)                                          \
 227 do {                                                                    \
 228         int s = (size);                                                 \
 229         if (unlikely((ptr) == NULL)) {                                  \
 230                 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at "    \
 231                        "%s:%d\n", s, __FILE__, __LINE__);               \
 232                 break;                                                  \
 233         }                                                               \
 234         LIBCFS_FREE_PRE(ptr, size, "kfreed");                           \
 235         if (unlikely(s > LIBCFS_VMALLOC_SIZE))                          \
 236                 libcfs_vfree_atomic(ptr);                               \
 237         else                                                            \
 238                 kfree(ptr);                                             \
 239 } while (0)
 240
 241 /******************************************************************************/
 242
 243 void libcfs_debug_dumplog(void);
 244 int libcfs_debug_init(unsigned long bufsize);
 245 int libcfs_debug_cleanup(void);
 246 int libcfs_debug_clear_buffer(void);
 247 int libcfs_debug_mark_buffer(const char *text);
 248
 249 #define LASSERT_ATOMIC_ENABLED          (1)
 250
 251 #if LASSERT_ATOMIC_ENABLED
 252
 253 /** assert value of @a is equal to @v */
 254 #define LASSERT_ATOMIC_EQ(a, v)                         \
 255         LASSERTF(atomic_read(a) == v, "value: %d\n", atomic_read((a)));
 256
 257 /** assert value of @a is unequal to @v */
 258 #define LASSERT_ATOMIC_NE(a, v)                         \
 259         LASSERTF(atomic_read(a) != v, "value: %d\n", atomic_read((a)));
 260
 261 /** assert value of @a is little than @v */
 262 #define LASSERT_ATOMIC_LT(a, v)                         \
 263         LASSERTF(atomic_read(a) < v, "value: %d\n", atomic_read((a)));
 264
 265 /** assert value of @a is little/equal to @v */
 266 #define LASSERT_ATOMIC_LE(a, v)                         \
 267         LASSERTF(atomic_read(a) <= v, "value: %d\n", atomic_read((a)));
 268
 269 /** assert value of @a is great than @v */
 270 #define LASSERT_ATOMIC_GT(a, v)                         \
 271         LASSERTF(atomic_read(a) > v, "value: %d\n", atomic_read((a)));
 272
 273 /** assert value of @a is great/equal to @v */
 274 #define LASSERT_ATOMIC_GE(a, v)                         \
 275         LASSERTF(atomic_read(a) >= v, "value: %d\n", atomic_read((a)));
 276
 277 /** assert value of @a is great than @v1 and little than @v2 */
 278 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)                 \
 279 do {                                                    \
 280         int __v = atomic_read(a);                       \
 281         LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);\
 282 } while (0)
 283
 284 /** assert value of @a is great than @v1 and little/equal to @v2 */
 285 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)                 \
 286 do {                                                    \
 287         int __v = atomic_read(a);                       \
 288         LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);\
 289 } while (0)
 290
 291 /** assert value of @a is great/equal to @v1 and little than @v2 */
 292 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)                 \
 293 do {                                                    \
 294         int __v = atomic_read(a);                       \
 295         LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);\
 296 } while (0)
 297
 298 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
 299 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)                         \
 300 do {                                                            \
 301         int __v = atomic_read(a);                               \
 302         LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v);   \
 303 } while (0)
 304
 305 #else /* !LASSERT_ATOMIC_ENABLED */
 306
 307 #define LASSERT_ATOMIC_EQ(a, v)                 do {} while (0)
 308 #define LASSERT_ATOMIC_NE(a, v)                 do {} while (0)
 309 #define LASSERT_ATOMIC_LT(a, v)                 do {} while (0)
 310 #define LASSERT_ATOMIC_LE(a, v)                 do {} while (0)
 311 #define LASSERT_ATOMIC_GT(a, v)                 do {} while (0)
 312 #define LASSERT_ATOMIC_GE(a, v)                 do {} while (0)
 313 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)         do {} while (0)
 314 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)         do {} while (0)
 315 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)         do {} while (0)
 316 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)         do {} while (0)
 317
 318 #endif /* LASSERT_ATOMIC_ENABLED */
 319
 320 #define LASSERT_ATOMIC_ZERO(a)                  LASSERT_ATOMIC_EQ(a, 0)
 321 #define LASSERT_ATOMIC_POS(a)                   LASSERT_ATOMIC_GT(a, 0)
 322
 323 #define CFS_ALLOC_PTR(ptr)      LIBCFS_ALLOC(ptr, sizeof(*(ptr)));
 324 #define CFS_ALLOC_PTR_ARRAY(ptr, count)                 \
 325         LIBCFS_ALLOC(ptr, (count) * sizeof(*(ptr)))
 326
 327 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof(*(ptr)));
 328 #define CFS_FREE_PTR_ARRAY(ptr, count)                  \
 329         LIBCFS_FREE(ptr, (count) * sizeof(*(ptr)))
 330
 331 /* implication */
 332 #define ergo(a, b) (!(a) || (b))
 333 /* logical equivalence */
 334 #define equi(a, b) (!!(a) == !!(b))
 335
 336 #define MKSTR(ptr) ((ptr))? (ptr) : ""
 337
 338 #ifndef HAVE_CFS_SIZE_ROUND
 339 static inline size_t cfs_size_round(size_t val)
 340 {
 341         return (val + 7) & (~0x7);
 342 }
 343 #define HAVE_CFS_SIZE_ROUND
 344 #endif
 345
 346 #endif