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                 memset((ptr), 0, (size));                                   \
 176                 libcfs_kmem_inc((ptr), (size));                             \
 177                 CDEBUG(D_MALLOC, "alloc '" #ptr "': %d at %p (tot %d).\n",  \
 178                        (int)(size), (ptr), libcfs_kmem_read());             \
 179         }                                                                   \
 180 } while (0)
 181
 182 /**
 183  * allocate memory with GFP flags @mask
 184  */
 185 #define LIBCFS_ALLOC_GFP(ptr, size, mask)                                   \
 186 do {                                                                        \
 187         LIBCFS_ALLOC_PRE((size), (mask));                                   \
 188         (ptr) = (size) <= LIBCFS_VMALLOC_SIZE ?                             \
 189                 kmalloc((size), (mask)) : vmalloc(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_IO)
 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  */
 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)) :            \
 215                 cfs_cpt_vmalloc((cptab), (cpt), (size));                    \
 216         LIBCFS_ALLOC_POST((ptr), (size));                                   \
 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_IO)
 222
 223 #define LIBCFS_FREE(ptr, size)                                          \
 224 do {                                                                    \
 225         int s = (size);                                                 \
 226         if (unlikely((ptr) == NULL)) {                                  \
 227                 CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at "    \
 228                        "%s:%d\n", s, __FILE__, __LINE__);               \
 229                 break;                                                  \
 230         }                                                               \
 231         libcfs_kmem_dec((ptr), s);                                      \
 232         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",     \
 233                s, (ptr), libcfs_kmem_read());                           \
 234         if (unlikely(s > LIBCFS_VMALLOC_SIZE))                          \
 235                 vfree(ptr);                                             \
 236         else                                                            \
 237                 kfree(ptr);                                             \
 238 } while (0)
 239
 240 /******************************************************************************/
 241
 242 /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */
 243 #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__)
 244 #define ___htonl(x) __cpu_to_be32(x)
 245 #define ___htons(x) __cpu_to_be16(x)
 246 #define ___ntohl(x) __be32_to_cpu(x)
 247 #define ___ntohs(x) __be16_to_cpu(x)
 248 #define htonl(x) ___htonl(x)
 249 #define ntohl(x) ___ntohl(x)
 250 #define htons(x) ___htons(x)
 251 #define ntohs(x) ___ntohs(x)
 252 #endif
 253
 254 void libcfs_debug_dumpstack(struct task_struct *tsk);
 255 void libcfs_run_upcall(char **argv);
 256 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *);
 257 void libcfs_debug_dumplog(void);
 258 int libcfs_debug_init(unsigned long bufsize);
 259 int libcfs_debug_cleanup(void);
 260 int libcfs_debug_clear_buffer(void);
 261 int libcfs_debug_mark_buffer(const char *text);
 262
 263 void libcfs_debug_set_level(unsigned int debug_level);
 264
 265 #else  /* !__KERNEL__ */
 266 # ifdef LIBCFS_DEBUG
 267 #  undef NDEBUG
 268 #  include <assert.h>
 269 #  define LASSERT(e)     assert(e)
 270 #  define LASSERTF(cond, ...)                                                  \
 271 do {                                                                           \
 272           if (!(cond))                                                         \
 273                 CERROR(__VA_ARGS__);                                           \
 274           assert(cond);                                                        \
 275 } while (0)
 276 #  define LBUG()   assert(0)
 277 #  ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 278 #   define LINVRNT(exp) LASSERT(exp)
 279 #  else
 280 #   define LINVRNT(exp) ((void)sizeof!!(exp))
 281 #  endif
 282 # else
 283 #  define LASSERT(e) ((void)sizeof!!(e))
 284 #  define LASSERTF(cond, ...) ((void)sizeof!!(cond))
 285 #  define LBUG()   ((void)(0))
 286 #  define LINVRNT(exp) ((void)sizeof!!(exp))
 287 # endif /* LIBCFS_DEBUG */
 288 # define KLASSERT(e) ((void)0)
 289 # define printk printf
 290 #define LIBCFS_ALLOC_GFP(ptr, size, mask)       \
 291 do {                                            \
 292         (ptr) = calloc(1, size);                \
 293 } while (0)
 294 # define LIBCFS_FREE(ptr, size) do { free(ptr); } while((size) - (size))
 295 # define LIBCFS_ALLOC(ptr, size)                                \
 296          LIBCFS_ALLOC_GFP(ptr, size, 0)
 297 # define LIBCFS_CPT_ALLOC_GFP(ptr, cptab, cpt, size, mask)      \
 298          LIBCFS_ALLOC(ptr, size)
 299 # define LIBCFS_CPT_ALLOC(ptr, cptab, cpt, size)                \
 300          LIBCFS_ALLOC(ptr, size)
 301
 302 void libcfs_debug_dumplog(void);
 303 int libcfs_debug_init(unsigned long bufsize);
 304 int libcfs_debug_cleanup(void);
 305
 306 #define libcfs_debug_dumpstack(tsk)     ((void)0)
 307
 308 /*
 309  * Generic compiler-dependent macros required for kernel
 310  * build go below this comment. Actual compiler/compiler version
 311  * specific implementations come from the above header files
 312  */
 313 #ifdef __GNUC__
 314 #define likely(x)      __builtin_expect(!!(x), 1)
 315 #define unlikely(x)    __builtin_expect(!!(x), 0)
 316 #else
 317 #define likely(x)       (!!(x))
 318 #define unlikely(x)     (!!(x))
 319 #endif
 320 /* !__KERNEL__ */
 321 #endif
 322
 323 /*
 324  * allocate per-cpu-partition data, returned value is an array of pointers,
 325  * variable can be indexed by CPU ID.
 326  *      cptable != NULL: size of array is number of CPU partitions
 327  *      cptable == NULL: size of array is number of HW cores
 328  */
 329 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
 330 /*
 331  * destory per-cpu-partition variable
 332  */
 333 void  cfs_percpt_free(void *vars);
 334 int   cfs_percpt_number(void *vars);
 335 void *cfs_percpt_current(void *vars);
 336 void *cfs_percpt_index(void *vars, int idx);
 337
 338 #define cfs_percpt_for_each(var, i, vars)               \
 339         for (i = 0; i < cfs_percpt_number(vars) &&      \
 340                     ((var) = (vars)[i]) != NULL; i++)
 341
 342 /*
 343  * allocate a variable array, returned value is an array of pointers.
 344  * Caller can specify length of array by count.
 345  */
 346 void *cfs_array_alloc(int count, unsigned int size);
 347 void  cfs_array_free(void *vars);
 348
 349 #define LASSERT_ATOMIC_ENABLED          (1)
 350
 351 #if LASSERT_ATOMIC_ENABLED
 352
 353 /** assert value of @a is equal to @v */
 354 #define LASSERT_ATOMIC_EQ(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 unequal to @v */
 361 #define LASSERT_ATOMIC_NE(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 little than @v */
 368 #define LASSERT_ATOMIC_LT(a, v)                                 \
 369 do {                                                            \
 370         LASSERTF(atomic_read(a) < v,                        \
 371                  "value: %d\n", atomic_read((a)));          \
 372 } while (0)
 373
 374 /** assert value of @a is little/equal to @v */
 375 #define LASSERT_ATOMIC_LE(a, v)                                 \
 376 do {                                                            \
 377         LASSERTF(atomic_read(a) <= v,                       \
 378                  "value: %d\n", atomic_read((a)));          \
 379 } while (0)
 380
 381 /** assert value of @a is great than @v */
 382 #define LASSERT_ATOMIC_GT(a, v)                                 \
 383 do {                                                            \
 384         LASSERTF(atomic_read(a) > v,                        \
 385                  "value: %d\n", atomic_read((a)));          \
 386 } while (0)
 387
 388 /** assert value of @a is great/equal to @v */
 389 #define LASSERT_ATOMIC_GE(a, v)                                 \
 390 do {                                                            \
 391         LASSERTF(atomic_read(a) >= v,                       \
 392                  "value: %d\n", atomic_read((a)));          \
 393 } while (0)
 394
 395 /** assert value of @a is great than @v1 and little than @v2 */
 396 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)                         \
 397 do {                                                            \
 398         int __v = atomic_read(a);                           \
 399         LASSERTF(__v > v1 && __v < v2, "value: %d\n", __v);     \
 400 } while (0)
 401
 402 /** assert value of @a is great than @v1 and little/equal to @v2 */
 403 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)                         \
 404 do {                                                            \
 405         int __v = atomic_read(a);                           \
 406         LASSERTF(__v > v1 && __v <= v2, "value: %d\n", __v);    \
 407 } while (0)
 408
 409 /** assert value of @a is great/equal to @v1 and little than @v2 */
 410 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)                         \
 411 do {                                                            \
 412         int __v = atomic_read(a);                           \
 413         LASSERTF(__v >= v1 && __v < v2, "value: %d\n", __v);    \
 414 } while (0)
 415
 416 /** assert value of @a is great/equal to @v1 and little/equal to @v2 */
 417 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)                         \
 418 do {                                                            \
 419         int __v = atomic_read(a);                           \
 420         LASSERTF(__v >= v1 && __v <= v2, "value: %d\n", __v);   \
 421 } while (0)
 422
 423 #else /* !LASSERT_ATOMIC_ENABLED */
 424
 425 #define LASSERT_ATOMIC_EQ(a, v)                 do {} while (0)
 426 #define LASSERT_ATOMIC_NE(a, v)                 do {} while (0)
 427 #define LASSERT_ATOMIC_LT(a, v)                 do {} while (0)
 428 #define LASSERT_ATOMIC_LE(a, v)                 do {} while (0)
 429 #define LASSERT_ATOMIC_GT(a, v)                 do {} while (0)
 430 #define LASSERT_ATOMIC_GE(a, v)                 do {} while (0)
 431 #define LASSERT_ATOMIC_GT_LT(a, v1, v2)         do {} while (0)
 432 #define LASSERT_ATOMIC_GT_LE(a, v1, v2)         do {} while (0)
 433 #define LASSERT_ATOMIC_GE_LT(a, v1, v2)         do {} while (0)
 434 #define LASSERT_ATOMIC_GE_LE(a, v1, v2)         do {} while (0)
 435
 436 #endif /* LASSERT_ATOMIC_ENABLED */
 437
 438 #define LASSERT_ATOMIC_ZERO(a)                  LASSERT_ATOMIC_EQ(a, 0)
 439 #define LASSERT_ATOMIC_POS(a)                   LASSERT_ATOMIC_GT(a, 0)
 440
 441 #define CFS_ALLOC_PTR(ptr)      LIBCFS_ALLOC(ptr, sizeof (*(ptr)));
 442 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof (*(ptr)));
 443
 444 /*
 445  * percpu partition lock
 446  *
 447  * There are some use-cases like this in Lustre:
 448  * . each CPU partition has it's own private data which is frequently changed,
 449  *   and mostly by the local CPU partition.
 450  * . all CPU partitions share some global data, these data are rarely changed.
 451  *
 452  * LNet is typical example.
 453  * CPU partition lock is designed for this kind of use-cases:
 454  * . each CPU partition has it's own private lock
 455  * . change on private data just needs to take the private lock
 456  * . read on shared data just needs to take _any_ of private locks
 457  * . change on shared data needs to take _all_ private locks,
 458  *   which is slow and should be really rare.
 459  */
 460
 461 enum {
 462         CFS_PERCPT_LOCK_EX      = -1, /* negative */
 463 };
 464
 465 #ifdef __KERNEL__
 466
 467 struct cfs_percpt_lock {
 468         /* cpu-partition-table for this lock */
 469         struct cfs_cpt_table    *pcl_cptab;
 470         /* exclusively locked */
 471         unsigned int            pcl_locked;
 472         /* private lock table */
 473         spinlock_t              **pcl_locks;
 474 };
 475
 476 /* return number of private locks */
 477 static inline int
 478 cfs_percpt_lock_num(struct cfs_percpt_lock *pcl)
 479 {
 480         return cfs_cpt_number(pcl->pcl_cptab);
 481 }
 482
 483 #else /* !__KERNEL__ */
 484
 485 # ifdef HAVE_LIBPTHREAD
 486
 487 struct cfs_percpt_lock {
 488         pthread_mutex_t         pcl_mutex;
 489 };
 490
 491 # else /* !HAVE_LIBPTHREAD */
 492
 493 struct cfs_percpt_lock {
 494         int                     pcl_lock;
 495 };
 496
 497 static const struct cfs_percpt_lock CFS_PERCPT_LOCK_MAGIC;
 498
 499 # endif /* HAVE_LIBPTHREAD */
 500 # define cfs_percpt_lock_num(pcl)        1
 501 #endif /* __KERNEL__ */
 502
 503 /*
 504  * create a cpu-partition lock based on CPU partition table \a cptab,
 505  * each private lock has extra \a psize bytes padding data
 506  */
 507 struct cfs_percpt_lock *cfs_percpt_lock_alloc(struct cfs_cpt_table *cptab);
 508 /* destroy a cpu-partition lock */
 509 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
 510
 511 /* lock private lock \a index of \a pcl */
 512 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
 513 /* unlock private lock \a index of \a pcl */
 514 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
 515 /* create percpt (atomic) refcount based on @cptab */
 516 atomic_t **cfs_percpt_atomic_alloc(struct cfs_cpt_table *cptab, int val);
 517 /* destroy percpt refcount */
 518 void cfs_percpt_atomic_free(atomic_t **refs);
 519 /* return sum of all percpu refs */
 520 int cfs_percpt_atomic_summary(atomic_t **refs);
 521
 522
 523 /** Compile-time assertion.
 524
 525  * Check an invariant described by a constant expression at compile time by
 526  * forcing a compiler error if it does not hold.  \a cond must be a constant
 527  * expression as defined by the ISO C Standard:
 528  *
 529  *       6.8.4.2  The switch statement
 530  *       ....
 531  *       [#3] The expression of each case label shall be  an  integer
 532  *       constant   expression  and  no  two  of  the  case  constant
 533  *       expressions in the same switch statement shall have the same
 534  *       value  after  conversion...
 535  *
 536  */
 537 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
 538
 539 /* support decl needed both by kernel and liblustre */
 540 int         libcfs_isknown_lnd(int type);
 541 char       *libcfs_lnd2modname(int type);
 542 char       *libcfs_lnd2str(int type);
 543 int         libcfs_str2lnd(const char *str);
 544 char       *libcfs_net2str(__u32 net);
 545 char       *libcfs_nid2str(lnet_nid_t nid);
 546 __u32       libcfs_str2net(const char *str);
 547 lnet_nid_t  libcfs_str2nid(const char *str);
 548 int         libcfs_str2anynid(lnet_nid_t *nid, const char *str);
 549 char       *libcfs_id2str(lnet_process_id_t id);
 550 void        cfs_free_nidlist(cfs_list_t *list);
 551 int         cfs_parse_nidlist(char *str, int len, cfs_list_t *list);
 552 int         cfs_match_nid(lnet_nid_t nid, cfs_list_t *list);
 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 /* --------------------------------------------------------------------
 582  * Light-weight trace
 583  * Support for temporary event tracing with minimal Heisenberg effect.
 584  * All stuff about lwt are put in arch/kp30.h
 585  * -------------------------------------------------------------------- */
 586
 587 struct libcfs_device_userstate
 588 {
 589         int             ldu_memhog_pages;
 590         struct page     *ldu_memhog_root_page;
 591 };
 592
 593 /* what used to be in portals_lib.h */
 594 #ifndef MIN
 595 # define MIN(a,b) (((a)<(b)) ? (a): (b))
 596 #endif
 597 #ifndef MAX
 598 # define MAX(a,b) (((a)>(b)) ? (a): (b))
 599 #endif
 600
 601 #define MKSTR(ptr) ((ptr))? (ptr) : ""
 602
 603 static inline int cfs_size_round4 (int val)
 604 {
 605         return (val + 3) & (~0x3);
 606 }
 607
 608 #ifndef HAVE_CFS_SIZE_ROUND
 609 static inline int cfs_size_round (int val)
 610 {
 611         return (val + 7) & (~0x7);
 612 }
 613 #define HAVE_CFS_SIZE_ROUND
 614 #endif
 615
 616 static inline int cfs_size_round16(int val)
 617 {
 618         return (val + 0xf) & (~0xf);
 619 }
 620
 621 static inline int cfs_size_round32(int val)
 622 {
 623         return (val + 0x1f) & (~0x1f);
 624 }
 625
 626 static inline int cfs_size_round0(int val)
 627 {
 628         if (!val)
 629                 return 0;
 630         return (val + 1 + 7) & (~0x7);
 631 }
 632
 633 static inline size_t cfs_round_strlen(char *fset)
 634 {
 635         return (size_t)cfs_size_round((int)strlen(fset) + 1);
 636 }
 637
 638 /* roundup \a val to power2 */
 639 static inline unsigned int cfs_power2_roundup(unsigned int val)
 640 {
 641         if (val != LOWEST_BIT_SET(val)) { /* not a power of 2 already */
 642                 do {
 643                         val &= ~LOWEST_BIT_SET(val);
 644                 } while (val != LOWEST_BIT_SET(val));
 645                 /* ...and round up */
 646                 val <<= 1;
 647         }
 648         return val;
 649 }
 650
 651 #define LOGL(var,len,ptr)                                       \
 652 do {                                                            \
 653         if (var)                                                \
 654                 memcpy((char *)ptr, (const char *)var, len);    \
 655         ptr += cfs_size_round(len);                             \
 656 } while (0)
 657
 658 #define LOGU(var,len,ptr)                                       \
 659 do {                                                            \
 660         if (var)                                                \
 661                 memcpy((char *)var, (const char *)ptr, len);    \
 662         ptr += cfs_size_round(len);                             \
 663 } while (0)
 664
 665 #define LOGL0(var,len,ptr)                              \
 666 do {                                                    \
 667         if (!len)                                       \
 668                 break;                                  \
 669         memcpy((char *)ptr, (const char *)var, len);    \
 670         *((char *)(ptr) + len) = 0;                     \
 671         ptr += cfs_size_round(len + 1);                 \
 672 } while (0)
 673
 674 /**
 675  *  Lustre Network Driver types.
 676  */
 677 enum {
 678         /* Only add to these values (i.e. don't ever change or redefine them):
 679          * network addresses depend on them... */
 680         QSWLND    = 1,
 681         SOCKLND   = 2,
 682         GMLND     = 3, /* obsolete, keep it so that libcfs_nid2str works */
 683         PTLLND    = 4,
 684         O2IBLND   = 5,
 685         CIBLND    = 6,
 686         OPENIBLND = 7,
 687         IIBLND    = 8,
 688         LOLND     = 9,
 689         RALND     = 10,
 690         VIBLND    = 11,
 691         MXLND     = 12,
 692         GNILND    = 13,
 693 };
 694
 695 #endif