Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * sysctl.h: General linux system control interface | |
3 | * | |
4 | * Begun 24 March 1995, Stephen Tweedie | |
5 | * | |
6 | **************************************************************** | |
7 | **************************************************************** | |
8 | ** | |
7cc13edc | 9 | ** WARNING: |
1da177e4 | 10 | ** The values in this file are exported to user space via |
7cc13edc EB |
11 | ** the sysctl() binary interface. Do *NOT* change the |
12 | ** numbering of any existing values here, and do not change | |
13 | ** any numbers within any one set of values. If you have to | |
93aec204 | 14 | ** redefine an existing interface, use a new number for it. |
7cc13edc EB |
15 | ** The kernel will then return -ENOTDIR to any application using |
16 | ** the old binary interface. | |
17 | ** | |
1da177e4 LT |
18 | **************************************************************** |
19 | **************************************************************** | |
20 | */ | |
1da177e4 LT |
21 | #ifndef _LINUX_SYSCTL_H |
22 | #define _LINUX_SYSCTL_H | |
23 | ||
d4ed803c | 24 | #include <linux/list.h> |
684adca4 | 25 | #include <linux/rcupdate.h> |
f1ecf068 | 26 | #include <linux/wait.h> |
ac13ac6f | 27 | #include <linux/rbtree.h> |
607ca46e | 28 | #include <uapi/linux/sysctl.h> |
1da177e4 | 29 | |
805b5d5e | 30 | /* For the /proc/sys support */ |
db3f6001 | 31 | struct completion; |
1ff007eb | 32 | struct ctl_table; |
e51b6ba0 | 33 | struct nsproxy; |
d7321cd6 | 34 | struct ctl_table_root; |
f7e6ced4 | 35 | struct ctl_table_header; |
7ec66d06 | 36 | struct ctl_dir; |
f7e6ced4 | 37 | |
8d65af78 | 38 | typedef int proc_handler (struct ctl_table *ctl, int write, |
1da177e4 LT |
39 | void __user *buffer, size_t *lenp, loff_t *ppos); |
40 | ||
8d65af78 | 41 | extern int proc_dostring(struct ctl_table *, int, |
1da177e4 | 42 | void __user *, size_t *, loff_t *); |
8d65af78 | 43 | extern int proc_dointvec(struct ctl_table *, int, |
1da177e4 | 44 | void __user *, size_t *, loff_t *); |
8d65af78 | 45 | extern int proc_dointvec_minmax(struct ctl_table *, int, |
1da177e4 | 46 | void __user *, size_t *, loff_t *); |
8d65af78 | 47 | extern int proc_dointvec_jiffies(struct ctl_table *, int, |
1da177e4 | 48 | void __user *, size_t *, loff_t *); |
8d65af78 | 49 | extern int proc_dointvec_userhz_jiffies(struct ctl_table *, int, |
1da177e4 | 50 | void __user *, size_t *, loff_t *); |
8d65af78 | 51 | extern int proc_dointvec_ms_jiffies(struct ctl_table *, int, |
1da177e4 | 52 | void __user *, size_t *, loff_t *); |
8d65af78 | 53 | extern int proc_doulongvec_minmax(struct ctl_table *, int, |
1da177e4 | 54 | void __user *, size_t *, loff_t *); |
d8217f07 | 55 | extern int proc_doulongvec_ms_jiffies_minmax(struct ctl_table *table, int, |
8d65af78 | 56 | void __user *, size_t *, loff_t *); |
9f977fb7 OP |
57 | extern int proc_do_large_bitmap(struct ctl_table *, int, |
58 | void __user *, size_t *, loff_t *); | |
1da177e4 | 59 | |
1da177e4 LT |
60 | /* |
61 | * Register a set of sysctl names by calling register_sysctl_table | |
2315ffa0 EB |
62 | * with an initialised array of struct ctl_table's. An entry with |
63 | * NULL procname terminates the table. table->de will be | |
d99f160a | 64 | * set up by the registration and need not be initialised in advance. |
1da177e4 LT |
65 | * |
66 | * sysctl names can be mirrored automatically under /proc/sys. The | |
67 | * procname supplied controls /proc naming. | |
68 | * | |
69 | * The table's mode will be honoured both for sys_sysctl(2) and | |
70 | * proc-fs access. | |
71 | * | |
72 | * Leaf nodes in the sysctl tree will be represented by a single file | |
73 | * under /proc; non-leaf nodes will be represented by directories. A | |
74 | * null procname disables /proc mirroring at this node. | |
d99f160a | 75 | * |
1da177e4 LT |
76 | * sysctl(2) can automatically manage read and write requests through |
77 | * the sysctl table. The data and maxlen fields of the ctl_table | |
78 | * struct enable minimal validation of the values being written to be | |
79 | * performed, and the mode field allows minimal authentication. | |
80 | * | |
1da177e4 LT |
81 | * There must be a proc_handler routine for any terminal nodes |
82 | * mirrored under /proc/sys (non-terminals are handled by a built-in | |
83 | * directory handler). Several default handlers are available to | |
84 | * cover common cases. | |
85 | */ | |
86 | ||
f1ecf068 LDM |
87 | /* Support for userspace poll() to watch for changes */ |
88 | struct ctl_table_poll { | |
89 | atomic_t event; | |
90 | wait_queue_head_t wait; | |
91 | }; | |
92 | ||
93 | static inline void *proc_sys_poll_event(struct ctl_table_poll *poll) | |
94 | { | |
95 | return (void *)(unsigned long)atomic_read(&poll->event); | |
96 | } | |
97 | ||
f1ecf068 LDM |
98 | #define __CTL_TABLE_POLL_INITIALIZER(name) { \ |
99 | .event = ATOMIC_INIT(0), \ | |
100 | .wait = __WAIT_QUEUE_HEAD_INITIALIZER(name.wait) } | |
101 | ||
102 | #define DEFINE_CTL_TABLE_POLL(name) \ | |
103 | struct ctl_table_poll name = __CTL_TABLE_POLL_INITIALIZER(name) | |
104 | ||
1da177e4 LT |
105 | /* A sysctl table is an array of struct ctl_table: */ |
106 | struct ctl_table | |
107 | { | |
1da177e4 LT |
108 | const char *procname; /* Text ID for /proc/sys, or zero */ |
109 | void *data; | |
110 | int maxlen; | |
36fcb589 | 111 | umode_t mode; |
f728019b | 112 | struct ctl_table *child; /* Deprecated */ |
1da177e4 | 113 | proc_handler *proc_handler; /* Callback for text formatting */ |
f1ecf068 | 114 | struct ctl_table_poll *poll; |
1da177e4 LT |
115 | void *extra1; |
116 | void *extra2; | |
117 | }; | |
118 | ||
ac13ac6f EB |
119 | struct ctl_node { |
120 | struct rb_node node; | |
121 | struct ctl_table_header *header; | |
122 | }; | |
123 | ||
1da177e4 | 124 | /* struct ctl_table_header is used to maintain dynamic lists of |
d8217f07 | 125 | struct ctl_table trees. */ |
1da177e4 LT |
126 | struct ctl_table_header |
127 | { | |
dfef6dcd AV |
128 | union { |
129 | struct { | |
130 | struct ctl_table *ctl_table; | |
dfef6dcd AV |
131 | int used; |
132 | int count; | |
938aaa4f | 133 | int nreg; |
dfef6dcd AV |
134 | }; |
135 | struct rcu_head rcu; | |
136 | }; | |
330d57fb | 137 | struct completion *unregistering; |
23eb06de | 138 | struct ctl_table *ctl_table_arg; |
e51b6ba0 | 139 | struct ctl_table_root *root; |
73455092 | 140 | struct ctl_table_set *set; |
7ec66d06 | 141 | struct ctl_dir *parent; |
ac13ac6f | 142 | struct ctl_node *node; |
7ec66d06 EB |
143 | }; |
144 | ||
145 | struct ctl_dir { | |
146 | /* Header must be at the start of ctl_dir */ | |
147 | struct ctl_table_header header; | |
ac13ac6f | 148 | struct rb_root root; |
1da177e4 LT |
149 | }; |
150 | ||
0ce8974d | 151 | struct ctl_table_set { |
0ce8974d | 152 | int (*is_seen)(struct ctl_table_set *); |
0e47c99d | 153 | struct ctl_dir dir; |
0ce8974d EB |
154 | }; |
155 | ||
156 | struct ctl_table_root { | |
0ce8974d EB |
157 | struct ctl_table_set default_set; |
158 | struct ctl_table_set *(*lookup)(struct ctl_table_root *root, | |
159 | struct nsproxy *namespaces); | |
73f7ef43 | 160 | int (*permissions)(struct ctl_table_header *head, struct ctl_table *table); |
0ce8974d EB |
161 | }; |
162 | ||
29e796fd EB |
163 | /* struct ctl_path describes where in the hierarchy a table is added */ |
164 | struct ctl_path { | |
165 | const char *procname; | |
29e796fd EB |
166 | }; |
167 | ||
0ce8974d EB |
168 | #ifdef CONFIG_SYSCTL |
169 | ||
170 | void proc_sys_poll_notify(struct ctl_table_poll *poll); | |
171 | ||
172 | extern void setup_sysctl_set(struct ctl_table_set *p, | |
9eb47c26 | 173 | struct ctl_table_root *root, |
0ce8974d | 174 | int (*is_seen)(struct ctl_table_set *)); |
97324cd8 | 175 | extern void retire_sysctl_set(struct ctl_table_set *set); |
0ce8974d | 176 | |
e51b6ba0 | 177 | void register_sysctl_root(struct ctl_table_root *root); |
6e9d5164 | 178 | struct ctl_table_header *__register_sysctl_table( |
60a47a2e | 179 | struct ctl_table_set *set, |
6e9d5164 | 180 | const char *path, struct ctl_table *table); |
e51b6ba0 | 181 | struct ctl_table_header *__register_sysctl_paths( |
60a47a2e | 182 | struct ctl_table_set *set, |
e51b6ba0 | 183 | const struct ctl_path *path, struct ctl_table *table); |
fea478d4 | 184 | struct ctl_table_header *register_sysctl(const char *path, struct ctl_table *table); |
d8217f07 | 185 | struct ctl_table_header *register_sysctl_table(struct ctl_table * table); |
29e796fd EB |
186 | struct ctl_table_header *register_sysctl_paths(const struct ctl_path *path, |
187 | struct ctl_table *table); | |
0b4d4147 | 188 | |
1da177e4 LT |
189 | void unregister_sysctl_table(struct ctl_table_header * table); |
190 | ||
de4e83bd | 191 | extern int sysctl_init(void); |
f9bd6733 EB |
192 | |
193 | extern struct ctl_table sysctl_mount_point[]; | |
194 | ||
0ce8974d EB |
195 | #else /* CONFIG_SYSCTL */ |
196 | static inline struct ctl_table_header *register_sysctl_table(struct ctl_table * table) | |
197 | { | |
198 | return NULL; | |
199 | } | |
200 | ||
201 | static inline struct ctl_table_header *register_sysctl_paths( | |
202 | const struct ctl_path *path, struct ctl_table *table) | |
203 | { | |
204 | return NULL; | |
205 | } | |
206 | ||
207 | static inline void unregister_sysctl_table(struct ctl_table_header * table) | |
208 | { | |
209 | } | |
210 | ||
211 | static inline void setup_sysctl_set(struct ctl_table_set *p, | |
9eb47c26 | 212 | struct ctl_table_root *root, |
0ce8974d EB |
213 | int (*is_seen)(struct ctl_table_set *)) |
214 | { | |
215 | } | |
216 | ||
0ce8974d EB |
217 | #endif /* CONFIG_SYSCTL */ |
218 | ||
16db3d3f HS |
219 | int sysctl_max_threads(struct ctl_table *table, int write, |
220 | void __user *buffer, size_t *lenp, loff_t *ppos); | |
221 | ||
1da177e4 | 222 | #endif /* _LINUX_SYSCTL_H */ |