4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef __LIBCFS_LIBCFS_H__
34 #define __LIBCFS_LIBCFS_H__
37 # include <libcfs/linux/libcfs.h>
40 #define LIBCFS_VERSION "0.5.0"
42 static inline int __is_po2(unsigned long long val)
44 return !(val & (val - 1));
47 #define IS_PO2(val) __is_po2((unsigned long long)(val))
48 #define PO2_ROUNDUP_TYPED(x, po2, type) (-(-(type)(x) & -(type)(po2)))
49 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
51 /* Sparse annotations */
52 #if !defined(__must_hold)
54 # define __must_hold(x) __attribute__((context(x, 1, 1)))
55 # else /* __CHECKER__ */
56 # define __must_hold(x)
57 # endif /* !__CHECKER__ */
58 #endif /* !__must_hold */
60 /* libcfs watchdogs */
63 /* Add a watchdog which fires after "time" milliseconds of delay. You have to
64 * touch it once to enable it. */
65 struct lc_watchdog *lc_watchdog_add(int time,
66 void (*cb)(pid_t pid, void *),
69 /* Enables a watchdog and resets its timer. */
70 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
71 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout, \
72 AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
73 svc->srv_watchdog_factor)
75 /* Disable a watchdog; touch it to restart it. */
76 void lc_watchdog_disable(struct lc_watchdog *lcw);
78 /* Clean up the watchdog */
79 void lc_watchdog_delete(struct lc_watchdog *lcw);
81 /* need both kernel and user-land acceptor */
82 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
83 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
86 * Drop into debugger, if possible. Implementation is provided by platform.
89 void cfs_enter_debugger(void);
94 int unshare_fs_struct(void);
95 sigset_t cfs_block_allsigs(void);
96 sigset_t cfs_block_sigs(unsigned long sigs);
97 sigset_t cfs_block_sigsinv(unsigned long sigs);
98 void cfs_restore_sigs(sigset_t);
99 void cfs_clear_sigpending(void);
102 * Random number handling
105 /* returns a random 32-bit integer */
106 unsigned int cfs_rand(void);
107 /* seed the generator */
108 void cfs_srand(unsigned int, unsigned int);
109 void cfs_get_random_bytes(void *buf, int size);
110 #endif /* __KERNEL__ */
112 #include <libcfs/libcfs_debug.h>
114 # include <libcfs/libcfs_private.h>
115 # include <libcfs/bitmap.h>
116 # include <libcfs/libcfs_cpu.h>
117 # include <libcfs/libcfs_ioctl.h>
118 # include <libcfs/libcfs_prim.h>
119 # include <libcfs/libcfs_time.h>
120 # include <libcfs/libcfs_string.h>
121 # include <libcfs/libcfs_workitem.h>
122 # include <libcfs/libcfs_hash.h>
123 # include <libcfs/libcfs_heap.h>
124 # include <libcfs/libcfs_fail.h>
126 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
127 int libcfs_ioctl(unsigned long cmd, void __user *uparam);
129 /* container_of depends on "likely" which is defined in libcfs_private.h */
130 static inline void *__container_of(const void *ptr, unsigned long shift)
132 if (unlikely(IS_ERR(ptr) || ptr == NULL))
133 return ERR_CAST(ptr);
135 return (char *)ptr - shift;
138 #define container_of0(ptr, type, member) \
139 ((type *)__container_of((ptr), offsetof(type, member)))
141 #endif /* __KERNEL__ */
143 #endif /* _LIBCFS_LIBCFS_H_ */