libcfs/include/libcfs/libcfs.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, 2015, 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
  37 #ifndef __LIBCFS_LIBCFS_H__
  38 #define __LIBCFS_LIBCFS_H__
  39
  40 #include <libcfs/list.h>
  41
  42 #ifdef __KERNEL__
  43 # include <libcfs/linux/libcfs.h>
  44 # include <libcfs/types.h>
  45 # include "curproc.h"
  46
  47 #define LIBCFS_VERSION  "0.5.0"
  48
  49 static inline int __is_po2(unsigned long long val)
  50 {
  51         return !(val & (val - 1));
  52 }
  53
  54 #define IS_PO2(val)       __is_po2((unsigned long long)(val))
  55 #define PO2_ROUNDUP_TYPED(x, po2, type) (-(-(type)(x) & -(type)(po2)))
  56 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
  57
  58 /* Sparse annotations */
  59 #if !defined(__must_hold)
  60 # ifdef __CHECKER__
  61 #  define __must_hold(x) __attribute__((context(x, 1, 1)))
  62 # else  /* __CHECKER__ */
  63 #  define __must_hold(x)
  64 # endif /* !__CHECKER__ */
  65 #endif /* !__must_hold */
  66
  67 /* libcfs watchdogs */
  68 struct lc_watchdog;
  69
  70 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
  71  * touch it once to enable it. */
  72 struct lc_watchdog *lc_watchdog_add(int time,
  73                                     void (*cb)(pid_t pid, void *),
  74                                     void *data);
  75
  76 /* Enables a watchdog and resets its timer. */
  77 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
  78 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout,                   \
  79                           AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
  80                           svc->srv_watchdog_factor)
  81
  82 /* Disable a watchdog; touch it to restart it. */
  83 void lc_watchdog_disable(struct lc_watchdog *lcw);
  84
  85 /* Clean up the watchdog */
  86 void lc_watchdog_delete(struct lc_watchdog *lcw);
  87
  88 /* need both kernel and user-land acceptor */
  89 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
  90 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
  91
  92 /*
  93  * Drop into debugger, if possible. Implementation is provided by platform.
  94  */
  95
  96 void cfs_enter_debugger(void);
  97
  98 /*
  99  * Defined by platform
 100  */
 101 int unshare_fs_struct(void);
 102 sigset_t cfs_block_allsigs(void);
 103 sigset_t cfs_block_sigs(unsigned long sigs);
 104 sigset_t cfs_block_sigsinv(unsigned long sigs);
 105 void cfs_restore_sigs(sigset_t);
 106 void cfs_clear_sigpending(void);
 107
 108 /*
 109  * Random number handling
 110  */
 111
 112 /* returns a random 32-bit integer */
 113 unsigned int cfs_rand(void);
 114 /* seed the generator */
 115 void cfs_srand(unsigned int, unsigned int);
 116 void cfs_get_random_bytes(void *buf, int size);
 117 #endif /* __KERNEL__ */
 118
 119 #include <libcfs/byteorder.h>
 120 #include <libcfs/libcfs_debug.h>
 121 #include <libcfs/libcfs_private.h>
 122 #ifdef __KERNEL__
 123 # include <libcfs/bitmap.h>
 124 # include <libcfs/libcfs_cpu.h>
 125 # include <libcfs/libcfs_ioctl.h>
 126 # include <libcfs/libcfs_prim.h>
 127 # include <libcfs/libcfs_time.h>
 128 # include <libcfs/libcfs_string.h>
 129 # include <libcfs/libcfs_workitem.h>
 130 # include <libcfs/libcfs_hash.h>
 131 # include <libcfs/libcfs_heap.h>
 132 # include <libcfs/libcfs_fail.h>
 133
 134 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 135 int libcfs_ioctl(unsigned long cmd, void __user *uparam);
 136
 137 /* container_of depends on "likely" which is defined in libcfs_private.h */
 138 static inline void *__container_of(const void *ptr, unsigned long shift)
 139 {
 140         if (unlikely(IS_ERR(ptr) || ptr == NULL))
 141                 return ERR_CAST(ptr);
 142         else
 143                 return (char *)ptr - shift;
 144 }
 145
 146 #define container_of0(ptr, type, member)                                \
 147         ((type *)__container_of((ptr), offsetof(type, member)))
 148
 149 #endif /* __KERNEL__ */
 150
 151 #endif /* _LIBCFS_LIBCFS_H_ */