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