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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef __LIBCFS_LIBCFS_H__
38 #define __LIBCFS_LIBCFS_H__
40 #include <libcfs/types.h>
41 #include <libcfs/list.h>
44 # include <libcfs/linux/libcfs.h>
45 #else /* !__KERNEL__ */
60 # include <sys/ioctl.h>
61 # include <sys/socket.h>
62 # include <sys/stat.h>
63 # include <sys/time.h>
64 # include <sys/types.h>
65 # include <libcfs/user-time.h>
66 #endif /* __KERNEL__ */
71 #define ARRAY_SIZE(a) ((sizeof (a)) / (sizeof ((a)[0])))
75 #define swap(x,y) do { typeof(x) z = x; x = y; y = z; } while (0)
78 #if !defined(container_of)
79 /* given a pointer @ptr to the field @member embedded into type (usually
80 * struct) @type, return pointer to the embedding instance of @type. */
81 #define container_of(ptr, type, member) \
82 ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
85 static inline int __is_po2(unsigned long long val)
87 return !(val & (val - 1));
90 #define IS_PO2(val) __is_po2((unsigned long long)(val))
92 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
94 /* Sparse annotations */
96 # if !defined(__must_hold)
98 # define __must_hold(x) __attribute__((context(x, 1, 1)))
99 # else /* __CHECKER__ */
100 # define __must_hold(x)
101 # endif /* !__CHECKER__ */
102 # endif /* !__must_hold */
103 #else /* __KERNEL__ */
104 # define __acquires(x)
105 # define __releases(x)
106 # define __must_hold(x)
107 #endif /* !__KERNEL__ */
110 * Lustre Error Checksum: calculates checksum
111 * of Hex number by XORing each bit.
113 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
114 ((hexnum) >> 8 & 0xf))
117 * Some (nomina odiosa sunt) platforms define NULL as naked 0. This confuses
118 * Lustre RETURN(NULL) macro.
124 #define NULL ((void *)0)
128 /* libcfs watchdogs */
131 /* Add a watchdog which fires after "time" milliseconds of delay. You have to
132 * touch it once to enable it. */
133 struct lc_watchdog *lc_watchdog_add(int time,
134 void (*cb)(pid_t pid, void *),
137 /* Enables a watchdog and resets its timer. */
138 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
139 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout, \
140 AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
141 svc->srv_watchdog_factor)
143 /* Disable a watchdog; touch it to restart it. */
144 void lc_watchdog_disable(struct lc_watchdog *lcw);
146 /* Clean up the watchdog */
147 void lc_watchdog_delete(struct lc_watchdog *lcw);
149 /* Dump a debug log */
150 void lc_watchdog_dumplog(pid_t pid, void *data);
152 #endif /* __KERNEL__ */
154 /* need both kernel and user-land acceptor */
155 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
156 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
159 * libcfs pseudo device operations
161 * struct struct miscdevice and
162 * misc_register() and
163 * misc_deregister() are declared in
164 * libcfs/<os>/<os>-prim.h
166 * It's just draft now.
169 struct cfs_psdev_file {
172 unsigned long reserved1;
173 unsigned long reserved2;
176 struct cfs_psdev_ops {
177 int (*p_open)(unsigned long, void *);
178 int (*p_close)(unsigned long, void *);
179 int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
180 int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
181 int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void __user *);
185 * Drop into debugger, if possible. Implementation is provided by platform.
188 void cfs_enter_debugger(void);
191 * Defined by platform
193 int unshare_fs_struct(void);
194 sigset_t cfs_block_allsigs(void);
195 sigset_t cfs_block_sigs(unsigned long sigs);
196 sigset_t cfs_block_sigsinv(unsigned long sigs);
197 void cfs_restore_sigs(sigset_t);
198 void cfs_clear_sigpending(void);
200 int convert_server_error(__u64 ecode);
201 int convert_client_oflag(int cflag, int *result);
204 * Stack-tracing filling.
208 * Platform-dependent data-type to hold stack frames.
210 struct cfs_stack_trace;
213 * Fill @trace with current back-trace.
215 void cfs_stack_trace_fill(struct cfs_stack_trace *trace);
218 * Return instruction pointer for frame @frame_no. NULL if @frame_no is
221 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no);
224 * Random number handling
227 /* returns a random 32-bit integer */
228 unsigned int cfs_rand(void);
229 /* seed the generator */
230 void cfs_srand(unsigned int, unsigned int);
231 void cfs_get_random_bytes(void *buf, int size);
233 #include <libcfs/byteorder.h>
234 #include <libcfs/err.h>
235 #include <libcfs/libcfs_debug.h>
236 #include <libcfs/libcfs_private.h>
238 # include <libcfs/bitmap.h>
239 # include <libcfs/libcfs_cpu.h>
240 # include <libcfs/libcfs_ioctl.h>
241 # include <libcfs/libcfs_prim.h>
242 #endif /* __KERNEL__ */
243 #include <libcfs/libcfs_time.h>
245 # include <libcfs/libcfs_string.h>
247 #include <libcfs/libcfs_workitem.h>
249 # include <libcfs/libcfs_hash.h>
250 # include <libcfs/libcfs_heap.h>
251 # include <libcfs/libcfs_fail.h>
252 #endif /* __KERNEL__ */
254 /* container_of depends on "likely" which is defined in libcfs_private.h */
255 static inline void *__container_of(const void *ptr, unsigned long shift)
257 if (unlikely(IS_ERR(ptr) || ptr == NULL))
258 return ERR_CAST(ptr);
260 return (char *)ptr - shift;
263 #define container_of0(ptr, type, member) \
264 ((type *)__container_of((ptr), offsetof(type, member)))
266 #endif /* _LIBCFS_LIBCFS_H_ */