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, 2017, 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__
36 #include <uapi/linux/lnet/libcfs_ioctl.h>
37 #include <libcfs/libcfs_debug.h>
38 #include <libcfs/libcfs_private.h>
39 #include <libcfs/bitmap.h>
40 #include <libcfs/libcfs_cpu.h>
41 #include <libcfs/libcfs_prim.h>
42 #include <libcfs/libcfs_time.h>
43 #include <libcfs/libcfs_string.h>
44 #include <libcfs/libcfs_workitem.h>
45 #include <libcfs/libcfs_hash.h>
46 #include <libcfs/libcfs_heap.h>
47 #include <libcfs/libcfs_fail.h>
50 #define LIBCFS_VERSION "0.5.0"
52 #define PO2_ROUNDUP_TYPED(x, po2, type) (-(-(type)(x) & -(type)(po2)))
53 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
55 /* Sparse annotations */
56 #if !defined(__must_hold)
58 # define __must_hold(x) __attribute__((context(x, 1, 1)))
59 # else /* __CHECKER__ */
60 # define __must_hold(x)
61 # endif /* !__CHECKER__ */
62 #endif /* !__must_hold */
64 /* libcfs watchdogs */
67 /* Add a watchdog which fires after "time" milliseconds of delay. You have to
68 * touch it once to enable it. */
69 struct lc_watchdog *lc_watchdog_add(int time,
70 void (*cb)(pid_t pid, void *),
73 /* Enables a watchdog and resets its timer. */
74 void lc_watchdog_touch(struct lc_watchdog *lcw, int timeout);
75 #define CFS_GET_TIMEOUT(svc) (max_t(int, obd_timeout, \
76 AT_OFF ? 0 : at_get(&svc->srv_at_estimate)) * \
77 svc->srv_watchdog_factor)
79 /* Disable a watchdog; touch it to restart it. */
80 void lc_watchdog_disable(struct lc_watchdog *lcw);
82 /* Clean up the watchdog */
83 void lc_watchdog_delete(struct lc_watchdog *lcw);
85 /* need both kernel and user-land acceptor */
86 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
87 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
92 int unshare_fs_struct(void);
93 sigset_t cfs_block_allsigs(void);
94 sigset_t cfs_block_sigs(unsigned long sigs);
95 sigset_t cfs_block_sigsinv(unsigned long sigs);
96 void cfs_restore_sigs(sigset_t);
97 void cfs_clear_sigpending(void);
100 * Random number handling
103 /* returns a random 32-bit integer */
104 unsigned int cfs_rand(void);
105 /* seed the generator */
106 void cfs_srand(unsigned int, unsigned int);
107 void cfs_get_random_bytes(void *buf, int size);
109 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
110 int libcfs_ioctl(unsigned long cmd, void __user *uparam);
112 /* container_of depends on "likely" which is defined in libcfs_private.h */
113 static inline void *__container_of(const void *ptr, unsigned long shift)
115 if (unlikely(IS_ERR(ptr) || ptr == NULL))
116 return ERR_CAST(ptr);
118 return (char *)ptr - shift;
121 #define container_of0(ptr, type, member) \
122 ((type *)__container_of((ptr), offsetof(type, member)))
124 struct lnet_debugfs_symlink_def {
129 void lnet_insert_debugfs(struct ctl_table *table,
130 const struct lnet_debugfs_symlink_def *symlinks);
132 /* helper for sysctl handlers */
133 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
134 void __user *buffer, size_t *lenp,
135 int (*handler)(void *data, int write, loff_t pos,
136 void __user *buffer, int len));
138 #endif /* _LIBCFS_LIBCFS_H_ */