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