Commit | Line | Data |
---|---|---|
b8441ed2 TH |
1 | /* |
2 | * kernfs.h - pseudo filesystem decoupled from vfs locking | |
3 | * | |
4 | * This file is released under the GPLv2. | |
5 | */ | |
6 | ||
7 | #ifndef __LINUX_KERNFS_H | |
8 | #define __LINUX_KERNFS_H | |
9 | ||
879f40d1 | 10 | #include <linux/kernel.h> |
5d0e26bb | 11 | #include <linux/err.h> |
dd8a5b03 TH |
12 | #include <linux/list.h> |
13 | #include <linux/mutex.h> | |
bc755553 | 14 | #include <linux/idr.h> |
517e64f5 | 15 | #include <linux/lockdep.h> |
cf9e5a73 TH |
16 | #include <linux/rbtree.h> |
17 | #include <linux/atomic.h> | |
18 | #include <linux/completion.h> | |
879f40d1 | 19 | |
5d60418e TH |
20 | struct file; |
21 | struct iattr; | |
dd8a5b03 TH |
22 | struct seq_file; |
23 | struct vm_area_struct; | |
4b93dc9b TH |
24 | struct super_block; |
25 | struct file_system_type; | |
5d60418e | 26 | |
c525aadd TH |
27 | struct kernfs_open_node; |
28 | struct kernfs_iattrs; | |
cf9e5a73 TH |
29 | |
30 | enum kernfs_node_type { | |
df23fc39 TH |
31 | KERNFS_DIR = 0x0001, |
32 | KERNFS_FILE = 0x0002, | |
33 | KERNFS_LINK = 0x0004, | |
cf9e5a73 TH |
34 | }; |
35 | ||
df23fc39 TH |
36 | #define KERNFS_TYPE_MASK 0x000f |
37 | #define KERNFS_COPY_NAME (KERNFS_DIR | KERNFS_LINK) | |
38 | #define KERNFS_ACTIVE_REF KERNFS_FILE | |
39 | #define KERNFS_FLAG_MASK ~KERNFS_TYPE_MASK | |
cf9e5a73 TH |
40 | |
41 | enum kernfs_node_flag { | |
df23fc39 TH |
42 | KERNFS_REMOVED = 0x0010, |
43 | KERNFS_NS = 0x0020, | |
44 | KERNFS_HAS_SEQ_SHOW = 0x0040, | |
45 | KERNFS_HAS_MMAP = 0x0080, | |
46 | KERNFS_LOCKDEP = 0x0100, | |
cf9e5a73 TH |
47 | }; |
48 | ||
324a56e1 TH |
49 | /* type-specific structures for kernfs_node union members */ |
50 | struct kernfs_elem_dir { | |
cf9e5a73 | 51 | unsigned long subdirs; |
adc5e8b5 | 52 | /* children rbtree starts here and goes through kn->rb */ |
cf9e5a73 TH |
53 | struct rb_root children; |
54 | ||
55 | /* | |
56 | * The kernfs hierarchy this directory belongs to. This fits | |
324a56e1 | 57 | * better directly in kernfs_node but is here to save space. |
cf9e5a73 TH |
58 | */ |
59 | struct kernfs_root *root; | |
60 | }; | |
61 | ||
324a56e1 TH |
62 | struct kernfs_elem_symlink { |
63 | struct kernfs_node *target_kn; | |
cf9e5a73 TH |
64 | }; |
65 | ||
324a56e1 | 66 | struct kernfs_elem_attr { |
cf9e5a73 | 67 | const struct kernfs_ops *ops; |
c525aadd | 68 | struct kernfs_open_node *open; |
cf9e5a73 TH |
69 | loff_t size; |
70 | }; | |
71 | ||
72 | /* | |
324a56e1 TH |
73 | * kernfs_node - the building block of kernfs hierarchy. Each and every |
74 | * kernfs node is represented by single kernfs_node. Most fields are | |
cf9e5a73 TH |
75 | * private to kernfs and shouldn't be accessed directly by kernfs users. |
76 | * | |
324a56e1 TH |
77 | * As long as s_count reference is held, the kernfs_node itself is |
78 | * accessible. Dereferencing elem or any other outer entity requires | |
79 | * active reference. | |
cf9e5a73 | 80 | */ |
324a56e1 | 81 | struct kernfs_node { |
adc5e8b5 TH |
82 | atomic_t count; |
83 | atomic_t active; | |
cf9e5a73 TH |
84 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
85 | struct lockdep_map dep_map; | |
86 | #endif | |
87 | /* the following two fields are published */ | |
adc5e8b5 TH |
88 | struct kernfs_node *parent; |
89 | const char *name; | |
cf9e5a73 | 90 | |
adc5e8b5 | 91 | struct rb_node rb; |
cf9e5a73 TH |
92 | |
93 | union { | |
94 | struct completion *completion; | |
324a56e1 | 95 | struct kernfs_node *removed_list; |
cf9e5a73 TH |
96 | } u; |
97 | ||
adc5e8b5 TH |
98 | const void *ns; /* namespace tag */ |
99 | unsigned int hash; /* ns + name hash */ | |
cf9e5a73 | 100 | union { |
adc5e8b5 TH |
101 | struct kernfs_elem_dir dir; |
102 | struct kernfs_elem_symlink symlink; | |
103 | struct kernfs_elem_attr attr; | |
cf9e5a73 TH |
104 | }; |
105 | ||
106 | void *priv; | |
107 | ||
adc5e8b5 TH |
108 | unsigned short flags; |
109 | umode_t mode; | |
110 | unsigned int ino; | |
c525aadd | 111 | struct kernfs_iattrs *iattr; |
cf9e5a73 | 112 | }; |
b8441ed2 | 113 | |
ba7443bc TH |
114 | struct kernfs_root { |
115 | /* published fields */ | |
324a56e1 | 116 | struct kernfs_node *kn; |
bc755553 TH |
117 | |
118 | /* private fields, do not use outside kernfs proper */ | |
119 | struct ida ino_ida; | |
ba7443bc TH |
120 | }; |
121 | ||
c525aadd | 122 | struct kernfs_open_file { |
dd8a5b03 | 123 | /* published fields */ |
324a56e1 | 124 | struct kernfs_node *kn; |
dd8a5b03 TH |
125 | struct file *file; |
126 | ||
127 | /* private fields, do not use outside kernfs proper */ | |
128 | struct mutex mutex; | |
129 | int event; | |
130 | struct list_head list; | |
131 | ||
132 | bool mmapped; | |
133 | const struct vm_operations_struct *vm_ops; | |
134 | }; | |
135 | ||
f6acf8bb TH |
136 | struct kernfs_ops { |
137 | /* | |
138 | * Read is handled by either seq_file or raw_read(). | |
139 | * | |
d19b9846 TH |
140 | * If seq_show() is present, seq_file path is active. Other seq |
141 | * operations are optional and if not implemented, the behavior is | |
142 | * equivalent to single_open(). @sf->private points to the | |
c525aadd | 143 | * associated kernfs_open_file. |
f6acf8bb TH |
144 | * |
145 | * read() is bounced through kernel buffer and a read larger than | |
146 | * PAGE_SIZE results in partial operation of PAGE_SIZE. | |
147 | */ | |
148 | int (*seq_show)(struct seq_file *sf, void *v); | |
d19b9846 TH |
149 | |
150 | void *(*seq_start)(struct seq_file *sf, loff_t *ppos); | |
151 | void *(*seq_next)(struct seq_file *sf, void *v, loff_t *ppos); | |
152 | void (*seq_stop)(struct seq_file *sf, void *v); | |
f6acf8bb | 153 | |
c525aadd | 154 | ssize_t (*read)(struct kernfs_open_file *of, char *buf, size_t bytes, |
f6acf8bb TH |
155 | loff_t off); |
156 | ||
157 | /* | |
158 | * write() is bounced through kernel buffer and a write larger than | |
159 | * PAGE_SIZE results in partial operation of PAGE_SIZE. | |
160 | */ | |
c525aadd | 161 | ssize_t (*write)(struct kernfs_open_file *of, char *buf, size_t bytes, |
f6acf8bb TH |
162 | loff_t off); |
163 | ||
c525aadd | 164 | int (*mmap)(struct kernfs_open_file *of, struct vm_area_struct *vma); |
517e64f5 TH |
165 | |
166 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
167 | struct lock_class_key lockdep_key; | |
168 | #endif | |
f6acf8bb TH |
169 | }; |
170 | ||
879f40d1 TH |
171 | #ifdef CONFIG_SYSFS |
172 | ||
df23fc39 | 173 | static inline enum kernfs_node_type kernfs_type(struct kernfs_node *kn) |
cf9e5a73 | 174 | { |
df23fc39 | 175 | return kn->flags & KERNFS_TYPE_MASK; |
cf9e5a73 TH |
176 | } |
177 | ||
178 | /** | |
179 | * kernfs_enable_ns - enable namespace under a directory | |
324a56e1 | 180 | * @kn: directory of interest, should be empty |
cf9e5a73 | 181 | * |
324a56e1 TH |
182 | * This is to be called right after @kn is created to enable namespace |
183 | * under it. All children of @kn must have non-NULL namespace tags and | |
cf9e5a73 TH |
184 | * only the ones which match the super_block's tag will be visible. |
185 | */ | |
324a56e1 | 186 | static inline void kernfs_enable_ns(struct kernfs_node *kn) |
cf9e5a73 | 187 | { |
df23fc39 | 188 | WARN_ON_ONCE(kernfs_type(kn) != KERNFS_DIR); |
adc5e8b5 | 189 | WARN_ON_ONCE(!RB_EMPTY_ROOT(&kn->dir.children)); |
df23fc39 | 190 | kn->flags |= KERNFS_NS; |
cf9e5a73 TH |
191 | } |
192 | ||
ac9bba03 TH |
193 | /** |
194 | * kernfs_ns_enabled - test whether namespace is enabled | |
324a56e1 | 195 | * @kn: the node to test |
ac9bba03 TH |
196 | * |
197 | * Test whether namespace filtering is enabled for the children of @ns. | |
198 | */ | |
324a56e1 | 199 | static inline bool kernfs_ns_enabled(struct kernfs_node *kn) |
ac9bba03 | 200 | { |
df23fc39 | 201 | return kn->flags & KERNFS_NS; |
ac9bba03 TH |
202 | } |
203 | ||
324a56e1 TH |
204 | struct kernfs_node *kernfs_find_and_get_ns(struct kernfs_node *parent, |
205 | const char *name, const void *ns); | |
206 | void kernfs_get(struct kernfs_node *kn); | |
207 | void kernfs_put(struct kernfs_node *kn); | |
ccf73cf3 | 208 | |
ba7443bc TH |
209 | struct kernfs_root *kernfs_create_root(void *priv); |
210 | void kernfs_destroy_root(struct kernfs_root *root); | |
211 | ||
324a56e1 | 212 | struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent, |
bb8b9d09 TH |
213 | const char *name, umode_t mode, |
214 | void *priv, const void *ns); | |
324a56e1 TH |
215 | struct kernfs_node *kernfs_create_file_ns_key(struct kernfs_node *parent, |
216 | const char *name, | |
217 | umode_t mode, loff_t size, | |
218 | const struct kernfs_ops *ops, | |
219 | void *priv, const void *ns, | |
220 | struct lock_class_key *key); | |
221 | struct kernfs_node *kernfs_create_link(struct kernfs_node *parent, | |
222 | const char *name, | |
223 | struct kernfs_node *target); | |
224 | void kernfs_remove(struct kernfs_node *kn); | |
225 | int kernfs_remove_by_name_ns(struct kernfs_node *parent, const char *name, | |
879f40d1 | 226 | const void *ns); |
324a56e1 | 227 | int kernfs_rename_ns(struct kernfs_node *kn, struct kernfs_node *new_parent, |
890ece16 | 228 | const char *new_name, const void *new_ns); |
324a56e1 TH |
229 | int kernfs_setattr(struct kernfs_node *kn, const struct iattr *iattr); |
230 | void kernfs_notify(struct kernfs_node *kn); | |
879f40d1 | 231 | |
4b93dc9b TH |
232 | const void *kernfs_super_ns(struct super_block *sb); |
233 | struct dentry *kernfs_mount_ns(struct file_system_type *fs_type, int flags, | |
234 | struct kernfs_root *root, const void *ns); | |
235 | void kernfs_kill_sb(struct super_block *sb); | |
236 | ||
237 | void kernfs_init(void); | |
238 | ||
879f40d1 TH |
239 | #else /* CONFIG_SYSFS */ |
240 | ||
df23fc39 | 241 | static inline enum kernfs_node_type kernfs_type(struct kernfs_node *kn) |
cf9e5a73 TH |
242 | { return 0; } /* whatever */ |
243 | ||
324a56e1 | 244 | static inline void kernfs_enable_ns(struct kernfs_node *kn) { } |
cf9e5a73 | 245 | |
324a56e1 | 246 | static inline bool kernfs_ns_enabled(struct kernfs_node *kn) |
ac9bba03 TH |
247 | { return false; } |
248 | ||
324a56e1 TH |
249 | static inline struct kernfs_node * |
250 | kernfs_find_and_get_ns(struct kernfs_node *parent, const char *name, | |
ccf73cf3 TH |
251 | const void *ns) |
252 | { return NULL; } | |
253 | ||
324a56e1 TH |
254 | static inline void kernfs_get(struct kernfs_node *kn) { } |
255 | static inline void kernfs_put(struct kernfs_node *kn) { } | |
ccf73cf3 | 256 | |
ba7443bc TH |
257 | static inline struct kernfs_root *kernfs_create_root(void *priv) |
258 | { return ERR_PTR(-ENOSYS); } | |
259 | ||
260 | static inline void kernfs_destroy_root(struct kernfs_root *root) { } | |
261 | ||
324a56e1 | 262 | static inline struct kernfs_node * |
bb8b9d09 TH |
263 | kernfs_create_dir_ns(struct kernfs_node *parent, const char *name, |
264 | umode_t mode, void *priv, const void *ns) | |
93b2b8e4 TH |
265 | { return ERR_PTR(-ENOSYS); } |
266 | ||
324a56e1 TH |
267 | static inline struct kernfs_node * |
268 | kernfs_create_file_ns_key(struct kernfs_node *parent, const char *name, | |
517e64f5 TH |
269 | umode_t mode, loff_t size, |
270 | const struct kernfs_ops *ops, void *priv, | |
271 | const void *ns, struct lock_class_key *key) | |
496f7394 TH |
272 | { return ERR_PTR(-ENOSYS); } |
273 | ||
324a56e1 TH |
274 | static inline struct kernfs_node * |
275 | kernfs_create_link(struct kernfs_node *parent, const char *name, | |
276 | struct kernfs_node *target) | |
5d0e26bb TH |
277 | { return ERR_PTR(-ENOSYS); } |
278 | ||
324a56e1 | 279 | static inline void kernfs_remove(struct kernfs_node *kn) { } |
879f40d1 | 280 | |
324a56e1 | 281 | static inline int kernfs_remove_by_name_ns(struct kernfs_node *kn, |
879f40d1 TH |
282 | const char *name, const void *ns) |
283 | { return -ENOSYS; } | |
284 | ||
324a56e1 TH |
285 | static inline int kernfs_rename_ns(struct kernfs_node *kn, |
286 | struct kernfs_node *new_parent, | |
890ece16 TH |
287 | const char *new_name, const void *new_ns) |
288 | { return -ENOSYS; } | |
289 | ||
324a56e1 | 290 | static inline int kernfs_setattr(struct kernfs_node *kn, |
5d60418e TH |
291 | const struct iattr *iattr) |
292 | { return -ENOSYS; } | |
293 | ||
324a56e1 | 294 | static inline void kernfs_notify(struct kernfs_node *kn) { } |
024f6471 | 295 | |
4b93dc9b TH |
296 | static inline const void *kernfs_super_ns(struct super_block *sb) |
297 | { return NULL; } | |
298 | ||
299 | static inline struct dentry * | |
300 | kernfs_mount_ns(struct file_system_type *fs_type, int flags, | |
301 | struct kernfs_root *root, const void *ns) | |
302 | { return ERR_PTR(-ENOSYS); } | |
303 | ||
304 | static inline void kernfs_kill_sb(struct super_block *sb) { } | |
305 | ||
306 | static inline void kernfs_init(void) { } | |
307 | ||
879f40d1 TH |
308 | #endif /* CONFIG_SYSFS */ |
309 | ||
324a56e1 TH |
310 | static inline struct kernfs_node * |
311 | kernfs_find_and_get(struct kernfs_node *kn, const char *name) | |
ccf73cf3 | 312 | { |
324a56e1 | 313 | return kernfs_find_and_get_ns(kn, name, NULL); |
ccf73cf3 TH |
314 | } |
315 | ||
324a56e1 | 316 | static inline struct kernfs_node * |
bb8b9d09 TH |
317 | kernfs_create_dir(struct kernfs_node *parent, const char *name, umode_t mode, |
318 | void *priv) | |
93b2b8e4 | 319 | { |
bb8b9d09 | 320 | return kernfs_create_dir_ns(parent, name, mode, priv, NULL); |
93b2b8e4 TH |
321 | } |
322 | ||
324a56e1 TH |
323 | static inline struct kernfs_node * |
324 | kernfs_create_file_ns(struct kernfs_node *parent, const char *name, | |
517e64f5 TH |
325 | umode_t mode, loff_t size, const struct kernfs_ops *ops, |
326 | void *priv, const void *ns) | |
327 | { | |
328 | struct lock_class_key *key = NULL; | |
329 | ||
330 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
331 | key = (struct lock_class_key *)&ops->lockdep_key; | |
332 | #endif | |
333 | return kernfs_create_file_ns_key(parent, name, mode, size, ops, priv, | |
334 | ns, key); | |
335 | } | |
336 | ||
324a56e1 TH |
337 | static inline struct kernfs_node * |
338 | kernfs_create_file(struct kernfs_node *parent, const char *name, umode_t mode, | |
496f7394 TH |
339 | loff_t size, const struct kernfs_ops *ops, void *priv) |
340 | { | |
341 | return kernfs_create_file_ns(parent, name, mode, size, ops, priv, NULL); | |
342 | } | |
343 | ||
324a56e1 | 344 | static inline int kernfs_remove_by_name(struct kernfs_node *parent, |
879f40d1 TH |
345 | const char *name) |
346 | { | |
347 | return kernfs_remove_by_name_ns(parent, name, NULL); | |
348 | } | |
349 | ||
4b93dc9b TH |
350 | static inline struct dentry * |
351 | kernfs_mount(struct file_system_type *fs_type, int flags, | |
352 | struct kernfs_root *root) | |
353 | { | |
354 | return kernfs_mount_ns(fs_type, flags, root, NULL); | |
355 | } | |
356 | ||
b8441ed2 | 357 | #endif /* __LINUX_KERNFS_H */ |