1
2
3
4
5
6
7
8#ifndef __LINUX_FSNOTIFY_BACKEND_H
9#define __LINUX_FSNOTIFY_BACKEND_H
10
11#ifdef __KERNEL__
12
13#include <linux/idr.h>
14#include <linux/fs.h>
15#include <linux/list.h>
16#include <linux/path.h>
17#include <linux/spinlock.h>
18#include <linux/types.h>
19#include <linux/atomic.h>
20#include <linux/user_namespace.h>
21#include <linux/refcount.h>
22
23
24
25
26
27
28
29#define FS_ACCESS 0x00000001
30#define FS_MODIFY 0x00000002
31#define FS_ATTRIB 0x00000004
32#define FS_CLOSE_WRITE 0x00000008
33#define FS_CLOSE_NOWRITE 0x00000010
34#define FS_OPEN 0x00000020
35#define FS_MOVED_FROM 0x00000040
36#define FS_MOVED_TO 0x00000080
37#define FS_CREATE 0x00000100
38#define FS_DELETE 0x00000200
39#define FS_DELETE_SELF 0x00000400
40#define FS_MOVE_SELF 0x00000800
41
42#define FS_UNMOUNT 0x00002000
43#define FS_Q_OVERFLOW 0x00004000
44#define FS_IN_IGNORED 0x00008000
45
46#define FS_OPEN_PERM 0x00010000
47#define FS_ACCESS_PERM 0x00020000
48
49#define FS_EXCL_UNLINK 0x04000000
50#define FS_ISDIR 0x40000000
51#define FS_IN_ONESHOT 0x80000000
52
53#define FS_DN_RENAME 0x10000000
54#define FS_DN_MULTISHOT 0x20000000
55
56
57
58#define FS_EVENT_ON_CHILD 0x08000000
59
60
61
62#define FS_EVENTS_POSS_ON_CHILD (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
63 FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
64 FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
65 FS_DELETE | FS_OPEN_PERM | FS_ACCESS_PERM)
66
67#define FS_MOVE (FS_MOVED_FROM | FS_MOVED_TO)
68
69#define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM | FS_ACCESS_PERM)
70
71#define ALL_FSNOTIFY_EVENTS (FS_ACCESS | FS_MODIFY | FS_ATTRIB | \
72 FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN | \
73 FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE | \
74 FS_DELETE | FS_DELETE_SELF | FS_MOVE_SELF | \
75 FS_UNMOUNT | FS_Q_OVERFLOW | FS_IN_IGNORED | \
76 FS_OPEN_PERM | FS_ACCESS_PERM | FS_EXCL_UNLINK | \
77 FS_ISDIR | FS_IN_ONESHOT | FS_DN_RENAME | \
78 FS_DN_MULTISHOT | FS_EVENT_ON_CHILD)
79
80struct fsnotify_group;
81struct fsnotify_event;
82struct fsnotify_mark;
83struct fsnotify_event_private_data;
84struct fsnotify_fname;
85struct fsnotify_iter_info;
86
87
88
89
90
91
92
93
94
95
96
97
98struct fsnotify_ops {
99 int (*handle_event)(struct fsnotify_group *group,
100 struct inode *inode,
101 struct fsnotify_mark *inode_mark,
102 struct fsnotify_mark *vfsmount_mark,
103 u32 mask, const void *data, int data_type,
104 const unsigned char *file_name, u32 cookie,
105 struct fsnotify_iter_info *iter_info);
106 void (*free_group_priv)(struct fsnotify_group *group);
107 void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
108 void (*free_event)(struct fsnotify_event *event);
109
110 void (*free_mark)(struct fsnotify_mark *mark);
111};
112
113
114
115
116
117
118struct fsnotify_event {
119 struct list_head list;
120
121 struct inode *inode;
122 u32 mask;
123};
124
125
126
127
128
129
130
131struct fsnotify_group {
132
133
134
135
136
137
138
139
140 refcount_t refcnt;
141
142 const struct fsnotify_ops *ops;
143
144
145 spinlock_t notification_lock;
146 struct list_head notification_list;
147 wait_queue_head_t notification_waitq;
148 unsigned int q_len;
149 unsigned int max_events;
150
151
152
153
154 #define FS_PRIO_0 0
155 #define FS_PRIO_1 1
156 #define FS_PRIO_2 2
157 unsigned int priority;
158 bool shutdown;
159
160
161 struct mutex mark_mutex;
162 atomic_t num_marks;
163
164
165 struct list_head marks_list;
166
167 struct fasync_struct *fsn_fa;
168
169 struct fsnotify_event *overflow_event;
170
171
172 atomic_t user_waits;
173
174
175
176 union {
177 void *private;
178#ifdef CONFIG_INOTIFY_USER
179 struct inotify_group_private_data {
180 spinlock_t idr_lock;
181 struct idr idr;
182 struct ucounts *ucounts;
183 } inotify_data;
184#endif
185#ifdef CONFIG_FANOTIFY
186 struct fanotify_group_private_data {
187
188 struct list_head access_list;
189 wait_queue_head_t access_waitq;
190 int f_flags;
191 unsigned int max_marks;
192 struct user_struct *user;
193 bool audit;
194 } fanotify_data;
195#endif
196 };
197};
198
199
200#define FSNOTIFY_EVENT_NONE 0
201#define FSNOTIFY_EVENT_PATH 1
202#define FSNOTIFY_EVENT_INODE 2
203
204
205
206
207
208
209
210struct fsnotify_mark_connector {
211 spinlock_t lock;
212#define FSNOTIFY_OBJ_TYPE_INODE 0x01
213#define FSNOTIFY_OBJ_TYPE_VFSMOUNT 0x02
214#define FSNOTIFY_OBJ_ALL_TYPES (FSNOTIFY_OBJ_TYPE_INODE | \
215 FSNOTIFY_OBJ_TYPE_VFSMOUNT)
216 unsigned int flags;
217 union {
218 struct inode *inode;
219 struct vfsmount *mnt;
220 };
221 union {
222 struct hlist_head list;
223
224 struct fsnotify_mark_connector *destroy_next;
225 };
226};
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242struct fsnotify_mark {
243
244 __u32 mask;
245
246
247 refcount_t refcnt;
248
249
250 struct fsnotify_group *group;
251
252
253
254 struct list_head g_list;
255
256 spinlock_t lock;
257
258 struct hlist_node obj_list;
259
260 struct fsnotify_mark_connector *connector;
261
262 __u32 ignored_mask;
263#define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY 0x01
264#define FSNOTIFY_MARK_FLAG_ALIVE 0x02
265#define FSNOTIFY_MARK_FLAG_ATTACHED 0x04
266 unsigned int flags;
267};
268
269#ifdef CONFIG_FSNOTIFY
270
271
272
273
274extern int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
275 const unsigned char *name, u32 cookie);
276extern int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask);
277extern void __fsnotify_inode_delete(struct inode *inode);
278extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
279extern u32 fsnotify_get_cookie(void);
280
281static inline int fsnotify_inode_watches_children(struct inode *inode)
282{
283
284 if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
285 return 0;
286
287
288 return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
289}
290
291
292
293
294
295static inline void fsnotify_update_flags(struct dentry *dentry)
296{
297 assert_spin_locked(&dentry->d_lock);
298
299
300
301
302
303
304
305
306 if (fsnotify_inode_watches_children(dentry->d_parent->d_inode))
307 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
308 else
309 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
310}
311
312
313
314
315extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
316
317extern void fsnotify_get_group(struct fsnotify_group *group);
318
319extern void fsnotify_put_group(struct fsnotify_group *group);
320
321extern void fsnotify_group_stop_queueing(struct fsnotify_group *group);
322
323extern void fsnotify_destroy_group(struct fsnotify_group *group);
324
325extern int fsnotify_fasync(int fd, struct file *file, int on);
326
327extern void fsnotify_destroy_event(struct fsnotify_group *group,
328 struct fsnotify_event *event);
329
330extern int fsnotify_add_event(struct fsnotify_group *group,
331 struct fsnotify_event *event,
332 int (*merge)(struct list_head *,
333 struct fsnotify_event *));
334
335extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
336
337extern struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group);
338
339extern struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group);
340
341
342
343
344extern void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn);
345extern void fsnotify_init_mark(struct fsnotify_mark *mark,
346 struct fsnotify_group *group);
347
348extern struct fsnotify_mark *fsnotify_find_mark(
349 struct fsnotify_mark_connector __rcu **connp,
350 struct fsnotify_group *group);
351
352extern int fsnotify_add_mark(struct fsnotify_mark *mark, struct inode *inode,
353 struct vfsmount *mnt, int allow_dups);
354extern int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
355 struct inode *inode, struct vfsmount *mnt, int allow_dups);
356
357extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
358 struct fsnotify_group *group);
359
360extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
361
362extern void fsnotify_free_mark(struct fsnotify_mark *mark);
363
364extern void fsnotify_clear_marks_by_group(struct fsnotify_group *group, unsigned int type);
365
366static inline void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group)
367{
368 fsnotify_clear_marks_by_group(group, FSNOTIFY_OBJ_TYPE_VFSMOUNT);
369}
370
371static inline void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group)
372{
373 fsnotify_clear_marks_by_group(group, FSNOTIFY_OBJ_TYPE_INODE);
374}
375extern void fsnotify_get_mark(struct fsnotify_mark *mark);
376extern void fsnotify_put_mark(struct fsnotify_mark *mark);
377extern void fsnotify_unmount_inodes(struct super_block *sb);
378extern void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info);
379extern bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info);
380
381
382extern void fsnotify_init_event(struct fsnotify_event *event,
383 struct inode *to_tell, u32 mask);
384
385#else
386
387static inline int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
388 const unsigned char *name, u32 cookie)
389{
390 return 0;
391}
392
393static inline int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask)
394{
395 return 0;
396}
397
398static inline void __fsnotify_inode_delete(struct inode *inode)
399{}
400
401static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
402{}
403
404static inline void fsnotify_update_flags(struct dentry *dentry)
405{}
406
407static inline u32 fsnotify_get_cookie(void)
408{
409 return 0;
410}
411
412static inline void fsnotify_unmount_inodes(struct super_block *sb)
413{}
414
415#endif
416
417#endif
418
419#endif
420