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, 2012, 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 /* 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 LASSERTF(cond, fmt, ...)                                        \
  75 do {                                                                    \
  76         if (cond)                                                       \
  77                 ;                                                       \
  78         else {                                                          \
  79                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  80                 libcfs_debug_msg(&__msg_data,                           \
  81                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  82                                  ## __VA_ARGS__);                       \
  83                 lbug_with_loc(&__msg_data);                             \
  84         }                                                               \
  85 } while (0)
  86
  87 #define LASSERT(cond) LASSERTF(cond, "\n")
  88
  89 #else /* !LASSERT_CHECKED */
  90
  91 #define LASSERTF(cond, fmt, ...)                                        \
  92 do {                                                                    \
  93         if (unlikely(!(cond))) {                                        \
  94                 LIBCFS_DEBUG_MSG_DATA_DECL(__msg_data, D_EMERG, NULL);  \
  95                 libcfs_debug_msg(&__msg_data,                           \
  96                                  "ASSERTION( %s ) failed: " fmt, #cond, \
  97                                  ## __VA_ARGS__);                       \
  98                 lbug_with_loc(&__msg_data);                             \
  99         }                                                               \
 100 } while (0)
 101
 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 */
 109
 110 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 111 /**
 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
 114  * configure option.
 115  */
 116 # define LINVRNT(exp) LASSERT(exp)
 117 #else
 118 # define LINVRNT(exp) ((void)sizeof!!(exp))
 119 #endif
 120
 121 #define KLASSERT(e) LASSERT(e)
 122
 123 void lbug_with_loc(struct libcfs_debug_msg_data *) __attribute__((noreturn));
 124
 125 #define LBUG()                                                          \
 126 do {                                                                    \
 127         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);             \
 128         lbug_with_loc(&msgdata);                                        \
 129 } while(0)
 130
 131 extern atomic_t libcfs_kmemory;
 132 /*
 133  * Memory
 134  */
 135 #ifdef LIBCFS_DEBUG
 136
 137 # define libcfs_kmem_inc(ptr, size)             \
 138 do {                                            \
 139         atomic_add(size, &libcfs_kmemory);      \
 140 } while (0)
 141
 142 # define libcfs_kmem_dec(ptr, size)             \
 143 do {                                            \
 144         atomic_sub(size, &libcfs_kmemory);      \
 145 } while (0)
 146
 147 # define libcfs_kmem_read()                     \
 148         atomic_read(&libcfs_kmemory)
 149
 150 #else
 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 */
 155
 156 #ifndef LIBCFS_VMALLOC_SIZE
 157 #define LIBCFS_VMALLOC_SIZE        (2 << PAGE_CACHE_SHIFT) /* 2 pages */
 158 #endif
 159
 160 #define LIBCFS_ALLOC_PRE(size, mask)                                        \
 161 do {                                                                        \
 162         LASSERT(!in_interrupt() ||                                          \
 163                 ((size) <= LIBCFS_VMALLOC_SIZE &&                           \
 164                  ((mask) & GFP_ATOMIC)) != 0);                      \
 165 } while (0)
 166
 167 #define LIBCFS_ALLOC_POST(ptr, size)                                        \
 168 do {                                                                        \
 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());                                 \
 174         } else {                                                            \
 175                 libcfs_kmem_inc((ptr), (size));                             \
 176                 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n",  \
 177                        (int)(size), (ptr), libcfs_kmem_read());             \
 178         }                                                                   \
 179 } while (0)
 180
 181 /**
 182  * allocate memory with GFP flags @mask
 183  * The allocated memory is zeroed-out.
 184  */
 185 #define LIBCFS_ALLOC_GFP(ptr, size, mask)                                   \
 186 do {                                                                        \
 187         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 188         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 189                 kzalloc((size), (mask)) : vzalloc(size);                    \
 190         LIBCFS_ALLOC_POST((ptr), (size));                                   \
 191 } while (0)
 192
 193 /**
 194  * default allocator
 195  */
 196 #define LIBCFS_ALLOC(ptr, size) \
 197         LIBCFS_ALLOC_GFP(ptr, size, GFP_NOFS)
 198
 199 /**
 200  * non-sleeping allocator
 201  */
 202 #define LIBCFS_ALLOC_ATOMIC(ptr, size) \
 203         LIBCFS_ALLOC_GFP(ptr, size, GFP_ATOMIC)
 204
 205 /**
 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
 209  * The allocated memory is zeroed-out.
 210  */
 211 #define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)                   \
 212 do {                                                                        \
 213         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 214         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 215                 cfs_cpt_malloc((cptab), (cpt), (size), (mask) | __GFP_ZERO) : \
 216                 cfs_cpt_vzalloc((cptab), (cpt), (size));                    \
 217         LIBCFS_ALLOC_POST((ptr), (size));                                   \
 218 } while (0)
 219
 220 /** default numa allocator */
 221 #define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                             \
 222         LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, GFP_NOFS)
 223
 224 #define LIBCFS_FREE(ptr, size)                                          \
 225 do {                                                                    \
 226         int s = (size);                                                 \
 227         if (unlikely((ptr) == NULL)) {                                  \
 228                 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at "    \
 229                        "%s:%d\n", s, __FILE__, __LINE__);               \
 230                 break;                                                  \
 231         }                                                               \
 232         libcfs_kmem_dec((ptr), s);                                      \
 233         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",     \
 234                s, (ptr), libcfs_kmem_read());                           \
 235         if (unlikely(s > LIBCFS_VMALLOC_SIZE))                          \
 236                 vfree(ptr);                                             \
 237         else                                                            \
 238                 kfree(ptr);                                             \
 239 } while (0)
 240
 241 /******************************************************************************/
 242
 243 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
 244 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
 245 #define ___htonl(x) __cpu_to_be32(x)
 246 #define ___htons(x) __cpu_to_be16(x)
 247 #define ___ntohl(x) __be32_to_cpu(x)
 248 #define ___ntohs(x) __be16_to_cpu(x)
 249 #define htonl(x) ___htonl(x)
 250 #define ntohl(x) ___ntohl(x)
 251 #define htons(x) ___htons(x)
 252 #define ntohs(x) ___ntohs(x)
 253 #endif
 254
 255 void libcfs_debug_dumpstack(struct task_struct *tsk);
 256 void libcfs_run_upcall(char **argv);
 257 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *);
 258 void libcfs_debug_dumplog(void);
 259 int libcfs_debug_init(unsigned long bufsize);
 260 int libcfs_debug_cleanup(void);
 261 int libcfs_debug_clear_buffer(void);
 262 int libcfs_debug_mark_buffer(const char *text);
 263
 264 void libcfs_debug_set_level(unsigned int debug_level);
 265
 266 #else  /* !__KERNEL__ */
 267 # ifdef LIBCFS_DEBUG
 268 #  undef NDEBUG
 269 #  include <assert.h>
 270 #  define LASSERT(e)     assert(e)
 271 #  define LASSERTF(cond, ...)                                                  \
 272 do {                                                                           \
 273           if (!(cond))                                                         \
 274                 CERROR(__VA_ARGS__);                                           \
 275           assert(cond);                                                        \
 276 } while (0)
 277 #  define LBUG()   assert(0)
 278 #  ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 279 #   define LINVRNT(exp) LASSERT(exp)
 280 #  else
 281 #   define LINVRNT(exp) ((void)sizeof!!(exp))
 282 #  endif
 283 # else
 284 #  define LASSERT(e) ((void)sizeof!!(e))
 285 #  define LASSERTF(cond, ...) ((void)sizeof!!(cond))
 286 #  define LBUG()   ((void)(0))
 287 #  define LINVRNT(exp) ((void)sizeof!!(exp))
 288 # endif /* LIBCFS_DEBUG */
 289 # define KLASSERT(e) ((void)0)
 290 # define printk printf
 291 #define LIBCFS_ALLOC_GFP(ptr, size, mask)       \
 292 do {                                            \
 293         (ptr) = calloc(1, size);                \
 294 } while (0)
 295 # define LIBCFS_FREE(ptr, size) do { free(ptr); } while((size) - (size))
 296 # define LIBCFS_ALLOC(ptr, size)                                \
 297          LIBCFS_ALLOC_GFP(ptr, size, 0)
 298 # define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)      \
 299          LIBCFS_ALLOC(ptr, size)
 300 # define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                \
 301          LIBCFS_ALLOC(ptr, size)
 302
 303 void libcfs_debug_dumplog(void);
 304 int libcfs_debug_init(unsigned long bufsize);
 305 int libcfs_debug_cleanup(void);
 306
 307 #define libcfs_debug_dumpstack(tsk)     ((void)0)
 308
 309 /*
 310  * Generic compiler-dependent macros required for kernel
 311  * build go below this comment. Actual compiler/compiler version
 312  * specific implementations come from the above header files
 313  */
 314 #define likely(x)      __builtin_expect(!!(x), 1)
 315 #define unlikely(x)    __builtin_expect(!!(x), 0)
 316 /* !__KERNEL__ */
 317 #endif
 318
 319 struct cfs_cpt_table;
 320
 321 /*
 322  * allocate per-cpu-partition data, returned value is an array of pointers,
 323  * variable can be indexed by CPU ID.
 324  *      cptable != NULL: size of array is number of CPU partitions
 325  *      cptable == NULL: size of array is number of HW cores
 326  */
 327 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
 328 /*
 329  * destory per-cpu-partition variable
 330  */
 331 void  cfs_percpt_free(void *vars);
 332 int   cfs_percpt_number(void *vars);
 333 void *cfs_percpt_current(void *vars);
 334 void *cfs_percpt_index(void *vars, int idx);
 335
 336 #define cfs_percpt_for_each(var, i, vars)               \
 337         for (i = 0; i < cfs_percpt_number(vars) &&      \
 338                     ((var) = (vars)[i]) != NULL; i++)
 339
 340 /*
 341  * allocate a variable array, returned value is an array of pointers.
 342  * Caller can specify length of array by count.
 343  */
 344 void *cfs_array_alloc(int count, unsigned int size);
 345 void  cfs_array_free(void *vars);
 346
 347 #define LASSERT_ATOMIC_ENABLED          (1)
 348
 349 #if LASSERT_ATOMIC_ENABLED
 350
 351 /** assert value of @a is equal to @v */
 352 #define LASSERT_ATOMIC_EQ(a, v)                                 \
 353 do {                                                            \
 354         LASSERTF(atomic_read(a) == v,                       \
 355                  "value: %d\n", atomic_read((a)));          \
 356 } while (0)
 357
 358 /** assert value of @a is unequal to @v */
 359 #define LASSERT_ATOMIC_NE(a, v)                                 \
 360 do {                                                            \
 361         LASSERTF(atomic_read(a) != v,                       \
 362                  "value: %d\n", atomic_read((a)));          \
 363 } while (0)
 364
 365 /** assert value of @a is little than @v */
 366 #define LASSERT_ATOMIC_LT(a, v)                                 \
 367 do {                                                            \
 368         LASSERTF(atomic_read(a) < v,                        \
 369                  "value: %d\n", atomic_read((a)));          \
 370 } while (0)
 371
 372 /** assert value of @a is little/equal to @v */
 373 #define LASSERT_ATOMIC_LE(a, v)                                 \
 374 do {                                                            \
 375         LASSERTF(atomic_read(a) <= v,                       \
 376                  "value: %d\n", atomic_read((a)));          \
 377 } while (0)
 378
 379 /** assert value of @a is great than @v */
 380 #define LASSERT_ATOMIC_GT(a, v)                                 \
 381 do {                                                            \
 382         LASSERTF(atomic_read(a) > v,                        \
 383                  "value: %d\n", atomic_read((a)));          \
 384 } while (0)
 385
 386 /** assert value of @a is great/equal to @v */
 387 #define LASSERT_ATOMIC_GE(a, v)                                 \
 388 do {                                                            \
 389         LASSERTF(atomic_read(a) >= v,                       \
 390                  "value: %d\n", atomic_read((a)));          \
 391 } while (0)
 392
 393 /** assert value of @a is great than @v1 and little than @v2 */
 394 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)                         \
 395 do {                                                            \
 396         int __v = atomic_read(a);                           \
 397         LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);     \
 398 } while (0)
 399
 400 /** assert value of @a is great than @v1 and little/equal to @v2 */
 401 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)                         \
 402 do {                                                            \
 403         int __v = atomic_read(a);                           \
 404         LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);    \
 405 } while (0)
 406
 407 /** assert value of @a is great/equal to @v1 and little than @v2 */
 408 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)                         \
 409 do {                                                            \
 410         int __v = atomic_read(a);                           \
 411         LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);    \
 412 } while (0)
 413
 414 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
 415 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)                         \
 416 do {                                                            \
 417         int __v = atomic_read(a);                           \
 418         LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v);   \
 419 } while (0)
 420
 421 #else /* !LASSERT_ATOMIC_ENABLED */
 422
 423 #define LASSERT_ATOMIC_EQ(a, v)                 do {} while (0)
 424 #define LASSERT_ATOMIC_NE(a, v)                 do {} while (0)
 425 #define LASSERT_ATOMIC_LT(a, v)                 do {} while (0)
 426 #define LASSERT_ATOMIC_LE(a, v)                 do {} while (0)
 427 #define LASSERT_ATOMIC_GT(a, v)                 do {} while (0)
 428 #define LASSERT_ATOMIC_GE(a, v)                 do {} while (0)
 429 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)         do {} while (0)
 430 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)         do {} while (0)
 431 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)         do {} while (0)
 432 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)         do {} while (0)
 433
 434 #endif /* LASSERT_ATOMIC_ENABLED */
 435
 436 #define LASSERT_ATOMIC_ZERO(a)                  LASSERT_ATOMIC_EQ(a, 0)
 437 #define LASSERT_ATOMIC_POS(a)                   LASSERT_ATOMIC_GT(a, 0)
 438
 439 #define CFS_ALLOC_PTR(ptr)      LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
 440 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof (*(ptr)));
 441
 442 /*
 443  * percpu partition lock
 444  *
 445  * There are some use-cases like this in Lustre:
 446  * . each CPU partition has it's own private data which is frequently changed,
 447  *   and mostly by the local CPU partition.
 448  * . all CPU partitions share some global data, these data are rarely changed.
 449  *
 450  * LNet is typical example.
 451  * CPU partition lock is designed for this kind of use-cases:
 452  * . each CPU partition has it's own private lock
 453  * . change on private data just needs to take the private lock
 454  * . read on shared data just needs to take _any_ of private locks
 455  * . change on shared data needs to take _all_ private locks,
 456  *   which is slow and should be really rare.
 457  */
 458
 459 enum {
 460         CFS_PERCPT_LOCK_EX      = -1, /* negative */
 461 };
 462
 463 #ifdef __KERNEL__
 464
 465 struct cfs_percpt_lock {
 466         /* cpu-partition-table for this lock */
 467         struct cfs_cpt_table    *pcl_cptab;
 468         /* exclusively locked */
 469         unsigned int            pcl_locked;
 470         /* private lock table */
 471         spinlock_t              **pcl_locks;
 472 };
 473
 474 /* return number of private locks */
 475 #define cfs_percpt_lock_num(pcl)        cfs_cpt_number(pcl->pcl_cptab)
 476
 477 #else /* !__KERNEL__ */
 478
 479 # ifdef HAVE_LIBPTHREAD
 480
 481 struct cfs_percpt_lock {
 482         pthread_mutex_t         pcl_mutex;
 483 };
 484
 485 # else /* !HAVE_LIBPTHREAD */
 486
 487 struct cfs_percpt_lock {
 488         int                     pcl_lock;
 489 };
 490
 491 static const struct cfs_percpt_lock CFS_PERCPT_LOCK_MAGIC;
 492
 493 # endif /* HAVE_LIBPTHREAD */
 494 # define cfs_percpt_lock_num(pcl)        1
 495 #endif /* __KERNEL__ */
 496
 497 /*
 498  * create a cpu-partition lock based on CPU partition table \a cptab,
 499  * each private lock has extra \a psize bytes padding data
 500  */
 501 struct cfs_percpt_lock *cfs_percpt_lock_alloc(struct cfs_cpt_table *cptab);
 502 /* destroy a cpu-partition lock */
 503 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
 504
 505 /* lock private lock \a index of \a pcl */
 506 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
 507 /* unlock private lock \a index of \a pcl */
 508 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
 509 /* create percpt (atomic) refcount based on @cptab */
 510 atomic_t **cfs_percpt_atomic_alloc(struct cfs_cpt_table *cptab, int val);
 511 /* destroy percpt refcount */
 512 void cfs_percpt_atomic_free(atomic_t **refs);
 513 /* return sum of all percpu refs */
 514 int cfs_percpt_atomic_summary(atomic_t **refs);
 515
 516
 517 /** Compile-time assertion.
 518
 519  * Check an invariant described by a constant expression at compile time by
 520  * forcing a compiler error if it does not hold.  \a cond must be a constant
 521  * expression as defined by the ISO C Standard:
 522  *
 523  *       6.8.4.2  The switch statement
 524  *       ....
 525  *       [#3] The expression of each case label shall be  an  integer
 526  *       constant   expression  and  no  two  of  the  case  constant
 527  *       expressions in the same switch statement shall have the same
 528  *       value  after  conversion...
 529  *
 530  */
 531 #define CLASSERT(cond) do {switch (1) {case (cond): case 0: break; } } while (0)
 532
 533 /* support decl needed both by kernel and liblustre */
 534 int              libcfs_isknown_lnd(int type);
 535 char            *libcfs_lnd2modname(int type);
 536 char            *libcfs_lnd2str(int type);
 537 int              libcfs_str2lnd(const char *str);
 538 char            *libcfs_net2str(__u32 net);
 539 char            *libcfs_nid2str(lnet_nid_t nid);
 540 __u32            libcfs_str2net(const char *str);
 541 lnet_nid_t       libcfs_str2nid(const char *str);
 542 int              libcfs_str2anynid(lnet_nid_t *nid, const char *str);
 543 char            *libcfs_id2str(lnet_process_id_t id);
 544 void             cfs_free_nidlist(struct list_head *list);
 545 int              cfs_parse_nidlist(char *str, int len, struct list_head *list);
 546 int              cfs_print_nidlist(char *buffer, int count,
 547                                    struct list_head *list);
 548 int              cfs_match_nid(lnet_nid_t nid, struct list_head *list);
 549 bool             cfs_nidrange_is_contiguous(struct list_head *nidlist);
 550 void             cfs_nidrange_find_min_max(struct list_head *nidlist,
 551                                            char *min_nid, char *max_nid,
 552                                            int nidstr_length);
 553
 554 /** \addtogroup lnet_addr
 555  * @{ */
 556 /* how an LNET NID encodes net:address */
 557 /** extract the address part of an lnet_nid_t */
 558 #define LNET_NIDADDR(nid)      ((__u32)((nid) & 0xffffffff))
 559 /** extract the network part of an lnet_nid_t */
 560 #define LNET_NIDNET(nid)       ((__u32)(((nid) >> 32)) & 0xffffffff)
 561 /** make an lnet_nid_t from a network part and an address part */
 562 #define LNET_MKNID(net,addr)   ((((__u64)(net))<<32)|((__u64)(addr)))
 563 /* how net encodes type:number */
 564 #define LNET_NETNUM(net)       ((net) & 0xffff)
 565 #define LNET_NETTYP(net)       (((net) >> 16) & 0xffff)
 566 #define LNET_MKNET(typ,num)    ((((__u32)(typ))<<16)|((__u32)(num)))
 567 /** @} lnet_addr */
 568
 569 /* max value for numeric network address */
 570 #define MAX_NUMERIC_VALUE 0xffffffff
 571
 572 /* implication */
 573 #define ergo(a, b) (!(a) || (b))
 574 /* logical equivalence */
 575 #define equi(a, b) (!!(a) == !!(b))
 576
 577 #ifndef CFS_CURRENT_TIME
 578 # define CFS_CURRENT_TIME time(0)
 579 #endif
 580
 581 struct libcfs_device_userstate
 582 {
 583         int             ldu_memhog_pages;
 584         struct page     *ldu_memhog_root_page;
 585 };
 586
 587 /* what used to be in portals_lib.h */
 588 #ifndef MIN
 589 # define MIN(a,b) (((a)<(b)) ? (a): (b))
 590 #endif
 591 #ifndef MAX
 592 # define MAX(a,b) (((a)>(b)) ? (a): (b))
 593 #endif
 594
 595 #define MKSTR(ptr) ((ptr))? (ptr) : ""
 596
 597 static inline size_t cfs_size_round4(size_t val)
 598 {
 599         return (val + 3) & (~0x3);
 600 }
 601
 602 #ifndef HAVE_CFS_SIZE_ROUND
 603 static inline size_t cfs_size_round(size_t val)
 604 {
 605         return (val + 7) & (~0x7);
 606 }
 607 #define HAVE_CFS_SIZE_ROUND
 608 #endif
 609
 610 static inline size_t cfs_size_round16(size_t val)
 611 {
 612         return (val + 0xf) & (~0xf);
 613 }
 614
 615 static inline size_t cfs_size_round32(size_t val)
 616 {
 617         return (val + 0x1f) & (~0x1f);
 618 }
 619
 620 static inline size_t cfs_size_round0(size_t val)
 621 {
 622         if (!val)
 623                 return 0;
 624         return (val + 1 + 7) & (~0x7);
 625 }
 626
 627 static inline size_t cfs_round_strlen(char *fset)
 628 {
 629         return cfs_size_round(strlen(fset) + 1);
 630 }
 631
 632 /* roundup \a val to power2 */
 633 static inline size_t cfs_power2_roundup(size_t val)
 634 {
 635         if (val != LOWEST_BIT_SET(val)) { /* not a power of 2 already */
 636                 do {
 637                         val &= ~LOWEST_BIT_SET(val);
 638                 } while (val != LOWEST_BIT_SET(val));
 639                 /* ...and round up */
 640                 val <<= 1;
 641         }
 642         return val;
 643 }
 644
 645 #define LOGL(var,len,ptr)                                       \
 646 do {                                                            \
 647         if (var)                                                \
 648                 memcpy((char *)ptr, (const char *)var, len);    \
 649         ptr += cfs_size_round(len);                             \
 650 } while (0)
 651
 652 #define LOGU(var,len,ptr)                                       \
 653 do {                                                            \
 654         if (var)                                                \
 655                 memcpy((char *)var, (const char *)ptr, len);    \
 656         ptr += cfs_size_round(len);                             \
 657 } while (0)
 658
 659 /**
 660  *  Lustre Network Driver types.
 661  */
 662 enum {
 663         /* Only add to these values (i.e. don't ever change or redefine them):
 664          * network addresses depend on them... */
 665         QSWLND    = 1,
 666         SOCKLND   = 2,
 667         GMLND     = 3, /* obsolete, keep it so that libcfs_nid2str works */
 668         PTLLND    = 4,
 669         O2IBLND   = 5,
 670         CIBLND    = 6,
 671         OPENIBLND = 7,
 672         IIBLND    = 8,
 673         LOLND     = 9,
 674         RALND     = 10,
 675         VIBLND    = 11,
 676         MXLND     = 12,
 677         GNILND    = 13,
 678         GNIIPLND  = 14,
 679 };
 680
 681 #endif