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/
32 #ifndef __LIBCFS_LIBCFS_H__
33 #define __LIBCFS_LIBCFS_H__
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/workqueue.h>
38 #include <linux/sched.h>
39 #ifdef HAVE_SCHED_HEADERS
40 #include <linux/sched/signal.h>
43 #include <libcfs/linux/linux-misc.h>
44 #include <libcfs/linux/linux-mem.h>
45 #include <libcfs/linux/linux-time.h>
46 #include <libcfs/linux/linux-wait.h>
47 #include <libcfs/linux/linux-fortify-string.h>
49 #include <uapi/linux/lnet/libcfs_ioctl.h>
50 #include <libcfs/libcfs_debug.h>
51 #include <libcfs/libcfs_private.h>
52 #include <libcfs/libcfs_cpu.h>
53 #include <libcfs/libcfs_string.h>
54 #include <libcfs/libcfs_hash.h>
55 #include <libcfs/libcfs_fail.h>
57 #define LIBCFS_VERSION "0.7.1"
59 /* Sparse annotations */
60 #if !defined(__must_hold)
62 # define __must_hold(x) __attribute__((context(x, 1, 1)))
63 # else /* __CHECKER__ */
64 # define __must_hold(x)
65 # endif /* !__CHECKER__ */
66 #endif /* !__must_hold */
68 typedef s32 timeout_t;
70 int libcfs_ioctl(unsigned int cmd, struct libcfs_ioctl_data *data);
72 extern struct workqueue_struct *cfs_rehash_wq;
74 void lnet_insert_debugfs(struct ctl_table *table, struct module *mod,
76 void lnet_remove_debugfs(struct ctl_table *table);
77 void lnet_debugfs_fini(void **statep);
79 /* helper for sysctl handlers */
80 int debugfs_doint(struct ctl_table *table, int write,
81 void __user *buffer, size_t *lenp, loff_t *ppos);
86 #if BITS_PER_LONG == 32
87 /* limit to lowmem on 32-bit systems */
88 #define NUM_CACHEPAGES \
89 min(cfs_totalram_pages(), 1UL << (30 - PAGE_SHIFT) * 3 / 4)
91 #define NUM_CACHEPAGES cfs_totalram_pages()
94 #define wait_var_event_warning(var, condition, format, ...) \
100 ___wait_var_event(var, condition, TASK_UNINTERRUPTIBLE, 0, 0, \
101 if (schedule_timeout(cfs_time_seconds(1)) == 0)\
102 CDEBUG(is_power_of_2(counter++) ? \
104 format, ## __VA_ARGS__) \
108 /* atomic-context safe vfree */
109 void libcfs_vfree_atomic(const void *addr);
113 #ifdef HAVE_INTERVAL_TREE_CACHED
114 #define interval_tree_root rb_root_cached
115 #define interval_tree_first rb_first_cached
116 #define INTERVAL_TREE_ROOT RB_ROOT_CACHED
118 #define interval_tree_root rb_root
119 #define interval_tree_first rb_first
120 #define INTERVAL_TREE_ROOT RB_ROOT
121 #endif /* HAVE_INTERVAL_TREE_CACHED */
123 #ifndef unsafe_memcpy
124 #define unsafe_memcpy(to, from, size, reason) memcpy((to), (from), (size))
127 #define FLEXIBLE_OBJECT \
128 "Struct contains a flexible member, the size of object is checked" \
129 "and can be safely copied in a single memcpy()"
131 #endif /* _LIBCFS_LIBCFS_H_ */