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