Whamcloud - gitweb
LU-9859 libcfs: make lnet_debugfs_symlink_def local to libcfs/modules.c
[fs/lustre-release.git] / 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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  */
31
32 #ifndef __LIBCFS_LIBCFS_H__
33 #define __LIBCFS_LIBCFS_H__
34
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>
41 #endif
42
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
48 #include <uapi/linux/lnet/libcfs_ioctl.h>
49 #include <libcfs/libcfs_debug.h>
50 #include <libcfs/libcfs_private.h>
51 #include <libcfs/bitmap.h>
52 #include <libcfs/libcfs_cpu.h>
53 #include <libcfs/libcfs_string.h>
54 #include <libcfs/libcfs_workitem.h>
55 #include <libcfs/libcfs_hash.h>
56 #include <libcfs/libcfs_fail.h>
57 #include "curproc.h"
58
59 #define LIBCFS_VERSION  "0.7.1"
60
61 /* Sparse annotations */
62 #if !defined(__must_hold)
63 # ifdef __CHECKER__
64 #  define __must_hold(x) __attribute__((context(x, 1, 1)))
65 # else  /* __CHECKER__ */
66 #  define __must_hold(x)
67 # endif /* !__CHECKER__ */
68 #endif /* !__must_hold */
69
70 typedef s32 timeout_t;
71
72 /* need both kernel and user-land acceptor */
73 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
74 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
75
76 extern struct blocking_notifier_head libcfs_ioctl_list;
77 static inline int notifier_from_ioctl_errno(int err)
78 {
79         if (err == -EINVAL)
80                 return NOTIFY_OK;
81         return notifier_from_errno(err) | NOTIFY_STOP_MASK;
82 }
83
84 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
85
86 extern struct workqueue_struct *cfs_rehash_wq;
87
88 void lnet_insert_debugfs(struct ctl_table *table);
89 void lnet_remove_debugfs(struct ctl_table *table);
90
91 /* helper for sysctl handlers */
92 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
93                          void __user *buffer, size_t *lenp,
94                          int (*handler)(void *data, int write, loff_t pos,
95                                         void __user *buffer, int len));
96 int debugfs_doint(struct ctl_table *table, int write,
97                   void __user *buffer, size_t *lenp, loff_t *ppos);
98
99 /*
100  * Memory
101  */
102 #if BITS_PER_LONG == 32
103 /* limit to lowmem on 32-bit systems */
104 #define NUM_CACHEPAGES \
105         min(cfs_totalram_pages(), 1UL << (30 - PAGE_SHIFT) * 3 / 4)
106 #else
107 #define NUM_CACHEPAGES cfs_totalram_pages()
108 #endif
109
110 #define wait_var_event_warning(var, condition, format, ...)             \
111 do {                                                                    \
112         int counter = 4;                                                \
113         might_sleep();                                                  \
114         if (condition)                                                  \
115                 break;                                                  \
116         ___wait_var_event(var, condition, TASK_UNINTERRUPTIBLE, 0, 0,   \
117                           if (schedule_timeout(cfs_time_seconds(1)) == 0)\
118                                   CDEBUG(is_power_of_2(counter++) ?     \
119                                          D_WARNING : D_NET,             \
120                                          format, ## __VA_ARGS__)        \
121                 );                                                      \
122 } while (0)
123
124 /* atomic-context safe vfree */
125 void libcfs_vfree_atomic(const void *addr);
126
127 /* interval tree */
128
129 #ifdef HAVE_INTERVAL_TREE_CACHED
130 #define interval_tree_root rb_root_cached
131 #define interval_tree_first rb_first_cached
132 #define INTERVAL_TREE_ROOT RB_ROOT_CACHED
133 #else
134 #define interval_tree_root rb_root
135 #define interval_tree_first rb_first
136 #define INTERVAL_TREE_ROOT RB_ROOT
137 #endif /* HAVE_INTERVAL_TREE_CACHED */
138
139 #endif /* _LIBCFS_LIBCFS_H_ */